Rework Analytics initialization (#357)

Author: sc-nikolaoslazaridis

CHANGELOG.md

@@ -26,10 +26,13 @@ Our versioning strategy is as follows:
   * `[react]` Added React hooks for search functionality
     - `useSearch` hook for paginated search queries with automatic state management, request cancellation, request status tracking.
     - `useInfiniteSearch` hook for infinite scroll/search patterns with `loadMore` functionality, request cancellation, request status tracking.
-  * `[analytics]` `[core]` `[create-content-sdk-app]` `[nextjs]` `[react]` Reorganize Analytics packages ([#340](https://github.com/Sitecore/content-sdk/pull/340))([#341](https://github.com/Sitecore/content-sdk/pull/341))
 
 * `[nextjs]` `[Pages Router]` Adjust static path generation when multisite is disabled ([#345](https://github.com/Sitecore/content-sdk/pull/345))
 
+* Introduce Analytics packages:
+  * `[analytics]` `[core]` `[create-content-sdk-app]` `[nextjs]` `[react]` Reorganize Analytics packages ([#340](https://github.com/Sitecore/content-sdk/pull/340))([#341](https://github.com/Sitecore/content-sdk/pull/341))
+  * `[sdk]` Rework Analytics initialization ([#357](https://github.com/Sitecore/content-sdk/pull/357))
+
 ### 🛠 Breaking Changes
 
 * Decouple `@sitecore-content-sdk/content` from `@sitecore-content-sdk/core` ([#351](https://github.com/Sitecore/content-sdk/pull/351)):

packages/analytics-core/browser.d.ts

@@ -7,6 +7,7 @@
     "url": "https://github.com/sitecore/content-sdk/issues"
   },
   "dependencies": {
+    "@sitecore-content-sdk/core": "1.5.0-canary.6",
     "debug": "^4.4.3"
   },
   "description": "> TODO: description",
@@ -29,26 +30,24 @@
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.2"
   },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "types/src/index.d.ts",
   "exports": {
-    "./browser": {
-      "import": "./dist/esm/src/browser.js",
-      "require": "./dist/cjs/src/browser.js",
-      "types": "./types/src/browser/index.d.ts"
+    ".": {
+      "import": "./dist/esm/src/index.js",
+      "require": "./dist/cjs/src/index.js",
+      "types": "./types/src/index.d.ts"
     },
     "./internal": {
       "import": "./dist/esm/src/internal.js",
       "require": "./dist/cjs/src/internal.js",
-      "types": "./types/src/internal/index.d.ts"
-    },
-    "./server": {
-      "import": "./dist/esm/src/server.js",
-      "require": "./dist/cjs/src/server.js",
-      "types": "./types/src/server/index.d.ts"
+      "types": "./types/src/internal.d.ts"
     },
     "./utils": {
       "import": "./dist/esm/src/utils.js",
       "require": "./dist/cjs/src/utils.js",
-      "types": "./types/src/utils/index.d.ts"
+      "types": "./types/src/utils.d.ts"
     }
   },
   "files": [

packages/analytics-core/package.json

@@ -1,5 +1,6 @@
 import { SITECORE_EDGE_URL } from '../consts';
 import { constructGetBrowserIdUrl } from './construct-get-browser-id-url';
+import { expect } from '@jest/globals';
 
 describe('constructGetBrowserIdUrl', () => {
   it('should correctly create the URL for retrieving the browser Id from EDGE events proxy', () => {

packages/analytics-core/server.d.ts

@@ -1,8 +1,9 @@
 import * as utils from '../utils';
-import { ErrorMessages, LIBRARY_VERSION, SITECORE_EDGE_URL } from '../consts';
+import { ERROR_MESSAGES, LIBRARY_VERSION, SITECORE_EDGE_URL } from '../consts';
 import type { EPResponse } from '../interfaces';
 import * as constructGetBrowserIdUrl from './construct-get-browser-id-url';
 import { fetchBrowserIdFromEdgeProxy } from './fetch-browser-id-from-edge-proxy';
+import { jest, expect } from '@jest/globals';
 
 describe('fetchBrowserIdFromEdgeProxy', () => {
   const constructBrowserIdUrlSpy = jest.spyOn(constructGetBrowserIdUrl, 'constructGetBrowserIdUrl');
@@ -87,7 +88,7 @@ describe('fetchBrowserIdFromEdgeProxy', () => {
 
     global.fetch = jest.fn(() => Promise.reject(abortError));
 
-    const expectedError = ErrorMessages.IE_0003;
+    const expectedError = ERROR_MESSAGES.IE_0003;
 
     expect(async () => {
       await fetchBrowserIdFromEdgeProxy(SITECORE_EDGE_URL, sitecoreEdgeContextId);
@@ -97,7 +98,7 @@ describe('fetchBrowserIdFromEdgeProxy', () => {
   it('should throw IE-0003 error if fetch returns null - fetchWithTimeout', async () => {
     const fetchWithTimeoutSpy = jest.spyOn(utils, 'fetchWithTimeout').mockResolvedValue(null);
 
-    const expectedError = ErrorMessages.IE_0003;
+    const expectedError = ERROR_MESSAGES.IE_0003;
 
     expect(async () => {
       await fetchBrowserIdFromEdgeProxy(SITECORE_EDGE_URL, sitecoreEdgeContextId, 100);
@@ -110,7 +111,7 @@ describe('fetchBrowserIdFromEdgeProxy', () => {
       .spyOn(utils, 'fetchWithTimeout')
       .mockRejectedValueOnce({ message: 'random error' });
 
-    const expectedError = ErrorMessages.IE_0003;
+    const expectedError = ERROR_MESSAGES.IE_0003;
 
     expect(async () => {
       await fetchBrowserIdFromEdgeProxy(SITECORE_EDGE_URL, sitecoreEdgeContextId, 100);
@@ -120,23 +121,23 @@ describe('fetchBrowserIdFromEdgeProxy', () => {
 
   it('should throw [IV-0006] when we pass negative timeout value', async () => {
     const fetchWithTimeoutSpy = jest.spyOn(utils, 'fetchWithTimeout').mockRejectedValueOnce({
-      message: utils.ErrorMessages.IV_0006,
+      message: utils.ERROR_MESSAGES.IV_0006,
     });
 
     expect(async () => {
       await fetchBrowserIdFromEdgeProxy(SITECORE_EDGE_URL, sitecoreEdgeContextId, -100);
-    }).rejects.toThrow(utils.ErrorMessages.IV_0006);
+    }).rejects.toThrow(utils.ERROR_MESSAGES.IV_0006);
     expect(fetchWithTimeoutSpy).toHaveBeenCalledTimes(1);
   });
 
   it('should throw [IE-0002] when we get an AbortError', async () => {
     const fetchWithTimeoutSpy = jest.spyOn(utils, 'fetchWithTimeout').mockRejectedValueOnce({
-      message: utils.ErrorMessages.IE_0002,
+      message: utils.ERROR_MESSAGES.IE_0002,
     });
 
     await expect(async () => {
       await fetchBrowserIdFromEdgeProxy(SITECORE_EDGE_URL, sitecoreEdgeContextId, 100);
-    }).rejects.toThrow(utils.ErrorMessages.IE_0002);
+    }).rejects.toThrow(utils.ERROR_MESSAGES.IE_0002);
     expect(fetchWithTimeoutSpy).toHaveBeenCalledTimes(1);
   });
 });

packages/analytics-core/src/browser-id/construct-get-browser-id-url.spec.ts

@@ -1,6 +1,6 @@
 import type { EPResponse, ProxySettings } from '../interfaces';
-import { ErrorMessages, LIBRARY_VERSION } from '../consts';
-import { ErrorMessages as UtilsErrorMessages, fetchWithTimeout } from '../utils';
+import { ERROR_MESSAGES, LIBRARY_VERSION } from '../consts';
+import { ERROR_MESSAGES as UTILS_ERROR_MESSAGES, fetchWithTimeout } from '../utils';
 import { constructGetBrowserIdUrl } from './construct-get-browser-id-url';
 
 /**
@@ -33,8 +33,8 @@ export async function fetchBrowserIdFromEdgeProxy(
       })
       .catch((err) => {
         if (
-          err.message === UtilsErrorMessages.IV_0006 ||
-          err.message === UtilsErrorMessages.IE_0002
+          err.message === UTILS_ERROR_MESSAGES.IV_0006 ||
+          err.message === UTILS_ERROR_MESSAGES.IE_0002
         )
           throw new Error(err.message);
 
@@ -45,7 +45,7 @@ export async function fetchBrowserIdFromEdgeProxy(
       .then((res) => res.json())
       .catch(() => undefined);
 
-  if (!payload?.ref) throw new Error(ErrorMessages.IE_0003);
+  if (!payload?.ref) throw new Error(ERROR_MESSAGES.IE_0003);
 
   const { ref: browserId, customer_ref: guestId }: EPResponse = payload;
   return { browserId, guestId };

packages/analytics-core/src/browser-id/fetch-browser-id-from-edge-proxy.spec.ts

@@ -1,54 +1,49 @@
-import * as coreBrowserModule from '../initializer/browser/initializer';
+import * as pluginsModule from '../initialization/plugin';
 import { getBrowserId } from './get-browser-id';
+import { jest, expect } from '@jest/globals';
 
-jest.mock('../initializer/browser/initializer');
+jest.mock('../initialization/plugin');
 
 describe('getBrowserId', () => {
-  const getCloudSDKSettingsSpy = jest
-    .spyOn(coreBrowserModule, 'getCloudSDKSettings')
-    .mockReturnValue({
-      cookieSettings: {
-        domain: 'cDomain',
-        expiryDays: 730,
-        name: { browserId: 'bid_name' },
-        path: '/',
-      },
-      siteName: '456',
-      sitecoreEdgeContextId: '123',
-      sitecoreEdgeUrl: '',
-    });
+  const mockEnvironment = {
+    getBrowserId: jest.fn(),
+  };
+
+  const getAnalyticsPluginSpy = jest.spyOn(pluginsModule, 'getAnalyticsPlugin').mockReturnValue({
+    environment: mockEnvironment,
+  } as unknown as ReturnType<typeof pluginsModule.getAnalyticsPlugin>);
 
   afterEach(() => {
     jest.clearAllMocks();
   });
 
-  it('should return the cookie value when cookie exists on the page', async () => {
-    jest.spyOn(document, 'cookie', 'get').mockReturnValueOnce(`bid_name=bid_value`);
-
-    const mockCoreBrowserModule = coreBrowserModule as { initCoreState: Promise<void> };
-    mockCoreBrowserModule.initCoreState = Promise.resolve();
+  it('should return the browser ID when environment returns a value', () => {
+    mockEnvironment.getBrowserId.mockReturnValueOnce('bid_value');
 
     const browserId = getBrowserId();
+
     expect(browserId).toEqual('bid_value');
-    expect(getCloudSDKSettingsSpy).toHaveBeenCalledTimes(1);
+    expect(getAnalyticsPluginSpy).toHaveBeenCalledTimes(1);
+    expect(mockEnvironment.getBrowserId).toHaveBeenCalledTimes(1);
   });
 
-  it('should return empty string if there is a cookie but not the correct one', async () => {
-    jest.spyOn(document, 'cookie', 'get').mockReturnValueOnce('WrongCookieName=cookieValue');
-
-    const mockCoreBrowserModule = coreBrowserModule as { initCoreState: Promise<void> };
-    mockCoreBrowserModule.initCoreState = Promise.resolve();
+  it('should return empty string when environment returns null', () => {
+    mockEnvironment.getBrowserId.mockReturnValueOnce(null);
 
     const browserId = getBrowserId();
+
     expect(browserId).toEqual('');
-    expect(getCloudSDKSettingsSpy).toHaveBeenCalledTimes(1);
+    expect(getAnalyticsPluginSpy).toHaveBeenCalledTimes(1);
+    expect(mockEnvironment.getBrowserId).toHaveBeenCalledTimes(1);
   });
-  it('should return empty string if no cookie exists on the page', async () => {
-    const mockCoreBrowserModule = coreBrowserModule as { initCoreState: Promise<void> };
-    mockCoreBrowserModule.initCoreState = Promise.resolve();
+
+  it('should return empty string when environment returns undefined', () => {
+    mockEnvironment.getBrowserId.mockReturnValueOnce(undefined);
 
     const browserId = getBrowserId();
+
     expect(browserId).toBe('');
-    expect(getCloudSDKSettingsSpy).toHaveBeenCalledTimes(1);
+    expect(getAnalyticsPluginSpy).toHaveBeenCalledTimes(1);
+    expect(mockEnvironment.getBrowserId).toHaveBeenCalledTimes(1);
   });
 });

packages/analytics-core/src/browser-id/fetch-browser-id-from-edge-proxy.ts

@@ -1,12 +1,9 @@
-import { getCookieValueClientSide } from '../utils';
-import { getCloudSDKSettings } from '../initializer/browser/initializer';
+import { getAnalyticsPlugin } from '../internal';
 
 /**
  * Gets the browser ID from the cookie.
  * @returns {string} The browser ID if the cookie exists.
  */
 export function getBrowserId(): string {
-  const cloudSDKSettings = getCloudSDKSettings();
-
-  return getCookieValueClientSide(cloudSDKSettings.cookieSettings.name.browserId);
+  return getAnalyticsPlugin().environment.getBrowserId() || '';
 }