fix(dts): add missing types to support resizable arraybuffer #54637

indrajitbnikam · 2023-06-13T17:12:21Z

I am opening this PR to fix the missing(not updated) type for ArrayBuffer. This PR is being raised due to this discussion in denoland/deno issue here.

src/lib/es5.d.ts

indrajitbnikam · 2023-06-13T17:17:31Z

@microsoft-github-policy-service agree

indrajitbnikam · 2023-06-13T17:29:24Z

Also, Can you help me understand how to fix this test case? https://github.com/microsoft/TypeScript/actions/runs/5258441307/jobs/9502673967?pr=54637#step:5:137

Josh-Cena

You should be adding this to esnext.d.ts, not es5.
You need to do the same for SharedArrayBuffer.

fatcerberus · 2023-06-14T01:03:23Z

You should be adding this to esnext.d.ts, not es5.

Now that you mention it, why is ArrayBuffer defined in es5 instead of es2015?

indrajitbnikam · 2023-06-14T01:27:12Z

What exactly do you want me to add to esnext.d.ts? All the ArrayBuffer-related types?

It is just referencing other libs at the moment.

Most of the types lie in es5.d.ts.

Also, SharedArrayBuffer is located in es2017.sharedmemory.d.ts. Are any changes required for SharedArrayBuffer such as where should it be?

Josh-Cena · 2023-06-14T02:03:29Z

why is ArrayBuffer defined in es5 instead of es2015?

Because... ArrayBuffer is es5? For example it was first in Chrome v7, far before es6.

What exactly do you want me to add to esnext.d.ts?

If you use lib: "es2017" then you will be forbidden to use anything later than that. This is the way TS ensures you don't use things your runtime doesn't support. You would add the resizing-related APIs to esnext, and then declaration merging will make both the base types and the new APIs available for lib: "esnext" users. For example, you can take a look at how the array methods are split across almost every ES version.

fatcerberus · 2023-06-14T02:22:30Z

Because... ArrayBuffer is es5?

It’s not. It’s not mentioned anywhere in the ES5.1 spec AFAICT and I specifically remember it not being supported in many ES5 engines such as Duktape until it got standardized with ES6, which was a pain point for me at the time.

Josh-Cena · 2023-06-14T02:32:03Z

Mmm, you are right—it's implemented around 2010, which is after ES5 already. Still it does seem older than most ES6 APIs (Promise, Map, Symbol, etc.)

petamoriken · 2023-06-14T14:38:37Z

@indrajitbnikam TypeScript's interface can be typedefs as patches from a separate d.ts file.

How about the following:

Create a new esnext.arraybuffer.d.ts file and write interface for ResizableArrayBuffer and GrowableSharedArrayBuffer
Add /// <reference lib="esnext.arraybuffer" /> to esnext.d.ts

petamoriken · 2023-06-14T14:54:32Z

It’s not. It’s not mentioned anywhere in the ES5.1 spec AFAICT and I specifically remember it not being supported in many ES5 engines such as Duktape until it got standardized with ES6, which was a pain point for me at the time.

Historically ArrayBuffer was defined by Khronos for WebGL and then moved to ES2015. That's why ArrayBuffer can be used in IE11, which should only be implemented up to ES5.1. It is odd that it defined in es5.d.ts, but it is useful for web developers.

indrajitbnikam · 2023-06-14T16:25:42Z

I've made the changes locally but for some reason, Git is ignoring the newly added esnext.arraybuffer.d.ts file so can't push it. Can somebody help me understand why it is like this?

indrajitbnikam · 2023-06-14T16:27:32Z

Also, I was checking what all changes are there for other such files. I added these entries based on what I found. Let me know if I'm doing something wrong.

jakebailey · 2023-06-14T16:29:13Z

Adding an entirely new lib.d.ts file requires updating a few things, including src/lib/libs.json and libEntries in src/compiler/commandLineParser.ts.

