fix: clear stale persisted state when App ID changes during migration (#1424)

Author: sherwinski

index.html

@@ -226,6 +226,105 @@ <h3>Demo: Suppress Notifications When Tab is Focused</h3>
       </div>
     </div>
 
+    <hr />
+    <h2>App ID Migration Regression Test</h2>
+    <p>
+      Reproduces the issue where migrating App IDs on the same origin leaves the
+      push subscription in an "unsubscribed" state. Open the browser console to
+      observe each step.
+    </p>
+    <ol>
+      <li>Enter <strong>App ID 1</strong> and click <em>Init &amp; Subscribe with App ID 1</em>. Grant notification permission when prompted.</li>
+      <li>Enter <strong>App ID 2</strong> and click <em>Migrate to App ID 2</em>. The page reloads with the new App ID.</li>
+      <li>Check the status panel below &mdash; <code>optedIn</code> should be <strong>true</strong> after migration.</li>
+    </ol>
+
+    <div style="display:flex;gap:12px;flex-wrap:wrap;margin:12px 0">
+      <label>
+        App ID 1
+        <input id="appId1" type="text" size="40" placeholder="paste App ID 1 here" />
+      </label>
+      <label>
+        App ID 2
+        <input id="appId2" type="text" size="40" placeholder="paste App ID 2 here" />
+      </label>
+    </div>
+
+    <div style="display:flex;gap:8px;flex-wrap:wrap;margin:8px 0">
+      <button id="btnInit1">Init &amp; Subscribe with App ID 1</button>
+      <button id="btnMigrate">Migrate to App ID 2 (reload)</button>
+      <button id="btnStatus">Refresh Status</button>
+    </div>
+
+    <h3>Subscription Status</h3>
+    <pre id="statusOutput" style="background:#f4f4f4;padding:12px;border-radius:4px;overflow:auto;max-height:300px">
+Click "Refresh Status" after init to see current state.
+    </pre>
+
+    <script>
+      // Populate App ID inputs from query params if present
+      const params = new URLSearchParams(window.location.search);
+      if (params.get('app_id'))
+        document.getElementById('appId1').value = params.get('app_id');
+      if (params.get('app_id_2'))
+        document.getElementById('appId2').value = params.get('app_id_2');
+
+      function log(msg) {
+        console.log('[Migration Test]', msg);
+      }
+
+      document.getElementById('btnInit1').addEventListener('click', () => {
+        const id = document.getElementById('appId1').value.trim();
+        if (!id) return alert('Enter App ID 1 first');
+        log('Navigating with App ID 1: ' + id);
+        const url = new URL(window.location.href);
+        url.searchParams.set('app_id', id);
+        window.location.href = url.toString();
+      });
+
+      document.getElementById('btnMigrate').addEventListener('click', () => {
+        const id2 = document.getElementById('appId2').value.trim();
+        if (!id2) return alert('Enter App ID 2 first');
+        log('Migrating to App ID 2: ' + id2);
+        const url = new URL(window.location.href);
+        url.searchParams.set('app_id', id2);
+        url.searchParams.set('app_id_2', id2);
+        window.location.href = url.toString();
+      });
+
+      document.getElementById('btnStatus').addEventListener('click', refreshStatus);
+
+      async function refreshStatus() {
+        const out = document.getElementById('statusOutput');
+        try {
+          const sub = OneSignal.User.PushSubscription;
+          const info = {
+            'App ID (config)': OneSignal.config?.appId,
+            'Notification.permission': Notification.permission,
+            'PushSubscription.id': sub.id,
+            'PushSubscription.token': sub.token
+              ? sub.token.substring(0, 60) + '...'
+              : null,
+            'PushSubscription.optedIn': sub.optedIn,
+          };
+          out.textContent = JSON.stringify(info, null, 2);
+          log('Status: ' + JSON.stringify(info));
+        } catch (e) {
+          out.textContent = 'Error reading status: ' + e.message;
+        }
+      }
+
+      // Auto-refresh status once SDK is ready
+      window.OneSignalDeferred = window.OneSignalDeferred || [];
+      OneSignalDeferred.push(function (OneSignal) {
+        OneSignal.User.PushSubscription.addEventListener('change', (e) => {
+          log('PushSubscription change event: ' + JSON.stringify(e));
+          refreshStatus();
+        });
+        setTimeout(refreshStatus, 1000);
+      });
+    </script>
+
     <script>
       // To check against race conditions
       // OneSignalDeferred.push(async function (OneSignal) {

package.json

@@ -85,12 +85,12 @@
     },
     {
       "path": "./build/releases/OneSignalSDK.page.es6.js",
-      "limit": "46.33 kB",
+      "limit": "46.44 kB",
       "gzip": true
     },
     {
       "path": "./build/releases/OneSignalSDK.sw.js",
-      "limit": "13.75 kB",
+      "limit": "13.68 kB",
       "gzip": true
     },
     {

src/shared/helpers/init.test.ts

@@ -1,9 +1,12 @@
+import { APP_ID } from '__test__/constants';
 import TestContext from '__test__/support/environment/TestContext';
 import { TestEnvironment } from '__test__/support/environment/TestEnvironment';
+import { setupSubModelStore } from '__test__/support/environment/TestEnvironmentHelpers';
 import Context from 'src/page/models/Context';
 import { type AppConfig } from 'src/shared/config/types';
 import type { MockInstance } from 'vitest';
 import { db } from '../database/client';
+import { getAppState } from '../database/config';
 import * as InitHelper from './init';
 
 let isSubscriptionExpiringSpy: MockInstance;
@@ -97,3 +100,99 @@ test('correct degree of persistNotification setting should be stored', async ()
   persistNotification = (await db.get('Options', 'persistNotification'))?.value;
   expect(persistNotification).toBe(true);
 });
