Skip to content

Commit ae9a23c

Browse files
fadi-georgefadi-george
committed
chore(demo): handle all transient send failure shapes
1 parent 7f93266 commit ae9a23c

5 files changed

Lines changed: 80 additions & 19 deletions

File tree

‎examples/demo/src/pages/HomeScreen.css‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,15 @@
113113

114114
.section-head .icon-btn {
115115
margin-left: auto;
116+
margin-right: -11px;
116117
color: var(--os-grey-500);
117118
font-size: 18px;
119+
width: 32px;
120+
height: 32px;
121+
padding: 0;
122+
display: inline-flex;
123+
align-items: center;
124+
justify-content: center;
118125
}
119126

120127
.card {

‎examples/demo/src/services/OneSignalApiService.ts‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ export const API_KEY = import.meta.env.VITE_ONESIGNAL_API_KEY as string | undefi
88
const ANDROID_CHANNEL_ID = import.meta.env.VITE_ONESIGNAL_ANDROID_CHANNEL_ID as string | undefined;
99
const DEFAULT_ANDROID_CHANNEL_ID = 'b3b015d9-c050-4042-8548-dcc34aa44aa4';
1010

11+
function isTransientSendFailure(data: unknown): boolean {
12+
if (!data || typeof data !== 'object') return false;
13+
const record = data as { id?: unknown; errors?: unknown; recipients?: unknown };
14+
const errors = record.errors;
15+
const hasErrors =
16+
(Array.isArray(errors) && errors.length > 0) ||
17+
(errors != null && typeof errors === 'object' && Object.keys(errors).length > 0);
18+
const missingId = typeof record.id !== 'string' || record.id.length === 0;
19+
const zeroRecipients = typeof record.recipients === 'number' && record.recipients === 0;
20+
return hasErrors || missingId || zeroRecipients;
21+
}
22+
1123
class OneSignalApiService {
1224
private static instance: OneSignalApiService;
1325

@@ -85,9 +97,14 @@ class OneSignalApiService {
8597
const maxAttempts = 5;
8698
const backoffMs = (n: number) => 2_000 * 2 ** (n - 1);
8799

88-
// Retry on `invalid_player_ids` to absorb the brief race where the
89-
// subscription has been created locally but is not yet visible to the
90-
// /notifications endpoint.
100+
// Retry while the OneSignal backend hasn't yet indexed the freshly
101+
// created subscription. The /notifications endpoint reports this race in
102+
// a few different shapes, all of which return HTTP 200:
103+
// {"id":"...","recipients":0} (user just switched, push token not yet attached)
104+
// {"id":"...","errors":{"invalid_player_ids":[...]}}
105+
// {"id":"","errors":["All included players are not subscribed"]}
106+
// {"id":"","errors":[...]}
107+
// Treat any 200 response with no real id, populated errors, or recipients=0 as transient.
91108
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
92109
try {
93110
const response = await CapacitorHttp.post({
@@ -104,15 +121,12 @@ class OneSignalApiService {
104121
return false;
105122
}
106123

107-
const invalidIds = response.data?.errors?.invalid_player_ids;
108-
if (Array.isArray(invalidIds) && invalidIds.length > 0) {
124+
if (isTransientSendFailure(response.data)) {
109125
if (attempt < maxAttempts) {
110126
await new Promise((resolve) => setTimeout(resolve, backoffMs(attempt)));
111127
continue;
112128
}
113-
console.error(
114-
`Send notification failed: invalid_player_ids ${JSON.stringify(invalidIds)}`,
115-
);
129+
console.error(`Send notification failed: ${JSON.stringify(response.data)}`);
116130
return false;
117131
}
118132

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

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ import OneSignal, { LogLevel } from '@onesignal/capacitor-plugin';
44

55
const ONESIGNAL_APP_ID = '77e32082-ea27-42e3-a898-c72e141824ef';
66

7+
function isTransientSendFailure(data: unknown): boolean {
8+
if (!data || typeof data !== 'object') return false;
9+
const record = data as { id?: unknown; errors?: unknown; recipients?: unknown };
10+
const errors = record.errors;
11+
const hasErrors =
12+
(Array.isArray(errors) && errors.length > 0) ||
13+
(errors != null && typeof errors === 'object' && Object.keys(errors).length > 0);
14+
const missingId = typeof record.id !== 'string' || record.id.length === 0;
15+
const zeroRecipients = typeof record.recipients === 'number' && record.recipients === 0;
16+
return hasErrors || missingId || zeroRecipients;
17+
}
18+
719
@Component({
820
selector: 'app-root',
921
standalone: true,
@@ -98,6 +110,14 @@ export class AppComponent {
98110
};
99111
const maxAttempts = 3;
100112

113+
// Retry while the OneSignal backend hasn't yet indexed the freshly
114+
// created subscription. The /notifications endpoint reports this race
115+
// in a few different shapes, all of which return HTTP 200:
116+
// {"id":"...","recipients":0} (user just switched, push token not yet attached)
117+
// {"id":"...","errors":{"invalid_player_ids":[...]}}
118+
// {"id":"","errors":["All included players are not subscribed"]}
119+
// {"id":"","errors":[...]}
120+
// Treat any 200 response with no real id, populated errors, or recipients=0 as transient.
101121
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
102122
const response = await CapacitorHttp.post({
103123
url: 'https://onesignal.com/api/v1/notifications',
@@ -113,13 +133,12 @@ export class AppComponent {
113133
return;
114134
}
115135

116-
const invalidIds = response.data?.errors?.invalid_player_ids;
117-
if (Array.isArray(invalidIds) && invalidIds.length > 0) {
136+
if (isTransientSendFailure(response.data)) {
118137
if (attempt < maxAttempts) {
119138
await new Promise((resolve) => setTimeout(resolve, 3_000 * attempt));
120139
continue;
121140
}
122-
this.log(`Send failed: invalid_player_ids ${JSON.stringify(invalidIds)}`);
141+
this.log(`Send failed: ${JSON.stringify(response.data)}`);
123142
return;
124143
}
125144

‎examples/demo_pods/src/pages/HomeScreen.css‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,15 @@
113113

114114
.section-head .icon-btn {
115115
margin-left: auto;
116+
margin-right: -11px;
116117
color: var(--os-grey-500);
117118
font-size: 18px;
119+
width: 32px;
120+
height: 32px;
121+
padding: 0;
122+
display: inline-flex;
123+
align-items: center;
124+
justify-content: center;
118125
}
119126

120127
.card {

‎examples/demo_pods/src/services/OneSignalApiService.ts‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ export const API_KEY = import.meta.env.VITE_ONESIGNAL_API_KEY as string | undefi
88
const ANDROID_CHANNEL_ID = import.meta.env.VITE_ONESIGNAL_ANDROID_CHANNEL_ID as string | undefined;
99
const DEFAULT_ANDROID_CHANNEL_ID = 'b3b015d9-c050-4042-8548-dcc34aa44aa4';
1010

11+
function isTransientSendFailure(data: unknown): boolean {
12+
if (!data || typeof data !== 'object') return false;
13+
const record = data as { id?: unknown; errors?: unknown; recipients?: unknown };
14+
const errors = record.errors;
15+
const hasErrors =
16+
(Array.isArray(errors) && errors.length > 0) ||
17+
(errors != null && typeof errors === 'object' && Object.keys(errors).length > 0);
18+
const missingId = typeof record.id !== 'string' || record.id.length === 0;
19+
const zeroRecipients = typeof record.recipients === 'number' && record.recipients === 0;
20+
return hasErrors || missingId || zeroRecipients;
21+
}
22+
1123
class OneSignalApiService {
1224
private static instance: OneSignalApiService;
1325

@@ -85,9 +97,14 @@ class OneSignalApiService {
8597
const maxAttempts = 5;
8698
const backoffMs = (n: number) => 2_000 * 2 ** (n - 1);
8799

88-
// Retry on `invalid_player_ids` to absorb the brief race where the
89-
// subscription has been created locally but is not yet visible to the
90-
// /notifications endpoint.
100+
// Retry while the OneSignal backend hasn't yet indexed the freshly
101+
// created subscription. The /notifications endpoint reports this race in
102+
// a few different shapes, all of which return HTTP 200:
103+
// {"id":"...","recipients":0} (user just switched, push token not yet attached)
104+
// {"id":"...","errors":{"invalid_player_ids":[...]}}
105+
// {"id":"","errors":["All included players are not subscribed"]}
106+
// {"id":"","errors":[...]}
107+
// Treat any 200 response with no real id, populated errors, or recipients=0 as transient.
91108
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
92109
try {
93110
const response = await CapacitorHttp.post({
@@ -104,15 +121,12 @@ class OneSignalApiService {
104121
return false;
105122
}
106123

107-
const invalidIds = response.data?.errors?.invalid_player_ids;
108-
if (Array.isArray(invalidIds) && invalidIds.length > 0) {
124+
if (isTransientSendFailure(response.data)) {
109125
if (attempt < maxAttempts) {
110126
await new Promise((resolve) => setTimeout(resolve, backoffMs(attempt)));
111127
continue;
112128
}
113-
console.error(
114-
`Send notification failed: invalid_player_ids ${JSON.stringify(invalidIds)}`,
115-
);
129+
console.error(`Send notification failed: ${JSON.stringify(response.data)}`);
116130
return false;
117131
}
118132

0 commit comments

Comments
 (0)