test: support for multimonitor tests #47911

nilayarya · 2025-07-30T15:41:31Z

Description of Change

Note

This PR is part of GSoC 2025 [project] [rfc]

Description of Change

This PR adds a new native addon fixture for testing virtual display functionality in Electron. The virtual-display addon provides programmatic virtual display creation capabilities on macOS for comprehensive display testing scenarios.

Example usage:

const virtualDisplay = require('@electron-ci/virtual-display');
const displayId = virtualDisplay.create();
virtualDisplay.destroy(displayId);

Checklist

PR description included and stakeholders cc'd
tests are changed or added
relevant API documentation, tutorials, and examples are updated and follow the documentation style guide
PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes: none

github-actions

Hello @nilayarya! It looks like this pull request touches one of our dependency files, and per our contribution policy we do not accept these types of changes in PRs.

Permitted in this case.

georgexu99

Docs: approved

erickzhao

I think this should be a test: prefix PR and be stacked on top of #47781, right?

nilayarya · 2025-08-06T15:05:13Z

I think this should be a test: prefix PR and be stacked on top of #47781, right?

Since this is a new independent API to create virtual displays wouldn’t it make more sense to label it as feat:?
I might have branched off incorrectly sorry for that.

VerteDinde

Looks great!

VerteDinde · 2025-08-11T04:13:13Z

Failing test is a known flake on main, safe to merge

release-clerk · 2025-08-11T07:43:19Z

No Release Notes

* test: support for multimonitor tests * fix: update yarn.lock file * test: support any resolution for new displays * test: support display positioning * docs: multi-monitor tests * test: remove dummy test

