fix: Ensure that notifications on legacy http integrations navigate to the origin (#1349)

Co-authored-by: Fadi George <fadii925@gmail.com>

Author: itrush

.github/workflows/cd.yml

@@ -5,7 +5,7 @@ on:
 
 jobs:
   test_build_deploy:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     container:
       image: python:2.7.18-buster
 
@@ -21,27 +21,27 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - name: Install Yarn
         run: npm install -g yarn
-      - name: "[Setup] Install dependencies"
+      - name: '[Setup] Install dependencies'
         run: yarn
-      - name: "[Test] Run all tests"
+      - name: '[Test] Run all tests'
         run: yarn test:CI
-      - name: "[Build] Staging"
+      - name: '[Build] Staging'
         env:
           STAGING_DOMAIN: ${{ secrets.STAGING_DOMAIN }}
         run: BUILD_ORIGIN=${STAGING_DOMAIN} API=staging API_ORIGIN=${STAGING_DOMAIN} yarn build:staging
-      - name: "[Build] Production"
+      - name: '[Build] Production'
         run: yarn build:prod
       - name: 'Authenticate to Google Cloud'
         uses: 'google-github-actions/auth@v1'
         with:
           credentials_json: '${{ secrets.GOOGLE_CREDENTIALS }}'
-      - name: "[Deploy] Upload SDK Files to GCS"
+      - name: '[Deploy] Upload SDK Files to GCS'
         uses: 'google-github-actions/upload-cloud-storage@v1'
         with:
           path: 'build/releases'
           destination: 'sdk-builds-persistence-onesignal/web-sdk/${{ github.sha }}'
           parent: false
-      - name: "[Deploy] Upload AMP SDK Files to GCS"
+      - name: '[Deploy] Upload AMP SDK Files to GCS'
         uses: 'google-github-actions/upload-cloud-storage@v1'
         with:
           path: 'build/amp'

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     container:
       image: python:2.7.18-buster
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:14.21.1
+FROM node:22
 WORKDIR /sdk
 COPY package.json .
 RUN yarn

express_webpack/OneSignalSDKWorker.js

@@ -1 +1 @@
-importScripts("https://localhost:4001/sdks/Dev-OneSignalSDKWorker.js");
+importScripts("https://localhost:4000/sdks/Dev-OneSignalSDKWorker.js");

express_webpack/push/onesignal/OneSignalSDKWorker.js

@@ -1 +1 @@
-importScripts("https://localhost:4001/sdks/Dev-OneSignalSDKWorker.js");
+importScripts("https://localhost:4000/sdks/Dev-OneSignalSDKWorker.js");

package.json

@@ -7,10 +7,10 @@
     "bowser": "github:OneSignal/bowser#fix-android8-opr6-build-detection",
     "jsdom": "^9.12.0",
     "jsonp": "github:OneSignal/jsonp#onesignal",
-    "sass": "^1.90.0",
     "npm-css": "https://registry.npmjs.org/npm-css/-/npm-css-0.2.3.tgz",
     "postcss-discard-comments": "https://registry.npmjs.org/postcss-discard-comments/-/postcss-discard-comments-2.0.4.tgz",
     "postcss-filter-plugins": "https://registry.npmjs.org/postcss-filter-plugins/-/postcss-filter-plugins-2.0.2.tgz",
+    "sass": "^1.90.0",
     "tslib": "^1.9.0",
     "validator": "https://registry.npmjs.org/validator/-/validator-6.0.0.tgz"
   },
@@ -40,7 +40,7 @@
     "jest": "jest --coverage"
   },
   "config": {
-    "sdkVersion": "151606"
+    "sdkVersion": "151607"
   },
   "repository": {
     "type": "git",
@@ -150,5 +150,6 @@
       "maxSize": "9 kB",
       "compression": "gzip"
     }
-  ]
-}
+  ],
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}

src/service-worker/ServiceWorker.ts

