Merge pull request #1240 from OneSignal/fg/process-deffered

Update page sdk init to handle delayed setting of window.OneSignalDeferred

Author: fadi-george

__test__/support/environment/TestEnvironmentHelpers.ts

@@ -30,7 +30,6 @@ export function resetDatabase() {
 
 export function mockUserAgent(config: TestEnvironmentConfig = {}): void {
   const info = bowser._detect(config.userAgent ?? BrowserUserAgent.Default);
-
   // Modify the mock implementation
   bowserCastleSpy.mockReturnValue({
     mobile: info.mobile,

index.html

@@ -6,14 +6,13 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>OneSignal Dev</title>
     <script>
-      window.OneSignalDeferred = window.OneSignalDeferred || [];
-
       // set can a query param ?app_id=your_app_id OR
       // create an .env file and set VITE_APP_ID to your app id
       const appId =
         new URLSearchParams(window.location.search).get('app_id') ||
         '%VITE_APP_ID%';
 
+      window.OneSignalDeferred = window.OneSignalDeferred || [];
       OneSignalDeferred.push(async function (OneSignal) {
         await OneSignal.init({
           appId,
@@ -33,6 +32,16 @@ <h1>OneSignal Dev</h1>
       // OneSignalDeferred.push(async function (OneSignal) {
       //   await OneSignal.logout();
       // });
+
+      // to check against delayed OneSignalDeferred call, comment out the one in the head
+      // setTimeout(async () => {
+      //   window.OneSignalDeferred = window.OneSignalDeferred || [];
+      //   OneSignalDeferred.push(async function (OneSignal) {
+      //     await OneSignal.init({
+      //       appId,
+      //     });
+      //   });
+      // }, 5000);
     </script>
   </body>
 </html>

package-lock.json

@@ -41,7 +41,7 @@
     "@types/node": "^18.18.0",
     "@typescript-eslint/eslint-plugin": "^5.36.1",
     "@typescript-eslint/parser": "^5.36.1",
-    "@vitest/coverage-v8": "3.0.7",
+    "@vitest/coverage-v8": "3.0.9",
     "deepmerge": "^4.2.2",
     "eslint": "^8.23.0",
     "eslint-config-prettier": "9.0.0",
@@ -56,7 +56,7 @@
     "vite-bundle-analyzer": "^0.17.1",
     "vite-plugin-mkcert": "^1.17.6",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "3.0.7"
+    "vitest": "3.0.9"
   },
   "size-limit": [
     {

package.json

@@ -3,24 +3,25 @@ import TestContext from '__test__/support/environment/TestContext';
 import { TestEnvironment } from '__test__/support/environment/TestEnvironment';
 import { server } from '__test__/support/mocks/server';
 import { http, HttpResponse } from 'msw';
-import { OneSignalDeferredLoadedCallback } from 'src/page/models/OneSignalDeferredLoadedCallback';
+import InitHelper from 'src/shared/helpers/InitHelper';
 import { ConfigIntegrationKind } from 'src/shared/models/AppConfig';
 
-vi.useFakeTimers();
-
-declare global {
-  interface Window {
-    OneSignalDeferred: OneSignalDeferredLoadedCallback[];
-  }
-}
-
 const serverConfig = TestContext.getFakeServerAppConfig(
   ConfigIntegrationKind.Custom,
 );
 
+vi.useFakeTimers();
+vi.mock('src/shared/utils/bowserCastle');
+
+// skip over creating dom elements
+vi.spyOn(InitHelper, 'sessionInit').mockImplementation(() => {
+  return Promise.resolve();
+});
+
 describe('pageSdkInit', () => {
   beforeEach(async () => {
-    window.OneSignalDeferred = [];
+    const cssURL =
+      'https://onesignal.com/sdks/web/v16/OneSignalSDK.page.styles.css';
 
     server.use(
       http.get('**/sync/*/web', ({ request }) => {
@@ -35,12 +36,20 @@ describe('pageSdkInit', () => {
           },
         );
       }),
+      http.get(cssURL, () => HttpResponse.text('')),
     );
+
     await TestEnvironment.initialize();
   });
 
+  afterEach(() => {
+    vi.resetModules();
+    localStorage.clear();
+    OneSignal._initCalled = false;
+  });
+
   test('can handle init followed by logout', async () => {
-    window.OneSignalDeferred = [];
+    window.OneSignalDeferred = window.OneSignalDeferred || [];
     window.OneSignalDeferred.push(async function (OneSignal) {
       await OneSignal.init({
         appId: APP_ID,
@@ -52,6 +61,21 @@ describe('pageSdkInit', () => {
 
     await import('./pageSdkInit');
     await vi.runOnlyPendingTimersAsync();
-    expect(OneSignal.coreDirector).toBeDefined();
+    expect(window.OneSignal.coreDirector).toBeDefined();
+  });
+
+  test('can process deferred items long after page init', async () => {
+    await import('./pageSdkInit');
+    const initSpy = vi.spyOn(window.OneSignal, 'init');
+
+    window.OneSignalDeferred = window.OneSignalDeferred || [];
+    window.OneSignalDeferred.push(async function (OneSignal) {
+      await OneSignal.init({
+        appId: APP_ID,
+      });
+    });
+
+    await vi.runOnlyPendingTimersAsync();
+    expect(initSpy).toHaveBeenCalled();
   });
 });