fix: make dev-server error message appear only once when CT is not configured #17090

elevatebart · 2021-06-23T21:41:01Z

Closes Double errors in component testing #17089

User facing changelog

Simplified the error when the event dev-server:start is not configured and users start the component testing

How has the user experience changed?

Before:

Error: It is required to register dev-server plugin that implements `dev-server:start` event for component testing.
    at Object.start (/Users/bart/Documents/github/cypress/packages/server/lib/plugins/dev-server.js:36:13)
    at /Users/bart/Documents/github/cypress/packages/server-ct/src/project-ct.ts:100:45
From previous event:
    at /Users/bart/Documents/github/cypress/packages/server-ct/src/project-ct.ts:99:18
    at processImmediate (internal/timers.js:461:21)
From previous event:
    at ProjectCt._initPlugins (/Users/bart/Documents/github/cypress/packages/server-ct/src/project-ct.ts:91:14)
    at onOpen (/Users/bart/Documents/github/cypress/packages/server-ct/src/project-ct.ts:50:29)
    at callback (/Users/bart/Documents/github/cypress/node_modules/graceful-fs/polyfills.js:299:20)
    at callback (/Users/bart/Documents/github/cypress/packages/server/node_modules/graceful-fs/polyfills.js:289:20)
    at FSReqCallback.oncomplete (fs.js:184:5)
From previous event:
    at ProjectCt.open (/Users/bart/Documents/github/cypress/packages/server/lib/project-base.ts:124:14)
    at ProjectCt.open (/Users/bart/Documents/github/cypress/packages/server-ct/src/project-ct.ts:47:22)
    at Object.create (/Users/bart/Documents/github/cypress/packages/server/lib/open_project.js:353:26)
    at /Users/bart/Documents/github/cypress/packages/server-ct/index.ts:66:39
    at processImmediate (internal/timers.js:461:21)
Error: It is required to register dev-server plugin that implements `dev-server:start` event for component testing.
    at Object.start (/Users/bart/Documents/github/cypress/packages/server/lib/plugins/dev-server.js:36:13)
    at /Users/bart/Documents/github/cypress/packages/server-ct/src/project-ct.ts:100:45
From previous event:
    at /Users/bart/Documents/github/cypress/packages/server-ct/src/project-ct.ts:99:18
    at processImmediate (internal/timers.js:461:21)
From previous event:
    at ProjectCt._initPlugins (/Users/bart/Documents/github/cypress/packages/server-ct/src/project-ct.ts:91:14)
    at onOpen (/Users/bart/Documents/github/cypress/packages/server-ct/src/project-ct.ts:50:29)
    at callback (/Users/bart/Documents/github/cypress/node_modules/graceful-fs/polyfills.js:299:20)
    at callback (/Users/bart/Documents/github/cypress/packages/server/node_modules/graceful-fs/polyfills.js:289:20)
    at FSReqCallback.oncomplete (fs.js:184:5)
From previous event:
    at ProjectCt.open (/Users/bart/Documents/github/cypress/packages/server/lib/project-base.ts:124:14)
    at ProjectCt.open (/Users/bart/Documents/github/cypress/packages/server-ct/src/project-ct.ts:47:22)
    at Object.create (/Users/bart/Documents/github/cypress/packages/server/lib/open_project.js:353:26)
    at /Users/bart/Documents/github/cypress/packages/server-ct/index.ts:66:39
    at processImmediate (internal/timers.js:461:21)
✨  Done in 26.45s.
✨  Done in 26.70s.

After:

yarn workspace v1.22.10
yarn run v1.22.10
$ node ../../scripts/cypress.js open-ct --project ${PWD}
(node:62958) Warning: Accessing non-existent property 'padLevels' of module exports inside circular dependency
(Use `Cypress --trace-warnings ...` to show where the warning was created)
To run component-testing, cypress needs the `dev-server:start` event.

Implement it by adding a `on('dev-server:start', () => startDevServer())` call in your pluginsFile.

You can find the 'pluginsFile' at the following path:

/Users/AppleSeed/project/cypress/plugins/index.js

To learn more about how to set up component testing:

https://on.cypress.io/component-testing

✨  Done in 21.16s.
✨  Done in 21.41s.

cypress-bot · 2021-06-23T21:41:02Z

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 · 2021-06-23T21:54:23Z

Test summary

8448 • 0 • 101 • 4 • 2

Run details


Project	cypress
Status	Passed
Commit	`a0b675a`
Started	Jun 26, 2021 2:04 PM
Ended	Jun 26, 2021 2:15 PM
Duration	11:14 💡
OS	Linux Debian - 10.8
Browser	Multiple

View run in Cypress Dashboard ➡️

Flakiness

	reporter.errors.spec.js	1
1	errors ui > uncaught errors > spec Bluebird unhandled rejection
	retries.ui.spec.js	1
