Run specs with name containing '+'

[laistomazz]

• Closes file name contains character ”+“ not run #5909

User facing changelog

Now you can run specs with name containing '+'

Additional details

The issue is using req.query.p when handling the spec. This is part of an example of the req object:

originalUrl: '/__cypress/tests?p=cypress/integration/issue+filename.spec.js',
  _parsedUrl: Url {
    protocol: null,
    slashes: null,
    auth: null,
    host: null,
    port: null,
    hostname: null,
    hash: null,
    search: '?p=cypress/integration/issue+filename.spec.js',
    query: 'p=cypress/integration/issue+filename.spec.js',
    pathname: '/__cypress/tests',
    path: '/__cypress/tests?p=cypress/integration/issue+filename.spec.js',
    href: '/__cypress/tests?p=cypress/integration/issue+filename.spec.js',
    _raw: '/__cypress/tests?p=cypress/integration/issue+filename.spec.js'
  },
  params: {},
  query: { p: 'cypress/integration/issue filename.spec.js' },

Why this happens

Express's req.query parser is based on Node's native query parser, querystring. It will replace + with a space by default.

Proposed solution

Quick fix: To not use the query parameter.

Proposed followup solution

Have a custom query string parsing function.

How has the user experience changed?

Now they won't see an error anymore if the spec file contains "+".

[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.

[jennifer-shehane]

@laistomazz Thanks! Can you add a test around this new behavior?

There is a Contributing Guide that covers how to contribute and get Cypress running locally in generally here: https://github.com/cypress-io/cypress/blob/develop/.github/CONTRIBUTING.md

Here's an example of another issue's test code below. I believe you should just be able to add a simple spec file called 5909+spec.js, since the presence of the + would make the test fail.

• Test spec: https://github.com/cypress-io/cypress/blob/develop/packages/driver/test/cypress/integration/issues/565_spec.js

To run the tests:

• within cypress root, run yarn
• run yarn workspace @packages/driver cypress:open
• click on the test you're writing to run it within Cypress

Instructions for running the driver tests can always be found here: https://github.com/cypress-io/cypress/blob/develop/packages/driver/README.md

[laistomazz]

The failing tests show that my solution doesn't work for all cases. I will look further into it.

[laistomazz]

It was an easier fix than I thought 😅

Any suggestion on how to fix the failing test? /packages/server/test/e2e/5_screenshots_spec.js

Locally it fails on /Users/username/cypress/packages/server/test/e2e/5_screenshots_spec.js:102:38

1) e2e screenshots passes [chrome]:
     AssertionError: expected 192864 not to be close to 193512 +/- 5000

[jennifer-shehane]

@laistomazz just some flake, is fine now.

Dismissing previous request for tests since tests exist now