Convert Session to factory function

Author: rzane

src/analyticsProvider.ts

@@ -1,4 +1,4 @@
-import Assignment from './assignment';
+import type Assignment from './assignment';
 
 export interface AnalyticsProvider {
   trackAssignment(visitorId: string, assignment: Assignment, callback: (value: boolean) => void): void;

src/index.ts

@@ -1,7 +1,8 @@
-import Session from './session';
+import { createSession } from './session';
 export type { AnalyticsProvider } from './analyticsProvider';
 
-const TestTrack = new Session().getPublicAPI();
+const TestTrack = createSession();
+
 const notifyListener = function () {
   window.dispatchEvent(
     new CustomEvent('tt:lib:loaded', {

src/session.test.ts

@@ -1,7 +1,7 @@
 import Assignment from './assignment';
 import { persistAssignmentOverride } from './assignmentOverride';
 import Cookies from 'js-cookie';
-import Session from './session';
+import { createSession, type Session } from './session';
 import Visitor from './visitor';
 import type { AnalyticsProvider } from './analyticsProvider';
 import type { RawConfig } from './config';
@@ -31,7 +31,7 @@ vi.mock('uuid');
 
 const mockPersistAssignmentOverride = vi.mocked(persistAssignmentOverride);
 
-describe('Session', () => {
+describe('createSession', () => {
   beforeAll(() => {
     window.TT = btoa(JSON.stringify(rawConfig));
   });
@@ -43,7 +43,7 @@ describe('Session', () => {
 
   describe('Cookie behavior', () => {
     it('reads the visitor id from a cookie and sets it back in the cookie', async () => {
-      await new Session().getPublicAPI().initialize({});
+      await createSession().initialize({});
       expect(Cookies.get).toHaveBeenCalledTimes(1);
       expect(Cookies.get).toHaveBeenCalledWith('custom_cookie_name');
       expect(Cookies.set).toHaveBeenCalledTimes(1);
@@ -60,7 +60,7 @@ describe('Session', () => {
       // @ts-expect-error uuid mock return type
       vi.mocked(uuid).mockReturnValue('generated_visitor_id');
 
-      await new Session().getPublicAPI().initialize({});
+      await createSession().initialize({});
       expect(Cookies.get).toHaveBeenCalledTimes(1);
       expect(Cookies.get).toHaveBeenCalledWith('custom_cookie_name');
       expect(Cookies.set).toHaveBeenCalledTimes(1);
@@ -77,15 +77,15 @@ describe('Session', () => {
 
     beforeEach(async () => {
       window.TT = btoa(JSON.stringify(rawConfig));
-      session = new Session();
+      session = createSession();
       await session.initialize({});
       vi.mocked(Cookies.set).mockClear();
     });
 
     describe('#initialize()', () => {
       it('calls notifyUnsyncedAssignments when a visitor is loaded', async () => {
         const notifySpy = vi.spyOn(Visitor.prototype, 'notifyUnsyncedAssignments');
-        await new Session().getPublicAPI().initialize({});
+        await createSession().initialize({});
         expect(notifySpy).toHaveBeenCalledTimes(1);
       });
 
@@ -98,7 +98,7 @@ describe('Session', () => {
 
         const setAnalyticsSpy = vi.spyOn(Visitor.prototype, 'setAnalytics');
 
-        await new Session().getPublicAPI().initialize({ analytics });
+        await createSession().initialize({ analytics });
         expect(setAnalyticsSpy).toHaveBeenCalledTimes(1);
         expect(setAnalyticsSpy).toHaveBeenCalledWith(analytics);
       });
@@ -107,7 +107,7 @@ describe('Session', () => {
         const errorLogger = function () {};
         const setErrorLoggerSpy = vi.spyOn(Visitor.prototype, 'setErrorLogger');
 
-        await new Session().getPublicAPI().initialize({ errorLogger: errorLogger });
+        await createSession().initialize({ errorLogger: errorLogger });
         expect(setErrorLoggerSpy).toHaveBeenCalledTimes(1);
         expect(setErrorLoggerSpy).toHaveBeenCalledWith(errorLogger);
       });
@@ -119,7 +119,7 @@ describe('Session', () => {
         // @ts-expect-error uuid returns different types depending on arguments
         vi.mocked(uuid).mockReturnValue('new_visitor_id');
 
-        const visitor = await new Session().getPublicAPI().initialize({
+        const visitor = await createSession().initialize({
           config: {
             url: 'http://localhost:3000',
             cookieDomain: 'localhost',
@@ -156,7 +156,7 @@ describe('Session', () => {
       });
 
       it('calls analytics.identify with the resolved visitor id', async () => {
-        const testSession = new Session();
+        const testSession = createSession();
         const visitor = await testSession.initialize({});
         const identifySpy = vi.spyOn(visitor.analytics, 'identify');
 
@@ -191,7 +191,7 @@ describe('Session', () => {
       });
 
       it('calls analytics.alias with the resolved visitor id', async () => {
-        const testSession = new Session();
+        const testSession = createSession();
         const visitor = await testSession.initialize({});
         const aliasSpy = vi.spyOn(visitor.analytics, 'alias');
 
@@ -232,65 +232,50 @@ describe('Session', () => {
       });
     });
 
-    describe('#getPublicAPI()', () => {
-      let publicApi: ReturnType<Session['getPublicAPI']>;
-
-      beforeEach(() => {
-        session = new Session();
-        session.initialize({});
-        publicApi = session.getPublicAPI();
-      });
-
-      it('returns an object with a limited set of methods', () => {
-        expect(publicApi).toEqual(
-          expect.objectContaining({
-            vary: expect.any(Function),
-            ab: expect.any(Function),
-            logIn: expect.any(Function),
-            signUp: expect.any(Function),
-            initialize: expect.any(Function)
-          })
-        );
-
-        expect(publicApi._crx).toEqual(
-          expect.objectContaining({
-            loadInfo: expect.any(Function),
-            persistAssignment: expect.any(Function)
-          })
-        );
+    it('returns an object with a limited set of methods', () => {
+      expect(session).toEqual({
+        vary: expect.any(Function),
+        ab: expect.any(Function),
+        logIn: expect.any(Function),
+        signUp: expect.any(Function),
+        initialize: expect.any(Function),
+        _crx: {
+          loadInfo: expect.any(Function),
+          persistAssignment: expect.any(Function)
+        }
       });
+    });
 
-      describe('_crx', () => {
-        describe('#persistAssignment()', () => {
-          it('calls persistAssignmentOverride with the correct parameters', async () => {
-            mockPersistAssignmentOverride.mockResolvedValue();
-
-            await publicApi._crx.persistAssignment('split', 'variant', 'the_username', 'the_password');
-            expect(mockPersistAssignmentOverride).toHaveBeenCalledTimes(1);
-            expect(mockPersistAssignmentOverride).toHaveBeenCalledWith({
-              visitor: expect.any(Visitor),
-              username: 'the_username',
-              password: 'the_password',
-              assignment: new Assignment({
-                splitName: 'split',
-                variant: 'variant',
-                context: 'chrome_extension',
-                isUnsynced: true
-              })
-            });
+    describe('_crx', () => {
+      describe('#persistAssignment()', () => {
+        it('calls persistAssignmentOverride with the correct parameters', async () => {
+          mockPersistAssignmentOverride.mockResolvedValue();
+
+          await session._crx.persistAssignment('split', 'variant', 'the_username', 'the_password');
+          expect(mockPersistAssignmentOverride).toHaveBeenCalledTimes(1);
+          expect(mockPersistAssignmentOverride).toHaveBeenCalledWith({
+            visitor: expect.any(Visitor),
+            username: 'the_username',
+            password: 'the_password',
+            assignment: new Assignment({
+              splitName: 'split',
+              variant: 'variant',
+              context: 'chrome_extension',
+              isUnsynced: true
+            })
           });
         });
+      });
 
-        describe('#loadInfo()', () => {
-          it('returns a promise that resolves with the split registry, assignment registry and visitor id', async () => {
-            const info = await publicApi._crx.loadInfo();
-            expect(info.visitorId).toEqual('existing_visitor_id');
-            expect(info.splitRegistry).toEqual({
-              jabba: { cgi: 50, puppet: 50 },
-              wine: { red: 50, white: 25, rose: 25 }
-            });
-            expect(info.assignmentRegistry).toEqual({ jabba: 'puppet', wine: 'rose' });
+      describe('#loadInfo()', () => {
+        it('returns a promise that resolves with the split registry, assignment registry and visitor id', async () => {
+          const info = await session._crx.loadInfo();
+          expect(info.visitorId).toEqual('existing_visitor_id');
+          expect(info.splitRegistry).toEqual({
+            jabba: { cgi: 50, puppet: 50 },
+            wine: { red: 50, white: 25, rose: 25 }
           });
+          expect(info.assignmentRegistry).toEqual({ jabba: 'puppet', wine: 'rose' });
         });
       });
     });