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

[node] Update with changes from v14.6.0 #46244

Merged
merged 1 commit into from Aug 17, 2020

Conversation

addaleax
Copy link
Contributor

Refs: nodejs/node#34371

Please fill in this template.

  • Use a meaningful title for the pull request. Include the name of the package modified.
  • Test the change in your own code. (Compile and run.)
  • Add or edit tests to reflect the change. (Run with npm test.)
  • Follow the advice from the readme.
  • Avoid common mistakes.
  • Run npm run lint package-name (or tsc if no tslint.json is present).

Select one of these and delete the others:

If adding a new definition:

  • The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
  • If this is for an NPM package, match the name. If not, do not conflict with the name of an NPM package.
  • Create it with dts-gen --dt, not by basing it on an existing project.
  • Represents shape of module/library correctly
  • tslint.json should be present and it shouldn't have any additional or disabling of rules. Just content as { "extends": "dtslint/dt.json" }. If for reason the some 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.
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: v14.6.0 proposal nodejs/node#34371
  • 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.
  • Include tests for your changes
  • 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.

If removing a declaration:

  • If a package was never on Definitely Typed, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
  • Delete the package's directory.
  • Add it to notNeededPackages.json.

@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?

Comparison details 📊
master #46244 diff
Batch compilation
Memory usage (MiB) 96.2 104.2 +8.3%
Type count 16857 16860 0%
Assignability cache size 4952 4952 0%
Language service
Samples taken 46 46 0%
Identifiers in tests 46 46 0%
getCompletionsAtPosition
    Mean duration (ms) 695.9 677.3 -2.7%
    Mean CV 11.0% 11.9%
    Worst duration (ms) 812.3 832.8 +2.5%
    Worst identifier assert assert
getQuickInfoAtPosition
    Mean duration (ms) 685.9 662.4 -3.4%
    Mean CV 10.0% 9.8% -2.2%
    Worst duration (ms) 808.8 788.7 -2.5%
    Worst identifier deepStrictEqual a

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. Critical package Author is Owner The author of this PR is a listed owner of the package. labels Jul 21, 2020
@typescript-bot typescript-bot added this to Needs Maintainer Review in New Pull Request Status Board Jul 21, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Jul 21, 2020

@addaleax Thank you for submitting this PR!

