feat: unify initialization process with other sdks

.github/workflows/pull-request.yml

@@ -66,6 +66,10 @@ jobs:
         run: make fmt
       - name: Lint
         run: make lint
+      - name: Check types
+        run: make type-check
+      - name: Check custom ESLint rules
+        run: make test-eslint
 
   unit-test:
     name: Unit test
@@ -117,4 +121,4 @@ jobs:
         run: make init
       - name: Example Build
         working-directory: ${{ env.EXAMPLE_PATH }}
-        run: make build
+        run: make build

.nvmrc

@@ -1 +1 @@
-16.13.0
+18.18.2

Makefile

@@ -51,6 +51,21 @@ test:
 	$(NPM_BIN_DIR)/babel src --extensions '.ts' --config-file "$(CURDIR)/babel-test.config.js" --out-dir "__test"
 	$(NPM_BIN_DIR)/ava --config ava-test.config.mjs
 
+.PHONY: test-single
+test-single:
+	rm -rf $(CURDIR)/__test
+	$(NPM_BIN_DIR)/babel src --extensions '.ts' --config-file "$(CURDIR)/babel-test.config.js" --out-dir "__test"
+	$(NPM_BIN_DIR)/ava --config ava-test.config.mjs $(filter-out $@,$(MAKECMDGOALS))
+
+.PHONY: test-eslint
+test-eslint:
+	node eslint-rules/no-spread-after-defaults.test.mjs
+
+.PHONY: type-check
+type-check:
+	$(NPM_BIN_DIR)/tsc --noEmit --project tsconfig.json
+	$(NPM_BIN_DIR)/tsc --noEmit --project tsconfig.test.json
+
 .PHONY: e2e
 e2e: copy-genfiles
 	rm -rf $(CURDIR)/__e2e

README.md

@@ -64,10 +64,11 @@ make init
 make fmt
 ```
 
-#### Lint
+#### Lint & Type check
 
 ```bash
 make lint
+make type-check
 ```
 
 #### Build
@@ -99,4 +100,10 @@ export NPM_TOKEN=<YOUR_NPM_TOKEN>
 make publish
 ```
 
+### Write tests
+- Write tests in the `src/__tests__` directory. The test files should following snake_case naming convention. Its differ from the library code which uses camelCase.
+- Use `ava` as the test runner. You can find the configuration in the [ava.config.mjs](./ava.config.mjs) file.
+- Run all tests using `make test` command.
+- Run single test using `make test-single <path-to-test-file>` command.
+
 **Note:** The publishing process is automated using [GitHub Actions](https://github.com/bucketeer-io/node-server-sdk/blob/master/.github/workflows/release.yml)https://github.com/bucketeer-io/node-server-sdk/blob/master/.github/workflows/release.yml to publish it when the released tag is created.

e2e/client.ts

@@ -1,9 +1,16 @@
-import test from 'ava'
-import { initialize, DefaultLogger } from '../lib';
-import { HOST, TOKEN, FEATURE_TAG, TARGETED_USER_ID, FEATURE_ID_BOOLEAN } from './constants/constants';
+import test from 'ava';
+import { initializeBKTClient, defineBKTConfig, DefaultLogger, initialize } from '../lib';
+import {
+  HOST,
+  TOKEN,
+  FEATURE_TAG,
+  TARGETED_USER_ID,
+  FEATURE_ID_BOOLEAN,
+} from './constants/constants';
 import { MetricsEvent, isMetricsEvent } from '../lib/objects/metricsEvent';
 import { ApiId } from '../lib/objects/apiId';
 import { BKTClientImpl } from '../lib/client';
+import { Config } from '../src';
 
 const FORBIDDEN_ERROR_METRICS_EVENT_NAME =
   'type.googleapis.com/bucketeer.event.client.ForbiddenErrorMetricsEvent';
@@ -12,93 +19,136 @@ const NOT_FOUND_ERROR_METRICS_EVENT_NAME =
 
 //Note: There is a different compared to other SDK clients.
 test('Using a random string in the api key setting should not throw exception', async (t) => {
-  const bktClient = initialize({
-    host: HOST,
-    token: "TOKEN_RANDOM",
-    tag: FEATURE_TAG,
-    logger: new DefaultLogger("error")
+  const config = defineBKTConfig({
+    apiEndpoint: HOST,
+    apiKey: 'TOKEN_RANDOM',
+    featureTag: FEATURE_TAG,
+    logger: new DefaultLogger('error'),
   });
-  const user = { id: TARGETED_USER_ID, data: {} }
+  const bktClient = initializeBKTClient(config);
+  const user = { id: TARGETED_USER_ID, data: {} };
   // The client can not load the evaluation, we will received the default value `true`
   // Other SDK clients e2e test will expect the value is `false`
   const result = await t.notThrowsAsync(bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, true));
   t.true(result);
 
-  const bktClientImpl = bktClient as BKTClientImpl
-  const events = bktClientImpl.eventStore.getAll()
+  const bktClientImpl = bktClient as BKTClientImpl;
+  const events = bktClientImpl.eventStore.getAll();
   // The SDK skips generating error events for unauthorized errors, so no error events should be present
-  t.false(events.some((e) => {
-    if (isMetricsEvent(e.event)) {
-      const metrics = e.event as MetricsEvent
-      return metrics.event?.['@type'] === FORBIDDEN_ERROR_METRICS_EVENT_NAME && metrics.event?.apiId === ApiId.GET_EVALUATION
-    }
-    return false;
-  }));
-
-  bktClient.destroy()
+  t.false(
+    events.some((e) => {
+      if (isMetricsEvent(e.event)) {
+        const metrics = e.event as MetricsEvent;
+        return (
+          metrics.event?.['@type'] === FORBIDDEN_ERROR_METRICS_EVENT_NAME &&
+          metrics.event?.apiId === ApiId.GET_EVALUATION
+        );
+      }
+      return false;
+    }),
+  );
+
+  bktClient.destroy();
 });
 
 test('altering featureTag should not affect api request', async (t) => {
-  const config = {
-    host: HOST,
-    token: TOKEN,
-    tag: FEATURE_TAG,
-    logger: new DefaultLogger("error")
-  }
-  const bktClient = initialize(config);
-  const user = { id: TARGETED_USER_ID, data: {} }
-  const result = await t.notThrowsAsync(bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, false));
+  const config = defineBKTConfig({
+    apiEndpoint: HOST,
+    apiKey: TOKEN,
+    featureTag: FEATURE_TAG,
+    logger: new DefaultLogger('error'),
+  });
+  const bktClient = initializeBKTClient(config);
+  const user = { id: TARGETED_USER_ID, data: {} };
+  const result = await t.notThrowsAsync(
+    bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, false),
+  );
   t.true(result);
-  config.tag = "RANDOME"
+  config.featureTag = 'RANDOME';
 
-  const resultAfterAlterAPIKey = await t.notThrowsAsync(bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, false));
+  const resultAfterAlterAPIKey = await t.notThrowsAsync(
+    bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, false),
+  );
   t.true(resultAfterAlterAPIKey);
 
