@dotcms/experiments 0.0.1-alpha.39 → 0.0.1-alpha.41

package/src/lib/shared/utils/utils.spec.ts

@@ -1,142 +0,0 @@
-import {
-    checkFlagExperimentAlreadyChecked,
-    getDataExperimentAttributes,
-    getExperimentScriptTag,
-    getFullUrl,
-    getScriptDataAttributes
-} from './utils';
-
-import { EXPERIMENT_ALREADY_CHECKED_KEY, EXPERIMENT_SCRIPT_FILE_NAME } from '../constants';
-import { LocationMock } from '../mocks/mock';
-
-describe('Utility ', () => {
-    describe('getExperimentScriptTag', () => {
-        it('should throw an error if the experiment script is not found', () => {
-            document.body.innerHTML = `<script src="other-script.js"></script>`;
-            expect(() => getExperimentScriptTag()).toThrow('Experiment script not found');
-        });
-
-        it('should return the script element when the experiment script is found', () => {
-            const experimentScriptUrl = 'http://example.com/' + EXPERIMENT_SCRIPT_FILE_NAME;
-
-            document.body.innerHTML = `<script src="${experimentScriptUrl}"></script>`;
-
-            const scriptTag = getExperimentScriptTag();
-
-            expect(scriptTag).toBeDefined();
-            expect(scriptTag.src).toBe(experimentScriptUrl);
-        });
-    });
-
-    describe('getDataExperimentAttributes', () => {
-        const location: Location = { ...LocationMock, href: 'http:/localhost/' };
-
-        it('should return null and warn if data-experiment-api-key is not specified but script is present', () => {
-            const experimentScriptUrl = 'http://example.com/' + EXPERIMENT_SCRIPT_FILE_NAME;
-
-            document.body.innerHTML = `<script src="${experimentScriptUrl}"></script>`;
-
-            try {
-                getDataExperimentAttributes(location);
-                expect('This should not be reached if an error is thrown').toBeNull();
-            } catch (error) {
-                expect(() => getDataExperimentAttributes(location)).toThrow(
-                    'You need specify the `data-experiment-api-key`'
-                );
-            }
-        });
-
-        it('should return the experiment attributes if they are present', () => {
-            const experimentScriptUrl = 'http://example.com/' + EXPERIMENT_SCRIPT_FILE_NAME;
-
-            document.body.innerHTML = `<script src="${experimentScriptUrl}" data-experiment-api-key="testKey" data-experiment-server="http://localhost"></script>`;
-
-            const attributes = getDataExperimentAttributes(location);
-
-            expect(attributes).toEqual({
-                apiKey: 'testKey',
-                server: 'http://localhost',
-                debug: false
-            });
-        });
-    });
-
-    describe('getScriptDataAttributes', () => {
-        it('should return the experiment attributes if they are present', () => {
-            const experimentScriptUrl = 'http://example.com/' + EXPERIMENT_SCRIPT_FILE_NAME;
-
-            document.body.innerHTML = `<script src="${experimentScriptUrl}" data-experiment-api-key="testKey" data-experiment-server="http://localhost"></script>`;
-
-            // eslint-disable-next-line no-restricted-globals
-            const attributes = getScriptDataAttributes(location);
-
-            expect(attributes).toEqual({
-                apiKey: 'testKey',
-                server: 'http://localhost',
-                debug: false
-            });
-        });
-    });
-
-    describe('SessionStorage EXPERIMENT_ALREADY_CHECKED_KEY handle', () => {
-        Object.defineProperty(window, 'sessionStorage', {
-            value: {
-                setItem: jest.fn(),
-                getItem: jest.fn()
-            },
-            writable: true
-        });
-
-        describe('checkFlagExperimentAlreadyChecked', () => {
-            const getItemMock = window.sessionStorage.getItem as jest.MockedFunction<
-                typeof window.sessionStorage.getItem
-            >;
-
-            const testCases = [
-                { value: '', expected: false, description: 'sessionStorage value is ""' },
-                { value: 'true', expected: true, description: 'sessionStorage value is "true"' },
-                { value: null, expected: false, description: 'sessionStorage value is null' }
-            ];
-
-            testCases.forEach(({ description, value, expected }) => {
-                it(`returns ${expected} when ${description}`, () => {
-                    getItemMock.mockReturnValue(value);
-
-                    expect(checkFlagExperimentAlreadyChecked()).toBe(expected);
-                    expect(getItemMock).toHaveBeenCalledWith(EXPERIMENT_ALREADY_CHECKED_KEY);
-                });
-            });
-        });
-    });
-
-    describe('getFullUrl', () => {
-        const href = 'http://localhost/';
-
-        const location: Location = { ...LocationMock, href };
-
-        it('should return null if absolutePath is null', () => {
-            const result = getFullUrl(location, null);
-
-            expect(result).toBeNull();
-        });
-
-        it('should return the same absolutePath if it is a full URL', () => {
-            const absolutePath = href + '/test';
-
-            const expectedUrl = absolutePath;
-
-            const result = getFullUrl(location, absolutePath);
-
-            expect(result).toBe(absolutePath);
-            expect(result).toBe(expectedUrl);
-        });
-
-        it('should return a full URL if absolutePath is a relative path', () => {
-            const absolutePath = '/test';
-
-            const result = getFullUrl(location, absolutePath);
-
-            expect(result).toBe(`${location.origin}${absolutePath}`);
-        });
-    });
-});

