main/smoke-test

Interfaces

SmokeReport

Defined in: app/src/main/smoke-test.ts:8

The report that a packaged build writes in self-test mode.

Properties

arch

readonly arch: string

Defined in: app/src/main/smoke-test.ts:13

errors

readonly errors: readonly string[]

Defined in: app/src/main/smoke-test.ts:27

marks

readonly marks: Readonly<Record<string, number>>

Defined in: app/src/main/smoke-test.ts:23

Milliseconds since process start at each start-up step. The page.* marks come from the shell page itself: its Navigation Timing and the marks that it sets.

ok

readonly ok: boolean

Defined in: app/src/main/smoke-test.ts:9

packaged

readonly packaged: boolean

Defined in: app/src/main/smoke-test.ts:14

platform

readonly platform: string

Defined in: app/src/main/smoke-test.ts:12

readyAt

readonly readyAt: number

Defined in: app/src/main/smoke-test.ts:18

Wall-clock time of that moment, so a harness can measure from the spawn.

rendererSandboxed

readonly rendererSandboxed: boolean | "unknown"

Defined in: app/src/main/smoke-test.ts:26

Whether renderer processes run inside the Chromium sandbox.

shellReadyMs

readonly shellReadyMs: number

Defined in: app/src/main/smoke-test.ts:16

Milliseconds from process start until the shell finished loading and rendered.

shellUrl

readonly shellUrl: string

Defined in: app/src/main/smoke-test.ts:24

version

readonly version: string

Defined in: app/src/main/smoke-test.ts:10

versions

readonly versions: Readonly<Record<string, string | undefined>>

Defined in: app/src/main/smoke-test.ts:11

Functions

runSandboxHelpSmokeTest()

runSandboxHelpSmokeTest(contents, reportPath): void

Defined in: app/src/main/smoke-test.ts:170

Self-test of the sandbox help mode: reports that the help page loaded and quits.

Parameters

contents

WebContents

The help page.

reportPath

string

Where to write the report.

Returns

void

---

runSmokeTest()

runSmokeTest(window, reportPath, options): void

Defined in: app/src/main/smoke-test.ts:62

Runs the self-test of a packaged build: waits for the first window’s shell and tab, writes a JSON report and quits. Installers and CI use it to check every package; the performance harness keeps the browser running to measure it.

Parameters

window

BrowserWindowController

The first window.

reportPath

string

Where to write the report.

options

Whether the browser stays open after the report, the start-up marks so far, and the wall-clock time at which their clock, performance.now(), started.

keepRunning

boolean

marks

Readonly<Record<string, number>>

timeOrigin

number

Returns

void