Skip to content

fs, stream: add initial Symbol.dispose and Symbol.asyncDispose support - #48518

Merged
nodejs-github-bot merged 10 commits into
nodejs:mainfrom
MoLow:symbol-dispose
Jun 25, 2023
Merged

fs, stream: add initial Symbol.dispose and Symbol.asyncDispose support#48518
nodejs-github-bot merged 10 commits into
nodejs:mainfrom
MoLow:symbol-dispose

Conversation

@MoLow

@MoLow MoLow commented Jun 22, 2023

Copy link
Copy Markdown
Member

Both TypeScript and Bable already support using (explicit resource management proposal),
adding this to node will be convenient

Co-authored-by: Benjamin Gruenbaum benjamingr@gmail.com

@nodejs-github-bot

nodejs-github-bot commented Jun 22, 2023

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/streams

@nodejs-github-bot nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Jun 22, 2023
ronag
ronag reviewed Jun 22, 2023
View reviewed changes
Comment thread doc/api/fs.md Outdated
ronag
ronag reviewed Jun 22, 2023
View reviewed changes
Comment thread doc/api/stream.md Outdated
mscdex
mscdex reviewed Jun 22, 2023
View reviewed changes
Comment thread doc/api/fs.md Outdated
ronag
ronag reviewed Jun 22, 2023
View reviewed changes
Comment thread lib/internal/streams/readable.js Outdated
mscdex
mscdex reviewed Jun 22, 2023
View reviewed changes
Comment thread doc/api/stream.md Outdated
ronag
ronag reviewed Jun 22, 2023
View reviewed changes
Comment thread lib/internal/process/pre_execution.js Outdated
mscdex
mscdex reviewed Jun 22, 2023
View reviewed changes
Comment thread lib/internal/process/pre_execution.js Outdated
ronag
ronag reviewed Jun 22, 2023
View reviewed changes
Comment thread lib/internal/process/pre_execution.js Outdated
ronag
ronag requested changes Jun 22, 2023
View reviewed changes

@ronag ronag left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added some comments.

ronag
ronag reviewed Jun 22, 2023
View reviewed changes

@ronag ronag left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q: Does await using fallback to Symbol.dispose if the async version doesn't exist?

@MoLow @benjamingr
fs, stream: initial Symbol.dispose and Symbol.asyncDispose support
8a25397 
Co-authored-by: Benjamin Gruenbaum <benjamingr@gmail.com>
@MoLow

MoLow commented Jun 22, 2023

Copy link
Copy Markdown
Member Author

Q: Does await using fallback to Symbol.dispose if the async version doesn't exist?

according to this it does:
https://github.com/tc39/proposal-explicit-resource-management#await-using-declarations-with-explicit-local-bindings

ronag
ronag reviewed Jun 22, 2023
View reviewed changes

@ronag ronag left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Implement for stream.Writable as well?

ronag
ronag reviewed Jun 22, 2023
View reviewed changes
Comment thread lib/internal/process/pre_execution.js Outdated
MoLow
MoLow commented Jun 22, 2023
View reviewed changes
Comment thread lib/internal/per_context/primordials.js
ronag
ronag reviewed Jun 22, 2023
View reviewed changes
Comment thread lib/internal/streams/readable.js Outdated
MoLow and others added 3 commits June 22, 2023 12:51
@MoLow @ronag
Update lib/internal/process/pre_execution.js
8dc2ee7 
Co-authored-by: Robert Nagy <ronagy@icloud.com>
@MoLow @ronag
Update lib/internal/streams/readable.js
223a2d8 
Co-authored-by: Robert Nagy <ronagy@icloud.com>
@MoLow
lint
40ba972
@benjamingr

benjamingr commented Jun 22, 2023

Copy link
Copy Markdown
Member

@ronag

Implement for stream.Writable as well?

Yeah, and for a lot of other things (http.Server etc), the idea here was to add the symbols and one example so we can distribute the work like we did last year with iterator-helpers.

ronag
ronag reviewed Jun 22, 2023
View reviewed changes
Comment thread lib/internal/streams/readable.js Outdated
ronag
ronag reviewed Jun 22, 2023
View reviewed changes
Comment thread lib/internal/streams/readable.js Outdated
benjamingr and others added 2 commits June 22, 2023 13:37
@benjamingr @ronag
Update lib/internal/streams/readable.js
e8a014f 
Co-authored-by: Robert Nagy <ronagy@icloud.com>
@benjamingr @ronag
Update lib/internal/streams/readable.js
48602bb 
Co-authored-by: Robert Nagy <ronagy@icloud.com>
@rixtox rixtox mentioned this pull request Jul 10, 2023
Open
@ruyadorno

ruyadorno commented Sep 10, 2023

Copy link
Copy Markdown
Member

This commit does not land cleanly on v18.x-staging and will need manual backport in case we want it in v18.

@atlowChemi atlowChemi mentioned this pull request Sep 11, 2023
Merged
@atlowChemi atlowChemi mentioned this pull request Sep 11, 2023
Closed
@simatec simatec mentioned this pull request Oct 5, 2023
Closed
@lukastaegert lukastaegert mentioned this pull request Nov 10, 2024
Merged
9 tasks
@skyclouds2001 skyclouds2001 mentioned this pull request Apr 5, 2025
Closed
@coderabbitai coderabbitai Bot mentioned this pull request Jul 6, 2026
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ljharb ljharb ljharb left review comments
@benjamingr benjamingr benjamingr left review comments
@aduh95 aduh95 aduh95 left review comments
@mcollina mcollina mcollina approved these changes
@anonrig anonrig anonrig approved these changes
@ronag ronag ronag approved these changes
@ErickWendel ErickWendel ErickWendel approved these changes
+3 more reviewers
@mscdex mscdex mscdex left review comments
@zloirock zloirock zloirock left review comments
@rbuckton rbuckton rbuckton left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. notable-change PRs with changes that should be highlighted in changelogs.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.