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.

Sign up for GitHub

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

Jump to bottom

[FSSDK-9781] warn on duplicate experiment key #343

Merged
merged 3 commits into from
Dec 8, 2023
Merged

[FSSDK-9781] warn on duplicate experiment key #343

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d9b902
warn on duplicate experiment key
Dec 7, 2023
7848f02
Merge branch 'master' into aleap/warn_duplicate_experiments
andrewleap-optimizely Dec 8, 2023
63791a1
fix tests
Dec 8, 2023
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
2 changes: 1 addition & 1 deletion lib/optimizely.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -889,7 +889,7 @@ def get_optimizely_config
if @config_manager.respond_to?(:optimizely_config)
@config_manager.optimizely_config
else
OptimizelyConfig.new(project_config).config
OptimizelyConfig.new(project_config, @logger).config
end
end

Expand Down
2 changes: 1 addition & 1 deletion lib/optimizely/config_manager/http_project_config_manager.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ def config
end

def optimizely_config
@optimizely_config = OptimizelyConfig.new(@config).config if @optimizely_config.nil?
@optimizely_config = OptimizelyConfig.new(@config, @logger).config if @optimizely_config.nil?

@optimizely_config
end
Expand Down
3 changes: 2 additions & 1 deletion lib/optimizely/config_manager/static_project_config_manager.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@ def initialize(datafile, logger, error_handler, skip_json_validation)
error_handler,
skip_json_validation
)
@logger = logger
@sdk_key = @config&.sdk_key
@optimizely_config = nil
end

def optimizely_config
@optimizely_config = OptimizelyConfig.new(@config).config if @optimizely_config.nil?
@optimizely_config = OptimizelyConfig.new(@config, @logger).config if @optimizely_config.nil?

@optimizely_config
end
Expand Down
4 changes: 3 additions & 1 deletion lib/optimizely/optimizely_config.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ module Optimizely
require 'json'
class OptimizelyConfig
include Optimizely::ConditionTreeEvaluator
def initialize(project_config)
def initialize(project_config, logger = nil)
@project_config = project_config
@logger = logger || NoOpLogger.new
@rollouts = @project_config.rollouts
@audiences = []
audience_id_lookup_dict = {}
Expand Down Expand Up @@ -91,6 +92,7 @@ def audiences_map

def experiments_map
experiments_id_map.values.reduce({}) do |experiments_key_map, experiment|
@logger.log(Logger::WARN, "Duplicate experiment keys found in datafile: #{experiment['key']}") if experiments_key_map.key? experiment['key']
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good. A question is the order in datafile is managed in experiment_id_map. Just for consistency, we're supposed to return the last experiment in the datafile.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea Ruby iterates over hash values in insertion order, so the last instance of an experiment key will take precedence.

experiments_key_map.update(experiment['key'] => experiment)
end
end
Expand Down
61 changes: 60 additions & 1 deletion spec/optimizely_config_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
require 'spec_helper'

describe Optimizely::OptimizelyConfig do
let(:config_body) { OptimizelySpec::VALID_CONFIG_BODY }
let(:config_body_JSON) { OptimizelySpec::VALID_CONFIG_BODY_JSON }
let(:similar_exp_keys_JSON) { OptimizelySpec::SIMILAR_EXP_KEYS_JSON }
let(:typed_audiences_JSON) { OptimizelySpec::CONFIG_DICT_WITH_TYPED_AUDIENCES_JSON }
Expand Down Expand Up @@ -768,7 +769,7 @@
'',
'"exactString" OR "999999999"'
]
optimizely_config = Optimizely::OptimizelyConfig.new(project_instance_typed_audiences.send(:project_config))
optimizely_config = Optimizely::OptimizelyConfig.new(project_instance_typed_audiences.send(:project_config), spy_logger)
audiences_map = optimizely_config.send(:audiences_map)
audience_conditions.each_with_index do |audience_condition, index|
result = optimizely_config.send(:replace_ids_with_names, audience_condition, audiences_map)
Expand Down Expand Up @@ -796,4 +797,62 @@
expect(optimizely_config_similar_rule_keys['sdkKey']).to eq('')
expect(optimizely_config_similar_rule_keys['environmentKey']).to eq('')
end

it 'should use the newest of duplicate experiment keys' do
duplicate_experiment_key = 'test_experiment'
new_experiment = {
'key': duplicate_experiment_key,
'status': 'Running',
'layerId': '8',
"audienceConditions": %w[
or
11160
],
'audienceIds': ['11160'],
'id': '111137',
'forcedVariations': {},
'trafficAllocation': [
{'entityId': '222242', 'endOfRange': 8000},
{'entityId': '', 'endOfRange': 10_000}
],
'variations': [
{
'id': '222242',
'key': 'control',
'variables': []
}
]
}

new_feature = {
'id': '91117',
'key': 'new_feature',
'experimentIds': ['111137'],
'rolloutId': '',
'variables': [
{'id': '127', 'key': 'is_working', 'defaultValue': 'true', 'type': 'boolean'},
{'id': '128', 'key': 'environment', 'defaultValue': 'devel', 'type': 'string'},
{'id': '129', 'key': 'cost', 'defaultValue': '10.99', 'type': 'double'},
{'id': '130', 'key': 'count', 'defaultValue': '999', 'type': 'integer'},
{'id': '131', 'key': 'variable_without_usage', 'defaultValue': '45', 'type': 'integer'},
{'id': '132', 'key': 'object', 'defaultValue': '{"test": 12}', 'type': 'string', 'subType': 'json'},
{'id': '133', 'key': 'true_object', 'defaultValue': '{"true_test": 23.54}', 'type': 'json'}
]
}

config_body['experiments'].push(new_experiment)
config_body['featureFlags'].push(new_feature)
project_config = Optimizely::DatafileProjectConfig.new(JSON.dump(config_body), spy_logger, error_handler)

opti_config = Optimizely::OptimizelyConfig.new(project_config, spy_logger)

key_map = opti_config.config['experimentsMap']
id_map = opti_config.send(:experiments_id_map)

expected_warning_message = "Duplicate experiment keys found in datafile: #{duplicate_experiment_key}"
expect(spy_logger).to have_received(:log).once.with(Logger::WARN, expected_warning_message)

expect(key_map[duplicate_experiment_key]['id']).to eq(new_experiment[:id])
expect(id_map.values.count { |exp| exp['key'] == duplicate_experiment_key }).to eq(2)
end
end
Loading