Skip to content

feat: Implement decideAll api #635

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

Merged
merged 11 commits into from
Dec 11, 2020
Merged

feat: Implement decideAll api #635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
97204df
Implement decideForKeys
yavorona Dec 10, 2020
22ae954
Implememt decideAll and add comments
yavorona Dec 10, 2020
cc0a21f
Add decideAll and decideForKeys unit tests to optimizely
yavorona Dec 10, 2020
92e9b2d
Add unit tests for user context decideForKey and decideAll
yavorona Dec 10, 2020
4f66e46
Clean up
yavorona Dec 10, 2020
2767d02
Fix decideAll
yavorona Dec 10, 2020
23da8c9
Add more ENABLED_FLAGS_ONLY tests
yavorona Dec 11, 2020
78480ec
update test params
yavorona Dec 11, 2020
5d91f24
Update comments
yavorona Dec 11, 2020
b9fab5e
Incorporate comments
yavorona Dec 11, 2020
adc3349
Update comments
yavorona Dec 11, 2020
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
296 changes: 290 additions & 6 deletions packages/optimizely-sdk/lib/optimizely/index.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4333,6 +4333,7 @@ describe('lib/optimizely', function() {
logLevel: LOG_LEVEL.INFO,
logToConsole: false,
});

describe('#createUserContext', function() {
beforeEach(function() {
optlyInstance = new Optimizely({
Expand Down Expand Up @@ -4911,16 +4912,10 @@ describe('lib/optimizely', function() {
});

sinon.stub(optlyInstance.notificationCenter, 'sendNotifications');
sinon.stub(errorHandler, 'handleError');
sinon.stub(createdLogger, 'log');
sinon.stub(fns, 'uuid').returns('a68cf1ad-0393-4e18-af87-efe8f01a7c9c');
});

afterEach(function() {
optlyInstance.notificationCenter.sendNotifications.restore();
errorHandler.handleError.restore();
createdLogger.log.restore();
fns.uuid.restore();
});

it('should make a decision and do not dispatch an event', function() {
Expand Down Expand Up @@ -4965,6 +4960,295 @@ describe('lib/optimizely', function() {
});
});
});

describe('#decideForKeys', function() {
var userId = 'tester';
beforeEach(function() {
optlyInstance = new Optimizely({
clientEngine: 'node-sdk',
datafile: testData.getTestDecideProjectConfig(),
errorHandler: errorHandler,
eventDispatcher: eventDispatcher,
jsonSchemaValidator: jsonSchemaValidator,
logger: createdLogger,
isValidInstance: true,
eventBatchSize: 1,
defaultDecideOptions: [],
});

sinon.stub(optlyInstance.notificationCenter, 'sendNotifications');
});

afterEach(function() {
optlyInstance.notificationCenter.sendNotifications.restore();
});

it('should return decision results map with single flag key provided for feature_test and dispatch an event', function() {
var flagKey = 'feature_2';
var user = optlyInstance.createUserContext(userId);
var expectedVariables = optlyInstance.getAllFeatureVariables(flagKey, userId);
var decisionsMap = optlyInstance.decideForKeys(user, [ flagKey ]);
var decision = decisionsMap[flagKey];
var expectedDecision = {
variationKey: 'variation_with_traffic',
enabled: true,
variables: expectedVariables,
ruleKey: 'exp_no_audience',
flagKey: flagKey,
userContext: user,
reasons: [],
}
assert.deepEqual(Object.values(decisionsMap).length, 1);
assert.deepEqual(decision, expectedDecision);
sinon.assert.calledOnce(optlyInstance.eventDispatcher.dispatchEvent);
sinon.assert.callCount(optlyInstance.notificationCenter.sendNotifications, 4)
var notificationCallArgs = optlyInstance.notificationCenter.sendNotifications.getCall(3).args;
var decisionEventDispatched = notificationCallArgs[1].decisionInfo.decisionEventDispatched;
assert.deepEqual(decisionEventDispatched, true);
});

it('should return decision results map with two flag keys provided and dispatch events', function() {
var flagKeysArray = ['feature_1', 'feature_2'];
var user = optlyInstance.createUserContext(userId);
var expectedVariables1 = optlyInstance.getAllFeatureVariables(flagKeysArray[0], userId);
var expectedVariables2 = optlyInstance.getAllFeatureVariables(flagKeysArray[1], userId);
var decisionsMap = optlyInstance.decideForKeys(user, flagKeysArray);
var decision1 = decisionsMap[flagKeysArray[0]];
var decision2 = decisionsMap[flagKeysArray[1]];
var expectedDecision1 = {
variationKey: '18257766532',
enabled: true,
variables: expectedVariables1,
ruleKey: '18322080788',
flagKey: flagKeysArray[0],
userContext: user,
reasons: [],
}
var expectedDecision2 = {
variationKey: 'variation_with_traffic',
enabled: true,
variables: expectedVariables2,
ruleKey: 'exp_no_audience',
flagKey: flagKeysArray[1],
userContext: user,
reasons: [],
}
assert.deepEqual(Object.values(decisionsMap).length, 2);
assert.deepEqual(decision1, expectedDecision1);
assert.deepEqual(decision2, expectedDecision2);
sinon.assert.calledTwice(optlyInstance.eventDispatcher.dispatchEvent);
});

it('should return decision results map with only enabled flags when ENABLED_FLAGS_ONLY flag is passed in and dispatch events', function() {
var flagKey1 = 'feature_2';
var flagKey2 = 'feature_3';
var user = optlyInstance.createUserContext(userId, {"gender": "female"});
var expectedVariables = optlyInstance.getAllFeatureVariables(flagKey1, userId);
var decisionsMap = optlyInstance.decideForKeys(user, [ flagKey1, flagKey2 ], [ OptimizelyDecideOptions.ENABLED_FLAGS_ONLY ]);
var decision = decisionsMap[flagKey1];
var expectedDecision = {
variationKey: 'variation_with_traffic',
enabled: true,
variables: expectedVariables,
ruleKey: 'exp_no_audience',
flagKey: flagKey1,
userContext: user,
reasons: [],
}
assert.deepEqual(Object.values(decisionsMap).length, 1);
assert.deepEqual(decision, expectedDecision);
sinon.assert.calledTwice(optlyInstance.eventDispatcher.dispatchEvent);
});
});

describe('#decideAll', function() {
var userId = 'tester';
describe('with empty default decide options', function() {
beforeEach(function() {
optlyInstance = new Optimizely({
clientEngine: 'node-sdk',
datafile: testData.getTestDecideProjectConfig(),
errorHandler: errorHandler,
eventDispatcher: eventDispatcher,
jsonSchemaValidator: jsonSchemaValidator,
logger: createdLogger,
isValidInstance: true,
eventBatchSize: 1,
defaultDecideOptions: [],
});

sinon.stub(optlyInstance.notificationCenter, 'sendNotifications');
});

afterEach(function() {
optlyInstance.notificationCenter.sendNotifications.restore();
});

it('should return decision results map with all flag keys provided and dispatch events', function() {
var configObj = optlyInstance.projectConfigManager.getConfig();
var allFlagKeysArray = Object.keys(configObj.featureKeyMap);
var user = optlyInstance.createUserContext(userId);
var expectedVariables1 = optlyInstance.getAllFeatureVariables(allFlagKeysArray[0], userId);
var expectedVariables2 = optlyInstance.getAllFeatureVariables(allFlagKeysArray[1], userId);
var expectedVariables3 = optlyInstance.getAllFeatureVariables(allFlagKeysArray[2], userId);
var decisionsMap = user.decideAll(allFlagKeysArray);
var decision1 = decisionsMap[allFlagKeysArray[0]];
var decision2 = decisionsMap[allFlagKeysArray[1]];
var decision3 = decisionsMap[allFlagKeysArray[2]];
var expectedDecision1 = {
variationKey: '18257766532',
enabled: true,
variables: expectedVariables1,
ruleKey: '18322080788',
flagKey: allFlagKeysArray[0],
userContext: user,
reasons: [],
}
var expectedDecision2 = {
variationKey: 'variation_with_traffic',
enabled: true,
variables: expectedVariables2,
ruleKey: 'exp_no_audience',
flagKey: allFlagKeysArray[1],
userContext: user,
reasons: [],
}
var expectedDecision3 = {
variationKey: '',
enabled: false,
variables: expectedVariables3,
ruleKey: '',
flagKey: allFlagKeysArray[2],
userContext: user,
reasons: [],
}
assert.deepEqual(Object.values(decisionsMap).length, allFlagKeysArray.length);
assert.deepEqual(decision1, expectedDecision1);
assert.deepEqual(decision2, expectedDecision2);
assert.deepEqual(decision3, expectedDecision3);
sinon.assert.calledThrice(optlyInstance.eventDispatcher.dispatchEvent);
});

it('should return decision results map with only enabled flags when ENABLED_FLAGS_ONLY flag is passed in and dispatch events', function() {
var flagKey1 = 'feature_1';
var flagKey2 = 'feature_2';
var user = optlyInstance.createUserContext(userId, {"gender": "female"});
var expectedVariables1 = optlyInstance.getAllFeatureVariables(flagKey1, userId);
var expectedVariables2 = optlyInstance.getAllFeatureVariables(flagKey2, userId);
var decisionsMap = optlyInstance.decideAll(user, [ OptimizelyDecideOptions.ENABLED_FLAGS_ONLY ]);
var decision1 = decisionsMap[flagKey1];
var decision2 = decisionsMap[flagKey2];
var expectedDecision1 = {
variationKey: '18257766532',
enabled: true,
variables: expectedVariables1,
ruleKey: '18322080788',
flagKey: flagKey1,
userContext: user,
reasons: [],
}
var expectedDecision2 = {
variationKey: 'variation_with_traffic',
enabled: true,
variables: expectedVariables2,
ruleKey: 'exp_no_audience',
flagKey: flagKey2,
userContext: user,
reasons: [],
}
assert.deepEqual(Object.values(decisionsMap).length, 2);
assert.deepEqual(decision1, expectedDecision1);
assert.deepEqual(decision2, expectedDecision2);
sinon.assert.calledThrice(optlyInstance.eventDispatcher.dispatchEvent);
});
});

describe('with ENABLED_FLAGS_ONLY flag in default decide options', function() {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add the same test with ENABLED_FLAGS_ONLY in decide call parameter?

beforeEach(function() {
optlyInstance = new Optimizely({
clientEngine: 'node-sdk',
datafile: testData.getTestDecideProjectConfig(),
errorHandler: errorHandler,
eventDispatcher: eventDispatcher,
jsonSchemaValidator: jsonSchemaValidator,
logger: createdLogger,
isValidInstance: true,
eventBatchSize: 1,
defaultDecideOptions: [ OptimizelyDecideOptions.ENABLED_FLAGS_ONLY ],
});

sinon.stub(optlyInstance.notificationCenter, 'sendNotifications');
});

afterEach(function() {
optlyInstance.notificationCenter.sendNotifications.restore();
});

it('should return decision results map with only enabled flags and dispatch events', function() {
var flagKey1 = 'feature_1';
var flagKey2 = 'feature_2';
var user = optlyInstance.createUserContext(userId, {"gender": "female"});
var expectedVariables1 = optlyInstance.getAllFeatureVariables(flagKey1, userId);
var expectedVariables2 = optlyInstance.getAllFeatureVariables(flagKey2, userId);
var decisionsMap = optlyInstance.decideAll(user);
var decision1 = decisionsMap[flagKey1];
var decision2 = decisionsMap[flagKey2];
var expectedDecision1 = {
variationKey: '18257766532',
enabled: true,
variables: expectedVariables1,
ruleKey: '18322080788',
flagKey: flagKey1,
userContext: user,
reasons: [],
}
var expectedDecision2 = {
variationKey: 'variation_with_traffic',
enabled: true,
variables: expectedVariables2,
ruleKey: 'exp_no_audience',
flagKey: flagKey2,
userContext: user,
reasons: [],
}
assert.deepEqual(Object.values(decisionsMap).length, 2);
assert.deepEqual(decision1, expectedDecision1);
assert.deepEqual(decision2, expectedDecision2);
sinon.assert.calledThrice(optlyInstance.eventDispatcher.dispatchEvent);
});

it('should return decision results map with only enabled flags and excluded variables when EXCLUDE_VARIABLES_FLAG is passed in', function() {
Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't it supposed to return all flags (not only enabled flags)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It should return enabled flags only because [ OptimizelyDecideOptions. ENABLED_FLAGS_ONLY ] is passed in defaultDecideOptions when instantiating optimizely client

var flagKey1 = 'feature_1';
var flagKey2 = 'feature_2';
var user = optlyInstance.createUserContext(userId, {"gender": "female"});
var decisionsMap = optlyInstance.decideAll(user, [ OptimizelyDecideOptions.EXCLUDE_VARIABLES ]);
var decision1 = decisionsMap[flagKey1];
var decision2 = decisionsMap[flagKey2];
var expectedDecision1 = {
variationKey: '18257766532',
enabled: true,
variables: {},
ruleKey: '18322080788',
flagKey: flagKey1,
userContext: user,
reasons: [],
}
var expectedDecision2 = {
variationKey: 'variation_with_traffic',
enabled: true,
variables: {},
ruleKey: 'exp_no_audience',
flagKey: flagKey2,
userContext: user,
reasons: [],
}
assert.deepEqual(Object.values(decisionsMap).length, 2);
assert.deepEqual(decision1, expectedDecision1);
assert.deepEqual(decision2, expectedDecision2);
sinon.assert.calledThrice(optlyInstance.eventDispatcher.dispatchEvent);
});
});
});
});