* feat: save window state (#47425) * feat: save/restore window state * cleanup * remove constructor option * refactor: apply suggestions from code review Co-authored-by: Charles Kerr <[email protected]> * refactor: forward declare prefservice * refactor: remove constructor option * refactor: save window state on move/resize instead of moved/resized * feat: resave window state after construction * test: add basic window save tests * test: add work area tests * test: asynchronous batching behavior * docs: add windowStateRestoreOptions to BaseWindowConstructorOptions * chore: move includes to main block * Update spec/api-browser-window-spec.ts Co-authored-by: David Sanders <[email protected]> * docs: update docs/api/structures/base-window-options.md Co-authored-by: Erick Zhao <[email protected]> * fix: preserve original bounds during window state save in special modes * feat: save kiosk state in window preferences * chore: remove ts-expect-error * test: check hasCapturableScreen before running tests * test: remove multimonitor tests * test: add missing hasCapturableScreen checks before tests * docs: add blurb on saving mechanism * feat: add debounce window of 200ms to saveWindowState * docs: remove blurb until finalized * style: convert constants from snake_case to camelCase * refactor: initialize prefs_ only if window state is configured to be saved/restored * refactor: rename window states key * refactor: store in application-level Local State instead of browser context * refactor: switch to more accurate function names * fix: add dcheck for browser_process * fix: flush window state to avoid race condition * refactor: change stateId to name * refactor: change windowStateRestoreOptions to windowStatePersistence * Update docs/api/structures/base-window-options.md Co-authored-by: David Sanders <[email protected]> * fix: add warning when window state persistence enabled without window name * docs: lowercase capital B for consistency --------- Co-authored-by: Charles Kerr <[email protected]> Co-authored-by: David Sanders <[email protected]> Co-authored-by: Erick Zhao <[email protected]> * feat: restore window state * feat: flush display modes on show * refactor: move utility functions to common area * feat: clear window state * fix: wait for the prefs to update * test: clearWindowState extra test * test: refine clear window state tests * test: single monitor restore window tests chore: rebase on gsoc-2025 * refactor: refine clearWindowState test * fix: revert default_app back to original * docs: add comment linking AdjustBoundsToBeVisibleOnDisplay to Chromium code * fix: add correct permalink * refactor: ci friendly * fix: disable windowStatePersistence when no display * refactor: use reference instead pointer * fix: skip window state persistence for invalid/fake displays * refactor: better flag placement * test: add test to verify window state is not saved when no display * fix: restore display mode inside show() * feat: save window state (#47425) * feat: save/restore window state * cleanup * remove constructor option * refactor: apply suggestions from code review Co-authored-by: Charles Kerr <[email protected]> * refactor: forward declare prefservice * refactor: remove constructor option * refactor: save window state on move/resize instead of moved/resized * feat: resave window state after construction * test: add basic window save tests * test: add work area tests * test: asynchronous batching behavior * docs: add windowStateRestoreOptions to BaseWindowConstructorOptions * chore: move includes to main block * Update spec/api-browser-window-spec.ts Co-authored-by: David Sanders <[email protected]> * docs: update docs/api/structures/base-window-options.md Co-authored-by: Erick Zhao <[email protected]> * fix: preserve original bounds during window state save in special modes * feat: save kiosk state in window preferences * chore: remove ts-expect-error * test: check hasCapturableScreen before running tests * test: remove multimonitor tests * test: add missing hasCapturableScreen checks before tests * docs: add blurb on saving mechanism * feat: add debounce window of 200ms to saveWindowState * docs: remove blurb until finalized * style: convert constants from snake_case to camelCase * refactor: initialize prefs_ only if window state is configured to be saved/restored * refactor: rename window states key * refactor: store in application-level Local State instead of browser context * refactor: switch to more accurate function names * fix: add dcheck for browser_process * fix: flush window state to avoid race condition * refactor: change stateId to name * refactor: change windowStateRestoreOptions to windowStatePersistence * Update docs/api/structures/base-window-options.md Co-authored-by: David Sanders <[email protected]> * fix: add warning when window state persistence enabled without window name * docs: lowercase capital B for consistency --------- Co-authored-by: Charles Kerr <[email protected]> Co-authored-by: David Sanders <[email protected]> Co-authored-by: Erick Zhao <[email protected]> * test: clear sharedUserPath before and test * refactor: hasInvalidDisplay function * debug: add display info logging for CI * fix: do not save/restore when window is 0x0 * test: support for multimonitor tests (#47911) * test: support for multimonitor tests * fix: update yarn.lock file * test: support any resolution for new displays * test: support display positioning * docs: multi-monitor tests * test: remove dummy test * feat: enforce unique window names across BaseWindow and BrowserWindow (#47764) * feat: save window state (#47425) * feat: save/restore window state * cleanup * remove constructor option * refactor: apply suggestions from code review Co-authored-by: Charles Kerr <[email protected]> * refactor: forward declare prefservice * refactor: remove constructor option * refactor: save window state on move/resize instead of moved/resized * feat: resave window state after construction * test: add basic window save tests * test: add work area tests * test: asynchronous batching behavior * docs: add windowStateRestoreOptions to BaseWindowConstructorOptions * chore: move includes to main block * Update spec/api-browser-window-spec.ts Co-authored-by: David Sanders <[email protected]> * docs: update docs/api/structures/base-window-options.md Co-authored-by: Erick Zhao <[email protected]> * fix: preserve original bounds during window state save in special modes * feat: save kiosk state in window preferences * chore: remove ts-expect-error * test: check hasCapturableScreen before running tests * test: remove multimonitor tests * test: add missing hasCapturableScreen checks before tests * docs: add blurb on saving mechanism * feat: add debounce window of 200ms to saveWindowState * docs: remove blurb until finalized * style: convert constants from snake_case to camelCase * refactor: initialize prefs_ only if window state is configured to be saved/restored * refactor: rename window states key * refactor: store in application-level Local State instead of browser context * refactor: switch to more accurate function names * fix: add dcheck for browser_process * fix: flush window state to avoid race condition * refactor: change stateId to name * refactor: change windowStateRestoreOptions to windowStatePersistence * Update docs/api/structures/base-window-options.md Co-authored-by: David Sanders <[email protected]> * fix: add warning when window state persistence enabled without window name * docs: lowercase capital B for consistency --------- Co-authored-by: Charles Kerr <[email protected]> Co-authored-by: David Sanders <[email protected]> Co-authored-by: Erick Zhao <[email protected]> * feat: enforce unique window names across BaseWindow and BrowserWindow * docs: update docs for name property * fix: linter issue with symbol --------- Co-authored-by: Charles Kerr <[email protected]> Co-authored-by: David Sanders <[email protected]> Co-authored-by: Erick Zhao <[email protected]> * test: remove invalid display test --------- Co-authored-by: Charles Kerr <[email protected]> Co-authored-by: David Sanders <[email protected]> Co-authored-by: Erick Zhao <[email protected]> Co-authored-by: Keeley Hammond <[email protected]>

* test: support for multimonitor tests * fix: update yarn.lock file * test: support any resolution for new displays * test: support display positioning * docs: multi-monitor tests * test: remove dummy test

* feat: save window state (#47425) * feat: save/restore window state * cleanup * remove constructor option * refactor: apply suggestions from code review Co-authored-by: Charles Kerr <[email protected]> * refactor: forward declare prefservice * refactor: remove constructor option * refactor: save window state on move/resize instead of moved/resized * feat: resave window state after construction * test: add basic window save tests * test: add work area tests * test: asynchronous batching behavior * docs: add windowStateRestoreOptions to BaseWindowConstructorOptions * chore: move includes to main block * Update spec/api-browser-window-spec.ts Co-authored-by: David Sanders <[email protected]> * docs: update docs/api/structures/base-window-options.md Co-authored-by: Erick Zhao <[email protected]> * fix: preserve original bounds during window state save in special modes * feat: save kiosk state in window preferences * chore: remove ts-expect-error * test: check hasCapturableScreen before running tests * test: remove multimonitor tests * test: add missing hasCapturableScreen checks before tests * docs: add blurb on saving mechanism * feat: add debounce window of 200ms to saveWindowState * docs: remove blurb until finalized * style: convert constants from snake_case to camelCase * refactor: initialize prefs_ only if window state is configured to be saved/restored * refactor: rename window states key * refactor: store in application-level Local State instead of browser context * refactor: switch to more accurate function names * fix: add dcheck for browser_process * fix: flush window state to avoid race condition * refactor: change stateId to name * refactor: change windowStateRestoreOptions to windowStatePersistence * Update docs/api/structures/base-window-options.md Co-authored-by: David Sanders <[email protected]> * fix: add warning when window state persistence enabled without window name * docs: lowercase capital B for consistency --------- Co-authored-by: Charles Kerr <[email protected]> Co-authored-by: David Sanders <[email protected]> Co-authored-by: Erick Zhao <[email protected]> * feat: restore window state * feat: flush display modes on show * refactor: move utility functions to common area * feat: clear window state * fix: wait for the prefs to update * test: clearWindowState extra test * test: refine clear window state tests * test: single monitor restore window tests chore: rebase on gsoc-2025 * refactor: refine clearWindowState test * fix: revert default_app back to original * docs: add comment linking AdjustBoundsToBeVisibleOnDisplay to Chromium code * fix: add correct permalink * refactor: ci friendly * fix: disable windowStatePersistence when no display * refactor: use reference instead pointer * fix: skip window state persistence for invalid/fake displays * refactor: better flag placement * test: add test to verify window state is not saved when no display * fix: restore display mode inside show() * feat: save window state (#47425) * feat: save/restore window state * cleanup * remove constructor option * refactor: apply suggestions from code review Co-authored-by: Charles Kerr <[email protected]> * refactor: forward declare prefservice * refactor: remove constructor option * refactor: save window state on move/resize instead of moved/resized * feat: resave window state after construction * test: add basic window save tests * test: add work area tests * test: asynchronous batching behavior * docs: add windowStateRestoreOptions to BaseWindowConstructorOptions * chore: move includes to main block * Update spec/api-browser-window-spec.ts Co-authored-by: David Sanders <[email protected]> * docs: update docs/api/structures/base-window-options.md Co-authored-by: Erick Zhao <[email protected]> * fix: preserve original bounds during window state save in special modes * feat: save kiosk state in window preferences * chore: remove ts-expect-error * test: check hasCapturableScreen before running tests * test: remove multimonitor tests * test: add missing hasCapturableScreen checks before tests * docs: add blurb on saving mechanism * feat: add debounce window of 200ms to saveWindowState * docs: remove blurb until finalized * style: convert constants from snake_case to camelCase * refactor: initialize prefs_ only if window state is configured to be saved/restored * refactor: rename window states key * refactor: store in application-level Local State instead of browser context * refactor: switch to more accurate function names * fix: add dcheck for browser_process * fix: flush window state to avoid race condition * refactor: change stateId to name * refactor: change windowStateRestoreOptions to windowStatePersistence * Update docs/api/structures/base-window-options.md Co-authored-by: David Sanders <[email protected]> * fix: add warning when window state persistence enabled without window name * docs: lowercase capital B for consistency --------- Co-authored-by: Charles Kerr <[email protected]> Co-authored-by: David Sanders <[email protected]> Co-authored-by: Erick Zhao <[email protected]> * test: clear sharedUserPath before and test * refactor: hasInvalidDisplay function * debug: add display info logging for CI * fix: do not save/restore when window is 0x0 * test: support for multimonitor tests (#47911) * test: support for multimonitor tests * fix: update yarn.lock file * test: support any resolution for new displays * test: support display positioning * docs: multi-monitor tests * test: remove dummy test * feat: enforce unique window names across BaseWindow and BrowserWindow (#47764) * feat: save window state (#47425) * feat: save/restore window state * cleanup * remove constructor option * refactor: apply suggestions from code review Co-authored-by: Charles Kerr <[email protected]> * refactor: forward declare prefservice * refactor: remove constructor option * refactor: save window state on move/resize instead of moved/resized * feat: resave window state after construction * test: add basic window save tests * test: add work area tests * test: asynchronous batching behavior * docs: add windowStateRestoreOptions to BaseWindowConstructorOptions * chore: move includes to main block * Update spec/api-browser-window-spec.ts Co-authored-by: David Sanders <[email protected]> * docs: update docs/api/structures/base-window-options.md Co-authored-by: Erick Zhao <[email protected]> * fix: preserve original bounds during window state save in special modes * feat: save kiosk state in window preferences * chore: remove ts-expect-error * test: check hasCapturableScreen before running tests * test: remove multimonitor tests * test: add missing hasCapturableScreen checks before tests * docs: add blurb on saving mechanism * feat: add debounce window of 200ms to saveWindowState * docs: remove blurb until finalized * style: convert constants from snake_case to camelCase * refactor: initialize prefs_ only if window state is configured to be saved/restored * refactor: rename window states key * refactor: store in application-level Local State instead of browser context * refactor: switch to more accurate function names * fix: add dcheck for browser_process * fix: flush window state to avoid race condition * refactor: change stateId to name * refactor: change windowStateRestoreOptions to windowStatePersistence * Update docs/api/structures/base-window-options.md Co-authored-by: David Sanders <[email protected]> * fix: add warning when window state persistence enabled without window name * docs: lowercase capital B for consistency --------- Co-authored-by: Charles Kerr <[email protected]> Co-authored-by: David Sanders <[email protected]> Co-authored-by: Erick Zhao <[email protected]> * feat: enforce unique window names across BaseWindow and BrowserWindow * docs: update docs for name property * fix: linter issue with symbol --------- Co-authored-by: Charles Kerr <[email protected]> Co-authored-by: David Sanders <[email protected]> Co-authored-by: Erick Zhao <[email protected]> * test: remove invalid display test --------- Co-authored-by: Charles Kerr <[email protected]> Co-authored-by: David Sanders <[email protected]> Co-authored-by: Erick Zhao <[email protected]> Co-authored-by: Keeley Hammond <[email protected]>

electron-cation bot added the new-pr 🌱 PR opened recently label Jul 30, 2025

dsanders11 added GSoC 2025 Google Summer of Code 2025 semver/none no-backport backport-check-skip Skip trop's backport validity checking labels Jul 30, 2025

electron-cation bot removed the new-pr 🌱 PR opened recently label Jul 30, 2025

github-actions bot previously requested changes Jul 30, 2025

View reviewed changes

nilayarya marked this pull request as draft August 1, 2025 14:32

nilayarya marked this pull request as ready for review August 3, 2025 15:14

georgexu99 reviewed Aug 5, 2025

View reviewed changes

VerteDinde force-pushed the gsoc-2025 branch from 7291a08 to 578fb0e Compare August 5, 2025 21:01

erickzhao reviewed Aug 5, 2025

View reviewed changes

codebytere changed the title ~~feat: support for multimonitor tests~~ test: support for multimonitor tests Aug 6, 2025

nilayarya added 6 commits August 7, 2025 12:31

test: support for multimonitor tests

0f63a83

fix: update yarn.lock file

7bafba0

test: support any resolution for new displays

c71752e

test: support display positioning

1eb9d0c

docs: multi-monitor tests

d3748a9

test: remove dummy test

94463ad

nilayarya force-pushed the multi-display-test branch from 81beead to 94463ad Compare August 7, 2025 16:38

VerteDinde approved these changes Aug 7, 2025

View reviewed changes

codebytere merged commit 88531c4 into electron:gsoc-2025 Aug 11, 2025
54 of 55 checks passed

nilayarya mentioned this pull request Aug 12, 2025

test: multi monitor tests for save/restore window state #48048

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test: support for multimonitor tests #47911

test: support for multimonitor tests #47911

Uh oh!

nilayarya commented Jul 30, 2025 •

edited

Loading

Uh oh!

github-actions bot left a comment

Uh oh!

georgexu99 left a comment •

edited

Loading

Uh oh!

erickzhao left a comment

Uh oh!

nilayarya commented Aug 6, 2025

Uh oh!

VerteDinde left a comment

Uh oh!

VerteDinde commented Aug 11, 2025

Uh oh!

Uh oh!

release-clerk bot commented Aug 11, 2025

Uh oh!

Uh oh!

test: support for multimonitor tests #47911

test: support for multimonitor tests #47911

Uh oh!

Conversation

nilayarya commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Description of Change

Checklist

Release Notes

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

georgexu99 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!

erickzhao left a comment

Choose a reason for hiding this comment

Uh oh!

nilayarya commented Aug 6, 2025

Uh oh!

VerteDinde left a comment

Choose a reason for hiding this comment

Uh oh!

VerteDinde commented Aug 11, 2025

Uh oh!

Uh oh!

release-clerk bot commented Aug 11, 2025

Uh oh!

Uh oh!

nilayarya commented Jul 30, 2025 •

edited

Loading

georgexu99 left a comment •

edited

Loading