V3 #294
Merged
V3 #294
Conversation
This file contains 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
## Summary <!-- Succinctly describe your change, providing context, what you've changed, and why. --> Adds backwards compatibility for in-progress `v2.x.x` runs for `v3.x.x` SDKs. - [x] Adding `x-inngest-req-version` header appropriately from response - [x] `v0.test.ts` - [ ] ~~Lazily importing backwards compatibility~~ N/A Tiny foot-print; can optionally add later ## Checklist <!-- Tick these items off as you progress. --> <!-- If an item isn't applicable, ideally please strikeout the item by wrapping it in "~~"" and suffix it with "N/A My reason for skipping this." --> <!-- e.g. "- [ ] ~~Added tests~~ N/A Only touches docs" --> - [ ] ~~Added a [docs PR](https://github.com/inngest/website) that references this PR~~ N/A - [x] Added unit/integration tests - [ ] ~~Added changesets if applicable~~ N/A ## Related <!-- A space for any related links, issues, or PRs. --> <!-- Linear issues are autolinked. --> <!-- e.g. - INN-123 --> <!-- GitHub issues/PRs can be linked using shorthand. --> <!-- e.g. "- inngest/inngest#123" --> <!-- Feel free to remove this section if there are no applicable related links.--> - #294
Merged
jpwilliams
pushed a commit
that referenced
this pull request
Oct 4, 2023
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 ## inngest@3.0.0 ### Major Changes - [#294](#294) [`f2f4856`](f2f4856) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Clients and functions now require IDs When instantiating a client using `new Inngest()` or creating a function via `inngest.createFunction()`, it's now required to pass an `id` instead of a `name`. Previously only `name` was required, but this implied that the value was safe to change. Internally, we used this name to _produce_ an ID which was used during deployments and executions. See the [v3 migration guide](https://www.inngest.com/docs/sdk/migration). - [#294](#294) [`f2f4856`](f2f4856) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Refactored available environment variables and configuration The arrangement of environment variables available has shifted a lot over the course of v2, so in v3 we've streamlined what's available and how they're used. See the [v3 migration guide](https://www.inngest.com/docs/sdk/migration). - [#294](#294) [`f2f4856`](f2f4856) Thanks [@jpwilliams](https://github.com/jpwilliams)! - In v2, providing a `fns` option when creating a function -- an object of functions -- would wrap those passed functions in `step.run()`, meaning you can run code inside your function without the `step.run()` boilerplate. This wasn't a very well advertised feature and had some drawbacks, so we're instead replacing it with some optional middleware. See the [v3 migration guide](https://www.inngest.com/docs/sdk/migration). - [#294](#294) [`f2f4856`](f2f4856) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Serving functions could become a bit unwieldy with the format we had, so we've slightly altered how you serve your functions to ensure proper discoverability of options and aid in readability when revisiting the code. See the [v3 migration guide](https://www.inngest.com/docs/sdk/migration). - [#294](#294) [`f2f4856`](f2f4856) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Shorthand function creation removed `inngest.createFunction()` can no longer take a string as the first or second arguments; an object is now required to aid in the discoverability of options and configuration. See the [v3 migration guide](https://www.inngest.com/docs/sdk/migration). - [#294](#294) [`f2f4856`](f2f4856) Thanks [@jpwilliams](https://github.com/jpwilliams)! - All steps require IDs When using any step.\* tool, an ID is now required to ensure that determinism across changes to a function is easier to reason about for the user and the underlying engine. The addition of these IDs allows you to deploy hotfixes and logic changes to long-running functions without fear of errors, failures, or panics. Beforehand, any changes to a function resulted in an irrecoverable error if step definitions changed. With this, changes to a function are smartly applied by default. See the [v3 migration guide](https://www.inngest.com/docs/sdk/migration). ### Patch Changes - [#333](#333) [`67bda66`](67bda66) Thanks [@goodoldneon](https://github.com/goodoldneon)! - (Internal) Fix missing name on `NonRetriableError`, ensuring it's correctly (de)serialized Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This was referenced Oct 6, 2023
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.
Summary
Checklist
Related