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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@types/node: stream.pipeline() should accept iterators since Node 13.10 #49868

Closed
wants to merge 1 commit into from

Conversation

voxpelli
Copy link
Contributor

@voxpelli voxpelli commented Nov 30, 2020

Please fill in this template.

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: https://nodejs.org/api/stream.html#stream_stream_pipeline_source_transforms_destination_callback
  • If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.
  • If you are making substantial changes, consider adding a tslint.json containing { "extends": "dtslint/dt.json" }. If for reason the any rule need to be disabled, disable it for that line using // tslint:disable-next-line [ruleName] and not for whole package so that the need for disabling can be reviewed.

@typescript-bot
Copy link
Contributor

typescript-bot commented Nov 30, 2020

@voxpelli Thank you for submitting this PR!

This is a live comment which I will keep updated.

1 package in this PR

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

You can test the changes in this PR in the Playground.

Status

  • ❌ No merge conflicts
  • ❌ Continuous integration tests have failed
  • 🕐 Most recent commit is approved by a DT maintainer

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.

Inactive

This PR has been inactive for 31 days — it is considered abandoned, and therefore closed!


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 49868,
  "author": "voxpelli",
  "headCommitOid": "131f82a6706dc69008052f7188da7e0298646348",
  "lastPushDate": "2021-03-04T19:20:48.000Z",
  "lastActivityDate": "2021-04-20T20:09:11.000Z",
  "hasMergeConflict": true,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "node",
      "kind": "edit",
      "files": [
        {
          "path": "types/node/stream.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/test/stream.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "Microsoft",
        "DefinitelyTyped",
        "jkomyno",
        "alvis",
        "r3nya",
        "btoueg",
        "smac89",
        "touffy",
        "DeividasBakanas",
        "eyqs",
        "Hannes-Magnusson-CK",
        "KSXGitHub",
        "hoo29",
        "kjin",
        "ajafff",
        "islishude",
        "mwiktorczyk",
        "mohsen1",
        "n-e",
        "galkin",
        "parambirs",
        "eps1lon",
        "SimonSchick",
        "ThomasdenH",
        "WilcoBakker",
        "wwwy3y3",
        "samuela",
        "kuehlein",
        "bhongy",
        "chyzwar",
        "trivikr",
        "nguymin4",
        "yoursunny",
        "qwelias",
        "ExE-Boss",
        "Ryan-Willpower",
        "peterblazejewicz",
        "addaleax",
        "JasonHK",
        "victorperin",
        "ZYSzys"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "stale",
      "reviewer": "rbuckton",
      "date": "2020-12-18T03:03:55.000Z",
      "abbrOid": "f2e95d2"
    },
    {
      "type": "stale",
      "reviewer": "a-tarasyuk",
      "date": "2020-11-30T16:44:25.000Z",
      "abbrOid": "f2e95d2"
    }
  ],
  "mainBotCommentID": 735888792,
  "ciResult": "fail",
  "ciUrl": "https://github.com/DefinitelyTyped/DefinitelyTyped/commit/131f82a6706dc69008052f7188da7e0298646348/checks?check_suite_id=2181047341"
}

@typescript-bot
Copy link
Contributor

typescript-bot commented Nov 30, 2020

@typescript-bot
Copy link
Contributor

👋 Hi there! I’ve run some quick measurements against master and your PR. These metrics should help the humans reviewing this PR gauge whether it might negatively affect compile times or editor responsiveness for users who install these typings.

Let’s review the numbers, shall we?

master #49868 diff
Batch compilation
Memory usage (MiB) 108.8 103.8 -4.6%
Type count 17661 17662 0%
Assignability cache size 5054 5054 0%
Language service
Samples taken 28 28 0%
Identifiers in tests 28 28 0%
getCompletionsAtPosition
    Mean duration (ms) 669.3 697.9 +4.3%
    Mean CV 9.7% 10.2%
    Worst duration (ms) 744.1 897.3 +20.6% 🔸
    Worst identifier env process
