mirror of
https://github.com/morluto/rea.git
synced 2026-11-16 19:53:50 +00:00
* test(architecture): fail on a stale layer baseline and document the declared layers verify:module-boundaries reported a layer baseline entry whose imports were gone but still passed, so main kept process -> artifacts at 20 after it fell to 17 and a later change could add three imports back unnoticed. A stale entry now fails like growth; --shrink-layer-baseline lowers it in the change that removes the imports. The architecture map and CONTRIBUTING name scripts/lib/module-layers.mjs as the per-directory layer declaration. * test(architecture): refuse to lower the layer baseline after an inspection failure A file that cannot be parsed contributes no imports, so a shrink run would record counts that fail as growth once the file is fixed. Whole-command tests cover stale rejection, shrinking, refused growth and the inspection failure. * refactor(ports): move the progress, work-scope and inspection-scope ports to src/ports (#11214) * refactor(ports): move the progress, work-scope and inspection-scope ports to src/ports Pure move with git mv and import specifier updates. * test(architecture): declare the ports layer and lower the layer baseline src/ports sits between the foundation and the providers. Moving the three ports removes 11 provider -> application imports. * refactor(ports): move AnalysisProvider to src/ports (#11217) * refactor(ports): move AnalysisProvider to src/ports Pure move with git mv and import specifier updates in its importers, the built-fixture path, the CI scope glob and the lint-rule test spellings. * test(architecture): lower the layer baseline after moving AnalysisProvider * refactor(ports): move the per-feature provider ports to src/ports (#11226) * refactor(ports): move the per-feature provider ports to src/ports Pure move with git mv and import specifier updates: the 47 *Port.ts and *Ports.ts files that providers implement, plus OptionalObservationProviders, which only composes the observation ports. * test(architecture): lower the layer baseline after moving the feature ports * refactor(providers): move closeAnalysisClient and the Frida session input errors to their owners (#11233) * refactor(providers): move closeAnalysisClient to src/providers and the Frida session input errors to src/frida Pure move with git mv and import specifier updates. * test(architecture): drop the application-providers and application-frida cycles from the layer baseline * fix(ci): keep provider lanes selecting the ports moved to src/ports Each lane glob that matched a moved port under src/application gains its src/ports counterpart; the change-scope test pins one moved port per lane. * refactor(domain): declare the localPath host exception and read HOST_PLATFORM there (#11256) absoluteLocalPathStringSchema decides which paths are absolute on the running host, so it reads HOST_PLATFORM instead of process.platform. Domain may not import outside domain/contracts; module-layers now declares LAYER_EXCEPTIONS, exact file-to-file imports with a reason, and both the layer count and the pure-layer boundary skip only that import. Any other domain -> platform import still fails. * refactor(ports): move the doctor check and provider inspection types to src/ports (#11246) * refactor(ports): move the doctor check and provider inspection types to src/ports Declaration move from application/Doctor.ts (unchanged text) and import updates; no re-export from Doctor.ts. * test(architecture): lower the layer baseline after moving the doctor provider types * refactor(ports): move the packet capture and signal recording ports to src/ports (#11249) * refactor(ports): move the packet capture and signal recording ports to src/ports Declaration move (unchanged text) out of the two application services, with import updates. * test(architecture): lower the layer baseline after moving the capture and signal ports * refactor(domain): move the analysis error projection schema from contracts to domain (#11251) * refactor(domain): move the analysis error projection schema from contracts to domain Declaration move (unchanged text) of the projection schemas that domain modules embed; contracts/errorSchemas.ts keeps the CLI envelope and the published JSON Schema. Import updates only. * test(architecture): drop the contracts-domain cycle from the layer baseline * refactor(ports): drop the imports the moved capture, signal and doctor types left behind Also give the packet capture and signal recording lanes the new port paths, with change-scope cases. * refactor(resources): add src/resources and move AnalysisCleanupLease and ArtifactReader there (#11259) * refactor(resources): move AnalysisCleanupLease to src/resources Pure move: git mv plus import specifier rewrites (source, tests, and the dist paths the verifier scripts load). * refactor(resources): declare src/resources as a foundation unit src/resources owns the shared analysis resource modules that process, windows and providers hold; AnalysisCleanupLease is the first. Its tests join the adapters project, the apk signature lane selects it beside src/artifacts, and the layer baseline drops the process and windows imports of the lease. * test(ci): pin the apk signature lane on the moved cleanup lease * refactor(resources): move ArtifactReader to src/resources Pure move: git mv plus import specifier rewrites (source, tests, and the dist path a verifier script loads). * test(architecture): lower the layer baseline after moving ArtifactReader windows no longer imports src/artifacts; process -> artifacts 11 -> 9. The CI lanes that selected src/artifacts/ArtifactReader.ts select its new path, pinned in the change-scope test. * refactor(resources): move ArtifactResourceScope to src/resources (#11265) * refactor(artifacts): name the output tree and private root capabilities the resource scope releases ArtifactResourceScope typed its output-tree and private-runtime-root owners with SafeOutputTree (src/artifacts) and PrivateRuntimeRoot (src/process). It only calls rollback() and close(), so it now declares those capabilities itself and names neither unit, which lets it move to src/resources without a resources <-> process cycle. The withheld-export test narrows to SafeOutputTree where it reads the published flag. * refactor(resources): move ArtifactResourceScope to src/resources Pure move: git mv plus import specifier rewrites (source, tests, the dist paths verifier scripts load, and the FIFO probe's module-relative URL). * test(architecture): lower the layer baseline after moving ArtifactResourceScope process -> artifacts 9 -> 5, and the artifacts <-> dotnet mutual pair is gone. The sqlite and agentenv lanes select the scope at its new path, pinned in the change-scope test. * refactor(resources): move ArtifactFileOperation to src/resources (#11269) * refactor(resources): move ArtifactFileOperation to src/resources Pure move: git mv plus import specifier rewrites (source, tests, and the dist paths verifier scripts load). * test(architecture): lower the layer baseline after moving ArtifactFileOperation process -> artifacts 5 -> 1. * refactor(resources): move readStableArtifact to src/resources (#11271) * refactor(resources): move readStableArtifact to src/resources Pure move: git mv plus import specifier rewrites. * test(architecture): lower the layer baseline after moving readStableArtifact process no longer imports src/artifacts: process -> artifacts 1 -> 0 and the artifacts <-> process mutual pair is gone. The seven lanes that selected readStableArtifact select its new path, pinned in the change-scope test; the architecture map lists what src/resources owns. * refactor(hopper): take Linux launcher verification from composition through a port (#11278) The Hopper launcher imported inspectLinuxHopperLauncher and retryLinuxHopperPublisherCleanup from src/application (the two hopper -> application imports). src/ports/LinuxHopperLauncherVerification.ts now names that capability; src/application/LinuxHopper.ts provides LINUX_HOPPER_LAUNCHER_VERIFICATION, binary composition passes it to HopperProvider, and the provider hands it to the launcher. A launcher built without one refuses a Linux demo launch with reason verification_unavailable before running the launcher. Layer baseline: hopper -> application 2 -> 0. * refactor(config): move Hopper launcher discovery to a src/hopperPaths foundation unit (#11292) * refactor(hopper): move the launcher discovery and macOS Hopper paths to src/hopperPaths Pure move: git mv plus import specifier rewrites. * refactor(hopper): declare src/hopperPaths as a foundation unit with the Linux launcher candidates Hopper install paths and launcher discovery are pure path facts that the Hopper provider, doctor and setup all read. Declare src/hopperPaths in the foundation layer, add it to the adapters test project, the architecture map and the package-baseline CI lane, and move the Linux launcher candidates out of src/application/LinuxHopper.ts into src/hopperPaths/LinuxHopperPaths.ts so discovery no longer imports application code. * refactor(config): leave Hopper launcher discovery to the Hopper provider parseConfig resolved an unset HOPPER_LAUNCHER_PATH by probing the filesystem through application-owned discovery, so config imported application (config -> application 2, application <-> config cycle) and read process.platform ambiently. AppConfig.hopperLauncherPath is now the caller's HOPPER_LAUNCHER_PATH unchanged (string | undefined). src/hopperPaths/HopperLauncherDiscovery.ts owns the selection (selectedHopperLauncherPath: the configured spelling, else discovery from the caller environment's home on the provider's platform); HopperProvider and the two real-Hopper verifiers read it. Discovery tests move from config.test.ts to src/hopperPaths; a provider test covers discovery from the provider's own platform and home. Module layers: config -> application 2 -> 0; application <-> config removed. Architecture guards: ambient platform reads in parseConfig.ts 2 -> 0. * refactor(providers): move owned-process prerequisite availability out of application (#11294) * refactor(providers): move the owned-process prerequisite availability mapping to src/providers Pure move: git mv plus import specifier rewrites. * test(architecture): lower the layer baseline after moving owned-process availability android -> application 1 -> 0; apktool -> application 1 -> 0. * refactor(process): move the regular-file read owner out of application (#11299) * refactor(process): move the regular-file read owner from src/application to src/process Pure move: git mv plus import specifier rewrites. * test(architecture): lower the layer baseline after moving the regular-file read owner desktop -> application 5 -> 4; dotnet -> application 2 -> 1. The agentenv lane listed src/application/RegularFileRead.ts. At its new path it is a src/process/ shared boundary: fast qualification selects the code and runtime checks (and the single owning lane, web_source_map, via src/process/**), and full qualification selects every lane, as for every other src/process/ module. A second owner entry would only suppress the web_source_map selection, so the agentenv entry is removed, not renamed. * refactor(resources): give atomic text writes their own owner (#11302) * refactor(resources): give atomic text writes their own owner in src/resources src/application/JsonFiles.ts owned both JSON input reads and the atomic text write (writeTextFile / writeTextParts and their staged-output publication). The write side depends only on domain, filesystem and resource owners, but il2cpp's Ghidra seed writer had to import application to reach it (il2cpp -> application). Move the write side verbatim to src/resources/TextFileWrite.ts (TextWriteCancellation, writeTextFile, writeTextParts and their private staging, publication and failure classification helpers). JsonFiles keeps the JSON read owner and reads the shared errno-to-reason classifier (fileAccessFailureReason) from the write owner instead of a copy. Importers (il2cpp seed writer, evidence bundle files, desktop build solves, analysis snapshot files and four boundary tests) read the new path; no re-export is left in JsonFiles. * test(architecture): lower the layer baseline after moving the text write owner il2cpp -> application 1 -> 0. * refactor(ports): move the desktop build host contract to src/ports (#11303) * refactor(domain): move the setup cancellation check from src/application to src/domain Pure move: git mv plus import specifier rewrites. * refactor(ports): move the desktop build host contract to src/ports The desktop provider implements doctor's desktop build facts reader and setup's desktop build host, but the contract it implements lived in application (DesktopBuildDoctor, SetupDesktopBuild, Doctor's clientRegistrations signature, ClientRegistrationEnvironment's setting types), so desktop imported application four times and the two units were a recorded mutual pair. src/ports/DesktopBuildHost.ts now holds that contract, moved verbatim: DesktopBuildCommand, DesktopBuildFacts, DesktopBuildFactsInput, DesktopBuildSetupFacts, DesktopBuildSetupHost, RecordedProviderSettings and OwnedProviderSetting. Two names are new: DesktopBuildRegistration, the registration facts the host reads (client, command and the recorded-settings names; client registration status satisfies it), and DesktopBuildRegistrationReader, which replaces DoctorHost["clientRegistrations"] in the setup host. The facts input's registration reader returns DesktopBuildRegistration instead of the full application status; the setup facts' settings are spelled Readonly<Record<string, string>> (SetupProviderEnvironment's definition). Application imports the types from the port; no re-export is left. * test(architecture): lower the layer baseline after the desktop build host port desktop -> application 4 -> 0; the application <-> desktop mutual pair is gone. * refactor(domain): define the resolved app bundle resource root beside its schema (#11304) * refactor(domain): define the resolved app bundle resource root beside its provenance schema ResolvedAppBundleResourceRoot (an app directory's resource-only identity) is a pure type over BundleResourceRoot's layout, but it lived in src/application/AppBundleExecutable.ts, so the native and artifact providers that receive it imported application. Move the interface verbatim to src/domain/apple/bundleResourceRoot.ts, which owns BundleResourceRoot, and point its eight readers there (native macOS provider and plist source, artifact provider, binary composition, and the binary session, status, port and bundle-resource session). The resolver that produces it stays in application. * test(architecture): lower the layer baseline after moving the resource root type native -> application 2 -> 0; artifacts -> application 2 -> 1 (the artifact provider still constructs BundleResourceSession). * refactor(config): move the pwntools input bound parser to src/config (#11306) * refactor(config): move the pwntools input bound parser from src/native to src/config Pure move: git mv plus import specifier rewrites, and the module path in docs/design/rea-limit-inventory.md (table realigned by oxfmt). * test(architecture): lower the layer baseline after moving the pwntools input bound config -> native 1 -> 0. The binary_layout and recorded_crash lanes, which select src/native/pwntools/**, also select src/config/pwntoolsInputLimit*.ts; ciChangeScope.test.ts pins both. * refactor(filesystem): move REA cache directory helpers out of config (#11309) * refactor(filesystem): move the REA cache directory and lexical directory helpers from src/config to src/filesystem Pure move: git mv plus import specifier rewrites. * test(architecture): drop the config and filesystem cycle from the layer baseline config no longer imports filesystem; filesystem still reads the Windows ChangeTime settle budget from config. * refactor(windows): break the process and windows import cycle (#11317) * refactor(domain): move the runtime-control and private-runtime-root refusals from src/process to src/domain Pure move: git mv plus import specifier rewrites (including the dist path scripts/verify-windows-native.mjs loads). * refactor(windows): type Job Object cleanup by what a Windows job reports WindowsOwnedProcess.cleanup() returned process-ownership's ProcessCleanupResult, so src/windows imported src/process for a type while process imports windows to supervise Windows trees. A Job Object stop only ever reports settled-and-signalled or a reason it did not settle; name that subset WindowsJobCleanupResult in windows. It stays assignable to ProcessCleanupResult, so the process supervisor reads it unchanged. * test(architecture): drop the process and windows cycle from the layer baseline * test(architecture): ratchet cross-provider imports and imports past a provider entry (#11386) * test(architecture): ratchet cross-provider imports and imports past a provider entry A provider folder may import the domain, contracts, foundation and ports layers, the shared provider core (src/providers) and its own files; an import of another provider folder is a recorded exception. Application, composition and the CLI/MCP adapters reach a provider only through src/<provider>/index.ts. verify:module-boundaries counts both kinds of import per unit pair in the layer baseline (crossProvider, providerEntry); like the upward counts they may only shrink, and a pair missing from the baseline fails. * refactor(resources): move StableArtifactFailure and StableArtifactObservation into src/resources (#11387) * refactor(resources): move StableArtifactFailure and StableArtifactObservation into src/resources Providers project stable-read failures through StableArtifactFailure next to the other shared provider toolkit owners (ArtifactReader, ArtifactResourceScope, ArtifactFileOperation, AnalysisCleanupLease, readStableArtifact) that already live in src/resources. Under src/artifacts it made every provider that reads a stable artifact import the artifacts provider. Pure move: git mv plus import specifier and baseline updates; the layer baseline drops the provider-boundary counts the move removes. * refactor(resources): reach the shared provider toolkit through src/resources/index.ts (#11390) * refactor(resources): import the shared provider toolkit through src/resources/index.ts Adds src/resources/index.ts, which exports the toolkit names that production code outside src/resources uses, and rewrites those importers (420 files) to import from it, merging each importer's toolkit imports into one declaration. Mechanical: import declarations only. * test(architecture): reach src/resources only through its entry file verify:module-boundaries now counts any production import of a src/resources file other than src/resources/index.ts, from any unit, with the imports past a provider entry. The count is renamed from providerEntry to entry ("import past the entry file"); it may only shrink, and src/resources starts at zero. * test(architecture): cover provider boundary counts through the verifier command * refactor(resources): move the safe output tree and artifact path owners into src/resources (#11398) * refactor(resources): move the safe output tree and artifact path owners into src/resources SafeOutputTree (with its admission, creation failure, readback, cleanup and identity files), StreamBytes, ArtifactPaths and readArtifactFileChunks depend only on domain, filesystem, platform and the toolkit, and browser, firmware, ghidra, javascript, android and apktool use them to publish outputs. Under src/artifacts every such provider imported the artifacts provider. Pure move: git mv, importers moved onto src/resources/index.ts (names added to the entry), the moved files import toolkit modules directly, path keys in the CI scopes and guard baseline follow the move, and the layer baseline drops the removed imports. * test(architecture): give the shared provider core its own layer below the providers (#11401) src/providers (deferred client owners and failure attribution) now imports only domain, ports, process, filesystem and the resources toolkit. Declaring it as the providerCore layer, between ports and providers, makes any import from it into a provider folder an upward import that verify:module-boundaries rejects, and lets every unit in the providers layer be a provider folder. * test(architecture): declare each provider's entry files instead of a provider barrel (#11407) * chore: ignore the source map parser move (#11348) in blame * test(architecture): declare inspector's use of the browser CDP client as a provider dependency (#11420)
660 lines
23 KiB
TypeScript
660 lines
23 KiB
TypeScript
import { execFile } from "node:child_process";
|
|
import {
|
|
access,
|
|
mkdir,
|
|
mkdtemp,
|
|
readdir,
|
|
readFile,
|
|
rename,
|
|
rm,
|
|
writeFile,
|
|
} from "node:fs/promises";
|
|
import { tmpdir } from "node:os";
|
|
import { join, posix } from "node:path";
|
|
import { promisify } from "node:util";
|
|
|
|
import { z } from "zod";
|
|
|
|
import { appendCallerPath } from "../filesystem/callerPath.js";
|
|
import type { AnalysisCleanupObservation } from "../domain/analysisErrorBase.js";
|
|
import { HOPPER_PUBLISHER } from "../domain/hopperPublisher.js";
|
|
import { macDeveloperIdRequirement } from "../process/MacCodeSignature.js";
|
|
import { macHopperUserApplicationPath } from "../hopperPaths/MacHopperPaths.js";
|
|
import {
|
|
downloadHopperPackage,
|
|
isHopperRequestCancellation,
|
|
HOPPER_METADATA_TIMEOUT_MS,
|
|
type HopperDownload,
|
|
type HopperRequestFailure,
|
|
} from "./HopperDownload.js";
|
|
import {
|
|
HOPPER_RELEASES_URL,
|
|
HOPPER_DOWNLOAD_PREFIX,
|
|
parseHopperReleaseJson,
|
|
parseMacHopperReleases,
|
|
hopperArchiveIntegrityMatches,
|
|
macHopperReleaseMinimumSystemVersion,
|
|
} from "./HopperReleaseFeed.js";
|
|
import type { HopperInstallFailureReason } from "./SetupInstallFailure.js";
|
|
import { decodeInfoPlistValue } from "./AppBundleExecutable.js";
|
|
import {
|
|
macosMajorVersion,
|
|
macosVersionMeetsMinimum,
|
|
} from "../domain/macosVersion.js";
|
|
|
|
const execFileAsync = promisify(execFile);
|
|
const HOPPER_PUBLISHER_REQUIREMENT = macDeveloperIdRequirement(
|
|
HOPPER_PUBLISHER.bundleIdentifier,
|
|
HOPPER_PUBLISHER.teamIdentifier,
|
|
);
|
|
|
|
/** Outcome of reading a mounted bundle's signature and publisher identity. */
|
|
export type MacHopperBundleVerification =
|
|
| "verified"
|
|
| "invalid_signature"
|
|
| "unverified_publisher";
|
|
|
|
type MacHopperInstallFailureReason = Extract<
|
|
HopperInstallFailureReason,
|
|
| "unsupported_host"
|
|
| "incompatible_host_version"
|
|
| "release_metadata"
|
|
| "download"
|
|
| "integrity"
|
|
| "launcher_missing"
|
|
| "destination_exists"
|
|
| "destination_inspection"
|
|
| "mount"
|
|
| "bundle"
|
|
| "publisher_verification_failed"
|
|
| "copy"
|
|
| "cancelled"
|
|
>;
|
|
|
|
export type MacHopperBundleInstallResult =
|
|
| { readonly status: "installed"; readonly cleanupFailure?: string }
|
|
| {
|
|
readonly status: "failed";
|
|
readonly reason: "copy" | "launcher_missing";
|
|
readonly diagnostic: string;
|
|
readonly cleanupFailure?: string;
|
|
};
|
|
|
|
/** Filesystem effects for one installer-owned bundle replacement transaction. */
|
|
export interface MacHopperBundleInstallOperations {
|
|
createStagingRoot(parent: string): Promise<string>;
|
|
copyBundle(source: string, stage: string): Promise<void>;
|
|
requireLauncher(path: string): Promise<void>;
|
|
pathExists(path: string): Promise<boolean>;
|
|
rename(source: string, destination: string): Promise<void>;
|
|
removeStagingRoot(path: string): Promise<void>;
|
|
}
|
|
|
|
/** Stable effects and checks disclosed before macOS Hopper setup. */
|
|
export const macHopperInstallDisclosure = {
|
|
detail:
|
|
"Download the official Hopper package, verify it, and install it. Before the download, and again from the signed app before copying, setup compares the release's minimum macOS version with this Mac's and stops if this Mac is older. Hopper may show its demo or license prompt when first opened.",
|
|
networkOrigins: [HOPPER_RELEASES_URL, HOPPER_DOWNLOAD_PREFIX] as const,
|
|
commands: [
|
|
"hdiutil attach -readonly -nobrowse -mountpoint <private-mount> <verified-hopper.dmg>",
|
|
"codesign --verify --deep --strict <mounted-hopper.app>",
|
|
`codesign --verify --strict '-R${HOPPER_PUBLISHER_REQUIREMENT}' <mounted-hopper.app>`,
|
|
"ditto <mounted-hopper.app> <user-Applications-stage>",
|
|
"open <installed-hopper.app>",
|
|
] as const,
|
|
};
|
|
|
|
/** Result of installing the official Hopper macOS application. */
|
|
export type MacHopperInstallResult =
|
|
| {
|
|
readonly status: "installed";
|
|
readonly launcherPath: string;
|
|
readonly cleanupFailure?: string;
|
|
readonly openFailure?: string;
|
|
}
|
|
| {
|
|
readonly status: "failed";
|
|
readonly reason: MacHopperInstallFailureReason;
|
|
readonly diagnostic?: string;
|
|
/** The vendor request (feed or package) whose transport failure stopped setup. */
|
|
readonly download?: HopperRequestFailure;
|
|
readonly cleanupFailure?: string;
|
|
};
|
|
|
|
/** External effects used by the bounded macOS Hopper installer. */
|
|
export interface MacHopperInstallHost {
|
|
download(
|
|
url: string,
|
|
options?: { readonly timeoutMs?: number; readonly signal?: AbortSignal },
|
|
): Promise<HopperDownload>;
|
|
createTemporaryDirectory(): Promise<string>;
|
|
createMountDirectory(path: string): Promise<void>;
|
|
writePackage(path: string, bytes: Uint8Array): Promise<void>;
|
|
mount(packagePath: string, mountPath: string): Promise<boolean>;
|
|
unmount(mountPath: string): Promise<void>;
|
|
appBundle(mountPath: string): Promise<string | undefined>;
|
|
validBundle(appPath: string): Promise<MacHopperBundleVerification>;
|
|
/** This Mac's version, read through the probe setup planning used. */
|
|
macosVersion(): Promise<string | undefined>;
|
|
/** The mounted app's declared LSMinimumSystemVersion; undefined when it declares none. */
|
|
minimumSystemVersion(appPath: string): Promise<string | undefined>;
|
|
destinationExists(path: string): Promise<boolean>;
|
|
installBundle(
|
|
source: string,
|
|
destination: string,
|
|
replaceExisting: boolean,
|
|
): Promise<MacHopperBundleInstallResult>;
|
|
openApplication(path: string): Promise<void>;
|
|
cleanup(path: string): Promise<void>;
|
|
/** Retain the cleanup capability until the owning setup host retries it. */
|
|
retainCleanup?(
|
|
cleanup: () => Promise<void>,
|
|
resources: readonly string[],
|
|
): void;
|
|
destination(): string;
|
|
}
|
|
|
|
/**
|
|
* Download, verify, and install Hopper into the current user's Applications
|
|
* directory. The selected release's own macOS minimum gates installation: the
|
|
* feed's `deployment_target` before the package is downloaded, and the signed
|
|
* app's `LSMinimumSystemVersion` before it is copied.
|
|
*/
|
|
export const installMacHopper = async (
|
|
options: {
|
|
readonly replaceExisting?: boolean;
|
|
/** Stops downloads and the steps after them; a started copy finishes. */
|
|
readonly signal?: AbortSignal;
|
|
},
|
|
host: MacHopperInstallHost,
|
|
): Promise<MacHopperInstallResult> => {
|
|
const cancellation =
|
|
options.signal === undefined ? {} : { signal: options.signal };
|
|
const hostVersion = await host.macosVersion();
|
|
// Without a comparable host version no declared minimum can be checked.
|
|
if (hostVersion === undefined || macosMajorVersion(hostVersion) === undefined)
|
|
return { status: "failed", reason: "unsupported_host" };
|
|
let temporary: string | undefined;
|
|
let mounted = false;
|
|
let bundleCleanupFailure: string | undefined;
|
|
let installStage: MacHopperInstallFailureReason = "release_metadata";
|
|
let result: MacHopperInstallResult;
|
|
try {
|
|
result = await (async (): Promise<MacHopperInstallResult> => {
|
|
const metadata = await host.download(HOPPER_RELEASES_URL, {
|
|
timeoutMs: HOPPER_METADATA_TIMEOUT_MS,
|
|
...cancellation,
|
|
});
|
|
if (!metadata.ok)
|
|
return {
|
|
status: "failed",
|
|
reason: "release_metadata",
|
|
download: { request: "release_feed", ...metadata.error },
|
|
};
|
|
const decoded = parseHopperReleaseJson(metadata.value);
|
|
if (!decoded.ok) throw decoded.cause;
|
|
const parsed = parseMacHopperReleases(decoded.value);
|
|
if (!parsed.ok) return { status: "failed", reason: "release_metadata" };
|
|
const release = parsed.value;
|
|
const releaseMinimum = macHopperReleaseMinimumSystemVersion(release);
|
|
// An unrecognized feed value defers to the signed app checked below.
|
|
if (
|
|
releaseMinimum !== undefined &&
|
|
macosVersionMeetsMinimum(hostVersion, releaseMinimum) === false
|
|
)
|
|
return {
|
|
status: "failed",
|
|
reason: "incompatible_host_version",
|
|
diagnostic: macHopperHostVersionDetail({
|
|
source: "release_feed",
|
|
packageUrl: release.filename,
|
|
minimumVersion: releaseMinimum,
|
|
hostVersion,
|
|
}),
|
|
};
|
|
installStage = "download";
|
|
const archive = await host.download(release.filename, cancellation);
|
|
if (!archive.ok)
|
|
return {
|
|
status: "failed",
|
|
reason: "download",
|
|
download: { request: "package", ...archive.error },
|
|
};
|
|
installStage = "integrity";
|
|
if (!hopperArchiveIntegrityMatches(archive.value, release))
|
|
return { status: "failed", reason: "integrity" };
|
|
|
|
installStage = "destination_inspection";
|
|
const destination = host.destination();
|
|
const destinationExists = await host.destinationExists(destination);
|
|
if (destinationExists && options.replaceExisting !== true)
|
|
return { status: "failed", reason: "destination_exists" };
|
|
options.signal?.throwIfAborted();
|
|
installStage = "mount";
|
|
temporary = await host.createTemporaryDirectory();
|
|
const packagePath = posix.join(temporary, "hopper.dmg");
|
|
const mountPath = posix.join(temporary, "mounted");
|
|
await host.createMountDirectory(mountPath);
|
|
await host.writePackage(packagePath, archive.value);
|
|
if (!(await host.mount(packagePath, mountPath)))
|
|
return { status: "failed", reason: "mount" };
|
|
mounted = true;
|
|
installStage = "bundle";
|
|
const source = await host.appBundle(mountPath);
|
|
if (source === undefined) return { status: "failed", reason: "bundle" };
|
|
const verification = await host.validBundle(source);
|
|
if (verification === "invalid_signature")
|
|
return { status: "failed", reason: "bundle" };
|
|
if (verification === "unverified_publisher")
|
|
return { status: "failed", reason: "publisher_verification_failed" };
|
|
// An app that declares no minimum is accepted, as macOS does.
|
|
const appMinimum = await host.minimumSystemVersion(source);
|
|
if (appMinimum !== undefined) {
|
|
const compatible = macosVersionMeetsMinimum(hostVersion, appMinimum);
|
|
if (compatible === false)
|
|
return {
|
|
status: "failed",
|
|
reason: "incompatible_host_version",
|
|
diagnostic: macHopperHostVersionDetail({
|
|
source: "signed_app",
|
|
minimumVersion: appMinimum,
|
|
hostVersion,
|
|
}),
|
|
};
|
|
if (compatible === undefined)
|
|
return {
|
|
status: "failed",
|
|
reason: "bundle",
|
|
diagnostic: macHopperIncomparableMinimumDetail(
|
|
appMinimum,
|
|
hostVersion,
|
|
),
|
|
};
|
|
}
|
|
options.signal?.throwIfAborted();
|
|
installStage = "copy";
|
|
const installation = await host.installBundle(
|
|
source,
|
|
destination,
|
|
destinationExists,
|
|
);
|
|
if (installation.status === "failed")
|
|
return {
|
|
status: "failed",
|
|
reason: installation.reason,
|
|
diagnostic: installation.diagnostic,
|
|
...(installation.cleanupFailure === undefined
|
|
? {}
|
|
: { cleanupFailure: installation.cleanupFailure }),
|
|
};
|
|
bundleCleanupFailure = installation.cleanupFailure;
|
|
const launcherPath = appendCallerPath(
|
|
destination,
|
|
"Contents/MacOS/hopper",
|
|
"darwin",
|
|
);
|
|
let openFailure: string | undefined;
|
|
if (options.signal?.aborted === true)
|
|
openFailure = "Setup was cancelled before Hopper was opened";
|
|
else
|
|
try {
|
|
await host.openApplication(destination);
|
|
} catch (cause: unknown) {
|
|
openFailure = failureMessage(cause);
|
|
}
|
|
return {
|
|
status: "installed",
|
|
launcherPath,
|
|
...(openFailure === undefined ? {} : { openFailure }),
|
|
};
|
|
})();
|
|
} catch (cause: unknown) {
|
|
result = {
|
|
status: "failed",
|
|
reason: isHopperRequestCancellation(cause, options.signal)
|
|
? "cancelled"
|
|
: installStage,
|
|
diagnostic: failureMessage(cause),
|
|
};
|
|
}
|
|
|
|
let cleanupFailure: string | undefined;
|
|
if (temporary !== undefined) {
|
|
const temporaryPath = temporary;
|
|
const mountPath = posix.join(temporary, "mounted");
|
|
const cleanup = async (): Promise<void> => {
|
|
if (mounted) {
|
|
await host.unmount(mountPath);
|
|
mounted = false;
|
|
}
|
|
await host.cleanup(temporaryPath);
|
|
};
|
|
try {
|
|
await cleanup();
|
|
} catch (cause: unknown) {
|
|
cleanupFailure = `Hopper DMG cleanup failed: ${failureMessage(cause)}`;
|
|
host.retainCleanup?.(cleanup, [temporaryPath]);
|
|
}
|
|
}
|
|
|
|
const retainedCleanupFailure = [
|
|
bundleCleanupFailure,
|
|
cleanupFailure,
|
|
result.cleanupFailure,
|
|
]
|
|
.filter((failure): failure is string => failure !== undefined)
|
|
.join(" ");
|
|
return retainedCleanupFailure === ""
|
|
? result
|
|
: { ...result, cleanupFailure: retainedCleanupFailure };
|
|
};
|
|
|
|
/** Replace a bundle through a fresh same-volume root owned by this transaction. */
|
|
export const installMacHopperBundle = async (
|
|
source: string,
|
|
destination: string,
|
|
replaceExisting: boolean,
|
|
operations: MacHopperBundleInstallOperations,
|
|
retainCleanup: (
|
|
cleanup: () => Promise<void>,
|
|
resources: readonly string[],
|
|
) => void,
|
|
): Promise<MacHopperBundleInstallResult> => {
|
|
const stagingRoot = await operations.createStagingRoot(
|
|
posix.dirname(destination),
|
|
);
|
|
const stagedBundle = appendCallerPath(stagingRoot, "new.app", "darwin");
|
|
const previousBundle = appendCallerPath(
|
|
stagingRoot,
|
|
"previous.app",
|
|
"darwin",
|
|
);
|
|
let originalBackedUp = false;
|
|
let newCommitted = false;
|
|
let failureReason: "copy" | "launcher_missing" = "copy";
|
|
|
|
try {
|
|
await operations.copyBundle(source, stagedBundle);
|
|
failureReason = "launcher_missing";
|
|
await operations.requireLauncher(
|
|
appendCallerPath(stagedBundle, "Contents/MacOS/hopper", "darwin"),
|
|
);
|
|
failureReason = "copy";
|
|
if (replaceExisting) {
|
|
await operations.rename(destination, previousBundle);
|
|
originalBackedUp = true;
|
|
}
|
|
await operations.rename(stagedBundle, destination);
|
|
newCommitted = true;
|
|
} catch (cause: unknown) {
|
|
const diagnostics = [failureMessage(cause)];
|
|
if (originalBackedUp && !newCommitted) {
|
|
try {
|
|
if (await operations.pathExists(destination))
|
|
throw new Error(
|
|
"destination now contains another installation; preserving the previous bundle in its owned staging root",
|
|
);
|
|
await operations.rename(previousBundle, destination);
|
|
originalBackedUp = false;
|
|
} catch (rollbackCause: unknown) {
|
|
diagnostics.push(`rollback failed: ${failureMessage(rollbackCause)}`);
|
|
const cleanupFailure = `The previous Hopper bundle remains owned at ${previousBundle}; cleanup will retry restoration only if the destination is empty.`;
|
|
retainCleanup(async () => {
|
|
if (originalBackedUp) {
|
|
if (await operations.pathExists(destination))
|
|
throw new Error(
|
|
`Hopper destination is occupied; preserving owned backup ${previousBundle}`,
|
|
);
|
|
await operations.rename(previousBundle, destination);
|
|
originalBackedUp = false;
|
|
}
|
|
await operations.removeStagingRoot(stagingRoot);
|
|
}, [stagingRoot]);
|
|
return {
|
|
status: "failed",
|
|
reason: failureReason,
|
|
diagnostic: diagnostics.join("; "),
|
|
cleanupFailure,
|
|
};
|
|
}
|
|
}
|
|
try {
|
|
await operations.removeStagingRoot(stagingRoot);
|
|
} catch (cleanupCause: unknown) {
|
|
const cleanupFailure = `Hopper staging root cleanup failed: ${failureMessage(cleanupCause)}`;
|
|
retainCleanup(
|
|
() => operations.removeStagingRoot(stagingRoot),
|
|
[stagingRoot],
|
|
);
|
|
diagnostics.push(cleanupFailure);
|
|
return {
|
|
status: "failed",
|
|
reason: failureReason,
|
|
diagnostic: diagnostics.join("; "),
|
|
cleanupFailure,
|
|
};
|
|
}
|
|
return {
|
|
status: "failed",
|
|
reason: failureReason,
|
|
diagnostic: diagnostics.join("; "),
|
|
};
|
|
}
|
|
|
|
try {
|
|
await operations.removeStagingRoot(stagingRoot);
|
|
return { status: "installed" };
|
|
} catch (cause: unknown) {
|
|
const cleanupFailure = `Hopper staging root cleanup failed after installation committed: ${failureMessage(cause)}`;
|
|
retainCleanup(
|
|
() => operations.removeStagingRoot(stagingRoot),
|
|
[stagingRoot],
|
|
);
|
|
return { status: "installed", cleanupFailure };
|
|
}
|
|
};
|
|
|
|
/** Compose installer paths and subprocesses from one selected caller context. */
|
|
export const systemMacHopperInstallHost = (
|
|
homeDirectory: string,
|
|
environment: Readonly<NodeJS.ProcessEnv>,
|
|
macosVersion: () => Promise<string | undefined>,
|
|
): MacHopperInstallHost & {
|
|
close(): Promise<AnalysisCleanupObservation | undefined>;
|
|
} => {
|
|
const pendingCleanup = new Map<() => Promise<void>, readonly string[]>();
|
|
return {
|
|
download: downloadHopperPackage,
|
|
createTemporaryDirectory: () => mkdtemp(join(tmpdir(), "rea-hopper-mac-")),
|
|
createMountDirectory: (path) => mkdir(path),
|
|
writePackage: (path, bytes) => writeFile(path, bytes, { mode: 0o600 }),
|
|
async mount(packagePath, mountPath) {
|
|
await execFileAsync(
|
|
"hdiutil",
|
|
[
|
|
"attach",
|
|
"-readonly",
|
|
"-nobrowse",
|
|
"-mountpoint",
|
|
mountPath,
|
|
packagePath,
|
|
],
|
|
{ env: environment },
|
|
);
|
|
return true;
|
|
},
|
|
async unmount(mountPath) {
|
|
await execFileAsync("hdiutil", ["detach", mountPath, "-force"], {
|
|
env: environment,
|
|
});
|
|
},
|
|
async appBundle(mountPath) {
|
|
const entries = await readdir(mountPath, { withFileTypes: true });
|
|
const app = entries.find(
|
|
(entry) => entry.isDirectory() && /^Hopper.*\.app$/iu.test(entry.name),
|
|
);
|
|
return app === undefined ? undefined : posix.join(mountPath, app.name);
|
|
},
|
|
async validBundle(appPath) {
|
|
if (
|
|
!(await commandSucceeds(
|
|
"codesign",
|
|
["--verify", "--deep", "--strict", appPath],
|
|
environment,
|
|
))
|
|
)
|
|
return "invalid_signature";
|
|
if (
|
|
!(await commandSucceeds(
|
|
"codesign",
|
|
[
|
|
"--verify",
|
|
"--strict",
|
|
`-R${HOPPER_PUBLISHER_REQUIREMENT}`,
|
|
appPath,
|
|
],
|
|
environment,
|
|
))
|
|
)
|
|
return "unverified_publisher";
|
|
return "verified";
|
|
},
|
|
macosVersion,
|
|
async minimumSystemVersion(appPath) {
|
|
const plist = posix.join(appPath, "Contents", "Info.plist");
|
|
const declared = minimumSystemVersionSchema.safeParse(
|
|
decodeInfoPlistValue(await readFile(plist), ["LSMinimumSystemVersion"]),
|
|
);
|
|
if (!declared.success)
|
|
throw new TypeError(
|
|
`${plist} does not declare LSMinimumSystemVersion as text`,
|
|
);
|
|
return declared.data.LSMinimumSystemVersion;
|
|
},
|
|
async destinationExists(path) {
|
|
try {
|
|
await access(path);
|
|
return true;
|
|
} catch (cause: unknown) {
|
|
if (isMissingPath(cause)) return false;
|
|
throw cause;
|
|
}
|
|
},
|
|
installBundle: (source, destination, replaceExisting) =>
|
|
installMacHopperBundle(
|
|
source,
|
|
destination,
|
|
replaceExisting,
|
|
{
|
|
async createStagingRoot(parent) {
|
|
await mkdir(parent, { recursive: true });
|
|
return mkdtemp(
|
|
appendCallerPath(parent, ".rea-hopper-stage-", "darwin"),
|
|
);
|
|
},
|
|
copyBundle: async (bundle, staged) => {
|
|
await execFileAsync("ditto", [bundle, staged], {
|
|
env: environment,
|
|
});
|
|
},
|
|
requireLauncher: (path) => access(path).then(() => undefined),
|
|
pathExists,
|
|
rename,
|
|
removeStagingRoot: (path) => rm(path, { recursive: true }),
|
|
},
|
|
(cleanup, resources) => pendingCleanup.set(cleanup, resources),
|
|
),
|
|
async openApplication(path) {
|
|
await execFileAsync("open", [path], { env: environment });
|
|
},
|
|
cleanup: (path) => rm(path, { recursive: true, force: true }),
|
|
retainCleanup: (cleanup, resources) =>
|
|
pendingCleanup.set(cleanup, resources),
|
|
async close() {
|
|
const failures: string[] = [];
|
|
for (const cleanup of pendingCleanup.keys()) {
|
|
try {
|
|
await cleanup();
|
|
pendingCleanup.delete(cleanup);
|
|
} catch (cause: unknown) {
|
|
failures.push(failureMessage(cause));
|
|
}
|
|
}
|
|
return failures.length === 0
|
|
? undefined
|
|
: {
|
|
reason: `Hopper installer cleanup remains incomplete: ${failures.join("; ")}`,
|
|
resources: [...new Set([...pendingCleanup.values()].flat())],
|
|
};
|
|
},
|
|
destination: () => macHopperUserApplicationPath(homeDirectory),
|
|
};
|
|
};
|
|
|
|
/** Installer detail naming the declared minimum this Mac's version does not meet. */
|
|
const macHopperHostVersionDetail = (
|
|
refusal: (
|
|
| { readonly source: "release_feed"; readonly packageUrl: string }
|
|
| { readonly source: "signed_app" }
|
|
) & { readonly minimumVersion: string; readonly hostVersion: string },
|
|
): string =>
|
|
refusal.source === "release_feed"
|
|
? `The current Hopper release (${refusal.packageUrl}) declares deployment_target ${refusal.minimumVersion}; this Mac runs macOS ${refusal.hostVersion}. The package was not downloaded.`
|
|
: `The signed Hopper application declares LSMinimumSystemVersion ${refusal.minimumVersion}; this Mac runs macOS ${refusal.hostVersion}. Nothing was copied.`;
|
|
|
|
/** Installer detail for a signed-app minimum REA cannot compare with this Mac's version. */
|
|
const macHopperIncomparableMinimumDetail = (
|
|
declared: string,
|
|
hostVersion: string,
|
|
): string =>
|
|
`The signed Hopper application declares LSMinimumSystemVersion ${JSON.stringify(declared)}, which REA cannot compare with macOS ${hostVersion}. Nothing was copied.`;
|
|
|
|
const minimumSystemVersionSchema = z.looseObject({
|
|
LSMinimumSystemVersion: z.string().optional(),
|
|
});
|
|
|
|
const commandSucceeds = async (
|
|
command: string,
|
|
args: readonly string[],
|
|
environment: Readonly<NodeJS.ProcessEnv>,
|
|
): Promise<boolean> => {
|
|
try {
|
|
await execFileAsync(command, args, { env: environment });
|
|
return true;
|
|
} catch (cause: unknown) {
|
|
if (
|
|
typeof cause === "object" &&
|
|
cause !== null &&
|
|
"code" in cause &&
|
|
typeof cause.code === "number"
|
|
)
|
|
return false;
|
|
throw cause;
|
|
}
|
|
};
|
|
const failureMessage = (cause: unknown): string =>
|
|
cause instanceof Error
|
|
? [
|
|
cause.message,
|
|
"stderr" in cause && typeof cause.stderr === "string"
|
|
? cause.stderr.trim()
|
|
: "",
|
|
]
|
|
.filter((value) => value !== "")
|
|
.join(": ")
|
|
: String(cause);
|
|
const isMissingPath = (cause: unknown): boolean =>
|
|
typeof cause === "object" &&
|
|
cause !== null &&
|
|
"code" in cause &&
|
|
cause.code === "ENOENT";
|
|
const pathExists = async (path: string): Promise<boolean> => {
|
|
try {
|
|
await access(path);
|
|
return true;
|
|
} catch (cause: unknown) {
|
|
if (isMissingPath(cause)) return false;
|
|
throw cause;
|
|
}
|
|
};
|