Skip to content

docs: correct production concurrency and idempotency guidance - #602

Merged
ueberBrot merged 3 commits into
mainfrom
docs/production-guidance-rate-limit-spec
Oct 8, 2026
Merged

ueberBrot merged 3 commits into
mainfrom
docs/production-guidance-rate-limit-spec

Conversation

@ueberBrot

@ueberBrot ueberBrot commented Oct 8, 2026 •

Copy link
Copy Markdown
Owner

Summary

Correct production guidance that could lead operators to confuse concurrency with request rate, assume heartbeats extend absolute locks, or use a duplicate check that races with another Worker.

production-checklist.mdx
├── distinguish concurrency from a shared rate budget
├── explain absolute locks and renewable Claim recovery
└── use provider idempotency keys or atomic MongoDB transactions
core-concepts/{jobs,workers}.mdx
└── align linked examples and terminology

Evidence

  • Before: The checklist implied concurrency limits request rate, twice the expected runtime prevents stale recovery, and a separate duplicate check is enough to prevent repeated effects.
    After: Guidance describes the actual Claim recovery behavior and uses stable provider keys or a unique record committed with balance changes in one transaction. Linked Jobs and Workers pages follow the same contracts.
  • After: Formatting, MDX compilation, example syntax checks, and type checks passed. The documentation build produced 208 pages with all internal links valid. No runtime suite was run on this documentation branch; example syntax checks do not execute application integrations.

Merge Danger

Door: two-way

The documentation corrections can be reverted.

Blast Radius: documentation

Operators may use these examples in their applications. Provider retention, immutable request details, transaction support, and reconciliation still require application-specific decisions.

@changeset-bot

changeset-bot Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4ba481e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ueberBrot ueberBrot changed the title docs: correct production guidance and specify shared rate limits docs: correct production concurrency and idempotency guidance Oct 8, 2026
@ueberBrot
ueberBrot force-pushed the docs/production-guidance-rate-limit-spec branch from f477c4b to 4ba481e Compare October 8, 2026 11:56
@ueberBrot
ueberBrot enabled auto-merge (squash) October 8, 2026 11:56
@ueberBrot
ueberBrot merged commit f50ccbe into main Oct 8, 2026
7 checks passed
@ueberBrot
ueberBrot deleted the docs/production-guidance-rate-limit-spec branch October 8, 2026 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant