domain/updates/update-service

Classes

UpdateService

Defined in: app/src/domain/updates/update-service.ts:96

Checks for updates on a schedule and downloads them in the background. A downloaded update installs when the browser quits. The service never shows a dialog.

Implements

Disposable

Constructors

Constructor

new UpdateService(engine, clock, logger, options): UpdateService

Defined in: app/src/domain/updates/update-service.ts:116

Parameters

engine

UpdateEngine

Finds, downloads and installs updates.

clock

Clock

Time and timers.

logger

Logger

Logger.

options

UpdateServiceOptions

Policies and installation facts.

Returns

UpdateService

Properties

onDidChange

readonly onDidChange: Event<UpdateState>

Defined in: app/src/domain/updates/update-service.ts:108

Fires whenever UpdateService.state changes.

Accessors

state

Get Signature

get state(): UpdateState

Defined in: app/src/domain/updates/update-service.ts:133

The current state.

Returns

UpdateState

Methods

check()

check(): Promise<UpdateState>

Defined in: app/src/domain/updates/update-service.ts:147

Checks now and downloads an update if there is one. Concurrent calls share one run.

Returns

Promise<UpdateState>

The state after the run.

dispose()

dispose(): void

Defined in: app/src/domain/updates/update-service.ts:170

Cancels the schedule.

Returns

void

Implementation of

Disposable.dispose

installOnExit()

installOnExit(): boolean

Defined in: app/src/domain/updates/update-service.ts:161

Installs a downloaded update while the browser exits.

Returns

boolean

Whether an installation started.

start()

start(): void

Defined in: app/src/domain/updates/update-service.ts:138

Schedules the first automatic check, unless updates are off or manual.

Returns

void

Interfaces

UpdateEngine

Defined in: app/src/domain/updates/update-service.ts:37

Finds, downloads and installs verified updates; electron-updater in the browser.

Methods

check()

check(): Promise<string | undefined>

Defined in: app/src/domain/updates/update-service.ts:42

Looks for a newer version in the signed feed.

Returns

Promise<string | undefined>

The version, or undefined when the browser is up to date.

download()

download(onProgress): Promise<void>

Defined in: app/src/domain/updates/update-service.ts:47

Downloads the update found by the last check and verifies it.

Parameters

onProgress

(percent) => void

Receives the progress in percent.

Returns

Promise<void>

install()

install(): void

Defined in: app/src/domain/updates/update-service.ts:52

Starts the silent installation of the downloaded update. Called while the browser exits, after everything is saved.

Returns

void

UpdateHooks

Defined in: app/src/domain/updates/update-service.ts:56

Work around an installation that keeps a rollback possible.

Methods

afterDownload()

afterDownload(version): Promise<void>

Defined in: app/src/domain/updates/update-service.ts:62

Runs after a download while the browser keeps running, such as fetching the package of the running version. A failure is logged; the update still installs.

Parameters

version

string

The downloaded version.

Returns

Promise<void>

beforeInstall()

beforeInstall(version): void

Defined in: app/src/domain/updates/update-service.ts:67

Runs right before the installation starts, while the browser exits.

Parameters

version

string

The version being installed.

Returns

void

UpdateServiceOptions

Defined in: app/src/domain/updates/update-service.ts:71

Settings of the update service, resolved from policies and the installation.

Properties

hasKeys

readonly hasKeys: boolean

Defined in: app/src/domain/updates/update-service.ts:75

Whether the build carries update keys; without them, nothing can be verified.

hooks?

readonly optional hooks?: UpdateHooks

Defined in: app/src/domain/updates/update-service.ts:83

Rollback preparation around downloads and installations.

installType

readonly installType: InstallType

Defined in: app/src/domain/updates/update-service.ts:73

isOnline

readonly isOnline: () => boolean

Defined in: app/src/domain/updates/update-service.ts:79

Whether the system reports a network connection.

Returns

boolean

mode

readonly mode: UpdateMode

Defined in: app/src/domain/updates/update-service.ts:72

periodMinutes

readonly periodMinutes: number

Defined in: app/src/domain/updates/update-service.ts:77

Minutes between automatic checks.

random?

readonly optional random?: () => number

Defined in: app/src/domain/updates/update-service.ts:81

Random number in [0, 1) for the jitter; replaceable in tests.

Returns

number

Type Aliases

InstallType

InstallType = "nsis" | "msi" | "mac" | "appimage" | "deb" | "rpm" | "unpacked"

Defined in: app/src/domain/updates/update-service.ts:8

How the browser was installed, which decides who installs updates.

UpdateMode

UpdateMode = "off" | "automatic" | "manual"

Defined in: app/src/domain/updates/update-service.ts:20

The UpdatePolicy values: off, automatic, or only when the user asks.

UpdateState

UpdateState = { kind: "disabled"; reason: "policy" | "install-type" | "no-keys"; } | { kind: "idle"; lastCheckAt?: number; } | { kind: "checking"; } | { kind: "downloading"; percent: number; version: string; } | { kind: "ready"; version: string; } | { at: number; code: string; kind: "failed"; message: string; }

Defined in: app/src/domain/updates/update-service.ts:23

What the updater is doing.

Variables

UpdateServiceToken

const UpdateServiceToken: Token<UpdateService>

Defined in: app/src/domain/updates/update-service.ts:240

Token for the UpdateService.

Functions

updatesItself()

updatesItself(type): boolean

Defined in: app/src/domain/updates/update-service.ts:15

Whether the browser installs updates of this installation type itself. IT updates MSI installations, and the package manager updates deb and rpm installations.

Parameters

type

InstallType

The installation type.

Returns

boolean