+
+/** initSaveState – App ID migration */
+describe('initSaveState: App ID migration', () => {
+  const OLD_APP_ID = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee';
+  const NEW_APP_ID = APP_ID; // the default test app id used in TestEnvironment
+
+  async function seedStaleState() {
+    await db.put('Ids', { type: 'appId', id: OLD_APP_ID });
+    await db.put('Options', { key: 'isPushEnabled', value: true });
+    await db.put('Options', { key: 'lastPushId', value: 'old-push-id' });
+    await db.put('Options', {
+      key: 'lastPushToken',
+      value: 'old-push-token',
+    });
+    await db.put('Options', { key: 'lastOptedIn', value: true });
+    await db.put('Ids', { type: 'registrationId', id: 'old-reg-token' });
+  }
+
+  test('clears stale lastKnown* values when App ID changes', async () => {
+    await seedStaleState();
+
+    await InitHelper.initSaveState();
+
+    const appState = await getAppState();
+    expect(appState.lastKnownPushEnabled).toBeNull();
+    expect(appState.lastKnownPushId).toBeUndefined();
+    expect(appState.lastKnownPushToken).toBeUndefined();
+    expect(appState.lastKnownOptedIn).toBeNull();
+  });
+
+  test('clears subscription models when App ID changes', async () => {
+    await setupSubModelStore({ id: 'old-sub-id', token: 'old-token' });
+    expect(
+      OneSignal._coreDirector._subscriptionModelStore._list().length,
+    ).toBeGreaterThan(0);
+
+    await seedStaleState();
+    await InitHelper.initSaveState();
+
+    expect(
+      OneSignal._coreDirector._subscriptionModelStore._list(),
+    ).toHaveLength(0);
+  });
+
+  test('clears stale registrationId and deviceId when App ID changes', async () => {
+    await seedStaleState();
+    await db.put('Ids', { type: 'userId', id: 'old-device-id' });
+
+    await InitHelper.initSaveState();
+
+    const regId = await db.get('Ids', 'registrationId');
+    expect(regId?.id).toBeNull();
+    const userId = await db.get('Ids', 'userId');
+    expect(userId?.id).toBeNull();
+  });
+
+  test('saves the new App ID after migration', async () => {
+    await seedStaleState();
+
+    await InitHelper.initSaveState();
+
+    const storedAppId = await db.get('Ids', 'appId');
+    expect(storedAppId?.id).toBe(NEW_APP_ID);
+  });
+
+  test('does NOT clear state when App ID has not changed', async () => {
+    await db.put('Ids', { type: 'appId', id: NEW_APP_ID });
+    await db.put('Options', { key: 'isPushEnabled', value: true });
+    await db.put('Options', { key: 'lastPushId', value: 'current-id' });
+    await db.put('Options', {
+      key: 'lastPushToken',
+      value: 'current-token',
+    });
+    await db.put('Options', { key: 'lastOptedIn', value: true });
+
+    await InitHelper.initSaveState();
+
+    const appState = await getAppState();
+    expect(appState.lastKnownPushEnabled).toBe(true);
+    expect(appState.lastKnownPushId).toBe('current-id');
+    expect(appState.lastKnownPushToken).toBe('current-token');
+    expect(appState.lastKnownOptedIn).toBe(true);
+  });
+
+  test('does NOT clear state on first-ever initialization (no previous App ID)', async () => {
+    await db.put('Options', { key: 'isPushEnabled', value: true });
+
+    await InitHelper.initSaveState();
+
+    const appState = await getAppState();
+    expect(appState.lastKnownPushEnabled).toBe(true);
+
+    const storedAppId = await db.get('Ids', 'appId');
+    expect(storedAppId?.id).toBe(NEW_APP_ID);
+  });
+});

src/shared/helpers/init.ts

@@ -1,7 +1,8 @@
 import Bell from '../../page/bell/Bell';
+import { ModelChangeTags } from 'src/core/types/models';
 import type { AppConfig } from '../config/types';
 import type { ContextInterface } from '../context/types';
-import { db } from '../database/client';
+import { db, getIdsValue } from '../database/client';
 import { getSubscription, setSubscription } from '../database/subscription';
 import type { OptionKey } from '../database/types';
 import Log from '../libraries/Log';
@@ -365,6 +366,23 @@ export async function saveInitOptions() {
 export async function initSaveState(overridingPageTitle?: string) {
   const appId = getAppId();
   const config: AppConfig = OneSignal.config!;
+
+  const previousAppId = await getIdsValue<string>('appId');
+  if (previousAppId && previousAppId !== appId) {
+    Log._info(
+      `OneSignal: App ID changed from ${previousAppId} to ${appId}. Clearing stale state for migration.`,
+    );
+    await db.put('Options', { key: 'isPushEnabled', value: null });
+    await db.put('Options', { key: 'lastPushId', value: null });
+    await db.put('Options', { key: 'lastPushToken', value: null });
+    await db.put('Options', { key: 'lastOptedIn', value: null });
+    await db.put('Ids', { type: 'registrationId', id: null });
+    await db.put('Ids', { type: 'userId', id: null });
+    OneSignal._coreDirector._subscriptionModelStore._clear(
+      ModelChangeTags._Hydrate,
+    );
+  }
+
   await db.put('Ids', { type: 'appId', id: appId });
   const pageTitle: string =
     overridingPageTitle || config.siteName || document.title || 'Notification';