@flisk-sh/flisk-export 0.5.0 → 0.7.0

package/README.md

@@ -47,8 +47,9 @@ flisk-export compose --check    # exit 1 when that file is out of date (for CI)
 Writes a **standalone** `docker-compose.yml` from the bring-your-own `service.json` files (`image` or `dockerfile`, `env`,
 `secrets.required`, `envFile`, `profiles`, `models`, `volumes`, `extraPorts`, `dependsOn`, `healthCheck`, `sidecarOf`, `container`). It runs without Flisk (`docker compose --env-file .env -f .autogenerated/docker-compose.yml up -d` from the project root, since Compose looks for `.env` next to the file it reads): no external
 networks, no `FLISK_*` variables, no generated secrets. `${VAR}` references in `env`, and every name in `secrets.required`, pass through as `${NAME}` for Compose to read from `.env`.
-A volume's `name` (the Docker volume an install already has) is kept, and the project is named after its stack, so `docker compose up` finds the same data as before.
-`healthCheck.command` becomes a Compose `healthcheck`; a service that lists a checked service in `dependsOn` waits for `service_healthy`, and one that lists a `restart: "no"` job waits for `service_completed_successfully`.
+A volume's `name` (the Docker volume an install already has) is kept, and the project is named after its stack (or, when `.flisk/project.json` has `composeProjectNames.<stack>` from flisk-import, the Compose project name it had before, such as `pl_mail`), so `docker compose up` finds the same data as before.
+An `image` with Compose variables (`postgres:${POSTGRES_VERSION:-18}-alpine`) is written as it is, for Compose to resolve; `restart: "on-failure:N"` keeps N. From `container`: `stopGracePeriod` becomes `stop_grace_period`, `networkAliases` become `networks: { default: { aliases } }` (not on a `sidecarOf` service, which has no network of its own), `extraHosts` become `extra_hosts` and `ulimits` stay `ulimits`. Each value is checked so it cannot add YAML keys; one that does not fit is an error.
+`healthCheck.command` becomes a Compose `healthcheck` (with `startPeriod` as `start_period`); a service that lists a checked service in `dependsOn` waits for `service_healthy` (only when that healthcheck is written: a service with only `healthCheckPath`, or `enabled: false`, is waited for with `service_started`), and one that lists a `restart: "no"` job waits for `service_completed_successfully`.
 Other resource types and `command` (native) services are not exported. The file is generated: change `service.json` and run it
 again with `--force`. It never starts a container or calls an API.
 

package/dist/compose.js

@@ -5,13 +5,25 @@
  * generated secrets. `${VAR}` references in `env` pass through for Compose to resolve from the project `.env`. These
  * functions only return text; nothing here starts a container, deploys or calls an API.
  */
-import { relative, sep } from "node:path";
+import { existsSync, readFileSync } from "node:fs";
+import { join, relative, sep } from "node:path";
 import { ExportError } from "./errors.js";
-/** extraPorts `publish`: digits, dots, colons and `${NAME:-default}`, as flisk core accepts it (flisk#2947). */
-const PUBLISH = /^(?:[0-9.:]|\$\{[A-Za-z_][A-Za-z0-9_]*:-[0-9.:]+\})+$/;
+/** extraPorts `publish`: digits, dots, colons and `${NAME:-default}` / `${NAME-default}`, as flisk core accepts it (flisk#2947). */
+const PUBLISH = /^(?:[0-9.:]|\$\{[A-Za-z_][A-Za-z0-9_]*:?-[0-9.:]+\})+$/;
+/** An image reference, with Compose variables `${NAME}`, `${NAME:-default}` and `${NAME-default}` kept for Compose to resolve. */
+const IMAGE = /^(?:[A-Za-z0-9._/:@-]|\$\{[A-Za-z_][A-Za-z0-9_]*(?::?-[A-Za-z0-9._/:@-]*)?\})+$/;
 /** The only resource type the Compose export covers: it is the one whose service.json is a Compose service. */
 export const COMPOSE_TYPE = "bring-your-own";
 const RESTART_POLICIES = new Set(["no", "on-failure", "unless-stopped", "always"]);
+/** `on-failure:N` with a retry limit from 1 to 100. */
+const RESTART_LIMIT = /^on-failure:([1-9][0-9]?|100)$/;
+/** A Compose duration such as 30s, 1m30s or 500ms. */
+const DURATION = /^(?:[0-9]+(?:\.[0-9]+)?(?:h|ms|us|m|s))+$/;
+/** A DNS name: letters, digits, '-', '_' and '.'. */
+const DNS_NAME = /^[A-Za-z0-9][A-Za-z0-9_.-]{0,252}$/;
+/** An extra_hosts address: host-gateway, IPv4, or IPv6 (optionally in brackets). */
+const HOST_ADDRESS = /^(?:host-gateway|[0-9]{1,3}(?:\.[0-9]{1,3}){3}|\[?[0-9A-Fa-f.]*:[0-9A-Fa-f.]*:[0-9A-Fa-f:.]*\]?)$/;
+const ULIMIT_NAME = /^[a-z]+$/;
 const SERVICE_NAME = /^[a-z0-9][a-z0-9_.-]*$/i;
 const ENV_NAME = /^[A-Za-z_][A-Za-z0-9_]*$/;
 const SHM_SIZE = /^\d+(b|k|kb|m|mb|g|gb)?$/i;
