fix: Fix issue with undefined or extra args passed to privileged commands

[chrisbreiding]

• Closes Resurfacing of command 'must only be invoked from the spec file or support file.' #27149

Additional details

Fixes the following two issues that erroneously cause the <command> must only be invoked from the spec file or support file error:

1. Command is called with an extra argument that isn't part of its API.

   cy.task('someTask', 'arg', { log: false }, { timeout: 10000 })

Privileged command arguments are collected on invocation generically, with no knowledge of how many arguments are valid. However, each command implementation would only send known arguments when it's run, making the argument comparison falsely fail. The solution is for the implementations to send all arguments, even if they're not used by the command.

2. Command is called with a trailing undefined argument. This usually happens when one of the arguments is a variable.

   function writeFile (options) {
     cy.writeFile('file.txt', 'contents', options)
   }
   
   writeFile()

This was a bug in how trailing undefined arguments were being trimmed. Before, they were trimmed after being serialized, which never worked since any undefined values became strings. There was an issue with the test for that case. The implementation has been fixed and the test has been improved.

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?

[AtofStryker]

Suggested change

	// @ts-ignore
	// @ts-expect-error

[chrisbreiding]

Good call. I always forget to use that instead of ts-ignore. Addressed in 45a6abc

[cypress]

Passing run #48344 ↗︎

0

214

20

0

0

Details:

fix test
Project: cypress	Commit: 1054b33328
Status: Passed	Duration: 10:03 💡
Started: Jun 28, 2023 3:22 PM	Ended: Jun 28, 2023 3: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.17.0.

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