@flisk-sh/flisk-export 0.2.0 → 0.3.0

package/README.md

@@ -45,8 +45,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`,
-`volumes`, `extraPorts`, `dependsOn`, `sidecarOf`, `container`). It runs with plain `docker compose up` and no Flisk: no external
-networks, no `FLISK_*` variables, no generated secrets. `${VAR}` references in `env` pass through for Compose to read from `.env`.
+`secrets.required`, `models`, `volumes`, `extraPorts`, `dependsOn`, `healthCheck`, `sidecarOf`, `container`). It runs with plain `docker compose up` and no Flisk: 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`.
+`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`.
 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

@@ -40,7 +40,8 @@ function hostPath(outDir, absolute) {
 function isNamedVolume(source) {
     return !/[\\/]/.test(source) && !source.startsWith(".") && !source.startsWith("~");
 }
-function serviceLines(resource, outDir, known) {
+function serviceLines(resource, outDir, services) {
+    const known = services;
     const c = resource.config;
     const name = resource.name;
     if (!SERVICE_NAME.test(name)) {
@@ -50,6 +51,7 @@ function serviceLines(resource, outDir, known) {
     }
     const lines = [`  ${name}:`];
     const namedVolumes = new Set();
+    const models = new Map();
     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;
@@ -81,13 +83,17 @@ function serviceLines(resource, outDir, known) {
         lines.push(`    network_mode: ${q(`service:${sidecarOf}`)}`);
     }
     const env = record(c.env);
-    const envNames = Object.keys(env)
-        .filter((k) => ENV_NAME.test(k))
-        .sort();
+    // Secrets are listed by name only in service.json; Compose reads their values from the project .env.
+    const values = new Map();
+    for (const key of strings(record(c.secrets).required))
+        values.set(key, `\${${key}}`);
+    for (const [key, value] of Object.entries(env))
+        values.set(key, String(value));
+    const envNames = [...values.keys()].filter((k) => ENV_NAME.test(k)).sort();
     if (envNames.length > 0) {
         lines.push("    environment:");
         for (const key of envNames)
-            lines.push(`      ${key}: ${q(String(env[key]))}`);
+            lines.push(`      ${key}: ${q(values.get(key) ?? "")}`);
     }
     const volumes = Array.isArray(c.volumes) ? c.volumes : [];
     if (volumes.length > 0) {
@@ -127,7 +133,26 @@ function serviceLines(resource, outDir, known) {
     }
     const dependsOn = strings(c.dependsOn).filter((d) => known.has(d));
     if (dependsOn.length > 0) {
-        lines.push("    depends_on:", ...dependsOn.map((d) => `      - ${q(d)}`));
+        lines.push("    depends_on:");
+        for (const d of dependsOn) {
+            lines.push(`      ${d}:`, `        condition: ${dependencyCondition(known.get(d))}`);
+        }
+    }
+    lines.push(...healthcheckLines(name, c.healthCheck));
+    // Docker Model Runner: the service lists model names, the top-level `models` block says which model each is.
+    const modelRefs = (Array.isArray(c.models) ? c.models : []).map(record);
+    if (modelRefs.length > 0) {
+        lines.push("    models:");
+        for (const ref of modelRefs) {
+            if (typeof ref.name !== "string" || !ENV_NAME.test(ref.name.replace(/[-.]/g, "_"))) {
+                throw new ExportError(`${name}: a model needs a name of letters, digits, dashes and dots`);
+            }
+            if (typeof ref.model !== "string" || !ref.model) {
+                throw new ExportError(`${name}: model "${ref.name}" needs a model reference`);
+            }
+            lines.push(`      - ${q(ref.name)}`);
+            models.set(ref.name, ref.model);
+        }
     }
     const capAdd = strings(container.capAdd);
     const capDrop = strings(container.capDrop);
@@ -149,7 +174,46 @@ function serviceLines(resource, outDir, known) {
         }
         lines.push(`    shm_size: ${q(container.shmSize)}`);
     }
-    return { lines, namedVolumes };
+    return { lines, namedVolumes, models };
+}
+/** What Compose waits for before starting a dependent: a passing check, a finished one-shot job, or the start. */
+function dependencyCondition(dep) {
+    if (hasProbeCommand(dep.config.healthCheck))
+        return "service_healthy";
+    if (dep.config.restart === "no")
+        return "service_completed_successfully";
+    return "service_started";
+}
+function hasProbeCommand(value) {
+    return strings(record(value).command).length > 0;
+}
+/** A Compose `healthcheck` from `healthCheck.command` (exit 0 is ready); `healthCheck: false` turns it off. */
+function healthcheckLines(name, value) {
+    if (value === false || record(value).enabled === false) {
+        return ["    healthcheck:", "      disable: true"];
+    }
+    const h = record(value);
+    const command = strings(h.command);
+    if (command.length === 0)
+        return [];
+    const lines = ["    healthcheck:", `      test: [${['"CMD"', ...command.map(q)].join(", ")}]`];
+    for (const key of ["interval", "timeout"]) {
+        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`)}`);
+    }
+    if (h.retries !== undefined) {
+        const retries = Number(h.retries);
+        if (!Number.isInteger(retries) || retries < 1) {
+            throw new ExportError(`${name}: healthCheck.retries must be a whole number above 0`);
+        }
+        lines.push(`      retries: ${retries}`);
+    }
+    return lines;
 }
 function resolveFrom(base, rel) {
     return rel.startsWith("/") ? rel : joinPosix(base, rel);
@@ -175,14 +239,17 @@ export function buildCompose(outDir, resources) {
             `Exported type: ${COMPOSE_TYPE} (a service.json with an image or a Dockerfile, and no command)`,
         ]);
     }
-    const known = new Set(services.map((s) => s.name));
+    const known = new Map(services.map((s) => [s.name, s]));
     const body = [];
     const volumes = new Set();
+    const models = new Map();
     for (const service of services) {
         const built = serviceLines(service, outDir, known);
         body.push(...built.lines, "");
         for (const v of built.namedVolumes)
             volumes.add(v);
+        for (const [n, m] of built.models)
+            models.set(n, m);
     }
     const header = [
         "###############################################################################",
@@ -194,6 +261,15 @@ export function buildCompose(outDir, resources) {
         "",
         "services:",
     ];
-    const tail = volumes.size > 0 ? ["volumes:", ...[...volumes].sort().map((v) => `  ${v}:`), ""] : [];
+    const tail = [
+        ...(models.size > 0
+            ? [
+                "models:",
+                ...[...models].sort().flatMap(([n, m]) => [`  ${n}:`, `    model: ${q(m)}`]),
+                "",
+            ]
+            : []),
+        ...(volumes.size > 0 ? ["volumes:", ...[...volumes].sort().map((v) => `  ${v}:`), ""] : []),
+    ];
     return [...header, ...body, ...tail].join("\n").replace(/\n{3,}/g, "\n\n");
 }

package/package.json

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