1	runner/cypress retries.ui.spec > opens attempt on each attempt failure for the screenshot, and closes after test passes

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

lmiller1990 · 2021-06-24T03:25:48Z

packages/server/lib/errors.js

@@ -965,6 +965,14 @@ const getMsgByType = function (type, arg1 = {}, arg2, arg3) {

        ${chalk.yellow(arg2)}
      `
+    case 'CT_NO_DEV_START_EVENT':
+      return stripIndent`\


nit: Can we not include the \ in the message:

To run component-testing, cypress needs the \`dev-server:start\` event.

The \ look a bit weird.

The backslash are not in the command message. They are only necessary for the backticks to be displayed in the final error.
My description was confusing.

(I did a poor Copy-Paste)

lmiller1990 · 2021-06-24T03:26:47Z

packages/server/lib/plugins/dev-server.js

@@ -32,8 +33,7 @@ const API = {

  start ({ specs, config }) {
    if (!plugins.has('dev-server:start')) {
-      // TODO: add link to the documentation in the error message
-      throw new Error('It is required to register dev-server plugin that implements `dev-server:start` event for component testing.')
+      return errors.throw('CT_NO_DEV_START_EVENT', config.pluginsFile)


Is the second arg (config.pluginsFile) needed? Seems it is not used.

Good catch, my plan was to use it in the error to offer a clickable target for the user.

Here is the path to your pluginsFile: /Users/dev/path

* develop: fix: prevent saved state errors for deprecated keys (#17093) fix(studio): restore intro modal styles (#17118) refactor: add @packages/resolve-dist to isolate client/server code (#17109) fix: plugin file referenced by cypress config in angular schematics (#17143) refactor: @packages/runner-shared should also be devDependencies (#17133) chore: release @cypress/schematic-v1.4.1 fix: plugin file in angular schematics (#17141) chore(runner): render spec list inline (behind feature flag) (#17069) refactor: remove junk test (#17125) chore(server): collapse project-ct and project-e2e into project-base (#17115) fix: make dev-server error message appear only once when CT is not configured (#17090) chore: release @cypress/schematic-v1.4.0 feat: add ng generate to @cypress/schematic to generate e2e spec files (#16962) feat(studio): add ability to copy commands to clipboard (#16912) chore: release @cypress/webpack-preprocessor-v5.9.1 chore: release @cypress/webpack-batteries-included-preprocessor-v2.2.2 chore: release @cypress/vue-v3.0.0-beta.3

elevatebart requested a review from a team as a code owner June 23, 2021 21:41

elevatebart requested review from chrisbreiding and jennifer-shehane and removed request for a team June 23, 2021 21:41

elevatebart added the component testing label Jun 23, 2021

lmiller1990 reviewed Jun 24, 2021

View reviewed changes

elevatebart added 3 commits June 24, 2021 08:57

replace errror and debug server-ct

381e691

fix: make the erreor message appear only once

1d18a7a

fix: use pluginsFile path in the error

f006452

elevatebart force-pushed the fix/show-dev-server-error-once branch from f686c60 to f006452 Compare June 24, 2021 14:14

lmiller1990 approved these changes Jun 24, 2021

View reviewed changes

Barthélémy Ledoux added 2 commits June 24, 2021 18:45

Merge branch 'develop' into fix/show-dev-server-error-once

857ca8e

Merge branch 'develop' into fix/show-dev-server-error-once

a0b675a

elevatebart merged commit 20de3e5 into develop Jun 27, 2021

cypress-bot bot mentioned this pull request Jun 27, 2021

Double errors in component testing #17089

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: make dev-server error message appear only once when CT is not configured #17090

fix: make dev-server error message appear only once when CT is not configured #17090

elevatebart commented Jun 23, 2021 •

edited

Loading

cypress-bot bot commented Jun 23, 2021

cypress bot commented Jun 23, 2021 •

edited

Loading

lmiller1990 Jun 24, 2021

elevatebart Jun 24, 2021

lmiller1990 Jun 24, 2021

elevatebart Jun 24, 2021

fix: make dev-server error message appear only once when CT is not configured #17090

fix: make dev-server error message appear only once when CT is not configured #17090

Conversation

elevatebart commented Jun 23, 2021 • edited Loading

User facing changelog

How has the user experience changed?

cypress-bot bot commented Jun 23, 2021

cypress bot commented Jun 23, 2021 • edited Loading

Test summary

Run details

Flakiness

lmiller1990 Jun 24, 2021

Choose a reason for hiding this comment

elevatebart Jun 24, 2021

Choose a reason for hiding this comment

lmiller1990 Jun 24, 2021

Choose a reason for hiding this comment

elevatebart Jun 24, 2021

Choose a reason for hiding this comment

elevatebart commented Jun 23, 2021 •

edited

Loading

cypress bot commented Jun 23, 2021 •

edited

Loading