Update Opticks to support Optimizely's JS SDK v5.3.2

README.md

@@ -14,24 +14,18 @@ The library consists of two related concepts:
 
 At the heart of our experimentation framework is the `toggle` function.
 
-- `toggle` toggles that switch between multiple experiment variants (a/b/c/...)
-- `booleanToggle` toggles that turn functionality on or off (feature flags)
+A toggle allows you to switch between multiple experiment variants (a/b/c/...)
+and also turn functionality on or off (feature flags)
 
 It can be used in a variety of ways:
 
 1.  Reading the value of the toggle (boolean, or a/b/c for multi toggles )
 1.  Execute code or for a variant of a multi toggle
 1.  Execute code when a boolean toggle is on
 
-We use React at FindHotel and some of the code examples use JSX, but the code
+We use React at vio.com and some of the code examples use JSX, but the code
 and concept is compatible with any front-end framework or architecture.
 
-The `booleanToggle` is the simplest toggle type to use for feature flagging, but
-it's also the least flexible. As of version 2.0 `toggle` is the default and
-recommended for both a/b/c experiments and feature flags. If you're only ever
-interested in feature flags, read more about [Boolean
-Toggles](docs/booleanToggles.md).
-
 ### Opticks vs other experimentation frameworks
 
 The main reason for using the Opticks library is to be able to clean your code
@@ -64,9 +58,9 @@ See the [Optimizely integration documentation](docs/optimizely-integration.md).
 
 ## Toggles
 
-Toggles can be used to implement a/b/c style testing, instead of on/off values
-as with `booleanToggle`, we specify multiple variants of which one is active at
-any time. By convention the variants are named `a` (control), `b`, `c` etc.
+Toggles can be used to implement a/b/c style testing and on/off values as well.
+We specify multiple variants of which one is active at any time.
+By convention the variants are named `a` (control), `b`, `c` etc.
 
 ### Reading values
 