@@ -28,6 +28,7 @@ import { NotificationReceived, NotificationClicked } from "../models/Notificatio
 import { cancelableTimeout } from "../helpers/sw/CancelableTimeout";
 import { DeviceRecord } from '../models/DeviceRecord';
 import { awaitableTimeout } from "../utils/AwaitableTimeout";
+import { AppConfig } from "src/models/AppConfig";
 
 declare var self: ServiceWorkerGlobalScope & OSServiceWorkerFields;
 
@@ -156,6 +157,11 @@ export class ServiceWorker {
     return appId;
   }
 
+  static async getAppConfig(): Promise<AppConfig> {
+    const appId = await ServiceWorker.getAppId();
+    return await ConfigHelper.getAppConfig({ appId }, OneSignalApiSW.downloadServerAppConfig);
+  }
+
   static setupMessageListeners() {
     ServiceWorker.workerMessenger.on(WorkerMessengerCommand.WorkerVersion, _ => {
       Log.debug('[Service Worker] Received worker version message.');
@@ -750,8 +756,30 @@ export class ServiceWorker {
 
     // Use the user-provided default URL if one exists
     const { defaultNotificationUrl: dbDefaultNotificationUrl } = await Database.getAppState();
-    if (dbDefaultNotificationUrl)
+    if (dbDefaultNotificationUrl) {
       launchUrl = dbDefaultNotificationUrl;
+    }
+    else {
+      // There was an issue with legacy HTTP integrations where the defaultNotificationUrl
+      // was never saved to the DB. To account for this, we try to get the default URL
+      // from the app config on notification click and save it to the DB for future use.
+      // Choosing between notification received and notification clicked to do this logic,
+      // we decided on notification clicked to avoid doing extra api call when the user
+      // may never click the notification.
+      try {
+        const config = await ServiceWorker.getAppConfig();
+        const defaultNotificationUrlFromConfig = config.origin;
+        if (defaultNotificationUrlFromConfig) {
+          launchUrl = defaultNotificationUrlFromConfig;
+
+          if (!dbDefaultNotificationUrl) {
+            await Database.setAppState({ defaultNotificationUrl: defaultNotificationUrlFromConfig });
+          }
+        }
+      } catch (e) {
+        Log.error("Failed to update notification in the database", e);
+      }
+    }
 
     // If the user clicked an action button, use the URL provided by the action button
     // Unless the action button URL is null

src/services/Database.ts

@@ -259,7 +259,7 @@ export default class Database {
     return state;
   }
 
-  async setAppState(appState: AppState) {
+  async setAppState(appState: Partial<AppState>) {
     if (appState.defaultNotificationUrl)
       await this.put("Options", { key: "defaultUrl", value: appState.defaultNotificationUrl });
     if (appState.defaultNotificationTitle || appState.defaultNotificationTitle === "")
@@ -525,7 +525,7 @@ export default class Database {
     return await Database.singletonInstance.getServiceWorkerState();
   }
 
-  static async setAppState(appState: AppState) {
+  static async setAppState(appState: Partial<AppState>) {
     return await Database.singletonInstance.setAppState(appState);
   }
 

test/support/mocks/service-workers/models/MockClients.ts

@@ -10,8 +10,8 @@ export class MockClients implements Clients {
     return Promise.resolve(client || null);
   }
 
-  async matchAll(_options?: ClientQueryOptions): Promise<Client[]> {
-    return this.clients;
+  async matchAll<T extends ClientQueryOptions>(options?: T): Promise<ReadonlyArray<T["type"] extends "window" ? WindowClient : Client>> {
+    return Object.freeze(this.clients) as ReadonlyArray<T["type"] extends "window" ? WindowClient : Client>;
   }
 
   async openWindow(_url: string): Promise<WindowClient | null> {

test/support/mocks/service-workers/models/MockPushManager.ts

@@ -12,7 +12,7 @@ export class MockPushManager implements PushManager {
     return this.subscription;
   }
 
-  public async permissionState(_options?: PushSubscriptionOptionsInit): Promise<PushPermissionState> {
+  public async permissionState(_options?: PushSubscriptionOptionsInit): Promise<PermissionState> {
     return "granted";
   }