Experimental `getAsyncCtx()` #776

jpwilliams · 2024-12-10T16:48:19Z

Summary

Adds a new getAsyncCtx() function exported from "inngest/experimental" that will attempt to retrieve the function input arguments.

Uses @inngest/test@workspace:^ internally, exclusively for the inngest package. This can be a bit weird, as inngest is a peer dep of @inngest/test so typing can be flaky.
Altered exports of @inngest/test to have simpler compilation and publishing.
Added the experimental getAsyncCtx()

import { getAsyncCtx } from "inngest/experimental";

const ctx = await getAsyncCtx();

Questions

Should we remove the store for a particular execution context when the run completes?
No. It will still be garbage collected and info may still be useful.

Checklist

~~Added a docs PR that references this PR~~ N/A Experimental for now
Added unit/integration tests
Added changesets if applicable

changeset-bot · 2024-12-10T16:48:23Z

🦋 Changeset detected

Latest commit: 0796d70

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
inngest	Minor
@inngest/test	Patch

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

inngest-release-bot · 2024-12-10T16:50:37Z

A user has added the prerelease/inngest label, so this PR will be published to npm with the tag pr-776. It will be updated with the latest changes as you push commits to this PR.

You can install this prerelease version with:

npm install inngest@pr-776

The last release was built and published from 0796d70.

This reverts commit fecd8b3.

These are regexes; `"inngest"` alone was causing us to route anything containing `"inngest"` to `src/`, which breaks imports of local `@inngest/test` packages.

pnpm is a pain at not sharing versions between packages with differing peer dependencies, resulting in packages utilizing >1 `inngest` package internally. This is exclusive to our monorepo here; in userland, the same package will be shared.

jpwilliams · 2024-12-11T17:41:30Z

.github/actions/setup-and-build/action.yml

+    - name: Build test dependencies
+      if: ${{ inputs.install-dependencies == 'true' }}
+      run: pnpm run build
+      shell: bash
+      working-directory: ${{ inputs.working-directory }}/packages/test


inngest now relies on @inngest/test@workspace:^, so we make sure that's built during CI too.

jpwilliams · 2024-12-11T17:42:05Z

packages/inngest/jest.config.js

@@ -6,7 +6,7 @@ module.exports = {
  roots: ["<rootDir>/src"],
  moduleNameMapper: {
    "(\\..+)\\.js": "$1",
-    inngest: "<rootDir>/src",
+    "^inngest$": "<rootDir>/src",


This regex was picking up anything containing inngest and redirecting it to src/ - bit of a problem when importing @inngest/test!

jpwilliams · 2024-12-11T17:42:18Z

packages/inngest/jsr.json

@@ -17,6 +17,7 @@
  ],
  "exports": {
    ".": "./src/index.ts",
+    "./experimental": "./src/experimental.ts",


A new entrypoint to mark out experimental APIs.

jpwilliams · 2024-12-11T17:43:33Z

packages/inngest/src/components/execution/v1.ts

  private async startExecution(): Promise<void> {
-    /**
-     * Mutate input as neccessary based on middleware.
-     */
-    await this.transformInput();
+    return getAsyncLocalStorage().then((als) =>
+      als.run({ ctx: this.fnArg }, async (): Promise<void> => {


When executing, we now wrap the entire operation in our AsyncLocalStorage.run() call. This also ensures that middleware is included in the async chain.

jpwilliams · 2024-12-11T17:43:59Z

packages/inngest/src/components/execution/als.ts

+  // eslint-disable-next-line @typescript-eslint/no-misused-promises, no-async-promise-executor
+  als ??= new Promise<AsyncLocalStorageIsh>(async (resolve) => {
+    try {
+      const { AsyncLocalStorage } = await import("node:async_hooks");


Bun, Deno, and Node all expose this as node:async_hooks.

Cloudflare Workers requires a compatibility flag of node_compat or node_compat_v2. A singular node_als should be possible but doesn't currently work with any version of Wrangler.

In the case that these flags have not been specified, this AsyncLocalStorage instance will essentially become a no-op; no store will ever be returned and .run() will just run the function given directly.

Nice!

On a side note, how many lines of code would it take you to do this in go!?

als ??= new Promise<AsyncLocalStorageIsh>(async (resolve) => ...

jpwilliams · 2024-12-11T17:45:50Z

packages/inngest/src/components/execution/als.ts

+/**
+ * Retrieve the async context for the current execution.
+ */
+export const getAsyncCtx = async (): Promise<AsyncContext | undefined> => {
+  return getAsyncLocalStorage().then((als) => als.getStore());
+};


This is the only piece exposed to the public API, used to retrieve the input to the current function run.

jpwilliams · 2024-12-11T17:46:37Z

packages/inngest/src/components/execution/als.ts

+export interface AsyncContext {
+  ctx: Context.Any;
+}


If found, this is the value returned when a developer calls getAsyncCtx() in userland code. It will likely expand to contain more information over time.

tonyhb

This is AMAZING work!!!

@jpwilliams

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 - [#776](#776) [`0dbcc87`](0dbcc87) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Add experimental `getAsyncCtx()`, allowing the retrieval of a run's input (`event`, `step`, `runId`, etc) from the relevant async chain. ```ts import { getAsyncCtx } from "inngest/experimental"; const ctx = await getAsyncCtx(); ``` ### Patch Changes - [#776](#776) [`0dbcc87`](0dbcc87) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Use `@inngest/test@workspace:^` internally for testing ## @inngest/[email protected] ### Patch Changes - [#776](#776) [`0dbcc87`](0dbcc87) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Altered exports to now be namespaced by `./dist/`; if you have directly imported files from `@inngest/test`, you may need to change the imports - Updated dependencies \[[`0dbcc87`](0dbcc87), [`0dbcc87`](0dbcc87)]: - [email protected] Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

## Summary  Fixes `@inngest/test` releasing; there's no longer a `dist/` dir following #776. ## Checklist    - [ ] ~Added a [docs PR](https://github.com/inngest/website) that references this PR~ N/A CI fix - [ ] ~Added unit/integration tests~ N/A CI fix - [ ] ~Added changesets if applicable~ N/A CI fix ## Related       - Bug introduced in #776

jpwilliams added 2 commits December 10, 2024 16:30

Use ALS for retrieving run context

d1b0b54

Export getAsyncCtx within "inngest/experimental"

b09cae8

jpwilliams self-assigned this Dec 10, 2024

inngest-release-bot added the 📦 inngest Affects the `inngest` package label Dec 10, 2024

jpwilliams added 🧪 experimental The addition of a new experimental API, feature, or fix. prerelease/inngest Create snapshot releases for a PR for the "inngest" package. labels Dec 10, 2024

jpwilliams added 8 commits December 10, 2024 17:14

Set Hono/CFW compat mode

fecd8b3

Revert "Set Hono/CFW compat mode"

982c1b0

This reverts commit fecd8b3.

Make node:async_hooks import safer

493be7c

Fix @inngest/test automatic spying not accounting for step.**

8238151

Move @inngest/test package out of dist/ for easier referencing

104fa51

Use @inngest/test@workspace:^ for internal testing

1da3262

Fix bad inngest referencing

22765b7

These are regexes; `"inngest"` alone was causing us to route anything containing `"inngest"` to `src/`, which breaks imports of local `@inngest/test` packages.

Add ALS tests

c44a9e6

inngest-release-bot added 📦 @inngest/middleware-validation 📦 @inngest/test labels Dec 11, 2024

jpwilliams and others added 6 commits December 11, 2024 13:45

Create cyan-sheep-train.md

6b7b9a3

Create ten-rockets-float.md

bc31746

Create silver-dolls-mix.md

6982f8a

Create dull-students-wink.md

dee32d2

Ensure test dependencies are built when setting up CI

e8c02dc

Fix silly test type

1e57bc9

jpwilliams force-pushed the experimental/hooks branch from bc6573b to 1e57bc9 Compare December 11, 2024 14:19

jpwilliams added 4 commits December 11, 2024 14:24

Make sure we do a final install to link any pacages

d265244

Try using only @local

ec58bbd

Ugly fix for in-package tests

bafe07c

pnpm is a pain at not sharing versions between packages with differing peer dependencies, resulting in packages utilizing >1 `inngest` package internally. This is exclusive to our monorepo here; in userland, the same package will be shared.

Ensure test deps are used during @inngest/middleware-validation CI

82752ca

jpwilliams force-pushed the experimental/hooks branch from 95266b3 to 76f9e94 Compare December 11, 2024 17:33

Revert workspace rearrange

cf2da79

jpwilliams force-pushed the experimental/hooks branch from 76f9e94 to cf2da79 Compare December 11, 2024 17:38

jpwilliams commented Dec 11, 2024

View reviewed changes

jpwilliams and others added 2 commits December 11, 2024 17:56

Merge branch 'main' into experimental/hooks

0d73a20

Merge branch 'main' into experimental/hooks

0796d70

jacobheric approved these changes Dec 11, 2024

View reviewed changes

tonyhb approved these changes Dec 12, 2024

View reviewed changes

jpwilliams merged commit 0dbcc87 into main Dec 12, 2024
51 checks passed

jpwilliams deleted the experimental/hooks branch December 12, 2024 15:51

inngest-release-bot mentioned this pull request Dec 12, 2024

Release @latest #780

Merged

jpwilliams mentioned this pull request Dec 12, 2024

Fix @inngest/test release; no dist/ dir #782

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Experimental `getAsyncCtx()` #776

Experimental `getAsyncCtx()` #776

jpwilliams commented Dec 10, 2024 •

edited

Loading

changeset-bot bot commented Dec 10, 2024 •

edited

Loading

inngest-release-bot commented Dec 10, 2024 •

edited

Loading

jpwilliams Dec 11, 2024

jpwilliams Dec 11, 2024

jpwilliams Dec 11, 2024

jpwilliams Dec 11, 2024

jpwilliams Dec 11, 2024

jacobheric Dec 11, 2024

jpwilliams Dec 11, 2024

jpwilliams Dec 11, 2024

tonyhb left a comment

Experimental getAsyncCtx() #776

Experimental getAsyncCtx() #776

Conversation

jpwilliams commented Dec 10, 2024 • edited Loading

Summary

Questions

Checklist

changeset-bot bot commented Dec 10, 2024 • edited Loading

🦋 Changeset detected

inngest-release-bot commented Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonyhb left a comment

Choose a reason for hiding this comment

Experimental `getAsyncCtx()` #776

Experimental `getAsyncCtx()` #776

jpwilliams commented Dec 10, 2024 •

edited

Loading

changeset-bot bot commented Dec 10, 2024 •

edited

Loading

inngest-release-bot commented Dec 10, 2024 •

edited

Loading