[jest] constrain type of the `jest.replacedProperty()` argument #64936

mrazauskas · 2023-03-29T16:00:53Z

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.
Follow the advice from the readme.
Avoid common mistakes.
Run npm test <package to test>.

If changing an existing definition:

Provide a URL to documentation or source code which provides context for the suggested changes: fix(jest-mock): tweak typings to allow jest.replaceProperty() replace methods jestjs/jest#14008 (comment)

Summary

Based on user report (see link above). Currently if compiler option "skipLibCheck": false is set and @types/jest are used with Jest’s built-in types, the compiler gives following error:

node_modules/@jest/environment/build/index.d.ts:401:26 - error TS2430: Interface 'JestImportMeta' incorrectly extends interface 'ImportMeta'.
  The types of 'jest.replaceProperty' are incompatible between these types.
    Type '<T extends object, K extends Exclude<keyof T, keyof { [K in keyof T as Required<T>[K] extends ClassLike ? K : never]: T[K]; } | keyof { [K in keyof T as Required<T>[K] extends FunctionLike ? K : never]: T[K]; }>, V extends T[K]>(object: T, propertyKey: K, value: V) => Replaced<...>' is not assignable to type '<T, K extends keyof T>(obj: T, key: K, value: T[K]) => ReplaceProperty<T[K]>'.
      Types of parameters 'object' and 'obj' are incompatible.
        Type 'T' is not assignable to type 'object'.