-  bktClient.destroy()
+  bktClient.destroy();
 });
 
 test('Altering the api key should not affect api request', async (t) => {
-  const config = {
-    host: HOST,
-    token: TOKEN,
-    tag: FEATURE_TAG,
-    logger: new DefaultLogger("error")
-  }
-  const bktClient = initialize(config);
-  const user = { id: TARGETED_USER_ID, data: {} }
-  const result = await t.notThrowsAsync(bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, false));
+  const config = defineBKTConfig({
+    apiEndpoint: HOST,
+    apiKey: TOKEN,
+    featureTag: FEATURE_TAG,
+    logger: new DefaultLogger('error'),
+  });
+  const bktClient = initializeBKTClient(config);
+  const user = { id: TARGETED_USER_ID, data: {} };
+  const result = await t.notThrowsAsync(
+    bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, false),
+  );
   t.true(result);
-  config.token = "RANDOME"
+  config.apiKey = 'RANDOME';
 
-  const resultAfterAlterAPIKey = await t.notThrowsAsync(bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, false));
+  const resultAfterAlterAPIKey = await t.notThrowsAsync(
+    bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, false),
+  );
   t.true(resultAfterAlterAPIKey);
 
-  bktClient.destroy()
+  bktClient.destroy();
 });
 
 //Note: There is a different compared to other SDK clients.
 test('Using a random string in the featureTag setting should affect api request', async (t) => {
-  const bktClient = initialize({
-    host: HOST,
-    token: TOKEN,
-    tag: "RANDOM",
-    logger: new DefaultLogger("error")
+  const config = defineBKTConfig({
+    apiEndpoint: HOST,
+    apiKey: TOKEN,
+    featureTag: 'RANDOM',
+    logger: new DefaultLogger('error'),
   });
-  const user = { id: TARGETED_USER_ID, data: {} }
+  const bktClient = initializeBKTClient(config);
+  const user = { id: TARGETED_USER_ID, data: {} };
   const result = await t.notThrowsAsync(bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, true));
   // The client can not load the evaluation, we will received the default value `true`
   // Other SDK clients e2e test will expect the value is `false`
   t.true(result);
 
-  const bktClientImpl = bktClient as BKTClientImpl
-  const events = bktClientImpl.eventStore.getAll()
-  t.true(events.some((e) => {
-    if (isMetricsEvent(e.event)) {
-      const metrics = e.event as MetricsEvent
-      return metrics.event?.['@type'] === NOT_FOUND_ERROR_METRICS_EVENT_NAME && metrics.event?.apiId === ApiId.GET_EVALUATION
-    }
-    return false;
-  }));
-
-  bktClient.destroy()
-});
+  const bktClientImpl = bktClient as BKTClientImpl;
+  const events = bktClientImpl.eventStore.getAll();
+  t.true(
+    events.some((e) => {
+      if (isMetricsEvent(e.event)) {
+        const metrics = e.event as MetricsEvent;
+        return (
+          metrics.event?.['@type'] === NOT_FOUND_ERROR_METRICS_EVENT_NAME &&
+          metrics.event?.apiId === ApiId.GET_EVALUATION
+        );
+      }
+      return false;
+    }),
+  );
+
+  bktClient.destroy();
+});
+
+test('The deprecated function for initializing the client should still work.', async (t) => {
+  const config: Config = {
+    host: HOST,
+    token: TOKEN,
+    tag: FEATURE_TAG,
+    logger: new DefaultLogger('error'),
+  };
+  const bktClient = initialize(config);
+  const user = { id: TARGETED_USER_ID, data: {} };
+  const result = await t.notThrowsAsync(
+    bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, false),
+  );
+  t.true(result);
+  config.tag = 'RANDOME';
+
+  const resultAfterAlterAPIKey = await t.notThrowsAsync(
+    bktClient.booleanVariation(user, FEATURE_ID_BOOLEAN, false),
+  );
+  t.true(resultAfterAlterAPIKey);
+
+  bktClient.destroy();
+});