indrajitbnikam · 2023-06-14T16:33:16Z

Hi @jakebailey I've changed these files as you can see in my comment above.

jakebailey · 2023-06-14T16:35:29Z

Ah, sorry, missed the second message.

The errors in the editor are necessarily provided by the version of TypeScript provided by VS Code or in node_modules, so you're going to get that message unless you change VS Code to a local build (or this change is released).

As for the git problem, it's likely that I broke something in .gitignore when I removed the top level lib dir. Let me go check.

jakebailey · 2023-06-14T16:38:11Z

Yep, my bad. Sent #54644.

jakebailey · 2023-06-14T16:43:42Z

For now, you can manually git add it by force.

indrajitbnikam · 2023-06-14T16:54:23Z

Thanks for clarifying so quickly 😊

src/compiler/commandLineParser.ts

…yBuffer types

indrajitbnikam · 2023-06-14T17:22:05Z

Also, I have another question about these already existing types,

Have a look at this slice() method signature.

Existing code

TypeScript/src/lib/es2017.sharedmemory.d.ts

Line 13 in aa44cd8

slice(begin: number, end?: number): SharedArrayBuffer;

MDN Doc (here)

How to cover this scenario?

indrajitbnikam · 2023-06-14T17:27:00Z

Should I do it the way I've done it over here for all missing constructor signatures for SharedArrayBuffer?

Frankly speaking, I think this can be fixed with a single type as follows.

interface SharedArrayBufferConstructor {
  new(byteLength?: number, options?: SharedArrayBufferOptions): SharedArrayBuffer
}

What do you think?

petamoriken · 2023-06-15T19:42:23Z

Since ES2017, not only TypedArray but also ArrayBuffer ~~and DataView~~ constructors are allowed to be empty.

tc39/ecma262#410

So to modify es2017.sharedmemory.d.ts and to add new es2017.arraybuffer.d.ts and es2017.dataview.d.ts are make sense for me.

petamoriken · 2023-06-17T13:06:20Z

@indrajitbnikam

Do you want me to do that change or we are just discussing it?

This is just my opinion, I think there needs to be a decision by TypeScript members.

Also, I'm not sure how to fix the failing tests. Can you help me understand it?

The baseline test seems to be failed.

Baselines are used to manage if there are any changes in the expected output of the TypeScript compiler. Baselines are located in tests/baselines.

Run the tests: hereby runtests-parallel
Check baseline changes: git diff --diff-filter=AM --no-index ./tests/baselines/reference ./tests/baselines/local
Accept baseline changes: hereby baseline-accept

Please see https://github.com/microsoft/TypeScript/blob/main/CONTRIBUTING.md#managing-the-baselines

indrajitbnikam · 2023-06-17T17:41:07Z

Hi @petamoriken,

This is just my opinion, I think there needs to be a decision by TypeScript members.

Ohh, I get it.

By the way, Thanks a lot for helping me understand why tests were failing. I had missed reading that section of CONTRIBUTING.md file. I would have never realized the issue, at least not this fast.

indrajitbnikam · 2023-06-17T17:49:58Z

Hi @petamoriken

Can you help me understand what should be described here in this related issue for this PR?

Should it be ESnext as we are adding our patch to the esnext files?

petamoriken · 2023-06-18T12:12:08Z

Should it be ESnext as we are adding our patch to the esnext files?

Yes, that's right.

indrajitbnikam · 2023-06-19T14:59:49Z

Hi @fatcerberus @Josh-Cena @jakebailey , Can someone check the PR and let me know if I need to change something?

Josh-Cena

Mostly LGTM, with a note that the TS repo usually uses 4 spaces for indentation. But you really don't have to ping me for reviews; you can simply ask the team (which is i.e. Jake in the current thread :))

Josh-Cena · 2023-06-20T15:52:33Z

src/lib/esnext.arraybuffer.d.ts

