Bump Jest to v27 #1198

mcmire · 2023-04-18T02:00:39Z

Description

The mocked utility function from ts-jest, which we commonly use, was moved into Jest in v27.

Changes

N/A

References

This is a blocker for #1197, as we want to update the NetworkController tests to use jest.mocked instead of mocked from ts-jest/utils.

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation for new or updated code as appropriate (note: this will usually be JSDoc)
I've highlighted breaking changes using the "BREAKING" category above as appropriate

socket-security · 2023-04-18T02:02:53Z

New dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No new dependency issues detected in pull request

Bot Commands

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore foo@1.0.0 bar@* or ignore all packages with @SocketSecurity ignore-all

Pull request alert summary

Issue	Status
Install scripts	✅ 0 issues
Native code	✅ 0 issues
Bin script shell injection	✅ 0 issues
Unresolved require	✅ 0 issues
Invalid package.json	✅ 0 issues
HTTP dependency	✅ 0 issues
Git dependency	✅ 0 issues
Potential typo squat	✅ 0 issues
Known Malware	✅ 0 issues
Telemetry	✅ 0 issues
Protestware/Troll package	✅ 0 issues

📊 Modified Dependency Overview:

⬆️ Updated Package	Version Diff	Added Capability Access	`+/-` Transitive Count	Publisher
jest@27.5.1	26.6.3...27.5.1	None	`+990/-3222`	simenb
jest-environment-jsdom@27.5.1	26.6.2...27.5.1	None	`+11/-91`	simenb
ts-jest@27.1.5	26.5.6...27.1.5	environment	`+1044/-3240`	kul
@types/jest@27.5.2	26.0.24...27.5.2	eval	`+108/-108`	types

legobeat · 2023-04-18T02:46:10Z

The test errors seem to be due to breaking changes in v28 that requires us to do changes in the setup.

https://jestjs.io/docs/28.x/upgrading-to-jest28#jsdom

jestjs/jest#12879

I'd suggest to

Draw down this upgrade to 27.x for now
Address the upgrade to 29 in a separate change

mcmire · 2023-04-19T00:15:15Z

@legobeat Ah, thanks! I've updated this PR to bump Jest to only v27.

mcmire · 2023-04-19T00:17:12Z

packages/assets-controllers/src/CurrencyRateController.test.ts

@@ -44,7 +44,7 @@ function flushPromises(): Promise<unknown> {

 describe('CurrencyRateController', () => {
  beforeEach(() => {
-    jest.useFakeTimers();


Changed because Jest v27 switches to the "modern" fake timers by default and these must mock more things related to timers than the legacy fake timers, because now any of the tests that involve HTTP requests are timing out. I suspect because this is because node-fetch calls setTimeout on the request object during the request-response flow, but I didn't look beyond that.

More information on this: nock/nock#2200

It seems that using the legacy implementation is the best solution for now. Jest v28 offers more options though. When we update to v28 we should consider using the modern timers but configuring it to leave whatever we need here unmocked.

legobeat · 2023-04-19T00:36:30Z

packages/transaction-controller/jest.config.js

@@ -16,7 +16,7 @@ module.exports = merge(baseConfig, {
  // An object that configures minimum threshold enforcement for coverage results
  coverageThreshold: {
    global: {
-      branches: 81.51,
+      branches: 80.79,


Do we have an explanation for this?

Hmm, that's fair. Let me dive deeper into the coverage reports.

Rebased on main (there were some yarn.lock conflicts) and ran a project-wide jest-it-up - the drop here persists.

For the preferences controller tests, the branch coverage went from 22/24 to 13/15. Here in the transactions controller, branch coverage went from 217/264 to 185/229

The reports seem to show the same gaps, roughly. I did a visual comparison and they were nearly identical. The one difference is that the else case for this condition used to be flagged as uncovered, but now it isn't.

I did a quick search in the Jest issue tracker but couldn't find any reference to this.

This is curious, but I don't think it needs to block this PR.

The `mocked` utility function from `ts-jest`, which we commonly use, was moved into Jest in v27.

Gudahtt

Looks great! I can approve once the conflicts are resolved

legobeat · 2023-04-21T01:13:54Z

packages/preferences-controller/jest.config.js

@@ -16,7 +16,7 @@ module.exports = merge(baseConfig, {
  // An object that configures minimum threshold enforcement for coverage results
  coverageThreshold: {
    global: {
-      branches: 86.67,


Had to do this after merge of main

Gudahtt

LGTM!

* Bump Jest to v27 The `mocked` utility function from `ts-jest`, which we commonly use, was moved into Jest in v27. * jest-it-down --------- Co-authored-by: legobt <6wbvkn0j@anonaddy.me> Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>

mcmire requested a review from a team as a code owner April 18, 2023 02:00

mcmire changed the title ~~Bump Jest to v29~~ Bump Jest to v27 Apr 18, 2023

mcmire force-pushed the bump-jest branch from 0ceaeb8 to 06528a9 Compare April 19, 2023 00:15

mcmire commented Apr 19, 2023

View reviewed changes

legobeat reviewed Apr 19, 2023

View reviewed changes

mcmire self-assigned this Apr 19, 2023

Bump Jest to v27

0503bbb

The `mocked` utility function from `ts-jest`, which we commonly use, was moved into Jest in v27.

legobeat force-pushed the bump-jest branch 2 times, most recently from c186550 to 0503bbb Compare April 19, 2023 11:05

Gudahtt reviewed Apr 19, 2023

View reviewed changes

Merge remote-tracking branch 'mm/main' into bump-jest

139cb4d

legobeat requested a review from Gudahtt April 19, 2023 13:15

Merge branch 'main' into bump-jest

0a57afc

legobeat force-pushed the bump-jest branch from cf04e75 to 0a57afc Compare April 21, 2023 00:22

legobeat reviewed Apr 21, 2023

View reviewed changes

jest-it-down

1c33a8a

legobeat force-pushed the bump-jest branch from b1eb116 to 1c33a8a Compare April 21, 2023 01:28

Merge branch 'main' into bump-jest

10449bd

Gudahtt approved these changes Apr 21, 2023

View reviewed changes

Merge branch 'main' into bump-jest

52272ab

Gudahtt merged commit 3fd38b8 into main Apr 21, 2023
85 checks passed

Gudahtt deleted the bump-jest branch April 21, 2023 12:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump Jest to v27 #1198

Bump Jest to v27 #1198

mcmire commented Apr 18, 2023 •

edited

socket-security bot commented Apr 18, 2023 •

edited

legobeat commented Apr 18, 2023 •

edited

mcmire commented Apr 19, 2023

mcmire Apr 19, 2023

Gudahtt Apr 19, 2023

legobeat Apr 19, 2023

mcmire Apr 19, 2023

legobeat Apr 19, 2023

Gudahtt Apr 19, 2023

Gudahtt left a comment

legobeat Apr 21, 2023

Gudahtt left a comment

Bump Jest to v27 #1198

Bump Jest to v27 #1198

Conversation

mcmire commented Apr 18, 2023 • edited

Description

Changes

References

Checklist

socket-security bot commented Apr 18, 2023 • edited

legobeat commented Apr 18, 2023 • edited

mcmire commented Apr 19, 2023

mcmire Apr 19, 2023

Choose a reason for hiding this comment

Gudahtt Apr 19, 2023

Choose a reason for hiding this comment

legobeat Apr 19, 2023

Choose a reason for hiding this comment

mcmire Apr 19, 2023

Choose a reason for hiding this comment

legobeat Apr 19, 2023

Choose a reason for hiding this comment

Gudahtt Apr 19, 2023

Choose a reason for hiding this comment

Gudahtt left a comment

Choose a reason for hiding this comment

legobeat Apr 21, 2023

Choose a reason for hiding this comment

Gudahtt left a comment

Choose a reason for hiding this comment

mcmire commented Apr 18, 2023 •

edited

socket-security bot commented Apr 18, 2023 •

edited

legobeat commented Apr 18, 2023 •

edited