Switch from jest from ts-jest to swc #2333

mattseddon · 2022-09-05T05:29:01Z

Docs: https://swc.rs/ / https://swc.rs/docs/usage/jest

The CI seems to be taking longer and longer to run. This should give us a significant speed boost but there are some caveats.

swc does not type-check the code.
jest.spyOn no longer works out of the box: jest.spyOn does not work when compared ts-jest swc-project/swc#3843
~~There are 4 webview tests that I cannot get to work. This is due to the above behaviour. I am still looking into it but unsure if I'll be able to find a way round.~~ There is an ugly workaround.

Locally I can run the entire set of Jest tests in ✨ Done in 24.09s.
This previously took: ✨ Done in 46.15s.

CI Now: 61.448s (extension) + 172.465s (webview)
CI Before: 154.413s (extension) + 298.381s (webview)

Note: This is an interesting ticket => swc-project/swc#5205

mattseddon · 2022-09-05T07:20:17Z

extension/src/common/logger.test.ts

+    __esModule: true,
+    ...actualModule
+  }
+})


[F] Unfortunately we cannot pull out a helper from this boilerplate as the compiler behaves differently if jest.mock in not written like this in the code.

mattseddon · 2022-09-05T07:21:02Z

extension/src/processExecution.ts

-    Logger.log(chunk.toString().replace(/(\r?\n)/g, ''))
-  )
-
-export const createProcessWithOutput = (options: ProcessOptions) => {


[F] moving this removed the need for a spy which was breaking some tests. It is currently only used in a single place so was ok to move.

package.json

mattseddon · 2022-09-05T07:22:35Z

webview/jest.config.js

  setupFiles: ['jest-canvas-mock', '<rootDir>/setup-tests.js'],
-  testEnvironment: 'node',
-  testTimeout: 20000
+  testEnvironment: 'jsdom',


[F] Has to be jsdom or everything blows up. Which is fine, we were only doing this to try and get some performance improvements.

If we only have to set this here once and not have to add

/** * @jest-environment jsdom */

for every file, that is very cool.

mattseddon · 2022-09-05T07:24:38Z

webview/src/plots/components/comparisonTable/ComparisonTable.test.tsx

+        secondRow,
+        firstRow,
+        DragEnterDirection.BOTTOM,
+        EventCurrentTargetDistances


[C] This is gross but I could not find any other way to successfully spy on a single call of getEventCurrentTargetDistances. I had to

give the function its own module

move the import to inside the test file (instead of the util)

mock inside the test file for the usual workaround

pass the module down into the test helper.

I had to do this in 4 places.

mattseddon · 2022-09-05T07:25:12Z

webview/src/shared/components/iconMenu/IconMenu.test.tsx

@@ -1,6 +1,3 @@
-/**
- * @jest-environment jsdom
- */


[F] No longer required as the whole suite now runs in jsdom.

mattseddon · 2022-09-05T07:50:38Z

extension/src/common/logger.test.ts

@@ -1,5 +1,13 @@
 import { Logger } from './logger'

+jest.mock('console', () => {


#2333 (comment)

wolmir · 2022-09-05T19:21:54Z

extension/src/python/index.ts

+  sendOutput(process)
+
+  return process
+}


Are we allowed to use this to do things like getting the ast from the project's Python files ?

You could definitely try. Take a look at https://github.com/microsoft/vscode-python/tree/main/src/client/languageServer to see what those guys do (outside of the closed source language server)

Why is that closed, btw?

mattseddon · 2022-09-06T00:51:36Z

webview/src/shared/components/dragDrop/currentTarget.ts

@@ -0,0 +1,11 @@
+import { DragEvent } from 'react'


@sroy3 any suggestions for the name of this file?

I think this is a good name.

codeclimate · 2022-09-06T05:49:17Z

Code Climate has analyzed commit df875f8 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 92.3% (85% is the threshold).

This pull request will bring the total coverage in the repository to 96.9%.

View more on Code Climate.

julieg18

Looks good to me!

sroy3 · 2022-09-06T14:30:43Z

webview/jest.config.js

  setupFiles: ['jest-canvas-mock', '<rootDir>/setup-tests.js'],
-  testEnvironment: 'node',
-  testTimeout: 20000
+  testEnvironment: 'jsdom',


If we only have to set this here once and not have to add

/** * @jest-environment jsdom */

for every file, that is very cool.

sroy3 · 2022-09-06T14:33:19Z

webview/src/shared/components/dragDrop/currentTarget.ts

@@ -0,0 +1,11 @@
+import { DragEvent } from 'react'


I think this is a good name.

switch ts-jest to swc

3848ed1

mattseddon added the 🏠 housekeeping label Sep 5, 2022

mattseddon self-assigned this Sep 5, 2022

fix up complicated spy of single function

77ec46d

mattseddon commented Sep 5, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

mattseddon commented Sep 5, 2022

View reviewed changes

revert jest version

384e620

mattseddon force-pushed the switch-jest-to-swc branch from c36d02a to 384e620 Compare September 5, 2022 07:33

mattseddon marked this pull request as ready for review September 5, 2022 07:48

mattseddon requested review from sroy3, wolmir and julieg18 as code owners September 5, 2022 07:48

mattseddon commented Sep 5, 2022

View reviewed changes

wolmir reviewed Sep 5, 2022

View reviewed changes

wolmir approved these changes Sep 5, 2022

View reviewed changes

mattseddon commented Sep 6, 2022

View reviewed changes

mattseddon force-pushed the switch-jest-to-swc branch from 8977134 to 08c7366 Compare September 6, 2022 01:33

Merge branch 'main' into switch-jest-to-swc

dfe4665

mattseddon force-pushed the switch-jest-to-swc branch from 08c7366 to dfe4665 Compare September 6, 2022 01:37

mattseddon added 2 commits September 6, 2022 15:21

Merge branch 'main' into switch-jest-to-swc

9581bc3

Merge branch 'main' into switch-jest-to-swc

df875f8

julieg18 approved these changes Sep 6, 2022

View reviewed changes

sroy3 approved these changes Sep 6, 2022

View reviewed changes

mattseddon merged commit d384dbf into main Sep 6, 2022

mattseddon deleted the switch-jest-to-swc branch September 6, 2022 20:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch from jest from ts-jest to swc #2333

Switch from jest from ts-jest to swc #2333

mattseddon commented Sep 5, 2022 •

edited

Loading

mattseddon Sep 5, 2022

mattseddon Sep 5, 2022

mattseddon Sep 5, 2022

sroy3 Sep 6, 2022

mattseddon Sep 5, 2022

mattseddon Sep 5, 2022

mattseddon Sep 5, 2022

wolmir Sep 5, 2022

mattseddon Sep 5, 2022

wolmir Sep 6, 2022

mattseddon Sep 6, 2022

mattseddon Sep 6, 2022

sroy3 Sep 6, 2022

codeclimate bot commented Sep 6, 2022

julieg18 left a comment

sroy3 Sep 6, 2022

sroy3 Sep 6, 2022

		@@ -1,5 +1,13 @@
		import { Logger } from './logger'

		jest.mock('console', () => {

Switch from jest from ts-jest to swc #2333

Switch from jest from ts-jest to swc #2333

Conversation

mattseddon commented Sep 5, 2022 • edited Loading

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

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

codeclimate bot commented Sep 6, 2022

julieg18 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattseddon commented Sep 5, 2022 •

edited

Loading