feat: throw when writing to 'read only' properties of config
#18896
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for taking the time to open a PR!
|
|
Test summary
Run details
View run in Cypress Dashboard ➡️ Flakiness
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 |
||||||||||||||||||||||||||||||||||||||||||
…thub.com/cypress-io/cypress into issue-6407-warn-for-read-only-properties
chrisbreiding
previously approved these changes
Dec 9, 2021
tbiethman
reviewed
Dec 9, 2021
| configUtil.validateNoReadOnlyConfig({ foo: 'bar' }, errorFn) | ||
|
|
||
| expect(errorFn).to.been.callCount(0) | ||
| }) |
There was a problem hiding this comment.
Can we also assert that the argument passed to the error function is the expected option?
There was a problem hiding this comment.
While you're at it, expect(errorFn).to.have.callCount(0) or expect(errorFn).not.to.have.beenCalled 😬
There was a problem hiding this comment.
Should be updated!
tbiethman
previously approved these changes
Dec 9, 2021
davidmunechika
dismissed stale reviews from tbiethman and chrisbreiding
via
54e7548
chrisbreiding
previously approved these changes
Dec 9, 2021
tbiethman
previously approved these changes
Dec 9, 2021
davidmunechika
dismissed stale reviews from tbiethman and chrisbreiding
via
abfabc0
chrisbreiding
approved these changes
Dec 9, 2021
tbiethman
approved these changes
Dec 9, 2021
emilyrohrbough
approved these changes
Dec 9, 2021
tgriesser
added a commit
that referenced
this pull request
Dec 15, 2021
* develop: chore(deps): update dependency ssri to 6.0.2 [security] (#19351) chore: Fix server unit tests running on mac by using actual tmp dir (#19350) fix: Add more precise types to Cypress.Commands (#19003) fix: Do not screenshot or trigger the failed event when tests are skipped (#19331) fix (#19262) fix: throw when writing to 'read only' properties of `config` (#18896) fix: close chrome when closing electron (#19322) fix: disable automatic request retries (#19161) chore: refactor cy funcs (#19080) chore(deps): update dependency @ffmpeg-installer/ffmpeg to v1.1.0 🌟 (#19300)
jennifer-shehane
changed the title
configconfig
tgriesser
added a commit
that referenced
this pull request
Dec 16, 2021
…cycle * 10.0-release: build: remove syncRemoteGraphQL from codegen chore: fix incorrect type from merge build: allow work with local dashboard (#19376) chore: Test example recipes against chrome (#19362) test(unify): Settings e2e tests (#19324) chore(deps): update dependency ssri to 6.0.2 [security] (#19351) fix: spec from story generation, add deps for install (#19352) chore: Fix server unit tests running on mac by using actual tmp dir (#19350) fix: Add more precise types to Cypress.Commands (#19003) fix: Do not screenshot or trigger the failed event when tests are skipped (#19331) fix (#19262) fix: throw when writing to 'read only' properties of `config` (#18896) fix: close chrome when closing electron (#19322) fix: disable automatic request retries (#19161) chore: refactor cy funcs (#19080) chore(deps): update dependency @ffmpeg-installer/ffmpeg to v1.1.0 🌟 (#19300)
|
Edit: this is what I get for half doing something on my time off. I just realized we set in the test suite to test the SDK option. 🤦🏼♂️ false alarm |
2 tasks
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
config#6407User facing changelog
Cypress will throw an error when a user attempts to set these 'non-writable' config values using
Cypress.config.Additional details
The following were identified as properties that could be updated during test time:
The following were identified as read-only properties for per test config:
User experience
Trying to set read-only config in test configuration:
Trying to set read-only config within test with Cypress.config():
PR Tasks
cypress-documentation? Update List of Valid Test Configuration Config Values cypress-documentation#4252type definitions?cypress.schema.json?