ci: add action for setting display resolution for all platform

Author: mato533

.github/workflows/actions/set-screen-resolution/action.yml

@@ -0,0 +1,41 @@
+name: 'vscode-webdriverio Set screen resolution'
+description: 'Set screen resolution'
+inputs:
+  width:
+    description: 'screen width'
+    default: '1920'
+  height:
+    description: 'screen height'
+    default: '1080'
+runs:
+  using: 'composite'
+  steps:
+    # https://github.com/actions/runner-images/issues/2935
+    - name: Set display resolution on Windows
+      if: runner.os == 'Windows'
+      shell: pwsh
+      run: |
+        Set-DisplayResolution -Width ${{ inputs.width }} -Height ${{ inputs.height }} -Force
+
+    # I don't know the details, but it appears that it needs to be maximized at the Webdriver level
+    # because it does not launch in full screen on Linux.
+    # However, as the following Issue states, Electron(base of vscode) can not be muximize by webdriver protocol.
+    # https://github.com/electron/electron/issues/33942
+    # Therefore, GUI-based methods are used to maximize the screen.
+    # The process of maximizing screen size using xdotool is done in the before hook of wdio.conf.ts.
+    - name: Set display resolution on Linux
+      if: runner.os == 'Linux'
+      shell: bash
+      run: |
+        pnpm --filter @vscode-wdio/xvfb-patch run patch -w ${{ inputs.width }} -h ${{ inputs.height }}
+        echo "::group::apt install -y xdotool"
+        sudo apt install -y xdotool
+        echo "::endgroup::"
+
+    # already use FHD resolution
+    - name: Set display resolution on MacOS
+      if: runner.os == 'macOS'
+      shell: bash
+      run: |
+        brew install displayplacer
+        displayplacer list

e2e/wdio.conf.ts

@@ -2,6 +2,7 @@ import * as path from 'node:path'
 import * as url from 'node:url'
 
 import { minVersion } from 'semver'
+import shell from 'shelljs'
 
 import pkg from '../packages/vscode-webdriverio/package.json' with { type: 'json' }
 import type { Frameworks } from '@wdio/types'
@@ -76,6 +77,14 @@ export function createBaseConfig(workspacePath: string, userSettings = {}): Webd
             timeout: 6000000,
             require: ['assertions/index.ts'],
         },
+        before: async function (_capabilities, _specs, _browser) {
+            if (process.platform === 'linux') {
+                const result = shell.exec('xdotool search --onlyvisible --name code')
+                const windowId = result.stdout.trim()
+                shell.exec(`xdotool windowmove ${windowId} 0 0`)
+                shell.exec(`xdotool windowsize ${windowId} 100% 100%`)
+            }
+        },
         afterTest: async function (_test: unknown, _context: unknown, result: Frameworks.TestResult) {
             if (!result.passed) {
                 await browser.saveScreenshot(path.join(outputDir, `screenshot-${screenshotCount++}.png`))

infra/xvfb-patch/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@vscode-wdio/xvfb-patch",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "patch": "tsx ./src/index.ts"
+  }
+}

infra/xvfb-patch/src/index.ts

@@ -0,0 +1,48 @@
+import * as fs from 'node:fs'
+import * as path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { parseArgs } from 'node:util'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const rootDir = path.resolve(__dirname, '../../..')
+const filePath = path.join(rootDir, 'node_modules', 'xvfb-maybe', 'src', 'xvfb-maybe.js')
+
+const args = process.argv.slice(2)
+const optionsDef = {
+    width: {
+        type: 'string',
+        short: 'w',
+    },
+    height: {
+        type: 'string',
+        short: 'h',
+    },
+} as const
+
+const { values: options } = parseArgs({ args, options: optionsDef })
+
+console.log('Adjust screen resolution')
+console.log(`  Width : ${options.width}`)
+console.log(`  Height: ${options.height}`)
+
+const insertBefore = "const dblDashPos = args.indexOf('--'),"
+const codeToInsert = `  args.unshift('--server-args=-screen 0 ${options.width}x${options.height}x24', '--');`
+
+const sourceCode = fs.readFileSync(filePath, 'utf-8')
+
+if (sourceCode.includes(codeToInsert)) {
+    console.log('🔧 xvfb-maybe is already patched')
+    process.exit(0)
+}
+
+const lines = sourceCode.split('\n')
+const index = lines.findIndex((line) => line.includes(insertBefore))
+
+if (index !== -1) {
+    lines.splice(index, 0, codeToInsert)
+    const newCode = lines.join('\n')
+    fs.writeFileSync(filePath, newCode, 'utf-8')
+    console.log('\n✅ xvfb-maybe is patched successfully\n\n')
+} else {
+    console.log('\n💥 could not find the target line.\n\n')
+}

infra/xvfb-patch/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "resolveJsonModule": true
+  }
+}