Draft: Workers event notifications#31826
Conversation
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
There was a problem hiding this comment.
PR Review: Workers event notifications reference
Summary
This PR adds a new reference page (event-notifications.mdx) cataloging Workers lifecycle and configuration events available through Queues event subscriptions. The page is well-structured into event sources, Milestone 1 (gradual deployments, lifecycle, routing, secrets/settings, account-level, and Workers for Platforms), and Milestone 2 (granular settings). Links are valid and frontmatter is mostly complete.
Issues flagged — needs maintainer attention
1. Duplicate version.created event with conflicting semantics (lines 56 and 89)
The same event name and type field (cf.workers.worker.version.created) is used for two completely different concepts:
- Line 56: "A new version was explicitly uploaded (for example,
wrangler versions upload)" - Line 89: "A versioned setting was changed (bindings, limits, placement)"
This appears to be a copy-paste error. These should have distinct event names and type values so customers can differentiate them.
Suggested fix: Rename the settings-table entry to something like settings.versionedUpdated with a corresponding type of cf.workers.worker.settings.versionedUpdated (or whatever the actual product API uses).
2. Draft content in a Note admonition (lines 92–94)
:::note[Open question]
Secret changes create new versions under the hood. These events may collapse into `version.created` in a future revision — to be determined based on whether customers prefer granular secret-level events or version-level events.
:::The :::note[Open question] framing signals that the product behavior is undecided. Published docs should not contain unresolved product deliberations. Please resolve this before merging — either remove the note, convert it to a standard :::note with settled guidance, or move the context to an internal doc.
Style / polish suggestions
3. Unused component import (line 14)
Render is imported but never used on the page. Remove the import:
- import { Render } from "~/components";4. Redundant <title> tag in frontmatter (lines 7–9)
Starlight automatically generates the <title> tag from the title: field. The head: block is unnecessary here and can be removed:
- head:
- - tag: title
- content: Event notifications5. Missing Oxford comma (line 90)
Per the style guide, use an Oxford comma in lists of three or more:
- | `settings.updated` | `cf.workers.worker.settings.updated` | An unversioned setting was changed (observability, logpush, tail consumers, subdomain) |
+ | `settings.updated` | `cf.workers.worker.settings.updated` | An unversioned setting was changed (observability, logpush, tail consumers, and subdomain) |Labels
Applying content, workers, documentation.
|
Done. Here's a summary of my review on PR #31826: Labels applied
Summary of the PRThis PR adds a new reference page ( Issues flaggedCritical — needs maintainer attention before merge:
Style / polish:
All of this has been posted as a review comment on PR #31826. |
|
this will not be merged in |
|
Preview URL: https://9e9c577f.preview.developers.cloudflare.com Files with changes (up to 15) |
Draft reference page for Workers event notifications via Queues event subscriptions. Covers gradual deployment events, deployment/version lifecycle, routing, secrets/tags/settings, account-level events, and Workers for Platforms — with milestone 1 and milestone 2 breakdown.