+	/**
+	 * Read-only. The maximum length that this ArrayBuffer can be resized to (in bytes).
+	 */
+	readonly maxByteLength: number;


I suggest using get maxByteLength(): number unless the team thinks otherwise; ditto for the other occurences.

I've seen the readonly as well in multiple places. But yeah, let's wait for the team to comment on it.

I agree with @Josh-Cena, the spec example uses accessors, so it makes sense to do so here.

(It's quite likely that old readonlys should be changed to accessors, but that might break backward compatibility, eg classes extend lib interfaces and override properties.)

I agree with @Josh-Cena, the spec example uses accessors, so it makes sense to do so here.

(It's quite likely that old readonlys should be changed to accessors, but that might break backward compatibility, eg classes extend lib interfaces and override properties.)

That seems like a breaking change we might want to take, though perhaps only if we can find a way to only enable it when --useDefineForClassProperties is true or the target it sufficiently high enough to warrant it.

indrajitbnikam · 2023-06-20T16:15:52Z

Mostly LGTM, with a note that the TS repo usually uses 4 spaces for indentation. But you really don't have to ping me for reviews; you can simply ask the team (which is i.e. Jake in the current thread :))

Oh Sorry, did not realise that. Thanks for reviewing though 😊.

sandersn

This needs a test in tests/cases/conformance/esnext that shows off example uses of the new entries. The file should be named esnextArrayBuffer.ts or similar, and the first line should be

// @lib: esnext.arraybuffer

so that the test harness will use the right lib setting

sandersn · 2023-06-28T22:15:15Z

src/compiler/commandLineParser.ts

@@ -216,6 +216,7 @@ const libEntries: [string, string][] = [
    ["esnext.array", "lib.es2023.array.d.ts"],
    ["esnext.collection", "lib.es2023.collection.d.ts"],
    ["esnext.symbol", "lib.es2019.symbol.d.ts"],
+    ["esnext.arraybuffer", "lib.esnext.arraybuffer.d.ts"],


@rbuckton Do you have an opinion abut we should add a separate lib entry for arraybuffer? This feels like the kind of thing that went in to earlier es20xx.collection entries.

Resizable ArrayBuffers and growable SharedArrayBuffers are Stage 4 and will be in ES2024 when it is standardized, so a lib.es2024.arraybuffer.d.ts might make sense at this point, though it would still only be referenced from esnext since we don't have a --target es2024 yet..

Or a lib.es2024.collections.d.ts, rather. I agree it makes more sense to try to keep the names somewhat consistent.

sandersn · 2023-06-28T22:30:18Z

src/lib/esnext.arraybuffer.d.ts

+	/**
+	 * Read-only. The maximum length that this ArrayBuffer can be resized to (in bytes).
+	 */
+	readonly maxByteLength: number;


I agree with @Josh-Cena, the spec example uses accessors, so it makes sense to do so here.

(It's quite likely that old readonlys should be changed to accessors, but that might break backward compatibility, eg classes extend lib interfaces and override properties.)

sandersn · 2023-06-28T22:38:52Z

src/lib/esnext.arraybuffer.d.ts

+
+interface SharedArrayBuffer {
+	/**
+	 * Read-only. Whether this SharedArrayBuffer can be grow or not.


Suggested change

* Read-only. Whether this SharedArrayBuffer can be grow or not.

* Returns true if this SharedArrayBuffer can grow.

Although, growable is self-explanatory, and the current explanation is redundant with it. If we must have a jsdoc here, I'd prefer to see an explanation of context or what different properties a growable SharedArrayBuffer has, or a link to an explanation.

sandersn · 2023-06-28T22:42:07Z

src/lib/esnext.arraybuffer.d.ts

+}
+
+/**
+ * ArrayBuffer constructor options


I would delete this. It doesn't add anything to the name of the type.

sandersn · 2023-06-28T22:42:58Z

src/lib/esnext.arraybuffer.d.ts

+	readonly maxByteLength: number;
+
+	/**
+	 * Read-only. Whether this ArrayBuffer can be resized or not.


Suggested change

* Read-only. Whether this ArrayBuffer can be resized or not.

* Returns true if this ArrayBuffer can be resized.

Actually, my comments about growable apply; I'd prefer to delete this comment.

sandersn · 2023-06-28T22:44:09Z

src/lib/esnext.arraybuffer.d.ts

+	 * Resizes the ArrayBuffer to the specified size (in bytes).
+	 * @param newLength The new length, in bytes, to resize the ArrayBuffer to.
+	 */
+	resize(newLength: number): undefined;


I would call this newByteLength like the proposal does. Then consider deleting the jsdoc.

sandersn · 2023-06-28T22:54:02Z

src/lib/esnext.arraybuffer.d.ts

@@ -0,0 +1,58 @@
+interface ArrayBuffer {
+	/**
+	 * Read-only. The maximum length that this ArrayBuffer can be resized to (in bytes).


The spec proposal points out that this is equal to byteLength if options.maxByteLength is not provided. I'd stay closer to the example's explanation:

Suggested change

* Read-only. The maximum length that this ArrayBuffer can be resized to (in bytes).

* If this ArrayBuffer is resizable, returns the maximum byte length given during construction; returns the byte length if not.

lino-levan · 2023-08-09T18:54:37Z

@indrajitbnikam are you willing to push this forward? If not, I'd be willing to take this on.

seirdotexe · 2023-10-17T17:38:26Z

Any updates? Node 20 LTS is coming soon, so would be nice if the types are there, too 😊

domoritz · 2023-12-16T17:38:28Z

@indrajitbnikam are you still working on this? This is currently blocking me from cleanly adopting reusable buffers.

indrajitbnikam · 2023-12-17T02:42:44Z

Hi Dominik, Im not working on this at the moment. You can take it forward from here. Thanks & Regards, Indrajeet Nikam

…

On Sat, 16 Dec 2023 at 11:08 PM, Dominik Moritz ***@***.***> wrote: @indrajitbnikam <https://github.com/indrajitbnikam> are you still working on this? This is currently blocking me from cleanly adopting reusable buffers. — Reply to this email directly, view it on GitHub <#54637 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AF6UTX2SINLOEYPTUCA43WTYJXMCDAVCNFSM6AAAAAAZFGFJVWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNJYHA3TSMRSGE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

domoritz · 2023-12-17T02:56:27Z

Okay. Unfortunately, I don't have cycles to fix this right now. I hacked around the types in apache/arrow#39252 for now.

sandersn · 2024-03-20T22:05:54Z

To help with PR housekeeping, I'm going to close this PR since it is stale and there's an updated version at #57858.

fix(dts): add missing types to support resizable arraybuffer

541081d

typescript-bot added the For Uncommitted Bug PR for untriaged, rejected, closed or missing bug label Jun 13, 2023

indrajitbnikam commented Jun 13, 2023

View reviewed changes

src/lib/es5.d.ts Outdated Show resolved Hide resolved

Josh-Cena reviewed Jun 13, 2023

View reviewed changes

jakebailey mentioned this pull request Jun 14, 2023

Only gitignore lib dir at repo root #54644

Merged

jakebailey reviewed Jun 14, 2023

View reviewed changes

src/compiler/commandLineParser.ts Outdated Show resolved Hide resolved

indrajitbnikam force-pushed the fix/dts-update-type-for-arraybuffer branch 2 times, most recently from b0f736a to 5925906 Compare June 14, 2023 17:17

fix(dts): add separate file to add missing arrayBuffer and sharedArra…

e675236

…yBuffer types

indrajitbnikam force-pushed the fix/dts-update-type-for-arraybuffer branch from 5925906 to e675236 Compare June 14, 2023 17:18

fix: update the baselines

51cbc24

typescript-bot added For Backlog Bug PRs that fix a backlog bug and removed For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Jun 17, 2023

indrajitbnikam requested review from fatcerberus, jakebailey and Josh-Cena June 20, 2023 15:45

Josh-Cena reviewed Jun 20, 2023

View reviewed changes

sandersn requested review from sandersn and removed request for fatcerberus June 28, 2023 21:40

sandersn requested changes Jun 28, 2023

View reviewed changes

sandersn self-assigned this Jun 29, 2023

ghost mentioned this pull request Mar 19, 2024

fix(dts): array buffer types (ES2024,ES2017) #57858

Closed

sandersn closed this Mar 20, 2024

petamoriken mentioned this pull request May 19, 2024

Introduce ES2024 target and fix some types #58573

Open

	* Read-only. Whether this SharedArrayBuffer can be grow or not.
	* Returns true if this SharedArrayBuffer can grow.

	* Read-only. Whether this ArrayBuffer can be resized or not.
	* Returns true if this ArrayBuffer can be resized.

	* Read-only. The maximum length that this ArrayBuffer can be resized to (in bytes).
	* If this ArrayBuffer is resizable, returns the maximum byte length given during construction; returns the byte length if not.

fix(dts): add missing types to support resizable arraybuffer #54637

fix(dts): add missing types to support resizable arraybuffer #54637

Conversation

indrajitbnikam commented Jun 13, 2023

indrajitbnikam commented Jun 13, 2023

indrajitbnikam commented Jun 13, 2023

Josh-Cena left a comment

Choose a reason for hiding this comment

fatcerberus commented Jun 14, 2023

indrajitbnikam commented Jun 14, 2023 • edited Loading

Josh-Cena commented Jun 14, 2023 • edited Loading

fatcerberus commented Jun 14, 2023 • edited Loading

Josh-Cena commented Jun 14, 2023

petamoriken commented Jun 14, 2023

petamoriken commented Jun 14, 2023

indrajitbnikam commented Jun 14, 2023 • edited Loading

indrajitbnikam commented Jun 14, 2023 • edited Loading

jakebailey commented Jun 14, 2023

indrajitbnikam commented Jun 14, 2023

jakebailey commented Jun 14, 2023

jakebailey commented Jun 14, 2023

jakebailey commented Jun 14, 2023

indrajitbnikam commented Jun 14, 2023

indrajitbnikam commented Jun 14, 2023 • edited Loading

indrajitbnikam commented Jun 14, 2023 • edited Loading

petamoriken commented Jun 15, 2023 • edited Loading

petamoriken commented Jun 17, 2023 • edited Loading

indrajitbnikam commented Jun 17, 2023

indrajitbnikam commented Jun 17, 2023

petamoriken commented Jun 18, 2023

indrajitbnikam commented Jun 19, 2023

Josh-Cena left a comment • 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

indrajitbnikam commented Jun 20, 2023

sandersn left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lino-levan commented Aug 9, 2023

seirdotexe commented Oct 17, 2023

domoritz commented Dec 16, 2023

indrajitbnikam commented Dec 17, 2023 via email

domoritz commented Dec 17, 2023

sandersn commented Mar 20, 2024

indrajitbnikam commented Jun 14, 2023 •

edited

Loading

Josh-Cena commented Jun 14, 2023 •

edited

Loading

fatcerberus commented Jun 14, 2023 •

edited

Loading

indrajitbnikam commented Jun 14, 2023 •

edited

Loading

indrajitbnikam commented Jun 14, 2023 •

edited

Loading

indrajitbnikam commented Jun 14, 2023 •

edited

Loading

indrajitbnikam commented Jun 14, 2023 •

edited

Loading

petamoriken commented Jun 15, 2023 •

edited

Loading

petamoriken commented Jun 17, 2023 •

edited

Loading

Josh-Cena left a comment •

edited

Loading