fix: Issue 23486

[amehta265]

• Closes Cypress UI no longer displays spec files to run #23486

User facing changelog

• When using the Cypress UI, if the dev server is not set up correctly in the cypress config, users should still be able to see list of spec files they can run.

Additional details

• The error stems from a missing null check for the component.devServer in the config. This could have happened if component testing was partially set up or devServer dependency was removed after the set up.
• Adding optional chaining to check the existence of the framework on the devServer circumvents the "GraphQL error [GraphQL] Cannot read properties of undefined (reading 'framework')". With optional chaining we will still be checking if the devServer is defined in the framework and if it is undefined it will not throw the error.
• The cypress-in-cypress.cy.ts test manually changes the config file removing the devServer from the component and then checks if the spec list still shows up.

Steps to test

1. Go to cypress/packages/data-context/src/actions/ProjectActions.ts. On line 534 remove the '?' character between devServer and framework such that it reads as devServer.framework
2. Run the cypress-in-cypress.cy.ts test within the app folder of packages.
3. The 'checks that specs load when devServer configuration is not set in open mode for e2e/CT' test should fail as the spec list is not visible in the DOM.
4. Repeat step 1 BUT add back the '?' character so it reads as devServer?.framework
5. Repeat step 2 and the test should pass now.

How has the user experience changed?

Before (When config file does not have a devServer):

After bug fix:

PR Tasks

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

[cypress-bot]

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.

[CLAassistant]

All committers have signed the CLA.

[marktnoonan]

Suggested update to the comment but otherwise looks good!

[astone123]

Nice! 👍🏻 @marktnoonan should we update the config types? If you look at cypress.d.ts, it looks like devServer is required

  interface ComponentConfigOptions<ComponentDevServerOpts = any> extends Omit<CoreConfigOptions, 'baseUrl' | 'experimentalSessionAndOrigin' | 'experimentalStudio'> {
    devServer: DevServerFn<ComponentDevServerOpts> | DevServerConfigOptions
    devServerConfig?: ComponentDevServerOpts
    /**
     * Runs all component specs in a single tab, trading spec isolation for faster run mode execution.
     * @default false
     */
    experimentalSingleTabRunMode?: boolean
  }

it seems like it should be optional devServer?: DevServerFn<ComponentDevServerOpts> | DevServerConfigOptions

[cypress]

---

Test summary

39641 • 0 • 3371 • 0 • 1

---

Run details

Project	cypress
Status	Passed
Commit	00d3803
Started	Aug 29, 2022 8:12 PM
Ended	Aug 29, 2022 8:26 PM
Duration	14:26 💡
OS	Linux Debian - 11.3
Browser	Multiple

View run in Cypress Dashboard ➡️

---

Flakiness

	cypress/e2e/commands/waiting.cy.js		1
1	... > errors > throws when waiting for 2nd response to route

---

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

[ZachJW34]

@astone123 we shouldn't tweak the devServer types. If they have a component field in the Cypress config, they should have a component.devServer property otherwise they shouldn't have CT configured at all.

[marktnoonan]

The ideal thing to do will be to correctly show a config validation error if devServer is not present. We need a follow up issue for that actually, this just stops the bug.

[astone123]

Looks good 🎉