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

[@pollyjs] Update types for version 4.3.0 #44848

Merged
merged 3 commits into from
May 26, 2020

Conversation

offirgolan
Copy link
Contributor

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).

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: Netflix/pollyjs@v4.0.0...v4.3.0
  • 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.

@typescript-bot typescript-bot added Where is Travis? Author is Owner The author of this PR is a listed owner of the package. labels May 18, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented May 18, 2020

@offirgolan Thank you for submitting this PR!

Code Reviews

Because this PR edits multiple packages, it can be merged once it's reviewed by a DT maintainer.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ❌ Only a DT maintainer can merge changes without tests

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


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 44848,
  "author": "offirgolan",
  "owners": [
    "feinoujc",
    "BoruiGu",
    "offirgolan",
    "silverchen"
  ],
  "dangerLevel": "MultiplePackagesEdited",
  "headCommitAbbrOid": "2c30e06",
  "headCommitOid": "2c30e06fe161ec8c01d2afd0c8cdc284ec3931fd",
  "mergeIsRequested": false,
  "stalenessInDays": 7,
  "lastCommitDate": "2020-05-18T18:25:35.000Z",
  "lastCommentDate": "2020-05-18T18:00:45.000Z",
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/44848/files",
  "hasMergeConflict": false,
  "authorIsOwner": true,
  "isFirstContribution": false,
  "popularityLevel": "Well-liked by everyone",
  "anyPackageIsNew": false,
  "packages": [
    "pollyjs__adapter",
    "pollyjs__core",
    "pollyjs__node-server",
    "pollyjs__persister"
  ],
  "files": [
    {
      "filePath": "types/pollyjs__adapter/index.d.ts",
      "kind": "definition",
      "package": "pollyjs__adapter"
    },
    {
      "filePath": "types/pollyjs__adapter/pollyjs__adapter-tests.ts",
      "kind": "test",
      "package": "pollyjs__adapter"
    },
    {
      "filePath": "types/pollyjs__core/index.d.ts",
      "kind": "definition",
      "package": "pollyjs__core"
    },
    {
      "filePath": "types/pollyjs__core/pollyjs__core-tests.ts",
      "kind": "test",
      "package": "pollyjs__core"
    },
    {
      "filePath": "types/pollyjs__node-server/index.d.ts",
      "kind": "definition",
      "package": "pollyjs__node-server"
    },
    {
      "filePath": "types/pollyjs__persister/index.d.ts",
      "kind": "definition",
      "package": "pollyjs__persister"
    },
    {
      "filePath": "types/pollyjs__persister/pollyjs__persister-tests.ts",
      "kind": "test",
      "package": "pollyjs__persister"
    }
  ],
  "hasDismissedReview": false,
  "travisResult": "pass",
  "lastReviewDate": "2020-05-19T22:06:03.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 2,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

🔔 @feinoujc @BoruiGu @silverchen - please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

@typescript-bot typescript-bot moved this from Other to Waiting for Code Reviews in New Pull Request Status Board May 18, 2020
@danger-public
Copy link

danger-public commented May 18, 2020

Inspecting the JavaScript source for this package found some properties that are not in the .d.ts files.
The check for missing properties isn't always right, so take this list as advice, not a requirement.

pollyjs__adapter (unpkg)

was missing the following properties:

  1. The declaration doesn't match the JavaScript module 'pollyjs__adapter'. Reason:
    The JavaScript module can be called or constructed, but the declaration module cannot.

The most common way to resolve this error is to use 'export =' syntax.
To learn more about 'export =' syntax, see https://www.typescriptlang.org/docs/handbook/modules.html#export--and-import--require.

  1. type
  2. id
  3. virtual
  4. The declaration doesn't match the JavaScript module 'pollyjs__adapter'. Reason:
    The JavaScript module can be called or constructed, but the declaration module cannot.

The most common way to resolve this error is to use 'export =' syntax.
To learn more about 'export =' syntax, see https://www.typescriptlang.org/docs/handbook/modules.html#export--and-import--require.

as well as these 3 other properties...

type, id, virtual

pollyjs__persister (unpkg)

was missing the following properties:

  1. The declaration doesn't match the JavaScript module 'pollyjs__persister'. Reason:
    The JavaScript module can be called or constructed, but the declaration module cannot.

The most common way to resolve this error is to use 'export =' syntax.
To learn more about 'export =' syntax, see https://www.typescriptlang.org/docs/handbook/modules.html#export--and-import--require.

  1. type
  2. id
  3. virtual
  4. BREAK
