Skip to content

refac: findValidatedForcedDecision method moved to decision service #730

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 6 commits into from
Jan 14, 2022
Merged

refac: findValidatedForcedDecision method moved to decision service #730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
71e098b
Moves ValidateForcedDecision
NomanShoaib Dec 22, 2021
e9091b4
testcase fixed
ozayr-zaviar Dec 23, 2021
01c3eb2
decision service import removed
ozayr-zaviar Dec 23, 2021
79a249e
hardcoded values removed with variables
ozayr-zaviar Dec 23, 2021
e488a6b
Updated Headers
mnoman09 Jan 4, 2022
712f7ff
removed logger from optimizelyUsercontext class
NomanShoaib Jan 5, 2022
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
98 changes: 95 additions & 3 deletions packages/optimizely-sdk/lib/core/decision_service/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/****************************************************************************
* Copyright 2017-2021 Optimizely, Inc. and contributors *
* Copyright 2017-2022 Optimizely, Inc. and contributors *
* *
* Licensed under the Apache License, Version 2.0 (the "License"); *
* you may not use this file except in compliance with the License. *
Expand Down Expand Up @@ -776,6 +776,98 @@ export class DecisionService {
return bucketingId;
}

/**
* Finds a validated forced decision for specific flagKey and optional ruleKey.
* @param {ProjectConfig} config A projectConfig.
* @param {OptimizelyUserContext} user A Optimizely User Context.
* @param {string} flagKey A flagKey.
* @param {ruleKey} ruleKey A ruleKey (optional).
* @return {DecisionResponse<Variation|null>} DecisionResponse object containing valid variation object and decide reasons.
*/
findValidatedForcedDecision(
config: ProjectConfig,
user: OptimizelyUserContext,
flagKey: string,
ruleKey?: string
): DecisionResponse<Variation | null> {

const decideReasons: (string | number)[][] = [];
const forcedDecision = user.getForcedDecision({ flagKey, ruleKey });
let variation = null;
let variationKey;
const userId = user.getUserId()
if (config && forcedDecision) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion (non binding): If we move the check for config at the top, we will save a redundant call to getForcedDecision when config is not available.

variationKey = forcedDecision.variationKey;
variation = getFlagVariationByKey(config, flagKey, variationKey);
if (variation) {
if (ruleKey) {
this.logger.log(
LOG_LEVEL.INFO,
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_RULE_SPECIFIED,
variationKey,
flagKey,
ruleKey,
userId
);
decideReasons.push([
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_RULE_SPECIFIED,
variationKey,
flagKey,
ruleKey,
userId
]);
} else {
this.logger.log(
LOG_LEVEL.INFO,
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_NO_RULE_SPECIFIED,
variationKey,
flagKey,
userId
);
decideReasons.push([
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_NO_RULE_SPECIFIED,
variationKey,
flagKey,
userId
])
}
} else {
if (ruleKey) {
this.logger.log(
LOG_LEVEL.INFO,
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_RULE_SPECIFIED_BUT_INVALID,
flagKey,
ruleKey,
userId
);
decideReasons.push([
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_RULE_SPECIFIED_BUT_INVALID,
flagKey,
ruleKey,
userId
]);
} else {
this.logger.log(
LOG_LEVEL.INFO,
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_NO_RULE_SPECIFIED_BUT_INVALID,
flagKey,
userId
);
decideReasons.push([
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_NO_RULE_SPECIFIED_BUT_INVALID,
flagKey,
userId
])
}
}
}

return {
result: variation,
reasons: decideReasons,
}
}

/**
* Removes forced variation for given userId and experimentKey
* @param {string} userId String representing the user id
Expand Down Expand Up @@ -1021,7 +1113,7 @@ export class DecisionService {
const decideReasons: (string | number)[][] = [];

// check forced decision first
const forcedDecisionResponse = user.findValidatedForcedDecision(configObj, flagKey, rule.key);
const forcedDecisionResponse = this.findValidatedForcedDecision(configObj, user, flagKey, rule.key);
decideReasons.push(...forcedDecisionResponse.reasons);

const forcedVariaton = forcedDecisionResponse.result;
Expand Down Expand Up @@ -1053,7 +1145,7 @@ export class DecisionService {

// check forced decision first
const rule = rules[ruleIndex];
const forcedDecisionResponse = user.findValidatedForcedDecision(configObj, flagKey, rule.key);
const forcedDecisionResponse = this.findValidatedForcedDecision(configObj, user, flagKey, rule.key);
decideReasons.push(...forcedDecisionResponse.reasons);

const forcedVariaton = forcedDecisionResponse.result;
Expand Down
4 changes: 2 additions & 2 deletions packages/optimizely-sdk/lib/optimizely/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/****************************************************************************
* Copyright 2020-2021, Optimizely, Inc. and contributors *
* Copyright 2020-2022, Optimizely, Inc. and contributors *
* *
* Licensed under the Apache License, Version 2.0 (the "License"); *
* you may not use this file except in compliance with the License. *
Expand Down Expand Up @@ -1481,7 +1481,7 @@ export default class Optimizely {

const allDecideOptions = this.getAllDecideOptions(options);

const forcedDecisionResponse = user.findValidatedForcedDecision(configObj, key);
const forcedDecisionResponse = this.decisionService.findValidatedForcedDecision(configObj, user, key);
reasons.push(...forcedDecisionResponse.reasons);
const variation = forcedDecisionResponse.result;
if (variation) {
Expand Down
22 changes: 10 additions & 12 deletions packages/optimizely-sdk/lib/optimizely_user_context/index.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/****************************************************************************
* Copyright 2020-2021, Optimizely, Inc. and contributors *
* Copyright 2020-2022, Optimizely, Inc. and contributors *
* *
* Licensed under the Apache License, Version 2.0 (the "License"); *
* you may not use this file except in compliance with the License. *
Expand Down Expand Up @@ -372,11 +372,13 @@ describe('lib/optimizely_user_context', function() {
notificationCenter,
});

sinon.stub(optlyInstance.decisionService.logger, 'log')
sinon.stub(eventDispatcher, 'dispatchEvent');
sinon.stub(optlyInstance.notificationCenter, 'sendNotifications');
});

afterEach(function() {
optlyInstance.decisionService.logger.log.restore();
eventDispatcher.dispatchEvent.restore();
optlyInstance.notificationCenter.sendNotifications.restore();
});
Expand Down Expand Up @@ -610,17 +612,13 @@ describe('lib/optimizely_user_context', function() {
assert.deepEqual(decision.userContext.forcedDecisionsMap[featureKey][ruleKey], { variationKey });

sinon.assert.called(stubLogHandler.log);
var logMessage = stubLogHandler.log.args[4][1];
assert.strictEqual(
logMessage,
sprintf(
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_RULE_SPECIFIED,
variationKey,
featureKey,
ruleKey,
userId,
)
);
var logMessage = optlyInstance.decisionService.logger.log.args[4];
assert.strictEqual(logMessage[0], 2);
assert.strictEqual(logMessage[1], 'Variation (%s) is mapped to flag (%s), rule (%s) and user (%s) in the forced decision map.');
assert.strictEqual(logMessage[2], variationKey);
assert.strictEqual(logMessage[3], featureKey);
assert.strictEqual(logMessage[4], ruleKey);
assert.strictEqual(logMessage[5], userId);

sinon.assert.calledOnce(eventDispatcher.dispatchEvent);
var callArgs = eventDispatcher.dispatchEvent.getCalls()[0].args;
Expand Down
91 changes: 1 addition & 90 deletions packages/optimizely-sdk/lib/optimizely_user_context/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/****************************************************************************
* Copyright 2020-2021, Optimizely, Inc. and contributors *
* Copyright 2020-2022, Optimizely, Inc. and contributors *
* *
* Licensed under the Apache License, Version 2.0 (the "License"); *
* you may not use this file except in compliance with the License. *
Expand All @@ -13,8 +13,6 @@
* See the License for the specific language governing permissions and *
* limitations under the License. *
***************************************************************************/
import { getLogger } from '@optimizely/js-sdk-logging';

