Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

lib: make diagnostics_channel async iterable #35532

Closed
wants to merge 1 commit into from

Conversation

Qard
Copy link
Member

@Qard Qard commented Oct 7, 2020

This is just an idea for a possibly helpful extension to the diagnostics_channel feature in #34895. Not sure how valuable this is, so I've pulled it out to a separate PR where people can 馃憤 or 馃憥 if they think it's a worthwhile addition.

Depends on: #34895

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@Qard Qard added lib / src Issues and PRs related to general changes in the lib or src directory. blocked PRs that are blocked by other issues or PRs. diag-agenda Issues and PRs to discuss during the meetings of the diagnostics working group. experimental Issues and PRs related to experimental features. labels Oct 7, 2020
@Qard Qard requested a review from a team as a code owner October 7, 2020 02:12
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/net

@Qard Qard force-pushed the diagnostics-channel-async-iterable branch from 826c870 to 6548fcb Compare October 31, 2020 22:38
@Qard
Copy link
Member Author

Qard commented Oct 31, 2020

cc @nodejs/diagnostics Now that diagnostics_channel has landed, I'd like to get a fresh look at this to decide if async iterable support is something we want. No docs currently, but I can write some if people think this is a feature worth having.

@Qard Qard added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 1, 2020
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 1, 2020
@nodejs-github-bot
Copy link
Collaborator

Copy link
Contributor

@mmarchini mmarchini left a comment

Choose a reason for hiding this comment

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

diagnostics_channel is implemented fully synchronously, right? If we add async iterablility to it, we'll be adding asynchronocity to the API, which will cause confusion to users (as the timing from the main API and the async API will be wildly different). Unless I'm misunderstanding it, I'm opposed to adding async iterability to this API (it's not an asynchronous API).

@mmarchini mmarchini removed the diag-agenda Issues and PRs to discuss during the meetings of the diagnostics working group. label Nov 25, 2020
@Qard
Copy link
Member Author

Qard commented Nov 25, 2020

Fair point. I didn't implement it as a requirement, so one could use the regular API when sync guarantees are needed, but then that'd need to be documented well and could be a source of confusion. 馃槙

@Qard Qard closed this Aug 11, 2021
@Qard Qard deleted the diagnostics-channel-async-iterable branch August 11, 2021 06:27
@Mesteery Mesteery added the diagnostics_channel Issues and PRs related to diagnostics channel label Oct 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked PRs that are blocked by other issues or PRs. diagnostics_channel Issues and PRs related to diagnostics channel experimental Issues and PRs related to experimental features. lib / src Issues and PRs related to general changes in the lib or src directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants