feat: adding module support for invoking cypress.config.mjs, .cjs, .ts #20554

JessicaSachs · 2022-03-10T03:27:41Z

Summary

Adds support for Cypress Config files to work with modules. Uses @egoist 's bundle-require which was created for loading library config files like vite.config.ts

We now support the following config file types:

cypress.config.mjs
cypress.config.cjs
cypress.config.js with "type": "module"
cypress.config.ts with "type": "module"

We now support ESM inside of plugins hooks (setupNodeEvents + devServer)

Closes:

UNIFY-1089

Changes made

Adding module support + exports to the cypress node api (index.mjs, cli/package.json)
Searching for additional file types (*.mjs, *.cjs) when resolving cypress.config
Using bundle-require to execute Cypress Config
Writing a ton of system tests for different package types

cypress-bot · 2022-03-10T03:27:43Z

Thanks for taking the time to open a PR!

Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.
Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

cypress · 2022-03-10T03:43:38Z

Test summary

17787 • 0 • 217 • 0 • 1

Run details


Project	cypress
Status	Passed
Commit	`9832322`
Started	Mar 14, 2022 3:00 AM
Ended	Mar 14, 2022 3:12 AM
Duration	12:21 💡
OS	Linux Debian - 10.10
Browser	Multiple

View run in Cypress Dashboard ➡️

Flakiness

	cypress/e2e/commands/xhr.cy.js		1
1	... > no status when request isnt forced 404

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

lmiller1990

Nice job getting this through so quickly. I left some comments, most important one is adding the watcher to a cypress.config.mjs if it exists.

packages/data-context/src/data/ProjectLifecycleManager.ts

system-tests/projects/config-cjs-and-esm/config-with-ts-module/cypress.config.ts

system-tests/test/config_modules_spec.ts

elevatebart · 2022-03-10T15:05:03Z

Did you try it with UNIFY-1135 ?

…s5 and es3

packages/server/lib/plugins/child/run_require_async_child.js

…cypress into fix/typescript-module-config

packages/data-context/src/data/ProjectLifecycleManager.ts

packages/server/lib/plugins/child/run_require_async_child.js

lmiller1990

Some comments!

packages/data-context/src/data/ProjectLifecycleManager.ts

…cypress into fix/typescript-module-config

lmiller1990 · 2022-03-11T04:31:28Z

@elevatebart seems that way: https://cypress-io.atlassian.net/browse/UNIFY-1135?focusedCommentId=16913

lmiller1990

all my blocking comments are ✔️ so seems fine - added 1 more question. Can we please assign someone from E2E to review this too?

lmiller1990 · 2022-03-11T04:31:57Z

cli/package.json

