Skip to content

Commit b0503c1

Browse files
committed
fix(push): name no tracker id in operator-facing push text (check:doc-authoring)
The relay refusal message and the relay and union describes drop #29920; the card stays named in the code comments, the ADR, the README and the changeset. push-config.mdx regenerated. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 42eef7a commit b0503c1

5 files changed

Lines changed: 11 additions & 10 deletions

File tree

‎content/docs/references/system/push-config.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Direct push transport for a white-label build: one block per vendor (apns, fcm),
157157

158158
## PushRelayTransportConfig
159159

160-
[PLANNED — not yet served] The hosted push relay transport (the default): authenticated by the server cloud binding credential, so it carries none. The push service refuses it at boot until the relay sender ships (#29920)
160+
[PLANNED — not yet served] The hosted push relay transport (the default): authenticated by the server cloud binding credential, so it carries none. The push service refuses it at boot until the relay sender ships
161161

162162
### Properties
163163

@@ -171,15 +171,15 @@ Direct push transport for a white-label build: one block per vendor (apns, fcm),
171171

172172
## PushServiceConfig
173173

174-
Push channel transport configuration: the hosted relay (the default) or direct delivery to apns and fcm for a white-label build. The push service reads it: direct drives the vendor transports, and relay is refused at boot until the relay sender ships (#29920)
174+
Push channel transport configuration: the hosted relay (the default) or direct delivery to apns and fcm for a white-label build. The push service reads it: direct drives the vendor transports, and relay is refused at boot until the relay sender ships
175175

176176
### Union Options
177177

178178
This schema accepts one of the following structures:
179179

180180
#### Option 1
181181

182-
[PLANNED — not yet served] The hosted push relay transport (the default): authenticated by the server cloud binding credential, so it carries none. The push service refuses it at boot until the relay sender ships (#29920)
182+
[PLANNED — not yet served] The hosted push relay transport (the default): authenticated by the server cloud binding credential, so it carries none. The push service refuses it at boot until the relay sender ships
183183

184184
### Properties
185185

‎packages/services/service-push/src/push-plugin.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ describe('PushServicePlugin', () => {
5454
expect(services.has('push')).toBe(false);
5555
});
5656

57-
it('names the follow-up card and the direct transport in the relay refusal', () => {
58-
expect(PUSH_RELAY_NOT_SERVED_MESSAGE).toContain('#29920');
57+
it('names the direct transport, and the relay as not yet served, in the relay refusal', () => {
58+
expect(PUSH_RELAY_NOT_SERVED_MESSAGE).toContain('is not served yet');
5959
expect(PUSH_RELAY_NOT_SERVED_MESSAGE).toContain("transport: 'direct'");
6060
expect(PUSH_RELAY_NOT_SERVED_MESSAGE).toContain('credentialRef');
6161
});

‎packages/services/service-push/src/push-plugin.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,15 @@ export interface PushServicePluginOptions {
6868
*/
6969
/**
7070
* The refusal a relay configuration meets at init. The relay is the schema's
71-
* default (cloud#3519), but its sender is not served yet (#29920): booting a
71+
* default (cloud#3519), but its sender is not served yet (follow-up card
72+
* #29920; the text below is printed at the operator, so it names no tracker
73+
* id, per check:doc-authoring): booting a
7274
* `push` service that would deliver nothing is worse than refusing, because
7375
* the channel would mount and every push would look sent.
7476
*/
7577
export const PUSH_RELAY_NOT_SERVED_MESSAGE =
7678
"PushServicePlugin: the hosted push relay (transport: 'relay', which is also what an empty push config reads as) "
77-
+ 'is not served yet: its sender is follow-up card #29920, and nothing would deliver through it. For a white-label '
79+
+ 'is not served yet: its sender has not shipped, and nothing would deliver through it. For a white-label '
7880
+ "build signed with your own APNs key or Firebase project, write transport: 'direct' with an apns and/or fcm block, "
7981
+ 'each naming its secret by credentialRef.';
8082

‎packages/spec/src/system/push-config.test.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,6 @@ describe('push transport configuration is read', () => {
207207
it('marks the relay block not yet served, and says the push service refuses it', () => {
208208
expect(PushRelayTransportConfigSchema.description).toMatch(/^\[PLANNED — not yet served\] /);
209209
expect(PushRelayTransportConfigSchema.description).toMatch(/refuses it at boot/);
210-
expect(PushRelayTransportConfigSchema.description).toMatch(/#29920/);
211210
});
212211

213212
it.each([

‎packages/spec/src/system/push-config.zod.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ export const PushRelayTransportConfigSchema = lazySchema(() => strictObject(
220220
),
221221
},
222222
).describe('[PLANNED — not yet served] The hosted push relay transport (the default): authenticated by the server cloud binding credential, so it carries none. '
223-
+ 'The push service refuses it at boot until the relay sender ships (#29920)'));
223+
+ 'The push service refuses it at boot until the relay sender ships'));
224224
export type PushRelayTransportConfig = z.input<typeof PushRelayTransportConfigSchema>;
225225
/** Post-parse shape of {@link PushRelayTransportConfig} — `transport` filled in (ADR-0122). */
226226
export type PushRelayTransportConfigParsed = z.infer<typeof PushRelayTransportConfigSchema>;
@@ -265,7 +265,7 @@ export const PushServiceConfigSchema = lazySchema(() => z.discriminatedUnion(
265265
// tag falls back to trying the members in order, relay first.
266266
{ unionFallback: true },
267267
).describe('Push channel transport configuration: the hosted relay (the default) or direct delivery to apns and fcm for a white-label build. '
268-
+ 'The push service reads it: direct drives the vendor transports, and relay is refused at boot until the relay sender ships (#29920)'));
268+
+ 'The push service reads it: direct drives the vendor transports, and relay is refused at boot until the relay sender ships'));
269269
export type PushServiceConfig = z.input<typeof PushServiceConfigSchema>;
270270
/** Post-parse shape of {@link PushServiceConfig} — `transport` filled in (ADR-0122). */
271271
export type PushServiceConfigParsed = z.infer<typeof PushServiceConfigSchema>;

0 commit comments

Comments
 (0)