401 export declare interface JestImportMeta extends ImportMeta {
                             ~~~~~~~~~~~~~~

  node_modules/@types/jest/index.d.ts:331:30
    331     function replaceProperty<T, K extends keyof T>(obj: T, key: K, value: T[K]): ReplaceProperty<T[K]>;
                                     ~
    This type parameter might need an `extends object` constraint.

This is because the jest.replacedProperty() argument is missing a constrain in @types/jest. jest.spyOn() is similar, so I added the same {} constrain (note that in Jest built-in types the constrain is object):

DefinitelyTyped/types/jest/index.d.ts

Line 447 in 498a65e

function spyOn<T extends {}, M extends ConstructorPropertyNames<Required<T>>>(

typescript-bot · 2023-03-29T16:01:34Z

@mrazauskas Thank you for submitting this PR!

This is a live comment which I will keep updated.

1 package in this PR

jest — on npm, on unpkg (author is owner)
- owner-approval: @domdomegg

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.

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

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": 64936,
  "author": "mrazauskas",
  "headCommitOid": "2eed5aa3bb89cdb5e96a1f92f5d758f830eb2ef3",
  "mergeBaseOid": "498a65e3da2f685fc7b86e99f4094bddf1512459",
  "lastPushDate": "2023-04-18T18:38:58.000Z",
  "lastActivityDate": "2023-04-19T09:41:05.000Z",
  "maintainerBlessed": "Waiting for Code Reviews",
  "mergeOfferDate": "2023-04-19T09:40:27.000Z",
  "mergeRequestDate": "2023-04-19T09:41:05.000Z",
  "mergeRequestUser": "mrazauskas",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "jest",
      "kind": "edit",
      "files": [
        {
          "path": "types/jest/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/jest/jest-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "NoHomey",
        "jwbay",
        "asvetliakov",
        "alexjoverm",
        "epicallan",
        "ikatyang",
        "wsmd",
        "JamieMason",
        "douglasduteil",
        "ahnpnl",
        "UselessPickles",
        "r3nya",
        "hotell",
        "sebald",
        "andys8",
        "antoinebrault",
        "gstamac",
        "ExE-Boss",
        "quassnoi",
        "Belco90",
        "tonyhallett",
        "ycmjason",
        "pawfa",
        "gerkindev",
        "domdomegg",
        "mrazauskas"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "domdomegg",
      "date": "2023-04-19T09:39:40.000Z",
      "isMaintainer": false
    }
  ],
  "mainBotCommentID": 1488891670,
  "ciResult": "pass"
}

typescript-bot · 2023-03-29T16:01:37Z

🔔 @NoHomey @jwbay @asvetliakov @alexjoverm @epicallan @ikatyang @wsmd @JamieMason @douglasduteil @ahnpnl @UselessPickles @r3nya @Hotell @sebald @andys8 @antoinebrault @gstamac @ExE-Boss @quassnoi @Belco90 @tonyhallett @ycmjason @pawfa @GerkinDev @domdomegg — 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 · 2023-04-18T01:05:59Z

Re-ping @NoHomey, @jwbay, @asvetliakov, @alexjoverm, @epicallan, @ikatyang, @wsmd, @JamieMason, @douglasduteil, @ahnpnl, @UselessPickles, @r3nya, @Hotell, @sebald, @andys8, @antoinebrault, @gstamac, @ExE-Boss, @quassnoi, @Belco90, @tonyhallett, @ycmjason, @pawfa, @GerkinDev, @domdomegg:

This PR has been out for over a week, yet I haven't seen any reviews.

Could someone please give it some attention? Thanks!

types/jest/index.d.ts

types/jest/jest-tests.ts

Co-authored-by: Adam Jones <domdomegg+git@gmail.com>

typescript-bot · 2023-04-18T10:39:57Z

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

Co-authored-by: Adam Jones <domdomegg+git@gmail.com>

mrazauskas · 2023-04-19T09:41:05Z

Ready to merge

domdomegg · 2023-04-19T09:42:06Z

Thanks for the PR @mrazauskas 🙌 , and apologies for the delayed review on my part.

molily · 2023-04-19T12:28:30Z

Thanks to everyone who contributed to this! ❤️

xt0rted · 2023-05-02T02:43:48Z

I have a PR updating from v29.4.0 to v29.5.1 of these types and I'm getting a similar build error as seen here xt0rted/dotnet-sdk-updater#391. Should this PR of fixed that error or is it a new one?

Error: node_modules/@jest/environment/build/index.d.ts(401,26): error TS2430: Interface 'JestImportMeta' incorrectly extends interface 'ImportMeta'.
  The types of 'jest.replaceProperty' are incompatible between these types.
    Type '<T extends object, K extends Exclude<keyof T, keyof { [K in keyof T as Required<T>[K] extends ClassLike ? K : never]: T[K]; } | keyof { [K in keyof T as Required<T>[K] extends FunctionLike ? K : never]: T[K]; }>, V extends T[K]>(object: T, propertyKey: K, value: V) => Replaced<...>' is not assignable to type '<T extends object, K extends keyof T>(obj: T, key: K, value: T[K]) => ReplaceProperty<T[K]>'.
      Types of parameters 'propertyKey' and 'key' are incompatible.
        Type 'K' is not assignable to type 'Exclude<keyof T, keyof { [K in keyof T as Required<T>[K] extends ClassLike ? K : never]: T[K]; } | keyof { [K in keyof T as Required<T>[K] extends FunctionLike ? K : never]: T[K]; }>'.
          Type 'keyof T' is not assignable to type 'Exclude<keyof T, keyof { [K in keyof T as Required<T>[K] extends ClassLike ? K : never]: T[K]; } | keyof { [K in keyof T as Required<T>[K] extends FunctionLike ? K : never]: T[K]; }>'.
            Type 'string | number | symbol' is not assignable to type 'Exclude<keyof T, keyof { [K in keyof T as Required<T>[K] extends ClassLike ? K : never]: T[K]; } | keyof { [K in keyof T as Required<T>[K] extends FunctionLike ? K : never]: T[K]; }>'.
              Type 'string' is not assignable to type 'Exclude<keyof T, keyof { [K in keyof T as Required<T>[K] extends ClassLike ? K : never]: T[K]; } | keyof { [K in keyof T as Required<T>[K] extends FunctionLike ? K : never]: T[K]; }>'.

mrazauskas · 2023-05-02T06:19:11Z

The problem is on Jest side. It is fixed already, just not yet released (see jestjs/jest#14097).

[jest] constrain type of the jest.replacedProperty() argument

ddc419b

typescript-bot added Where is GH Actions? GH Actions didn't give a response to this PR Critical package Author is Owner The author of this PR is a listed owner of the package. labels Mar 29, 2023

mrazauskas mentioned this pull request Mar 29, 2023

fix(jest-mock): tweak typings to allow jest.replaceProperty() replace methods jestjs/jest#14008

Merged

restart CI

ca0170d

typescript-bot removed the Where is GH Actions? GH Actions didn't give a response to this PR label Apr 5, 2023

typescript-bot added the Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. label Apr 18, 2023

domdomegg reviewed Apr 18, 2023

View reviewed changes

types/jest/index.d.ts Outdated Show resolved Hide resolved

domdomegg reviewed Apr 18, 2023

View reviewed changes

types/jest/jest-tests.ts Show resolved Hide resolved

Update types/jest/index.d.ts

73813a8

Co-authored-by: Adam Jones <domdomegg+git@gmail.com>

typescript-bot removed the Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. label Apr 18, 2023

Update types/jest/jest-tests.ts

2eed5aa

Co-authored-by: Adam Jones <domdomegg+git@gmail.com>

domdomegg approved these changes Apr 19, 2023

View reviewed changes

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 Apr 19, 2023

typescript-bot merged commit 683f1d9 into DefinitelyTyped:master Apr 19, 2023

mrazauskas deleted the jest-constrain-replacedProperty-argument branch April 19, 2023 12:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[jest] constrain type of the `jest.replacedProperty()` argument #64936

[jest] constrain type of the `jest.replacedProperty()` argument #64936

Uh oh!

mrazauskas commented Mar 29, 2023

Uh oh!

typescript-bot commented Mar 29, 2023 •

edited

Loading

Uh oh!

typescript-bot commented Mar 29, 2023

Uh oh!

typescript-bot commented Apr 18, 2023

Uh oh!

Uh oh!

Uh oh!

typescript-bot commented Apr 18, 2023

Uh oh!

mrazauskas commented Apr 19, 2023

Uh oh!

domdomegg commented Apr 19, 2023 •

edited

Loading

Uh oh!

molily commented Apr 19, 2023

Uh oh!

xt0rted commented May 2, 2023 •

edited

Loading

Uh oh!

mrazauskas commented May 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

[jest] constrain type of the jest.replacedProperty() argument #64936

[jest] constrain type of the jest.replacedProperty() argument #64936

Uh oh!

Conversation

mrazauskas commented Mar 29, 2023

Summary

Uh oh!

typescript-bot commented Mar 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

1 package in this PR

Code Reviews

Status

Uh oh!

typescript-bot commented Mar 29, 2023

Uh oh!

typescript-bot commented Apr 18, 2023

Uh oh!

Uh oh!

Uh oh!

typescript-bot commented Apr 18, 2023

Uh oh!

mrazauskas commented Apr 19, 2023

Uh oh!

domdomegg commented Apr 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

molily commented Apr 19, 2023

Uh oh!

xt0rted commented May 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mrazauskas commented May 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

[jest] constrain type of the `jest.replacedProperty()` argument #64936

[jest] constrain type of the `jest.replacedProperty()` argument #64936

typescript-bot commented Mar 29, 2023 •

edited

Loading

domdomegg commented Apr 19, 2023 •

edited

Loading

xt0rted commented May 2, 2023 •

edited

Loading