Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

record_accessor: Add set method for nested record #2977

Merged
merged 2 commits into from
Apr 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions lib/fluent/plugin_helper/record_accessor.rb
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@ def initialize(param)
else
mcall = method(:call_dig)
mdelete = method(:delete_nest)
mset = method(:set_nest)
singleton_class.module_eval do
define_method(:call, mcall)
define_method(:delete, mdelete)
define_method(:set, mset)
end
end
end
Expand Down Expand Up @@ -75,6 +77,18 @@ def delete_nest(r)
nil
end

def set(r, v)
r[@keys] = v
end

# set_nest doesn't create intermediate object. If key doesn't exist, no effect.
# See also: https://bugs.ruby-lang.org/issues/11747
def set_nest(r, v)
r.dig(*@dig_keys)&.[]=(@last_key, v)
rescue
nil
end

def self.parse_parameter(param)
if param.start_with?('$.')
parse_dot_notation(param)
Expand Down
41 changes: 41 additions & 0 deletions test/plugin_helper/test_record_accessor.rb
Original file line number Diff line number Diff line change
Expand Up @@ -194,4 +194,45 @@ class Dummy < Fluent::Plugin::TestBase
end
end
end

sub_test_case 'Fluent::PluginHelper::RecordAccessor::Accessor#set' do
setup do
@d = Dummy.new
end

data('normal' => 'key1',
'space' => 'ke y2',
'dot key' => 'this.is.key3')
test 'set top key' do |param|
r = {'key1' => 'v1', 'ke y2' => 'v2', 'this.is.key3' => 'v3'}
accessor = @d.record_accessor_create(param)
accessor.set(r, "test")
assert_equal "test", r[param]
end

test "set top key using bracket style" do
r = {'key1' => 'v1', 'ke y2' => 'v2', 'this.is.key3' => 'v3'}
accessor = @d.record_accessor_create('$["this.is.key3"]')
accessor.set(r, "test")
assert_equal "test", r["this.is.key3"]
end

data('bracket' => "$['key1'][0]['ke y2']",
'bracket w/ double quotes' => '$["key1"][0]["ke y2"]')
test "set nested keys ['key1', 0, 'ke y2']" do |param|
r = {'key1' => [{'ke y2' => "value"}]}
accessor = @d.record_accessor_create(param)
accessor.set(r, "nested_message")
assert_equal "nested_message", r['key1'][0]['ke y2']
end

test "don't raise an error when unexpected record is coming" do
r = {'key1' => [{'key3' => "value"}]}
accessor = @d.record_accessor_create("$['key1']['key2']['key3']")
assert_nothing_raised do
accessor.set(r, "unknown field")
end
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it'd be better to add assert_equal {'key1' => [{'key3' => "value"}]}, r to make sure the original record doesn't change.

assert_equal({'key1' => [{'key3' => "value"}]}, r)
end
end
end