feat: cy.press() #31398

cacieprins · 2025-03-27T19:04:15Z

Closes Need tab key support #299

Additional details

Driver implementation for cy.press(). Supported in chromium browsers and firefox versions >135.

Steps to test

How has the user experience changed?

See docs: cypress-io/cypress-documentation#6135

PR Tasks

Have tests been added/updated?
Has a PR for user-facing changes been opened in cypress-documentation? feat: documentation for the press() command cypress-documentation#6135
Have API changes been updated in the type definitions?

Copilot

Pull Request Overview

This PR introduces the driver implementation for cy.press(), enabling simulated keypress events in Chromium and Firefox (v>135) browsers.

Implements a new helper (isSupportedKey) in the server automation commands to validate supported keys.
Adds a new cy.press() command along with comprehensive unit and end-to-end tests.
Updates error messages, vitest configuration, and command registration to support the new functionality.

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
packages/server/lib/automation/commands/key_press.ts	Adds isSupportedKey helper to validate supported keys
packages/driver/vitest.config.mjs	Adds setupFiles configuration for test mocks
packages/driver/test/unit/cy/commands/actions/press.spec.ts	Introduces unit tests for the new press command
packages/driver/test/setup/setupMocks.ts	Provides required mocks for source map utilities
packages/driver/src/cypress/error_messages.ts	Introduces error messages for press command issues
packages/driver/src/cypress/commands.ts	Adds type annotations for commands related to press
packages/driver/src/cy/commands/actions/press.ts	Implements the cy.press() command logic
packages/driver/src/cy/commands/actions/index.ts	Registers the new press command
packages/driver/cypress/e2e/commands/actions/press.cy.ts	Provides an end-to-end test for cy.press()

Comments suppressed due to low confidence (1)

packages/server/lib/automation/commands/key_press.ts:24

BIDI_VALUE is used here but is not defined or imported in the diff. Please ensure that BIDI_VALUE is properly declared or imported to avoid runtime errors.

return CDP_KEYCODE[key] && BIDI_VALUE[key]

…owsers

cli/CHANGELOG.md

cli/types/cypress.d.ts

AtofStryker · 2025-03-31T17:32:03Z

cli/types/cypress.d.ts

+     *    cy.press(Cypress.Keyboard.Keys.TAB) // dispatches a keydown and press event to the browser, followed by a keyup event.
+     * @see https://on.cypress.io/press
+     */
+    press(key: 'Tab' /* todo */, options?: Partial<Loggable & Timeoutable>): void


should this be a direct reference to Keys.TAB? or the Key's interface?

packages/server/lib/automation/commands/key_press.ts

cypress · 2025-03-31T21:00:06Z

cypress Run #61446

Run Properties: Failed #61446 • c30265bf42: Merge branch 'develop' into cacie/feat/cy-press-command

Project	`cypress`
Branch Review	`cacie/feat/cy-press-command`
Run status	`Failed #61446`
Run duration	`18m 50s`
Commit	`c30265bf42: Merge branch 'develop' into cacie/feat/cy-press-command`
Committer	`Jennifer Shehane`
View all properties for this run ↗︎

Test results
Failures	`1`
Flaky	`10`
Pending	`1232`
Skipped	`0`
Passing	`32139`
View all changes introduced in this branch ↗︎

UI Coverage `46.46%`
Untested elements	`184`
Tested elements	`164`

Accessibility `92.63%`
Failed rules	`3 critical` `8 serious` `2 moderate` `2 minor`
Failed elements	`878`

Tests for review

cypress/e2e/commands/actions/press.cy.ts • 1 failed test • 5x-driver-firefox

View Output

Test Artifacts

src/cy/commands/actions/press > dispatches the tab keypress to the AUT

    </td>
  </tr></table>

e2e/origin/config_env.cy.ts • 1 flaky test • 5x-driver-electron

View Output

Test		Artifacts
cy.origin- Cypress.config() > serializable > overwrites different values in secondary if one exists in the primary		`Test Replay`

issues/28527.cy.ts • 1 flaky test • 5x-driver-electron

View Output

Test		Artifacts
issue 28527 > fails and then retries and verifies about:blank is not displayed		`Test Replay` `Screenshots`

issues/28527.cy.ts • 1 flaky test • 5x-driver-chrome

View Output

Test		Artifacts
issue 28527 > fails and then retries and verifies about:blank is not displayed		`Test Replay` `Screenshots`

commands/waiting.cy.js • 1 flaky test • 5x-driver-chrome:beta

View Output

Test		Artifacts
... > errors > throws when waiting for 2nd response to route		`Test Replay`

issues/28527.cy.ts • 1 flaky test • 5x-driver-chrome:beta

View Output

Test		Artifacts
issue 28527 > fails and then retries and verifies about:blank is not displayed		`Test Replay` `Screenshots`

The first 5 flaky specs are shown, see all 10 specs in Cypress Cloud.

…ext id

…tructor

…wSpec

AtofStryker · 2025-04-04T18:42:13Z

cli/types/tslint.json

-    "no-single-declare-module": false
+    "no-single-declare-module": false,
+    // This is detecting necessary qualifiers as unnecessary
+    "no-unnecessary-qualifier": false


whats the reason we are doing this? is it related to the keys only having one value in it, i.e "tab"?

This was getting thrown by L#1758 - tslint thinks the Cypress reference here is the namespace, but it's the interface Cypress within the namespace.

