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.

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

feat: Node version schema update #18796

Merged
merged 2 commits into from
Nov 5, 2021
Merged

Conversation

mjhenkes
Copy link
Member

@mjhenkes mjhenkes commented Nov 4, 2021

User facing changelog

This is a follow-up PR to #18732 where I missed updating the cypress.schema.json file with the updated values. This PR should have the same change log as the previous PR.

Thanks for spotting this @emilyrohrbough !

Additional details

How has the user experience changed?

This change will not impact user experience.

PR Tasks

  • Have new configuration options been added to the cypress.schema.json? <-- whoops, I apparently missed this step on the last pr.

@mjhenkes mjhenkes self-assigned this Nov 4, 2021
@mjhenkes mjhenkes requested a review from a team as a code owner November 4, 2021 20:39
@mjhenkes mjhenkes requested review from jennifer-shehane and removed request for a team November 4, 2021 20:39
@cypress-bot
Copy link
Contributor

cypress-bot bot commented Nov 4, 2021

Thanks for taking the time to open a PR!

@@ -244,8 +244,7 @@
"system",
"bundled"
],
"default": "bundled",
"description": "If set to 'system', Cypress will try to find a Node.js executable on your path to use when executing your plugins. Otherwise, Cypress will use the Node version bundled with Cypress."
"description": "If set to 'system', Cypress will use the node version that was used to launch the cli when executing your plugins. Otherwise, Cypress will use the Node version bundled with Cypress."
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this have 'system' as the default?

This description should be reversed also since the logic would apply if set to 'bundled'.

Suggested change
"description": "If set to 'system', Cypress will use the node version that was used to launch the cli when executing your plugins. Otherwise, Cypress will use the Node version bundled with Cypress."
"description": "If set to 'bundled', Cypress will use the Node version bundled with Cypress. Otherwise, Cypress will use the Node version that was used to launch the Cypress. This Node version is used when executing your plugins file and building spec files."

Copy link
Member Author

Choose a reason for hiding this comment

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

Technically there is no default now because adding either system or bundled will trigger the deprecation warning.

https://github.com/cypress-io/cypress/blob/9.0-release/packages/server/lib/config_options.ts#L153-L155

I'm not sure exactly how to use this file, but I didn't want to encourage people to add the 'nodeVersion' option to config.

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually should I remove the nodeVersion entry entirely because it's deprecated?

Copy link
Member

Choose a reason for hiding this comment

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

But the deprecation warning is just a warning - the value still works. I don't understand the blocker for showing the default value as it is in the schema.

Copy link
Member

Choose a reason for hiding this comment

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

If things are deprecated they are still documented as before because the value is still completely functional, it just warns that it will be removed later.

Copy link
Member Author

Choose a reason for hiding this comment

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

We met in standup and decided to restore the default and mark the option as deprecated in the description.

@cypress
Copy link

cypress bot commented Nov 4, 2021



Test summary

18577 3 214 7Flakiness 0


Run details

Project cypress
Status Failed
Commit 1943211
Started Nov 5, 2021 4:01 PM
Ended Nov 5, 2021 4:12 PM
Duration 11:09 💡
OS Linux Debian - 10.9
Browser Multiple

View run in Cypress Dashboard ➡️


Failures

Run group: 5x-driver-electron (Linux, Electron )
net_stubbing_spec.ts Failed
1 network stubbing > waiting and aliasing > can timeout waiting on a single request using "alias.request"
Run group: 5x-driver-firefox (Linux, Firefox )
xhr_spec.js Failed
1 ... > no status when request isnt forced 404
Run group: 5x-driver-chrome:beta (Linux, Chrome beta )
net_stubbing_spec.ts Failed
1 network stubbing > waiting and aliasing > can timeout waiting on a single request using "alias.request"

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

@mjhenkes mjhenkes merged commit cb7f530 into 9.0-release Nov 5, 2021
@mjhenkes mjhenkes deleted the nodeVersion-schema-update branch November 5, 2021 18:04
flotwig pushed a commit that referenced this pull request Nov 8, 2021
* Update Schema

* update to mark as deprecated and restore the default.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants