Skip to content

[FSSDK-11101] refactor handling of no config availability #998

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
raju-opti merged 2 commits into from
Feb 3, 2025
Merged

[FSSDK-11101] refactor handling of no config availability #998

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51d882f
[FSSDK-11101] refactor handling of no config availability
raju-opti Jan 30, 2025
534177b
review fix
raju-opti Feb 3, 2025
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/message/error_message.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export const UNKNOWN_CONDITION_TYPE =
export const UNKNOWN_MATCH_TYPE =
'Audience condition %s uses an unknown match type. You may need to upgrade to a newer release of the Optimizely SDK.';
export const UNRECOGNIZED_DECIDE_OPTION = 'Unrecognized decide option %s provided.';
export const INVALID_OBJECT = 'Optimizely object is not valid. Failing %s.';
export const NO_PROJECT_CONFIG_FAILURE = 'No project config available. Failing %s.';
export const EVENT_KEY_NOT_FOUND = 'Event key %s is not in datafile.';
export const NOT_TRACKING_USER = 'Not tracking user %s.';
export const VARIABLE_REQUESTED_WITH_WRONG_TYPE =
Expand Down
107 changes: 42 additions & 65 deletions lib/optimizely/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { OdpManager } from '../odp/odp_manager';
import { VuidManager } from '../vuid/vuid_manager';
import { OdpEvent } from '../odp/event_manager/odp_event';
import { OptimizelySegmentOption } from '../odp/segment_manager/optimizely_segment_option';
import { BaseService } from '../service';

import {
UserAttributes,
Expand Down Expand Up @@ -71,7 +72,7 @@ import {
ODP_EVENT_FAILED_ODP_MANAGER_MISSING,
UNABLE_TO_GET_VUID_VUID_MANAGER_NOT_AVAILABLE,
UNRECOGNIZED_DECIDE_OPTION,
INVALID_OBJECT,
NO_PROJECT_CONFIG_FAILURE,
EVENT_KEY_NOT_FOUND,
NOT_TRACKING_USER,
VARIABLE_REQUESTED_WITH_WRONG_TYPE,
Expand Down Expand Up @@ -267,11 +268,9 @@ export default class Optimizely implements Client {

/**
* Returns a truthy value if this instance currently has a valid project config
* object, and the initial configuration object that was passed into the
* constructor was also valid.
* @return {boolean}
*/
isValidInstance(): boolean {
private hasProjectConfig(): boolean {
return !!this.projectConfigManager.getConfig();
}

Expand All @@ -284,20 +283,16 @@ export default class Optimizely implements Client {
*/
activate(experimentKey: string, userId: string, attributes?: UserAttributes): string | null {
try {
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'activate');
const configObj = this.projectConfigManager.getConfig();
if (!configObj) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'activate');
return null;
}

if (!this.validateInputs({ experiment_key: experimentKey, user_id: userId }, attributes)) {
return this.notActivatingExperiment(experimentKey, userId);
}

const configObj = this.projectConfigManager.getConfig();
if (!configObj) {
return null;
}

try {
const variationKey = this.getVariation(experimentKey, userId, attributes);
if (variationKey === null) {
Expand Down Expand Up @@ -394,20 +389,16 @@ export default class Optimizely implements Client {
return;
}

if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'track');
const configObj = this.projectConfigManager.getConfig();
Copy link
Contributor

@junaed-optimizely junaed-optimizely Feb 3, 2025

Choose a reason for hiding this comment

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

Same as above

if (!configObj) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'track');
return;
}

if (!this.validateInputs({ user_id: userId, event_key: eventKey }, attributes, eventTags)) {
return;
}

const configObj = this.projectConfigManager.getConfig();
if (!configObj) {
return;
}


if (!projectConfig.eventWithKeyExists(configObj, eventKey)) {
this.logger?.warn(EVENT_KEY_NOT_FOUND, eventKey);
Expand Down Expand Up @@ -453,8 +444,9 @@ export default class Optimizely implements Client {
*/
getVariation(experimentKey: string, userId: string, attributes?: UserAttributes): string | null {
try {
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'getVariation');
const configObj = this.projectConfigManager.getConfig();
Copy link
Contributor

@junaed-optimizely junaed-optimizely Feb 3, 2025

Choose a reason for hiding this comment

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

Same as above

if (!configObj) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'getVariation');
return null;
}

Expand All @@ -463,11 +455,6 @@ export default class Optimizely implements Client {
return null;
}

const configObj = this.projectConfigManager.getConfig();
if (!configObj) {
return null;
}

const experiment = configObj.experimentKeyMap[experimentKey];
if (!experiment || experiment.isRollout) {
this.logger?.debug(INVALID_EXPERIMENT_KEY_INFO, experimentKey);
Expand Down Expand Up @@ -624,20 +611,16 @@ export default class Optimizely implements Client {
*/
isFeatureEnabled(featureKey: string, userId: string, attributes?: UserAttributes): boolean {
try {
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'isFeatureEnabled');
const configObj = this.projectConfigManager.getConfig();
Copy link
Contributor

@junaed-optimizely junaed-optimizely Feb 3, 2025

Choose a reason for hiding this comment

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

Same as above

if (!configObj) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'isFeatureEnabled');
return false;
}

if (!this.validateInputs({ feature_key: featureKey, user_id: userId }, attributes)) {
return false;
}

const configObj = this.projectConfigManager.getConfig();
if (!configObj) {
return false;
}

const feature = projectConfig.getFeatureFromKey(configObj, featureKey, this.logger);
if (!feature) {
return false;
Expand Down Expand Up @@ -704,17 +687,14 @@ export default class Optimizely implements Client {
getEnabledFeatures(userId: string, attributes?: UserAttributes): string[] {
try {
const enabledFeatures: string[] = [];
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'getEnabledFeatures');
return enabledFeatures;
}

if (!this.validateInputs({ user_id: userId })) {
const configObj = this.projectConfigManager.getConfig();
Copy link
Contributor

@junaed-optimizely junaed-optimizely Feb 3, 2025

Choose a reason for hiding this comment

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

Same as above

if (!configObj) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'getEnabledFeatures');
return enabledFeatures;
}

const configObj = this.projectConfigManager.getConfig();
if (!configObj) {
if (!this.validateInputs({ user_id: userId })) {
return enabledFeatures;
}

Expand Down Expand Up @@ -752,8 +732,8 @@ export default class Optimizely implements Client {
attributes?: UserAttributes
): FeatureVariableValue {
try {
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'getFeatureVariable');
if (!this.hasProjectConfig()) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'getFeatureVariable');
return null;
}
return this.getFeatureVariableForType(featureKey, variableKey, null, userId, attributes);
Expand Down Expand Up @@ -946,8 +926,8 @@ export default class Optimizely implements Client {
attributes?: UserAttributes
): boolean | null {
try {
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'getFeatureVariableBoolean');
if (!this.hasProjectConfig()) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'getFeatureVariableBoolean');
return null;
}
return this.getFeatureVariableForType(
Expand Down Expand Up @@ -984,8 +964,8 @@ export default class Optimizely implements Client {
attributes?: UserAttributes
): number | null {
try {
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'getFeatureVariableDouble');
if (!this.hasProjectConfig()) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'getFeatureVariableDouble');
return null;
}
return this.getFeatureVariableForType(
Expand Down Expand Up @@ -1022,8 +1002,8 @@ export default class Optimizely implements Client {
attributes?: UserAttributes
): number | null {
try {
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'getFeatureVariableInteger');
if (!this.hasProjectConfig()) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'getFeatureVariableInteger');
return null;
}
return this.getFeatureVariableForType(
Expand Down Expand Up @@ -1060,8 +1040,8 @@ export default class Optimizely implements Client {
attributes?: UserAttributes
): string | null {
try {
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'getFeatureVariableString');
if (!this.hasProjectConfig()) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'getFeatureVariableString');
return null;
}
return this.getFeatureVariableForType(
Expand Down Expand Up @@ -1093,8 +1073,8 @@ export default class Optimizely implements Client {
*/
getFeatureVariableJSON(featureKey: string, variableKey: string, userId: string, attributes: UserAttributes): unknown {
try {
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'getFeatureVariableJSON');
if (!this.hasProjectConfig()) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'getFeatureVariableJSON');
return null;
}
return this.getFeatureVariableForType(featureKey, variableKey, FEATURE_VARIABLE_TYPES.JSON, userId, attributes);
Expand All @@ -1120,17 +1100,14 @@ export default class Optimizely implements Client {
attributes?: UserAttributes
): { [variableKey: string]: unknown } | null {
try {
if (!this.isValidInstance()) {
this.logger?.error(INVALID_OBJECT, 'getAllFeatureVariables');
return null;
}
const configObj = this.projectConfigManager.getConfig();
Copy link
Contributor

@junaed-optimizely junaed-optimizely Feb 3, 2025

Choose a reason for hiding this comment

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

Same as above


if (!this.validateInputs({ feature_key: featureKey, user_id: userId }, attributes)) {
if (!configObj) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'getAllFeatureVariables');
return null;
}

const configObj = this.projectConfigManager.getConfig();
if (!configObj) {
if (!this.validateInputs({ feature_key: featureKey, user_id: userId }, attributes)) {
return null;
}

Expand Down Expand Up @@ -1425,8 +1402,8 @@ export default class Optimizely implements Client {
decide(user: OptimizelyUserContext, key: string, options: OptimizelyDecideOption[] = []): OptimizelyDecision {
const configObj = this.projectConfigManager.getConfig();

if (!this.isValidInstance() || !configObj) {
this.logger?.error(INVALID_OBJECT, 'decide');
if (!configObj) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'decide');
return newErrorDecision(key, user, [DECISION_MESSAGES.SDK_NOT_READY]);
}

Expand Down Expand Up @@ -1570,8 +1547,8 @@ export default class Optimizely implements Client {

const configObj = this.projectConfigManager.getConfig()

if (!this.isValidInstance() || !configObj) {
this.logger?.error(INVALID_OBJECT, 'decideForKeys');
if (!configObj) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'decideForKeys');
return decisionMap;
}
if (keys.length === 0) {
Expand Down Expand Up @@ -1638,10 +1615,10 @@ export default class Optimizely implements Client {
user: OptimizelyUserContext,
options: OptimizelyDecideOption[] = []
): { [key: string]: OptimizelyDecision } {
const configObj = this.projectConfigManager.getConfig();
const decisionMap: { [key: string]: OptimizelyDecision } = {};
if (!this.isValidInstance() || !configObj) {
this.logger?.error(INVALID_OBJECT, 'decideAll');
const configObj = this.projectConfigManager.getConfig();
Copy link
Contributor

@junaed-optimizely junaed-optimizely Feb 3, 2025

Choose a reason for hiding this comment

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

Same as above

if (!configObj) {
this.errorReporter.report(NO_PROJECT_CONFIG_FAILURE, 'decideAll');
return decisionMap;
}

Expand Down
Loading