[FSSDK-9984] fix: initialization and setUser errors

.vscode/launch.json

@@ -0,0 +1,25 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "name": "vscode-jest-tests.v2.react-sdk",
+      "request": "launch",
+      "args": [
+        "--runInBand",
+        "--watchAll=false",
+        "--testNamePattern",
+        "${jest.testNamePattern}",
+        "--runTestsByPath",
+        "${jest.testFile}"
+      ],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "program": "${workspaceFolder}/node_modules/.bin/jest",
+      "windows": {
+        "program": "${workspaceFolder}/node_modules/jest/bin/jest"
+      }
+    }
+  ]
+}

.vscode/settings.json

@@ -1,5 +1,4 @@
 {
-  "jest.autoRun": {
-    "onStartup": ["all-tests"]
-  }
+  "jest.runMode": "on-demand",
+  "jest.jestCommandLine": "~/.nvm/nvm-exec yarn test"
 }

package.json

@@ -34,7 +34,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@optimizely/optimizely-sdk": "^5.2.0",
+    "@optimizely/optimizely-sdk": "^5.2.1",
     "hoist-non-react-statics": "^3.3.0",
     "prop-types": "^15.6.2",
     "utility-types": "^2.1.0 || ^3.0.0"

src/Feature.spec.tsx

@@ -1,5 +1,5 @@
 /**
- * Copyright 2018-2019, 2023 Optimizely
+ * Copyright 2018-2019, 2023-2024 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,7 +22,7 @@ import { render, screen, waitFor } from '@testing-library/react';
 import '@testing-library/jest-dom/extend-expect';
 
 import { OptimizelyProvider } from './Provider';
-import { ReactSDKClient, VariableValuesObject } from './client';
+import { NotReadyReason, ReactSDKClient, VariableValuesObject } from './client';
 import { OptimizelyFeature } from './Feature';
 
 describe('<OptimizelyFeature>', () => {
@@ -298,7 +298,7 @@ describe('<OptimizelyFeature>', () => {
 
         // while it's waiting for onReady()
         expect(container.innerHTML).toBe('');
-        resolver.resolve({ success: false, reason: 'fail', dataReadyPromise: Promise.resolve() });
+        resolver.resolve({ success: false, reason: NotReadyReason.TIMEOUT, dataReadyPromise: Promise.resolve() });
 
         // Simulate config update notification firing after datafile fetched
         await optimizelyMock.onReady().then(res => res.dataReadyPromise);

src/Provider.tsx

@@ -1,5 +1,5 @@
 /**
- * Copyright 2022-2023, Optimizely
+ * Copyright 2022-2024, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,9 +43,7 @@ interface OptimizelyProviderState {
 export class OptimizelyProvider extends React.Component<OptimizelyProviderProps, OptimizelyProviderState> {
   constructor(props: OptimizelyProviderProps) {
     super(props);
-  }
 
-  componentDidMount(): void {
     this.setUserInOptimizely();
   }
 
@@ -81,9 +79,9 @@ export class OptimizelyProvider extends React.Component<OptimizelyProviderProps,
       finalUser = DefaultUser;
     }
 
+    // if user is a promise, setUser occurs in the then block above
     if (finalUser) {
       try {
-        await optimizely.onReady();
         await optimizely.setUser(finalUser);
       } catch {
         logger.error('Error while trying to set user.');

src/client.spec.ts

@@ -5,7 +5,7 @@
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ * https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -28,7 +28,7 @@ jest.mock('./logger', () => {
 
 import * as optimizely from '@optimizely/optimizely-sdk';
 
-import { createInstance, OnReadyResult, ReactSDKClient } from './client';
+import { createInstance, DefaultUser, NotReadyReason, OnReadyResult, ReactSDKClient } from './client';
 import { logger } from './logger';
 
 interface MockedReactSDKClient extends ReactSDKClient {
@@ -37,6 +37,7 @@ interface MockedReactSDKClient extends ReactSDKClient {
 }
 
 describe('ReactSDKClient', () => {
+  const validVuid = 'vuid_8de3bb278fce47f6b000cadc1ac';
   const config: optimizely.Config = {
     datafile: {},
   };
@@ -51,6 +52,7 @@ describe('ReactSDKClient', () => {
       decideAll: jest.fn(),
       decideForKeys: jest.fn(),
       fetchQualifiedSegments: jest.fn(),
+      getUserId: jest.fn(),
       setForcedDecision: jest.fn(),
       removeForcedDecision: jest.fn(),
       removeAllForcedDecisions: jest.fn(),
@@ -144,32 +146,41 @@ describe('ReactSDKClient', () => {
     });
 
     it('fulfills the returned promise with success: true when a user is set', async () => {
-      jest.spyOn(instance, 'fetchQualifiedSegments').mockImplementation(async () => true);
+      jest.spyOn(mockInnerClient, 'onReady').mockResolvedValue({ success: true });
+      const instance = createInstance(config);
+      jest.spyOn(instance, 'fetchQualifiedSegments').mockResolvedValue(true);
+
       await instance.setUser({
         id: 'user12345',
       });
+
       const result = await instance.onReady();
+
       expect(result.success).toBe(true);
     });
 
     it('fulfills the returned promise with success: false when fetchqualifiedsegment is false', async () => {
-      jest.spyOn(instance, 'fetchQualifiedSegments').mockImplementation(async () => false);
+      jest.spyOn(mockInnerClient, 'onReady').mockResolvedValue({ success: true });
+      const instance = createInstance(config);
+      jest.spyOn(instance, 'fetchQualifiedSegments').mockResolvedValue(false);
 
       await instance.setUser({
         id: 'user12345',
       });
       const result = await instance.onReady();
+
       expect(result.success).toBe(false);
     });
 
     describe('if Optimizely client is null', () => {
       beforeEach(() => {
-        // Mocks dataReadyPromise value instead of _client = null because test initialization of instance causes dataReadyPromise to return { success: true }
+        // Mocks clientAndUserReadyPromise value instead of _client = null because test initialization of
+        // instance causes clientAndUserReadyPromise to return { success: true }
         // @ts-ignore
-        instance.dataReadyPromise = new Promise((resolve, reject) => {
+        instance.clientAndUserReadyPromise = new Promise(resolve => {
           resolve({
             success: false,
-            reason: 'NO_CLIENT',
+            reason: NotReadyReason.NO_CLIENT,
             message: 'Optimizely client failed to initialize.',
           });
         });
@@ -185,16 +196,20 @@ describe('ReactSDKClient', () => {
 
       it('waits for the inner client onReady to fulfill with success = false before fulfilling the returned promise', async () => {
         const mockInnerClientOnReady = jest.spyOn(mockInnerClient, 'onReady');
-        let resolveInnerClientOnReady: (result: OnReadyResult) => void;
+        let resolveInnerClientOnReady: (result: OnReadyResult) => void = () => {};
         const mockReadyPromise: Promise<OnReadyResult> = new Promise(res => {
           resolveInnerClientOnReady = res;
         });
         mockInnerClientOnReady.mockReturnValueOnce(mockReadyPromise);
+        const userId = 'user999';
+        jest.spyOn(mockOptimizelyUserContext, 'getUserId').mockReturnValue(userId);
+        resolveInnerClientOnReady({ success: true });
+
         await instance.setUser({
-          id: 'user999',
+          id: userId,
         });
-        resolveInnerClientOnReady!({ success: true });
         const result = await instance.onReady();
+
         expect(result.success).toBe(false);
       });
     });
@@ -206,6 +221,7 @@ describe('ReactSDKClient', () => {
         resolveInnerClientOnReady = res;
       });
       mockInnerClientOnReady.mockReturnValueOnce(mockReadyPromise);
+      const instance = createInstance(config);
       jest.spyOn(instance, 'fetchQualifiedSegments').mockImplementation(async () => true);
       await instance.setUser({
         id: 'user999',
@@ -217,50 +233,69 @@ describe('ReactSDKClient', () => {
   });
 
   describe('setUser', () => {
+    it('can be called with no/default user set', async () => {
+      const instance = createInstance(config);
+      jest.spyOn(mockOptimizelyUserContext, 'getUserId').mockReturnValue(validVuid);
+
+      await instance.setUser(DefaultUser);
+
+      expect(instance.user.id).toEqual(validVuid);
+    });
+
     it('updates the user object with id and attributes', async () => {
+      const userId = 'xxfueaojfe8&86';
+      jest.spyOn(mockOptimizelyUserContext, 'getUserId').mockReturnValue(userId);
+
       const instance = createInstance(config);
       await instance.setUser({
-        id: 'xxfueaojfe8&86',
+        id: userId,
         attributes: {
           foo: 'bar',
         },
       });
+
       expect(instance.user).toEqual({
-        id: 'xxfueaojfe8&86',
+        id: userId,
         attributes: {
           foo: 'bar',
         },
       });
     });
 
     it('adds and removes update handlers', async () => {
+      const userId = 'newUser';
+      jest.spyOn(mockOptimizelyUserContext, 'getUserId').mockReturnValue(userId);
       const instance = createInstance(config);
       const onUserUpdateListener = jest.fn();
       const dispose = instance.onUserUpdate(onUserUpdateListener);
+
       await instance.setUser({
-        id: 'newUser',
+        id: userId,
       });
+
       expect(onUserUpdateListener).toBeCalledTimes(1);
       expect(onUserUpdateListener).toBeCalledWith({
-        id: 'newUser',
+        id: userId,
         attributes: {},
       });
+
       dispose();
       await instance.setUser({
         id: 'newUser2',
       });
+
       expect(onUserUpdateListener).toBeCalledTimes(1);
     });
 
-    it('does not call fetchqualifiedsegements on setUser if onready is not calleed initially', async () => {
+    it('implicitly calls fetchqualifiedsegements', async () => {
       const instance = createInstance(config);
-      jest.spyOn(instance, 'fetchQualifiedSegments').mockImplementation(async () => true);
+      jest.spyOn(instance, 'fetchQualifiedSegments').mockResolvedValue(true);
 
       await instance.setUser({
         id: 'xxfueaojfe8&86',
       });
 
-      expect(instance.fetchQualifiedSegments).toBeCalledTimes(0);
+      expect(instance.fetchQualifiedSegments).toBeCalledTimes(1);
     });
 
     it('calls fetchqualifiedsegements internally on each setuser call after onready', async () => {
@@ -286,9 +321,11 @@ describe('ReactSDKClient', () => {
     describe('pre-set user and user overrides', () => {
       let instance: ReactSDKClient;
       beforeEach(async () => {
+        const userId = 'user1';
+        jest.spyOn(mockOptimizelyUserContext, 'getUserId').mockReturnValue(userId);
         instance = createInstance(config);
         await instance.setUser({
-          id: 'user1',
+          id: userId,
           attributes: {
             foo: 'bar',
           },
@@ -1067,9 +1104,11 @@ describe('ReactSDKClient', () => {
             }
           }
         );
+        const userId = 'user1123';
+        jest.spyOn(mockOptimizelyUserContext, 'getUserId').mockReturnValue(userId);
         const instance = createInstance(config);
         await instance.setUser({
-          id: 'user1123',
+          id: userId,
         });
         const result = instance.getFeatureVariables('feat1');
         expect(result).toEqual({
@@ -1353,9 +1392,11 @@ describe('ReactSDKClient', () => {
   describe('setForcedDecision', () => {
     let instance: ReactSDKClient;
     beforeEach(async () => {
+      const userId = 'user1';
+      jest.spyOn(mockOptimizelyUserContext, 'getUserId').mockReturnValue(userId);
       instance = createInstance(config);
       await instance.setUser({
-        id: 'user1',
+        id: userId,
         attributes: {
           foo: 'bar',
         },
@@ -1374,7 +1415,6 @@ describe('ReactSDKClient', () => {
           variables: {},
           variationKey: 'varition1',
         });
-
         // @ts-ignore
         instance._client = null;
 
@@ -1462,6 +1502,8 @@ describe('ReactSDKClient', () => {
   describe('removeForcedDecision', () => {
     let instance: ReactSDKClient;
     beforeEach(async () => {
+      const userId = 'user1';
+      jest.spyOn(mockOptimizelyUserContext, 'getUserId').mockReturnValue(userId);
       instance = createInstance(config);
       await instance.setUser({
         id: 'user1',
@@ -1640,7 +1682,6 @@ describe('ReactSDKClient', () => {
     });
 
     it('should return a valid vuid', async () => {
-      const validVuid = 'vuid_8de3bb278fce47f6b000cadc1ac';
       const mockGetVuid = mockInnerClient.getVuid as jest.Mock;
       mockGetVuid.mockReturnValue(validVuid);