package/src/lib/shared/utils/utils.ts

@@ -1,203 +0,0 @@
-import {
-    EXPERIMENT_ALLOWED_DATA_ATTRIBUTES,
-    EXPERIMENT_ALREADY_CHECKED_KEY,
-    EXPERIMENT_FETCH_EXPIRE_TIME_KEY,
-    EXPERIMENT_QUERY_PARAM_KEY,
-    EXPERIMENT_SCRIPT_FILE_NAME
-} from '../constants';
-import { DotExperimentConfig, Experiment, Variant } from '../models';
-
-/**
- * Returns the first script element that includes the experiment script identifier.
- *
- * @return {HTMLScriptElement|undefined} - The found script element or undefined if none is found.
- */
-export const getExperimentScriptTag = (): HTMLScriptElement => {
-    const experimentScript = Array.from(document.getElementsByTagName('script')).find((script) =>
-        script.src.includes(EXPERIMENT_SCRIPT_FILE_NAME)
-    );
-
-    if (!experimentScript) {
-        throw new Error('Experiment script not found');
-    }
-
-    return experimentScript;
-};
-
-/**
- * Retrieves experiment attributes from a given script element.
- *
- *
- * @return {DotExperimentConfig | null} - The experiment attributes or null if there are no valid attributes present.
- */
-export const getDataExperimentAttributes = (location: Location): DotExperimentConfig | null => {
-    const script = getExperimentScriptTag();
-
-    const defaultExperimentAttributes: DotExperimentConfig = {
-        apiKey: '',
-        server: location.href,
-        debug: false
-    };
-
-    let experimentAttribute: Partial<DotExperimentConfig> = {};
-
-    if (!script.hasAttribute('data-experiment-api-key')) {
-        throw new Error('You need specify the `data-experiment-api-key`');
-    }
-
-    Array.from(script.attributes).forEach((attr) => {
-        if (EXPERIMENT_ALLOWED_DATA_ATTRIBUTES.includes(attr.name)) {
-            // Server of dotCMS
-            if (attr.name === 'data-experiment-server') {
-                experimentAttribute = { ...experimentAttribute, server: attr.value };
-            }
-
-            // Api Key for Analytics App
-            if (attr.name === 'data-experiment-api-key') {
-                experimentAttribute = { ...experimentAttribute, apiKey: attr.value };
-            }
-
-            // Show debug
-            if (attr.name === 'data-experiment-debug') {
-                experimentAttribute = {
-                    ...experimentAttribute,
-                    debug: true
-                };
-            }
-        }
-    });
-
-    return { ...defaultExperimentAttributes, ...experimentAttribute };
-};
-
-/**
- * Retrieves the data attributes from the experiment script tag.
- *
- * @example
- * Given the custom script tag in your HTML:
- * <script src="/dot-experiments.iife.js"
- *        defer=""
- *        data-experiment-api-key="api-token"
- *        data-experiment-server="http://localhost:8080/"
- *        data-experiment-debug>
- * </script>
- *
- * @returns {DotExperimentConfig | null} The data attributes of the experiment script tag, or null if no experiment script is found.
- */
-export const getScriptDataAttributes = (location: Location): DotExperimentConfig | null => {
-    const dataExperimentAttributes = getDataExperimentAttributes(location);
-
-    if (dataExperimentAttributes) {
-        return dataExperimentAttributes;
-    }
-
-    return null;
-};
-
-/**
- * Checks the flag indicating whether the experiment has already been checked.
- *
- * @function checkFlagExperimentAlreadyChecked
- * @returns {boolean} - returns true if experiment has already been checked, otherwise false.
- */
-export const checkFlagExperimentAlreadyChecked = (): boolean => {
-    const flag = sessionStorage.getItem(EXPERIMENT_ALREADY_CHECKED_KEY);
-
-    return flag === 'true';
-};
-
-/**
- * Checks if the data needs to be invalidated based on the creation date.
- *
- * @returns {boolean} - True if the data needs to be invalidated, false otherwise.
- */
-export const isDataCreateValid = (): boolean => {
-    try {
-        const timeValidUntil = Number(localStorage.getItem(EXPERIMENT_FETCH_EXPIRE_TIME_KEY));
-
-        if (isNaN(timeValidUntil)) {
-            return false;
-        }
-
-        const now = Date.now();
-
-        return timeValidUntil > now;
-    } catch (error) {
-        return false;
-    }
-};
-
-/**
- * Ad to an absolute path the baseUrl depending on the location.
- *
- * @param {string | null} absolutePath - The absolute path of the URL.
- * @param {Location} location - The location object representing the current URL.
- * @returns {string | null} - The full URL or null if absolutePath is null.
- */
-export const getFullUrl = (location: Location, absolutePath: string | null): string | null => {
-    if (absolutePath === null) {
-        return null;
-    }
-
-    if (!isFullUrl(absolutePath)) {
-        const baseUrl = location.origin;
-
-        return `${baseUrl}${absolutePath}`;
-    }
-
-    return absolutePath;
-};
-
-const isFullUrl = (url: string): boolean => {
-    const pattern = /^https?:\/\//i;
-
-    return pattern.test(url);
-};
-
-/**
- * Updates the URL with the queryParam with the experiment variant name.
- *
- * @param {Location|string} location - The current location object or the URL string.
- * @param {Variant} variant - The experiment variant to update the URL with.
- * @returns {string} The updated URL string.
- */
-export const updateUrlWithExperimentVariant = (
-    location: Location | string,
-    variant: Variant | null
-): string => {
-    const href = typeof location === 'string' ? location : location.href;
-
-    const url = new URL(href);
-
-    if (variant !== null) {
-        const params = url.searchParams;
-
-        params.set(EXPERIMENT_QUERY_PARAM_KEY, variant.name);
-        url.search = params.toString();
-    }
-
-    return url.toString();
-};
-
-/**
- * Check if two arrays of Experiment objects are equal.
- *
- * @param {Experiment[]} obj1 - The first array of Experiment objects.
- * @param {Experiment[]} obj2 - The second array of Experiment objects.
- * @return {boolean} - True if the arrays are equal, false otherwise.
- */
-export const objectsAreEqual = (obj1: Experiment[], obj2: Experiment[]): boolean => {
-    if (obj1.length === 0 && obj2.length === 0) {
-        return false;
-    }
-
-    return JSON.stringify(obj1) === JSON.stringify(obj2);
-};
-
-/**
- * A function to redirect the user to a new URL.
- *
- * @param {string} href - The URL to redirect to.
- * @returns {void}
- */
-export const defaultRedirectFn = (href: string) => (window.location.href = href);

