[FSSDK-10882] improvements

Author: junaed-optimizely

lib/index.node.tests.js

@@ -88,23 +88,7 @@ describe('optimizelyFactory', function() {
         assert.instanceOf(optlyInstance, Optimizely);
         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.spec.ts

@@ -0,0 +1,78 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * 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,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { describe, it, expect, vi } from 'vitest';
+import Optimizely from '.';
+import { getMockProjectConfigManager } from '../tests/mock/mock_project_config_manager';
+import * as logger from '../plugins/logger';
+import * as jsonSchemaValidator from '../utils/json_schema_validator';
+import { LOG_LEVEL } from '../common_exports';
+import { createNotificationCenter } from '../core/notification_center';
+import testData from '../tests/test_data';
+import { getForwardingEventProcessor } from '../event_processor/forwarding_event_processor';
+import { LoggerFacade } from '../modules/logging';
+import { createProjectConfig } from '../project_config/project_config';
+
+describe('lib/optimizely', () => {
+  const errorHandler = { handleError: function() {} };
+
+  const eventDispatcher = {
+    dispatchEvent: () => Promise.resolve({ statusCode: 200 }),
+  };
+
+  const eventProcessor = getForwardingEventProcessor(eventDispatcher);
+
+  const createdLogger: LoggerFacade = {
+    ...logger.createLogger({
+      logLevel: LOG_LEVEL.INFO,
+    }),
+    info: () => {},
+    debug: () => {},
+    warn: () => {},
+    error: () => {},
+    log: () => {},
+  };
+
+  const notificationCenter = createNotificationCenter({ logger: createdLogger, errorHandler });
+
+  it('should pass ssr to the project config manager', () => {
+    const projectConfigManager = getMockProjectConfigManager({
+      initConfig: createProjectConfig(testData.getTestProjectConfig()),
+    });
+
+    vi.spyOn(projectConfigManager, 'setSsr');
+
+    const instance = new Optimizely({
+      clientEngine: 'node-sdk',
+      projectConfigManager,
+      errorHandler,
+      jsonSchemaValidator,
+      logger: createdLogger,
+      notificationCenter,
+      eventProcessor,
+      isSsr: true,
+      isValidInstance: true,
+    });
+
+    expect(projectConfigManager.setSsr).toHaveBeenCalledWith(true);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    expect(instance.getProjectConfig()).toBe(projectConfigManager.config);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    expect(projectConfigManager.isSsr).toBe(true);
+  });
+});

lib/project_config/project_config_manager.spec.ts

@@ -409,6 +409,16 @@ describe('ProjectConfigManagerImpl', () => {
       expect(logger.error).toHaveBeenCalled();
     });
 
+    it('should reject onRunning() and log error if isSsr is true and datafile is not provided', async () =>{
+      const logger = getMockLogger();
+      const manager = new ProjectConfigManagerImpl({ logger, datafileManager: getMockDatafileManager({})});
+      manager.setSsr(true);
+      manager.start();
+
+      await expect(manager.onRunning()).rejects.toThrow();
+      expect(logger.error).toHaveBeenCalled();
+    });
+
     it('should reject onRunning() and log error if the datafile version is not supported', async () => {
       const logger = getMockLogger();
       const datafile = testData.getUnsupportedVersionConfig();

lib/project_config/project_config_manager.ts

@@ -55,7 +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;
+  private isSsr = true;
 
   constructor(config: ProjectConfigManagerConfig) {
     super();
@@ -75,17 +75,21 @@ export class ProjectConfigManagerImpl extends BaseService implements ProjectConf
     }
 
     this.state = ServiceState.Starting;
-    if (!this.datafile && !this.datafileManager) {
-      // TODO: replace message with imported constants
-      this.handleInitError(new Error('You must provide at least one of sdkKey or datafile'));
-      return;
-    }
 
     if(this.isSsr) {
       // If isSsr is true, we don't need to poll for datafile updates 
       this.datafileManager = undefined 
     }
 
+    if (!this.datafile && !this.datafileManager) {
+      const errorMessage = this.isSsr
+        ? 'You must provide datafile in SSR'
+        : 'You must provide at least one of sdkKey or datafile';
+      // TODO: replace message with imported constants
+      this.handleInitError(new Error(errorMessage));
+      return;
+    }
+
     if (this.datafile) {
       this.handleNewDatafile(this.datafile, true);
     }
@@ -229,7 +233,7 @@ export class ProjectConfigManagerImpl extends BaseService implements ProjectConf
    * @param {Boolean} isSsr  
    * @returns {void}
    */
-  setSsr(isSsr?: boolean): void {
+  setSsr(isSsr: boolean): void {
     this.isSsr = isSsr;
   }
 }

lib/tests/mock/mock_project_config_manager.ts

@@ -26,6 +26,7 @@ type MockOpt = {
 
 export const getMockProjectConfigManager = (opt: MockOpt = {}): ProjectConfigManager => {
   return {
+    isSsr: false,
     config: opt.initConfig,
     start: () => {},
     setSsr: function(isSsr?:boolean) {