(no-unnecessary-qualifier throws when you reference the namespace from within the namespace - generally you don't need to and shouldn't, because you're in scope with the namespace. But we have an interface named the same as the namespace, and tslint gets confused because of it)

packages/server/lib/automation/automation.ts

AtofStryker · 2025-04-04T19:08:09Z

packages/server/test/unit/automation/commands/key_press.spec.ts

+        })
+      })
+
+      describe('when there are invalid execution contexts associated with the top frame', () => {


maybe a weird question but what defines an invalid execution context?

An execution context that is no longer available; electron doesn't always emit the execution context removed event when it removes an execution context, so we need to loop through and determine which execution context associated with top is actually available.

AtofStryker · 2025-04-04T19:11:37Z

packages/server/test/unit/browsers/firefox_spec.ts

@@ -162,6 +162,8 @@ describe('lib/browsers/firefox', () => {
          context: mockContextId,
          url: 'next-spec-url',
        })
+
+        expect(this.automation.use).to.have.been.calledWith(bidiAutomationClient.automationMiddleware)


we probably need a test to make sure this gets called on the initial context initialization and not just connectToNewSpecBiDi

packages/server/test/unit/browsers/firefox-util_spec.ts

* dependency: upgrade mocha to 7.2.0 (#31423) * dependency: upgrade mocha to 7.2.0 * changelog entry * remove the it.only from the mocha patch changelog that is triggering our stop-only check from passing * skip patches folder with stop-only check * remove extra bracket * Update protocol_spec to reflect new mocha line number for error stack trace * chore: updating v8 snapshot cache (#31424) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * chore: updating v8 snapshot cache (#31425) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * chore: updating v8 snapshot cache (#31426) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * chore: migrates plugin system test to a v3 extension (#31434) * chore: Update Chrome (stable) to 135.0.7049.52 (#31428) * chore: Update Chrome (stable) to 135.0.7049.52 * empty commit --------- Co-authored-by: cypress-bot[bot] <41898282+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Jennifer Shehane <[email protected]> Co-authored-by: Cacie Prins <[email protected]> * chore: bump Firefox to 137 (#31431) * chore: bump Firefox to 137 * use 137 version? weird. * just kidding, major version only has 1 zero after it................ * dependency: update server to mocha 7.2.0 (#31432) * dependency: update server to mocha 7.2.0 * Add PR to changelog * chore: updating v8 snapshot cache (#31437) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * chore: updating v8 snapshot cache (#31438) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * chore: updating v8 snapshot cache (#31439) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * chore: Update Chrome (beta) to 136.0.7103.17 (#31448) * chore: Update Chrome (beta) to 136.0.7103.17 * empty commit --------- Co-authored-by: cypress-bot[bot] <41898282+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Jennifer Shehane <[email protected]> * refactor: lifts toPosix to its own file, removes circular dependency between stack_utils and source_map_utils (#30983) * refactor: lifts toPosix to remove circular dependency between stack_utils and source_map_utils * camelCase to snake_case * rm duplicated file * internal: (studio) make the protocol database accessible to studio (#31443) * internal: (studio) make the protocol database accessible to studio * PR comment * chore(deps): update dependency patch-package to v8 (#31451) * chore(deps): update dependency patch-package to v8 * empty commit * add types to handle json-stable-stringify dep change --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Jennifer Shehane <[email protected]> * chore: fix deprecation warnings and refactor react reporter to use functional components and hooks (#31284) * chore: fix deprecation warnings and refactor react reporter to use functional components with hooks * chore: update code to reflect feedback from code review * fix issues with scrollIntoView() on updated component and refactor isOpen logic in collapsible to not attempt to sync state * fix issues with tests after refactor * see if event registration fixes windows flake * chore: update snap-shot-core patch package file to match version (#31449) * chore: update snap-shot-core patch package file to match version * update circle cache * experiment with removing .md from yarnclean * add .md back to yarnclean * bust circle cache * remove .md files being cleaned from yarn to get around patch-package issue * print size of cache * try out the size of the .md * remove md from yarnclean * UPdate to version without removal of markdown files * chore: updating v8 snapshot cache (#31460) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * chore: updating v8 snapshot cache (#31462) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * chore: updating v8 snapshot cache (#31461) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * feat: cy.press() (#31398) * wip - cy.press() command * cy command for dispatching key press/down/up events * unit tests and failure cases for cy.press() * Cypress.Keyboard.Keys definition; fix command log message * add keys to the internal keyboard type * auto-focus in cdp * ensure aut iframe is focused before dispatching key events in bidi browsers * update tests for cdp focus * fixed tests for bidi * lint * fix type ref in .d.ts * linting * skip press() driver test in ff below v135 * try all contexts for frame before failing due to missing/invalid context id * ensure error is error before accessing props * skip press driver test in webkit * changelog * debug automation middleware invocation for firefox flake * debug * cache update * use bidi automation middleware from connectToNewSpec rather than constructor * more comprehensive logging * debug socket base, additional debug in automation * install firefox automation middleware on setup as well as connectToNewSpec * unit tests for firefox-utils * proper calledWith --------- Co-authored-by: Jennifer Shehane <[email protected]> * docs: update contributing requirements for corepack (#31463) * chore: remove `du` check (#31465) * chore: use different args for `du` in win * rm du command for build * chore: release 14.3.0 (#31467) --------- Co-authored-by: Jennifer Shehane <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Cacie Prins <[email protected]> Co-authored-by: cypress-bot[bot] <41898282+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Mike McCready <[email protected]>

cypress-bot · 2025-04-08T21:21:00Z

Released in 14.3.0.

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

cacieprins added 3 commits March 27, 2025 15:00

wip - cy.press() command

c3f4f85

cy command for dispatching key press/down/up events

5abbb60

unit tests and failure cases for cy.press()

6f5da33

cacieprins changed the title ~~feat: cy.press() (WIP)~~ feat: cy.press() Mar 27, 2025

jennifer-shehane assigned cacieprins Mar 27, 2025

jennifer-shehane requested a review from Copilot March 27, 2025 19:18

Copilot AI reviewed Mar 27, 2025

View reviewed changes

cacieprins added 2 commits March 27, 2025 16:29

Cypress.Keyboard.Keys definition; fix command log message

4748f31

add keys to the internal keyboard type

f0f5dc0

cacieprins mentioned this pull request Mar 28, 2025

feat: documentation for the press() command cypress-io/cypress-documentation#6135

Merged

cacieprins added 3 commits March 31, 2025 12:08

auto-focus in cdp

98063fc

ensure aut iframe is focused before dispatching key events in bidi br…

7ec4c8b

…owsers

update tests for cdp focus

c8b61e8

AtofStryker reviewed Mar 31, 2025

View reviewed changes

cacieprins added 2 commits March 31, 2025 15:23

fixed tests for bidi

6600009

lint

30bfc52

cacieprins marked this pull request as ready for review March 31, 2025 20:14

cacieprins and others added 3 commits March 31, 2025 16:14

Merge branch 'develop' into cacie/feat/cy-press-command

a12e15f

fix type ref in .d.ts

2e84355

linting

a33bcef

cacieprins and others added 4 commits March 31, 2025 17:28

skip press() driver test in ff below v135

a1f9a27

Merge branch 'develop' into cacie/feat/cy-press-command

1ca097c

try all contexts for frame before failing due to missing/invalid cont…

3637665

…ext id

ensure error is error before accessing props

7744213

AtofStryker self-requested a review April 2, 2025 13:55

cacieprins and others added 3 commits April 2, 2025 10:32

Merge branch 'develop' into cacie/feat/cy-press-command

2636de5

skip press driver test in webkit

fe3a435

changelog

8956584

CloneOfAlex approved these changes Apr 2, 2025

View reviewed changes

cacieprins and others added 8 commits April 2, 2025 11:28

debug automation middleware invocation for firefox flake

39ffe62

debug

9d60c4d

cache update

1b183e5

use bidi automation middleware from connectToNewSpec rather than cons…

dc42d30

…tructor

more comprehensive logging

14d8822

debug socket base, additional debug in automation

a13c69d

install firefox automation middleware on setup as well as connectToNe…

da743c3

…wSpec

Merge branch 'develop' into cacie/feat/cy-press-command

98b12c7

AtofStryker reviewed Apr 4, 2025

View reviewed changes

unit tests for firefox-utils

9af2e37

AtofStryker reviewed Apr 7, 2025

View reviewed changes

packages/server/test/unit/browsers/firefox-util_spec.ts Outdated Show resolved Hide resolved

proper calledWith

a9ac681

AtofStryker approved these changes Apr 7, 2025

View reviewed changes

cacieprins and others added 2 commits April 7, 2025 16:16

Merge branch 'develop' into cacie/feat/cy-press-command

e01d3df

Merge branch 'develop' into cacie/feat/cy-press-command

c30265b

cacieprins merged commit cfdeb7a into develop Apr 8, 2025
58 of 78 checks passed

cacieprins deleted the cacie/feat/cy-press-command branch April 8, 2025 13:23

cypress-bot bot locked as resolved and limited conversation to collaborators Apr 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: cy.press() #31398

feat: cy.press() #31398

cacieprins commented Mar 27, 2025 •

edited by jennifer-shehane

Loading

Copilot AI left a comment

AtofStryker Mar 31, 2025

cypress bot commented Mar 31, 2025 •

edited

Loading

AtofStryker Apr 4, 2025

cacieprins Apr 7, 2025

AtofStryker Apr 4, 2025

cacieprins Apr 7, 2025

AtofStryker Apr 4, 2025

cypress-bot bot commented Apr 8, 2025

feat: cy.press() #31398

feat: cy.press() #31398

Conversation

cacieprins commented Mar 27, 2025 • edited by jennifer-shehane Loading

Additional details

Steps to test

How has the user experience changed?

PR Tasks

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

AtofStryker Mar 31, 2025

Choose a reason for hiding this comment

cypress bot commented Mar 31, 2025 • edited Loading

cypress Run #61446

Tests for review

AtofStryker Apr 4, 2025

Choose a reason for hiding this comment

cacieprins Apr 7, 2025

Choose a reason for hiding this comment

AtofStryker Apr 4, 2025

Choose a reason for hiding this comment

cacieprins Apr 7, 2025

Choose a reason for hiding this comment

AtofStryker Apr 4, 2025

Choose a reason for hiding this comment

cypress-bot bot commented Apr 8, 2025

cacieprins commented Mar 27, 2025 •

edited by jennifer-shehane

Loading

cypress bot commented Mar 31, 2025 •

edited

Loading