Merge pull request #329 from elbwalker/324-add-a-getsession-function

324 add a getsession function

Author: alexanderkirtzel

.changeset/five-drinks-talk.md

@@ -0,0 +1,5 @@
+---
+'@elbwalker/walker.js': minor
+---
+
+elbLayer init arguments [#326](https://github.com/elbwalker/walkerOS/issues/326)

.changeset/four-buckets-grow.md

@@ -0,0 +1,7 @@
+---
+'@elbwalker/walker.js': minor
+'@elbwalker/utils': minor
+---
+
+Add a getSession function
+[#324](https://github.com/elbwalker/walkerOS/issues/324)

.changeset/rare-sheep-ring.md

@@ -0,0 +1,5 @@
+---
+'@elbwalker/walker.js': minor
+---
+
+Require consent to run [#327](https://github.com/elbwalker/walkerOS/issues/327)

.changeset/three-lizards-appear.md

@@ -0,0 +1,7 @@
+---
+'@elbwalker/walker.js': minor
+'@elbwalker/types': minor
+'@elbwalker/utils': minor
+---
+
+on start command [#325](https://github.com/elbwalker/walkerOS/issues/325)

.changeset/weak-paws-kiss.md

@@ -0,0 +1,6 @@
+---
+'@elbwalker/walker.js': minor
+---
+
+Config options for run and dataLayer
+[#328](https://github.com/elbwalker/walkerOS/issues/328)

packages/clients/walkerjs/jest.config.js

@@ -1,7 +1,5 @@
-const commonConfig = require('@elbwalker/jest');
+const commonConfig = require('@elbwalker/jest/web.config');
 
-const config = {
-  testEnvironment: 'jsdom',
-};
+const config = {};
 
 module.exports = { ...commonConfig, ...config };

packages/clients/walkerjs/src/__tests__/browser.test.ts

@@ -5,25 +5,17 @@ describe('Browser', () => {
   const w = window;
   const mockFn = jest.fn(); //.mockImplementation(console.log);
 
-  jest.mock('../', () => {
-    return mockFn;
-  });
+  jest.mock('../', () => ({
+    Walkerjs: mockFn,
+    default: mockFn,
+  }));
 
   const html: string = fs
     .readFileSync(__dirname + '/html/index.html')
     .toString();
 
   beforeEach(() => {
-    // reset DOM with event listeners etc.
-    document.body = document.body.cloneNode() as HTMLElement;
     document.body.innerHTML = html;
-
-    jest.resetModules();
-    jest.clearAllMocks();
-  });
-
-  afterEach(() => {
-    document.getElementsByTagName('html')[0].innerHTML = '';
   });
 
   test('initialize walkerjs on window', () => {

packages/clients/walkerjs/src/__tests__/commands.test.ts

@@ -1,21 +1,11 @@
 import { elb, Walkerjs } from '..';
+import { mockDataLayer } from '@elbwalker/jest/web.setup';
 import type { WebClient } from '..';
 
 describe('Commands on', () => {
-  const w = window;
-  const mockDataLayer = jest.fn(); //.mockImplementation(console.log);
-
   let walkerjs: WebClient.Instance;
 
   beforeEach(() => {
-    // reset DOM with event listeners etc.
-    document.body = document.body.cloneNode() as HTMLElement;
-    jest.clearAllMocks();
-    jest.resetModules();
-    w.dataLayer = [];
-    (w.dataLayer as unknown[]).push = mockDataLayer;
-    w.elbLayer = undefined as unknown as WebClient.ElbLayer;
-
     walkerjs = Walkerjs({
       consent: { automatically: true },
       default: true,
@@ -26,7 +16,7 @@ describe('Commands on', () => {
     const mockFn = jest.fn();
 
     // Don't call on default
-    elb('walker on', 'consent', { marketing: [mockFn] });
+    elb('walker on', 'consent', { marketing: mockFn });
     expect(mockFn).not.toHaveBeenCalled();
 
     // Different consent group
@@ -44,15 +34,15 @@ describe('Commands on', () => {
 
   test('consent register', () => {
     const mockFn = jest.fn();
-    elb('walker on', 'consent', { foo: [mockFn] });
-    expect(walkerjs.config.on.consent!.foo[0]).toBe(mockFn);
+    elb('walker on', 'consent', { foo: mockFn });
+    expect(walkerjs.config.on.consent![0].foo).toBe(mockFn);
   });
 
   test('consent by start', () => {
     const mockFn = jest.fn();
     Walkerjs({
       consent: { foo: false },
-      on: { consent: { foo: [mockFn] } },
+      on: { consent: [{ foo: mockFn }] },
       default: true,
     });
     expect(mockFn).toHaveBeenCalledTimes(1);
@@ -62,22 +52,22 @@ describe('Commands on', () => {
     const mockFn = jest.fn();
     Walkerjs({
       consent: { foo: false },
-      on: { consent: { foo: [mockFn] } },
+      on: { consent: [{ foo: mockFn }] },
       default: true,
     });
     expect(mockFn).toHaveBeenCalledTimes(1);
   });
 
   test('consent call on register', () => {
     const mockFn = jest.fn();
-    elb('walker on', 'consent', { automatically: [mockFn] });
+    elb('walker on', 'consent', { automatically: mockFn });
 
     expect(mockFn).toHaveBeenCalledTimes(1);
   });
 
   test('consent parameters', () => {
     const mockFn = jest.fn();
-    elb('walker on', 'consent', { automatically: [mockFn] });
+    elb('walker on', 'consent', { automatically: mockFn });
     expect(mockFn).toHaveBeenCalledWith(walkerjs, {
       automatically: true,
     });
@@ -88,35 +78,31 @@ describe('Commands on', () => {
     const mockFn = jest.fn(() => {
       throw new Error('kaputt');
     });
-    elb('walker on', 'consent', { automatically: [mockFn] });
+    elb('walker on', 'consent', { automatically: mockFn });
     expect(mockFn).toHaveBeenCalledTimes(1);
-    expect(mockDataLayer).toHaveBeenCalledTimes(1);
+    expect(mockDataLayer).toHaveBeenCalledTimes(2); // session start and page view only
   });
 
   test('multiple functions', () => {
     const mockFnA = jest.fn();
     const mockFnB = jest.fn();
     const mockFnC = jest.fn();
-    elb('walker on', 'consent', { automatically: [mockFnA, mockFnB] });
-    expect(walkerjs.config.on.consent!.automatically).toHaveLength(2);
+    elb('walker on', 'consent', [
+      { automatically: mockFnA },
+      { automatically: mockFnB },
+    ]);
+
+    expect(walkerjs.config.on.consent).toHaveLength(2);
     expect(mockFnA).toHaveBeenCalledTimes(1);
     expect(mockFnB).toHaveBeenCalledTimes(1);
     // Add a new function
     jest.clearAllMocks();
-    elb('walker on', 'consent', { automatically: [mockFnC] });
-    expect(walkerjs.config.on.consent!.automatically).toHaveLength(3);
+    elb('walker on', 'consent', { automatically: mockFnC });
+    expect(walkerjs.config.on.consent).toHaveLength(3);
     expect(mockFnA).toHaveBeenCalledTimes(0);
     expect(mockFnB).toHaveBeenCalledTimes(0);
     expect(mockFnC).toHaveBeenCalledTimes(1);
 
-    // Don't add a duplicate function but call it once
-    jest.clearAllMocks();
-    elb('walker on', 'consent', { automatically: [mockFnA] });
-    expect(walkerjs.config.on.consent!.automatically).toHaveLength(3);
-    expect(mockFnA).toHaveBeenCalledTimes(1);
-    expect(mockFnB).toHaveBeenCalledTimes(0);
-    expect(mockFnC).toHaveBeenCalledTimes(0);
-
     // Update consent
     jest.clearAllMocks();
     elb('walker consent', { automatically: false });
@@ -125,3 +111,92 @@ describe('Commands on', () => {
     expect(mockFnC).toHaveBeenCalledTimes(1);
   });
 });
+
+describe('Commands run', () => {
+  const w = window;
+
+  let walkerjs: WebClient.Instance;
+
+  beforeEach(() => {
+    // reset DOM with event listeners etc.
+    document.body = document.body.cloneNode() as HTMLElement;
+    jest.clearAllMocks();
+    jest.resetModules();
+    w.elbLayer = undefined as unknown as WebClient.ElbLayer;
+
+    walkerjs = Walkerjs();
+  });
+
+  test('basics', () => {
+    const mockFn = jest.fn();
+
+    // Don't call on default
+    elb('walker on', 'run', mockFn);
+    expect(mockFn).toHaveBeenCalledTimes(0);
+
+    elb('walker run');
+    expect(mockFn).toHaveBeenCalledTimes(1); // only once
+  });
+
+  test('run register', () => {
+    const mockFn = jest.fn();
+    elb('walker on', 'run', mockFn);
+    elb('walker run');
+    expect(walkerjs.config.on.run![0]).toBe(mockFn);
+  });
+
+  test('run register init', () => {
+    const mockFn = jest.fn();
+    Walkerjs({
+      on: { run: [mockFn] },
+      default: true,
+    });
+    expect(mockFn).toHaveBeenCalledTimes(1);
+  });
+
+  test('run register after run', () => {
+    const mockFnPre = jest.fn();
+    const mockFnPost = jest.fn();
+    elb('walker on', 'run', mockFnPre);
+    expect(mockFnPre).toHaveBeenCalledTimes(0);
+    walkerjs = Walkerjs();
+    expect(mockFnPre).toHaveBeenCalledTimes(0);
+    elb('walker run');
+    expect(mockFnPre).toHaveBeenCalledTimes(1);
+
+    expect(mockFnPost).toHaveBeenCalledTimes(0);
+    elb('walker on', 'run', mockFnPost);
+    expect(mockFnPost).toHaveBeenCalledTimes(1);
+  });
+
+  test('run register elbLayer', () => {
+    const mockFn = jest.fn();
+    Walkerjs({
+      on: { run: [mockFn] },
+      default: true,
+    });
+    expect(mockFn).toHaveBeenCalledTimes(1);
+  });
+
+  test('consent error', () => {
+    const mockFn = jest.fn();
+    const mockBrokenFn = jest.fn(() => {
+      throw new Error('kaputt');
+    });
+    Walkerjs({
+      on: { run: [mockBrokenFn, mockFn] },
+      default: true,
+    });
+    expect(mockBrokenFn).toHaveBeenCalledTimes(1);
+    expect(mockFn).toHaveBeenCalledTimes(1);
+  });
+
+  test('run multiple', () => {
+    const mockFn = jest.fn();
+    elb('walker on', 'run', mockFn);
+    elb('walker run');
+    elb('walker run');
+    elb('walker run');
+    expect(mockFn).toHaveBeenCalledTimes(3);
+  });
+});

packages/clients/walkerjs/src/__tests__/destination.test.ts

@@ -11,11 +11,7 @@ describe('Destination', () => {
   let config: WebDestination.Config;
 
   beforeEach(() => {
-    jest.clearAllMocks();
-    jest.resetModules();
-
-    window.elbLayer = undefined as unknown as WebClient.ElbLayer;
-    walkerjs = Walkerjs({ pageview: false });
+    walkerjs = Walkerjs({ pageview: false, session: false });
     config = { init: false };
 
     destination = {
@@ -309,6 +305,7 @@ describe('Destination', () => {
     walkerjs = Walkerjs({
       consent: { functional: true, marketing: false },
       pageview: false,
+      session: false,
     });
     elb('walker run');
 
@@ -367,6 +364,7 @@ describe('Destination', () => {
     walkerjs = Walkerjs({
       consent: { functional: true },
       pageview: false,
+      session: false,
     });
     elb('walker run');
 
@@ -646,14 +644,4 @@ describe('Destination', () => {
     elb('walker destination', destination);
     expect(Object.keys(walkerjs.config.destinations)).toHaveLength(2);
   });
-
-  test.skip('TODO investigate this', () => {
-    elb('walker destination', destination, { id: 'foo' });
-    elb('walker run');
-
-    // @TODO
-    // the walker destination command is not processed
-    // only if walker run was called before
-    expect(walkerjs.config.destinations['foo']).toBe(destination);
-  });
 });