package/src/lib/standalone.spec.ts

@@ -1,36 +0,0 @@
-import { DotExperiments } from './dot-experiments';
-import { EXPERIMENT_WINDOWS_KEY } from './shared/constants';
-import { getScriptDataAttributes } from './shared/utils/utils';
-
-declare global {
-    interface Window {
-        [EXPERIMENT_WINDOWS_KEY]: DotExperiments;
-    }
-}
-
-jest.mock('./shared/utils/utils', () => ({
-    getScriptDataAttributes: jest.fn().mockReturnValue({ server: 'http://localhost' }),
-    Logger: jest.fn()
-}));
-
-describe('IIFE Execution', () => {
-    it('should call getScriptDataAttributes and set window[EXPERIMENT_WINDOWS_KEY]', () => {
-        const fakeInstance = {
-            initialize: jest.fn()
-        } as unknown as DotExperiments;
-
-        const getInstanceMock = jest
-            .spyOn(DotExperiments, 'getInstance')
-            .mockReturnValue(fakeInstance);
-
-        require('./standalone');
-
-        expect(getScriptDataAttributes).toHaveBeenCalled();
-
-        expect(getInstanceMock).toHaveBeenCalledWith({ server: 'http://localhost' });
-        expect(getInstanceMock).toHaveBeenCalled();
-
-        expect(window[EXPERIMENT_WINDOWS_KEY]).toBeDefined();
-        expect(window[EXPERIMENT_WINDOWS_KEY]).toEqual(fakeInstance);
-    });
-});