//tests separated out from APIs because of mock bucketing
Expand Down
57 changes: 57 additions & 0 deletions packages/optimizely-sdk/lib/optimizely/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1593,4 +1593,61 @@ export default class Optimizely {

return allDecideOptions;
}

/**
* Returns an object of decision results for multiple flag keys and a user context.
* If the SDK finds an error for a key, the response will include a decision for the key showing reasons for the error.
* The SDK will always return an object of decisions. When it cannot process requests, it will return an empty object after logging the errors.
* @param {OptimizelyUserContext} user A user context associated with this OptimizelyClient
* @param {string[]} keys An array of flag keys for which decisions will be made.
* @param {OptimizelyDecideOptions[]} options An array of options for decision-making.
* @return {[key: string]: OptimizelyDecision} An object of decision results mapped by flag keys.
*/

decideForKeys(
user: OptimizelyUserContext,
keys: string[],
options: OptimizelyDecideOptions[] = []
): { [key: string]: OptimizelyDecision } {
const decisionMap: { [key: string]: OptimizelyDecision } = {};
if (!this.isValidInstance()) {
this.logger.log(LOG_LEVEL.ERROR, sprintf(LOG_MESSAGES.INVALID_OBJECT, MODULE_NAME, 'decideForKeys'));
return decisionMap;
}
if (keys.length === 0) {
return decisionMap;
}

const allDecideOptions = this.getAllDecideOptions(options);
keys.forEach(key => {
const optimizelyDecision: OptimizelyDecision = this.decide(user, key, options);
if (!allDecideOptions[OptimizelyDecideOptions.ENABLED_FLAGS_ONLY] || optimizelyDecision.enabled) {
decisionMap[key] = optimizelyDecision;
}
});

return decisionMap;
}

/**
* Returns an object of decision results for all active flag keys.
* @param {OptimizelyUserContext} user A user context associated with this OptimizelyClient
* @param {OptimizelyDecideOptions[]} options An array of options for decision-making.
* @return {[key: string]: OptimizelyDecision} An object of all decision results mapped by flag keys.
*/
decideAll(
user: OptimizelyUserContext,
options: OptimizelyDecideOptions[] = []
): { [key: string]: OptimizelyDecision } {
const configObj = this.projectConfigManager.getConfig();
const decisionMap: { [key: string]: OptimizelyDecision } = {};
if (!this.isValidInstance() || !configObj) {
this.logger.log(LOG_LEVEL.ERROR, sprintf(LOG_MESSAGES.INVALID_OBJECT, MODULE_NAME, 'decideAll'));
return decisionMap;
}

const allFlagKeys = Object.keys(configObj.featureKeyMap);

return this.decideForKeys(user, allFlagKeys, options);
}
}
Loading