@@ -62,6 +74,11 @@ function serviceLines(resource, outDir, services) {
     const image = typeof c.image === "string" && c.image ? c.image : undefined;
     const dockerfile = typeof c.dockerfile === "string" && c.dockerfile ? c.dockerfile : undefined;
     const buildContext = typeof c.buildContext === "string" ? c.buildContext : undefined;
+    if (image && !IMAGE.test(image)) {
+        throw new ExportError(`${name}: image "${image}" is not an image reference`, [
+            "Use letters, digits, . _ / : @ - and Compose variables ${NAME}, ${NAME:-default} or ${NAME-default}",
+        ]);
+    }
     if (image)
         lines.push(`    image: ${q(image)}`);
     if (dockerfile || !image) {
@@ -74,7 +91,7 @@ function serviceLines(resource, outDir, services) {
     if (container.init !== false)
         lines.push("    init: true");
     if (typeof c.restart === "string") {
-        if (!RESTART_POLICIES.has(c.restart)) {
+        if (!RESTART_POLICIES.has(c.restart) && !RESTART_LIMIT.test(c.restart)) {
             throw new ExportError(`${name}: restart "${c.restart}" is not a Compose restart policy`);
         }
         lines.push(`    restart: ${q(c.restart)}`);
@@ -89,6 +106,18 @@ function serviceLines(resource, outDir, services) {
         }
         lines.push(`    network_mode: ${q(`service:${sidecarOf}`)}`);
     }
+    // Every exported service is on the default network, so its aliases go there. A sidecar has no network of its own.
+    const aliases = strings(container.networkAliases);
+    for (const alias of aliases) {
+        if (!DNS_NAME.test(alias)) {
+            throw new ExportError(`${name}: network alias "${alias}" is not a DNS name`, [
+                "Use letters, digits, '-', '_' and '.'",
+            ]);
+        }
+    }
+    if (aliases.length > 0 && !sidecarOf) {
+        lines.push("    networks:", "      default:", "        aliases:", ...aliases.map((a) => `          - ${q(a)}`));
+    }
     const env = record(c.env);
     // Secrets are listed by name only in service.json; Compose reads their values from the project .env.
     const values = new Map();
@@ -196,6 +225,41 @@ function serviceLines(resource, outDir, services) {
         }
         lines.push(`    shm_size: ${q(container.shmSize)}`);
     }
+    if (container.stopGracePeriod !== undefined) {
+        const period = container.stopGracePeriod;
+        if (typeof period !== "string" || !DURATION.test(period)) {
+            throw new ExportError(`${name}: stopGracePeriod ${JSON.stringify(period)} is not a duration such as 30s or 1m30s`);
+        }
+        lines.push(`    stop_grace_period: ${q(period)}`);
+    }
+    const extraHosts = strings(container.extraHosts);
+    for (const host of extraHosts) {
+        const at = host.indexOf(":");
+        if (at < 1 || !DNS_NAME.test(host.slice(0, at)) || !HOST_ADDRESS.test(host.slice(at + 1))) {
+            throw new ExportError(`${name}: extraHosts "${host}" is not name:address (an IP or host-gateway)`);
+        }
+    }
+    if (extraHosts.length > 0)
+        lines.push("    extra_hosts:", ...extraHosts.map((h) => `      - ${q(h)}`));
+    const ulimits = Object.entries(record(container.ulimits));
+    if (ulimits.length > 0) {
+        lines.push("    ulimits:");
+        for (const [limit, value] of ulimits) {
+            const pair = record(value);
+            if (!ULIMIT_NAME.test(limit)) {
+                throw new ExportError(`${name}: ulimit "${limit}" is not a ulimit name`);
+            }
+            if (typeof value === "number" && Number.isInteger(value)) {
+                lines.push(`      ${limit}: ${value}`);
+            }
+            else if (Number.isInteger(pair.soft) && Number.isInteger(pair.hard)) {
+                lines.push(`      ${limit}:`, `        soft: ${pair.soft}`, `        hard: ${pair.hard}`);
+            }
+            else {
+                throw new ExportError(`${name}: ulimit "${limit}" must be a whole number or { soft, hard } whole numbers`);
+            }
+        }
+    }
     const tmpfs = strings(container.tmpfs);
     if (tmpfs.length > 0) {
         for (const t of tmpfs) {
@@ -242,7 +306,10 @@ function dependencyCondition(dep) {
         return "service_completed_successfully";
     return "service_started";
 }
+/** Whether the output has a healthcheck for this value: a command, and not turned off. Only then can a dependent wait for service_healthy. */
 function hasProbeCommand(value) {
+    if (value === false || record(value).enabled === false)
+        return false;
     return strings(record(value).command).length > 0;
 }
 /** A Compose `healthcheck` from `healthCheck.command` (exit 0 is ready); `healthCheck: false` turns it off. */
@@ -255,14 +322,18 @@ function healthcheckLines(name, value) {
     if (command.length === 0)
         return [];
     const lines = ["    healthcheck:", `      test: [${['"CMD"', ...command.map(q)].join(", ")}]`];
-    for (const key of ["interval", "timeout"]) {
+    for (const [key, composeKey] of [
+        ["interval", "interval"],
+        ["timeout", "timeout"],
+        ["startPeriod", "start_period"],
+    ]) {
         if (h[key] === undefined)
             continue;
         const seconds = Number(h[key]);
         if (!Number.isFinite(seconds) || seconds <= 0) {
             throw new ExportError(`${name}: healthCheck.${key} must be a number of seconds above 0`);
         }
-        lines.push(`      ${key}: ${q(`${seconds}s`)}`);
+        lines.push(`      ${composeKey}: ${q(`${seconds}s`)}`);
     }
     if (h.retries !== undefined) {
         const retries = Number(h.retries);
@@ -289,8 +360,26 @@ function joinPosix(base, rel) {
     }
     return (base.startsWith("/") ? "/" : "") + out.join("/");
 }
+/** A Compose project name as `docker compose` accepts it. */
+const PROJECT_NAME = /^[a-z0-9][a-z0-9_-]*$/;
+/**
+ * `.flisk/project.json` `composeProjectNames`: the project name each stack had as a Compose project before the import
+ * (flisk-import records it), so the export keeps its container names (pl_mail-php-1). Empty when absent or unreadable.
+ */
+export function composeProjectNames(projectRoot) {
+    const path = join(projectRoot, ".flisk", "project.json");
+    if (!existsSync(path))
+        return {};
+    try {
+        const names = record(record(JSON.parse(readFileSync(path, "utf8"))).composeProjectNames);
+        return Object.fromEntries(Object.entries(names).filter((entry) => typeof entry[1] === "string" && PROJECT_NAME.test(entry[1])));
+    }
+    catch {
+        return {};
+    }
+}
 /** The text of a docker-compose.yml for `resources`, written for a file in `outDir`. */
-export function buildCompose(outDir, resources) {
+export function buildCompose(outDir, resources, options = {}) {
     const services = resources.filter(isComposeExportable);
     if (services.length === 0) {
         throw new ExportError("No bring-your-own resource was found to export", [
@@ -301,6 +390,10 @@ export function buildCompose(outDir, resources) {
     const stacks = new Set(services
         .map((s) => s.config.stack)
         .filter((v) => typeof v === "string" && /^[a-z0-9][a-z0-9_-]*$/.test(v)));
+    const projectName = (stack) => {
+        const recorded = options.composeProjectNames?.[stack];
+        return recorded && PROJECT_NAME.test(recorded) ? recorded : stack;
+    };
     const body = [];
     const volumes = new Map();
     const models = new Map();
@@ -329,7 +422,8 @@ export function buildCompose(outDir, resources) {
         "",
         // Without a name Compose takes the folder's (autogenerated), so containers and unnamed volumes would not match the
         // project the app had before. One stack gives the project its name.
-        ...(stacks.size === 1 ? [`name: ${q([...stacks][0])}`, ""] : []),
+        // The Compose project name the stack had before the import, when flisk-import recorded it, else the stack.
+        ...(stacks.size === 1 ? [`name: ${q(projectName([...stacks][0]))}`, ""] : []),
         "services:",
     ];
     const tail = [

package/dist/main.js

@@ -5,7 +5,7 @@
 import { existsSync, mkdirSync, readFileSync, realpathSync, writeFileSync } from "node:fs";
 import { basename, dirname, join, relative, resolve } from "node:path";
 import { Command, CommanderError } from "commander";
-import { buildCompose } from "./compose.js";
+import { buildCompose, composeProjectNames } from "./compose.js";
 import { discoverResources, findProjectRoot, findRepoRoot, findResource, } from "./discover.js";
 import { ExportError } from "./errors.js";
 import { assertExportable, buildRenderBlueprint, buildWranglerToml, EXPORTABLE_TYPES, isExportable, skippedEnvNames, } from "./generate.js";
@@ -94,7 +94,9 @@ function program(io) {
         const outDir = options.out
             ? realDir(resolve(io.cwd, options.out))
             : join(projectRoot, ".autogenerated");
-        const content = buildCompose(outDir, discover(projectRoot));
+        const content = buildCompose(outDir, discover(projectRoot), {
+            composeProjectNames: composeProjectNames(projectRoot),
+        });
         const file = join(outDir, "docker-compose.yml");
         if (options.check) {
             const shown = relative(realDir(io.cwd), file) || file;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flisk-sh/flisk-export",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Write a Render Blueprint (render.yaml), a Cloudflare wrangler.toml or a standalone docker-compose.yml from Flisk service.json files. Never deploys.",
   "type": "module",
   "license": "MIT",