FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

src: expose `node::RegisterContext` to make a node managed context · nodejs/node@26f677c · GitHub

/ node Public

Commit 26f677c

Browse files
legendecas
authored and
sxa
committed
src: expose node::RegisterContext to make a node managed context
Signed-off-by: Chengzhong Wu <cwu631@bloomberg.net> PR-URL: #62322 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
1 parent 288c320 commit 26f677c

7 files changed

Lines changed: 176 additions & 0 deletions

File tree

‎src/api/environment.cc‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
#if HAVE_OPENSSL
33
#include "crypto/crypto_util.h"
44
#endif // HAVE_OPENSSL
5+
#include "env.h"
56
#include "env_properties.h"
67
#include "node.h"
78
#include "node_builtins.h"
@@ -1075,6 +1076,18 @@ Maybe<bool> InitializeContext(Local<Context> context) {
10751076
return Just(true);
10761077
}
10771078

1079+
void RegisterContext(Environment* env,
1080+
v8::Local<v8::Context> context,
1081+
std::string_view name,
1082+
std::string_view origin) {
1083+
ContextInfo info{std::string(name), std::string(origin)};
1084+
env->AssignToContext(context, nullptr, info);
1085+
}
1086+
1087+
void UnregisterContext(Environment* env, v8::Local<v8::Context> context) {
1088+
env->UnassignFromContext(context);
1089+
}
1090+
10781091
uv_loop_t* GetCurrentEventLoop(Isolate* isolate) {
10791092
HandleScope handle_scope(isolate);
10801093
Local<Context> context = isolate->GetCurrentContext();

‎src/env.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,8 @@ class NODE_EXTERN_PRIVATE IsolateData : public MemoryRetainer {
255255

256256
struct ContextInfo {
257257
explicit ContextInfo(const std::string& name) : name(name) {}
258+
ContextInfo(const std::string& name, const std::string& origin)
259+
: name(name), origin(origin) {}
258260
const std::string name;
259261
std::string origin;
260262
bool is_default = false;

‎src/node.h‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -608,6 +608,8 @@ NODE_EXTERN v8::Isolate* NewIsolate(
608608
const IsolateSettings& settings = {});
609609

610610
// Creates a new context with Node.js-specific tweaks.
611+
// Call `RegisterContext` after the context been created to register
612+
// the context with Node.js specific setups like the inspector.
611613
NODE_EXTERN v8::Local<v8::Context> NewContext(
612614
v8::Isolate* isolate,
613615
v8::Local<v8::ObjectTemplate> object_template =
@@ -617,6 +619,18 @@ NODE_EXTERN v8::Local<v8::Context> NewContext(
617619
// Return value indicates success of operation
618620
NODE_EXTERN v8::Maybe<bool> InitializeContext(v8::Local<v8::Context> context);
619621

622+
// Associate the context with the given Environment. This registers the context
623+
// as known to Node.js, makes it available to the inspector. This also registers
624+
// Node.js promise hooks on the context.
625+
NODE_EXTERN void RegisterContext(Environment* env,
626+
v8::Local<v8::Context> context,
627+
std::string_view name = "",
628+
std::string_view origin = "");
629+
// Unregister the context. Call this when the embedder finished all work with
630+
// this context.
631+
NODE_EXTERN void UnregisterContext(Environment* env,
632+
v8::Local<v8::Context> context);
633+
620634
// If `platform` is passed, it will be used to register new Worker instances.
621635
// It can be `nullptr`, in which case creating new Workers inside of
622636
// Environments that use this `IsolateData` will not work.

‎test/addons/new-context-inspector/binding.cc‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
#include <node.h>
2+
#include <v8.h>
3+
4+
namespace {
5+
6+
using v8::Context;
7+
using v8::FunctionCallbackInfo;
8+
using v8::HandleScope;
9+
using v8::Isolate;
10+
using v8::Local;
11+
using v8::Object;
12+
using v8::Script;
13+
using v8::String;
14+
using v8::Value;
15+
16+
void MakeContext(const FunctionCallbackInfo<Value>& args) {
17+
Isolate* isolate = Isolate::GetCurrent();
18+
HandleScope handle_scope(isolate);
19+
Local<Context> context = isolate->GetCurrentContext();
20+
node::Environment* env = node::GetCurrentEnvironment(context);
21+
assert(env);
22+
23+
// Create a new context with Node.js-specific setup.
24+
v8::MaybeLocal<Context> maybe_context = node::NewContext(isolate);
25+
v8::Local<Context> new_context;
26+
if (!maybe_context.ToLocal(&new_context)) {
27+
return;
28+
}
29+
node::RegisterContext(env, new_context, "Addon Context", "addon://about");
30+
31+
// Return the global proxy object.
32+
args.GetReturnValue().Set(new_context->Global());
33+
}
34+
35+
void RunInContext(const FunctionCallbackInfo<Value>& args) {
36+
Isolate* isolate = Isolate::GetCurrent();
37+
HandleScope handle_scope(isolate);
38+
assert(args.Length() == 2);
39+
40+
assert(args[0]->IsObject());
41+
Local<Object> global_proxy = args[0].As<Object>();
42+
v8::MaybeLocal<Context> maybe_context = global_proxy->GetCreationContext();
43+
v8::Local<Context> new_context;
44+
if (!maybe_context.ToLocal(&new_context)) {
45+
return;
46+
}
47+
Context::Scope context_scope(new_context);
48+
49+
assert(args[1]->IsString());
50+
Local<String> source = args[1].As<String>();
51+
Local<Script> script;
52+
Local<Value> result;
53+
54+
if (Script::Compile(new_context, source).ToLocal(&script) &&
55+
script->Run(new_context).ToLocal(&result)) {
56+
args.GetReturnValue().Set(result);
57+
}
58+
}
59+
60+
void Initialize(Local<Object> exports,
61+
Local<Value> module,
62+
Local<Context> context) {
63+
NODE_SET_METHOD(exports, "makeContext", MakeContext);
64+
NODE_SET_METHOD(exports, "runInContext", RunInContext);
65+
}
66+
67+
} // anonymous namespace
68+
69+
NODE_MODULE_CONTEXT_AWARE(NODE_GYP_MODULE_NAME, Initialize)

‎test/addons/new-context-inspector/binding.gyp‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
'targets': [
3+
{
4+
'target_name': 'binding',
5+
'sources': ['binding.cc'],
6+
'includes': ['../common.gypi'],
7+
},
8+
]
9+
}

‎test/addons/new-context-inspector/test-inspector.js‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
'use strict';
2+
3+
const common = require('../../common');
4+
common.skipIfInspectorDisabled();
5+
6+
const assert = require('node:assert');
7+
const { once } = require('node:events');
8+
const { Session } = require('node:inspector');
9+
10+
const binding = require(`./build/${common.buildType}/binding`);
11+
12+
const session = new Session();
13+
session.connect();
14+
15+
(async function() {
16+
const mainContextPromise =
17+
once(session, 'Runtime.executionContextCreated');
18+
session.post('Runtime.enable', assert.ifError);
19+
await mainContextPromise;
20+
21+
// Addon-created context should be reported to the inspector.
22+
{
23+
const addonContextPromise =
24+
once(session, 'Runtime.executionContextCreated');
25+
26+
const ctx = binding.makeContext();
27+
const result = binding.runInContext(ctx, '1 + 1');
28+
assert.strictEqual(result, 2);
29+
30+
const { 0: contextCreated } = await addonContextPromise;
31+
const { name, origin, auxData } = contextCreated.params.context;
32+
assert.strictEqual(name, 'Addon Context',
33+
JSON.stringify(contextCreated));
34+
assert.strictEqual(origin, 'addon://about',
35+
JSON.stringify(contextCreated));
36+
assert.strictEqual(auxData.isDefault, false,
37+
JSON.stringify(contextCreated));
38+
}
39+
40+
// `debugger` statement should pause in addon-created context.
41+
{
42+
session.post('Debugger.enable', assert.ifError);
43+
44+
const pausedPromise = once(session, 'Debugger.paused');
45+
const ctx = binding.makeContext();
46+
binding.runInContext(ctx, 'debugger');
47+
await pausedPromise;
48+
49+
session.post('Debugger.resume');
50+
}
51+
})().then(common.mustCall());

‎test/addons/new-context-inspector/test.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
'use strict';
2+
3+
const common = require('../../common');
4+
const assert = require('assert');
5+
6+
const binding = require(`./build/${common.buildType}/binding`);
7+
8+
// This verifies that the addon-created context has an independent
9+
// global object.
10+
{
11+
const ctx = binding.makeContext();
12+
const result = binding.runInContext(ctx, `
13+
globalThis.foo = 'bar';
14+
foo;
15+
`);
16+
assert.strictEqual(result, 'bar');
17+
assert.strictEqual(globalThis.foo, undefined);
18+
}

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL