chore: Migrate @packages/electron to TS #32417

cacieprins · 2025-09-03T18:05:54Z

Closes

Additional details

Builds to CJS, since it is executed via node script and imported by @packages/server
Prepared to build to ESM in the future
Unwrapped some promises
Minor type annotations

This is in preparation for setting up vitest, so we can properly test the conditional logic for enabling or disabling stderr filtering.

Steps to test

How has the user experience changed?

PR Tasks

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

packages/electron/BUILD.md

.circleci/workflows.yml

jennifer-shehane · 2025-09-03T19:00:02Z

packages/electron/README.md

+- **ES Modules**: Alternative build for modern Node.js applications
+- **Output**: Compiled JavaScript in `dist/cjs/`, and a binary in `dist/Cypress`.

 ## Building


@cacieprins Should this link to the BUILD.md? Or are those instructions no longer needed?

Redundant - I'll remove build.md

jennifer-shehane · 2025-09-03T19:01:39Z

packages/electron/README.md

+# Install/build Electron binary for current platform
+./bin/cypress-electron --install


Where are these commands actually defined? Is it in the code somewhere to reference so these instructions don't go out of date?

The cli() fn in lib/electron.ts is what parses out the commands. I'd really like to use something like commander for our cli tools so it's more obvious, but it's pretty simple to trace from bin/cypress-electron to lib/electron.ts#cli. I'll add some docs.

jennifer-shehane · 2025-09-04T17:47:42Z

@cacieprins Something about this PR is still failing

AtofStryker

might be good to run the esm compile with a --noEmit just so we know there aren't regressions in this package as people add to it (though that's likely seldom).

Weird we have almost no tests. Might have some dead code as well because some of the functions from the main entry I can't find in the build.ts or the server.

packages/electron/lib/electron.ts

AtofStryker · 2025-09-04T17:55:53Z

packages/electron/lib/electron.ts

