@flisk-sh/flisk-export 0.7.0 → 0.9.0

package/README.md

@@ -49,7 +49,7 @@ Writes a **standalone** `docker-compose.yml` from the bring-your-own `service.js
 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 (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`.
+`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 a `dependsOn` entry written as `{ name, condition }` (flisk#2983) keeps its condition. `buildArgs` become `build.args`, `logging` stays `logging`, a bind source `${NAME:-./path}` keeps reading NAME with its default rewritten for this file, `selinux` becomes the `:z`/`:Z` mount option, and an image may use `${NAME:?message}` (Flisk 1.4.28 fields). A service with no `restart` gets none (Compose's default), as the project's own Compose file had it. 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

@@ -11,10 +11,19 @@ import { ExportError } from "./errors.js";
 /** 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._/:@-]*)?\})+$/;
+const IMAGE = /^(?:[A-Za-z0-9._/:@-]|\$\{[A-Za-z_][A-Za-z0-9_]*(?::?-[A-Za-z0-9._/:@-]+|:?\?[A-Za-z0-9 !#%&()*+,./:;<=>?@[\]^_|~-]*)?\})+$/;
+/** A bind source from the environment, `${NAME:-./path}` (flisk 1.4.28): NAME, the operator and the default path. */
+const ENV_BIND = /^\$\{([A-Za-z_][A-Za-z0-9_]*)(:?-)(\.{1,2}(?:\/[A-Za-z0-9_.-]+)*\/?)\}$/;
+const LOG_DRIVER = /^[a-z0-9][a-z0-9_.-]*$/;
+const LOG_OPTION = /^[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"]);
+const CONDITIONS = new Set([
+    "service_started",
+    "service_healthy",
+    "service_completed_successfully",
+]);
 /** `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. */
@@ -86,6 +95,16 @@ function serviceLines(resource, outDir, services) {
         lines.push("    build:", `      context: ${q(context)}`);
         if (dockerfile)
             lines.push(`      dockerfile: ${q(dockerfile)}`);
+        // buildArgs (flisk#2983): NAME to a string, which may use Compose variables such as ${NODE_VERSION:-22}.
+        const args = Object.entries(record(c.buildArgs));
+        for (const [arg, value] of args) {
+            if (!ENV_NAME.test(arg) || typeof value !== "string") {
+                throw new ExportError(`${name}: buildArgs "${arg}" needs a name of letters, digits and _ and a string`);
+            }
+        }
+        if (args.length > 0) {
+            lines.push("      args:", ...args.map(([arg, value]) => `        ${arg}: ${q(value)}`));
+        }
     }
     const container = record(c.container);
     if (container.init !== false)
@@ -96,9 +115,7 @@ function serviceLines(resource, outDir, services) {
         }
         lines.push(`    restart: ${q(c.restart)}`);
     }