getQuickInfoAtPosition
    Mean duration (ms) 672.0 678.4 +1.0%
    Mean CV 10.7% 8.1%
    Worst duration (ms) 748.8 789.6 +5.5%
    Worst identifier preopens env

Looks like there were a couple significant differences—take a look at worst-case duration for getting completions at a position to make sure everything looks ok.

@typescript-bot typescript-bot added the Perf: Worse typescript-bot determined that this PR has a negative impact on compilation performance. label Nov 30, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board Nov 30, 2020
@typescript-bot typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label Nov 30, 2020
Copy link
Collaborator

@rbuckton rbuckton left a comment

Choose a reason for hiding this comment

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

The NodeJS documentation here is poor and there are some inconsistencies between the above type and the actual NodeJS runtime semantics.

types/node/stream.d.ts Show resolved Hide resolved
@typescript-bot typescript-bot added Revision needed This PR needs code changes before it can be merged. and removed Owner Approved A listed owner of this package signed off on the pull request. labels Dec 8, 2020
@typescript-bot typescript-bot moved this from Needs Maintainer Review to Needs Author Action in New Pull Request Status Board Dec 8, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Dec 8, 2020

@voxpelli One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits. Thank you!

@typescript-bot typescript-bot added the Abandoned This PR had no activity for a long time, and is considered abandoned label Jan 1, 2021
@typescript-bot
Copy link
Contributor

@voxpelli I haven't seen any activity on this PR in more than three weeks, and it still has problems that prevent it from being merged. The PR will be closed in a week if the issues aren't addressed.

@voxpelli
Copy link
Contributor Author

voxpelli commented Jan 7, 2021

nodejs/node#36437 is now released as https://github.com/nodejs/node/releases/tag/v15.5.0 @rbuckton, should we push this change into #48981 and/or continue here?

@typescript-bot typescript-bot removed the Abandoned This PR had no activity for a long time, and is considered abandoned label Jan 7, 2021
@voxpelli
Copy link
Contributor Author

voxpelli commented Jan 7, 2021

I submitted a request to backport the patch to Node 14: nodejs/node#36831

@voxpelli
Copy link
Contributor Author

The backport has been merged, so once it’s released we can merge this I believe @rbuckton

@voxpelli
Copy link
Contributor Author

voxpelli commented Feb 9, 2021

v14.15.5 has now been released: https://nodejs.org/en/blog/release/v14.15.5/ So we can go ahead and merge this @rbuckton

@typescript-bot typescript-bot added the Abandoned This PR had no activity for a long time, and is considered abandoned label Mar 4, 2021
@typescript-bot
Copy link
Contributor

@voxpelli I haven't seen any activity on this PR in more than three weeks, and it still has problems that prevent it from being merged. The PR will be closed on Mar 11th (in a week) if the issues aren't addressed.

@voxpelli
Copy link
Contributor Author

voxpelli commented Mar 4, 2021

Rebased on top of master, still needs a review, though I'm not sure @typescript-bot gets that.

@typescript-bot typescript-bot added Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. and removed Abandoned This PR had no activity for a long time, and is considered abandoned Revision needed This PR needs code changes before it can be merged. labels Mar 4, 2021
@typescript-bot typescript-bot moved this from Needs Author Action to Needs Maintainer Action in New Pull Request Status Board Mar 4, 2021
@typescript-bot
Copy link
Contributor

It has been more than two weeks and this PR still has no reviews.

I'll bump it to the DT maintainer queue. Thank you for your patience, @voxpelli.

(Ping @microsoft, @DefinitelyTyped, @jkomyno, @alvis, @r3nya, @btoueg, @BrunoScheufler, @smac89, @Touffy, @DeividasBakanas, @eyqs, @Hannes-Magnusson-CK, @KSXGitHub, @hoo29, @kjin, @ajafff, @islishude, @mwiktorczyk, @mohsen1, @n-e, @galkin, @parambirs, @eps1lon, @SimonSchick, @ThomasdenH, @WilcoBakker, @wwwy3y3, @samuela, @kuehlein, @bhongy, @chyzwar, @trivikr, @nguymin4, @yoursunny, @qwelias, @ExE-Boss, @Ryan-Willpower, @peterblazejewicz, @addaleax, @JasonHK, @victorperin, @ZYSzys.)

