chore(demo): handle all transient send failure shapes

Author: fadi-george

examples/demo/src/pages/HomeScreen.css

@@ -113,8 +113,15 @@
 
 .section-head .icon-btn {
   margin-left: auto;
+  margin-right: -11px;
   color: var(--os-grey-500);
   font-size: 18px;
+  width: 32px;
+  height: 32px;
+  padding: 0;
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
 }
 
 .card {

examples/demo/src/services/OneSignalApiService.ts

@@ -8,6 +8,18 @@ export const API_KEY = import.meta.env.VITE_ONESIGNAL_API_KEY as string | undefi
 const ANDROID_CHANNEL_ID = import.meta.env.VITE_ONESIGNAL_ANDROID_CHANNEL_ID as string | undefined;
 const DEFAULT_ANDROID_CHANNEL_ID = 'b3b015d9-c050-4042-8548-dcc34aa44aa4';
 
+function isTransientSendFailure(data: unknown): boolean {
+  if (!data || typeof data !== 'object') return false;
+  const record = data as { id?: unknown; errors?: unknown; recipients?: unknown };
+  const errors = record.errors;
+  const hasErrors =
+    (Array.isArray(errors) && errors.length > 0) ||
+    (errors != null && typeof errors === 'object' && Object.keys(errors).length > 0);
+  const missingId = typeof record.id !== 'string' || record.id.length === 0;
+  const zeroRecipients = typeof record.recipients === 'number' && record.recipients === 0;
+  return hasErrors || missingId || zeroRecipients;
+}
+
 class OneSignalApiService {
   private static instance: OneSignalApiService;
 
@@ -85,9 +97,13 @@ class OneSignalApiService {
     const maxAttempts = 5;
     const backoffMs = (n: number) => 2_000 * 2 ** (n - 1);
 
-    // Retry on `invalid_player_ids` to absorb the brief race where the
-    // subscription has been created locally but is not yet visible to the
-    // /notifications endpoint.
+    // Retry while the OneSignal backend hasn't yet indexed the freshly
+    // created subscription. The /notifications endpoint reports this race in
+    // a few different shapes, all of which return HTTP 200:
+    //   {"errors":{"invalid_player_ids":[...]}}
+    //   {"id":"","errors":["All included players are not subscribed"]}
+    //   {"id":"","errors":[...]}
+    // Treat any 200 response without a real notification id as transient.
     for (let attempt = 1; attempt <= maxAttempts; attempt++) {
       try {
         const response = await CapacitorHttp.post({
@@ -104,15 +120,12 @@ class OneSignalApiService {
           return false;
         }
 
-        const invalidIds = response.data?.errors?.invalid_player_ids;
-        if (Array.isArray(invalidIds) && invalidIds.length > 0) {
+        if (isTransientSendFailure(response.data)) {
           if (attempt < maxAttempts) {
             await new Promise((resolve) => setTimeout(resolve, backoffMs(attempt)));
             continue;
           }
-          console.error(
-            `Send notification failed: invalid_player_ids ${JSON.stringify(invalidIds)}`,
-          );
+          console.error(`Send notification failed: ${JSON.stringify(response.data)}`);
           return false;
         }
 

examples/demo_cap7/src/app/app.component.ts

@@ -4,6 +4,17 @@ import OneSignal, { LogLevel } from '@onesignal/capacitor-plugin';
 
 const ONESIGNAL_APP_ID = '77e32082-ea27-42e3-a898-c72e141824ef';
 
+function isTransientSendFailure(data: unknown): boolean {
+  if (!data || typeof data !== 'object') return false;
+  const record = data as { id?: unknown; errors?: unknown };
+  const errors = record.errors;
+  const hasErrors =
+    (Array.isArray(errors) && errors.length > 0) ||
+    (errors != null && typeof errors === 'object' && Object.keys(errors).length > 0);
+  const missingId = typeof record.id !== 'string' || record.id.length === 0;
+  return hasErrors || missingId;
+}
+
 @Component({
   selector: 'app-root',
   standalone: true,
@@ -98,6 +109,13 @@ export class AppComponent {
       };
       const maxAttempts = 3;
 
+      // Retry while the OneSignal backend hasn't yet indexed the freshly
+      // created subscription. The /notifications endpoint reports this race
+      // in a few different shapes, all of which return HTTP 200:
+      //   {"errors":{"invalid_player_ids":[...]}}
+      //   {"id":"","errors":["All included players are not subscribed"]}
+      //   {"id":"","errors":[...]}
+      // Treat any 200 response without a real notification id as transient.
       for (let attempt = 1; attempt <= maxAttempts; attempt++) {
         const response = await CapacitorHttp.post({
           url: 'https://onesignal.com/api/v1/notifications',
@@ -113,13 +131,12 @@ export class AppComponent {
           return;
         }
 
-        const invalidIds = response.data?.errors?.invalid_player_ids;
-        if (Array.isArray(invalidIds) && invalidIds.length > 0) {
+        if (isTransientSendFailure(response.data)) {
           if (attempt < maxAttempts) {
             await new Promise((resolve) => setTimeout(resolve, 3_000 * attempt));
             continue;
           }
-          this.log(`Send failed: invalid_player_ids ${JSON.stringify(invalidIds)}`);
+          this.log(`Send failed: ${JSON.stringify(response.data)}`);
           return;
         }
 

examples/demo_pods/src/pages/HomeScreen.css

@@ -113,8 +113,15 @@
 
 .section-head .icon-btn {
   margin-left: auto;
+  margin-right: -11px;
   color: var(--os-grey-500);
   font-size: 18px;
+  width: 32px;
+  height: 32px;
+  padding: 0;
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
 }
 
 .card {

examples/demo_pods/src/services/OneSignalApiService.ts

@@ -8,6 +8,17 @@ export const API_KEY = import.meta.env.VITE_ONESIGNAL_API_KEY as string | undefi
 const ANDROID_CHANNEL_ID = import.meta.env.VITE_ONESIGNAL_ANDROID_CHANNEL_ID as string | undefined;
 const DEFAULT_ANDROID_CHANNEL_ID = 'b3b015d9-c050-4042-8548-dcc34aa44aa4';
 
+function isTransientSendFailure(data: unknown): boolean {
+  if (!data || typeof data !== 'object') return false;
+  const record = data as { id?: unknown; errors?: unknown };
+  const errors = record.errors;
+  const hasErrors =
+    (Array.isArray(errors) && errors.length > 0) ||
+    (errors != null && typeof errors === 'object' && Object.keys(errors).length > 0);
+  const missingId = typeof record.id !== 'string' || record.id.length === 0;
+  return hasErrors || missingId;
+}
+
 class OneSignalApiService {
   private static instance: OneSignalApiService;
 
@@ -85,9 +96,13 @@ class OneSignalApiService {
     const maxAttempts = 5;
     const backoffMs = (n: number) => 2_000 * 2 ** (n - 1);
 
-    // Retry on `invalid_player_ids` to absorb the brief race where the
-    // subscription has been created locally but is not yet visible to the
-    // /notifications endpoint.
+    // Retry while the OneSignal backend hasn't yet indexed the freshly
+    // created subscription. The /notifications endpoint reports this race in
+    // a few different shapes, all of which return HTTP 200:
+    //   {"errors":{"invalid_player_ids":[...]}}
+    //   {"id":"","errors":["All included players are not subscribed"]}
+    //   {"id":"","errors":[...]}
+    // Treat any 200 response without a real notification id as transient.
     for (let attempt = 1; attempt <= maxAttempts; attempt++) {
       try {
         const response = await CapacitorHttp.post({
@@ -104,15 +119,12 @@ class OneSignalApiService {
           return false;
         }
 
-        const invalidIds = response.data?.errors?.invalid_player_ids;
-        if (Array.isArray(invalidIds) && invalidIds.length > 0) {
+        if (isTransientSendFailure(response.data)) {
           if (attempt < maxAttempts) {
             await new Promise((resolve) => setTimeout(resolve, backoffMs(attempt)));
             continue;
           }
-          console.error(
-            `Send notification failed: invalid_player_ids ${JSON.stringify(invalidIds)}`,
-          );
+          console.error(`Send notification failed: ${JSON.stringify(response.data)}`);
           return false;
         }