feat: add Jest/jsdom compatibility #642

ctavan · 2022-07-29T12:07:22Z

BREAKING CHANGE: Jest runs browser tests in a jsdom environment which now also supports web crypto polyfills.

Since ESM support in Jest is currently still limited, it requires a commonJS build for browser environments, see the discussion in #616 for all the details.

Closes #617
Closes #616
Fixes #451

Co-authored-by: Christoph Tavan dev@tavan.de

SimenB · 2022-07-29T12:15:12Z

yay, thanks!

SimenB · 2022-07-29T12:17:26Z

scripts/build.sh

+# Transpile CommonJS versions of files for node
+babel --env-name commonjsNode src --source-root src --out-dir "$DIR" --copy-files --quiet
+
+# Transpile CommonJS versions of files for node


Suggested change

# Transpile CommonJS versions of files for node

# Transpile CommonJS versions of files for the browser

SimenB · 2022-07-29T12:26:49Z

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:

    strategy:
      matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x]
+        node-version: [12.x, 14.x, 16.x, 18.x]


Jest 29 will drop 12, fwiw. Might affect integration tests?

I think in here we're not yet ready to drop 12.x support. Do you know that this will break?

We've stopped testing v12, and setup babel to target v14. Not any explicit breaking changes, tho.

JSDOM v20 also has minimum node@14, fwiw

scripts/build.sh

ctavan · 2022-07-29T13:11:00Z

While I don't have proof of it, I think this change to the pkg.exports field may in fact be a breaking change for some. I'm therefore marking this as breaking change and we'll only get this change with the v9 release.

SimenB · 2022-07-29T13:21:37Z

Node version minimum changes makes this a breaking change, imo 😀

However, if you ignore that, I don't think this is breaking. People requesting browser and require will now get what they want instead of ESM. If they don't want cjs, it shouldn't be requested. And people requesting all of browser, import and require will still get the ESM version as it's above the require condition. So the exports changes in isolation are not, IMO, breaking.

broofa · 2022-07-29T16:15:19Z

Let's push this out in v9, and get v9 rolled out ASAP. I've cleaned up the project board for it, so there's only one other pending pr (#604). @ctavan: Is that something you'd be able to close out sometime soon?

If so, let's merge both these PRs and get v9 rolled out.

