Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: support loading config files for projects with type module, without esbuild #21574

Merged
merged 24 commits into from
May 31, 2022
Merged

fix: support loading config files for projects with type module, without esbuild #21574

Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
53d500c
fix: support loading config files for projects with type module, with…
JessicaSachs May 19, 2022
a18bb9e
Update packages/server/lib/plugins/child/run_require_async_child.js
JessicaSachs May 19, 2022
5733d7c
Update packages/server/lib/plugins/child/run_require_async_child.js
JessicaSachs May 19, 2022
2d4399e
Merge branch '10.0-release' into fix/module-projects-without-esbuild
JessicaSachs May 20, 2022
3d06929
Merge branch '10.0-release' into fix/module-projects-without-esbuild
JessicaSachs May 23, 2022
63b428a
fix: adding process.cwd() to require.resolve paths so that system-tes…
JessicaSachs May 23, 2022
d007fd6
Merge branch '10.0-release' into fix/module-projects-without-esbuild
tgriesser May 24, 2022
a7c71dd
Merge branch 'develop' of github.com:cypress-io/cypress into fix/modu…
JessicaSachs May 26, 2022
7c5350a
fix: missing esbuild from test
JessicaSachs May 26, 2022
d5ba8cc
Merge branch 'fix/module-projects-without-esbuild' of github.com:cypr…
JessicaSachs May 26, 2022
89d2077
Merge branch 'develop' into fix/module-projects-without-esbuild
JessicaSachs May 27, 2022
7ed4ba7
Merge branch 'develop' into fix/module-projects-without-esbuild
JessicaSachs May 27, 2022
e77a696
Merge branch 'develop' into fix/module-projects-without-esbuild
JessicaSachs May 27, 2022
582e2c4
test
JessicaSachs May 27, 2022
69e530a
Merge remote-tracking branch 'origin' into fix/module-projects-withou…
JessicaSachs May 27, 2022
d35c9ed
Merge branch 'fix/module-projects-without-esbuild' of github.com:cypr…
JessicaSachs May 27, 2022
26e1378
build plz
flotwig May 27, 2022
d437afd
Merge branch 'develop' into fix/module-projects-without-esbuild
tgriesser May 31, 2022
facb21c
Merge branch 'develop' into fix/module-projects-without-esbuild
mjhenkes May 31, 2022
c952a29
Update test case to capture failure
tgriesser May 31, 2022
d2d8d15
Merge branch 'develop' into fix/module-projects-without-esbuild
mjhenkes May 31, 2022
310a44e
empty message for fresh CI
tgriesser May 31, 2022
08a87d8
fix flaky test
tgriesser May 31, 2022
71cbb69
See if esbuild helps with migration-e2e-module on windows
tgriesser May 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/server/lib/plugins/child/run_require_async_child.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,14 @@ function run (ipc, file, projectRoot) {
try {
debug('Trying to use esbuild to run their config file.')
// We prefer doing this because it supports TypeScript files
require.resolve('esbuild')
require.resolve('esbuild', { paths: [process.cwd()] })
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The absence of this line was actually a bug and it was only working on my machine because of some GLOBAL transitive deps with esbuild.

To debug this, you can add

require.resolve.paths('esbuild')

to a production-built binary installed in a real project. We should really consider moving some of these low-dependency or no-dependency tests OUTSIDE of the system-tests and into the binary-system-tests phase.


debug(`They have esbuild, so we'll load the configFile via bundleRequire`)
const { bundleRequire } = require('bundle-require')

return (await bundleRequire({ filepath: file })).mod
} catch (err) {
if (err.stack.includes(`Cannot find package 'esbuild'`)) {
if (err.stack.includes(`Cannot find module 'esbuild'`)) {
tgriesser marked this conversation as resolved.
Show resolved Hide resolved
debug(`User doesn't have esbuild. Going to use native node imports.`)

// We cannot replace the initial `require` with `await import` because
Expand Down
3 changes: 2 additions & 1 deletion system-tests/projects/config-with-ts-module-error/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"dependencies": {
"find-up": "6.3.0"
"find-up": "6.3.0",
"esbuild": "0.14.39"
},
"type": "module"
}
126 changes: 126 additions & 0 deletions system-tests/projects/config-with-ts-module-error/yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,132 @@
# yarn lockfile v1


esbuild-android-64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-android-64/-/esbuild-android-64-0.14.39.tgz#09f12a372eed9743fd77ff6d889ac14f7b340c21"
integrity sha512-EJOu04p9WgZk0UoKTqLId9VnIsotmI/Z98EXrKURGb3LPNunkeffqQIkjS2cAvidh+OK5uVrXaIP229zK6GvhQ==

esbuild-android-arm64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-android-arm64/-/esbuild-android-arm64-0.14.39.tgz#f608d00ea03fe26f3b1ab92a30f99220390f3071"
integrity sha512-+twajJqO7n3MrCz9e+2lVOnFplRsaGRwsq1KL/uOy7xK7QdRSprRQcObGDeDZUZsacD5gUkk6OiHiYp6RzU3CA==

esbuild-darwin-64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-darwin-64/-/esbuild-darwin-64-0.14.39.tgz#31528daa75b4c9317721ede344195163fae3e041"
integrity sha512-ImT6eUw3kcGcHoUxEcdBpi6LfTRWaV6+qf32iYYAfwOeV+XaQ/Xp5XQIBiijLeo+LpGci9M0FVec09nUw41a5g==

esbuild-darwin-arm64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-darwin-arm64/-/esbuild-darwin-arm64-0.14.39.tgz#247f770d86d90a215fa194f24f90e30a0bd97245"
integrity sha512-/fcQ5UhE05OiT+bW5v7/up1bDsnvaRZPJxXwzXsMRrr7rZqPa85vayrD723oWMT64dhrgWeA3FIneF8yER0XTw==

esbuild-freebsd-64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-freebsd-64/-/esbuild-freebsd-64-0.14.39.tgz#479414d294905055eb396ebe455ed42213284ee0"
integrity sha512-oMNH8lJI4wtgN5oxuFP7BQ22vgB/e3Tl5Woehcd6i2r6F3TszpCnNl8wo2d/KvyQ4zvLvCWAlRciumhQg88+kQ==

esbuild-freebsd-arm64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-freebsd-arm64/-/esbuild-freebsd-arm64-0.14.39.tgz#cedeb10357c88533615921ae767a67dc870a474c"
integrity sha512-1GHK7kwk57ukY2yI4ILWKJXaxfr+8HcM/r/JKCGCPziIVlL+Wi7RbJ2OzMcTKZ1HpvEqCTBT/J6cO4ZEwW4Ypg==

esbuild-linux-32@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-linux-32/-/esbuild-linux-32-0.14.39.tgz#d9f008c4322d771f3958f59c1eee5a05cdf92485"
integrity sha512-g97Sbb6g4zfRLIxHgW2pc393DjnkTRMeq3N1rmjDUABxpx8SjocK4jLen+/mq55G46eE2TA0MkJ4R3SpKMu7dg==

esbuild-linux-64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-linux-64/-/esbuild-linux-64-0.14.39.tgz#ba58d7f66858913aeb1ab5c6bde1bbd824731795"
integrity sha512-4tcgFDYWdI+UbNMGlua9u1Zhu0N5R6u9tl5WOM8aVnNX143JZoBZLpCuUr5lCKhnD0SCO+5gUyMfupGrHtfggQ==

esbuild-linux-arm64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-linux-arm64/-/esbuild-linux-arm64-0.14.39.tgz#708785a30072702b5b1c16b65cf9c25c51202529"
integrity sha512-23pc8MlD2D6Px1mV8GMglZlKgwgNKAO8gsgsLLcXWSs9lQsCYkIlMo/2Ycfo5JrDIbLdwgP8D2vpfH2KcBqrDQ==

esbuild-linux-arm@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-linux-arm/-/esbuild-linux-arm-0.14.39.tgz#4e8b5deaa7ab60d0d28fab131244ef82b40684f4"
integrity sha512-t0Hn1kWVx5UpCzAJkKRfHeYOLyFnXwYynIkK54/h3tbMweGI7dj400D1k0Vvtj2u1P+JTRT9tx3AjtLEMmfVBQ==

esbuild-linux-mips64le@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-linux-mips64le/-/esbuild-linux-mips64le-0.14.39.tgz#6f3bf3023f711084e5a1e8190487d2020f39f0f7"
integrity sha512-epwlYgVdbmkuRr5n4es3B+yDI0I2e/nxhKejT9H0OLxFAlMkeQZxSpxATpDc9m8NqRci6Kwyb/SfmD1koG2Zuw==

esbuild-linux-ppc64le@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-linux-ppc64le/-/esbuild-linux-ppc64le-0.14.39.tgz#900e718a4ea3f6aedde8424828eeefdd4b48d4b9"
integrity sha512-W/5ezaq+rQiQBThIjLMNjsuhPHg+ApVAdTz2LvcuesZFMsJoQAW2hutoyg47XxpWi7aEjJGrkS26qCJKhRn3QQ==

esbuild-linux-riscv64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-linux-riscv64/-/esbuild-linux-riscv64-0.14.39.tgz#dcbff622fa37047a75d2ff7a1d8d2949d80277e4"
integrity sha512-IS48xeokcCTKeQIOke2O0t9t14HPvwnZcy+5baG13Z1wxs9ZrC5ig5ypEQQh4QMKxURD5TpCLHw2W42CLuVZaA==

esbuild-linux-s390x@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-linux-s390x/-/esbuild-linux-s390x-0.14.39.tgz#3f725a7945b419406c99d93744b28552561dcdfd"
integrity sha512-zEfunpqR8sMomqXhNTFEKDs+ik7HC01m3M60MsEjZOqaywHu5e5682fMsqOlZbesEAAaO9aAtRBsU7CHnSZWyA==

esbuild-netbsd-64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-netbsd-64/-/esbuild-netbsd-64-0.14.39.tgz#e10e40b6a765798b90d4eb85901cc85c8b7ff85e"
integrity sha512-Uo2suJBSIlrZCe4E0k75VDIFJWfZy+bOV6ih3T4MVMRJh1lHJ2UyGoaX4bOxomYN3t+IakHPyEoln1+qJ1qYaA==

esbuild-openbsd-64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-openbsd-64/-/esbuild-openbsd-64-0.14.39.tgz#935ec143f75ce10bd9cdb1c87fee00287eb0edbc"
integrity sha512-secQU+EpgUPpYjJe3OecoeGKVvRMLeKUxSMGHnK+aK5uQM3n1FPXNJzyz1LHFOo0WOyw+uoCxBYdM4O10oaCAA==

esbuild-sunos-64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-sunos-64/-/esbuild-sunos-64-0.14.39.tgz#0e7aa82b022a2e6d55b0646738b2582c2d72c3c0"
integrity sha512-qHq0t5gePEDm2nqZLb+35p/qkaXVS7oIe32R0ECh2HOdiXXkj/1uQI9IRogGqKkK+QjDG+DhwiUw7QoHur/Rwg==

esbuild-windows-32@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-windows-32/-/esbuild-windows-32-0.14.39.tgz#3f1538241f31b538545f4b5841b248cac260fa35"
integrity sha512-XPjwp2OgtEX0JnOlTgT6E5txbRp6Uw54Isorm3CwOtloJazeIWXuiwK0ONJBVb/CGbiCpS7iP2UahGgd2p1x+Q==

esbuild-windows-64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-windows-64/-/esbuild-windows-64-0.14.39.tgz#b100c59f96d3c2da2e796e42fee4900d755d3e03"
integrity sha512-E2wm+5FwCcLpKsBHRw28bSYQw0Ikxb7zIMxw3OPAkiaQhLVr3dnVO8DofmbWhhf6b97bWzg37iSZ45ZDpLw7Ow==

esbuild-windows-arm64@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild-windows-arm64/-/esbuild-windows-arm64-0.14.39.tgz#00268517e665b33c89778d61f144e4256b39f631"
integrity sha512-sBZQz5D+Gd0EQ09tZRnz/PpVdLwvp/ufMtJ1iDFYddDaPpZXKqPyaxfYBLs3ueiaksQ26GGa7sci0OqFzNs7KA==

esbuild@0.14.39:
version "0.14.39"
resolved "https://registry.yarnpkg.com/esbuild/-/esbuild-0.14.39.tgz#c926b2259fe6f6d3a94f528fb42e103c5a6d909a"
integrity sha512-2kKujuzvRWYtwvNjYDY444LQIA3TyJhJIX3Yo4+qkFlDDtGlSicWgeHVJqMUP/2sSfH10PGwfsj+O2ro1m10xQ==
optionalDependencies:
esbuild-android-64 "0.14.39"
esbuild-android-arm64 "0.14.39"
esbuild-darwin-64 "0.14.39"
esbuild-darwin-arm64 "0.14.39"
esbuild-freebsd-64 "0.14.39"
esbuild-freebsd-arm64 "0.14.39"
esbuild-linux-32 "0.14.39"
esbuild-linux-64 "0.14.39"
esbuild-linux-arm "0.14.39"
esbuild-linux-arm64 "0.14.39"
esbuild-linux-mips64le "0.14.39"
esbuild-linux-ppc64le "0.14.39"
esbuild-linux-riscv64 "0.14.39"
esbuild-linux-s390x "0.14.39"
esbuild-netbsd-64 "0.14.39"
esbuild-openbsd-64 "0.14.39"
esbuild-sunos-64 "0.14.39"
esbuild-windows-32 "0.14.39"
esbuild-windows-64 "0.14.39"
esbuild-windows-arm64 "0.14.39"

find-up@6.3.0:
version "6.3.0"
resolved "https://registry.yarnpkg.com/find-up/-/find-up-6.3.0.tgz#2abab3d3280b2dc7ac10199ef324c4e002c8c790"
Expand Down
14 changes: 13 additions & 1 deletion system-tests/test/config_modules_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ describe('cypress config with esm and cjs', function () {
'config-cjs-and-esm/config-with-mjs',
'config-cjs-and-esm/config-with-cjs',
'config-cjs-and-esm/config-with-js-module',
'config-cjs-and-esm/config-with-ts-module',

// This covers Vite and SvelteKit e2e projects
'config-cjs-and-esm/config-with-ts-module-and-esbuild',
Expand All @@ -23,6 +22,19 @@ describe('cypress config with esm and cjs', function () {
})
})

// TODO: add support for ts-node/esm https://github.com/cypress-io/cypress/issues/21939
;[
'config-cjs-and-esm/config-with-ts-module',
].forEach((project) => {
systemTests.it(`does not support modules and ts without esbuild in ${project}`, {
project,
testingType: 'e2e',
spec: 'app.cy.js',
browser: 'chrome',
expectedExitCode: 1,
})
})

;[
'config-cjs-and-esm/config-with-ts-module-component',
].forEach((project) => {
Expand Down