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 allow 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/__mocks__/@optimizely/optimizely-sdk.ts

@@ -10,9 +10,18 @@ export const createInstanceMock = jest.fn(() => ({
   notificationCenter: {
     addNotificationListener: addNotificationListenerMock
   },
-  activate: activateMock
+  activate: activateMock,
+  createUserContext: optimizelyUserContextMock
 }))
 
+export const decideMock = jest.fn((toggleKey) => ({
+  enabled: toggleKey === "foo"
+}))
+export const optimizelyUserContextMock = jest.fn((userId, attributes) => ({
+  decide: decideMock
+}))
+
+
 export const isFeatureEnabledMock = jest.fn((toggleId) => toggleId === 'foo')
 
 export const getEnabledFeaturesMock = jest.fn((userId, attributes) => {
@@ -38,8 +47,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

packages/lib/src/integrations/optimizely.test.ts

@@ -5,14 +5,12 @@ import {
   setUserId,
   setAudienceSegmentationAttributes,
   resetAudienceSegmentationAttributes,
-  booleanToggle,
   toggle,
   forceToggles,
   getEnabledFeatures
 } from './optimizely'
 
 // During the tests:
-// for booleanToggle 'foo' yields true and 'bar' yields false, unless forced
 // for toggle 'foo' yields 'b' and 'bar' yields 'a', unless forced
 import datafile from './__fixtures__/dataFile'
 
@@ -26,7 +24,11 @@ import Optimizely, {
   // @ts-expect-error
   getEnabledFeaturesMock,
   // @ts-expect-error
-  activateMock
+  activateMock,
+  // @ts-expect-error
+  decideMock,
+  // @ts-expect-error
+  optimizelyUserContextMock
 } from '@optimizely/optimizely-sdk'
 
 // Re-used between toggle test suites
@@ -123,9 +125,6 @@ describe('Optimizely Integration', () => {
           expect(() => toggle('foo')).toThrow(
             'Opticks: Fatal error: user id is not set'
           )
-          expect(() => booleanToggle('foo')).toThrow(
-            'Opticks: Fatal error: user id is not set'
-          )
         })
       })
 
@@ -140,25 +139,18 @@ describe('Optimizely Integration', () => {
           expect(toggle('bax', 'a', 'b', 'c')).toEqual('c')
           expect(toggle('foo')).toEqual('b')
           expect(toggle('bar')).toEqual('a')
-          expect(booleanToggle('foo')).toEqual(true)
-          expect(booleanToggle('bar')).toEqual(false)
         })
         */
 
         it('Forwards toggle reading and audienceSegmentationAttributes to Optimizely', () => {
           toggle('foo', 'a', 'b', 'c')
           expect(activateMock).toHaveBeenCalledWith('foo', 'fooBSide', {})
           toggle('foo')
-          expect(isFeatureEnabledMock).toHaveBeenCalledWith(
-            'foo',
-            'fooBSide',
-            {}
+          expect(decideMock).toHaveBeenCalledWith(
+            'foo'
           )
-          booleanToggle('foo')
-          expect(isFeatureEnabledMock).toHaveBeenCalledWith(
-            'foo',
-            'fooBSide',
-            {}
+          expect(optimizelyUserContextMock).toHaveBeenCalledWith(
+            'fooBSide', {}
           )
         })
       })
@@ -182,16 +174,11 @@ describe('Optimizely Integration', () => {
             deviceType: 'mobile',
             isLoggedIn: false
           })
+        })
 
+        it('Forwards toggle reading and audienceSegmentationAttributes to Optimizely', () => {
           toggle('foo')
-          expect(isFeatureEnabledMock).toHaveBeenCalledWith('foo', 'fooBSide', {
-            thisWillNotBeOverwritten: 'foo',
-            deviceType: 'mobile',
-            isLoggedIn: false
-          })
-
-          booleanToggle('foo')
-          expect(isFeatureEnabledMock).toHaveBeenCalledWith('foo', 'fooBSide', {
+          expect(optimizelyUserContextMock).toHaveBeenCalledWith('fooBSide', {
             thisWillNotBeOverwritten: 'foo',
             deviceType: 'mobile',
             isLoggedIn: false
@@ -213,26 +200,23 @@ describe('Optimizely Integration', () => {
           })
 
           toggle('foo', 'a', 'b')
-          expect(isFeatureEnabledMock).toHaveBeenCalledWith('foo', 'fooBSide', {
+          expect(optimizelyUserContextMock).toHaveBeenCalledWith('fooBSide', {
             valueAfterReset: true
           })
 
           toggle('foo')
-          expect(isFeatureEnabledMock).toHaveBeenCalledWith('foo', 'fooBSide', {
+          expect(optimizelyUserContextMock).toHaveBeenCalledWith('fooBSide', {
             valueAfterReset: true
           })
         })
       })
 
       testAudienceSegmentationCacheBusting(toggle, activateMock)
-      testAudienceSegmentationCacheBusting(booleanToggle, isFeatureEnabledMock)
 
-      it("Returns Optimizely's value when no arguments supplied using booleanToggle", () => {
+      it("Returns Optimizely's value when no arguments supplied using", () => {
         // maps to a, b, c
         expect(toggle('foo')).toEqual('b')
         expect(toggle('bar')).toEqual('a')
-        expect(booleanToggle('foo')).toBeTruthy()
-        expect(booleanToggle('bar')).toBeFalsy()
       })
 
       it('Maps Optimizely value to a, b, c indexed arguments', () => {
@@ -257,27 +241,21 @@ describe('Optimizely Integration', () => {
         expect(toggle('bax', 'a', 'b', 'c')).toEqual('c')
         expect(toggle('bar')).toEqual('a')
         expect(toggle('baz')).toEqual('b')
-        expect(booleanToggle('bar')).toEqual(false)
-        expect(booleanToggle('baz')).toEqual(true)
       })
 
       it('allows you to invent non-existing experiments', () => {
         expect(toggle('bax', 'a', 'b', 'c')).toEqual('c')
-        expect(booleanToggle('baz')).toEqual(true)
       })
 
       it('persist after setAudienceSegmentationAttributes is called', () => {
         expect(toggle('bax', 'a', 'b', 'c')).toEqual('c')
         setAudienceSegmentationAttributes({foo: 'bar'})
         expect(toggle('foo', 'a', 'b', 'c')).toEqual('a')
         expect(toggle('bax', 'a', 'b', 'c')).toEqual('c')
-        expect(booleanToggle('bar')).toEqual(false)
-        expect(booleanToggle('baz')).toEqual(true)
       })
 
       it('makes sure Toggles return defaults if forced values are of wrong type', () => {
         expect(toggle('baz', 'a', 'b', 'c')).toEqual('a')
-        expect(booleanToggle('bax')).toEqual(false)
       })
 
       describe('Clearing forced toggles', () => {
@@ -288,15 +266,11 @@ describe('Optimizely Integration', () => {
         it('should yield real values for cleared toggles', () => {
           expect(toggle('foo', 'a', 'b', 'c')).toEqual('b')
           expect(toggle('bar', 'a', 'b', 'c')).toEqual('a')
-          expect(booleanToggle('foo')).toEqual(true)
-          expect(booleanToggle('bar')).toEqual(false)
         })
 
         it('should keep the non-cleared forced toggles and other defaults', () => {
           expect(toggle('bax', 'a', 'b', 'c')).toEqual('c')
-          expect(booleanToggle('baz')).toEqual(true)
           expect(toggle('nonexistent', 'a', 'b', 'c')).toEqual('a')
-          expect(booleanToggle('nonexistent')).toEqual(false)
         })
       })
     })