Jest runs browser tests in a jsdom environment which now also supports web crypto polyfills. Since ESM support in Jest is currently still limited, it requires a commonJS build for browser environments, see the discussion in #616 for all the details. Co-authored-by: Christoph Tavan <dev@tavan.de>

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [uuid](https://github.com/uuidjs/uuid) | dependencies | major | [`^8.3.2` -> `^9.0.0`](https://renovatebot.com/diffs/npm/uuid/8.3.2/9.0.0) | | [@types/uuid](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/uuid) ([source](https://github.com/DefinitelyTyped/DefinitelyTyped)) | dependencies | major | [`^8.3.0` -> `^9.0.0`](https://renovatebot.com/diffs/npm/@types%2fuuid/8.3.0/9.0.1) | --- ### Release Notes <details> <summary>uuidjs/uuid</summary> ### [`v9.0.0`](https://github.com/uuidjs/uuid/blob/HEAD/CHANGELOG.md#900-httpsgithubcomuuidjsuuidcomparev832v900-2022-09-05) [Compare Source](uuidjs/uuid@v8.3.2...v9.0.0) ##### ⚠ BREAKING CHANGES - Drop Node.js 10.x support. This library always aims at supporting one EOLed LTS release which by this time now is 12.x which has reached EOL 30 Apr 2022. - Remove the minified UMD build from the package. Minified code is hard to audit and since this is a widely used library it seems more appropriate nowadays to optimize for auditability than to ship a legacy module format that, at best, serves educational purposes nowadays. For production browser use cases, users should be using a bundler. For educational purposes, today's online sandboxes like replit.com offer convenient ways to load npm modules, so the use case for UMD through repos like UNPKG or jsDelivr has largely vanished. - Drop IE 11 and Safari 10 support. Drop support for browsers that don't correctly implement const/let and default arguments, and no longer transpile the browser build to ES2015. This also removes the fallback on msCrypto instead of the crypto API. Browser tests are run in the first supported version of each supported browser and in the latest (as of this commit) version available on Browserstack. ##### Features - optimize uuid.v1 by 1.3x uuid.v4 by 4.3x (430%) ([#597](uuidjs/uuid#597)) ([3a033f6](uuidjs/uuid@3a033f6)) - remove UMD build ([#645](uuidjs/uuid#645)) ([e948a0f](uuidjs/uuid@e948a0f)), closes [#620](uuidjs/uuid#620) - use native crypto.randomUUID when available ([#600](uuidjs/uuid#600)) ([c9e076c](uuidjs/uuid@c9e076c)) ##### Bug Fixes - add Jest/jsdom compatibility ([#642](uuidjs/uuid#642)) ([16f9c46](uuidjs/uuid@16f9c46)) - change default export to named function ([#545](uuidjs/uuid#545)) ([c57bc5a](uuidjs/uuid@c57bc5a)) - handle error when parameter is not set in v3 and v5 ([#622](uuidjs/uuid#622)) ([fcd7388](uuidjs/uuid@fcd7388)) - run npm audit fix ([#644](uuidjs/uuid#644)) ([04686f5](uuidjs/uuid@04686f5)) - upgrading from uuid3 broken link ([#568](uuidjs/uuid#568)) ([1c849da](uuidjs/uuid@1c849da)) ##### build - drop Node.js 8.x from babel transpile target ([#603](uuidjs/uuid#603)) ([aa11485](uuidjs/uuid@aa11485)) - drop support for legacy browsers (IE11, Safari 10) ([#604](uuidjs/uuid#604)) ([0f433e5](uuidjs/uuid@0f433e5)) - drop node 10.x to upgrade dev dependencies ([#653](uuidjs/uuid#653)) ([28a5712](uuidjs/uuid@28a5712)), closes [#643](uuidjs/uuid#643) ##### [8.3.2](uuidjs/uuid@v8.3.1...v8.3.2) (2020-12-08) ##### Bug Fixes - lazy load getRandomValues ([#537](uuidjs/uuid#537)) ([16c8f6d](uuidjs/uuid@16c8f6d)), closes [#536](uuidjs/uuid#536) ##### [8.3.1](uuidjs/uuid@v8.3.0...v8.3.1) (2020-10-04) ##### Bug Fixes - support expo>=39.0.0 ([#515](uuidjs/uuid#515)) ([c65a0f3](uuidjs/uuid@c65a0f3)), closes [#375](uuidjs/uuid#375) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: Renovate Bot <renovate@vylpes.com> Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/Droplet/pulls/111 Reviewed-by: Vylpes <ethan@vylpes.com> Co-authored-by: RenovateBot <renovate@vylpes.com> Co-committed-by: RenovateBot <renovate@vylpes.com>

SimenB reviewed Jul 29, 2022

View reviewed changes

ctavan force-pushed the jsdom-compatibility branch from fe74e72 to dc74aff Compare July 29, 2022 12:24

SimenB reviewed Jul 29, 2022

View reviewed changes

ctavan force-pushed the jsdom-compatibility branch 2 times, most recently from 8b6bf8f to cf58531 Compare July 29, 2022 12:48

ctavan requested review from broofa, LinusU and TrySound July 29, 2022 12:48

ctavan changed the title ~~fix: add Jest/jsdom compatibility~~ feat: add Jest/jsdom compatibility Jul 29, 2022

ctavan force-pushed the jsdom-compatibility branch from cf58531 to 0237e73 Compare July 29, 2022 12:54

broofa approved these changes Jul 29, 2022

View reviewed changes

scripts/build.sh Show resolved Hide resolved

ctavan force-pushed the jsdom-compatibility branch from 0237e73 to c1e179c Compare July 29, 2022 13:07

ctavan force-pushed the jsdom-compatibility branch from c1e179c to cb806f6 Compare August 3, 2022 09:38

ctavan merged commit 16f9c46 into main Aug 3, 2022

ctavan deleted the jsdom-compatibility branch August 3, 2022 09:45

ctavan added this to the 9.0.0 milestone Aug 3, 2022

ctavan mentioned this pull request Jan 4, 2023

[BUG] crypto.getRandomValues() not supported ember.js w/fastboot.js #672

Closed

2 tasks

jsnajdr mentioned this pull request Mar 8, 2023

Upgrade Jest from 27 to 29.5.0 WordPress/gutenberg#47388

Merged

SinanBaymammadli mentioned this pull request Apr 11, 2024

Jest fails to run with SyntaxError: Unexpected token 'export' statsig-io/react-sdk#23

Closed

mdalpozzo mentioned this pull request Aug 19, 2024

[FEE-610] update uuid from v8 to v9 appfolio/react-gears#1252

Merged

This was referenced Oct 27, 2024

chore(main): release 11.0.0 #808

Merged

chore(main): release 11.0.0 #809

Merged

This was referenced Oct 27, 2024

chore(main): release 11.0.0 #810

Closed

chore(main): release 11.0.0 #813

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add Jest/jsdom compatibility #642

feat: add Jest/jsdom compatibility #642

ctavan commented Jul 29, 2022 •

edited

Loading

SimenB commented Jul 29, 2022

SimenB Jul 29, 2022

SimenB Jul 29, 2022

ctavan Jul 29, 2022

SimenB Jul 29, 2022

ctavan commented Jul 29, 2022

SimenB commented Jul 29, 2022 •

edited

Loading

broofa commented Jul 29, 2022

	# Transpile CommonJS versions of files for node
	# Transpile CommonJS versions of files for the browser

feat: add Jest/jsdom compatibility #642

feat: add Jest/jsdom compatibility #642

Conversation

ctavan commented Jul 29, 2022 • edited Loading

SimenB commented Jul 29, 2022

SimenB Jul 29, 2022

Choose a reason for hiding this comment

SimenB Jul 29, 2022

Choose a reason for hiding this comment

ctavan Jul 29, 2022

Choose a reason for hiding this comment

SimenB Jul 29, 2022

Choose a reason for hiding this comment

ctavan commented Jul 29, 2022

SimenB commented Jul 29, 2022 • edited Loading

broofa commented Jul 29, 2022

ctavan commented Jul 29, 2022 •

edited

Loading

SimenB commented Jul 29, 2022 •

edited

Loading