feat: support ct/e2e specific overrides in cypress.json #15444

lmiller1990 · 2021-03-12T02:11:31Z

Closes https://cypress-io.atlassian.net/browse/CT-305?focusedCommentId=13398

Note: This behavior and API was discussed over the course of two meetings and validated with Brian, Zach, and Jess.

User facing changelog

1. Add support for runner specific overrides in `cypress.json`. Like this:

// cypress.json
{
    // defaults
    video: true,

    // added this e2e key
    e2e: {
	  video: false // override!
	},

    // added component
    component: { 
      viewportWidth: 500 // video is true - inherited.
    }
}

2. Pass `mode` to plugins function

Note the third argument is mode. This is component or e2e. The user can have conditional plugins using this flag.

module.exports = (on, config, mode) => {
  if (mode === 'component') {
    // start webpack-dev-server, etc.
  }

  if (mode === 'e2e') {
    // e2e things
  }

  // You still need to return a config file.
  // e2e or CT specific config can be done in `cypress.json` using `e2e` or `component` keys.
  return config
}

Additional details

It's very useful now that we have two runners, CT and E2E.

How has the user experience changed?

You can have runner specific config, and runner specific plugins.

PR Tasks

Have tests been added/updated?
Has a PR for user-facing changes been opened in [cypress-documentation] NO. NEED TO DO THIS PRE 7.0.
Have API changes been updated in the type definitions? Yes.
Have new configuration options been added to the cypress.schema.json? Yes.

cypress-bot · 2021-03-12T02:11:33Z

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.

lmiller1990 · 2021-03-12T02:12:50Z

npm/react/cypress/plugins/index.js

-module.exports = (on, config) => {
+module.exports = (on, config, mode) => {
+  if (mode !== 'component') {
+    throw Error('This is an component project. mode should be `component`.')


This is a good way to test that mode is passed correctly. We expect this project to be only used with runner-ct.

github-actions · 2021-03-12T02:29:08Z

Internal Jira issue: TR-702

lmiller1990 · 2021-03-12T02:39:28Z

packages/server/lib/util/settings.js

@@ -93,6 +93,10 @@ module.exports = {
    }, _.cloneDeep(obj))
  },

+  isComponentTesting (options = {}) {
+    return options.experimentalComponentTesting || options.componentTesting || options.testingType === 'component'
+  },


We have a lot of flags for CT, apparently... we should reduce these to just one or two eventually.

Oy vey. Yeah we need to do this like ASAP.

cypress · 2021-03-12T02:47:46Z

Test summary

3982 • 0 • 49 • 2

Run details


Project	cypress
Status	Passed
Commit	`3245164`
Started	Mar 13, 2021 12:57 AM
Ended	Mar 13, 2021 1:07 AM
Duration	09:18 💡
OS	Linux Debian - 10.5
Browser	Chrome 83

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

elevatebart

Overall great PR.
A few improvements to the json schema.

I believe the word mode is used to differentiate run from open.
Should it be used as well for component vs e2e?
That is confusing.
How about context or buildMode?

cli/schema/cypress.schema.json

npm/vue/cypress/plugins/index.js

packages/server-ct/src/project-ct.ts

elevatebart · 2021-03-12T18:02:44Z

Is there a place where we can test the new JSON schema?
I do not see it used anywhere.

An idea could be to use the $schema flag at the top of a file containing a valid cypress.json with all options just to make sure it still works.
This can be done in a spec using ajv
EDIT: will be fined in https://cypress-io.atlassian.net/browse/CT-347

elevatebart

To avoid blocking the PR, I change my review to comment

To avoid blocking PR

…)" This reverts commit a94c9d5.

chrisbreiding · 2021-03-15T20:37:36Z

We had to revert this for 6.7.1 in #15499. I'd recommend re-submitting it against the 7.0-release branch so it will go out with 7.0.0.

I don't think we should add a 3rd argument to the plugins file function. It should be a property on the config argument. We've augmented that object before for environment details.

…)" This reverts commit a94c9d5.

gdibble · 2021-07-08T00:20:26Z

We had to revert this for 6.7.1 in #15499. I'd recommend re-submitting it against the 7.0-release branch so it will go out with 7.0.0.

I don't think we should add a 3rd argument to the plugins file function. It should be a property on the config argument. We've augmented that object before for environment details.

Hi @chrisbreiding, did cypress.config.[js,ts] land in v7?
🙏 Thanks

lmiller1990 · 2021-07-08T00:43:27Z

@gdibble not yet, it is getting worked on. You can follow the progress here: #17000

gdibble · 2021-07-08T01:26:37Z

TY @lmiller1990 - I appreciate the tracking info 👍

lmiller1990 added 2 commits March 12, 2021 11:07

feat: support ct/e2e specific overrides in cypress.json

b7725f5

feat: pass mode to plugins

ce06ccb

lmiller1990 commented Mar 12, 2021

View reviewed changes

fix: correctly merge options

57a0f87

lmiller1990 mentioned this pull request Mar 12, 2021

feat: support cypress.js for config #15280

Closed

5 tasks

lmiller1990 added the internal-priority label Mar 12, 2021

lmiller1990 commented Mar 12, 2021

View reviewed changes

lmiller1990 added 2 commits March 12, 2021 14:13

chore: fix failing test

b4a7823

fix: flaky test

0291af0

lmiller1990 marked this pull request as ready for review March 12, 2021 04:54

lmiller1990 requested review from elevatebart, flotwig, brian-mann, jennifer-shehane and JessicaSachs March 12, 2021 04:54

chore: update cypress schema and types

b70d69f

elevatebart previously requested changes Mar 12, 2021

View reviewed changes

cli/schema/cypress.schema.json Outdated Show resolved Hide resolved

npm/vue/cypress/plugins/index.js Show resolved Hide resolved

packages/server-ct/src/project-ct.ts Show resolved Hide resolved

fix: make schema validate overrides

7db103a

elevatebart reviewed Mar 12, 2021

View reviewed changes

JessicaSachs previously approved these changes Mar 12, 2021

View reviewed changes

Merge branch 'develop' into feat/ct-e2e-specific-config

f9e14af

JessicaSachs requested a review from elevatebart March 12, 2021 22:56

Merge branch 'develop' into feat/ct-e2e-specific-config

0d40745

JessicaSachs dismissed their stale review via 0d40745 March 12, 2021 22:59

Merge branch 'develop' into feat/ct-e2e-specific-config

3245164

JessicaSachs approved these changes Mar 13, 2021

View reviewed changes

JessicaSachs merged commit a94c9d5 into develop Mar 13, 2021

JessicaSachs deleted the feat/ct-e2e-specific-config branch March 13, 2021 08:47

lmiller1990 mentioned this pull request Mar 15, 2021

docs: document mode argument to plugins cypress-io/cypress-documentation#3693

Merged

This was referenced Mar 15, 2021

build(deps): bump cypress from 6.6.0 to 6.7.0 in /frontend r-k-b/noticeimilate#97

Closed

build(deps-dev): bump cypress from 6.6.0 to 6.7.0 r-k-b/tulars#154

Closed

chrisbreiding added a commit that referenced this pull request Mar 15, 2021

Revert "feat: support ct/e2e specific overrides in cypress.json (#15444…

280834c

…)" This reverts commit a94c9d5.

dependabot bot mentioned this pull request Mar 15, 2021

Bump cypress from 6.5.0 to 6.7.0 hmsk/vite-plugin-markdown#107

Closed

chrisbreiding mentioned this pull request Mar 15, 2021

fix: Revert cypress.json changes #15499

Merged

2 tasks

chrisbreiding added a commit that referenced this pull request Mar 15, 2021

Revert "feat: support ct/e2e specific overrides in cypress.json (#15444…

ff4a824

…)" This reverts commit a94c9d5.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support ct/e2e specific overrides in cypress.json #15444

feat: support ct/e2e specific overrides in cypress.json #15444

lmiller1990 commented Mar 12, 2021 •

edited

Loading

cypress-bot bot commented Mar 12, 2021

lmiller1990 Mar 12, 2021

github-actions bot commented Mar 12, 2021

lmiller1990 Mar 12, 2021

JessicaSachs Mar 12, 2021

cypress bot commented Mar 12, 2021 •

edited

Loading

elevatebart left a comment

elevatebart commented Mar 12, 2021 •

edited

Loading

elevatebart left a comment

chrisbreiding commented Mar 15, 2021

gdibble commented Jul 8, 2021

lmiller1990 commented Jul 8, 2021

gdibble commented Jul 8, 2021

feat: support ct/e2e specific overrides in cypress.json #15444

feat: support ct/e2e specific overrides in cypress.json #15444

Conversation

lmiller1990 commented Mar 12, 2021 • edited Loading

User facing changelog

1. Add support for runner specific overrides in cypress.json. Like this:

2. Pass mode to plugins function

Additional details

How has the user experience changed?

PR Tasks

cypress-bot bot commented Mar 12, 2021

lmiller1990 Mar 12, 2021

Choose a reason for hiding this comment

github-actions bot commented Mar 12, 2021

lmiller1990 Mar 12, 2021

Choose a reason for hiding this comment

JessicaSachs Mar 12, 2021

Choose a reason for hiding this comment

cypress bot commented Mar 12, 2021 • edited Loading

Test summary

Run details

elevatebart left a comment

Choose a reason for hiding this comment

elevatebart commented Mar 12, 2021 • edited Loading

elevatebart left a comment

Choose a reason for hiding this comment

chrisbreiding commented Mar 15, 2021

gdibble commented Jul 8, 2021

lmiller1990 commented Jul 8, 2021

gdibble commented Jul 8, 2021

lmiller1990 commented Mar 12, 2021 •

edited

Loading

1. Add support for runner specific overrides in `cypress.json`. Like this:

2. Pass `mode` to plugins function

cypress bot commented Mar 12, 2021 •

edited

Loading

elevatebart commented Mar 12, 2021 •

edited

Loading