as well as these 1 other properties...

RETURN

Generated by 🚫 dangerJS against 2c30e06

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board May 18, 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?

pollyjs__adapter/v*

Comparison details for pollyjs__adapter/* 📊
master #44848 diff
Batch compilation
Memory usage (MiB) 34.0 34.1 +0.2%
Type count 2318 2325 0%
Assignability cache size 112 112 0%
Language service
Samples taken 21 23 +10%
Identifiers in tests 21 23 +10%
getCompletionsAtPosition
    Mean duration (ms) 77.4 76.5 -1.1%
    Mean CV 17.1% 18.3%
    Worst duration (ms) 112.7 99.8 -11.4%
    Worst identifier body result
getQuickInfoAtPosition
    Mean duration (ms) 79.8 77.6 -2.7%
    Mean CV 19.2% 17.1% -11.0%
    Worst duration (ms) 113.2 98.0 -13.4%
    Worst identifier passthroughRequest req

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

pollyjs__core/v*

Comparison details for pollyjs__core/* 📊
master #44848 diff
Batch compilation
Memory usage (MiB) 32.6 32.9 +0.9%
Type count 2553 2560 0%
Assignability cache size 230 230 0%
Language service
Samples taken 301 314 +4%
Identifiers in tests 301 314 +4%
getCompletionsAtPosition
    Mean duration (ms) 81.9 81.1 -0.9%
    Mean CV 17.0% 16.6%
    Worst duration (ms) 118.0 112.9 -4.4%
    Worst identifier setupMocha passthrough
getQuickInfoAtPosition
    Mean duration (ms) 83.3 84.0 +0.8%
    Mean CV 16.2% 16.3% +0.6%
    Worst duration (ms) 110.9 116.1 +4.7%
    Worst identifier headers port

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

pollyjs__node-server/v*

Comparison details for pollyjs__node-server/* 📊
master #44848 diff
Batch compilation
Memory usage (MiB) 66.9 68.1 +1.8%
Type count 11074 11092 0%
Assignability cache size 3757 3759 0%
Language service
Samples taken 69 69 0%
Identifiers in tests 69 69 0%
getCompletionsAtPosition
    Mean duration (ms) 346.8 340.3 -1.9%
    Mean CV 11.5% 10.4%
    Worst duration (ms) 641.3 593.3 -7.5%
    Worst identifier app port
getQuickInfoAtPosition
    Mean duration (ms) 345.3 344.0 -0.4%
    Mean CV 12.9% 12.1% -6.4%
    Worst duration (ms) 601.9 634.7 +5.4%
    Worst identifier registerExpressAPI registerExpressAPI

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

pollyjs__persister/v*

Comparison details for pollyjs__persister/* 📊
master #44848 diff
Batch compilation
Memory usage (MiB) 35.8 32.4 -9.5%
Type count 2142 2143 0%
Assignability cache size 110 110 0%
Language service
Samples taken 9 9 0%
Identifiers in tests 9 9 0%
getCompletionsAtPosition
    Mean duration (ms) 78.9 80.4 +1.9%
    Mean CV 28.2% 24.4%
    Worst duration (ms) 93.8 92.1 -1.8%
    Worst identifier persister options
getQuickInfoAtPosition
    Mean duration (ms) 75.8 75.9 +0.1%
    Mean CV 20.7% 20.2% -2.4%
    Worst duration (ms) 82.9 84.2 +1.6%
    Worst identifier persister Persister

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

@typescript-bot typescript-bot added the Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. label May 18, 2020
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board May 18, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board May 18, 2020
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board May 18, 2020
@typescript-bot typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label May 19, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board May 22, 2020
@amcasey amcasey merged commit e90e963 into DefinitelyTyped:master May 26, 2020
@typescript-bot typescript-bot removed this from Needs Maintainer Review in New Pull Request Status Board May 26, 2020
@offirgolan offirgolan deleted the pollyjs-types-4.3.0 branch May 27, 2020 04:59
jjballano-qatium pushed a commit to jjballano-qatium/DefinitelyTyped that referenced this pull request Jun 16, 2020
* [@pollyjs] Update types for version 4.3.0

* fix: Header versions

* chore: More header fixes
ngbrown pushed a commit to ngbrown-forks/DefinitelyTyped that referenced this pull request Jul 11, 2020
* [@pollyjs] Update types for version 4.3.0

* fix: Header versions

* chore: More header fixes
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. 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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants