// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. import { isDaemonControlRecord } from './ControlRecord'; import { DaemonProtocolError } from './DaemonProtocolError'; import { validateEnvironmentChange } from './EnvironmentChangeValidation'; import { validateWorkspaceInputsChange } from './WorkspaceInputsChangeValidation'; const INSTALLATION_CHANGE_KINDS: ReadonlySet = new Set(['removed', 'replaced']); const INSTALLATION_CHANGED: string = 'installationChanged'; const ENVIRONMENT_CHANGED: string = 'environmentChanged'; const WORKSPACE_INPUTS_CHANGED: string = 'workspaceInputsChanged'; const NATIVE_MUTATION: string = 'nativeMutation'; const EMPTY_LENGTH: number = 0; /** Validates the fields of each known restart reason kind; unknown kinds are accepted. */ const REASON_VALIDATORS: ReadonlyMap) => void> = new Map([ [ INSTALLATION_CHANGED, (reason: Record) => validateInstallationChange(reason, 'restartReason') ], [ENVIRONMENT_CHANGED, validateEnvironmentChange], [WORKSPACE_INPUTS_CHANGED, validateWorkspaceInputsChange], [NATIVE_MUTATION, validateNativeMutation] ]); /** Validates an optional installation change, as reported by pong or by a restart reason. @internal */ export function validateInstallationChange(value: unknown, field: string): void { if (value === undefined) return; requireRecord(value, field); if (!INSTALLATION_CHANGE_KINDS.has(value.change)) fail(`${field}.change`); requireFolder(value.folder, `${field}.folder`); } /** Validates an optional restart reason. Unknown kinds from newer daemons are accepted and ignored. @internal */ export function validateRestartReason(payload: Record): void { if (payload.restartReason === undefined) return; if (payload.retryAfterRestart !== true) fail('restartReason without retryAfterRestart'); validateReason(payload.restartReason); } /** Validates the optional restart reason of a queue position, which needs no retry flag. @internal */ export function validateQueuedRestartReason(payload: Record): void { if (payload.restartReason !== undefined) validateReason(payload.restartReason); } function validateReason(reason: unknown): void { requireRecord(reason, 'restartReason'); requireKind(reason.kind); REASON_VALIDATORS.get(reason.kind)?.(reason); } function validateNativeMutation(reason: Record): void { const { commandName } = reason; if (typeof commandName !== 'string' || commandName.length === EMPTY_LENGTH) fail('restartReason.commandName'); } function requireRecord(value: unknown, field: string): asserts value is Record { if (!isDaemonControlRecord(value) || Array.isArray(value)) fail(field); } function requireKind(value: unknown): void { if (typeof value !== 'string' || value.length === EMPTY_LENGTH) fail('restartReason.kind'); } function requireFolder(value: unknown, field: string): void { if (typeof value !== 'string' || value.length === EMPTY_LENGTH) fail(field); } function fail(field: string): never { throw new DaemonProtocolError('malformedControlMessage', `Invalid ${field}.`); }