@flisk-sh/flisk-import 0.9.0 → 0.11.0

package/README.md

@@ -12,12 +12,13 @@ flisk import . --yes         # write service.json files and project setup
 
 - **Reads one file:** the root `docker-compose.yml`, or `compose.yaml`, `compose.yml` or `docker-compose.yaml` when that is absent. Not override files, nested Compose files, Dockerfiles on their own, `package.json`, or Procfiles.
 - **Writes:** one bring-your-own `service.json` per Compose service, plus `.flisk/project.json` if the repo is not a Flisk project yet. It never edits the Compose file or overwrites a `service.json` without `--force`.
+- **Keeps the install's data:** each named volume gets `name`, the Docker volume `docker compose up` created (`<project>_<volume>`, its own `name:`, or an `external` volume), so `flisk up` mounts the same data with no copy (needs the Flisk release with flisk#2964).
 - **Keeps:** the service names (`db` stays `db`, so it stays the hostname), the build context and Dockerfile (or the image), the container port as written (3000, 80, 5432), `depends_on`, and an HTTP health path. Databases and brokers are private, with no proxy route.
-- **Runtime keys:** named volumes and bind mounts inside the project (`volumes`), `cap_add`, `cap_drop`, `init`, `read_only`, `user`, `security_opt` and `shm_size` (`container`), extra published ports (`extraPorts`, on 127.0.0.1 only), `network_mode: service:<name>` (`sidecarOf`) and `restart`.
+- **Runtime keys:** named volumes and bind mounts inside the project (`volumes`), `cap_add`, `cap_drop`, `init`, `read_only`, `user`, `security_opt` and `shm_size` (`container`), extra published ports (`extraPorts`, on the same host address as in Compose: `"80:80"` stays on every interface, `"127.0.0.1:5432:5432"` on loopback, and another address or a `${VAR:-default}` host side as `publish`), `network_mode: service:<name>` (`sidecarOf`) and `restart`.
 - **Environment:** values that cannot be secrets go into the committed `service.json` `env`: numbers, `true`/`false`, another imported service's address without a user, password or query (`http://invidious:3000`, `redis:6379`), and pure `${VAR}` references. Every other name, and any name that looks like a credential (`PASSWORD`, `TOKEN`, `KEY`, ...), goes into `secrets.required`, with its literal value copied to the project `.env`, which is added to `.gitignore`. Values in `.env` already are kept.
 - **Keeps:** a `command` or `entrypoint` on an image as the `CMD`/`ENTRYPOINT` of a small `Dockerfile` next to `service.json` (Flisk sets no container command), a `healthcheck` as `healthCheck.command`, a published database port as `extraPorts`, and `restart: on-failure:N` as `on-failure`.
 - **Drops, and says so:** `command` on a service with a `build`, `env_file` and every other untranslated key; anonymous volumes and paths outside the project; `network_mode` other than `service:<name>`; services with `profiles`, `extends`, an out-of-tree build or a `${VAR}` image.
-- **Does not start anything.** Run `flisk up` with Flisk core **1.4.24 or later**. The importer does not check the core version.
+- **Does not start anything.** Run `flisk up` with Flisk core **1.4.26 or later** (`publish` needs it). The importer does not check the core version.
 - **Exit codes:** `0` when the plan succeeds (`--dry-run`, files written, or all `service.json` files already exist), `1` when no root `docker-compose.yml` or mappable service is found, and `2` when the write prompt is declined or closed without an answer (`Nothing written.`).
 
 See [docs/import.md](docs/import.md) for the full mapping and limits. `flisk import` is the core CLI command backed by this package.

package/dist/detectors/compose.js

@@ -1,5 +1,5 @@
 import { readFileSync } from "node:fs";
-import { dirname, isAbsolute, join, normalize } from "node:path/posix";
+import { basename, dirname, isAbsolute, join, normalize } from "node:path/posix";
 import { isAlias, isMap, parseDocument, visit } from "yaml";
 import { HEALTH_CHECK_PATH_PATTERN } from "../flisk.js";
 import { registerDetector } from "../registry.js";
@@ -120,33 +120,65 @@ function containerOf(raw) {
     return { ...(Object.keys(container).length ? { container } : {}), dropped };
 }
 /** One published port: container port, host port when Compose names a literal one, and protocol. */
