fix: Handle large payloads sent with privileged commands

[chrisbreiding]

• Closes cy.task() doesn't work with new Cypress version 12.15.0 #27099

Additional details

Running a privileged command with a large payload can cause a 413 Request Entity Too Large error in express/body-parser when on the POST /__cypress/add-verified-command request.

This is experienced with the code coverage plugin since it sends the entire coverage payload through cy.task().

The crux of the issue is that privileged commands send their args to the server via a POST request when the command is invoked (i.e. enqueued, before being run), which triggers the 413 error in express/body-parser. Those args are compared later when the command is actually run. The fix is to send a hashed version of each arg instead of sending the entire arg in order to reduce the payload size. Then when the command is run, hashes are compared instead of full values.

Steps to test

1. Set up a simple someTask implementation in cypress.config.js. Doesn't actually need to do anything besides return null.
2. Run this test

it('privileged command can handle a large json payload', () => {
    const hugeJson = Cypress._.times(3000).map(() => {
      return {
        key1: 'value 1',
        key2: {
          key3: 'value 3',
          key4: {
            key5: 'value 5',
          },
        },
      }
    })

    cy.task('someTask', hugeJson)
})

How has the user experience changed?

PR Tasks

• Have tests been added/updated?
• [N/A] Has a PR for user-facing changes been opened in cypress-documentation?
• [N/A] Have API changes been updated in the type definitions?

[cypress]

Passing run #48167 ↗︎

0

214

20

0

0

Details:

handle undefined arg in middle of arguments
Project: cypress	Commit: 92b63cd108
Status: Passed	Duration: 10:15 💡
Started: Jun 23, 2023 7:22 PM	Ended: Jun 23, 2023 7:32 PM

_{This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.}

[cypress-bot]

Released in 12.16.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v12.16.0, please open a new issue.