@typescript-bot
Copy link
Contributor

Updated numbers for you here from 89c276a. Nice job, these numbers look better.

Comparison details 📊
master #49868 diff
Batch compilation
Memory usage (MiB) 126.6 127.2 +0.5%
Type count 22918 23049 +1%
Assignability cache size 7594 7595 0%
Language service
Samples taken 28 28 0%
Identifiers in tests 28 28 0%
getCompletionsAtPosition
    Mean duration (ms) 871.7 881.9 +1.2%
    Mean CV 9.4% 10.0%
    Worst duration (ms) 1076.9 1068.7 -0.8%
    Worst identifier start start
getQuickInfoAtPosition
    Mean duration (ms) 866.7 867.5 +0.1%
    Mean CV 9.7% 8.6%
    Worst duration (ms) 1034.2 1011.8 -2.2%
    Worst identifier start start

It looks like nothing changed too much. I won’t post performance data again unless it gets worse.

@typescript-bot typescript-bot added Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. The CI failed When GH Actions fails and removed Perf: Worse typescript-bot determined that this PR has a negative impact on compilation performance. Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. labels Mar 4, 2021
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Needs Author Action in New Pull Request Status Board Mar 5, 2021
@typescript-bot
Copy link
Contributor

@voxpelli The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

@typescript-bot typescript-bot added the Abandoned This PR had no activity for a long time, and is considered abandoned label Mar 28, 2021
@typescript-bot
Copy link
Contributor

@voxpelli I haven't seen any activity on this PR in more than three weeks, and it still has problems that prevent it from being merged. The PR will be closed on Apr 3rd (in a week) if the issues aren't addressed.

@voxpelli
Copy link
Contributor Author

I'll have to look at the CI then... Would be awesome to get some feedback now when the patch has been upstreamed.

@typescript-bot typescript-bot removed the Abandoned This PR had no activity for a long time, and is considered abandoned label Mar 28, 2021
@typescript-bot typescript-bot added the Has Merge Conflict This PR can't be merged because it has a merge conflict. The author needs to update it. label Apr 15, 2021
@typescript-bot
Copy link
Contributor

@voxpelli Unfortunately, this pull request currently has a merge conflict 😥. Please update your PR branch to be up-to-date with respect to master. Have a nice day!

@typescript-bot typescript-bot added the Abandoned This PR had no activity for a long time, and is considered abandoned label Apr 20, 2021
@typescript-bot
Copy link
Contributor

@voxpelli I haven't seen any activity on this PR in more than three weeks, and it still has problems that prevent it from being merged. The PR will be closed on Apr 27th (in a week) if the issues aren't addressed.

@voxpelli
Copy link
Contributor Author

I will try to find time soon

@typescript-bot typescript-bot removed the Abandoned This PR had no activity for a long time, and is considered abandoned label Apr 20, 2021
@typescript-bot typescript-bot added the Abandoned This PR had no activity for a long time, and is considered abandoned label May 14, 2021
@typescript-bot
Copy link
Contributor

@voxpelli I haven't seen any activity on this PR in more than three weeks, and it still has problems that prevent it from being merged. The PR will be closed on May 20th (in a week) if the issues aren't addressed.

@typescript-bot
Copy link
Contributor

@voxpelli To keep things tidy, we have to close PRs that aren't mergeable and don't have activity in the last month. No worries, though — please open a new PR if you'd like to continue with this change. Thank you!

@typescript-bot typescript-bot removed this from Needs Author Action in New Pull Request Status Board May 22, 2021
@voxpelli voxpelli deleted the patch-1 branch May 24, 2021 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Abandoned This PR had no activity for a long time, and is considered abandoned Critical package Has Merge Conflict This PR can't be merged because it has a merge conflict. The author needs to update it. Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. The CI failed When GH Actions fails
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants