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

src: implement structuredClone in native · nodejs/node@c3a41d8 · GitHub

/ node Public

Commit c3a41d8

Browse files
joyeecheung
authored
src: implement structuredClone in native
Simplify the implementation by implementing it directly in C++. This improves performance and also makes structuredClone supported in custom snapshots. PR-URL: #50330 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
1 parent b6bced8 commit c3a41d8

8 files changed

Lines changed: 150 additions & 82 deletions

File tree

‎benchmark/misc/structured-clone.js‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
'use strict';
2+
3+
const common = require('../common.js');
4+
const assert = require('assert');
5+
6+
const bench = common.createBenchmark(main, {
7+
type: ['string', 'object', 'arraybuffer'],
8+
n: [1e4],
9+
});
10+
11+
function main({ n, type }) {
12+
const data = [];
13+
14+
switch (type) {
15+
case 'string':
16+
for (let i = 0; i < n; ++i) {
17+
data.push(new Date().toISOString());
18+
}
19+
break;
20+
case 'object':
21+
for (let i = 0; i < n; ++i) {
22+
data.push({ ...process.config });
23+
}
24+
break;
25+
case 'arraybuffer':
26+
for (let i = 0; i < n; ++i) {
27+
data.push(new ArrayBuffer(10));
28+
}
29+
break;
30+
default:
31+
throw new Error('Unsupported payload type');
32+
}
33+
34+
const run = type === 'arraybuffer' ? (i) => {
35+
data[i] = structuredClone(data[i], { transfer: [ data[i] ] });
36+
} : (i) => {
37+
data[i] = structuredClone(data[i]);
38+
};
39+
40+
bench.start();
41+
for (let i = 0; i < n; ++i) {
42+
run(i);
43+
}
44+
bench.end(n);
45+
assert.strictEqual(data.length, n);
46+
}

‎lib/.eslintrc.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ rules:
172172
- name: setTimeout
173173
message: Use `const { setTimeout } = require('timers');` instead of the global.
174174
- name: structuredClone
175-
message: Use `const { structuredClone } = require('internal/structured_clone');` instead of the global.
175+
message: Use `const { structuredClone } = internalBinding('messaging');` instead of the global.
176176
- name: SubtleCrypto
177177
message: Use `const { SubtleCrypto } = require('internal/crypto/webcrypto');` instead of the global.
178178
no-restricted-modules:

‎lib/internal/bootstrap/web/exposed-window-or-worker.js‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,8 @@ const {
3131
} = require('internal/process/task_queues');
3232
defineOperation(globalThis, 'queueMicrotask', queueMicrotask);
3333

34-
defineLazyProperties(
35-
globalThis,
36-
'internal/structured_clone',
37-
['structuredClone'],
38-
);
34+
const { structuredClone } = internalBinding('messaging');
35+
defineOperation(globalThis, 'structuredClone', structuredClone);
3936
defineLazyProperties(globalThis, 'buffer', ['atob', 'btoa']);
4037

4138
// https://html.spec.whatwg.org/multipage/web-messaging.html#broadcasting-to-other-browsing-contexts

‎lib/internal/perf/usertiming.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ const {
3131
},
3232
} = require('internal/errors');
3333

34-
const { structuredClone } = require('internal/structured_clone');
34+
const { structuredClone } = internalBinding('messaging');
3535
const {
3636
lazyDOMException,
3737
kEnumerableProperty,

‎lib/internal/structured_clone.js‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎lib/internal/webstreams/readablestream.js‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,7 @@ const {
8585
kControllerErrorFunction,
8686
} = require('internal/streams/utils');
8787

88-
const {
89-
structuredClone,
90-
} = require('internal/structured_clone');
88+
const { structuredClone } = internalBinding('messaging');
9189

9290
const {
9391
ArrayBufferViewGetBuffer,

‎src/node_messaging.cc‎

Lines changed: 87 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1008,6 +1008,47 @@ static Maybe<bool> ReadIterable(Environment* env,
10081008
return Just(true);
10091009
}
10101010

1011+
bool GetTransferList(Environment* env,
1012+
Local<Context> context,
1013+
Local<Value> transfer_list_v,
1014+
TransferList* transfer_list_out) {
1015+
if (transfer_list_v->IsNullOrUndefined()) {
1016+
// Browsers ignore null or undefined, and otherwise accept an array or an
1017+
// options object.
1018+
return true;
1019+
}
1020+
1021+
if (!transfer_list_v->IsObject()) {
1022+
THROW_ERR_INVALID_ARG_TYPE(
1023+
env, "Optional transferList argument must be an iterable");
1024+
return false;
1025+
}
1026+
1027+
bool was_iterable;
1028+
if (!ReadIterable(env, context, *transfer_list_out, transfer_list_v)
1029+
.To(&was_iterable))
1030+
return false;
1031+
if (!was_iterable) {
1032+
Local<Value> transfer_option;
1033+
if (!transfer_list_v.As<Object>()
1034+
->Get(context, env->transfer_string())
1035+
.ToLocal(&transfer_option))
1036+
return false;
1037+
if (!transfer_option->IsUndefined()) {
1038+
if (!ReadIterable(env, context, *transfer_list_out, transfer_option)
1039+
.To(&was_iterable))
1040+
return false;
1041+
if (!was_iterable) {
1042+
THROW_ERR_INVALID_ARG_TYPE(
1043+
env, "Optional options.transfer argument must be an iterable");
1044+
return false;
1045+
}
1046+
}
1047+
}
1048+
1049+
return true;
1050+
}
1051+
10111052
void MessagePort::PostMessage(const FunctionCallbackInfo<Value>& args) {
10121053
Environment* env = Environment::GetCurrent(args);
10131054
Local<Object> obj = args.This();
@@ -1018,33 +1059,10 @@ void MessagePort::PostMessage(const FunctionCallbackInfo<Value>& args) {
10181059
"MessagePort.postMessage");
10191060
}
10201061

1021-
if (!args[1]->IsNullOrUndefined() && !args[1]->IsObject()) {
1022-
// Browsers ignore null or undefined, and otherwise accept an array or an
1023-
// options object.
1024-
return THROW_ERR_INVALID_ARG_TYPE(env,
1025-
"Optional transferList argument must be an iterable");
1026-
}
1027-
10281062
TransferList transfer_list;
1029-
if (args[1]->IsObject()) {
1030-
bool was_iterable;
1031-
if (!ReadIterable(env, context, transfer_list, args[1]).To(&was_iterable))
1032-
return;
1033-
if (!was_iterable) {
1034-
Local<Value> transfer_option;
1035-
if (!args[1].As<Object>()->Get(context, env->transfer_string())
1036-
.ToLocal(&transfer_option)) return;
1037-
if (!transfer_option->IsUndefined()) {
1038-
if (!ReadIterable(env, context, transfer_list, transfer_option)
1039-
.To(&was_iterable)) return;
1040-
if (!was_iterable) {
1041-
return THROW_ERR_INVALID_ARG_TYPE(env,
1042-
"Optional options.transfer argument must be an iterable");
1043-
}
1044-
}
1045-
}
1063+
if (!GetTransferList(env, context, args[1], &transfer_list)) {
1064+
return;
10461065
}
1047-
10481066
MessagePort* port = Unwrap<MessagePort>(args.This());
10491067
// Even if the backing MessagePort object has already been deleted, we still
10501068
// want to serialize the message to ensure spec-compliant behavior w.r.t.
@@ -1535,6 +1553,48 @@ static void SetDeserializerCreateObjectFunction(
15351553
env->set_messaging_deserialize_create_object(args[0].As<Function>());
15361554
}
15371555

1556+
static void StructuredClone(const FunctionCallbackInfo<Value>& args) {
1557+
Isolate* isolate = args.GetIsolate();
1558+
Local<Context> context = isolate->GetCurrentContext();
1559+
Realm* realm = Realm::GetCurrent(context);
1560+
Environment* env = realm->env();
1561+
1562+
if (args.Length() == 0) {
1563+
return THROW_ERR_MISSING_ARGS(env, "The value argument must be specified");
1564+
}
1565+
1566+
Local<Value> value = args[0];
1567+
1568+
TransferList transfer_list;
1569+
if (!args[1]->IsNullOrUndefined()) {
1570+
if (!args[1]->IsObject()) {
1571+
return THROW_ERR_INVALID_ARG_TYPE(
1572+
env, "The options argument must be either an object or undefined");
1573+
}
1574+
Local<Object> options = args[1].As<Object>();
1575+
Local<Value> transfer_list_v;
1576+
if (!options->Get(context, env->transfer_string())
1577+
.ToLocal(&transfer_list_v)) {
1578+
return;
1579+
}
1580+
1581+
// TODO(joyeecheung): implement this in JS land to avoid the C++ -> JS
1582+
// cost to convert a sequence into an array.
1583+
if (!GetTransferList(env, context, transfer_list_v, &transfer_list)) {
1584+
return;
1585+
}
1586+
}
1587+
1588+
std::shared_ptr<Message> msg = std::make_shared<Message>();
1589+
Local<Value> result;
1590+
if (msg->Serialize(env, context, value, transfer_list, Local<Object>())
1591+
.IsNothing() ||
1592+
!msg->Deserialize(env, context, nullptr).ToLocal(&result)) {
1593+
return;
1594+
}
1595+
args.GetReturnValue().Set(result);
1596+
}
1597+
15381598
static void MessageChannel(const FunctionCallbackInfo<Value>& args) {
15391599
Environment* env = Environment::GetCurrent(args);
15401600
if (!args.IsConstructCall()) {
@@ -1615,6 +1675,7 @@ static void InitMessaging(Local<Object> target,
16151675
"setDeserializerCreateObjectFunction",
16161676
SetDeserializerCreateObjectFunction);
16171677
SetMethod(context, target, "broadcastChannel", BroadcastChannel);
1678+
SetMethod(context, target, "structuredClone", StructuredClone);
16181679

16191680
{
16201681
Local<Function> domexception = GetDOMException(context).ToLocalChecked();
@@ -1638,6 +1699,7 @@ static void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
16381699
registry->Register(MessagePort::ReceiveMessage);
16391700
registry->Register(MessagePort::MoveToContext);
16401701
registry->Register(SetDeserializerCreateObjectFunction);
1702+
registry->Register(StructuredClone);
16411703
}
16421704

16431705
} // anonymous namespace

‎test/parallel/test-structuredClone-global.js‎

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,17 @@
1-
// Flags: --expose-internals
21
'use strict';
3-
/* eslint-disable no-global-assign */
42

53
require('../common');
4+
const assert = require('assert');
65

7-
const {
8-
structuredClone: _structuredClone,
9-
} = require('internal/structured_clone');
6+
assert.throws(() => structuredClone(), { code: 'ERR_MISSING_ARGS' });
7+
assert.throws(() => structuredClone(undefined, ''), { code: 'ERR_INVALID_ARG_TYPE' });
8+
assert.throws(() => structuredClone(undefined, 1), { code: 'ERR_INVALID_ARG_TYPE' });
9+
assert.throws(() => structuredClone(undefined, { transfer: 1 }), { code: 'ERR_INVALID_ARG_TYPE' });
10+
assert.throws(() => structuredClone(undefined, { transfer: '' }), { code: 'ERR_INVALID_ARG_TYPE' });
1011

11-
const {
12-
strictEqual,
13-
throws,
14-
} = require('assert');
15-
16-
strictEqual(globalThis.structuredClone, _structuredClone);
17-
structuredClone = undefined;
18-
strictEqual(globalThis.structuredClone, undefined);
19-
20-
// Restore the value for the known globals check.
21-
structuredClone = _structuredClone;
22-
23-
throws(() => _structuredClone(), /ERR_MISSING_ARGS/);
12+
// Options can be null or undefined.
13+
assert.strictEqual(structuredClone(undefined), undefined);
14+
assert.strictEqual(structuredClone(undefined, null), undefined);
15+
// Transfer can be null or undefined.
16+
assert.strictEqual(structuredClone(undefined, { transfer: null }), undefined);
17+
assert.strictEqual(structuredClone(undefined, { }), undefined);

0 commit comments

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