Return null for initializevalues when initialize fails (#139)

* return null for initializevalues when initialize fails

* Use specstore update time

* feedback

index.d.ts

@@ -127,6 +127,15 @@ declare module 'statsig-node' {
    */
   export function shutdown(): void;
 
+  /**
+   * Returns the initialize values for the given user
+   * Can be used to bootstrap a client SDK with up to date values
+   * @param user the user to evaluate configurations for
+   */
+  export function getClientInitializeResponse(
+    user: StatsigUser,
+  ): Record<string, unknown> | null;
+
   /**
    * Overrides the given gate with the provided value
    * If no userID is provided, it will override for all users

package.json

@@ -1,6 +1,6 @@
 {
   "name": "statsig-node",
-  "version": "4.12.0",
+  "version": "4.12.0-beta.5",
   "description": "Statsig Node.js SDK for usage in multi-user server environments.",
   "main": "dist/src/index.js",
   "scripts": {

src/Evaluator.js

@@ -177,6 +177,9 @@ const Evaluator = {
    * @returns {Record<string, unknown>}
    */
   getClientInitializeResponse(user) {
+    if (!SpecStore.isServingChecks()) {
+      return null;
+    }
     const gates = Object.entries(SpecStore.store.gates)
       .map(([gate, spec]) => {
         if (spec.entity === 'segment') {

src/SpecStore.js

@@ -46,6 +46,10 @@ const SpecStore = {
     this.initialized = true;
   },
 
+  isServingChecks() {
+    return this.time !== 0;
+  },
+
   async _syncValues() {
     try {
       const response = await fetcher.post(
@@ -69,7 +73,9 @@ const SpecStore = {
       }
     } catch (e) {
       console.error(
-        `statsigSDK::sync> Failed while attempting to sync values: ${e.message ?? ''}`,
+        `statsigSDK::sync> Failed while attempting to sync values: ${
+          e?.message ?? ''
+        }`,
       );
     }
 

src/__tests__/ClientInitializeResponseConsistency.test.js

@@ -0,0 +1,105 @@
+const fs = require('fs');
+const path = require('path');
+const fetch = require('node-fetch');
+
+let secret = process.env.test_api_key;
+if (!secret) {
+  try {
+    secret = fs.readFileSync(
+      path.resolve(
+        __dirname,
+        '../../../ops/secrets/prod_keys/statsig-rulesets-eval-consistency-test-secret.key',
+      ),
+      'utf8',
+    );
+  } catch {}
+}
+
+if (secret) {
+  describe('Verify e2e behavior consistency /initialize vs getClientInitializeResponse', () => {
+    beforeEach(() => {
+      jest.restoreAllMocks();
+      jest.resetModules();
+    });
+
+    ['https://api.statsig.com/v1', 'https://latest.api.statsig.com/v1'].map(
+      (url) =>
+        test(`server and SDK evaluates gates to the same results on ${url}`, async () => {
+          await _validateInitializeConsistency(url);
+        }),
+    );
+  });
+} else {
+  describe('fail for non employees', () => {
+    test('Intended failing test. Proceed with pull request unless you are a Statsig employee.', () => {
+      console.log(
+        'THIS TEST IS EXPECTED TO FAIL FOR NON-STATSIG EMPLOYEES! If this is the only test failing, please proceed to submit a pull request. If you are a Statsig employee, chat with jkw.',
+      );
+      expect(true).toBe(false);
+    });
+  });
+}
+
+async function _validateInitializeConsistency(api) {
+  expect.assertions(1);
+  const user = {
+    userID: '12345',
+    email: '[email protected]',
+    country: 'US',
+    custom: {
+      test: '123',
+    },
+  };
+  const response = await fetch(api + '/initialize', {
+    method: 'POST',
+    body: JSON.stringify({
+      user: user,
+      statsigMetadata: {
+        sdkType: 'consistency-test',
+        sessionID: 'x123',
+      },
+    }),
+    headers: {
+      'Content-type': 'application/json; charset=UTF-8',
+      'STATSIG-API-KEY': 'client-wlH3WMkysINMhMU8VrNBkbjrEr2JQrqgxKwDPOUosJK',
+      'STATSIG-CLIENT-TIME': Date.now(),
+    },
+  });
+  const testData = await response.json();
+  // for sake of comparison, normalize the initialize response
+  // drop unused fields, set the time to 0
+  testData.time = 0;
+
+  for (const topLevel in testData) {
+    for (const property in testData[topLevel]) {
+      const item = testData[topLevel][property];
+      if (item.secondary_exposures) {
+        item.secondary_exposures.map((item) => {
+          delete item.gate;
+        });
+      }
+      // TODO for full layers future proofing
+      delete item['explicit_parameters'];
+      delete item['is_in_layer'];
+    }
+  }
+
+  const statsig = require('../index');
+  await statsig.initialize(secret, { api: api });
+
+  const sdkInitializeResponse = statsig.getClientInitializeResponse(user);
+
+  for (const topLevel in sdkInitializeResponse) {
+    for (const property in sdkInitializeResponse[topLevel]) {
+      const item = sdkInitializeResponse[topLevel][property];
+      if (item.secondary_exposures) {
+        // initialize has these hashed, we are putting them in plain text
+        // exposure logging still works
+        item.secondary_exposures.map((item) => {
+          delete item.gate;
+        });
+      }
+    }
+  }
+  expect(sdkInitializeResponse).toEqual(testData);
+}

src/__tests__/RulesetsEvalConsistency.test.js

@@ -30,7 +30,7 @@ if (secret) {
     );
   });
 } else {
-  describe('', () => {
+  describe('fail for non employees', () => {
     test('Intended failing test. Proceed with pull request unless you are a Statsig employee.', () => {
       console.log(
         'THIS TEST IS EXPECTED TO FAIL FOR NON-STATSIG EMPLOYEES! If this is the only test failing, please proceed to submit a pull request. If you are a Statsig employee, chat with jkw.',

src/__tests__/StatsigE2ETest.test.js

@@ -35,13 +35,23 @@ describe('Verify e2e behavior of the SDK with mocked network', () => {
           ok: true,
         });
       }
+      if (url.includes('get_id_lists')) {
+        postedLogs = JSON.parse(params.body);
+        return Promise.resolve({
+          ok: true,
+          json: () => Promise.resolve({}),
+        });
+      }
       return Promise.reject();
     });
   });
 
   test('Verify checkGate and exposure logs', async () => {
     const statsig = require('../index');
     await statsig.initialize('secret-123');
+    expect(statsig.getClientInitializeResponse(statsigUser)).toEqual(
+      INIT_RESPONSE,
+    );
     const on = await statsig.checkGate(statsigUser, 'always_on_gate');
     expect(on).toEqual(true);
     const passingEmail = await statsig.checkGate(

src/index.js

@@ -247,6 +247,17 @@ const statsig = {
     Evaluator.shutdown();
   },
 
+  getClientInitializeResponse(user) {
+    if (statsig._ready !== true) {
+      return Promise.reject(
+        new Error(
+          'statsigSDK::getClientInitializeResponse> Must call initialize() first.',
+        ),
+      );
+    }
+    return Evaluator.getClientInitializeResponse(user);
+  },
+
   overrideGate(gateName, value, userID = '') {
     if (typeof value !== 'boolean') {
       console.warn(

src/utils/StatsigFetcher.js

@@ -62,10 +62,11 @@ const fetcher = {
         }
         return Promise.resolve(res);
       })
-      .catch(() => {
+      .catch((e) => {
         if (retries > 0) {
           return this._retry(url, sdkKey, body, retries, backoff);
         }
+        return Promise.reject(e);
       })
       .finally(() => {
         fetcher.leakyBucket[url] = Math.max(fetcher.leakyBucket[url] - 1, 0);