Infer jest globals from @jest/globals #62037

remcohaszing · 2022-08-30T13:21:17Z

Jest provides their own types. If I’m correct (based on #44365), @SimenB, the maintainer of Jest, envisions @types/jest to be a way for people to opt into the use of type safe jest globals. These globals are defined in the @jest/globals package.

With these changes, all this package does is expose Jest globals from the @jest/globals package.

This also removes a bunch of types that no longer exist in Jest, such as jasmine, spyOn, and done.fail(). This also fixes incompatibilities between the builtin Jest types and these manually written type definitions, which causes issues such as #62025.

The minimum TypeScript version has been changed to 4.5, because the upstream types require this.

Closes #34617
Closes #36299
Closes #44365
Closes #59960
Closes #60546
Closes #62025

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): use @jest/globals package #44365
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.

typescript-bot · 2022-08-30T13:22:01Z

@remcohaszing Thank you for submitting this PR!

This is a live comment which I will keep updated.

6 packages in this PR

expect-puppeteer — on npm, on unpkg
heft-jest — on npm, on unpkg
jest-axe — on npm, on unpkg
jest-expect-message — on npm, on unpkg
jest-image-snapshot — on npm, on unpkg
jest — on npm, on unpkg

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 of this PR in the Playground.

Status

❌ No merge conflicts
❌ Continuous integration tests have failed
🕐 A DT maintainer needs to approve changes which affect more than one package

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 156 days — it is considered abandoned, and therefore closed!

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 62037,
  "author": "remcohaszing",
  "headCommitOid": "c04757c650c613a837dac93fe07a7d5e5d50f1ed",
  "mergeBaseOid": "40cfc02a705b4a5967ff4e9a123f34dddf318970",
  "lastPushDate": "2022-08-31T07:41:35.000Z",
  "lastActivityDate": "2022-09-11T15:17:44.000Z",
  "hasMergeConflict": true,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "expect-puppeteer",
      "kind": "edit",
      "files": [
        {
          "path": "types/expect-puppeteer/expect-puppeteer-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/expect-puppeteer/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/expect-puppeteer/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "tkrotoff",
        "jfm710"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    },
    {
      "name": "heft-jest",
      "kind": "edit",
      "files": [
        {
          "path": "types/heft-jest/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/heft-jest/mocked.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/heft-jest/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "octogonz",
        "iclanton"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "jest-axe",
      "kind": "edit",
      "files": [
        {
          "path": "types/jest-axe/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/jest-axe/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "erbridge"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    },
    {
      "name": "jest-expect-message",
      "kind": "edit",
      "files": [
        {
          "path": "types/jest-expect-message/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/jest-expect-message/jest-expect-message-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/jest-expect-message/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "mike-d-davydov",
        "saitonakamura"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    },
    {
      "name": "jest-image-snapshot",
      "kind": "edit",
      "files": [
        {
          "path": "types/jest-image-snapshot/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/jest-image-snapshot/jest-image-snapshot-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/jest-image-snapshot/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "dawnmist",
        "erbridge",
        "peterblazejewicz"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    },
    {
      "name": "jest",
      "kind": "edit",
      "files": [
        {
          "path": "types/jest/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/jest/jest-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/jest/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "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",
        "regevbr",
        "gerkindev",
        "domdomegg"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "stale",
      "reviewer": "SimenB",
      "date": "2022-08-30T14:14:43.000Z",
      "abbrOid": "3c40987"
    },
    {
      "type": "stale",
      "reviewer": "mrazauskas",
      "date": "2022-08-30T13:55:11.000Z",
      "abbrOid": "5dd2387"
    }
  ],
  "mainBotCommentID": 1231662208,
  "ciResult": "fail",
  "ciUrl": "https://github.com/DefinitelyTyped/DefinitelyTyped/commit/c04757c650c613a837dac93fe07a7d5e5d50f1ed/checks?check_suite_id=8064505067"
}

typescript-bot · 2022-08-30T13:22:04Z

🔔 @tkrotoff @jfm710 @octogonz @iclanton @erbridge @mike-d-davydov @saitonakamura @dawnmist @peterblazejewicz @NoHomey @jwbay @asvetliakov @alexjoverm @epicallan @ikatyang @wsmd @JamieMason @douglasduteil @ahnpnl @UselessPickles @r3nya @Hotell @sebald @andys8 @antoinebrault @gstamac @ExE-Boss @quassnoi @Belco90 @tonyhallett @ycmjason @pawfa @regevbr @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 · 2022-08-30T13:26:52Z

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

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

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

SimenB

Yay, thanks for picking this up! ♥️

There's probably a whole bunch of utility types jest is missing.

Also the jasmine types should probably stay somehow (jest-jasmine2 is still maintained

SimenB · 2022-08-30T13:28:26Z

types/jest/index.d.ts

-        [n: number]: T;
-    }
-}
+// Minimum TypeScript Version: 4.5


Should be 4.3 (only jsdom types require 4.5).

All should be fine with 4.2 as well. If it helps to resolve errors with depends.

Type tests are running on 4.3 in Jest repo. The limitation comes from current setup, but it might be possible to rework it. I just didn't find time yet (;

It failed on jest-mock for lower versions.

Interesting! Sounds like a bug - as mentioned we use TS 4.3 in our own type tests

SimenB · 2022-08-30T13:31:11Z

types/jest/index.d.ts

+declare var xit: typeof import('@jest/globals').xit;
+declare var test: typeof import('@jest/globals').test;
+declare var xtest: typeof import('@jest/globals').xtest;
+declare var jest: typeof import('@jest/globals').jest;


Does this re-export namespace stuff? That was an issue in https://github.com/facebook/jest/pull/12856/files#r945243675

The jest namespace implementation could follow the code of 'packages/jest/src/index.ts' in the above mentioned PR.

Does this re-export namespace stuff?

It does not, but it could!

It’s just a bit annoying these exports need to be hand-picked.

SimenB · 2022-08-30T13:33:44Z

/cc @mrazauskas who has done a bunch of work on Jest's types

SimenB · 2022-08-30T13:35:10Z

Also, this will certainly be horribly breaking, so should probably land as part of a future Jest v30 (no timeline)

typescript-bot · 2022-08-30T13:46:46Z

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

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

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

remcohaszing · 2022-08-30T14:24:30Z

Also, this will certainly be horribly breaking, so should probably land as part of a future Jest v30

So far it doesn’t look that bad actually. But yeah, this would have definitely been nice for 29.0.0 😅

typescript-bot · 2022-08-31T07:47:04Z

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

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

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

mrazauskas · 2022-08-31T07:53:56Z

types/heft-jest/index.d.ts

+function mocked<T>(item: T, deep?: false): mocked.MaybeMocked<T>;
+function mocked<T>(item: T, deep: true): mocked.MaybeMockedDeep<T>;


Is this really necessary? Jest has jest.mocked() helper (it was moved from ts-jest), is that not sufficient?

By the way, typings of jest.mocked() were reworked recently and the copy above is already outdated. For reference see: https://github.com/facebook/jest/blob/835a93666a69202de2a0429cd5445cb5f56d2cea/packages/jest-mock/src/index.ts#L34-L92, and: https://github.com/facebook/jest/blob/835a93666a69202de2a0429cd5445cb5f56d2cea/packages/jest-mock/src/index.ts#L1219-L1230

So should this be changed to the following then?

declare global mocked: typeof import('@jest/globals').mocked

I’m not familiar with heft-jest. It’s just affected by the updates.

I was looking through Heft’s docs. The way they use Jest does not work with ts-jest, so to have mocked() working they copied it to @types/heft-jest. Seemed like they are fine to deprecate @types/heft-jest after Heft will ship Jest v28, which has jest.mocked() builtin. I think that would be the best solution. See microsoft/rushstack#3609

types/jest-expect-message/index.d.ts

mrazauskas · 2022-08-31T08:01:09Z

types/jest-image-snapshot/jest-image-snapshot-tests.ts

 import {
    configureToMatchImageSnapshot,
    MatchImageSnapshotOptions,
    toMatchImageSnapshot,
    updateSnapshotState,
 } from 'jest-image-snapshot';

+declare const it: any;


Could this be typed through @types/jest? Or perhaps simply to import {it} from '@jest/globals'?

The value of it is actually irrelevant. It just makes the tests look more representative. If it’s imported from @types/jest or @jest/globals, this would add a dependency (dev dependencies are not allowed in DefinitelyTyped).

Fine with me. It just felt like a regression. I am not a maintainer of any @types/* packages, just wanted to draw attention.

mrazauskas · 2022-08-31T08:10:18Z

types/jest-expect-message/index.d.ts

-        <T = any>(actual: T, message: string): JestMatchers<T>;
+        (actual: any, message: string): Matchers<void>;


Just to be sure. Removal of the generic could possibly mess up other matchers. For example, does it work with .resolves chainer?

typescript-bot · 2022-09-11T13:37:19Z

@remcohaszing 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!

mrazauskas · 2022-09-11T13:49:42Z

types/jest/jest-tests.ts

-const spyInterfaceImpl: SpyInterface = {};
-// @ts-expect-error
-jest.spyOn(spyInterfaceImpl, 'method', 'get');
-// @ts-expect-error
-jest.spyOn(spyInterfaceImpl, 'prop');
-// $ExpectType SpyInstance<number, []>
-jest.spyOn(spyInterfaceImpl, 'prop', 'get');
-// $ExpectType SpyInstance<void, [boolean]> || SpyInstance<void, [arg1: boolean]>
-jest.spyOn(spyInterfaceImpl, 'method');


Just to draw attention – some useful tests might be removed accidentally. E.g., this particular test helped me to figure out that Jest’s build-in spyOn typings do not handle optional props in interfaces. Fixed in jestjs/jest#13247

We should ideally keep most of the tests here, at least during migration. There's gonna be a bunch we don't want/need, but nice to see run the tests in the meantime

Summary: Originally proposed in react-native-community/discussions-and-proposals#592 Main changes are: - Explicitly importing the global APIs in `App.test.tsx` - Drop `types/jest` from the devDependency list Benefits of these changes will be: - Keep in line with Jest's recommended practice - Remove a dev-dependency to make dependencies slimmer References: - jestjs/jest#13133 - DefinitelyTyped/DefinitelyTyped#62037 ## Changelog [GENERAL] [CHANGED] - Switch from `types/jest` to `jest/globals` for new react-native projects Pull Request resolved: #36068 Test Plan: 1. Create a new RN project from the modified template 2. Ensure yarn test passes 3. Ensure IDEs do not complain about `App.test.tsx` Reviewed By: cipolleschi Differential Revision: D43080151 Pulled By: cortinico fbshipit-source-id: c9161cb930c78f3a1eaa08ccb6483aa38d52fa3c

typescript-bot · 2023-02-14T20:05:41Z

@remcohaszing 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!

Summary: Originally proposed in react-native-community/discussions-and-proposals#592 Main changes are: - Explicitly importing the global APIs in `App.test.tsx` - Drop `types/jest` from the devDependency list Benefits of these changes will be: - Keep in line with Jest's recommended practice - Remove a dev-dependency to make dependencies slimmer References: - jestjs/jest#13133 - DefinitelyTyped/DefinitelyTyped#62037 ## Changelog [GENERAL] [CHANGED] - Switch from `types/jest` to `jest/globals` for new react-native projects Pull Request resolved: facebook#36068 Test Plan: 1. Create a new RN project from the modified template 2. Ensure yarn test passes 3. Ensure IDEs do not complain about `App.test.tsx` Reviewed By: cipolleschi Differential Revision: D43080151 Pulled By: cortinico fbshipit-source-id: c9161cb930c78f3a1eaa08ccb6483aa38d52fa3c

Infer jest globals from @jest/globals

3c40987

typescript-bot added the Critical package label Aug 30, 2022

typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board Aug 30, 2022

typescript-bot added the The CI failed When GH Actions fails label Aug 30, 2022

typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Aug 30, 2022

SimenB reviewed Aug 30, 2022

View reviewed changes

Update expect-puppeteer-tests

5dd2387

typescript-bot added Edits multiple packages and removed The CI failed When GH Actions fails labels Aug 30, 2022

typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Aug 30, 2022

typescript-bot added the The CI failed When GH Actions fails label Aug 30, 2022

typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Aug 30, 2022

remcohaszing added 2 commits August 30, 2022 16:12

Fix types for heft-jest

7605e45

Fix types for jest-axe

7425401

remcohaszing added 2 commits August 30, 2022 17:20

Fix types of jest-expect-message

4b29962

Fix jest-image-snapshot tests

c04757c

mrazauskas mentioned this pull request Aug 31, 2022

docs: update expect.extend examples jestjs/jest#13195

Merged

remcohaszing mentioned this pull request Aug 31, 2022

Define import.meta.jest in jest types #61862

Merged

8 tasks

remcohaszing requested a review from peterblazejewicz as a code owner August 31, 2022 07:41

typescript-bot removed the The CI failed When GH Actions fails label Aug 31, 2022

typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Aug 31, 2022

typescript-bot added the The CI failed When GH Actions fails label Aug 31, 2022

typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Aug 31, 2022

mrazauskas reviewed Aug 31, 2022

View reviewed changes

types/jest-expect-message/index.d.ts Show resolved Hide resolved

mrazauskas reviewed Aug 31, 2022

View reviewed changes

mrazauskas mentioned this pull request Aug 31, 2022

[Feature]: Please export @jest/globals into global namespace jestjs/jest#13196

Closed

ChrisKuBa mentioned this pull request Sep 6, 2022

[Bug]: Mocked function returned by jest.mocked is not a function using ESM + Typescript jestjs/jest#13200

Closed

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 Sep 11, 2022

mrazauskas reviewed Sep 11, 2022

View reviewed changes

mrazauskas mentioned this pull request Sep 16, 2022

[jest]: align jest.fn generic type with Jest #62208

Closed

7 tasks

This was referenced Sep 30, 2022

chore: replace @types/jest with a new private @jest/test-globals package jestjs/jest#13344

Merged

feat(jest): allow enabling Jest global types through "types": ["jest"] in tsconfig.json jestjs/jest#12856

Closed

SimenB mentioned this pull request Oct 3, 2022

[(Bug?/)Feature]: Improve JSDoc and make more consistent jestjs/jest#11804

Closed

SimenB mentioned this pull request Oct 24, 2022

[Feature]: Replace @types/jest's expect implementation with @jest/expect jestjs/jest#12424

Open

mrazauskas mentioned this pull request Dec 16, 2022

[jest] improve expect spy matcher inference #63610

Closed

7 tasks

UNIDY2002 mentioned this pull request Feb 6, 2023

[template] switch from @types/jest to @jest/globals facebook/react-native#36068

Closed

typescript-bot added the Abandoned This PR had no activity for a long time, and is considered abandoned label Feb 14, 2023

typescript-bot removed this from Needs Author Action in New Pull Request Status Board Feb 14, 2023

typescript-bot closed this Feb 14, 2023

remcohaszing deleted the jest-globals branch January 25, 2024 10:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Infer jest globals from @jest/globals #62037

Infer jest globals from @jest/globals #62037

remcohaszing commented Aug 30, 2022

typescript-bot commented Aug 30, 2022 •

edited

typescript-bot commented Aug 30, 2022 •

edited

typescript-bot commented Aug 30, 2022

SimenB left a comment

SimenB Aug 30, 2022

mrazauskas Aug 30, 2022 •

edited

remcohaszing Aug 30, 2022

SimenB Aug 30, 2022

SimenB Aug 30, 2022

mrazauskas Aug 30, 2022

remcohaszing Aug 30, 2022

SimenB commented Aug 30, 2022

SimenB commented Aug 30, 2022

typescript-bot commented Aug 30, 2022

remcohaszing commented Aug 30, 2022

typescript-bot commented Aug 31, 2022

mrazauskas Aug 31, 2022 •

edited

remcohaszing Sep 6, 2022

mrazauskas Sep 7, 2022

mrazauskas Aug 31, 2022

remcohaszing Sep 6, 2022

mrazauskas Sep 7, 2022

mrazauskas Aug 31, 2022

typescript-bot commented Sep 11, 2022

mrazauskas Sep 11, 2022

SimenB Sep 11, 2022

typescript-bot commented Feb 14, 2023

		function mocked<T>(item: T, deep?: false): mocked.MaybeMocked<T>;
		function mocked<T>(item: T, deep: true): mocked.MaybeMockedDeep<T>;

		<T = any>(actual: T, message: string): JestMatchers<T>;
		(actual: any, message: string): Matchers<void>;

Infer jest globals from @jest/globals #62037

Infer jest globals from @jest/globals #62037

Conversation

remcohaszing commented Aug 30, 2022

typescript-bot commented Aug 30, 2022 • edited

6 packages in this PR

Code Reviews

Status

Inactive

typescript-bot commented Aug 30, 2022 • edited

typescript-bot commented Aug 30, 2022

SimenB left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrazauskas Aug 30, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SimenB commented Aug 30, 2022

SimenB commented Aug 30, 2022

typescript-bot commented Aug 30, 2022

remcohaszing commented Aug 30, 2022

typescript-bot commented Aug 31, 2022

mrazauskas Aug 31, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typescript-bot commented Sep 11, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typescript-bot commented Feb 14, 2023

typescript-bot commented Aug 30, 2022 •

edited

typescript-bot commented Aug 30, 2022 •

edited

mrazauskas Aug 30, 2022 •

edited

mrazauskas Aug 31, 2022 •

edited