util: add isArrayBufferDetached method #45512

anonrig · 2022-11-18T23:33:13Z

CC @nodejs/streams @nodejs/util @nodejs/performance

anonrig · 2022-11-18T23:36:38Z

CC @daeyeon, since he was the original author of this TODO.

nodejs-github-bot · 2022-11-18T23:55:35Z

CI: https://ci.nodejs.org/job/node-test-pull-request/48014/

lib/internal/webstreams/util.js

doc/api/util.md

tniessen · 2022-11-19T17:11:26Z

b) Should this really be a public API?

Adding to @addaleax's point, if there is justification for such a public API in Node.js, isn't there justification for such an API in any JavaScript runtime, in which case it would be better to find a compatible approach across runtimes?

anonrig · 2022-11-19T17:13:52Z

b) Should this really be a public API?

Adding to @addaleax's point, if there is justification for such a public API in Node.js, isn't there justification for such an API in any JavaScript runtime, in which case it would be better to find a compatible approach across runtimes?

I'm +0 on the public API. But I don't think there is a better & compatible approach across runtimes (for now), since WasDetached is not currently supported at Deno (using V8 10.9.194.1)

doc/api/util.md

lib/internal/webstreams/util.js

doc/api/util.md

lib/internal/util/types.js

ljharb · 2022-11-19T22:25:32Z

If a universal solution is desired, and there's compelling use cases for it, a JS language proposal seems appropriate.

mcollina · 2022-11-20T11:16:27Z

What's the use case for this? The PR description is empty.

doc/api/util.md

LiviaMedeiros · 2022-11-20T11:18:17Z

lib/internal/util/types.js

@@ -54,8 +57,16 @@ function isBigUint64Array(value) {
  return TypedArrayPrototypeGetSymbolToStringTag(value) === 'BigUint64Array';
 }