+/** A `publish` value Flisk accepts: digits, dots, colons and `${NAME:-default}` with a port or IPv4 address:port default. */
+const PUBLISH = /^(?:[0-9.:]|\$\{[A-Za-z_][A-Za-z0-9_]*:-[0-9.:]+\})+$/;
+/** The host address and port of a published port. Compose publishes on every interface unless an address is given. */
+function hostSideOf(port, hostIp, hostPort) {
+    const hostNumber = hostPort && /^\d+$/.test(hostPort) ? Number.parseInt(hostPort, 10) : undefined;
+    const keepHostPort = hostNumber !== undefined && hostNumber >= 1 && hostNumber <= 65535 && hostNumber !== port
+        ? { hostPort: hostNumber }
+        : {};
+    if (hostPort?.includes("${")) {
+        const publish = hostIp ? `${hostIp}:${hostPort}` : hostPort;
+        return PUBLISH.test(publish) ? { publish } : undefined;
+    }
+    if (hostIp === undefined || hostIp === "" || hostIp === "0.0.0.0") {
+        // A bare container port ("3000") gets a random host port from Compose; Flisk keeps it on 127.0.0.1.
+        return hostPort === undefined ? {} : { ...keepHostPort, bind: "0.0.0.0" };
+    }
+    if (hostIp === "127.0.0.1")
+        return keepHostPort;
+    const publish = `${hostIp}:${hostNumber ?? port}`;
+    return /^\d{1,3}(\.\d{1,3}){3}:\d+$/.test(publish) ? { publish } : undefined;
+}
 function publishedPort(entry) {
     const port = containerPort(entry);
     if (port === undefined)
         return undefined;
-    let host;
     let protocol = "tcp";
+    let hostSide;
     if (isObj(entry)) {
-        const published = typeof entry.published === "string" ? Number(entry.published) : entry.published;
-        if (typeof published === "number" && Number.isInteger(published))
-            host = published;
+        const published = entry.published === undefined ? undefined : String(entry.published);
+        const hostIp = typeof entry.host_ip === "string" ? entry.host_ip : undefined;
         if (entry.protocol === "udp")
             protocol = "udp";
+        hostSide = hostSideOf(port, hostIp, published);
     }
     else if (typeof entry === "string") {
         const [mapping, proto] = entry.split("/");
         if (proto === "udp")
             protocol = "udp";
-        const parts = (mapping ?? "").split(":");
-        const hostPart = parts.length >= 2 ? parts[parts.length - 2] : undefined;
-        if (hostPart && /^\d+$/.test(hostPart))
-            host = Number.parseInt(hostPart, 10);
+        // [HOST_IP:][HOST_PORT:]CONTAINER_PORT, where the host side may hold ${VAR:-default}, which has colons of its own.
+        const match = (mapping ?? "").match(/^(?:(.*):)?([^:]+)$/);
+        const host = match?.[1];
+        if (host === undefined)
+            hostSide = hostSideOf(port, undefined, undefined);
+        else if (host.includes("${"))
+            hostSide = hostSideOf(port, undefined, host);
+        else {
+            const at = host.lastIndexOf(":");
+            hostSide =
+                at === -1
+                    ? hostSideOf(port, undefined, host)
+                    : hostSideOf(port, host.slice(0, at), host.slice(at + 1));
+        }
+    }
+    else {
+        hostSide = {};
     }
     return {
         port,
-        ...(host !== undefined && host >= 1 && host <= 65535 && host !== port
-            ? { hostPort: host }
-            : {}),
+        ...(hostSide ?? {}),
         ...(protocol === "udp" ? { protocol } : {}),
     };
 }
@@ -189,6 +221,26 @@ function volumeOf(entry, composeDir) {
         return undefined;
     return { source: resolved, target, ...(readOnly ? { readOnly } : {}), bind };
 }
