fix: support type: module in Node.js 16.17.0+ and 18.6.0+ by lmiller1990 · Pull Request #23637 · cypress-io/cypress

lmiller1990 · 2022-08-31T06:51:07Z

User facing changelog

Fix a bug where projects using Node.js 16.17+ and 18.6+ with type: module and cypress.config.ts were not working with Cypress.

Additional details

Projects with type: module using TypeScript (with a cypress.config.ts file) broke recently due to Node.js changing something on their end.

This is the exact PR to Node.js that broke everything: nodejs/node#42623. It seems even the Node.js team wasn't fully across the scope of breakage that was introduced: nodejs/node#42623 (comment)

Anyway, ts-node made some fixes in response to handle it. We use ts-node internally. I just updated the version of ts-node we ship to the latest, which has the relevant fixes. Everything seems okay now.

To test this and avoid regressions, I added two new Docker images in the cypress-docker-images repo for Node.js 16.17.0 and 18.6.0.

I then added some binary system tests to cover the Node.js versions we were not working on. I also created a branch to prove they were failing on develop (prior to this PR).

Passing (this branch): https://app.circleci.com/pipelines/github/cypress-io/cypress?branch=update-ts-node
Failing (develop + regression tests added here - expected to fail): https://app.circleci.com/pipelines/github/cypress-io/cypress?branch=lmiller%2Ftesting-module-tests

Steps to test

You could make a minimal reproduction locally like this: #22795 (comment). Then you'd build the binary and make sure it works. Or you can just see the above system tests that I added.

How has the user experience changed?

PR Tasks

Have tests been added/updated?
Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
Has a PR for user-facing changes been opened in cypress-documentation?
Have API changes been updated in the type definitions?

cypress-bot · 2022-08-31T06:51:11Z

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-08-31T07:04:45Z

Test summary

39662 • 0 • 3348 • 0 • 0

Run details


Project	cypress
Status	Passed
Commit	`5d94e74`
Started	Sep 6, 2022 11:07 PM
Ended	Sep 6, 2022 11:21 PM
Duration	14:25 💡
OS	Linux Debian - 11.3
Browser	Multiple

View run in Cypress Dashboard ➡️

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

emilyrohrbough · 2022-08-31T13:14:09Z

@lmiller1990 is this related? #23393

lmiller1990 · 2022-09-01T02:18:30Z

Yep same issue @emilyrohrbough

lmiller1990 · 2022-09-02T04:54:36Z

 export npm_config_cache=/tmp/npm_config_cache/
 export npm_config_package_lock=false

+mkdir /tmp/npm_config_cache


I had to add this, none of our existing binary system tests seem to actually install any node modules. These ones do, and without this line I get some random permission error when doing npm install in Docker.

Good find, I remember running in to that permission error while setting this up and having NFC why it was happening.

Co-authored-by: Zach Bloomquist <git@chary.us>

ZachJW34

Tested locally with latest 16 + 18 and worked like a charm 🍀

flotwig · 2022-09-06T16:07:34Z

 export npm_config_package_lock=false

+mkdir $npm_config_cache
+chown -R 1000:1000 $npm_config_cache


Since we do need the chown, I think this would be safer, since the uid/gid aren't guaranteed to always be 1000:1000. But maybe this is wrong, considering what happened when this line was deleted, could be some trickery afoot.

Suggested change

chown -R 1000:1000 $npm_config_cache

chown -R $(id -u):$(id -g) $npm_config_cache

I will try this!

Interestingly enough this also is not working 🤔

https://app.circleci.com/pipelines/github/cypress-io/cypress/42940/workflows/4929e8f3-cf0b-4e98-b1ae-4b5c6c83f6f0/jobs/1788721

Will ssh in and see what the output of id -u and id -g is.

circleci@ip-172-28-37-251:~$ id -u 1000 circleci@ip-172-28-37-251:~$ id -g 1000

Hmmmm.

Oh, chown -R $(id -u):$(id -g) $npm_config_cache is just not valid code. Try running it. chown: missing operand after ‘1000:1000.

Let's do...

uid=$(id -u) gid=$(id -g) chown -R $uid:$gui $npm_config_cache

It works for me on Linux in bash and zsh. You do have a slight typo, gid => gui

This script runs in the context of the Docker container too, not the main system... and id -u and id -g work, but by default we're running as root:

So now I'm even more confused why 1000:1000 is needed/works here, as we are running as root already.... 🤔 🤔 🤔

Co-authored-by: Zach Bloomquist <git@chary.us>

To revert once a Cypress release is available with cypress-io/cypress#23637

chore: bump ts-node version

da282e7

This was referenced Sep 1, 2022

ERR_LOADER_CHAIN_INCOMPLETE e2e in local #23393

Closed

Investigate Webpack 5 Impact #19555

Closed

debugging

5ef6bc1

lmiller1990 mentioned this pull request Sep 1, 2022

chore: workaround test-ui ci failure vitest-dev/vitest#1942

Merged

update tests with docker images and docker script

c219e2c

lmiller1990 force-pushed the update-ts-node branch from a5db874 to c219e2c Compare September 2, 2022 03:15

lmiller1990 changed the title ~~fix: support Node.js 16.17 and 18.6~~ fix: support type: module in Node.js 16.17.0+ and 18.6.0+ Sep 2, 2022

lmiller1990 marked this pull request as ready for review September 2, 2022 04:01

lmiller1990 requested review from a team, emilmilanov, emilyrohrbough, flotwig and mike-plummer and removed request for emilmilanov and mike-plummer September 2, 2022 04:32

lmiller1990 commented Sep 2, 2022

View reviewed changes

flotwig reviewed Sep 2, 2022

View reviewed changes

Comment thread system-tests/scripts/bootstrap-docker-container.sh Outdated

lmiller1990 mentioned this pull request Sep 5, 2022

ERR_LOADER_CHAIN_INCOMPLETE in CI, works locally in a Dev Container #22795

Closed

lmiller1990 and others added 2 commits September 6, 2022 09:28

Update system-tests/scripts/bootstrap-docker-container.sh

6239c49

Co-authored-by: Zach Bloomquist <git@chary.us>

use chown

c928332

Waseem826 mentioned this pull request Sep 6, 2022

Migrate Cypress to v10 kubermatic/dashboard#4929

Merged

ZachJW34 approved these changes Sep 6, 2022

View reviewed changes

flotwig reviewed Sep 6, 2022

View reviewed changes

lmiller1990 and others added 2 commits September 7, 2022 05:15

Update system-tests/scripts/bootstrap-docker-container.sh

ba26814

Co-authored-by: Zach Bloomquist <git@chary.us>

Update bootstrap-docker-container.sh

2c64dd2

Update bootstrap-docker-container.sh

5d94e74

flotwig approved these changes Sep 6, 2022

View reviewed changes

lmiller1990 merged commit b6dad0a into develop Sep 7, 2022

lmiller1990 deleted the update-ts-node branch September 7, 2022 00:21

luxaritas added a commit to eternagame/eterna-next that referenced this pull request Sep 9, 2022

Pin node version to work around cypress error

1723e7e

To revert once a Cypress release is available with cypress-io/cypress#23637

sapphi-red mentioned this pull request Sep 12, 2022

Bump node from 16.16.0-alpine to 16.17.0-alpine traPtitech/traQ_S-UI#3528

Merged

lmiller1990 mentioned this pull request Dec 5, 2022

After Spec API TypeScript Code breaks the config.ts file - [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts" #23141

Closed

	chown -R 1000:1000 $npm_config_cache
	chown -R $(id -u):$(id -g) $npm_config_cache

Conversation

lmiller1990 commented Aug 31, 2022 • edited by emilyrohrbough Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User facing changelog

Additional details

Steps to test

How has the user experience changed?

PR Tasks

Uh oh!

cypress-bot Bot commented Aug 31, 2022

Uh oh!

cypress Bot commented Aug 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test summary

Run details

Uh oh!

emilyrohrbough commented Aug 31, 2022

Uh oh!

lmiller1990 commented Sep 1, 2022

Uh oh!

lmiller1990 Sep 2, 2022

Choose a reason for hiding this comment

Uh oh!

flotwig Sep 2, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ZachJW34 left a comment

Choose a reason for hiding this comment

Uh oh!

flotwig Sep 6, 2022

Choose a reason for hiding this comment

Uh oh!

lmiller1990 Sep 6, 2022

Choose a reason for hiding this comment

Uh oh!

lmiller1990 Sep 6, 2022

Choose a reason for hiding this comment

Uh oh!

lmiller1990 Sep 6, 2022

Choose a reason for hiding this comment

Uh oh!

lmiller1990 Sep 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

flotwig Sep 6, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lmiller1990 commented Aug 31, 2022 •

edited by emilyrohrbough

Loading

cypress Bot commented Aug 31, 2022 •

edited

Loading

lmiller1990 Sep 6, 2022 •

edited

Loading