Add support for in-band syncing #702
Conversation
🦋 Changeset detectedLatest commit: 86f259e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
| @@ -756,7 +760,7 @@ export class InngestCommHandler< | |||
| }), | |||
| methodP, | |||
| methodP.then((method) => { | |||
| if (method === "POST") { | |||
| if (method === "POST" || method === "PUT") { | |||
There was a problem hiding this comment.
PUT requests can be signed now, so we make sure to access the body here. Some frameworks will throw errors if you attempt to access the body of a request that cannot have one (like a GET), hence abstracting it here.
| Promise.resolve( | ||
| parseAsBoolean(this.env[envKeys.InngestAllowInBandSync]) | ||
| ) |
There was a problem hiding this comment.
Only consider in-band syncs if we're explicitly allowing it, otherwise always fall back to out-of-band.
| // Validation can be successful if we're in dev mode and did not | ||
| // actually validate a key. In this case, also check that we did indeed | ||
| // use a particular key to validate. | ||
| const sigCheck = await signatureValidation; |
There was a problem hiding this comment.
This is always true if the SDK's mode is "dev", but will fail if it's "cloud" and the request could not be validated.
| if (!sigCheck.success) { | ||
| return { | ||
| status: 401, |
There was a problem hiding this comment.
A failed validation when we are allowing an in-band sync and one has been requested is always a 401.
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## [email protected] ### Minor Changes - [#702](#702) [`4df5a01`](4df5a01) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Add support for in-band syncing ### Patch Changes - [#721](#721) [`59fa466`](59fa466) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Support Next.js 15 in serve handler typing Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Summary
Adds in-band sync support by returning different data based on whether a
PUTrequest is signed (and validated) or not.In draft while functionality is built out elsewhere.
Checklist
Added a docs PR that references this PRN/A Accounted for elsewhereRelated