fix: removed a check that returns false on empty key. (#717)

* removed a check that returns false on empty key.

Author: msohailhussain

packages/optimizely-sdk/lib/core/event_builder/build_event_v1.ts

@@ -159,8 +159,8 @@ function makeConversionSnapshot(conversion: ConversionEvent): Snapshot {
 function makeDecisionSnapshot(event: ImpressionEvent): Snapshot {
   const { layer, experiment, variation, ruleKey, flagKey, ruleType, enabled } = event
   const layerId = layer ? layer.id : null
-  const experimentId = experiment ? experiment.id : null
-  const variationId = variation ? variation.id : null
+  const experimentId = experiment?.id ?? ''
+  const variationId = variation?.id ?? ''
   const variationKey = variation ? variation.key : ''
 
   return {

packages/optimizely-sdk/lib/optimizely/index.tests.js

@@ -6717,8 +6717,8 @@ describe('lib/optimizely', function() {
                       decisions: [
                         {
                           campaign_id: null,
-                          experiment_id: null,
-                          variation_id: null,
+                          experiment_id: '',
+                          variation_id: '',
                           metadata: {
                             flag_key: 'test_feature',
                             rule_key: '',

packages/optimizely-sdk/lib/optimizely_user_context/index.tests.js

@@ -26,7 +26,7 @@ import { createNotificationCenter } from '../core/notification_center';
 import Optimizely from '../optimizely';
 import errorHandler from '../plugins/error_handler';
 import eventDispatcher from '../plugins/event_dispatcher/index.node';
-import { DECISION_MESSAGES, LOG_LEVEL, LOG_MESSAGES } from '../utils/enums';
+import { CONTROL_ATTRIBUTES, DECISION_MESSAGES, LOG_LEVEL, LOG_MESSAGES } from '../utils/enums';
 import testData from '../tests/test_data';
 import { OptimizelyDecideOption } from '../shared_types';
 
@@ -328,7 +328,7 @@ describe('lib/optimizely_user_context', function() {
         assert.strictEqual(stubLogHandler.log.args[0][1], DECISION_MESSAGES.SDK_NOT_READY);
       });
 
-      it('should return false when provided empty string flagKey', function() {
+      it('should return true when provided empty string flagKey', function() {
         fakeOptimizely = {
           isValidInstance: sinon.stub().returns(true)
         };
@@ -337,7 +337,7 @@ describe('lib/optimizely_user_context', function() {
           userId: 'user123',
         });
         var result = user.setForcedDecision({ flagKey: '' }, '3324490562');
-        assert.strictEqual(result, false);
+        assert.strictEqual(result, true);
         sinon.assert.notCalled(stubLogHandler.log);
       });
 
@@ -400,7 +400,7 @@ describe('lib/optimizely_user_context', function() {
           assert.equal(decision.userContext.getUserId(), userId);
           assert.deepEqual(decision.userContext.getAttributes(), {});
           assert.deepEqual(Object.keys(decision.userContext.forcedDecisionsMap).length, 1);
-          assert.deepEqual(decision.userContext.forcedDecisionsMap[featureKey]['$null-rule-key'], { variationKey });
+          assert.deepEqual(decision.userContext.forcedDecisionsMap[featureKey][CONTROL_ATTRIBUTES.FORCED_DECISION_NULL_RULE_KEY], { variationKey });
           assert.equal(
             true,
             decision.reasons.includes(
@@ -429,7 +429,7 @@ describe('lib/optimizely_user_context', function() {
           assert.equal(decision.userContext.getUserId(), userId);
           assert.deepEqual(decision.userContext.getAttributes(), {});
           assert.deepEqual(Object.values(decision.userContext.forcedDecisionsMap).length, 1);
-          assert.deepEqual(decision.userContext.forcedDecisionsMap[featureKey]['$null-rule-key'], { variationKey });
+          assert.deepEqual(decision.userContext.forcedDecisionsMap[featureKey][CONTROL_ATTRIBUTES.FORCED_DECISION_NULL_RULE_KEY], { variationKey });
           assert.equal(
             true,
             decision.reasons.includes(
@@ -448,7 +448,7 @@ describe('lib/optimizely_user_context', function() {
           var eventDecision = impressionEvent.params.visitors[0].snapshots[0].decisions[0];
           var metadata = eventDecision.metadata;
 
-          assert.equal(eventDecision.experiment_id, null);
+          assert.equal(eventDecision.experiment_id, '');
           assert.equal(eventDecision.variation_id, '3324490562');
 
           assert.equal(metadata.flag_key, featureKey);
@@ -561,6 +561,7 @@ describe('lib/optimizely_user_context', function() {
                 },
                 decisionEventDispatched: true,
                 reasons: [
+
                   sprintf(
                     LOG_MESSAGES.USER_HAS_FORCED_DECISION_WITH_RULE_SPECIFIED,
                     variationKey,
@@ -681,7 +682,7 @@ describe('lib/optimizely_user_context', function() {
           assert.equal(decision.variationKey, '18257766532');
           assert.equal(decision.ruleKey, '18322080788');
           assert.deepEqual(Object.keys(decision.userContext.forcedDecisionsMap).length, 1);
-          assert.deepEqual(decision.userContext.forcedDecisionsMap[featureKey]['$null-rule-key'], { variationKey });
+          assert.deepEqual(decision.userContext.forcedDecisionsMap[featureKey][CONTROL_ATTRIBUTES.FORCED_DECISION_NULL_RULE_KEY], { variationKey });
           assert.equal(
             true,
             decision.reasons.includes(

packages/optimizely-sdk/lib/optimizely_user_context/index.ts

@@ -26,7 +26,7 @@ import {
   UserAttributes,
   Variation
 } from '../../lib/shared_types';
-import { DECISION_MESSAGES, LOG_MESSAGES } from '../utils/enums';
+import { DECISION_MESSAGES, LOG_MESSAGES, CONTROL_ATTRIBUTES } from '../utils/enums';
 
 const logger = getLogger();
 
@@ -137,11 +137,8 @@ export default class OptimizelyUserContext {
     }
 
     const flagKey = context.flagKey;
-    if (flagKey === '') {
-      return false;
-    }
 
-    const ruleKey = context.ruleKey ?? '$null-rule-key';
+    const ruleKey = context.ruleKey ?? CONTROL_ATTRIBUTES.FORCED_DECISION_NULL_RULE_KEY;
     const variationKey  = decision.variationKey;
     const forcedDecision = { variationKey };
 
@@ -178,7 +175,7 @@ export default class OptimizelyUserContext {
       return false;
     }
 
-    const ruleKey = context.ruleKey ?? '$null-rule-key';
+    const ruleKey = context.ruleKey ?? CONTROL_ATTRIBUTES.FORCED_DECISION_NULL_RULE_KEY;
     const flagKey = context.flagKey;
 
     let isForcedDecisionRemoved = false;
@@ -218,7 +215,7 @@ export default class OptimizelyUserContext {
    */
   private findForcedDecision(context: OptimizelyDecisionContext): OptimizelyForcedDecision | null {
     let variationKey;
-    const validRuleKey = context.ruleKey ?? '$null-rule-key';
+    const validRuleKey = context.ruleKey ?? CONTROL_ATTRIBUTES.FORCED_DECISION_NULL_RULE_KEY;
     const flagKey = context.flagKey;
 
     if (this.forcedDecisionsMap.hasOwnProperty(context.flagKey)) {

packages/optimizely-sdk/lib/utils/enums/index.ts

@@ -174,6 +174,7 @@ export const CONTROL_ATTRIBUTES = {
   BUCKETING_ID: '$opt_bucketing_id',
   STICKY_BUCKETING_KEY: '$opt_experiment_bucket_map',
   USER_AGENT: '$opt_user_agent',
+  FORCED_DECISION_NULL_RULE_KEY: '$opt_null_rule_key'
 };
 
 export const JAVASCRIPT_CLIENT_ENGINE = 'javascript-sdk';

packages/optimizely-sdk/package-lock.json

@@ -42,7 +42,7 @@
   "homepage": "https://github.com/optimizely/javascript-sdk/tree/master/packages/optimizely-sdk",
   "dependencies": {
     "@optimizely/js-sdk-datafile-manager": "^0.9.1",
-    "@optimizely/js-sdk-event-processor": "^0.9.1",
+    "@optimizely/js-sdk-event-processor": "^0.9.2",
     "@optimizely/js-sdk-logging": "^0.3.1",
     "@optimizely/js-sdk-utils": "^0.4.0",
     "json-schema": "^0.2.3",