@gtkx/cli 2.0.0-beta.1 → 2.0.0-beta.2

package/src/deploy/run-deploy.ts

@@ -1,4 +1,4 @@
-import { loadConfig } from "@gtkx/config";
+import { type Config, loadConfig } from "@gtkx/config";
 import { info, warn } from "@gtkx/utils";
 import { existsSync, mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
 import { dirname, join, relative } from "node:path";
@@ -22,6 +22,7 @@ import {
     synchronizeCatalogs,
 } from "../i18n/catalogs.js";
 import { extractSourceCatalogTo } from "../i18n/source-messages.js";
+import { prepareBuildOutDir, resolveBuildOutDir } from "../internal/build-output.js";
 import { discoverSourceFiles } from "../internal/source-imports.js";
 import { renderDesktopEntry } from "./freedesktop/desktop-entry.js";
 import { extractMetadataMessages, localizeMetadata } from "./freedesktop/localize.js";
@@ -35,6 +36,7 @@ import { DEFAULT_TARGETS, parseTargetList, targetsFor } from "./registry.js";
 import { readBuildManifest } from "./settings/build-manifest.js";
 import { resolveDeploySettings } from "./settings/index.js";
 import { readPackageManifest } from "./settings/package-manifest.js";
+import { prepareDeployOutDir } from "./settings/paths.js";
 import { missingDeployError } from "./settings/starter.js";
 import { finishArgsFor, hasDisplaySocket, runtimeLabelFor } from "./targets/flatpak-manifest.js";
 import { detectPackageManager } from "./targets/flatpak-sources.js";
@@ -58,6 +60,7 @@ import {
 type DeployOptions = {
     entry: string;
     cwd: string;
+    configFile?: string | undefined;
     targets?: string | undefined;
     outDir?: string | undefined;
     shouldPrintManifests: boolean;
@@ -72,6 +75,20 @@ type PreflightRequest = {
     shouldSkipBuild: boolean;
 };
 
+type LoadedDeploySettings = {
+    config: Config;
+    configFile: string;
+    settings: DeploySettings;
+};
+
+type BuildPayloadRequest = {
+    options: DeployOptions;
+    loaded: LoadedDeploySettings;
+    targets: DeployTarget[];
+    project: CatalogProject | null;
+    buildOutDir: string | null;
+};
+
 const BUILD_MODE = "production";
 const BYTES_PER_MIB = 1024 * 1024;
 const WEBKIT_LIBRARY = "WebKit-6.0";
@@ -282,14 +299,26 @@ const resolveTargetNames = (options: DeployOptions, settings: DeploySettings): s
     return settings.deploy.targets ?? DEFAULT_TARGETS;
 };
 
-const loadSettings = async (options: DeployOptions): Promise<DeploySettings> => {
-    const { config, root } = await loadConfig(options.cwd, { mode: BUILD_MODE });
+const loadSettings = async (options: DeployOptions): Promise<LoadedDeploySettings> => {
+    const { config, configFile, root } = await loadConfig(options.cwd, {
+        mode: BUILD_MODE,
+        configFile: options.configFile,
+    });
 
     if (config.deploy === undefined) {
         throw missingDeployError(config.applicationId, readPackageManifest(root));
     }
 
-    return resolveDeploySettings({ root, config, outDirOverride: options.outDir });
+    return {
+        config,
+        configFile,
+        settings: resolveDeploySettings({
+            root,
+            config,
+            configFile,
+            outDirOverride: options.outDir,
+        }),
+    };
 };
 
 const synchronizeMetadataCatalogs = async (
@@ -318,22 +347,27 @@ const synchronizeMetadataCatalogs = async (
     }
 };
 
-const buildPayload = async (
-    options: DeployOptions,
-    settings: DeploySettings,
-    targets: DeployTarget[],
-    project: CatalogProject | null,
-): Promise<DeployPayload> => {
+const buildPayload = async ({
+    options,
+    loaded,
+    targets,
+    project,
+    buildOutDir,
+}: BuildPayloadRequest): Promise<DeployPayload> => {
+    const settings = loaded.settings;
     const templates = renderMetadata(settings);
 
-    if (!options.shouldSkipBuild) {
+    if (buildOutDir !== null) {
         info(`Building ${options.entry}`);
+        using preparedOutput = prepareBuildOutDir(settings.paths.root, buildOutDir);
 
         await buildApp({
             entry: options.entry,
-            vite: { root: options.cwd },
+            configFile: options.configFile,
+            vite: { root: options.cwd, build: { outDir: preparedOutput.path, emptyOutDir: false } },
         });
 
+        preparedOutput.commit();
         await synchronizeMetadataCatalogs(settings, templates, project);
     } else if (project !== null) {
         compileCatalogs(project, join(settings.paths.dist, LOCALE_DIRNAME));
@@ -341,7 +375,7 @@ const buildPayload = async (
 
     const metadata = localizeMetadata(templates, project);
     validateMetadata(settings, metadata, isFlathubSubmission(settings, targets));
-    const buildManifest = readBuildManifest(settings);
+    const buildManifest = readBuildManifest(settings, loaded);
 
     const builtSettings: DeploySettings = {
         ...settings,
@@ -411,9 +445,11 @@ const announce = (settings: DeploySettings, targets: DeployTarget[]): void => {
 };
 
 const runDeploy = async (options: DeployOptions): Promise<void> => {
-    let settings = await loadSettings(options);
+    let loaded = await loadSettings(options);
+    let settings = loaded.settings;
     let project = resolveCatalogProject(settings.paths.root, settings.applicationId);
     let targets = targetsFor(resolveTargetNames(options, settings));
+    let buildOutDir = options.shouldSkipBuild ? null : resolveBuildOutDir(settings.paths.root, settings.paths.dist);
     announce(settings, targets);
 
     preflight({
@@ -428,14 +464,18 @@ const runDeploy = async (options: DeployOptions): Promise<void> => {
         await ensureGenerated(options.cwd, {
             shouldAnnounce: true,
             mode: BUILD_MODE,
+            configFile: options.configFile,
         });
 
-        settings = await loadSettings(options);
+        loaded = await loadSettings(options);
+        settings = loaded.settings;
         project = resolveCatalogProject(settings.paths.root, settings.applicationId);
         targets = targetsFor(resolveTargetNames(options, settings));
+        buildOutDir = resolveBuildOutDir(settings.paths.root, settings.paths.dist);
     }
 
-    const payload = await buildPayload(options, settings, targets, project);
+    prepareDeployOutDir(settings.paths.root, settings.paths.outDir);
+    const payload = await buildPayload({ options, loaded, targets, project, buildOutDir });
     const rendered = renderTargetManifests(targets, payload);
 
     if (options.shouldPrintManifests) {

package/src/deploy/settings/build-manifest.ts

@@ -1,12 +1,14 @@
-import { isPathInside, isRecord, sortStrings } from "@gtkx/utils";
+import type { Config } from "@gtkx/config";
+import { isPathInside, isRecord, sortStrings, toPosixPath } from "@gtkx/utils";
 import { existsSync, readFileSync, statSync } from "node:fs";
-import { isAbsolute, join, resolve } from "node:path";
+import { isAbsolute, join, relative, resolve } from "node:path";
 import type { DeploySettings } from "../types.js";
 import {
     BUILD_MANIFEST_FILENAME,
     BUILD_MANIFEST_FORMAT_VERSION,
     BUILD_MANIFEST_GENERATOR,
     type BuildManifest,
+    configDigest,
     type RecordedPackage,
 } from "../../internal/build-manifest.js";
 import {
@@ -20,6 +22,11 @@ type ResolvedBuildManifest = {
     schemaFiles: string[];
 };
 
+type ExpectedBuildConfig = {
+    config: Config;
+    configFile: string;
+};
+
 const invalidManifest = (path: string): Error =>
     new Error(`Cannot deploy: ${path} is not a valid GTKX build manifest. Run \`gtkx build\` again.`);
 
@@ -51,6 +58,8 @@ const parseBuildManifest = (value: unknown, path: string): BuildManifest => {
         !isRecord(value) ||
         value.generator !== BUILD_MANIFEST_GENERATOR ||
         value.formatVersion !== BUILD_MANIFEST_FORMAT_VERSION ||
+        typeof value.configFile !== "string" ||
+        typeof value.configDigest !== "string" ||
         !Array.isArray(value.schemas) ||
         !Array.isArray(value.packages)
     ) {
@@ -62,6 +71,8 @@ const parseBuildManifest = (value: unknown, path: string): BuildManifest => {
     return {
         generator: BUILD_MANIFEST_GENERATOR,
         formatVersion: BUILD_MANIFEST_FORMAT_VERSION,
+        configFile: value.configFile,
+        configDigest: value.configDigest,
         schemas: recordedSchemas(value.schemas, path),
         packages: packages.map((entry) => recordedPackage(entry, path)),
     };
@@ -91,7 +102,20 @@ const resolveRecordedSchema = (root: string, manifestPath: string, entry: string
     return filePath;
 };
 
-const readBuildManifest = (settings: DeploySettings): ResolvedBuildManifest => {
+const assertBuildConfig = (
+    settings: DeploySettings,
+    manifestPath: string,
+    manifest: BuildManifest,
+    expected: ExpectedBuildConfig,
+): void => {
+    const expectedFile = toPosixPath(relative(settings.paths.root, expected.configFile));
+
+    if (manifest.configFile !== expectedFile || manifest.configDigest !== configDigest(expected.config)) {
+        throw new Error(`Cannot deploy: ${manifestPath} was built from a different GTKX configuration.`);
+    }
+};
+
+const readBuildManifest = (settings: DeploySettings, expected: ExpectedBuildConfig): ResolvedBuildManifest => {
     const manifestPath = join(settings.paths.dist, BUILD_MANIFEST_FILENAME);
 
     if (!existsSync(manifestPath)) {
@@ -100,6 +124,7 @@ const readBuildManifest = (settings: DeploySettings): ResolvedBuildManifest => {
 
     const parsed: unknown = JSON.parse(readFileSync(manifestPath, "utf8"));
     const manifest = parseBuildManifest(parsed, manifestPath);
+    assertBuildConfig(settings, manifestPath, manifest, expected);
     const files = manifest.schemas.map((entry) => resolveRecordedSchema(settings.paths.root, manifestPath, entry));
     const unique = sortStrings(new Set(files));
     assertUniqueSchemaBasenames(unique);

package/src/deploy/settings/extra-files.ts

@@ -1,3 +1,5 @@
+import { statSync } from "node:fs";
+import { resolve } from "node:path";
 import type { DeployConfig, DeployExtraFile } from "../types.js";
 
 type ExtraFiles = NonNullable<DeployConfig["extraFiles"]>;
@@ -5,6 +7,20 @@ type ExtraFileEntry = NonNullable<ExtraFiles[string]>;
 
 const OCTAL_RADIX = 8;
 
+const assertSourceFile = (root: string, file: DeployExtraFile): void => {
+    const source = resolve(root, file.source);
+
+    try {
+        if (statSync(source).isFile()) {
+            return;
+        }
+    } catch {
+        throw new Error(`Cannot install "${file.destination}": its source file "${file.source}" does not exist`);
+    }
+
+    throw new Error(`Cannot install "${file.destination}": its source "${file.source}" is not a file`);
+};
+
 const resolveExtraFile = (destination: string, entry: ExtraFileEntry): DeployExtraFile => {
     if (typeof entry === "string") {
         return { destination, source: entry, mode: null };
@@ -15,7 +31,15 @@ const resolveExtraFile = (destination: string, entry: ExtraFileEntry): DeployExt
     return { destination, source: entry.source, mode };
 };
 
-const resolveExtraFiles = (deploy: DeployConfig): DeployExtraFile[] =>
-    Object.entries(deploy.extraFiles ?? {}).map(([destination, entry]) => resolveExtraFile(destination, entry));
+const resolveExtraFiles = (root: string, deploy: DeployConfig): DeployExtraFile[] => {
+    const files = Object.entries(deploy.extraFiles ?? {})
+        .map(([destination, entry]) => resolveExtraFile(destination, entry));
+
+    for (const file of files) {
+        assertSourceFile(root, file);
+    }
+
+    return files;
+};
 
 export { resolveExtraFiles };

package/src/deploy/settings/index.ts

@@ -31,6 +31,7 @@ import { resolveVersions } from "./version.js";
 type SettingsRequest = {
     root: string;
     config: Config;
+    configFile: string;
     outDirOverride?: string | undefined;
     now?: Date | undefined;
 };
@@ -174,10 +175,11 @@ const resolveDeploySettings = (request: SettingsRequest): DeploySettings => {
     const deploy = core.identity.deploy;
 
     return {
+        configFile: request.configFile,
         ...identitySlice(core),
         ...metadataSlice(request.root, core),
         ...desktopSlice(deploy),
-        extraFiles: resolveExtraFiles(deploy),
+        extraFiles: resolveExtraFiles(request.root, deploy),
         versions: core.versions,
         arch: resolveArch(),
         paths: resolvePaths({

package/src/deploy/settings/paths.ts

@@ -1,9 +1,10 @@
 import type { Config } from "@gtkx/config";
 import { isPathInside } from "@gtkx/utils";
-import { statSync } from "node:fs";
-import { join, resolve } from "node:path";
+import { lstatSync, readdirSync, statSync, writeFileSync } from "node:fs";
+import { join, relative, resolve, sep } from "node:path";
 import type { DeployConfig, DeployPaths } from "../types.js";
 import { resolveApplicationIcon } from "../../internal/icon-path.js";
+import { prepareOutputDirectory, readRegularFile } from "../../internal/output-directory.js";
 
 type PathsRequest = {
     root: string;
@@ -15,19 +16,83 @@ type PathsRequest = {
 
 const DEFAULT_OUT_DIR = "build";
 const DIST_DIR = "dist";
+const DEPLOY_MARKER_FILENAME = ".gtkx-deploy.json";
+const DEPLOY_MARKER = `${JSON.stringify({ generator: "gtkx-deploy", formatVersion: 1 })}\n`;
 const LICENSE_CANDIDATES = ["LICENSE", "LICENSE.md", "LICENSE.txt", "COPYING", "COPYING.md"];
 
+const hasSymlinkComponent = (root: string, target: string): boolean => {
+    let current = root;
+
+    for (const segment of relative(root, target).split(sep)) {
+        current = join(current, segment);
+
+        if (lstatSync(current, { throwIfNoEntry: false })?.isSymbolicLink() === true) {
+            return true;
+        }
+    }
+
+    return false;
+};
+
+const isDeployMarker = (path: string): boolean => {
+    return readRegularFile(path) === DEPLOY_MARKER;
+};
+
+const isReusableDeployDirectory = (path: string): boolean => {
+    const entry = lstatSync(path, { throwIfNoEntry: false });
+
+    if (entry === undefined) {
+        return true;
+    }
+
+    return entry.isDirectory() &&
+        (readdirSync(path).length === 0 || isDeployMarker(join(path, DEPLOY_MARKER_FILENAME)));
+};
+
+const deployOutputError = (root: string, configured: string): Error =>
+    new Error(
+        `Cannot use "${configured}" as the deploy output directory: choose an empty directory or an ` +
+        `earlier GTKX deploy directory below ${root}`,
+    );
+
+const assertSafeDeployOutDir = (root: string, outDir: string, configured: string): void => {
+    const dist = join(root, DIST_DIR);
+
+    if (
+        outDir === dist ||
+        !isPathInside(root, outDir) ||
+        isPathInside(dist, outDir) ||
+        hasSymlinkComponent(root, outDir)
+    ) {
+        throw deployOutputError(root, configured);
+    }
+};
+
 const resolveOutDir = ({ root, deploy, outDirOverride }: PathsRequest): string => {
     const configured = outDirOverride ?? deploy.outDir ?? DEFAULT_OUT_DIR;
     const outDir = resolve(root, configured);
+    assertSafeDeployOutDir(root, outDir, configured);
 
-    if (!isPathInside(root, outDir)) {
-        throw new Error(`Cannot use "${configured}" as the deploy output directory: it is outside ${root}`);
+    if (!isReusableDeployDirectory(outDir)) {
+        throw deployOutputError(root, configured);
     }
 
     return outDir;
 };
 
+const prepareDeployOutDir = (root: string, outDir: string): void => {
+    assertSafeDeployOutDir(root, outDir, outDir);
+    const prepared = prepareOutputDirectory(root, outDir, isReusableDeployDirectory);
+
+    if (prepared.status === "unsafe") {
+        throw deployOutputError(root, outDir);
+    }
+
+    using transaction = prepared.transaction;
+    transaction.commit();
+    writeFileSync(join(outDir, DEPLOY_MARKER_FILENAME), DEPLOY_MARKER, { flag: "wx" });
+};
+
 const existingFile = (path: string): string | null =>
     statSync(path, { throwIfNoEntry: false })?.isFile() === true ? path : null;
 
@@ -65,4 +130,4 @@ const resolvePaths = (request: PathsRequest): DeployPaths => {
     };
 };
 
-export { resolvePaths };
+export { prepareDeployOutDir, resolvePaths };

package/src/deploy/targets/flatpak-source.ts

@@ -244,6 +244,17 @@ const appendPathFor = (settings: DeploySettings, pin: PnpmPin | null, nodeExtens
         ? `${nodeExtensionPath}/bin`
         : `${pnpmPathFor(moduleDirFor(settings))}:${nodeExtensionPath}/bin`;
 
+const sourceBuildCommand = (settings: DeploySettings): string => {
+    const configFile = projectRelative(settings, settings.configFile);
+    assertInsideProject(settings, {
+        destination: "the Flatpak build configuration",
+        source: configFile,
+        resolved: settings.configFile,
+    });
+
+    return `npx gtkx build --config ${pathArgument(configFile)}`;
+};
+
 const flatpakSourceModule = (payload: DeployPayload): FlatpakModule => {
     const settings = payload.settings;
     const manager = detectPackageManager(settings);
@@ -271,14 +282,14 @@ const flatpakSourceModule = (payload: DeployPayload): FlatpakModule => {
         ],
         "build-commands": [
             installCommandFor(settings, manager),
-            "npx gtkx build",
+            sourceBuildCommand(settings),
             ...runtimeInstallCommands(settings, nodeExtensionPath),
+            ...extraFileInstallCommands(settings),
             ...metadataInstallCommands(settings),
             ...schemaInstallCommands(settings),
             ...iconInstallCommands(settings),
             ...licenseInstallCommands(settings),
             ...noticesInstallCommands(settings),
-            ...extraFileInstallCommands(settings),
             ...(settings.deploy.flatpak?.buildCommands ?? []),
             ...validationCommands(settings),
         ],

package/src/deploy/types.ts

@@ -114,6 +114,7 @@ type DeployPaths = {
 
 type DeploySettings = {
     applicationId: string;
+    configFile: string;
     binaryName: string;
     name: string;
     genericName: string | null;

package/src/dev/headless.ts

@@ -0,0 +1,40 @@
+import { MCP_SOCKET_PATH_ENV, resolveMcpSocketPath } from "@gtkx/mcp/internal";
+import { resolveHeadlessOptions, startHeadlessDisplay } from "@gtkx/vitest/headless";
+
+const restoreEnvironment = (name: string, value: string | undefined): void => {
+    if (value === undefined) {
+        Reflect.deleteProperty(process.env, name);
+    } else {
+        process.env[name] = value;
+    }
+};
+
+const startHeadlessDevDisplay = async (size?: string): Promise<() => void> => {
+    const previousSocketPath = process.env[MCP_SOCKET_PATH_ENV];
+    process.env[MCP_SOCKET_PATH_ENV] = resolveMcpSocketPath();
+
+    try {
+        const stopDisplay = await startHeadlessDisplay(resolveHeadlessOptions({ ...(size !== undefined && { size }) }));
+        let isStopped = false;
+
+        const stop = (): void => {
+            if (isStopped) {
+                return;
+            }
+
+            isStopped = true;
+            process.removeListener("exit", stop);
+            stopDisplay();
+            restoreEnvironment(MCP_SOCKET_PATH_ENV, previousSocketPath);
+        };
+
+        process.once("exit", stop);
+
+        return stop;
+    } catch (error) {
+        restoreEnvironment(MCP_SOCKET_PATH_ENV, previousSocketPath);
+        throw error;
+    }
+};
+
+export { startHeadlessDevDisplay };

package/src/dev/runner-deps.ts

@@ -87,7 +87,7 @@ const defaultDevRunnerDeps = (): DevRunnerDeps => ({
     staleExportName,
     readFileRevision,
     plugins: (entryPath) => [
-        ...gtkxVitePlugins(DEV_MODE, entryPath),
+        ...gtkxVitePlugins({ mode: DEV_MODE, entryPath }),
         ...gtkxFastRefresh(),
         gtkxReactDomPrebundle(),
     ],