This is a live comment which I will keep updated.

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ Most recent commit is approved by type definition owners or DT maintainers

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 46244,
  "author": "addaleax",
  "owners": [
    "Microsoft",
    "DefinitelyTyped",
    "jkomyno",
    "a-tarasyuk",
    "alvis",
    "r3nya",
    "btoueg",
    "brunoscheufler",
    "smac89",
    "touffy",
    "DeividasBakanas",
    "eyqs",
    "Flarna",
    "Hannes-Magnusson-CK",
    "KSXGitHub",
    "hoo29",
    "kjin",
    "ajafff",
    "islishude",
    "mwiktorczyk",
    "mohsen1",
    "n-e",
    "galkin",
    "parambirs",
    "eps1lon",
    "SimonSchick",
    "ThomasdenH",
    "WilcoBakker",
    "wwwy3y3",
    "samuela",
    "kuehlein",
    "j-oliveras",
    "bhongy",
    "chyzwar",
    "trivikr",
    "nguymin4",
    "yoursunny",
    "qwelias",
    "ExE-Boss",
    "Ryan-Willpower",
    "peterblazejewicz",
    "addaleax",
    "JasonHK"
  ],
  "dangerLevel": "ScopedAndTested",
  "headCommitAbbrOid": "1fb3a7e",
  "headCommitOid": "1fb3a7e9ce0a09dc564e0a02e552359dce51733a",
  "mergeIsRequested": true,
  "stalenessInDays": 0,
  "lastPushDate": "2020-07-22T13:25:50.000Z",
  "lastCommentDate": "2020-08-17T14:14:57.000Z",
  "maintainerBlessed": true,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/46244/files",
  "hasMergeConflict": false,
  "authorIsOwner": true,
  "isFirstContribution": false,
  "popularityLevel": "Critical",
  "anyPackageIsNew": false,
  "packages": [
    "node"
  ],
  "files": [
    {
      "path": "types/node/index.d.ts",
      "kind": "definition",
      "package": "node"
    },
    {
      "path": "types/node/test/vm.ts",
      "kind": "test",
      "package": "node"
    },
    {
      "path": "types/node/test/worker_threads.ts",
      "kind": "test",
      "package": "node"
    },
    {
      "path": "types/node/tls.d.ts",
      "kind": "definition",
      "package": "node"
    },
    {
      "path": "types/node/vm.d.ts",
      "kind": "definition",
      "package": "node"
    },
    {
      "path": "types/node/worker_threads.d.ts",
      "kind": "definition",
      "package": "node"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "lastReviewDate": "2020-08-12T11:09:04.000Z",
  "reviewersWithStaleReviews": [
    {
      "reviewedAbbrOid": "3744a0f",
      "reviewer": "ExE-Boss",
      "date": "2020-07-22T00:15:07Z"
    }
  ],
  "approvalFlags": 2,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

@typescript-bot typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label Jul 22, 2020
Copy link
Contributor

@SimonSchick SimonSchick left a comment

Choose a reason for hiding this comment

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

Does this include changes from .5 etc?
Also missing minor version bumb in index.d.ts

@typescript-bot typescript-bot added the Revision needed This PR needs code changes before it can be merged. label Jul 22, 2020
@typescript-bot typescript-bot moved this from Needs Maintainer Review to Needs Author Action in New Pull Request Status Board Jul 22, 2020
@typescript-bot
Copy link
Contributor

@addaleax 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 or comments. If you disagree with the reviewer's comments, you can "dismiss" the review using GitHub's review UI. Thank you!

@addaleax
Copy link
Contributor Author

@SimonSchick No, I only specifically looked at the 14.6.0 release. I’ve bumped the version number here, though.

@typescript-bot typescript-bot removed Owner Approved A listed owner of this package signed off on the pull request. Revision needed This PR needs code changes before it can be merged. labels Jul 22, 2020
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Jul 22, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board Jul 22, 2020
@typescript-bot
Copy link
Contributor

@ExE-Boss Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@sheetalkamat sheetalkamat moved this from Needs Maintainer Review to Waiting for Code Reviews in New Pull Request Status Board Jul 22, 2020
@typescript-bot typescript-bot added Owner Approved A listed owner of this package signed off on the pull request. Self Merge This PR can now be self-merged by the PR author or an owner labels Jul 22, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Waiting for Author to Merge in New Pull Request Status Board Jul 22, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Jul 22, 2020

@addaleax Everything looks good here. Great job! I am ready to merge this PR on your behalf.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

(@microsoft, @DefinitelyTyped, @jkomyno, @a-tarasyuk, @alvis, @r3nya, @btoueg, @BrunoScheufler, @smac89, @Touffy, @DeividasBakanas, @eyqs, @Flarna, @Hannes-Magnusson-CK, @KSXGitHub, @hoo29, @kjin, @ajafff, @islishude, @mwiktorczyk, @mohsen1, @n-e, @galkin, @parambirs, @eps1lon, @SimonSchick, @ThomasdenH, @WilcoBakker, @wwwy3y3, @samuela, @kuehlein, @j-oliveras, @bhongy, @chyzwar, @trivikr, @nguymin4, @yoursunny, @qwelias, @ExE-Boss, @Ryan-Willpower, @peterblazejewicz, @JasonHK: you can do this too.)

@SimonSchick
Copy link
Contributor

@addaleax can you please file an issue to apply changes from .1 to .5?
People could be lead to believe that .6 contains all of those changes.

@addaleax
Copy link
Contributor Author

Hm yeah… I can probably just update this to actually incorporate those changes later, that might be the easiest way

@typescript-bot typescript-bot added the Unmerged The author did not merge the PR when it was ready. label Aug 2, 2020
@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Needs Maintainer Action in New Pull Request Status Board Aug 2, 2020
@addaleax
Copy link
Contributor Author

addaleax commented Aug 6, 2020

@SimonSchick I’m not sure I’ll have time for finishing that task up this week.

So can you pick either one of your review comments? You’ve asked me to bump the version, and subsequently asked me to bump the code so that it matches that version; that basically leaves me with no option but a massive scope creep for this PR. I don’t think that’s a helpful review process, and I would appreciate it if you were to pick one (update the version or not, but not expect me to do a ton of extra work).

@typescript-bot typescript-bot removed the Unmerged The author did not merge the PR when it was ready. label Aug 6, 2020
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Author to Merge in New Pull Request Status Board Aug 6, 2020
@addaleax
Copy link
Contributor Author

Can somebody merge this / weigh in on @SimonSchick’s comments?

@Flarna
Copy link
Contributor

Flarna commented Aug 12, 2020

@addaleax If I understand bot correct you just have to comment with Ready to merge and bot will merge this.

@addaleax
Copy link
Contributor Author

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board Aug 17, 2020
@typescript-bot typescript-bot merged commit d868bfe into DefinitelyTyped:master Aug 17, 2020
@typescript-bot
Copy link
Contributor

I just published @types/node@14.6.0 to npm.

@typescript-bot typescript-bot removed this from Recently Merged in New Pull Request Status Board Aug 18, 2020
chivesrs pushed a commit to chivesrs/DefinitelyTyped that referenced this pull request Sep 2, 2020
danielrearden pushed a commit to danielrearden/DefinitelyTyped that referenced this pull request Sep 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Author is Owner The author of this PR is a listed owner of the package. Critical package Owner Approved A listed owner of this package signed off on the pull request. Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. Self Merge This PR can now be self-merged by the PR author or an owner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants