fix(core): don't assume a 64-character idempotency key is pre-hashed on reset - #4626
Draft
claude[bot] wants to merge 2 commits into
Draft
fix(core): don't assume a 64-character idempotency key is pre-hashed on reset#4626claude[bot] wants to merge 2 commits into
claude[bot] wants to merge 2 commits into
Conversation
…on reset `resetIdempotencyKey` treated any 64-character string as an already-computed hash and sent it to the API verbatim. That short-circuit ran before the scope logic, so a user key that is itself a 64-character digest had an explicitly passed `scope` silently discarded and was sent un-hashed, matching no run. A 64-character string is now only passed through when there is evidence it is already a hash: the idempotency key catalog recognises it (so it came from `idempotencyKeys.create()`), or no `scope` was passed and the length is the only signal available. An explicit `scope` is an explicit request to derive the hash, so it is always honoured. This keeps both existing behaviours intact: a key from `idempotencyKeys.create()` is still forwarded unchanged, and 64-character key material passed straight to `trigger()` and reset without a scope is still sent verbatim. `isIdempotencyKey` is deliberately untouched, since the trigger path is self-consistent and changing it would invalidate already-stored keys. Co-Authored-By: Claude <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 6016987 The changes in this PR will be included in the next version bump. This PR includes changesets to release 27 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Co-Authored-By: Claude <noreply@anthropic.com>
@trigger.dev/build
trigger.dev
@trigger.dev/core
@trigger.dev/python
@trigger.dev/react-hooks
@trigger.dev/redis-worker
@trigger.dev/rsc
@trigger.dev/schema-to-json
@trigger.dev/sdk
commit: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Matt Aitken · Slack thread
idempotencyKeys.reset()now honours an explicitly passedscopeeven when the key material happens to be 64 characters long.Before:
resetIdempotencyKeytreated any 64-character string as an already-computed hash and sent it to the API verbatim. That short-circuit ran before the scope logic, so if your key material is itself a 64-character digest — a common pattern when you hash your own dedup identity — thescopeyou passed was silently discarded and the un-hashed material went on the wire. The server stores the hash, so the reset matched no run and returned 404 every single time. Key material of any other length worked fine, which made this look arbitrary.After: a 64-character string is only passed through when there is evidence it is already a hash. Otherwise an explicit
scopeis honoured and the hash is derived, at any key length.How
The pass-through now requires positive evidence rather than a length guess:
idempotencyKeys.create(), orscopewas passed, so there is nothing to derive a hash from and the length is the only available signal.An explicit
scopeis an explicit request to derive the hash, so it is never short-circuited past.Both existing behaviours are preserved:
idempotencyKeys.create()is still forwarded unchanged (catalog hit), including when ascopeis also passed — it is never hashed twice.trigger()is stored un-hashed, and resetting it with noscopestill sends it verbatim.isIdempotencyKeyis deliberately left alone: it applies the same length rule on the trigger path, but it is self-consistent there, and changing it would invalidate already-stored keys.The
attachedOptions?.key/attachedOptions?.scopefallbacks below the guard were unreachable — every catalog entry is a 64-character digest, so it always hit the short-circuit first — and re-deriving from them produces the identical hash anyway. They are removed rather than left as dead code.✅ Checklist
Testing
New tests in
packages/core/src/v3/idempotencyKeys.test.tsdrive the realresetIdempotencyKeyagainst a local HTTP server and assert on the exact value that reaches the wire — nothing is mocked. They cover:{ scope: "global" }resolves to the same valueidempotencyKeys.create()produces (fails without this change){ scope: "run", parentRunId }derives the run-salted hash (fails without this change)idempotencyKeys.create()is forwarded unchanged, with and without ascopescopeis still forwarded unchangedReverting only the source change turns the two new scope tests red and leaves the three compatibility tests green.
Changelog
idempotencyKeys.reset()now works when your idempotency key is itself 64 characters long. Previously any 64-character key was assumed to be already hashed, so passing one along with ascopesilently ignored the scope and the reset never found a matching run.Follow-ups (not in this PR)
docs/idempotency.mdxdescribes theidempotencyKeyparameter ofreset()as "the 64-character hash string" in one place while showing raw material plus{ scope: "global" }a few lines later. Worth reconciling.ctx.run.idempotencyKey, the run page and theidempotency_keyquery column all show the user-provided key. That is what leads people to send a value reset cannot match.