[FSSDK-8941] [React] Enable ODP Functionality in React Context

package.json

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

src/client.spec.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2019-2022, Optimizely
+ * Copyright 2019-2023, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,21 +15,24 @@
  */
 jest.mock('@optimizely/optimizely-sdk');
 jest.mock('./logger', () => {
- return { logger: {
- warn : jest.fn(() => ()=>{}),
- info : jest.fn(() => ()=>{}),
- error : jest.fn(() => ()=>{}),
- debug : jest.fn(() => ()=>{})
- } };
-})
-
+ return {
+ logger: {
+ warn: jest.fn(() => () => {}),
+ info: jest.fn(() => () => {}),
+ error: jest.fn(() => () => {}),
+ debug: jest.fn(() => () => {}),
+ },
+ };
+});
+
 import * as optimizely from '@optimizely/optimizely-sdk';
 
 import { createInstance, OnReadyResult, ReactSDKClient } from './client';
+import { logger } from './logger';
+
 interface MockedReactSDKClient extends ReactSDKClient {
  client: optimizely.Client;
  initialConfig: optimizely.Config;
-
 }
 
 describe('ReactSDKClient', () => {
@@ -46,6 +49,7 @@ describe('ReactSDKClient', () => {
  decide: jest.fn(),
  decideAll: jest.fn(),
  decideForKeys: jest.fn(),
+ fetchQualifiedSegments: jest.fn(),
  setForcedDecision: jest.fn(),
  removeForcedDecision: jest.fn(),
  removeAllForcedDecisions: jest.fn(),
@@ -72,6 +76,8 @@ describe('ReactSDKClient', () => {
  getOptimizelyConfig: jest.fn(() => null),
  onReady: jest.fn(() => Promise.resolve({ success: false })),
  close: jest.fn(),
+ getVuid: jest.fn(),
+ sendOdpEvent: jest.fn(),
  notificationCenter: {
  addNotificationListener: jest.fn(() => 0),
  removeNotificationListener: jest.fn(() => false),
@@ -1177,6 +1183,45 @@ describe('ReactSDKClient', () => {
  });
  });
 
+ describe('fetchQualifedSegments', () => {
+ let instance: ReactSDKClient;
+ beforeEach(() => {
+ instance = createInstance(config);
+ });
+
+ it('should never call fetchQualifiedSegments if Optimizely user context is falsy', async () => {
+ const result = await instance.fetchQualifiedSegments();
+
+ expect(result).toEqual(false);
+ expect(logger.warn).toHaveBeenCalledTimes(1);
+ expect(logger.warn).toBeCalledWith(
+ 'Unable to fetch qualified segments for user because Optimizely client failed to initialize.'
+ );
+ });
+
+ it('should return false if fetch fails', async () => {
+ instance.setUser({
+ id: 'user1',
+ });
+
+ jest.spyOn(instance, 'fetchQualifiedSegments').mockImplementation(async () => false);
+ const result = await instance.fetchQualifiedSegments();
+
+ expect(result).toEqual(false);
+ });
+
+ it('should return true if fetch successful', async () => {
+ instance.setUser({
+ id: 'user1',
+ });
+
+ jest.spyOn(instance, 'fetchQualifiedSegments').mockImplementation(async () => true);
+ const result = await instance.fetchQualifiedSegments();
+
+ expect(result).toEqual(true);
+ });
+ });
+
  describe('onForcedVariationsUpdate', () => {
  let instance: ReactSDKClient;
  beforeEach(() => {

src/client.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2019-2022, Optimizely
+ * Copyright 2019-2023, 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 { logger } from './logger';
 export type VariableValuesObject = {
  [key: string]: any;
 };
- 
+
 type DisposeFn = () => void;
 
 type OnUserUpdateHandler = (userInfo: UserInfo) => void;
@@ -170,6 +170,8 @@ export interface ReactSDKClient extends Omit<optimizely.Client, 'createUserConte
  removeForcedDecision(decisionContext: optimizely.OptimizelyDecisionContext): boolean;
 
  getForcedDecision(decisionContext: optimizely.OptimizelyDecisionContext): optimizely.OptimizelyForcedDecision | null;
+
+ fetchQualifiedSegments(): Promise<boolean>;
 }
 
 export const DEFAULT_ON_READY_TIMEOUT = 5000;
@@ -211,7 +213,7 @@ class OptimizelyReactSDKClient implements ReactSDKClient {
  */
  constructor(config: optimizely.Config) {
  this.initialConfig = config;
- this.userPromiseResolver = () => { };
+ this.userPromiseResolver = () => {};
 
  const configWithClientInfo = {
  ...config,
@@ -321,6 +323,15 @@ class OptimizelyReactSDKClient implements ReactSDKClient {
  return null;
  }
 
+ async fetchQualifiedSegments(): Promise<boolean> {
+ if (!this.userContext) {
+ logger.warn('Unable to fetch qualified segments for user because Optimizely client failed to initialize.');
+ return false;
+ }
+
+ return await this.userContext.fetchQualifiedSegments();
+ }
+
  setUser(userInfo: UserInfo): void {
  // TODO add check for valid user
  if (userInfo.id) {
@@ -1123,7 +1134,7 @@ class OptimizelyReactSDKClient implements ReactSDKClient {
  return new Promise<{ success: boolean; reason: string }>((resolve, reject) =>
  resolve({
  success: true,
- reason: 'Optimizely client is not initialized.'
+ reason: 'Optimizely client is not initialized.',
  })
  );
  }
@@ -1176,6 +1187,21 @@ class OptimizelyReactSDKClient implements ReactSDKClient {
  attributes: finalUserAttributes,
  };
  }
+
+ // TODO: discuss if we want to expose these method and provide implementation
+ getVuid(): string | undefined {
+ return undefined;
+ }
+
+ // TODO: discuss if we want to expose these method and provide implementation
+ sendOdpEvent(
+ action: string,
+ type: string | undefined,
+ identifiers: Map<string, string> | undefined,
+ data: Map<string, unknown> | undefined
+ ): void {
+ // no-op
+ }
 }
 
 export function createInstance(config: optimizely.Config): ReactSDKClient {

yarn.lock

@@ -544,14 +544,6 @@
  "@optimizely/js-sdk-utils" "^0.4.0"
  decompress-response "^4.2.1"
 
-"@optimizely/js-sdk-event-processor@^0.9.2":
- version "0.9.5"
- resolved "https://registry.npmjs.org/@optimizely/js-sdk-event-processor/-/js-sdk-event-processor-0.9.5.tgz"
- integrity sha512-g5zqAjJuexxgbNvn7dacFkQXQxH3+OtjELfmSswvhxP9EHkyNR0ZdQF/kBxFxr335F2/RRPvAJ9tQBPkwaBg8g==
- dependencies:
- "@optimizely/js-sdk-logging" "^0.3.1"
- "@optimizely/js-sdk-utils" "^0.4.0"
-
 "@optimizely/js-sdk-logging@^0.3.1":
  version "0.3.1"
  resolved "https://registry.npmjs.org/@optimizely/js-sdk-logging/-/js-sdk-logging-0.3.1.tgz"
@@ -566,17 +558,16 @@
  dependencies:
  uuid "^3.3.2"
 
-"@optimizely/optimizely-sdk@^4.9.2":
- version "4.9.2"
- resolved "https://registry.yarnpkg.com/@optimizely/optimizely-sdk/-/optimizely-sdk-4.9.2.tgz#d63edda82e957927a3b9d909aa9f67a34013eb77"
- integrity sha512-aPUU2KGDgo0VmbYNXeUCttXQgbBr59leUhyNPidy1J3YixEhzo0Q9UXCzhf4SgCTCtHCwahE7g0Lf36U0IVPgQ==
+"@optimizely/optimizely-sdk@^5.0.0-beta":
+ version "5.0.0-beta"
+ resolved "https://registry.yarnpkg.com/@optimizely/optimizely-sdk/-/optimizely-sdk-5.0.0-beta.tgz#3290713524707d6328ec2c00a4ec1490410d3bcd"
+ integrity sha512-WgiZDAJcdRyRPbJlZ96cuVVAF+6IuwK4hzGT6XBPdfRrBm6jLb9oQ3qUhGJMxNBoUFHlaNVnvm/T4lKS/gcy9Q==
  dependencies:
  "@optimizely/js-sdk-datafile-manager" "^0.9.5"
- "@optimizely/js-sdk-event-processor" "^0.9.2"
- "@optimizely/js-sdk-logging" "^0.3.1"
+ decompress-response "^4.2.1"
  json-schema "^0.4.0"
- murmurhash "0.0.2"
- uuid "^3.3.2"
+ murmurhash "^2.0.1"
+ uuid "^8.3.2"
 
 "@rollup/plugin-commonjs@^16.0.0":
  version "16.0.0"
@@ -3462,10 +3453,10 @@ ms@2.1.2:
  resolved "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz"
  integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==
 
-murmurhash@0.0.2:
- version "0.0.2"
- resolved "https://registry.npmjs.org/murmurhash/-/murmurhash-0.0.2.tgz"
- integrity sha512-LKlwdZKWzvCQpMszb2HO5leJ7P9T4m5XuDKku8bM0uElrzqK9cn0+iozwQS8jO4SNjrp4w7olalgd8WgsIjhWA==
+murmurhash@^2.0.1:
+ version "2.0.1"
+ resolved "https://registry.yarnpkg.com/murmurhash/-/murmurhash-2.0.1.tgz#4097720e08cf978872194ad84ea5be2dec9b610f"
+ integrity sha512-5vQEh3y+DG/lMPM0mCGPDnyV8chYg/g7rl6v3Gd8WMF9S429ox3Xk8qrk174kWhG767KQMqqxLD1WnGd77hiew==
 
 mute-stream@0.0.8:
  version "0.0.8"
@@ -4757,9 +4748,9 @@ uuid@^3.3.2:
  resolved "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz"
  integrity sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==
 
-uuid@^8.3.0:
+uuid@^8.3.0, uuid@^8.3.2:
  version "8.3.2"
- resolved "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz"
+ resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2"
  integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==
 
 v8-compile-cache@^2.0.3: