import { BrowserWindow } from 'electron/main'; import { AssertionError } from 'chai'; import { SuiteFunction, TestFunction } from 'mocha'; import * as childProcess from 'node:child_process'; import * as http from 'node:http'; import * as http2 from 'node:http2'; import * as https from 'node:https'; import * as net from 'node:net'; import * as path from 'node:path'; import { setTimeout } from 'node:timers/promises'; import * as url from 'node:url'; import * as v8 from 'node:v8'; const addOnly = (fn: Function): T => { const wrapped = (...args: any[]) => { return fn(...args); }; (wrapped as any).only = wrapped; (wrapped as any).skip = wrapped; return wrapped as any; }; export const ifit = (condition: boolean) => (condition ? it : addOnly(it.skip)); export const ifdescribe = (condition: boolean) => (condition ? describe : addOnly(describe.skip)); type CleanupFunction = (() => void) | (() => Promise) const cleanupFunctions: CleanupFunction[] = []; export async function runCleanupFunctions () { for (const cleanup of cleanupFunctions) { const r = cleanup(); if (r instanceof Promise) { await r; } } cleanupFunctions.length = 0; } export function defer (f: CleanupFunction) { cleanupFunctions.unshift(f); } class RemoteControlApp { process: childProcess.ChildProcess; port: number; constructor (proc: childProcess.ChildProcess, port: number) { this.process = proc; this.port = port; } remoteEval = (js: string): Promise => { return new Promise((resolve, reject) => { const req = http.request({ host: '127.0.0.1', port: this.port, method: 'POST' }, res => { const chunks = [] as Buffer[]; res.on('data', chunk => { chunks.push(chunk); }); res.on('end', () => { const ret = v8.deserialize(Buffer.concat(chunks)); if (Object.hasOwn(ret, 'error')) { reject(new Error(`remote error: ${ret.error}\n\nTriggered at:`)); } else { resolve(ret.result); } }); }); req.write(js); req.end(); }); }; remotely = (script: Function, ...args: any[]): Promise => { return this.remoteEval(`(${script})(...${JSON.stringify(args)})`); }; } export async function startRemoteControlApp (extraArgs: string[] = [], options?: childProcess.SpawnOptionsWithoutStdio) { const appPath = path.join(__dirname, '..', 'fixtures', 'apps', 'remote-control'); const appProcess = childProcess.spawn(process.execPath, [appPath, ...extraArgs], options); appProcess.stderr.on('data', d => { process.stderr.write(d); }); const port = await new Promise(resolve => { appProcess.stdout.on('data', d => { const m = /Listening: (\d+)/.exec(d.toString()); if (m && m[1] != null) { resolve(Number(m[1])); } }); }); defer(() => { appProcess.kill('SIGINT'); }); return new RemoteControlApp(appProcess, port); } export function waitUntil ( callback: () => boolean|Promise, opts: { rate?: number, timeout?: number } = {} ) { const { rate = 10, timeout = 10000 } = opts; return (async () => { const ac = new AbortController(); const signal = ac.signal; let checkCompleted = false; let timedOut = false; const check = async () => { let result; try { result = await callback(); } catch (e) { ac.abort(); throw e; } return result; }; setTimeout(timeout, { signal }) .then(() => { timedOut = true; checkCompleted = true; }); while (checkCompleted === false) { const checkSatisfied = await check(); if (checkSatisfied === true) { ac.abort(); checkCompleted = true; return; } else { await setTimeout(rate); } } if (timedOut) { throw new Error(`waitUntil timed out after ${timeout}ms`); } })(); } export async function repeatedly ( fn: () => Promise, opts?: { until?: (x: T) => boolean, timeLimit?: number } ) { const { until = (x: T) => !!x, timeLimit = 10000 } = opts ?? {}; const begin = Date.now(); while (true) { const ret = await fn(); if (until(ret)) { return ret; } if (Date.now() - begin > timeLimit) { throw new Error(`repeatedly timed out (limit=${timeLimit})`); } } } async function makeRemoteContext (opts?: any) { const { webPreferences, setup, url = 'about:blank', ...rest } = opts ?? {}; const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false, ...webPreferences }, ...rest }); await w.loadURL(url.toString()); if (setup) await w.webContents.executeJavaScript(setup); return w; } const remoteContext: BrowserWindow[] = []; export async function getRemoteContext () { if (remoteContext.length) { return remoteContext[0]; } const w = await makeRemoteContext(); defer(() => w.close()); return w; } export function useRemoteContext (opts?: any) { before(async () => { remoteContext.unshift(await makeRemoteContext(opts)); }); after(() => { const w = remoteContext.shift(); w!.close(); }); } async function runRemote (type: 'skip' | 'none' | 'only', name: string, fn: Function, args?: any[]) { const wrapped = async () => { const w = await getRemoteContext(); const { ok, message } = await w.webContents.executeJavaScript(`(async () => { try { const chai_1 = require('chai') const promises_1 = require('node:timers/promises') chai_1.use(require('chai-as-promised')) chai_1.use(require('dirty-chai')) await (${fn})(...${JSON.stringify(args ?? [])}) return {ok: true}; } catch (e) { return {ok: false, message: e.message} } })()`); if (!ok) { throw new AssertionError(message); } }; let runFn: any = it; if (type === 'only') { runFn = it.only; } else if (type === 'skip') { runFn = it.skip; } runFn(name, wrapped); } export const itremote = Object.assign( (name: string, fn: Function, args?: any[]) => { runRemote('none', name, fn, args); }, { only: (name: string, fn: Function, args?: any[]) => { runRemote('only', name, fn, args); }, skip: (name: string, fn: Function, args?: any[]) => { runRemote('skip', name, fn, args); } }); export async function listen (server: http.Server | https.Server | http2.Http2SecureServer) { const hostname = '127.0.0.1'; await new Promise(resolve => server.listen(0, hostname, () => resolve())); const { port } = server.address() as net.AddressInfo; const protocol = (server instanceof http.Server) ? 'http' : 'https'; return { port, hostname, url: url.format({ protocol, hostname, port }) }; }