+/** Compose's project name: top-level `name`, else the directory name, lowercased with other characters dropped. */
+function projectNameOf(root, absPath) {
+    const raw = isObj(root) && typeof root.name === "string" && !root.name.includes("$")
+        ? root.name
+        : basename(dirname(absPath));
+    const name = raw.toLowerCase().replace(/[^a-z0-9_-]/g, "");
+    return /^[a-z0-9]/.test(name) ? name : undefined;
+}
+/**
+ * The Docker name of a named volume, as `docker compose up` created it: its own `name:`, the key itself when it is
+ * `external`, else `<project>_<key>`. Undefined when the name uses Compose variables.
+ */
+function dockerVolumeName(key, volumes, project) {
+    const def = isObj(volumes) ? volumes[key] : undefined;
+    if (isObj(def) && typeof def.name === "string")
+        return /^[A-Za-z0-9][A-Za-z0-9_.-]*$/.test(def.name) ? def.name : undefined;
+    if (isObj(def) && (def.external === true || isObj(def.external)))
+        return key;
+    return project ? `${project}_${key}` : undefined;
+}
 function envNames(environment) {
     if (Array.isArray(environment)) {
         return environment
@@ -358,6 +410,7 @@ registerDetector({
         if (!services || !isMap(doc.get("services", true))) {
             return { candidates, skips: [...skips, { ...base, reason: "no `services:` map" }] };
         }
+        const project = projectNameOf(root, absPath);
         for (const [name, raw] of Object.entries(services)) {
             if (!isObj(raw)) {
                 skips.push({ ...base, reason: `service "${name}" is not a map` });
@@ -417,13 +470,13 @@ registerDetector({
             if (ports.length > 1 && selectedPort === undefined) {
                 skips.push({
                     ...base,
-                    reason: `service "${name}" lists several ports (${ports.join(", ")}); no single HTTP container port could be identified, so none is routed (all are published on 127.0.0.1 as extraPorts)`,
+                    reason: `service "${name}" lists several ports (${ports.join(", ")}); no single HTTP container port could be identified, so none is routed (all stay published, as extraPorts)`,
                 });
             }
             else if (ports.length > 1) {
                 skips.push({
                     ...base,
-                    reason: `service "${name}" publishes extra container ports (${ports.filter((port) => port !== selectedPort).join(", ")}); Flisk routes only ${selectedPort} and publishes the others on 127.0.0.1 as extraPorts`,
+                    reason: `service "${name}" publishes extra container ports (${ports.filter((port) => port !== selectedPort).join(", ")}); Flisk routes only ${selectedPort} and keeps the others published as extraPorts`,
                 });
             }
             const dependsOn = Array.isArray(raw.depends_on)
@@ -456,7 +509,7 @@ registerDetector({
                     reason: `service "${name}" ${key} ${JSON.stringify(raw[key])} has values Flisk does not accept; not used`,
                 });
             }
-            // Every published port Flisk does not route stays published, on 127.0.0.1 (service.json extraPorts).
+            // Every published port Flisk does not route stays published on the same host address (service.json extraPorts).
             const proxied = selectedPort !== undefined && !NON_HTTP_PORTS.has(selectedPort);
             const extraPorts = (Array.isArray(raw.ports) ? raw.ports : [])
                 .map(publishedPort)
@@ -477,8 +530,11 @@ registerDetector({
             const volumes = [];
             for (const entry of Array.isArray(raw.volumes) ? raw.volumes : []) {
                 const volume = volumeOf(entry, composeDir);
+                const dockerName = volume && !volume.bind
+                    ? dockerVolumeName(volume.source, isObj(root) ? root.volumes : undefined, project)
+                    : undefined;
                 if (volume)
-                    volumes.push(volume);
+                    volumes.push(dockerName ? { ...volume, name: dockerName } : volume);
                 else
                     skips.push({
                         ...base,

package/dist/write.js

@@ -237,8 +237,16 @@ export function planWrites(plan, force) {
         const extraPorts = sidecarOf ? [] : (service.extraPorts ?? []);
         if (sidecarOf && service.extraPorts?.length)
             notes.push(`ports not written: a sidecar has none of its own; publish them on "${sidecarOf}"`);
-        if (extraPorts.length)
-            notes.push(`published on 127.0.0.1 only: ${extraPorts.map((p) => `${p.hostPort ?? p.port}->${p.port}/${p.protocol ?? "tcp"}`).join(", ")}`);
+        const portText = (p) => `${p.publish ?? p.hostPort ?? p.port}->${p.port}/${p.protocol ?? "tcp"}`;
+        const loopback = extraPorts.filter((p) => !p.bind && !p.publish);
+        const everywhere = extraPorts.filter((p) => p.bind === "0.0.0.0");
+        const fromCompose = extraPorts.filter((p) => p.publish);
+        if (loopback.length)
+            notes.push(`published on 127.0.0.1 only: ${loopback.map(portText).join(", ")}`);
+        if (everywhere.length)
+            notes.push(`published on every interface, as in Compose: ${everywhere.map(portText).join(", ")} (flisk doctor lists these)`);
+        if (fromCompose.length)
+            notes.push(`published as Compose wrote the host side: ${fromCompose.map(portText).join(", ")}`);
         // Bind mounts are relative to the service directory in service.json, and must stay inside the project.
         const serviceDir = dirname(path);
         const volumes = (service.volumes ?? []).flatMap((volume) => {
@@ -276,10 +284,12 @@ export function planWrites(plan, force) {
             ...(sidecarOf ? { sidecarOf } : {}),
             ...(volumes.length
                 ? {
-                    volumes: volumes.map(({ source, target, readOnly }) => ({
+                    // `name` keeps the Docker volume the Compose install already has, so its data is used with no copy.
+                    volumes: volumes.map(({ source, target, readOnly, name }) => ({
                         source,
                         target,
                         ...(readOnly ? { readOnly } : {}),
+                        ...(name ? { name } : {}),
                     })),
                 }
                 : {}),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flisk-sh/flisk-import",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Import a repository's root docker-compose.yml into Flisk service.json files, or register its Tiltfile.",
   "type": "module",
   "license": "MIT",