feat(sdk-analytics) comments done

dotCMS · Dec 17, 2024 · 9d616de · 9d616de
1 parent 516501d
commit 9d616de
Show file tree

Hide file tree

Showing 21 changed files with 464 additions and 134 deletions.
diff --git a/core-web/libs/sdk/analytics/README.md b/core-web/libs/sdk/analytics/README.md
@@ -29,7 +29,7 @@ Or include the script in your HTML page:
 First, import the provider:
 
 ```tsx
-import { DotContentAnalyticsProvider } from '@dotcms/analytics';
+import { DotContentAnalyticsProvider } from '@dotcms/analytics/react';
 ```
 
 Wrap your application with the `DotContentAnalyticsProvider`:
@@ -56,21 +56,15 @@ function App() {
 Use the `useAnalyticsTracker` hook to track custom events:
 
 ```tsx
+import { useAnalyticsTracker } from '@dotcms/analytics/react';
+
 function Activity({ title, urlTitle }) {
     const { track } = useAnalyticsTracker();
 
-    const handleClick = () => {
-        // First parameter: custom event name to identify the action
-        // Second parameter: object with properties you want to track
-        track('product-detail-click', {
-            productTitle: title,
-            productUrl: urlTitle,
-            clickedElement: 'detail-button',
-            timestamp: new Date().toISOString()
-        });
-    };
-
-    return <button onClick={handleClick}>See Details →</button>;
+    // First parameter: custom event name to identify the action
+    // Second parameter: object with properties you want to track
+
+    return <button onClick={() => track('btn-click', { title, urlTitle })}>See Details →</button>;
 }
 ```
 

diff --git a/core-web/libs/sdk/analytics/jest.config.ts b/core-web/libs/sdk/analytics/jest.config.ts
@@ -14,15 +14,16 @@ if (swcJestConfig.swcrc === undefined) {
 // Uncomment if using global setup/teardown files being transformed via swc
 // https://nx.dev/nx-api/jest/documents/overview#global-setupteardown-with-nx-libraries
 // jest needs EsModule Interop to find the default exported setup/teardown functions
-// swcJestConfig.module.noInterop = false;
+swcJestConfig.module.noInterop = false;
 
 export default {
     displayName: 'analytics',
     preset: '../../../jest.preset.js',
     transform: {
-        '^.+\\.[tj]s$': ['@swc/jest', swcJestConfig]
+        '^.+\\.[tj]sx?$': ['@swc/jest', swcJestConfig]
     },
-    moduleFileExtensions: ['ts', 'js', 'html'],
+    moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
     testEnvironment: 'jsdom',
-    coverageDirectory: '../../../coverage/libs/sdk/analytics'
+    coverageDirectory: '../../../coverage/libs/sdk/analytics',
+    setupFilesAfterEnv: ['<rootDir>/test-setup.ts']
 };
diff --git a/core-web/libs/sdk/analytics/package.json b/core-web/libs/sdk/analytics/package.json
@@ -22,7 +22,8 @@
     "homepage": "https://github.com/dotCMS/core/tree/main/core-web/libs/sdk/analytics/README.md",
     "dependencies": {
         "analytics": "^0.8.14",
-    "vite": "~5.0.0"
+        "vite": "~5.0.0",
+    "@testing-library/jest-dom": "^6.1.6"
     },
     "peerDependencies": {
         "react": "^18.2.0"
@@ -31,8 +32,8 @@
     "module": "./index.esm.js",
     "exports": {
         "./react": {
-            "import": "./lib/react/index.js",
-            "types": "./lib/react/index.d.ts"
+            "import": "./react/index.js",
+            "types": "./src/lib/react/index.d.ts"
         }
     }
 }
diff --git a/core-web/libs/sdk/analytics/project.json b/core-web/libs/sdk/analytics/project.json
@@ -41,11 +41,6 @@
                 "project": "libs/sdk/analytics/package.json"
             }
         },
