Test cleanup & additions, Added documentation

Remove unused setup in domo.test.ts & add new coverage, Move tests from domo.test.ts into the appropriate test file, document what port1 and port2 are used for.

Author: JSON

src/domo.test.ts

@@ -1,6 +1,3 @@
-// Mock global location before importing domo
-(global as any).location = { search: '' };
-
 import Domo, { __mutationObserverCallback } from './domo';
 import { RequestMethods } from './models/enums/request-methods';
 
@@ -10,76 +7,20 @@ const originalPost = Domo.post;
 const originalPut = Domo.put;
 const originalDelete = Domo.delete;
 
-declare global {
-  // eslint-disable-next-line no-var
-  var _originalXMLHttpRequest: any;
-  // eslint-disable-next-line no-var
-  var _openSpy: jest.Mock;
-  // eslint-disable-next-line no-var
-  var _xhrInstance: any;
-}
-
-// Mock MessagePort and MessageChannel globally for Jest
 class MockMessagePort {
   onmessage: ((event: any) => void) | null = null;
   postMessage = jest.fn();
   close = jest.fn();
 }
-(global as any).MessagePort = MockMessagePort;
 (global as any).MessageChannel = class {
   port1 = new MockMessagePort();
   port2 = new MockMessagePort();
 };
 
