dataLayer reference

elbwalker · Dec 19, 2024 · 777daa7 · 777daa7
1 parent 8f4e090
commit 777daa7
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 36 deletions.
diff --git a/packages/sources/datalayer/src/__tests__/index.test.ts b/packages/sources/datalayer/src/__tests__/index.test.ts
@@ -13,7 +13,7 @@ describe('source dataLayer', () => {
   });
 
   const gtag: Gtag.Gtag = function () {
-    dataLayer.push(arguments);
+    window.dataLayer!.push(arguments);
   };
 
   test('init new', () => {
@@ -37,15 +37,6 @@ describe('source dataLayer', () => {
     expect(originalPush).not.toBe(dataLayer!.push);
   });
 
-  test('config dataLayer', () => {
-    const dataLayer: DataLayer = [];
-
-    sourceDataLayer({ elb, dataLayer, name: 'foo' });
-    expect(window.foo).toBeUndefined(); // Prefer dataLayer over name
-    dataLayer.push({ event: 'foo' });
-    expect(elb).toHaveBeenCalledTimes(1);
-  });
-
   test('config name', () => {
     expect(window.foo).toBeUndefined();
 
@@ -90,7 +81,7 @@ describe('source dataLayer', () => {
   });
 
   test('arguments', () => {
-    dataLayer = [
+    window.dataLayer = [
       {
         event: 'gtm.js',
         'gtm.start': 1730909886667,
@@ -103,7 +94,7 @@ describe('source dataLayer', () => {
       }),
     ];
 
-    sourceDataLayer({ elb, dataLayer });
+    sourceDataLayer({ elb });
 
     gtag('event', 'another_arg', {
       bar: 'baz',

diff --git a/packages/sources/datalayer/src/__tests__/mapping.test.ts b/packages/sources/datalayer/src/__tests__/mapping.test.ts
@@ -1,7 +1,9 @@
+import type { DataLayer } from '../types';
 import { sourceDataLayer } from '..';
 
 describe('mapping', () => {
   const elb = jest.fn(); //.mockImplementation(console.log);
+  let dataLayer: DataLayer;
 
   function gtag(...args: unknown[]) {
     args;
@@ -28,7 +30,8 @@ describe('mapping', () => {
 
   beforeEach(() => {
     jest.clearAllMocks();
-    window.dataLayer = undefined;
+    window.dataLayer = [];
+    dataLayer = window.dataLayer as DataLayer;
   });
 
   test('init dataLayer', () => {
@@ -70,7 +73,7 @@ describe('mapping', () => {
   });
 
   test('default values', () => {
-    const { dataLayer } = sourceDataLayer({ elb })!;
+    sourceDataLayer({ elb })!;
 
     dataLayer.push({ event: 'foo this' });
     expect(elb).toHaveBeenCalledWith({
@@ -84,7 +87,7 @@ describe('mapping', () => {
   });
 
   test('mapping name', () => {
-    const { dataLayer } = sourceDataLayer({
+    sourceDataLayer({
       elb,
       mapping: {
         foo: { name: 'bar' },
@@ -104,7 +107,7 @@ describe('mapping', () => {
   });
 
   test('mapping ignore', () => {
-    const { dataLayer } = sourceDataLayer({
+    sourceDataLayer({
       elb,
       mapping: {
         foo: {
@@ -118,7 +121,7 @@ describe('mapping', () => {
   });
 
   test('mapping *', () => {
-    const { dataLayer } = sourceDataLayer({
+    sourceDataLayer({
       elb,
       mapping: {
         '*': { ignore: true },
@@ -221,7 +224,7 @@ describe('mapping', () => {
   });
 
   test('mapping add_to_cart', () => {
-    const { dataLayer } = sourceDataLayer({
+    sourceDataLayer({
       elb,
       mapping: {
         add_to_cart: {
@@ -276,7 +279,7 @@ describe('mapping', () => {
   });
 
   test('mapping purchase', () => {
-    const { dataLayer } = sourceDataLayer({
+    sourceDataLayer({
       elb,
       mapping: {
         purchase: {

diff --git a/packages/sources/datalayer/src/helper.ts b/packages/sources/datalayer/src/helper.ts
@@ -1,3 +1,5 @@
+import type { DataLayer } from './types';
+
 export function convertConsentStates(
   obj: Record<string, unknown>,
 ): Record<string, unknown> {
@@ -10,3 +12,10 @@ export function convertConsentStates(
 
   return consent;
 }
+
+export function getDataLayer(name = 'dataLayer'): DataLayer {
+  // Ensure the dataLayer exists
+  if (!window[name]) window[name] = [];
+
+  return window[name] || [];
+}
diff --git a/packages/sources/datalayer/src/index.ts b/packages/sources/datalayer/src/index.ts
@@ -1,31 +1,20 @@
-import type { Config, DataLayer } from './types';
+import type { Config } from './types';
 import { intercept, push } from './push';
+import { getDataLayer } from './helper';
 
 export * as SourceDataLayer from './types';
 
 export function sourceDataLayer(
   partialConfig: Partial<Config> = {},
 ): Config | undefined {
-  const { elb, prefix = 'dataLayer', skipped = [] } = partialConfig;
+  const { elb, name, prefix = 'dataLayer', skipped = [] } = partialConfig;
   if (!elb) return;
 
-  let { dataLayer } = partialConfig;
-
-  // Ensure the dataLayer exists
-  if (!dataLayer) {
-    const { name = 'dataLayer' } = partialConfig;
-    const key = name as keyof Window;
-
-    // Ensure the dataLayer exists
-    if (!window[key]) (window[key] as unknown) = [];
-
-    dataLayer = window[key] as DataLayer;
-  }
+  const dataLayer = getDataLayer(name);
 
   const config: Config = {
     ...partialConfig,
     elb,
-    dataLayer,
     prefix,
     skipped,
   };

diff --git a/packages/sources/datalayer/src/push.ts b/packages/sources/datalayer/src/push.ts
@@ -9,9 +9,10 @@ import {
   tryCatch,
 } from '@elbwalker/utils';
 import { objToEvent, gtagToObj } from './mapping';
+import { getDataLayer } from './helper';
 
 export function intercept(config: Config) {
-  const { dataLayer } = config;
+  const dataLayer = getDataLayer(config.name);
 
   // Store the original push function to preserve existing functionality
   const dataLayerPush = dataLayer.push.bind(dataLayer);

diff --git a/packages/sources/datalayer/src/types/index.ts b/packages/sources/datalayer/src/types/index.ts
@@ -9,7 +9,6 @@ declare global {
 export type DataLayer = Array<unknown>;
 export interface Config {
   elb: WalkerOS.Elb | WalkerOS.AnyFunction;
-  dataLayer: DataLayer;
   mapping?: Mapping;
   name?: string;
   prefix: string;