@@ -133,7 +127,7 @@ experimentId, then the values for `a`, `b`, etc.
 For instance:
 
 ```
-// simple boolean switch: (you could use a BooleanToggle as well)
+// simple boolean switch
 const shouldDoSomething = toggle('foo', false, true)
 
 // multiple variants as strings

packages/lib/package.json

@@ -33,10 +33,10 @@
   "author": "Jop de Klein",
   "license": "ISC",
   "peerDependencies": {
-    "@optimizely/optimizely-sdk": "~4.4.3"
+    "@optimizely/optimizely-sdk": "5.3.2"
   },
   "devDependencies": {
-    "@optimizely/optimizely-sdk": "~4.4.3",
+    "@optimizely/optimizely-sdk": "5.3.2",
     "@types/jest": "^29.4.0",
     "jest": "^29.4.0",
     "ts-jest": "^29.0.5",

packages/lib/src/integrations/__fixtures__/dataFile.ts

@@ -1,10 +1,98 @@
 export default {
   accountId: '12345',
-  anonymizeIP: false,
-  botFiltering: false,
   projectId: '23456',
   revision: '6',
+  attributes: [
+    {id: 'trafficSource', key: 'trafficSource'},
+    {id: 'hasDefaultDates', key: 'hasDefaultDates'},
+    {id: 'deviceType', key: 'deviceType'}
+  ],
+  audiences: [
+    {
+      id: 'foo-default-dates',
+      name: 'Foo Traffic',
+      conditions:
+        '[ "and", { "name": "trafficSource", "value": "foo", "type": "custom_attribute" }, { "name": "hasDefaultDates", "value": true, "type": "custom_attribute" }, ["not", { "name": "deviceType", "value": "mobile", "type": "custom_attribute" } ] ]'
+    }
+  ],
   version: '4',
+  events: [],
+  integrations: [],
+  anonymizeIP: false,
+  botFiltering: false,
+  typedAudiences: [],
+  variables: [],
+  environmentKey: 'production',
+  sdkKey: '12345',
+  featureFlags: [
+    {
+      experimentIds: ['foo'],
+      id: 'foo',
+      rolloutId: 'rollout-1234',
+      key: 'foo',
+      variables: []
+    },
+    {
+      experimentIds: ['bar'],
+      id: 'bar',
+      rolloutId: 'rollout-456',
+      key: 'bar',
+      variables: []
+    }
+  ],
+  rollouts: [
+    {
+      id: 'rollout-1234',
+      experiments: [
+        {
+          id: '12345',
+          key: 'foo-exp',
+          status: 'Running',
+          layerId: '1234',
+          variations: [
+            {
+              id: '12345',
+              key: 'on',
+              featureEnabled: true,
+              variables: []
+            }
+          ],
+          trafficAllocation: [
+            {
+              entityId: '12345',
+              endOfRange: 5000
+            }
+          ],
+          forcedVariations: {},
+          audienceIds: [],
+          audienceConditions: []
+        },
+        {
+          id: 'default-foo',
+          key: 'default-foo',
+          status: 'Running',
+          layerId: 'default-foo',
+          variations: [
+            {
+              id: '624542',
+              key: 'off',
+              featureEnabled: false,
+              variables: []
+            }
+          ],
+          trafficAllocation: [
+            {
+              entityId: '624542',
+              endOfRange: 10000
+            }
+          ],
+          forcedVariations: {},
+          audienceIds: [],
+          audienceConditions: []
+        }
+      ]
+    }
+  ],
   experiments: [
     {
       id: 'foo',
@@ -67,33 +155,5 @@ export default {
       forcedVariations: []
     }
   ],
-  featureFlags: [
-    {
-      experimentIds: ['foo'],
-      id: 'foo',
-      key: 'foo'
-    },
-    {
-      experimentIds: ['bar'],
-      id: 'bar',
-      key: 'bar'
-    }
-  ],
-  events: [],
-  audiences: [
-    {
-      id: 'foo-default-dates',
-      name: 'Foo Traffic',
-      conditions:
-        '[ "and", { "name": "trafficSource", "value": "foo", "type": "custom_attribute" }, { "name": "hasDefaultDates", "value": true, "type": "custom_attribute" }, ["not", { "name": "deviceType", "value": "mobile", "type": "custom_attribute" } ] ]'
-    }
-  ],
-  attributes: [
-    {id: 'trafficSource', key: 'trafficSource'},
-    {id: 'hasDefaultDates', key: 'hasDefaultDates'},
-    {id: 'deviceType', key: 'deviceType'}
-  ],
-  groups: [],
-  rollouts: [],
-  variables: []
+  groups: []
 }

packages/lib/src/integrations/__mocks__/@optimizely/optimizely-sdk.ts

@@ -5,30 +5,23 @@ export const voidEventDispatcher = {
 export const addNotificationListenerMock = jest.fn()
 
 export const createInstanceMock = jest.fn(() => ({
-  getEnabledFeatures: getEnabledFeaturesMock,
   isFeatureEnabled: isFeatureEnabledMock,
   notificationCenter: {
     addNotificationListener: addNotificationListenerMock
   },
-  activate: activateMock
+  activate: activateMock,
+  createUserContext: optimizelyUserContextMock
 }))
 
-export const isFeatureEnabledMock = jest.fn((toggleId) => toggleId === 'foo')
-
-export const getEnabledFeaturesMock = jest.fn((userId, attributes) => {
-  if (userId) {
-    if (attributes.deviceType) {
-      return [
-        `${userId}-${attributes.deviceType}-test-1`,
-        `${userId}-${attributes.deviceType}-test-2`
-      ]
-    }
-
-    return [`${userId}-test-1`, `${userId}-test-2`]
-  }
+export const decideMock = jest.fn((toggleKey) => ({
+  enabled: toggleKey === "foo"
+}))
+export const optimizelyUserContextMock = jest.fn(() => ({
+  decide: decideMock
+}))
+
 
-  return []
-})
+export const isFeatureEnabledMock = jest.fn((toggleId) => toggleId === 'foo')
 
 export const activateMock = jest.fn((toggleId, userId) => {
   const shouldReturnB =
@@ -38,8 +31,12 @@ export const activateMock = jest.fn((toggleId, userId) => {
   return shouldReturnB && 'b'
 })
 
+const originalModule = jest.requireActual('@optimizely/optimizely-sdk')
+
 const mock = {
+  ...originalModule,
   createInstance: createInstanceMock
 }
 
+
 export default mock