kobotoolbox / kpi / 11939363921

82%

master: 76%

push

github

test(jest): replace mocha-chrome with jest TASK-1234 (#5264)

### 👀 Preview steps

- Check the CI log output — [✅ build
(20.17.0)](https://github.com/kobotoolbox/kpi/actions/runs/11822549230/job/32939829801?pr=5264)
- To run unit tests locally — use `npm run test` or `npm run test-watch`

### 💭 Notes

Port unit tests to a Jest runner instead of running them in
mocha-chrome.

- Internal discussion: [flaky "npm-test" CI
failure](https://chat.kobotoolbox.org/#narrow/stream/4-Kobo-Dev/topic/flaky.20.22npm-test.22.20CI.20failure)

- **🃏 Jest Configs** — Added jest/**mocha.config.ts**,
jest/**setupMochaTest.ts**, and jest/**coffeeTransformer.js**
- ☕ The custom transformer accommodates our rare combination of current
Jest with CoffeeScript 1.12.7. Easier than it seemed given good
examples, and I was glad it didn't need more code to interop with es
modules.
- 🎓 I used `@ts-expect-error` when setting up some globals for the test
environment. Lemme know if there's a more "correct" alternative, but I
think the effect is limited

- **🧰 Tests** - Changed test/**helper/fauxChai.coffee** and 4 other
**.tests.coffee** files in test/**xlform/**
- Added explicit `return` statements to fauxChai helpers and 4 other
test files
- Prevents CoffeeScript tests from implicitly returning objects, which
is interpreted as a test failure in the new Jest environment.
- See why Jest cares about this:
https://github.com/jestjs/jest/issues/6516#issuecomment-399539647
- Added explicit import for `_` in utils.tests.coffee, matching other
tests (instead of including it in the shared test environment)

- **🌐 Frontend** - Changed js/**constants.ts** 
- 🗨️ I added a check to prevent a `console.error` log from appearing if
test globals are present
- Otherwise the log appears frequently in the test logs, and may be
interpreted as a failed test

- **📦 Build** - Changed **package.json**, **package-lock.json**, and
scripts/**hints.js**
    - **"scripts... (continued)

5629 of 9091 branches covered (61.92%)

21544 of 26940 relevant lines covered (79.97%)

0.8 hits per line