-// Patch window.addEventListener and removeEventListener to track message listeners for test cleanup
-const realAddEventListener = window.addEventListener;
-const realRemoveEventListener = window.removeEventListener;
-(window as any).eventListeners = { message: [] };
-window.addEventListener = function(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions) {
-  if (type === 'message') {
-    (window as any).eventListeners.message.push(listener);
-  }
-  return realAddEventListener.call(this, type, listener, options);
-};
-window.removeEventListener = function(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions) {
-  if (type === 'message') {
-    const arr = (window as any).eventListeners.message;
-    const idx = arr.indexOf(listener);
-    if (idx !== -1) arr.splice(idx, 1);
-  }
-  return realRemoveEventListener.call(this, type, listener, options);
-};
-
 // Mock browser APIs and global objects as needed
 beforeEach(() => {
   jest.resetAllMocks();
   (window as any)['__RYUU_SID__'] = 'test-token';
-  window.parent.postMessage = jest.fn();
-  Object.defineProperty(window.navigator, 'userAgent', {
-    value: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)',
-    configurable: true
-  });
-  (window as any)['webkit'] = { messageHandlers: { domofilter: { postMessage: jest.fn() }, domovariable: { postMessage: jest.fn() } } };
-  // Only redefine MessageChannel if needed for test isolation
-  (global as any).MessageChannel = (global as any).MessageChannel;
-
-  // XMLHttpRequest mock for all HTTP verb tests
-  globalThis._originalXMLHttpRequest = (global as any).XMLHttpRequest;
-  globalThis._openSpy = jest.fn();
-  globalThis._xhrInstance = {
-    open: globalThis._openSpy,
-    setRequestHeader: jest.fn(),
-    send: jest.fn(),
-    addEventListener: jest.fn(),
-    removeEventListener: jest.fn(),
-    onload: null,
-    onerror: null,
-    readyState: 4,
-    status: 200,
-    response: '{}',
-    getResponseHeader: jest.fn()
-  };
-  (global as any).XMLHttpRequest = jest.fn(() => globalThis._xhrInstance);
 
   Domo.domoHttp = originalDomoHttp;
   Domo.get = originalGet;
@@ -88,90 +29,61 @@ beforeEach(() => {
   Domo.delete = originalDelete;
 });
 
-afterEach(() => {
-  (global as any).XMLHttpRequest = globalThis._originalXMLHttpRequest;
-  // Remove all message event listeners to prevent test pollution
-  const listeners: EventListenerOrEventListenerObject[] = (window as any).eventListeners?.message ?? [];
-  listeners.forEach((listener: EventListenerOrEventListenerObject) => {
-    realRemoveEventListener.call(window, 'message', listener);
-  });
-  (window as any).eventListeners.message = [];
-});
+describe('Domo Connect & MessageChannel', () => {
+  let appDataSpy: jest.Mock, 
+      filtersSpy: jest.Mock, 
+      variablesSpy: jest.Mock;
 
+  beforeEach(() => {
+    Domo.listeners.onAppDataUpdated = [];
+    Domo.listeners.onFiltersUpdated = [];
+    Domo.listeners.onVariablesUpdated = [];
 
-describe('domo event/callback APIs', () => {
-  describe('connect/MessageChannel', () => {
-    function makeMessageEvent(data: any, ports: any[] = []) {
-      return { data, ports } as any;
-    }
+    appDataSpy = jest.fn();
+    filtersSpy = jest.fn();
+    variablesSpy = jest.fn();
+  
+    Domo.listeners.onAppDataUpdated.push(appDataSpy);
+    Domo.listeners.onFiltersUpdated.push(filtersSpy);
+    Domo.listeners.onVariablesUpdated.push(variablesSpy);
+  });
+
+  function makeMessageEvent(data: any, ports: any[] = []) {
+    return { data, ports } as any;
+  }
 
-    it('should early return if responsePort is undefined', () => {
-      Domo.connect();
-      expect(() => Domo.channel.port1.onmessage(makeMessageEvent({ event: 'filtersUpdated', filters: [] }, []))).not.toThrow();
-    });
+  it('should early return if responsePort is undefined', () => {
+    const data = { event: 'filtersUpdated', filters: [] } as any;
+    Domo.connect();
+    expect(() => Domo.channel?.port1?.onmessage?.(makeMessageEvent(data, []))).not.toThrow();
+  });
+  
+  it('should handle multiple messages correctly', () => {
+    const channel = new MessageChannel();
+    const data1 = { event: 'filtersUpdated', filters: [] } as any;
+    const data2 = { event: 'appData', data: {} } as any;
+    const data3 = { event: 'variablesUpdated', variables: {} } as any;
+
+    expect(() => Domo.channel?.port1?.onmessage?.(makeMessageEvent(data1, [channel.port2]))).not.toThrow();
+    expect(() => Domo.channel?.port1?.onmessage?.(makeMessageEvent(data2, [channel.port2]))).not.toThrow();
+    expect(() => Domo.channel?.port1?.onmessage?.(makeMessageEvent(data3, [channel.port2]))).not.toThrow();
+    expect(variablesSpy).toHaveBeenCalled();
+    expect(filtersSpy).toHaveBeenCalled();
+    expect(appDataSpy).toHaveBeenCalled();
+    expect(channel.port2.postMessage).toHaveBeenCalledTimes(3);
   });
 });
 
+
 describe('domo.__util (internal utilities)', () => {
   it('should expose the expected private functions', () => {
     expect(typeof Domo.__util.isVerifiedOrigin).toBe('function');
     expect(typeof Domo.__util.isSuccess).toBe('function');
     expect(typeof Domo.__util.getQueryParams).toBe('function');
     expect(typeof Domo.__util.setFormatHeaders).toBe('function');
   });
-
-  it('isSuccess returns true for 2xx, false otherwise', () => {
-    expect(Domo.__util.isSuccess(200)).toBe(true);
-    expect(Domo.__util.isSuccess(299)).toBe(true);
-    expect(Domo.__util.isSuccess(199)).toBe(false);
-    expect(Domo.__util.isSuccess(300)).toBe(false);
-    expect(Domo.__util.isSuccess(null)).toBe(false);
-    expect(Domo.__util.isSuccess(undefined)).toBe(false);
-  });
-
-  it('isVerifiedOrigin honors whitelisting and blacklisting', () => {
-    expect(Boolean(Domo.__util.isVerifiedOrigin('https://www.domo.com'))).toBe(true);
-    expect(Boolean(Domo.__util.isVerifiedOrigin('https://www.domotech.io'))).toBe(true);
-    expect(Boolean(Domo.__util.isVerifiedOrigin('https://www.domorig.io'))).toBe(true);
-    expect(Boolean(Domo.__util.isVerifiedOrigin('https://domo.demo.domo.com'))).toBe(true);
-    expect(Boolean(Domo.__util.isVerifiedOrigin('https://qa2staging.fastage1.domotech.io/auth/index'))).toBe(true);
-    expect(Boolean(Domo.__util.isVerifiedOrigin('https://www.domoapps-test.domo.com'))).toBe(false);
-    expect(Boolean(Domo.__util.isVerifiedOrigin('https://www.test-domoapps.domo.com'))).toBe(false);
-    expect(Boolean(Domo.__util.isVerifiedOrigin('https://www.somethingk.com'))).toBe(false);
-    expect(Boolean(Domo.__util.isVerifiedOrigin('https://www.domo.com.bad.io'))).toBe(false);
-    expect(Boolean(Domo.__util.isVerifiedOrigin('http://www.domo.com'))).toBe(false);
-  });
-
-  it('getQueryParams parses query string', () => {
-    Object.defineProperty(global, 'location', {
-      value: { search: '?foo=bar&baz=qux' },
-      configurable: true
-    });
-    const params = Domo.__util.getQueryParams();
-    expect('foo' in params).toBe(true);
-    expect('baz' in params).toBe(true);
-    expect((params as any)['foo']).toBe('bar');
-    expect((params as any)['baz']).toBe('qux');
-  });
-
-  it('setFormatHeaders sets Accept header for data/v URLs', () => {
-    const req = { setRequestHeader: jest.fn() };
-    Domo.__util.setFormatHeaders(req as any, 'https://domo.com/data/v1', { format: 'array-of-objects' });
-    expect(req.setRequestHeader).toHaveBeenCalledWith('Accept', expect.any(String));
-  });
 });
 
-describe('domo.env and global exposure', () => {
-  it('should have env properties with expected types', () => {
-    expect(typeof Domo.env).toBe('object');
-    expect(typeof Domo.env.userId).toBeDefined();
-  });
-
-  it('should expose env and __util', () => {
-    expect(Domo.env).toBeDefined();
-    expect(Domo.__util).toBeDefined();
-  });
-});
 
 describe('MutationObserver integration', () => {
   it('should call handleNode when a new element is added to the DOM', () => {
@@ -186,23 +98,20 @@ describe('MutationObserver integration', () => {
   });
 });
 
-describe('domo uncovered/miscellaneous branches', () => {
-  it('should handle catch branch in isVerifiedOrigin', () => {
-    expect(Domo.__util.isVerifiedOrigin('not a url')).toBe(false);
-  });
 
-  it('should use DataFormats.DEFAULT in setFormatHeaders', () => {
-    const req = { setRequestHeader: jest.fn() };
-    Domo.__util.setFormatHeaders(req as any, 'https://domo.com/data/v1', {});
-    expect(req.setRequestHeader).toHaveBeenCalledWith('Accept', expect.anything());
+describe('domo.env and global exposure', () => {
+  it('should have env properties with expected types', () => {
+    expect(typeof Domo.env).toBe('object');
+    expect(typeof Domo.env.userId).toBeDefined();
   });
 
-  it('should import FilterDataTypes from models/index', () => {
-    const { FilterDataTypes } = require('../src/models/interfaces/filter-data-types');
-    expect(FilterDataTypes).toBeDefined();
+  it('should expose env and __util', () => {
+    expect(Domo.env).toBeDefined();
+    expect(Domo.__util).toBeDefined();
   });
 });
 
+
 describe('Domo.extend', () => {
   beforeEach(() => {
     jest.resetModules();
@@ -258,5 +167,4 @@ describe('Domo.extend', () => {
     expect(mockHttp).toHaveBeenCalledWith('DELETE', '/grault', undefined);
     expect(deleteResult).toBe('mocked-http');
   });
-  
 });

src/domo.ts

@@ -47,6 +47,8 @@ class Domo {
 
   ////////////////////////////////////////////
   // Event Listeners
+  // 
+  // These receive messages from the parent window via port1 of the MessageChannel
   //////////////////////////////////////////
   static onDataUpdated = onDataUpdated;
   static onFiltersUpdated = onFiltersUpdated;
@@ -63,6 +65,8 @@ class Domo {
 
   /////////////////////////////////////////////
   // Emitters
+  //
+  // These send messages to the parent window via port2 of the MessageChannel
   ///////////////////////////////////////////
   static filterContainer = filterContainer;
   static sendVariables = sendVariables;

src/models/enums/data-formats.ts

@@ -6,7 +6,6 @@
  * for more details.
  */
 export enum DataFormats {
-  DEFAULT = 'application/array-of-objects',
   ARRAY_OF_OBJECTS = 'application/array-of-objects',
   JSON = 'application/json',
   CSV = 'text/csv',

src/models/interfaces/query-params.ts

@@ -6,4 +6,5 @@ export interface QueryParams {
   locale?: string;
   environment?: string;
   platform?: 'desktop' | 'mobile';
+  [key: string]: string | number | undefined;
 }

src/utils/data-helpers.ts

@@ -9,20 +9,10 @@ import { DomoDataFormats } from "../models/interfaces/domo-data-formats";
  */
 export function domoFormatToRequestFormat(format: DomoDataFormats): DataFormats {
   switch (format) {
-    case 'array-of-objects': {
-      return DataFormats.ARRAY_OF_OBJECTS;
-    }
-    case 'array-of-arrays': {
-      return DataFormats.JSON;
-    }
-    case 'excel': {
-      return DataFormats.EXCEL;
-    }
-    case 'csv': {
-      return DataFormats.CSV;
-    }
-    default: {
-      return DataFormats.DEFAULT;
-    }
+    case 'array-of-objects': return DataFormats.ARRAY_OF_OBJECTS;
+    case 'array-of-arrays': return DataFormats.JSON;
+    case 'excel': return DataFormats.EXCEL;
+    case 'csv': return DataFormats.CSV;
+    default: return DataFormats.ARRAY_OF_OBJECTS;
   }
 }

src/utils/domoutils.test.ts

@@ -129,7 +129,7 @@ describe('domoutils', () => {
       expect(domoFormatToRequestFormat('array-of-arrays')).toBe(DataFormats.JSON);
       expect(domoFormatToRequestFormat('excel')).toBe(DataFormats.EXCEL);
       expect(domoFormatToRequestFormat('csv')).toBe(DataFormats.CSV);
-      expect(domoFormatToRequestFormat('xml')).toBe(DataFormats.DEFAULT);
+      expect(domoFormatToRequestFormat('xml')).toBe(DataFormats.ARRAY_OF_OBJECTS);
     });
   });
 });