mirror of
https://github.com/discourse/discourse.git
synced 2024-11-28 02:03:45 +08:00
f0c6dd5682
* FIX: Fix a bug that is accessing the values in a hash wrongly and write tests
I decided to write tests in order to be confident in my refactor that's in the next commit.
Meanwhile I have discovered a potential bug. The `title_attr` key was accessed as a string,
but all the keys are actually symbols so it was never evaluated to be true.
irb(main):025:0> d = {key: 'value'}
=> {:key=>"value"}
irb(main):026:0> d['key']
=> nil
irb(main):027:0> d[:key]
=> "value"
* DEV: Extract methods for readability
I will be adding a new method following the conventions in place for adding a new normalizer. And this will make the readability of the `raw` block even more difficult; so I am extracting self contained private methods beforehand.
* FEATURE: Parse JSON-LD and introduce Movie object
JSON LD data is very easily transferable to Ruby objects because they contain types. If these types are mapped to Ruby objects, it is also better to make all the parsed data very explicit and easily extendable.
JSON-LD has many more standardized item types, with a full list here: https://schema.org/docs/full.html
However in order to decrease the scope, I only adapted the movie type.
* DEV: Change inheritance between normalizers
Normalizers are not supposed to have an inheritance relationships amongst each other. They are all normalizers, but all normalizing separate protocols. This is why I chose to extract a parent class and relieve Open Graph off that responsibility. Removing the parent class altogether could also a possibility, but I am keeping the scope limited to having a more accurate representation of the normalizers while making it easier to add a new one.
* Lint changes
* Bring back the Oembed OpenGraph inheritance
There is one test that caught that this inheritance was necessary. I still think modelling wise this inheritance shouldn't exist, but this can be tackled separately.
* Return empty hash if the json received is invalid
Before this change if there was a parsing error with JSON it would throw an exception. The goal of this commit is to rescue that exception and then log a warning. I chose to use Discourse's logger wrapper `warn_exception` to have the backtrace and not just used Rails logger. I considered raising an `InvalidParameters` error however if the JSON here is invalid it should not block showing of the Onebox, so logging is enough.
* Prep to support more JSONLD schema types with case
* Extract mustache template object created from JSONLD
46 lines
1013 B
Ruby
46 lines
1013 B
Ruby
# frozen_string_literal: true
|
|
|
|
module Onebox
|
|
class JsonLd < Normalizer
|
|
# Full schema.org hierarchy can be found here: https://schema.org/docs/full.html
|
|
MOVIE_JSON_LD_TYPE = "Movie"
|
|
|
|
def initialize(doc)
|
|
@data = extract(doc)
|
|
end
|
|
|
|
private
|
|
|
|
def extract(doc)
|
|
extracted_json = extract_json_from(doc)
|
|
parsed_json = parse_json(extracted_json)
|
|
|
|
extracted =
|
|
case parsed_json["@type"]
|
|
when MOVIE_JSON_LD_TYPE
|
|
Onebox::Movie.new(parsed_json)
|
|
else
|
|
{}
|
|
end
|
|
|
|
extracted.to_h
|
|
end
|
|
|
|
def extract_json_from(doc)
|
|
return {} if Onebox::Helpers::blank?(doc)
|
|
json_ld = doc.search('script[type="application/ld+json"]').text
|
|
return {} if Onebox::Helpers::blank?(json_ld)
|
|
json_ld
|
|
end
|
|
|
|
def parse_json(json)
|
|
begin
|
|
JSON[json]
|
|
rescue JSON::ParserError => e
|
|
Discourse.warn_exception(e, message: "Error parsing JSON-LD json: #{json}")
|
|
{}
|
|
end
|
|
end
|
|
end
|
|
end
|