+  debugElectron('dest path %s', dest)
+
+  try {
+    await fs.stat(appPath)


previously this was access. I am guessing we mostly just care for existence and this is fine and actually more appropriate

no, access is the right thing - the debug had me mixed up (and that fs-extra's remove fails silently if the fd does not exist).

packages/electron/lib/electron.ts

packages/electron/lib/install.ts

AtofStryker · 2025-09-04T19:53:19Z

packages/electron/lib/electron.ts

+  return _install.check()
+}
+
+export function install (...args: Parameters<typeof _install.packageAndExit>) {


dumb question, but where exactly is this used? I'm guessing it's a part of the CLI but I can't find the invocation. That would mean the process.exit() cursor is complaining about is erroneous

hence the help command, right?

But that uses installIfNeeded. I'm thinking this is dead code because it's not used in the build.ts script.

This doesn't need to be addressed in this PR. Mostly curious if this function is even used

post-install runs yarn workspace @packages/electron build-binary, which execs node ./bin/cypress-electron --install, which runs this fn. This is also how our tests launch cypress when invoked via scripts/cypress.js

cypress · 2025-09-05T18:16:04Z

cypress Run #65322

Run Properties: Passed #65322 • dab7c08d10: Update packages/electron/lib/electron.ts

Project	`cypress`
Branch Review	`migrate-electron-lib-ts`
Run status	`Passed #65322`
Run duration	`19m 28s`
Commit	`dab7c08d10: Update packages/electron/lib/electron.ts`
Committer	`Cacie Prins`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`11`
Pending	`1102`
Skipped	`0`
Passing	`26661`
View all changes introduced in this branch ↗︎

UI Coverage `45.27%`
Untested elements	`186`
Tested elements	`158`

Accessibility `97.71%`
Failed rules	`4 critical` `8 serious` `2 moderate` `2 minor`
Failed elements	`110`

AtofStryker

Changes look good

packages/electron/lib/electron.ts

Co-authored-by: Bill Glesias <bglesias@gmail.com>

cypress-bot · 2025-09-09T22:01:10Z

Released in 15.2.0.

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

cacieprins added 3 commits September 3, 2025 14:00

migrates electron pkg to typescript

103c86a

Merge branch 'develop' into migrate-electron-lib-ts

49da95d

build multi platform binaries on this branch

4d86453

cacieprins marked this pull request as draft September 3, 2025 18:06

cacieprins commented Sep 3, 2025

View reviewed changes

packages/electron/BUILD.md Outdated Show resolved Hide resolved

Update packages/electron/BUILD.md

ceef000

cacieprins commented Sep 3, 2025

View reviewed changes

packages/electron/BUILD.md Outdated Show resolved Hide resolved

Update packages/electron/BUILD.md

c168e4e

cacieprins commented Sep 3, 2025

View reviewed changes

packages/electron/BUILD.md Outdated Show resolved Hide resolved

Update packages/electron/BUILD.md

a3317e2

jennifer-shehane self-requested a review September 3, 2025 18:10

jennifer-shehane assigned cacieprins Sep 3, 2025

cacieprins added 3 commits September 3, 2025 14:19

update docs

7e20ce2

Merge branch 'develop' into migrate-electron-lib-ts

cd52a06

lint

38cd73f

jennifer-shehane marked this pull request as ready for review September 3, 2025 18:56

jennifer-shehane reviewed Sep 3, 2025

View reviewed changes

.circleci/workflows.yml Outdated Show resolved Hide resolved

.circleci/workflows.yml Outdated Show resolved Hide resolved

jennifer-shehane added 2 commits September 3, 2025 14:57

Update .circleci/workflows.yml

6ac5a6b

Update .circleci/workflows.yml

87e4c40

This comment was marked as outdated.

Sign in to view

jennifer-shehane reviewed Sep 3, 2025

View reviewed changes

cacieprins added 4 commits September 4, 2025 10:24

fix inverted fuse logic

a3446c2

convert buffer to Uint8Array before hashing

ad0e745

use pipeline to simplify

20101e4

fix ide error display of disabled rule

bb33cc7

This comment was marked as outdated.

Sign in to view

rm redundant md

1fe76b8

This comment was marked as outdated.

Sign in to view

cacieprins added 2 commits September 4, 2025 10:57

fix error handling / exit code

ccd2efc

update docs for cli params

5db3b72

cacieprins and others added 3 commits September 4, 2025 10:59

fix async try/catch

3904b59

Merge branch 'develop' into migrate-electron-lib-ts

9ebfcfd

re-apply obfuscated requires ...

df4c1ee

AtofStryker reviewed Sep 4, 2025

View reviewed changes

improve readability, correct debug output regarding access vs stat

60bf411

This comment was marked as outdated.

Sign in to view

flip fuses the right way again

47c005b

AtofStryker self-requested a review September 5, 2025 16:29

move back to some fs-extra, clean up dist a little better

3ffcdd1

This comment was marked as outdated.

Sign in to view

correct normalization for paths

5fcb1b1

This comment was marked as outdated.

Sign in to view

cacieprins added 2 commits September 5, 2025 13:45

icons path

6c4d9bd

exit(1) on electron signal>=1

302b530

This comment was marked as outdated.

Sign in to view

AtofStryker approved these changes Sep 5, 2025

View reviewed changes

packages/electron/lib/electron.ts Outdated Show resolved Hide resolved

Update packages/electron/lib/electron.ts

dab7c08

Co-authored-by: Bill Glesias <bglesias@gmail.com>

cacieprins merged commit 9ebddda into develop Sep 8, 2025
89 of 91 checks passed

cacieprins deleted the migrate-electron-lib-ts branch September 8, 2025 14:15

cypress-bot bot locked as resolved and limited conversation to collaborators Sep 9, 2025

		# Install/build Electron binary for current platform
		./bin/cypress-electron --install

chore: Migrate @packages/electron to TS #32417

chore: Migrate @packages/electron to TS #32417

Uh oh!

Conversation

cacieprins commented Sep 3, 2025

Additional details

Steps to test

How has the user experience changed?

PR Tasks

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

jennifer-shehane commented Sep 4, 2025

Uh oh!

AtofStryker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

cypress bot commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

AtofStryker left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cypress-bot bot commented Sep 9, 2025

Uh oh!

Uh oh!

cypress bot commented Sep 5, 2025 •

edited

Loading

AtofStryker left a comment •

edited

Loading