-        "nx-release-publish": {
-            "options": {
-                "packageRoot": "dist/{projectRoot}"
-            }
-        },
         "test": {
             "executor": "@nx/jest:jest",
             "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],

diff --git a/core-web/libs/sdk/analytics/src/lib/dotAnalytics/dot-content-analytics.spec.ts b/core-web/libs/sdk/analytics/src/lib/dotAnalytics/dot-content-analytics.spec.ts
@@ -3,17 +3,18 @@
 import Analytics from 'analytics';
 
 import { DotContentAnalytics } from './dot-content-analytics';
-import { dotAnalyticsPlugin } from './plugin/dot-analytics.plugin';
+import { dotAnalytics } from './plugin/dot-analytics.plugin';
+import { DotContentAnalyticsConfig } from './shared/dot-content-analytics.model';
 
 // Mock the analytics library
 jest.mock('analytics');
 jest.mock('./plugin/dot-analytics.plugin');
 
 describe('DotAnalytics', () => {
-    const mockConfig = {
+    const mockConfig: DotContentAnalyticsConfig = {
         debug: false,
         server: 'http://test.com',
-        key: 'test-key',
+        apiKey: 'test-key',
         autoPageView: false
     };
 
@@ -43,17 +44,34 @@ describe('DotAnalytics', () => {
         it('should initialize analytics with correct config', async () => {
             const instance = DotContentAnalytics.getInstance(mockConfig);
             const mockAnalytics = {};
+
             (Analytics as jest.Mock).mockReturnValue(mockAnalytics);
-            (dotAnalyticsPlugin as jest.Mock).mockReturnValue({ name: 'mock-plugin' });
+            (dotAnalytics as jest.Mock).mockReturnValue({ name: 'mock-plugin' });
+
+            // Mock del enricher plugin
+            jest.mock('./plugin/dot-analytics.enricher.plugin', () => ({
+                dotAnalyticsEnricherPlugin: {
+                    name: 'enrich-dot-analytics',
+                    'page:dot-analytics': jest.fn(),
+                    'track:dot-analytics': jest.fn()
+                }
+            }));
 
             await instance.ready();
 
             expect(Analytics).toHaveBeenCalledWith({
                 app: 'dotAnalytics',
                 debug: false,
-                plugins: [{ name: 'mock-plugin' }]
+                plugins: [
+                    {
+                        name: 'enrich-dot-analytics',
+                        'page:dot-analytics': expect.any(Function),
+                        'track:dot-analytics': expect.any(Function)
+                    },
+                    { name: 'mock-plugin' }
+                ]
             });
-            expect(dotAnalyticsPlugin).toHaveBeenCalledWith(mockConfig);
+            expect(dotAnalytics).toHaveBeenCalledWith(mockConfig);
         });
 
         it('should only initialize once', async () => {
@@ -72,20 +90,20 @@ describe('DotAnalytics', () => {
                 throw error;
             });
 
-            // eslint-disable-next-line @typescript-eslint/no-empty-function
-            const consoleErrorMock = jest.spyOn(console, 'error').mockImplementation(() => {});
+            const consoleErrorMock = jest.spyOn(console, 'error').mockImplementation(() => {
+                // Do nothing
+            });
 
             try {
                 await instance.ready();
+                fail('Should have thrown an error');
             } catch (e) {
                 expect(e).toEqual(error);
                 expect(console.error).toHaveBeenCalledWith(
-                    'Failed to initialize DotAnalytics:',
-                    error
+                    '[dotCMS DotContentAnalytics] Failed to initialize: Error: Init failed'
                 );
             }
 
-            // Restore console.error
             consoleErrorMock.mockRestore();
         });
     });

diff --git a/core-web/libs/sdk/analytics/src/lib/dotAnalytics/shared/dot-content-analytics.http.ts b/core-web/libs/sdk/analytics/src/lib/dotAnalytics/shared/dot-content-analytics.http.ts
@@ -10,7 +10,7 @@ import { DotContentAnalyticsConfig, ServerEvent } from './dot-content-analytics.
 export const sendAnalyticsEventToServer = async (
     data: Record<string, unknown>,
     options: DotContentAnalyticsConfig
-): Promise<Response> => {
+): Promise<void> => {
     const serverEvent: ServerEvent = {
         ...data,
         timestamp: new Date().toISOString(),
@@ -28,13 +28,10 @@ export const sendAnalyticsEventToServer = async (
             body: JSON.stringify(serverEvent)
         });
 
-        if (response.ok) {
-            return response;
-        } else {
-            throw new Error(`${response.status}`);
+        if (!response.ok) {
+            console.error(`DotAnalytics: Server responded with status ${response.status}`);
         }
     } catch (error) {
         console.error('DotAnalytics: Error sending event:', error);
-        throw error;
     }
 };
diff --git a/core-web/libs/sdk/analytics/src/lib/dotAnalytics/shared/dot-content-analytics.model.ts b/core-web/libs/sdk/analytics/src/lib/dotAnalytics/shared/dot-content-analytics.model.ts
@@ -23,7 +23,7 @@ export interface DotContentAnalyticsConfig {
     /**
      * Automatically track page views when set to true.
      */
-    autoPageView: boolean;
+    autoPageView?: boolean;
 
     /**
      * The API key for authenticating with the Analytics service.