[FSSDK-9726] AAT gap fill

.devcontainer/devcontainer.json

@@ -1,10 +1,7 @@
 {
   "name": "React SDK",
-
   "image": "mcr.microsoft.com/devcontainers/javascript-node:1-18-bullseye",
-
-  "postCreateCommand": "npm install -g npm && yarn install",
-
+  "postCreateCommand": "yarn install",
   "customizations": {
     "vscode": {
       "extensions": [
@@ -14,7 +11,8 @@
         "Gruntfuggly.todo-tree",
         "github.vscode-github-actions",
         "Orta.vscode-jest",
-        "ms-vscode.test-adapter-converter"
+        "ms-vscode.test-adapter-converter",
+        "GitHub.copilot-chat"
       ],
       "settings": {
         "files.eol": "\n"

src/client.spec.ts

@@ -269,7 +269,7 @@ describe('ReactSDKClient', () => {
       await instance.setUser({
         id: 'xxfueaojfe8&86',
       });
-      await instance.onReady()
+      await instance.onReady();
 
       await instance.setUser({
         id: 'xxfueaojfe8&87',
@@ -1624,4 +1624,82 @@ describe('ReactSDKClient', () => {
       expect(mockInnerClient.sendOdpEvent).toHaveBeenCalledTimes(1);
     });
   });
+
+  describe('getVuid', () => {
+    const vuidFormat = /^vuid_[a-f0-9]{27}$/;
+    let instance: ReactSDKClient;
+
+    beforeEach(async () => {
+      instance = createInstance(config);
+    });
+
+    it('should return undefined if client is null', () => {
+      // @ts-ignore
+      instance._client = null;
+
+      const vuid = instance.getVuid();
+
+      expect(vuid).toBeUndefined();
+    });
+
+    it('should call the JS getVuid if a user set', async () => {
+      await instance.setUser({
+        id: 'user1',
+      });
+
+      instance.getVuid();
+
+      expect(mockInnerClient.getVuid).toHaveBeenCalledTimes(1);
+      expect(logger.warn).toHaveBeenCalledTimes(0);
+    });
+
+    it('should call the JS getVuid if even if a user is not set', async () => {
+      instance.getVuid();
+
+      expect(mockInnerClient.getVuid).toHaveBeenCalledTimes(1);
+      expect(logger.warn).toHaveBeenCalledTimes(0);
+    });
+
+    it('should return a valid vuid', async () => {
+      const validVuid = 'vuid_8de3bb278fce47f6b000cadc1ac';
+      const mockGetVuid = mockInnerClient.getVuid as jest.Mock;
+      mockGetVuid.mockReturnValue(validVuid);
+
+      const vuid = instance.getVuid();
+
+      expect(vuid).toMatch(vuidFormat);
+    });
+  });
+
+  describe('getQualifedSegments', () => {
+    let instance: ReactSDKClient;
+
+    beforeEach(async () => {
+      instance = createInstance(config);
+    });
+
+    it('returns null if userContext is not initialized', () => {
+      // @ts-ignore
+      instance.userContext = null;
+
+      expect(instance.getQualifedSegments()).toBeNull();
+    });
+
+    it('returns qualified segments if userContext is initialized', () => {
+      // @ts-ignore
+      instance.userContext = {
+        qualifiedSegments: ['segment1', 'segment2'],
+      };
+
+      expect(instance.getQualifedSegments()).toEqual(['segment1', 'segment2']);
+    });
+
+    it('logs a warning if userContext is not initialized', () => {
+      const loggerWarnSpy = jest.spyOn(logger, 'warn');
+
+      instance.getQualifedSegments();
+
+      expect(loggerWarnSpy).toHaveBeenCalledWith('Unable to get qualified segments for user because Optimizely user context failed to initialize.');
+    });
+  });
 });

src/client.ts

@@ -49,7 +49,7 @@ const default_user: UserInfo = {
   attributes: {},
 };
 
-export interface ReactSDKClient extends Omit<optimizely.Client, 'createUserContext' | 'getVuid'> {
+export interface ReactSDKClient extends Omit<optimizely.Client, 'createUserContext'> {
   user: UserInfo;
 
   onReady(opts?: { timeout?: number }): Promise<any>;
@@ -180,9 +180,13 @@ export interface ReactSDKClient extends Omit<optimizely.Client, 'createUserConte
   getForcedDecision(decisionContext: optimizely.OptimizelyDecisionContext): optimizely.OptimizelyForcedDecision | null;
 
   fetchQualifiedSegments(options?: optimizely.OptimizelySegmentOption[]): Promise<boolean>;
+
+  getQualifedSegments(): string[] | null;
+
+  getVuid(): string | undefined;
 }
 
-export const DEFAULT_ON_READY_TIMEOUT = 5000;
+export const DEFAULT_ON_READY_TIMEOUT = 5_000;
 
 class OptimizelyReactSDKClient implements ReactSDKClient {
   private userContext: optimizely.OptimizelyUserContext | null = null;
@@ -219,7 +223,7 @@ class OptimizelyReactSDKClient implements ReactSDKClient {
    */
   constructor(config: optimizely.Config) {
     this.initialConfig = config;
-    this.userPromiseResolver = () => { };
+    this.userPromiseResolver = () => {};
 
     const configWithClientInfo = {
       ...config,
@@ -343,8 +347,8 @@ class OptimizelyReactSDKClient implements ReactSDKClient {
       }
 
       if (userInfo.id) {
-        userContext = this._client.createUserContext(userInfo.id, userInfo.attributes);
-        return userContext;
+        this.userContext = this._client.createUserContext(userInfo.id, userInfo.attributes);
+        return this.userContext;
       }
 
       return null;
@@ -367,6 +371,15 @@ class OptimizelyReactSDKClient implements ReactSDKClient {
     return await this.userContext.fetchQualifiedSegments(options);
   }
 
+  public getQualifedSegments(): string[] | null {
+    if (!this.userContext) {
+      logger.warn('Unable to get qualified segments for user because Optimizely user context failed to initialize.');
+      return null;
+    }
+
+    return this.userContext.qualifiedSegments;
+  }
+
   public async setUser(userInfo: UserInfo): Promise<void> {
     this.isUserReady = true;
 
@@ -1227,6 +1240,14 @@ class OptimizelyReactSDKClient implements ReactSDKClient {
 
     this.client?.sendOdpEvent(action, type, identifiers, data);
   }
+
+  public getVuid(): string | undefined {
+    if (!this._client) {
+      logger.warn('Unable to get VUID because Optimizely client failed to initialize.');
+      return undefined;
+    }
+    return this._client.getVuid();
+  }
 }
 
 export function createInstance(config: optimizely.Config): ReactSDKClient {