feat: add test file

AlexStack · AlexStack · commit e2311cecdc0d · 2023-10-13T18:10:09.000+13:00
diff --git a/.npmignore b/.npmignore
@@ -12,4 +12,5 @@ serverless.*
 *.gz
 *bak.js
 *BAK.js
-test
+test
+__test__
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-MIT License
+# MIT License
 
 Copyright (c) 2023 Alex Zeng
 
diff --git a/README.md b/README.md
@@ -17,16 +17,16 @@ yarn add cloud-configuration
 ## Basic Usage
 
 ```typescript
-import cloudConfig from "cloud-configuration";
+import cloudConfig from 'cloud-configuration';
 
 const configs = await cloudConfig.fetchAll();
 
-const auFlagUrl = cloudConfig.get({ configs, featureKey: "au_flag_url" }); // return value or null
+const auFlagUrl = cloudConfig.get({ configs, featureKey: 'au_flag_url' }); // return value or null
 
 const usFlagUrl = cloudConfig.getWithDefault({
   configs,
-  featureKey: "us_flag_url",
-  defaultValue: "https://example.com/us.png",
+  featureKey: 'us_flag_url',
+  defaultValue: 'https://example.com/us.png',
 }); // return typed value or default value, good for typescript
 ```
 
diff --git a/__test__/cloud-config.test.ts b/__test__/cloud-config.test.ts
@@ -0,0 +1,101 @@
+import { mockApiData } from './mock-api-data';
+import cloudConfig, { CloudConfigData } from '../index';
+
+let cloudConfigData: CloudConfigData[] = [];
+
+const decryptSecret = 'CLIENT_/lMAHJcive';
+
+describe('fetchAllConfigs', () => {
+  it('should fetch configs successfully', async () => {
+    const mockResponse = {
+      ok: true,
+      json: jest.fn().mockResolvedValue(mockApiData),
+    };
+    const mockFetch = jest.fn().mockResolvedValue(mockResponse);
+    global.fetch = mockFetch;
+
+    cloudConfigData = await cloudConfig.fetchAll({
+      decryptSecret,
+    });
+
+    expect(mockFetch).toHaveBeenCalledTimes(1);
+    expect(mockFetch).toHaveBeenCalledWith(
+      expect.any(String),
+      expect.any(Object)
+    );
+    expect(mockResponse.json).toHaveBeenCalledTimes(1);
+    expect(cloudConfigData[2].featureKey).toEqual(mockApiData[2].featureKey);
+  });
+
+  it('should throw an error when response is not ok', async () => {
+    const mockResponse = { ok: false, status: 404, statusText: 'Not Found' };
+    const mockFetch = jest.fn().mockResolvedValue(mockResponse);
+    global.fetch = mockFetch;
+
+    const result = await cloudConfig.fetchAll();
+    expect(result.length).toEqual(0);
+  });
+
+  it('should catch and log errors', async () => {
+    const mockError = new Error('Test error');
+    const mockFetch = jest.fn().mockRejectedValue(mockError);
+    global.fetch = mockFetch;
+
+    const consoleSpy = jest.spyOn(console, 'log').mockImplementation();
+
+    const result = await cloudConfig.fetchAll();
+
+    expect(consoleSpy).toHaveBeenCalledTimes(1);
+    expect(consoleSpy).toHaveBeenCalledWith(
+      '💔💔💔 fetchAllConfigs error:',
+      mockError
+    );
+    expect(result).toEqual([]);
+  });
+});
+
+describe('getConfigWithDefaultValue', () => {
+  it('should return the correct cloud config value', () => {
+    const boolean_2 = cloudConfig.getWithDefault({
+      configs: cloudConfigData,
+      featureKey: 'boolean_2',
+      defaultValue: true,
+    });
+    expect(boolean_2).toEqual(false);
+
+    const key_not_exists = cloudConfig.getWithDefault({
+      configs: cloudConfigData,
+      featureKey: 'key_not_exists',
+      defaultValue: 'default_value_if_key_not_exists',
+    });
+    expect(key_not_exists).toEqual('default_value_if_key_not_exists');
+
+    const encrypt_array_001 = cloudConfig.getWithDefault({
+      configs: cloudConfigData,
+      projectName: 'project001',
+      groupName: 'group001',
+      featureKey: 'encrypt_key_001',
+      defaultValue: ['encrypt_key_001_value', 'value2'],
+    });
+    expect(encrypt_array_001).toEqual([
+      'a1',
+      'a2',
+      's3',
+      's a7',
+      'hamilton east',
+    ]);
+
+    const encrypt_json_001 = cloudConfig.getWithDefault({
+      configs: cloudConfigData,
+      featureKey: 'json_key_1',
+      defaultValue: { message: 'json message' },
+    });
+    expect(encrypt_json_001.message).toEqual('I am JSON');
+
+    const not_enabled_key = cloudConfig.get({
+      configs: cloudConfigData,
+      featureKey: 'float_key_1',
+    });
+    expect(not_enabled_key).toEqual(null);
+  });
+});
diff --git a/__test__/mock-api-data.ts b/__test__/mock-api-data.ts
@@ -0,0 +1,110 @@
+export const mockApiData = [
+  {
+    projectName: 'defaultProject',
+    groupName: 'defaultGroup',
+    featureKey: 'json_key_1',
+    value:
+      'U2FsdGVkX1+mogKJ4wd9gZ2YJ2e7s+mJXtADCnww2B1VfsSBnpyI+Y+Bwz7kpayLjkvSWEMk4iRNo38BtNKFBUrkj5lm7K0my/7xHY1KqvHA5z1msr4yAIsrJETCIl3X',
+    valueType: 'json',
+    valueEncrypted: true,
+    prodEnabled: true,
+    devEnabled: true,
+  },
+  {
+    projectName: 'defaultProject',
+    groupName: 'defaultGroup',
+    featureKey: 'population_auk',
+    value: 'U2FsdGVkX1+r7+y9XWTBXxtfCQLUiryxKVyT3C298A0=',
+    valueType: 'number',
+    valueEncrypted: true,
+    prodEnabled: false,
+    devEnabled: false,
+  },
+  {
+    projectName: 'defaultProject',
+    groupName: 'defaultGroup',
+    featureKey: 'key1',
+    value: 'value1',
+    valueType: 'string',
+    prodEnabled: true,
+    devEnabled: true,
+  },
+  {
+    projectName: 'defaultProject',
+    groupName: 'defaultGroup',
+    featureKey: 'key1a',
+    value: 'Default Value1',
+    valueType: 'string',
+    prodEnabled: true,
+    devEnabled: false,
+  },
+  {
+    projectName: 'project001',
+    groupName: 'group001',
+    featureKey: 'encrypt_key_001',
+    value:
+      'U2FsdGVkX1/r7C9jX5YV0e772hXz0dkdcz3WF+UfLooTybLFCjzVVUGVHxOPhNU0A8nf7lT45sJKD5cVIAHOyA==',
+    valueType: 'array',
+    valueEncrypted: true,
+    prodEnabled: true,
+    devEnabled: true,
+  },
+  {
+    projectName: 'project002',
+    groupName: 'group002',
+    featureKey: 'encrypt_key_002',
+    value: 'U2FsdGVkX1+jmy577IqUlWs+ydML3Rs8S6LnAo1wWKG9Gk9Vvjh35rZETsW5D09f',
+    valueType: 'array',
+    valueEncrypted: true,
+    prodEnabled: false,
+    devEnabled: true,
+  },
+  {
+    projectName: 'defaultProject',
+    groupName: 'defaultGroup',
+    featureKey: 'boolean_1',
+    value: true,
+    valueType: 'boolean',
+    prodEnabled: true,
+    devEnabled: false,
+  },
+  {
+    projectName: 'defaultProject',
+    groupName: 'defaultGroup',
+    featureKey: 'boolean_2',
+    value: false,
+    valueType: 'boolean',
+    prodEnabled: true,
+    devEnabled: true,
+  },
+  {
+    projectName: 'defaultProject',
+    groupName: 'defaultGroup',
+    featureKey: 'boolean_003',
+    value: true,
+    valueType: 'boolean',
+    prodEnabled: true,
+    devEnabled: true,
+  },
+  {
+    projectName: 'defaultProject',
+    groupName: 'defaultGroup',
+    featureKey: 'float_key_1',
+    value: 23.32,
+    valueType: 'number',
+    prodEnabled: false,
+    devEnabled: false,
+  },
+  {
+    projectName: 'defaultProject',
+    groupName: 'defaultGroup',
+    featureKey: 'cloudConfigExtraData',
+    value: {
+      dataRetrievedAt: '2023-10-13T02:18:22.237Z',
+      configCount: 10,
+    },
+    valueType: 'json',
+    prodEnabled: true,
+    devEnabled: true,
+  },
+];
diff --git a/cloud-config.ts b/cloud-config.ts
@@ -20,7 +20,10 @@ export const decryptConfig = (
     const decryptedData = AES.decrypt(data, cryptSecret);
     const decryptedText = decryptedData.toString(encUtf8);
     if (!decryptedText || decryptedText === data) {
-      return 'Decrypt value failed! Make sure the encrypt secret is correct in env';
+      return (
+        'Decrypt value failed! Make sure the encrypt secret is correct in env' +
+        cryptSecret
+      );
     }
     return decryptedText;
   } catch (error) {
@@ -31,15 +34,17 @@ export const decryptConfig = (
 
 export const parseSingleConfig = (
   config: CloudConfigData,
-  serverSideOnly = false
+  serverSideOnly = false,
+  decryptSecret?: string
 ): CloudConfigData => {
   if (!config.valueEncrypted) {
     return config;
   }
   const cryptSecret = serverSideOnly
     ? CLOUD_CONFIG_SERVER_ENCRYPT_SECRET
     : CLOUD_CONFIG_CLIENT_ENCRYPT_SECRET;
-  if (!cryptSecret) {
+  const newDecryptSecret = decryptSecret || cryptSecret;
+  if (!newDecryptSecret) {
     // eslint-disable-next-line no-console
     console.log(
       `😅😅😅 Can't decrypt featureKey ${config.featureKey}, Please set ${
@@ -50,7 +55,10 @@ export const parseSingleConfig = (
     );
     return config;
   }
-  const decryptedValue = decryptConfig(config.value as string, cryptSecret);
+  const decryptedValue = decryptConfig(
+    config.value as string,
+    newDecryptSecret
+  );
   if (!decryptedValue) {
     return config;
   }
@@ -87,9 +95,12 @@ export const parseSingleConfig = (
 
 export const parseAllConfigs = (
   configs: CloudConfigData[],
-  serverSideOnly = false
+  serverSideOnly = false,
+  decryptSecret?: string
 ): CloudConfigData[] => {
-  return configs.map((config) => parseSingleConfig(config, serverSideOnly));
+  return configs.map((config) =>
+    parseSingleConfig(config, serverSideOnly, decryptSecret)
+  );
 };
 
 interface GetCloudConfigParams<T> {
@@ -145,7 +156,15 @@ export const getConfigWithDefaultValue = <T>(
 
 export const fetchAllConfigs = async (params?: FetchAllConfigsParams) => {
   try {
-    const { orgId, serverSide, accessToken, cache, apiPrefix, cacheSeconds } = {
+    const {
+      orgId,
+      serverSide,
+      accessToken,
+      cache,
+      apiPrefix,
+      cacheSeconds,
+      decryptSecret,
+    } = {
       ...CLOUD_CONFIG_FETCH_ALL_DEFAULT_VALUE,
       ...params,
     };
@@ -188,7 +207,7 @@ export const fetchAllConfigs = async (params?: FetchAllConfigsParams) => {
 
     const configs = ((await response.json()) || []) as CloudConfigData[];
 
-    return parseAllConfigs(configs, serverSide);
+    return parseAllConfigs(configs, serverSide, decryptSecret);
   } catch (error) {
     console.log('💔💔💔 fetchAllConfigs error:', error);
   }
diff --git a/package.json b/package.json
@@ -1,13 +1,14 @@
 {
   "name": "cloud-configuration",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "This package allows you to use CloudConfig easily.",
   "author": "Alex Zeng",
   "license": "MIT",
   "main": "index.js",
   "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "publish-package": "npm publish --access public"
   },
   "repository": {
     "type": "git",
diff --git a/test/test-config.ts b/test/test-config.ts
diff --git a/tsconfig.json b/tsconfig.json
@@ -25,11 +25,17 @@
       }
     ]
   },
-    "ts-node": {
-        // Tell ts-node CLI to install the --loader automatically
-        "esm": true
-    },
-  "include": ["next-env.d.ts", "**/*.ts", "*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "ts-node": {
+    // Tell ts-node CLI to install the --loader automatically
+    "esm": true
+  },
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts"
+  ],
   "exclude": ["node_modules"],
   "moduleResolution": ["node_modules", ".next", "node"]
 }
diff --git a/types.ts b/types.ts
@@ -16,4 +16,5 @@ export interface FetchAllConfigsParams {
   cache?: RequestCache;
   apiPrefix?: string;
   cacheSeconds?: number;
+  decryptSecret?: string;
 }

-Original file line number
+Diff line change
 *.gz
 *bak.js
 *BAK.js
 -test
 +test
 +__test__
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-MIT License`
	`1`	`+# MIT License`
`2`	`2`
`3`	`3`	`Copyright (c) 2023 Alex Zeng`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,5 @@ export interface FetchAllConfigsParams {`
`16`	`16`	`cache?: RequestCache;`
`17`	`17`	`apiPrefix?: string;`
`18`	`18`	`cacheSeconds?: number;`
	`19`	`+ decryptSecret?: string;`
`19`	`20`	`}`