Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion lib/ldclient-rb/ldclient.rb
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ def toggle?(key, user, default = false)
@config.logger.error("[LDClient] Must specify user")
return default
end
sanitize_user(user)

if @config.stream? && !@stream_processor.started?
@stream_processor.start
Expand Down Expand Up @@ -176,6 +177,7 @@ def add_event(event)
# @param [Hash] The user to register
#
def identify(user)
sanitize_user(user)
add_event(kind: "identify", key: user[:key], user: user)
end

Expand All @@ -200,6 +202,7 @@ def is_offline?
#
# @return [void]
def track(event_name, user, data)
sanitize_user(user)
add_event(kind: "custom", key: event_name, user: user, data: data)
end

Expand Down Expand Up @@ -406,9 +409,15 @@ def log_exception(caller, exn)
@config.logger.error(error)
end

def sanitize_user(user)
if user[:key]
user[:key] = user[:key].to_s
end
end

private :post_flushed_events, :add_event, :get_streamed_flag,
:get_flag_stream, :get_flag_int, :make_request, :param_for_user,
:match_target?, :match_user?, :match_variation?, :evaluate,
:create_worker, :log_timings, :log_exception
:create_worker, :log_timings, :log_exception, :sanitize_user
end
end
9 changes: 9 additions & 0 deletions spec/fixtures/numeric_key_user.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"key": 33,
"custom":{
"groups":[
"microsoft",
"google"
]
}
}
9 changes: 9 additions & 0 deletions spec/fixtures/sanitized_numeric_key_user.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"key": "33",
"custom":{
"groups":[
"microsoft",
"google"
]
}
}
34 changes: 34 additions & 0 deletions spec/ldclient_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@
data = File.read(File.join("spec", "fixtures", "user.json"))
JSON.parse(data, symbolize_names: true)
end
let(:numeric_key_user) do
data = File.read(File.join("spec", "fixtures", "numeric_key_user.json"))
JSON.parse(data, symbolize_names: true)
end
let(:sanitized_numeric_key_user) do
data = File.read(File.join("spec", "fixtures", "sanitized_numeric_key_user.json"))
JSON.parse(data, symbolize_names: true)
end

context 'user flag settings' do
describe '#update_user_flag_setting' do
Expand Down Expand Up @@ -85,6 +93,10 @@
result = client.toggle?(feature[:key], nil, "default")
expect(result).to eq "default"
end
it "sanitizes the user in the event" do
expect(client).to receive(:add_event).with(hash_including(user: sanitized_numeric_key_user))
client.toggle?(feature[:key], numeric_key_user, "default")
end
it "returns value from streamed flag if available" do
expect(client.instance_variable_get(:@config)).to receive(:stream?).and_return(true).twice
expect(client.instance_variable_get(:@stream_processor)).to receive(:started?).and_return true
Expand All @@ -103,6 +115,28 @@
end
end

describe '#identify' do
it "queues up an identify event" do
expect(client).to receive(:add_event).with(hash_including(kind: "identify", key: user[:key], user: user))
client.identify(user)
end
it "sanitizes the user in the event" do
expect(client).to receive(:add_event).with(hash_including(user: sanitized_numeric_key_user))
client.identify(numeric_key_user)
end
end

describe '#track' do
it "queues up an custom event" do
expect(client).to receive(:add_event).with(hash_including(kind: "custom", key: "custom_event_name", user: user, data: 42))
client.track("custom_event_name", user, 42)
end
it "sanitizes the user in the event" do
expect(client).to receive(:add_event).with(hash_including(user: sanitized_numeric_key_user))
client.track("custom_event_name", numeric_key_user, nil)
end
end

describe '#get_streamed_flag' do
it "will not check the polled flag normally" do
expect(client).to receive(:get_flag_stream).and_return true
Expand Down