Merge pull request #38 from gotokatsuya/patch/userid-string-type

#37 feat: support string userId
appannie · Jul 15, 2021 · 026ebcc · 026ebcc
2 parents 72063cc + 66fbdad
commit 026ebcc
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 13 deletions.
diff --git a/packages/ab-testing/__tests__/index.test.ts b/packages/ab-testing/__tests__/index.test.ts
@@ -56,6 +56,25 @@ describe('ab-testing module', () => {
                     },
                 ],
             },
+            {
+                name: 'experiment_3',
+                cohorts: [
+                    { name: 'control', force_include: {} },
+                    {
+                        name: 'test_allocation',
+                        allocation: [[0, 50]],
+                    },
+                    {
+                        name: 'test_force_include',
+                        force_include: hashObject(
+                            {
+                                user_id: ['123456789'],
+                            },
+                            salt
+                        ),
+                    },
+                ],
+            },
         ],
         salt,
     };
@@ -183,6 +202,20 @@ describe('ab-testing module', () => {
                 hashObject({ user_id: 1, email_domain: 'a.com' }, config.salt)
             ).getCohort('experiment_2')
         ).toEqual('test_force_include');
+        expect(
+            new Experiments(
+                config,
+                '12345',
+                hashObject({ user_id: '12345' }, config.salt)
+            ).getCohort('experiment_3')
+        ).toEqual('control');
+        expect(
+            new Experiments(
+                config,
+                '123456789',
+                hashObject({ user_id: '123456789' }, config.salt)
+            ).getCohort('experiment_3')
+        ).toEqual('test_force_include');
         expect(
             Array(20)
                 .fill(0)
@@ -201,7 +234,7 @@ describe('ab-testing module', () => {
                 config,
                 1,
                 hashObject({ user_id: 1, email_domain: 'example.com' }, config.salt)
-            ).getCohort('experiment_3')
+            ).getCohort('experiment_any')
         ).toEqual('control');
     });
 
@@ -215,15 +248,15 @@ describe('ab-testing module', () => {
         expect(experiment.getCohort('experiment_2')).toEqual('test_force_include');
     });
 
-    it('does not show an error message if NODE_ENV is  test', () => {
+    it('does not show an error message if NODE_ENV is test', () => {
         const spy = jest.spyOn(console, 'error').mockImplementation();
 
         expect(
             new Experiments(
                 config,
                 1,
                 hashObject({ user_id: 1, email_domain: 'example.com' }, config.salt)
-            ).getCohort('experiment_3')
+            ).getCohort('experiment_any')
         ).toEqual('control');
         expect(spy).not.toHaveBeenCalled();
     });
@@ -238,8 +271,8 @@ describe('ab-testing module', () => {
             hashObject({ user_id: 1, email_domain: 'example.com' }, config.salt)
         );
 
-        expect(experiments.getCohort('experiment_3')).toEqual('control');
-        expect(experiments.hasExperiment('experiment_3')).toBe(false);
+        expect(experiments.getCohort('experiment_any')).toEqual('control');
+        expect(experiments.hasExperiment('experiment_any')).toBe(false);
         expect(spy).toHaveBeenCalled();
 
         global.process.env.NODE_ENV = initialEnv;

diff --git a/packages/ab-testing/src/index.js.flow b/packages/ab-testing/src/index.js.flow
@@ -18,13 +18,13 @@ export type ABTestingConfig = {
 };
 declare export class Experiments {
     config: ABTestingConfig;
-    userId: number;
+    userId: number | string;
     userProfile: {
         [s: string]: string,
     };
     constructor(
         config: ABTestingConfig,
-        userId: number,
+        userId: number | string,
         userProfile: {
             [s: string]: string,
         }

diff --git a/packages/ab-testing/src/index.ts b/packages/ab-testing/src/index.ts
@@ -21,13 +21,13 @@ export type ABTestingConfig = {
     experiments: Experiment[];
 };
 
-function getModuloValue(experiment: string, userId: number): number {
+function getModuloValue(experiment: string, userId: number | string): number {
     return crc32.calculate(String(userId), crc32.calculate(experiment)) % 100;
 }
 
 function matchUserCohort(
     experimentConfig: Experiment,
-    userId: number,
+    userId: number | string,
     userProfile: { [s: string]: string }
 ): string {
     const userSegmentNum = getModuloValue(experimentConfig.name, userId);
@@ -53,11 +53,15 @@ function matchUserCohort(
 
 export class Experiments {
     config: { [experimentName: string]: Experiment };
-    userId: number;
+    userId: number | string;
     userProfile: { [s: string]: string };
     matchedCohorts: { [experimentName: string]: string };
 
-    constructor(config: ABTestingConfig, userId: number, userProfile: { [s: string]: string }) {
+    constructor(
+        config: ABTestingConfig,
+        userId: number | string,
+        userProfile: { [s: string]: string }
+    ) {
         this.config = {};
         this.userId = userId;
         this.userProfile = userProfile;

diff --git a/packages/react-ab-testing/src/index.js.flow b/packages/react-ab-testing/src/index.js.flow
@@ -5,7 +5,7 @@ export type { ABTestingConfig } from '@appannie/ab-testing';
 
 declare export var ABTestingController: React.ComponentType<{
     config: ABTestingConfig,
-    userId: number,
+    userId: number | string,
     userProfile: {
         [key: string]: string,
     },

diff --git a/packages/react-ab-testing/src/index.tsx b/packages/react-ab-testing/src/index.tsx
@@ -15,7 +15,7 @@ const ABTestingContext = React.createContext<ABTestingContextType>({
 
 export const ABTestingController: React.FunctionComponent<{
     config: ABTestingConfig;
-    userId: number;
+    userId: number | string;
     userProfile: { [key: string]: string };
     children: ReactNode;
 }> = ({ config, userId, userProfile, children }) => {