+      "import": "./index.mjs",
+      "require": "./index.js"
+    },
+    "./package.json": {


Q: what does this do?

https://nodejs.org/api/packages.html#package-entry-points allows package.json to be accessible. See "Package Entry Points"

resolved

tgriesser

Thank you for adding this!

tgriesser · 2022-03-11T14:35:29Z

packages/server/lib/plugins/child/run_require_async_child.js

+      if (err.stack.includes(`Cannot find package 'esbuild'`)) {
+        debug(`User doesn't have esbuild. Going to use native node imports.`)
+


Do we expect this to work? Should we just throw an error that's like

"Hey, Cypress depends on esbuild for ESM support, please install it and try again"

Should we have it as a "real" dependency and only use it if typescript is detected?

This works fine for all TS projects where type != module. We don't need to fail -- we can just fall back.

lmiller1990 · 2022-03-14T02:41:21Z

packages/server/lib/plugins/child/run_require_async_child.js

-      if (legacyPlugins && typeof legacyPlugins.default === 'function') {
-        legacyPlugins = legacyPlugins.default
-      }
+  // Config file loading of modules is tested within


This got butchered during the rebase, I put all the "legacy config" stuff at the bottom.

lmiller1990

Looks good. I merged in 10.0-release and resolved the conflicts.

tbiethman

Works great, nice tests too 👍

feat: adding module support for invoking cypress.config.mjs, .cjs, .ts

509c3cb

feat: adding module support for invoking cypress.config.mjs, .cjs, .ts

5aff3ee

JessicaSachs marked this pull request as ready for review March 10, 2022 04:43

JessicaSachs added 2 commits March 9, 2022 23:43

whitespace

6a3dca9

adding another project example

b8ea545

JessicaSachs requested review from tgriesser, brian-mann and lmiller1990 March 10, 2022 04:55

removing multiple calls to existsSync

f03ee26

lmiller1990 reviewed Mar 10, 2022

View reviewed changes

packages/data-context/src/data/ProjectLifecycleManager.ts Outdated Show resolved Hide resolved

system-tests/projects/config-cjs-and-esm/config-with-ts-module/cypress.config.ts Outdated Show resolved Hide resolved

system-tests/test/config_modules_spec.ts Show resolved Hide resolved

JessicaSachs added 2 commits March 10, 2022 00:57

adding additional files to watcher

af08d0f

respell

08510bc

JessicaSachs force-pushed the fix/typescript-module-config branch from b999185 to 08510bc Compare March 10, 2022 06:07

jennifer-shehane self-requested a review March 10, 2022 12:50

jennifer-shehane removed their request for review March 10, 2022 18:48

updating errors and adding additional tests for tsconfig.json using e…

705408c

…s5 and es3

JessicaSachs force-pushed the fix/typescript-module-config branch from 12a1447 to 705408c Compare March 11, 2022 00:01

Merge branch '10.0-release' into fix/typescript-module-config

4a9e9ee

tgriesser requested changes Mar 11, 2022

View reviewed changes

packages/server/lib/plugins/child/run_require_async_child.js Outdated Show resolved Hide resolved

JessicaSachs added 2 commits March 10, 2022 20:41

swapping build logic for config

2cea3b7

Merge branch 'fix/typescript-module-config' of github.com:cypress-io/…

8960955

…cypress into fix/typescript-module-config

tgriesser reviewed Mar 11, 2022

View reviewed changes

packages/data-context/src/data/ProjectLifecycleManager.ts Show resolved Hide resolved

tgriesser requested changes Mar 11, 2022

View reviewed changes

packages/server/lib/plugins/child/run_require_async_child.js Outdated Show resolved Hide resolved

lmiller1990 reviewed Mar 11, 2022

View reviewed changes

packages/data-context/src/data/ProjectLifecycleManager.ts Show resolved Hide resolved

packages/data-context/src/data/ProjectLifecycleManager.ts Show resolved Hide resolved

JessicaSachs added 3 commits March 10, 2022 20:57

resetting allFoundConfigFiles

110527d

updating text

ae8f3a8

loading bundleRequire if esm fails

5d7bb32

lmiller1990 reviewed Mar 11, 2022

View reviewed changes

packages/data-context/src/data/ProjectLifecycleManager.ts Show resolved Hide resolved

JessicaSachs added 4 commits March 10, 2022 22:34

removing case insensitive test

aaae31c

Merge branch '10.0-release' into fix/typescript-module-config

5199e44

testing vue specific failures

d4d8572

Merge branch 'fix/typescript-module-config' of github.com:cypress-io/…

e71026d

…cypress into fix/typescript-module-config

lmiller1990 self-requested a review March 11, 2022 04:31

lmiller1990 previously approved these changes Mar 11, 2022

View reviewed changes

JessicaSachs requested review from tgriesser and flotwig March 11, 2022 04:48

Merge branch '10.0-release' into fix/typescript-module-config

77edee3

JessicaSachs dismissed lmiller1990’s stale review via 77edee3 March 11, 2022 05:01

tgriesser approved these changes Mar 11, 2022

View reviewed changes

tgriesser previously approved these changes Mar 11, 2022

View reviewed changes

tgriesser reviewed Mar 11, 2022

View reviewed changes

tgriesser requested a review from tbiethman March 11, 2022 18:50

merge in remote and resolve conflicts

d0d5793

lmiller1990 dismissed tgriesser’s stale review via d0d5793 March 14, 2022 02:40

lmiller1990 reviewed Mar 14, 2022

View reviewed changes

rename variable missed during rebase

9832322

lmiller1990 self-requested a review March 14, 2022 04:13

lmiller1990 approved these changes Mar 14, 2022

View reviewed changes

tgriesser self-requested a review March 14, 2022 11:26

tgriesser approved these changes Mar 14, 2022

View reviewed changes

tbiethman approved these changes Mar 14, 2022

View reviewed changes

tgriesser merged commit c2cc967 into 10.0-release Mar 14, 2022

tgriesser deleted the fix/typescript-module-config branch March 14, 2022 14:46

emilyrohrbough mentioned this pull request Mar 15, 2022

unification audit cypress-io/cypress-documentation#4384

Closed

Pashozator mentioned this pull request Dec 11, 2022

Support cypress ^10.0.0 SMenigat/cypress-mailhog#34

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adding module support for invoking cypress.config.mjs, .cjs, .ts #20554

feat: adding module support for invoking cypress.config.mjs, .cjs, .ts #20554

JessicaSachs commented Mar 10, 2022 •

edited

Loading

cypress-bot bot commented Mar 10, 2022

cypress bot commented Mar 10, 2022 •

edited

Loading

lmiller1990 left a comment

elevatebart commented Mar 10, 2022

lmiller1990 left a comment

lmiller1990 commented Mar 11, 2022

lmiller1990 left a comment

lmiller1990 Mar 11, 2022

JessicaSachs Mar 11, 2022

tgriesser left a comment

tgriesser Mar 11, 2022

elevatebart Mar 11, 2022

JessicaSachs Mar 11, 2022

lmiller1990 Mar 14, 2022

lmiller1990 left a comment

tbiethman left a comment

		if (err.stack.includes(`Cannot find package 'esbuild'`)) {
		debug(`User doesn't have esbuild. Going to use native node imports.`)

feat: adding module support for invoking cypress.config.mjs, .cjs, .ts #20554

feat: adding module support for invoking cypress.config.mjs, .cjs, .ts #20554

Conversation

JessicaSachs commented Mar 10, 2022 • edited Loading

Summary

Changes made

cypress-bot bot commented Mar 10, 2022

cypress bot commented Mar 10, 2022 • edited Loading

Test summary

Run details

Flakiness

lmiller1990 left a comment

Choose a reason for hiding this comment

elevatebart commented Mar 10, 2022

lmiller1990 left a comment

Choose a reason for hiding this comment

lmiller1990 commented Mar 11, 2022

lmiller1990 left a comment

Choose a reason for hiding this comment

lmiller1990 Mar 11, 2022

Choose a reason for hiding this comment

JessicaSachs Mar 11, 2022

Choose a reason for hiding this comment

tgriesser left a comment

Choose a reason for hiding this comment

tgriesser Mar 11, 2022

Choose a reason for hiding this comment

elevatebart Mar 11, 2022

Choose a reason for hiding this comment

JessicaSachs Mar 11, 2022

Choose a reason for hiding this comment

lmiller1990 Mar 14, 2022

Choose a reason for hiding this comment

lmiller1990 left a comment

Choose a reason for hiding this comment

tbiethman left a comment

Choose a reason for hiding this comment

JessicaSachs commented Mar 10, 2022 •

edited

Loading

cypress bot commented Mar 10, 2022 •

edited

Loading