package/src/lib/standalone.ts

@@ -1,28 +0,0 @@
-import { DotExperiments } from './dot-experiments';
-import { EXPERIMENT_WINDOWS_KEY } from './shared/constants';
-import { getScriptDataAttributes } from './shared/utils/utils';
-
-declare global {
-    interface Window {
-        [EXPERIMENT_WINDOWS_KEY]: DotExperiments;
-    }
-}
-
-/**
- * This file sets up everything necessary to run an Experiment in Standalone Mode(Immediately Invoked Function Expressions).
- * It checks which experiments are currently running, and generates the essential data
- * needed for storing in DotCMS for subsequent A/B Testing validation.
- *
- */
-if (window) {
-    // TODO: make this file buildable by task and publish to dotCMS/src/main/webapp/html
-    try {
-        const dataAttributes = getScriptDataAttributes(window.location);
-
-        if (dataAttributes) {
-            window[EXPERIMENT_WINDOWS_KEY] = DotExperiments.getInstance({ ...dataAttributes });
-        }
-    } catch (error) {
-        throw new Error(`Error instancing DotExperiments: ${error}`);
-    }
-}

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-    "extends": "../../../tsconfig.base.json",
-    "compilerOptions": {
-        "jsx": "react-jsx",
-        "allowJs": false,
-        "esModuleInterop": false,
-        "allowSyntheticDefaultImports": true,
-        "strict": true
-    },
-    "files": [],
-    "include": ["src"],
-    "references": [
-        {
-            "path": "./tsconfig.lib.json"
-        },
-        {
-            "path": "./tsconfig.spec.json"
-        }
-    ]
-}

package/tsconfig.lib.json

@@ -1,20 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "../../../dist/out-tsc",
-        "declaration": true,
-        "types": ["node", "vite/client"]
-    },
-    "exclude": [
-        "jest.config.ts",
-        "src/**/*.spec.ts",
-        "src/**/*.test.ts",
-        "src/**/*.spec.tsx",
-        "src/**/*.test.tsx",
-        "src/**/*.spec.js",
-        "src/**/*.test.js",
-        "src/**/*.spec.jsx",
-        "src/**/*.test.jsx"
-    ],
-    "include": ["src/**/*.js", "src/**/*.jsx", "src/**/*.ts", "src/**/*.tsx"]
-}

package/tsconfig.spec.json

@@ -1,9 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "../../../dist/out-tsc",
-        "module": "commonjs",
-        "types": ["jest", "node"]
-    },
-    "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
-}

package/vite.config.ts

@@ -1,41 +0,0 @@
-import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
-import { defineConfig } from 'vite';
-import dts from 'vite-plugin-dts';
-
-import * as path from 'path';
-
-export default defineConfig({
-    root: __dirname,
-    cacheDir: '../../../node_modules/.vite/libs/sdk/experiments',
-
-    plugins: [
-        nxViteTsPaths(),
-        dts({
-            entryRoot: 'src',
-            tsConfigFilePath: path.join(__dirname, 'tsconfig.lib.json'),
-            skipDiagnostics: true
-        })
-    ],
-
-    // Configuration for building the DotExperiment as IIFE file to use in
-    // plain HTML or other projects.
-    build: {
-        outDir: '../../../dist/libs/sdk/experiments',
-        reportCompressedSize: true,
-        emptyOutDir: true,
-        commonjsOptions: {
-            transformMixedEsModules: true
-        },
-        minify: 'terser',
-        lib: {
-            entry: 'src/lib/standalone.ts',
-            name: 'DotExperiment',
-            fileName: 'dot-experiments.min',
-            formats: ['iife']
-        },
-        rollupOptions: {
-            // External packages that should not be bundled into your library.
-            external: []
-        }
-    }
-});