[FSSDK-10882] ProjectConfigManager SSR support

lib/index.node.tests.js

@@ -24,6 +24,7 @@ import * as loggerPlugin from './plugins/logger';
 import optimizelyFactory from './index.node';
 import configValidator from './utils/config_validator';
 import { getMockProjectConfigManager } from './tests/mock/mock_project_config_manager';
+import { createProjectConfig } from './project_config/project_config';
 
 describe('optimizelyFactory', function() {
   describe('APIs', function() {
@@ -88,6 +89,22 @@ describe('optimizelyFactory', function() {
         assert.equal(optlyInstance.clientVersion, '5.3.4');
       });
 
+      it('should create an instance of optimizely with ssr flag, project config must be available', () => {
+        const optlyInstance = optimizelyFactory.createInstance({
+          projectConfigManager: getMockProjectConfigManager({
+            initConfig: createProjectConfig(testData.getTestProjectConfig()),
+          }),
+          errorHandler: fakeErrorHandler,
+          eventDispatcher: fakeEventDispatcher,
+          logger: fakeLogger,
+          isSsr: true,
+        });
+
+        assert.instanceOf(optlyInstance, Optimizely);
+        assert.equal(optlyInstance.projectConfigManager.isSsr, true);
+        assert.deepEqual(optlyInstance.getProjectConfig(), createProjectConfig(testData.getTestProjectConfig()));
+      });
+
       // TODO: user will create and inject an event processor
       // these tests will be refactored accordingly
       // describe('event processor configuration', function() {

lib/optimizely/index.ts

@@ -146,6 +146,7 @@ export default class Optimizely implements Client {
       this.updateOdpSettings();
     });
 
+    this.projectConfigManager.setSsr(config.isSsr) 
     this.projectConfigManager.start();
     const projectConfigManagerRunningPromise = this.projectConfigManager.onRunning();
 

lib/project_config/project_config_manager.spec.ts

@@ -165,6 +165,17 @@ describe('ProjectConfigManagerImpl', () => {
           await manager.onRunning();
           expect(manager.getConfig()).toEqual(createProjectConfig(testData.getTestProjectConfig()));
         });
+
+        it('should not start datafileManager if isSsr is true and return correct config', () => {
+          const datafileManager = getMockDatafileManager({});
+          vi.spyOn(datafileManager, 'start');
+          const manager = new ProjectConfigManagerImpl({ datafile: testData.getTestProjectConfig(), datafileManager });
+          manager.setSsr(true);
+          manager.start();
+
+          expect(manager.getConfig()).toEqual(createProjectConfig(testData.getTestProjectConfig()));
+          expect(datafileManager.start).not.toHaveBeenCalled();
+        });
       });
 
       describe('when datafile is invalid', () => {

lib/project_config/project_config_manager.ts

@@ -34,6 +34,7 @@ interface ProjectConfigManagerConfig {
 
 export interface ProjectConfigManager extends Service {
   setLogger(logger: LoggerFacade): void;
+  setSsr(isSsr?: boolean): void;
   getConfig(): ProjectConfig | undefined;
   getOptimizelyConfig(): OptimizelyConfig | undefined;
   onUpdate(listener: Consumer<ProjectConfig>): Fn;
@@ -54,6 +55,7 @@ export class ProjectConfigManagerImpl extends BaseService implements ProjectConf
   public datafileManager?: DatafileManager;
   private eventEmitter: EventEmitter<{ update: ProjectConfig }> = new EventEmitter();
   private logger?: LoggerFacade;
+  private isSsr?: boolean;
 
   constructor(config: ProjectConfigManagerConfig) {
     super();
@@ -79,6 +81,11 @@ export class ProjectConfigManagerImpl extends BaseService implements ProjectConf
       return;
     }
 
+    if(this.isSsr) {
+      // If isSsr is true, we don't need to poll for datafile updates 
+      this.datafileManager = undefined 
+    }
+
     if (this.datafile) {
       this.handleNewDatafile(this.datafile, true);
     }
@@ -216,4 +223,13 @@ export class ProjectConfigManagerImpl extends BaseService implements ProjectConf
       this.stopPromise.reject(err);
     });
   }
+
+  /**
+   * Set the isSsr flag to indicate if the project config manager is being used in a server side rendering environment 
+   * @param {Boolean} isSsr  
+   * @returns {void}
+   */
+  setSsr(isSsr?: boolean): void {
+    this.isSsr = isSsr;
+  }
 }

lib/shared_types.ts

@@ -291,6 +291,7 @@ export interface OptimizelyOptions {
   sdkKey?: string;
   userProfileService?: UserProfileService | null;
   defaultDecideOptions?: OptimizelyDecideOption[];
+  isSsr?:boolean;
   odpManager?: IOdpManager;
   notificationCenter: NotificationCenterImpl;
 }
@@ -425,6 +426,7 @@ export interface ConfigLite {
   defaultDecideOptions?: OptimizelyDecideOption[];
   clientEngine?: string;
   clientVersion?: string;
+  isSsr?: boolean;
 }
 
 export type OptimizelyExperimentsMap = {

lib/tests/mock/mock_project_config_manager.ts

@@ -28,6 +28,9 @@ export const getMockProjectConfigManager = (opt: MockOpt = {}): ProjectConfigMan
   return {
     config: opt.initConfig,
     start: () => {},
+    setSsr: function(isSsr?:boolean) {
+      this.isSsr = isSsr;
+    },
     onRunning: () => opt.onRunning || Promise.resolve(),
     stop: () => {},
     onTerminated: () => opt.onTerminated || Promise.resolve(),