-
Notifications
You must be signed in to change notification settings - Fork 322
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #208 from cloudflare/jsnell/async-context-tracking
- Loading branch information
Showing
16 changed files
with
1,197 additions
and
55 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Imports the base schema for workerd configuration files. | ||
|
|
||
| # Refer to the comments in /src/workerd/server/workerd.capnp for more details. | ||
|
|
||
| using Workerd = import "/workerd/workerd.capnp"; | ||
|
|
||
| # A constant of type Workerd.Config defines the top-level configuration for an | ||
| # instance of the workerd runtime. A single config file can contain multiple | ||
| # Workerd.Config definitions and must have at least one. | ||
| const helloWorldExample :Workerd.Config = ( | ||
|
|
||
| # Every workerd instance consists of a set of named services. A worker, for instance, | ||
| # is a type of service. Other types of services can include external servers, the | ||
| # ability to talk to a network, or accessing a disk directory. Here we create a single | ||
| # worker service. The configuration details for the worker are defined below. | ||
| services = [ (name = "main", worker = .helloWorld) ], | ||
|
|
||
| # Every configuration defines the one or more sockets on which the server will listene. | ||
| # Here, we create a single socket that will listen on localhost port 8080, and will | ||
| # dispatch to the "main" service that we defined above. | ||
| sockets = [ ( name = "http", address = "*:8080", http = (), service = "main" ) ] | ||
| ); | ||
|
|
||
| # The definition of the actual helloWorld worker exposed using the "main" service. | ||
| # In this example the worker is implemented as a single simple script (see worker.js). | ||
| # The compatibilityDate is required. For more details on compatibility dates see: | ||
| # https://developers.cloudflare.com/workers/platform/compatibility-dates/ | ||
|
|
||
| const helloWorld :Workerd.Worker = ( | ||
| modules = [ | ||
| (name = "worker", esModule = embed "worker.js") | ||
| ], | ||
| compatibilityDate = "2022-11-08", | ||
| compatibilityFlags = ["nodejs_18_compat_experimental"] | ||
| ); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import { default as async_hooks } from 'node:async_hooks'; | ||
| const { AsyncLocalStorage, AsyncResource } = async_hooks; | ||
|
|
||
| const als = new AsyncLocalStorage(); | ||
|
|
||
| export default { | ||
| async fetch(request) { | ||
| const differentScope = als.run(123, () => AsyncResource.bind(() => { | ||
| console.log(als.getStore()); | ||
| })); | ||
|
|
||
| return als.run("Hello World", async () => { | ||
|
|
||
| // differentScope is attached to a different async context, so | ||
| // it will see a different value for als.getStore() (123) | ||
| setTimeout(differentScope, 5); | ||
|
|
||
| // Some simulated async delay. | ||
| await scheduler.wait(10); | ||
| return new Response(als.getStore()); // "Hello World" | ||
| }); | ||
| } | ||
| }; |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| // Copyright (c) 2017-2022 Cloudflare, Inc. | ||
| // Licensed under the Apache 2.0 license found in the LICENSE file or at: | ||
| // https://opensource.org/licenses/Apache-2.0 | ||
| #include "async-hooks.h" | ||
| #include <kj/vector.h> | ||
|
|
||
| namespace workerd::api::node { | ||
|
|
||
| jsg::Ref<AsyncLocalStorage> AsyncLocalStorage::constructor(jsg::Lock& js) { | ||
| return jsg::alloc<AsyncLocalStorage>(); | ||
| } | ||
|
|
||
| v8::Local<v8::Value> AsyncLocalStorage::run( | ||
| jsg::Lock& js, | ||
| v8::Local<v8::Value> store, | ||
| v8::Local<v8::Function> callback, | ||
| jsg::Varargs args) { | ||
| kj::Vector<v8::Local<v8::Value>> argv(args.size()); | ||
| for (auto arg : args) { | ||
| argv.add(arg.getHandle(js)); | ||
| } | ||
|
|
||
| auto context = js.v8Isolate->GetCurrentContext(); | ||
|
|
||
| jsg::AsyncContextFrame::StorageScope scope(js, *key, js.v8Ref(store)); | ||
|
|
||
| return jsg::check(callback->Call( | ||
| context, | ||
| context->Global(), | ||
| argv.size(), | ||
| argv.begin())); | ||
| } | ||
|
|
||
| v8::Local<v8::Value> AsyncLocalStorage::exit( | ||
| jsg::Lock& js, | ||
| v8::Local<v8::Function> callback, | ||
| jsg::Varargs args) { | ||
| // Node.js defines exit as running "a function synchronously outside of a context". | ||
| // It goes on to say that the store is not accessible within the callback or the | ||
| // asynchronous operations created within the callback. Any getStore() call done | ||
| // within the callbackfunction will always return undefined... except if run() is | ||
| // called which implicitly enables the context again within that scope. | ||
| // | ||
| // We do not have to emulate Node.js enable/disable behavior since we are not | ||
| // implementing the enterWith/disable methods. We can emulate the correct | ||
| // behavior simply by calling run with the store value set to undefined, which | ||
| // will propagate correctly. | ||
| return run(js, v8::Undefined(js.v8Isolate), callback, kj::mv(args)); | ||
| } | ||
|
|
||
| v8::Local<v8::Value> AsyncLocalStorage::getStore(jsg::Lock& js) { | ||
| KJ_IF_MAYBE(value, jsg::AsyncContextFrame::current(js).get(*key)) { | ||
| return value->getHandle(js); | ||
| } | ||
| return v8::Undefined(js.v8Isolate); | ||
| } | ||
|
|
||
| AsyncResource::AsyncResource(jsg::Lock& js) | ||
| : frame(kj::addRef(jsg::AsyncContextFrame::current(js))) {} | ||
|
|
||
| jsg::Ref<AsyncResource> AsyncResource::constructor( | ||
| jsg::Lock& js, | ||
| jsg::Optional<kj::String> type, | ||
| jsg::Optional<Options> options) { | ||
| // The type and options are required as part of the Node.js API compatibility | ||
| // but our implementation does not currently make use of them at all. It is ok | ||
| // for us to silently ignore both here. | ||
| return jsg::alloc<AsyncResource>(js); | ||
| } | ||
|
|
||
| v8::Local<v8::Function> AsyncResource::staticBind( | ||
| jsg::Lock& js, | ||
| v8::Local<v8::Function> fn, | ||
| jsg::Optional<kj::String> type, | ||
| jsg::Optional<v8::Local<v8::Value>> thisArg, | ||
| const jsg::TypeHandler<jsg::Ref<AsyncResource>>& handler) { | ||
| return AsyncResource::constructor(js, kj::mv(type) | ||
| .orDefault([] { return kj::str("AsyncResource"); })) | ||
| ->bind(js, fn, thisArg, handler); | ||
| } | ||
|
|
||
| v8::Local<v8::Function> AsyncResource::bind( | ||
| jsg::Lock& js, | ||
| v8::Local<v8::Function> fn, | ||
| jsg::Optional<v8::Local<v8::Value>> thisArg, | ||
| const jsg::TypeHandler<jsg::Ref<AsyncResource>>& handler) { | ||
| auto& frame = jsg::AsyncContextFrame::current(js); | ||
| v8::Local<v8::Function> bound = jsg::AsyncContextFrame::wrap(js, fn, frame, thisArg); | ||
|
|
||
| // Per Node.js documentation (https://nodejs.org/dist/latest-v19.x/docs/api/async_context.html#asyncresourcebindfn-thisarg), the returned function "will have an | ||
| // asyncResource property referencing the AsyncResource to which the function | ||
| // is bound". | ||
| jsg::check(bound->Set(js.v8Isolate->GetCurrentContext(), | ||
| jsg::v8StrIntern(js.v8Isolate, "asyncResource"_kj), | ||
| handler.wrap(js, JSG_THIS))); | ||
| return bound; | ||
| } | ||
|
|
||
| v8::Local<v8::Value> AsyncResource::runInAsyncScope( | ||
| jsg::Lock& js, | ||
| v8::Local<v8::Function> fn, | ||
| jsg::Optional<v8::Local<v8::Value>> thisArg, | ||
| jsg::Varargs args) { | ||
| kj::Vector<v8::Local<v8::Value>> argv(args.size()); | ||
| for (auto arg : args) { | ||
| argv.add(arg.getHandle(js)); | ||
| } | ||
|
|
||
| auto context = js.v8Isolate->GetCurrentContext(); | ||
|
|
||
| jsg::AsyncContextFrame::Scope scope(js, *frame); | ||
|
|
||
| return jsg::check(fn->Call( | ||
| context, | ||
| thisArg.orDefault(context->Global()), | ||
| argv.size(), | ||
| argv.begin())); | ||
| } | ||
|
|
||
| } // namespace workerd::api::node |
Oops, something went wrong.