@flisk-sh/flisk-export 0.3.0 → 0.4.1

package/README.md

@@ -47,6 +47,7 @@ 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`, `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`.
+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`.
 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

@@ -7,12 +7,15 @@
  */
 import { 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.:]+\})+$/;
 /** 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 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;
+const DOCKER_NAME = /^[A-Za-z0-9][A-Za-z0-9_.-]*$/;
 export function isComposeExportable(resource) {
     return resource.type === COMPOSE_TYPE && typeof resource.config.command !== "string";
 }
@@ -50,7 +53,7 @@ function serviceLines(resource, outDir, services) {
         ]);
     }
     const lines = [`  ${name}:`];
-    const namedVolumes = new Set();
+    const namedVolumes = new Map();
     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;
@@ -105,7 +108,11 @@ function serviceLines(resource, outDir, services) {
             }
             let source = v.source;
             if (isNamedVolume(source)) {
-                namedVolumes.add(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`);
+                }
+                namedVolumes.set(source, dockerName ?? namedVolumes.get(source));
             }
             else {
                 source = hostPath(outDir, resolveFrom(resource.path, source));
@@ -125,9 +132,20 @@ function serviceLines(resource, outDir, services) {
             if (!Number.isInteger(port) || port < 1 || port > 65535) {
                 throw new ExportError(`${name}: extraPorts needs a port from 1 to 65535`);
             }
-            const hostPort = p.hostPort === undefined ? port : Number(p.hostPort);
-            const bind = typeof p.bind === "string" && p.bind ? p.bind : "127.0.0.1";
             const protocol = p.protocol === "udp" ? "udp" : "tcp";
+            // `publish` (flisk#2947): the host side as the project's Compose wrote it, e.g. "${APP_HTTP_BIND:-80}"; Compose resolves it.
+            if (p.publish !== undefined) {
+                if (typeof p.publish !== "string" || !PUBLISH.test(p.publish)) {
+                    throw new ExportError(`${name}: extraPorts publish must be a port, an IPv4 address:port, or \${NAME:-default}`);
+                }
+                lines.push(`      - ${q(`${p.publish}:${port}/${protocol}`)}`);
+                continue;
+            }
+            const hostPort = p.hostPort === undefined ? port : Number(p.hostPort);
+            const bind = p.bind === undefined ? "127.0.0.1" : p.bind;
+            if (bind !== "127.0.0.1" && bind !== "0.0.0.0") {
+                throw new ExportError(`${name}: extraPorts bind must be 127.0.0.1 or 0.0.0.0`);
+            }
             lines.push(`      - ${q(`${bind}:${hostPort}:${port}/${protocol}`)}`);
         }
     }
@@ -240,14 +258,22 @@ export function buildCompose(outDir, resources) {
         ]);
     }
     const known = new Map(services.map((s) => [s.name, s]));
+    const stacks = new Set(services
+        .map((s) => s.config.stack)
+        .filter((v) => typeof v === "string" && /^[a-z0-9][a-z0-9_-]*$/.test(v)));
     const body = [];
-    const volumes = new Set();
+    const volumes = new Map();
     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 [v, dockerName] of built.namedVolumes) {
+            const known = volumes.get(v);
+            if (known && dockerName && known !== dockerName) {
+                throw new ExportError(`volume "${v}" is given two names, "${known}" and "${dockerName}"`);
+            }
+            volumes.set(v, dockerName ?? known);
+        }
         for (const [n, m] of built.models)
             models.set(n, m);
     }
@@ -259,6 +285,9 @@ export function buildCompose(outDir, resources) {
         "# Runs with plain `docker compose up`; Flisk is not needed to start it.",
         "###############################################################################",
         "",
+        // 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])}`, ""] : []),
         "services:",
     ];
     const tail = [
@@ -269,7 +298,16 @@ export function buildCompose(outDir, resources) {
                 "",
             ]
             : []),
-        ...(volumes.size > 0 ? ["volumes:", ...[...volumes].sort().map((v) => `  ${v}:`), ""] : []),
+        // A volume with a name keeps the Docker volume an existing install has, so its data is used as it is.
+        ...(volumes.size > 0
+            ? [
+                "volumes:",
+                ...[...volumes]
+                    .sort(([a], [b]) => a.localeCompare(b))
+                    .flatMap(([v, dockerName]) => dockerName ? [`  ${v}:`, `    name: ${q(dockerName)}`] : [`  ${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.3.0",
+  "version": "0.4.1",
   "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",