LiquidMigrator is checking for complex JSONPaths

If a complex JSONPath like '$.text[*]' is found the migration will
fail with an exception and keep the database intact
This commit is contained in:
Dominik Sander 2014-04-30 23:47:43 +02:00
parent e8ecbe25b8
commit b4b9939b7d
3 changed files with 31 additions and 8 deletions

View file

@ -1,7 +1,7 @@
module LiquidInterpolatable
extend ActiveSupport::Concern
def interpolate_options options, payload
def interpolate_options(options, payload)
duped_options = options.dup.tap do |duped_options|
duped_options.each_pair do |key, value|
if value.class == String
@ -14,7 +14,7 @@ module LiquidInterpolatable
duped_options
end
def interpolate_string string, payload
def interpolate_string(string, payload)
Liquid::Template.parse(string).render(payload)
end

View file

@ -20,9 +20,9 @@ module LiquidMigrator
end
hash[key] = LiquidMigrator.convert_string value, options[:leading_dollarsign_is_jsonpath]
when 'Hash'
# might want to make it recursive?
raise "nested Hashes are not supported at the moment"
when 'Array'
# do we need it?
raise "nested Arrays are not supported at the moment"
end
end
# remove the unneeded *_path attributes
@ -51,7 +51,14 @@ module LiquidMigrator
end
def self.convert_json_path(string, filter = "")
"{{#{string[2..-1].gsub(/\.\*\Z/, '')}#{filter}}}"
check_path(string)
"{{#{string[2..-1]}#{filter}}}"
end
def self.check_path(string)
if string !~ /\A(\$\.)?(\w+\.)*(\w+)\Z/
raise "JSONPath '#{string}' is too complex, please check your migration."
end
end
end

View file

@ -5,7 +5,6 @@ describe LiquidMigrator do
it "should work" do
LiquidMigrator.convert_string("$.data", true).should == "{{data}}"
LiquidMigrator.convert_string("$.data.test", true).should == "{{data.test}}"
LiquidMigrator.convert_string("$.data.test.*", true).should == "{{data.test}}"
end
it "should ignore strings which just contain a JSONPath" do
@ -13,12 +12,14 @@ describe LiquidMigrator do
LiquidMigrator.convert_string(" $.data", true).should == " $.data"
LiquidMigrator.convert_string("lorem $.data", true).should == "lorem $.data"
end
it "should raise an exception when encountering complex JSONPaths" do
expect { LiquidMigrator.convert_string("$.data.test.*", true) }.
to raise_error("JSONPath '$.data.test.*' is too complex, please check your migration.")
end
end
describe "converting escaped JSONPath strings" do
it "should work" do
LiquidMigrator.convert_string("Received <$.content.text.*> from <$.content.name> .").should ==
"Received {{content.text}} from {{content.name}} ."
LiquidMigrator.convert_string("Weather looks like <$.conditions> according to the forecast at <$.pretty_date.time>").should ==
"Weather looks like {{conditions}} according to the forecast at {{pretty_date.time}}"
end
@ -27,6 +28,11 @@ describe LiquidMigrator do
LiquidMigrator.convert_string("Escaped: <escape $.content.name>\nNot escaped: <$.content.name>").should ==
"Escaped: {{content.name | uri_escape}}\nNot escaped: {{content.name}}"
end
it "should raise an exception when encountering complex JSONPaths" do
expect { LiquidMigrator.convert_string("Received <$.content.text.*> from <$.content.name> .") }.
to raise_error("JSONPath '$.content.text.*' is too complex, please check your migration.")
end
end
describe "migrating a hash" do
@ -42,6 +48,10 @@ describe LiquidMigrator do
LiquidMigrator.convert_hash({'a' => "default", 'a_path' => "$.data"}, {leading_dollarsign_is_jsonpath: true, merge_path_attributes: true}).should ==
{'a' => "{{data}}"}
end
it "should raise an exception when encountering complex JSONPaths" do
expect { LiquidMigrator.convert_hash({'b' => "This is <$.complex[2]>"}) }.
to raise_error("JSONPath '$.complex[2]' is too complex, please check your migration.")
end
end
describe "migrating an actual agent" do
@ -69,5 +79,11 @@ describe LiquidMigrator do
LiquidMigrator.convert_all_agent_options(@agent)
@agent.reload.options.should == {"auth_token" => 'token', 'color' => 'yellow', 'notify' => false, 'room_name' => 'test', 'username' => '{{username}}', 'message' => '{{message}}'}
end
it "should raise an exception when encountering complex JSONPaths" do
@agent.options['username_path'] = "$.very.complex[*]"
expect { LiquidMigrator.convert_all_agent_options(@agent) }.
to raise_error("JSONPath '$.very.complex[*]' is too complex, please check your migration.")
end
end
end