e2e/evaluations_defaut_strategy.ts

@@ -1,18 +1,28 @@
 import anyTest, { TestFn } from 'ava';
-import { Bucketeer, DefaultLogger, User, initialize } from '../lib';
-import { HOST, TOKEN, FEATURE_TAG, FEATURE_ID_BOOLEAN, FEATURE_ID_STRING, FEATURE_ID_INT, FEATURE_ID_JSON, FEATURE_ID_FLOAT } from './constants/constants';
+import { Bucketeer, DefaultLogger, User, defineBKTConfig, initializeBKTClient } from '../lib';
+import {
+  HOST,
+  TOKEN,
+  FEATURE_TAG,
+  FEATURE_ID_BOOLEAN,
+  FEATURE_ID_STRING,
+  FEATURE_ID_INT,
+  FEATURE_ID_JSON,
+  FEATURE_ID_FLOAT,
+} from './constants/constants';
 import { assetEvaluationDetails } from './utils/assert';
 
 const test = anyTest as TestFn<{ bktClient: Bucketeer; defaultUser: User }>;
 
 test.beforeEach((t) => {
+  const config = defineBKTConfig({
+    apiEndpoint: HOST,
+    apiKey: TOKEN,
+    featureTag: FEATURE_TAG,
+    logger: new DefaultLogger('error'),
+  });
   t.context = {
-    bktClient: initialize({
-      host: HOST,
-      token: TOKEN,
-      tag: FEATURE_TAG,
-      logger: new DefaultLogger("error")
-    }),
+    bktClient: initializeBKTClient(config),
     defaultUser: { id: 'user-1', data: {} },
   };
 });
@@ -31,8 +41,8 @@ test('boolVariation', async (t) => {
       variationName: 'variation 1',
       variationValue: true,
       reason: 'DEFAULT',
-    }
-  )
+    },
+  );
 });
 
 test('stringVariation', async (t) => {
@@ -49,8 +59,8 @@ test('stringVariation', async (t) => {
       variationName: 'variation 1',
       variationValue: 'value-1',
       reason: 'DEFAULT',
-    }
-  )
+    },
+  );
 });
 
 test('numberVariation', async (t) => {
@@ -67,8 +77,8 @@ test('numberVariation', async (t) => {
       variationName: 'variation 1',
       variationValue: 10,
       reason: 'DEFAULT',
-    }
-  )
+    },
+  );
 
   t.is(await bktClient.numberVariation(defaultUser, FEATURE_ID_FLOAT, 0.0), 2.1);
   assetEvaluationDetails(
@@ -82,15 +92,20 @@ test('numberVariation', async (t) => {
       variationName: 'variation 1',
       variationValue: 2.1,
       reason: 'DEFAULT',
-    }
-  )
-
+    },
+  );
 });
 
 test('objectVariation', async (t) => {
   const { bktClient, defaultUser } = t.context;
-  t.deepEqual(await bktClient.getJsonVariation(defaultUser, FEATURE_ID_JSON, {}), { "str": "str1", "int": "int1" });
-  t.deepEqual(await bktClient.objectVariation(defaultUser, FEATURE_ID_JSON, {}), { "str": "str1", "int": "int1" });
+  t.deepEqual(await bktClient.getJsonVariation(defaultUser, FEATURE_ID_JSON, {}), {
+    str: 'str1',
+    int: 'int1',
+  });
+  t.deepEqual(await bktClient.objectVariation(defaultUser, FEATURE_ID_JSON, {}), {
+    str: 'str1',
+    int: 'int1',
+  });
   assetEvaluationDetails(
     t,
     await bktClient.objectVariationDetails(defaultUser, FEATURE_ID_JSON, {}),
@@ -102,12 +117,11 @@ test('objectVariation', async (t) => {
       variationName: 'variation 1',
       variationValue: { str: 'str1', int: 'int1' },
       reason: 'DEFAULT',
-    }
-  )
+    },
+  );
 });
 
 test.afterEach(async (t) => {
   const { bktClient } = t.context;
   bktClient.destroy();
 });
-