remove stub dom environment

Author: fadi-george

__test__/setupTests.ts

@@ -1,7 +1,13 @@
+import intlTelInput from 'intl-tel-input';
+import OneSignalApi from 'src/shared/api/OneSignalApi';
+import { ConfigIntegrationKind } from 'src/shared/config/constants';
 import { clearAll } from 'src/shared/database/client';
 import { DEFAULT_USER_AGENT } from './constants';
+import TestContext from './support/environment/TestContext';
 import { server } from './support/mocks/server';
 
+window.intlTelInput = intlTelInput;
+
 beforeAll(() =>
   server.listen({
     onUnhandledRequest: 'warn',
@@ -44,3 +50,12 @@ Object.defineProperty(navigator, 'userAgent', {
   value: DEFAULT_USER_AGENT,
   writable: true,
 });
+
+export const mockJsonp = () => {
+  const serverConfig = TestContext.getFakeServerAppConfig(
+    ConfigIntegrationKind.Custom,
+  );
+  vi.spyOn(OneSignalApi, 'jsonpLib').mockImplementation((_, fn) => {
+    fn(null, serverConfig);
+  });
+};

__test__/support/environment/TestEnvironment.ts

@@ -1,16 +1,13 @@
 import { ONESIGNAL_ID } from '__test__/constants';
+import { mockJsonp } from '__test__/setupTests';
 import type {
   AppUserConfig,
   ConfigIntegrationKindValue,
   ServerAppConfig,
 } from 'src/shared/config/types';
 import type { RecursivePartial } from 'src/shared/context/types';
 import { updateIdentityModel } from '../helpers/setup';
-import {
-  initOSGlobals,
-  stubDomEnvironment,
-  stubNotification,
-} from './TestEnvironmentHelpers';
+import { initOSGlobals, stubNotification } from './TestEnvironmentHelpers';
 
 export interface TestEnvironmentConfig {
   userConfig?: AppUserConfig;
@@ -24,15 +21,31 @@ export interface TestEnvironmentConfig {
   overrideServerConfig?: RecursivePartial<ServerAppConfig>;
   integration?: ConfigIntegrationKindValue;
 }
+Object.defineProperty(document, 'readyState', {
+  value: 'complete',
+  writable: true,
+});
 
 export class TestEnvironment {
   static async initialize(config: TestEnvironmentConfig = {}) {
+    mockJsonp();
     const oneSignal = await initOSGlobals(config);
     OneSignal.coreDirector.operationRepo.queue = [];
 
     updateIdentityModel('onesignal_id', ONESIGNAL_ID);
 
-    await stubDomEnvironment(config);
+    // Set URL if provided
+    if (config.url) {
+      Object.defineProperty(window, 'location', {
+        value: new URL(config.url),
+        writable: true,
+      });
+    }
+
+    OneSignal._didLoadITILibrary = true;
+    window.isSecureContext = true;
+
+    // await stubDomEnvironment(config);
     config.environment = 'dom';
     stubNotification(config);
     return oneSignal;

__test__/support/environment/TestEnvironmentHelpers.ts

@@ -1,4 +1,3 @@
-import { type DOMWindow, JSDOM, ResourceLoader } from 'jsdom';
 import CoreModule from 'src/core/CoreModule';
 import { SubscriptionModel } from 'src/core/models/SubscriptionModel';
 import { ModelChangeTags } from 'src/core/types/models';
@@ -14,15 +13,8 @@ import OneSignal from '../../../src/onesignal/OneSignal';
 import { ONESIGNAL_EVENTS } from '../../../src/onesignal/OneSignalEvents';
 import UserNamespace from '../../../src/onesignal/UserNamespace';
 import Context from '../../../src/page/models/Context';
-import { getSlidedownElement } from '../../../src/page/slidedown/SlidedownElement';
 import Emitter from '../../../src/shared/libraries/Emitter';
-import { CUSTOM_LINK_CSS_CLASSES } from '../../../src/shared/slidedown/constants';
-import {
-  DEFAULT_USER_AGENT,
-  DEVICE_OS,
-  ONESIGNAL_ID,
-  SUB_ID_3,
-} from '../../constants';
+import { DEVICE_OS, ONESIGNAL_ID, SUB_ID_3 } from '../../constants';
 import MockNotification from '../mocks/MockNotification';
 import TestContext from './TestContext';
 import { type TestEnvironmentConfig } from './TestEnvironment';
@@ -60,55 +52,6 @@ export function stubNotification(config: TestEnvironmentConfig) {
   }
 }
 
-export async function stubDomEnvironment(config: TestEnvironmentConfig) {
-  if (!config) {
-    config = {};
-  }
-
-  let url = 'https://localhost:3001/webpush/sandbox?https=1';
-
-  if (config.url) {
-    url = config.url.toString();
-    global.location = url;
-  }
-
-  let html = '<!doctype html><html><head></head><body></body></html>';
-
-  if (config.addPrompts) {
-    html = `<!doctype html><html><head>\
-    <div class="${CUSTOM_LINK_CSS_CLASSES.containerClass}"></div>\
-    <div class="${CUSTOM_LINK_CSS_CLASSES.containerClass}"></div>\
-    </head><body>\
-      ${getSlidedownElement({}).outerHTML}</div></body></html>`;
-  }
-
-  const resourceLoader = new ResourceLoader({
-    userAgent: config.userAgent
-      ? config.userAgent.toString()
-      : DEFAULT_USER_AGENT.toString(),
-  });
-
-  // global document object must be defined for `getSlidedownElement` to work correctly.
-  // this line initializes the document object
-  const dom = new JSDOM(html, {
-    resources: resourceLoader,
-    url: url,
-    contentType: 'text/html',
-    runScripts: 'dangerously',
-    pretendToBeVisual: true,
-  });
-
-  const windowDef = dom.window;
-  (windowDef as any).location = url;
-
-  const windowTop: DOMWindow = windowDef;
-  dom.reconfigure({ url, windowTop });
-  global.window = windowDef;
-  global.window.isSecureContext = true;
-  global.document = windowDef.document;
-  return dom;
-}
-
 export const createPushSub = ({
   id = SUB_ID_3,
   token = 'push-token',

__test__/support/helpers/requests.ts

@@ -1,30 +1,11 @@
 import { http, HttpResponse } from 'msw';
 import type { ISubscription, IUserProperties } from 'src/core/types/api';
-import { ConfigIntegrationKind } from 'src/shared/config/constants';
+import type { NotificationIcons } from 'src/shared/notifications/types';
 import { APP_ID, ONESIGNAL_ID, SUB_ID } from '../../constants';
-import TestContext from '../environment/TestContext';
 import { server } from '../mocks/server';
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 // configs
-const serverConfig = TestContext.getFakeServerAppConfig(
-  ConfigIntegrationKind.Custom,
-);
-
-export const mockServerConfig = () => {
-  return http.get('**/sync/*/web', ({ request }) => {
-    const url = new URL(request.url);
-    const callbackParam = url.searchParams.get('callback');
-    return new HttpResponse(
-      `${callbackParam}(${JSON.stringify(serverConfig)})`,
-      {
-        headers: {
-          'Content-Type': 'application/javascript',
-        },
-      },
-    );
-  });
-};
 export const mockPageStylesCss = () => {
   return http.get(
     'https://onesignal.com/sdks/web/v16/OneSignalSDK.page.styles.css',
@@ -397,3 +378,16 @@ export const setSendCustomEventResponse = () =>
     status: 200,
     callback: sendCustomEventFn,
   });
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+// icons
+export const getNotificationIcons = () =>
+  server.use(
+    http.get('**/apps/:appId/icon', () => {
+      return HttpResponse.json({
+        chrome: 'https://onesignal.com/icon.png',
+        firefox: 'https://onesignal.com/icon.png',
+        safari: 'https://onesignal.com/icon.png',
+      } satisfies NotificationIcons);
+    }),
+  );

__test__/support/helpers/setup.ts

@@ -7,6 +7,7 @@ import { db } from 'src/shared/database/client';
 import type {
   IdentitySchema,
   PropertiesSchema,
+  SubscriptionSchema,
 } from 'src/shared/database/types';
 
 export const setIsPushEnabled = async (isPushEnabled: boolean) => {
@@ -35,6 +36,15 @@ export const getPropertiesItem = async (
   return properties;
 };
 
+export const getDbSubscriptions = async (length: number) => {
+  let subscriptions: SubscriptionSchema[] = [];
+  await vi.waitUntil(async () => {
+    subscriptions = await db.getAll('subscriptions');
+    return subscriptions.length === length;
+  });
+  return subscriptions;
+};
+
 export const setupIdentityModel = async (
   {
     onesignalID,

index.html

@@ -49,6 +49,7 @@
       // uncomment to test login
       // OneSignalDeferred.push(async function (OneSignal) {
       //   await OneSignal.login('new-web-sdk');
+      //   OneSignal.User.addEmail('test@test.com');
       // });
     </script>
   </head>