-    else {
-        lines.push('    restart: "unless-stopped"');
-    }
+    // No restart in service.json is written as none: Compose's default, as the project's own Compose file had it.
     const sidecarOf = typeof c.sidecarOf === "string" ? c.sidecarOf : undefined;
     if (sidecarOf) {
         if (!known.has(sidecarOf)) {
@@ -140,7 +157,15 @@ function serviceLines(resource, outDir, services) {
                 throw new ExportError(`${name}: a volume needs a source and a target`);
             }
             let source = v.source;
-            if (isNamedVolume(source)) {
+            const fromEnv = source.match(ENV_BIND);
+            if (v.selinux !== undefined && v.selinux !== "z" && v.selinux !== "Z") {
+                throw new ExportError(`${name}: volume selinux must be z or Z`);
+            }
+            if (fromEnv) {
+                // The default is relative to the service directory; Compose reads it relative to this file.
+                source = `\${${fromEnv[1]}${fromEnv[2]}${hostPath(outDir, resolveFrom(resource.path, fromEnv[3]))}}`;
+            }
+            else if (isNamedVolume(source)) {
                 const dockerName = typeof v.name === "string" ? v.name : undefined;
                 if (dockerName !== undefined && !DOCKER_NAME.test(dockerName)) {
                     throw new ExportError(`${name}: volume name "${dockerName}" is not a Docker volume name`);
@@ -150,7 +175,11 @@ function serviceLines(resource, outDir, services) {
             else {
                 source = hostPath(outDir, resolveFrom(resource.path, source));
             }
-            lines.push(`      - ${q(`${source}:${v.target}${v.readOnly === true ? ":ro" : ""}`)}`);
+            const options = [
+                ...(v.readOnly === true ? ["ro"] : []),
+                ...(typeof v.selinux === "string" ? [v.selinux] : []),
+            ];
+            lines.push(`      - ${q(`${source}:${v.target}${options.length ? `:${options.join(",")}` : ""}`)}`);
         }
     }
     const ports = Array.isArray(c.extraPorts) ? c.extraPorts : [];
@@ -182,11 +211,26 @@ function serviceLines(resource, outDir, services) {
             lines.push(`      - ${q(`${bind}:${hostPort}:${port}/${protocol}`)}`);
         }
     }
-    const dependsOn = strings(c.dependsOn).filter((d) => known.has(d));
+    // dependsOn entries are names or { name, condition } (flisk#2983); a stated condition wins over the guess.
+    const dependsOn = (Array.isArray(c.dependsOn) ? c.dependsOn : [])
+        .map((entry) => typeof entry === "string"
+        ? { name: entry, condition: undefined }
+        : { name: record(entry).name, condition: record(entry).condition })
+        .filter((d) => typeof d.name === "string" && known.has(d.name));
     if (dependsOn.length > 0) {
         lines.push("    depends_on:");
         for (const d of dependsOn) {
-            lines.push(`      ${d}:`, `        condition: ${dependencyCondition(known.get(d))}`);
+            const dep = known.get(d.name);
+            if (d.condition !== undefined && !CONDITIONS.has(d.condition)) {
+                throw new ExportError(`${name}: dependsOn "${d.name}" condition is not a Compose condition`, ["Use service_started, service_healthy or service_completed_successfully"]);
+            }
+            // service_healthy needs a healthcheck in this file; without one Compose would refuse to start.
+            const condition = d.condition === undefined
+                ? dependencyCondition(dep)
+                : d.condition === "service_healthy" && !hasProbeCommand(dep.config.healthCheck)
+                    ? "service_started"
+                    : d.condition;
+            lines.push(`      ${d.name}:`, `        condition: ${condition}`);
         }
     }
     lines.push(...healthcheckLines(name, c.healthCheck));
@@ -288,6 +332,26 @@ function serviceLines(resource, outDir, services) {
             lines.push(`      - path: ${q(hostPath(outDir, resolveFrom(resource.path, file)))}`, "        required: false");
         }
     }
+    // logging (flisk 1.4.28): a driver and string options, checked so nothing can add a key.
+    if (c.logging !== undefined) {
+        const logging = record(c.logging);
+        const options = Object.entries(record(logging.options));
+        if (logging.driver !== undefined &&
+            (typeof logging.driver !== "string" || !LOG_DRIVER.test(logging.driver))) {
+            throw new ExportError(`${name}: logging.driver "${String(logging.driver)}" is not a logging driver`);
+        }
+        for (const [key, value] of options) {
+            if (!LOG_OPTION.test(key) || typeof value !== "string") {
+                throw new ExportError(`${name}: logging option "${key}" needs a name of letters, digits, _ . - and a string`);
+            }
+        }
+        lines.push("    logging:", ...(typeof logging.driver === "string" ? [`      driver: ${q(logging.driver)}`] : []), ...(options.length
+            ? [
+                "      options:",
+                ...options.map(([key, value]) => `        ${key}: ${q(value)}`),
+            ]
+            : []));
+    }
     const profiles = strings(c.profiles);
     if (profiles.length > 0) {
         for (const p of profiles) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flisk-sh/flisk-export",
-  "version": "0.7.0",
+  "version": "0.9.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",