import Optimizely from '../../lib/optimizely';
import {
DecisionResponse,
Expand All @@ -32,8 +30,6 @@ import {
} from '../core/project_config';
import { LOG_MESSAGES, CONTROL_ATTRIBUTES } from '../utils/enums';

const logger = getLogger();

export default class OptimizelyUserContext {
private optimizely: Optimizely;
private userId: string;
Expand Down Expand Up @@ -213,91 +209,6 @@ export default class OptimizelyUserContext {
return null;
}

/**
* Finds a validated forced decision for specific flagKey and optional ruleKey.
* @param {ProjectConfig}config A projectConfig.
* @param {string} flagKey A flagKey.
* @param {ruleKey} ruleKey A ruleKey (optional).
* @return {DecisionResponse<Variation|null>} DecisionResponse object containing valid variation object and decide reasons.
*/
findValidatedForcedDecision(
config: ProjectConfig,
flagKey: string,
ruleKey?: string,
): DecisionResponse<Variation | null> {

const decideReasons: (string | number)[][] = [];
const forcedDecision = this.findForcedDecision({ flagKey, ruleKey });
let variation = null;
let variationKey;
if (config && forcedDecision) {
variationKey = forcedDecision.variationKey;
variation = getFlagVariationByKey(config, flagKey, variationKey);
if (variation) {
if (ruleKey) {
logger.info(
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_RULE_SPECIFIED,
variationKey,
flagKey,
ruleKey,
this.userId
);
decideReasons.push([
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_RULE_SPECIFIED,
variationKey,
flagKey,
ruleKey,
this.userId
]);
} else {
logger.info(
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_NO_RULE_SPECIFIED,
variationKey,
flagKey,
this.userId
);
decideReasons.push([
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_NO_RULE_SPECIFIED,
variationKey,
flagKey,
this.userId
])
}
} else {
if (ruleKey) {
logger.info(
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_RULE_SPECIFIED_BUT_INVALID,
flagKey,
ruleKey,
this.userId
);
decideReasons.push([
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_RULE_SPECIFIED_BUT_INVALID,
flagKey,
ruleKey,
this.userId
]);
} else {
logger.info(
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_NO_RULE_SPECIFIED_BUT_INVALID,
flagKey,
this.userId
);
decideReasons.push([
LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_NO_RULE_SPECIFIED_BUT_INVALID,
flagKey,
this.userId
])
}
}
}

return {
result: variation,
reasons: decideReasons,
}
}

Copy link
Contributor

Choose a reason for hiding this comment

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

import logger on line 16 and get_logger on line 35 can be removed.

private cloneUserContext(): OptimizelyUserContext {
const userContext = new OptimizelyUserContext({
optimizely: this.getOptimizely(),
Expand Down
7 changes: 1 addition & 6 deletions packages/optimizely-sdk/lib/shared_types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2020-2021, Optimizely
* Copyright 2020-2022, Optimizely
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -382,11 +382,6 @@ export interface OptimizelyUserContext {
options: OptimizelyDecideOption[],
): { [key: string]: OptimizelyDecision };
trackEvent(eventName: string, eventTags?: EventTags): void;
findValidatedForcedDecision(
config: ProjectConfig,
flagKey: string,
ruleKey?: string
): DecisionResponse<Variation | null>;
setForcedDecision(context: OptimizelyDecisionContext, decision: OptimizelyForcedDecision): boolean;
getForcedDecision(context: OptimizelyDecisionContext): OptimizelyForcedDecision | null;
removeForcedDecision(context: OptimizelyDecisionContext): boolean;
Expand Down