+function isArrayBufferDetached(value) {
+  if (ArrayBufferPrototypeGetByteLength(value) === 0) {


Should we do this before checking if value is an instance of ArrayBuffer?

If the user passes something that's not an ArrayBuffer, instead of returning false the function would throw a TypeError, which is surprising. We should at least document this behavior if we want to keep it (another option is to not expose it publicly and keep it internal, or expose a slower version that first checks if the parameter is an ArrayBuffer before calling the internal util).

jasnell · 2022-11-20T18:07:24Z

@mcollina:

What's the use case for this? The PR description is empty.

There are a few cases (e.g. in web streams) where we are required to check if the ArrayBuffer has been detached. Currently we only approximate the check by seeing if it is a zero-length ArrayBuffer, but that's really not quite accurate.

mcollina · 2022-11-20T19:17:00Z

If we need it only for our webstreams API, it would be better to:

only expose it internally
include those usages in the PR

LiviaMedeiros · 2022-11-21T11:04:18Z

If performance cost of checking if ArrayBuffer is detached will be negligible, it would make sense to widely use it in other parts of Node.js API.
In most cases, passing a view with detached buffer is meaningless and implies an error in userland code. Currently, the outcome depends on underlying implementation:

If it tries to use the buffer (e.g. make a new view with new Uint8Array(passedData.buffer), or a copy with passedData.slice()), the TypeError will be thrown.
Otherwise it's silently interpreted as zero-size buffer; for example, fs.writeFileSync(filePath, dataBuffer) will truncate file to zero if dataBuffer.buffer happens to be detached.

anonrig · 2022-11-21T22:39:41Z

I'm working with @ljharb on making a proposal to TC39 for detach and isDetached. Until, it is released, I wanted to give the option to both functionality to detach and detect isDetached to the userland. This is one of the first pull request, when/if merged, will be continued with detachArrayBuffer() functionality. Some of the reviews on this pull request was around why we should expose isDetached to the userland.

This particular question is better answered with the original ArrayBuffer.prototype.transfer() proposal.

aduh95 · 2022-11-21T22:56:50Z

lib/internal/util/types.js

@@ -54,8 +58,16 @@ function isBigUint64Array(value) {
  return TypedArrayPrototypeGetSymbolToStringTag(value) === 'BigUint64Array';
 }

+function isArrayBufferDetached(value) {
+  if (value instanceof ArrayBuffer && ArrayBufferPrototypeGetByteLength(value) === 0) {


I wouldn't be surprised if that instanceof check had a dramatic impact on performance.

Referencing: https://github.com/RafaelGSS/nodejs-bench-operations/blob/main/RESULTS-v19.md#comparison-using-instanceof

I can change it to value != null && ... , and expect .byteLength to be the differentiator.

I think the best course of action is to make an internal isArrayBufferDetached without any instanceof check, and if we have a public one, it would return value instanceof ArrayBuffer && internal.isArrayBufferDetached(value).

@aduh95 #45568

also, instanceof is brittle and can be forged, and doesn’t work cross-realm. In JS the way to check this is using the byteLength getter in a try/catch.

anonrig · 2022-12-03T00:51:27Z

I'm closing this pull request in favor of Array.prototype.detached proposal, which is currently in Stage 2.

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run. typings web streams labels Nov 18, 2022

anonrig force-pushed the feat/array-buffer-detached branch 2 times, most recently from 9f4da15 to 55484ba Compare November 18, 2022 23:40

anonrig mentioned this pull request Nov 18, 2022

stream: update todo message for detached buffers #45464

Closed

anonrig added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 18, 2022

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 18, 2022

daeyeon reviewed Nov 19, 2022

View reviewed changes

lib/internal/webstreams/util.js Show resolved Hide resolved

addaleax reviewed Nov 19, 2022

View reviewed changes

doc/api/util.md Outdated Show resolved Hide resolved

anonrig force-pushed the feat/array-buffer-detached branch from 55484ba to 5d284cf Compare November 19, 2022 17:10

anonrig force-pushed the feat/array-buffer-detached branch 3 times, most recently from 255977c to 81b13d1 Compare November 19, 2022 18:14

jasnell reviewed Nov 19, 2022

View reviewed changes

doc/api/util.md Outdated Show resolved Hide resolved

doc/api/util.md Show resolved Hide resolved

lib/internal/webstreams/util.js Show resolved Hide resolved

jasnell reviewed Nov 19, 2022

View reviewed changes

doc/api/util.md Outdated Show resolved Hide resolved

anonrig force-pushed the feat/array-buffer-detached branch from 81b13d1 to 4e614d5 Compare November 19, 2022 19:23

anonrig requested a review from jasnell November 19, 2022 20:02

aduh95 reviewed Nov 19, 2022

View reviewed changes

lib/internal/util/types.js Outdated Show resolved Hide resolved

util: add isArrayBufferDetached method

82d44f4

anonrig force-pushed the feat/array-buffer-detached branch from 4e614d5 to 82d44f4 Compare November 19, 2022 22:31

anonrig mentioned this pull request Nov 19, 2022

stream: use ArrayBufferPrototypeGetByteLength #45528

Merged

github-actions bot mentioned this pull request Nov 20, 2022

CI Reliability 2022-11-20 nodejs/reliability#434

Open

14 tasks

LiviaMedeiros reviewed Nov 20, 2022

View reviewed changes

github-actions bot mentioned this pull request Nov 21, 2022

CI Reliability 2022-11-21 nodejs/reliability#435

Open

15 tasks

fixup! util: add isArrayBufferDetached method

7aae649

anonrig force-pushed the feat/array-buffer-detached branch from 320ce8b to b1bf33f Compare November 21, 2022 22:00

anonrig added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Nov 21, 2022

test: add util.types tests

f207b32

anonrig force-pushed the feat/array-buffer-detached branch from b1bf33f to f207b32 Compare November 21, 2022 22:34

aduh95 reviewed Nov 21, 2022

View reviewed changes

anonrig mentioned this pull request Nov 21, 2022

src: add internal isArrayBufferDetached #45568

Merged

This was referenced Nov 22, 2022

CI Reliability 2022-11-22 nodejs/reliability#436

Open

CI Reliability 2022-11-23 nodejs/reliability#437

Open

anonrig closed this Dec 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: add isArrayBufferDetached method #45512

util: add isArrayBufferDetached method #45512

anonrig commented Nov 18, 2022 •

edited

anonrig commented Nov 18, 2022

nodejs-github-bot commented Nov 18, 2022

tniessen commented Nov 19, 2022

anonrig commented Nov 19, 2022

ljharb commented Nov 19, 2022

mcollina commented Nov 20, 2022

LiviaMedeiros Nov 20, 2022

aduh95 Nov 21, 2022

jasnell commented Nov 20, 2022

mcollina commented Nov 20, 2022

LiviaMedeiros commented Nov 21, 2022

anonrig commented Nov 21, 2022

aduh95 Nov 21, 2022 •

edited

anonrig Nov 21, 2022

aduh95 Nov 21, 2022

anonrig Nov 21, 2022

ljharb Nov 22, 2022

anonrig commented Dec 3, 2022

util: add isArrayBufferDetached method #45512

util: add isArrayBufferDetached method #45512

Conversation

anonrig commented Nov 18, 2022 • edited

anonrig commented Nov 18, 2022

nodejs-github-bot commented Nov 18, 2022

tniessen commented Nov 19, 2022

anonrig commented Nov 19, 2022

ljharb commented Nov 19, 2022

mcollina commented Nov 20, 2022

LiviaMedeiros Nov 20, 2022

Choose a reason for hiding this comment

aduh95 Nov 21, 2022

Choose a reason for hiding this comment

jasnell commented Nov 20, 2022

mcollina commented Nov 20, 2022

LiviaMedeiros commented Nov 21, 2022

anonrig commented Nov 21, 2022

aduh95 Nov 21, 2022 • edited

Choose a reason for hiding this comment

anonrig Nov 21, 2022

Choose a reason for hiding this comment

aduh95 Nov 21, 2022

Choose a reason for hiding this comment

anonrig Nov 21, 2022

Choose a reason for hiding this comment

ljharb Nov 22, 2022

Choose a reason for hiding this comment

anonrig commented Dec 3, 2022

anonrig commented Nov 18, 2022 •

edited

aduh95 Nov 21, 2022 •

edited