flisk-import 0.5.0 → 0.6.0

package/README.md

@@ -14,7 +14,7 @@ flisk import . --yes         # write service.json files and project setup
 - **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 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`.
-- **Environment:** names go into `service.json` as `secrets.required`; literal values are copied to the project `.env`, which is added to `.gitignore`. Values in `.env` already are kept, and `${VAR}` values are left for you.
+- **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.
 - **Drops, and says so:** `command`, `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.
 - **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.`).

package/dist/detectors/compose.js

@@ -211,6 +211,24 @@ function envValues(environment) {
     }
     return out;
 }
+/** A value that is nothing but Compose interpolation, such as `${URL}` or `${PORT:-80}`. Holds no secret itself. */
+const ONLY_REFERENCES = /^(\$\{[A-Za-z_][A-Za-z0-9_]*(?::?[-?+][^}\n]*)?\})+$/;
+/** Values that are only `${VAR}` references, which service.json `env` can keep as they are (Flisk 1.4.24). */
+function envReferences(environment) {
+    const pairs = Array.isArray(environment)
+        ? environment
+            .filter((e) => typeof e === "string" && e.includes("="))
+            .map((e) => [e.slice(0, e.indexOf("=")), e.slice(e.indexOf("=") + 1)])
+        : isObj(environment)
+            ? Object.entries(environment)
+            : [];
+    const out = {};
+    for (const [key, raw] of pairs) {
+        if (typeof raw === "string" && ONLY_REFERENCES.test(raw))
+            out[key] = raw;
+    }
+    return out;
+}
 function commandOf(command) {
     if (typeof command === "string")
         return command;
@@ -347,6 +365,7 @@ registerDetector({
             const command = commandOf(raw.command);
             const envKeys = envNames(raw.environment);
             const env = envValues(raw.environment);
+            const envRefs = envReferences(raw.environment);
             const foundHealthPath = healthPathOf(raw.healthcheck);
             const healthCheckPath = foundHealthPath && HEALTH_CHECK_PATH_PATTERN.test(foundHealthPath)
                 ? foundHealthPath
@@ -424,6 +443,7 @@ registerDetector({
                 exposeViaProxy,
                 ...(envKeys.length ? { envKeys } : {}),
                 ...(Object.keys(env).length ? { env } : {}),
+                ...(Object.keys(envRefs).length ? { envRefs } : {}),
                 ...(dependsOn.length ? { dependsOn } : {}),
                 ...(container ? { container } : {}),
                 ...(extraPorts.length ? { extraPorts } : {}),

package/dist/merge.js

@@ -63,6 +63,7 @@ function mergeGroup(name, dir, members, resolve) {
         kind: ordered[0].kind,
         envKeys: [...new Set(ordered.flatMap((c) => c.envKeys ?? []))].sort(),
         env: Object.assign({}, ...[...ordered].reverse().map((c) => c.env ?? {})),
+        envRefs: Object.assign({}, ...[...ordered].reverse().map((c) => c.envRefs ?? {})),
         dependsOn: [...new Set(ordered.flatMap((c) => (c.dependsOn ?? []).map(resolve)))].sort(),
         exposeViaProxy: ordered.find((c) => c.exposeViaProxy !== undefined)?.exposeViaProxy,
         // Only Compose states these, so the first source that has one wins.

package/dist/write.js

@@ -6,6 +6,31 @@ import { toResourceName } from "./merge.js";
 import { usedManifestPorts } from "./plan.js";
 /** Secret names the service schema accepts (`secrets.required`). */
 const ENV_NAME = /^[A-Z_][A-Z0-9_]*$/;
+/** Names that may hold a credential whatever their value looks like; these always stay secrets. */
+const CREDENTIAL_NAME = /PASS|SECRET|TOKEN|KEY|PRIVATE|CREDENTIAL|AUTH|HMAC|SALT|CERT|SESSION|COOKIE/i;
+/**
+ * Whether a literal Compose value cannot be a secret, so it may be committed in service.json `env`: a number, true or false,
+ * or the address of another service in this import (a URL or host:port with no user, password, query or fragment).
+ */
+function isPlainValue(value, serviceHosts) {
+    if (/^-?\d+(\.\d+)?$/.test(value) || /^(true|false)$/i.test(value))
+        return true;
+    const hostPort = value.match(/^([a-z0-9][a-z0-9._-]*):(\d{1,5})$/);
+    if (hostPort)
+        return serviceHosts.has(hostPort[1]);
+    try {
+        const url = new URL(value);
+        return (serviceHosts.has(url.hostname) &&
+            !url.username &&
+            !url.password &&
+            !url.search &&
+            !url.hash &&
+            /^[A-Za-z0-9._~/-]*$/.test(url.pathname));
+    }
+    catch {
+        return false;
+    }
+}
 function readEnvKeys(path) {
     if (!existsSync(path))
         return new Set();
@@ -78,6 +103,8 @@ export function planWrites(plan, force) {
         return !reason;
     });
     const names = new Set(accepted.map((s) => s.name));
+    // Hostnames other services use for these: the resource name, which stays the container hostname, and the Compose name.
+    const serviceHosts = new Set(plan.services.flatMap((s) => (s.originalName ? [s.name, s.originalName] : [s.name])));
     for (const service of accepted) {
         const path = resolve(servicesDir, stack, service.name, "service.json");
         const exists = existsSync(path);
@@ -133,8 +160,28 @@ export function planWrites(plan, force) {
             notes.push("no health path: the service does not serve HTTP (non-HTTP image or job)");
         if (!isPrivate && !nonHttp && !service.healthCheckPath)
             notes.push("health path / is assumed: no HTTP health path could be read from Compose. Traefik routes only while it answers 2xx or 3xx");
-        // Names go into service.json as secrets, so Flisk injects them; values go to the gitignored project .env.
-        const secretNames = service.envKeys.filter((key) => ENV_NAME.test(key));
+        // Values that cannot be secrets (numbers, booleans, another service's address, pure ${VAR} references) go into the
+        // committed service.json `env` (Flisk 1.4.24). Every other name is a secret: Flisk injects it from the gitignored .env.
+        const validNames = service.envKeys.filter((key) => ENV_NAME.test(key));
+        const env = {};
+        for (const key of validNames) {
+            if (CREDENTIAL_NAME.test(key))
+                continue;
+            const literal = service.env[key];
+            const reference = service.envRefs[key];
+            if (literal !== undefined && isPlainValue(literal, serviceHosts))
+                env[key] = literal;
+            else if (literal === undefined && reference !== undefined)
+                env[key] = reference;
+        }
+        const referenced = [
+            ...new Set(Object.values(env).flatMap((value) => [...value.matchAll(/\$\{([A-Za-z_][A-Za-z0-9_]*)(:?-)?/g)]
+                .filter((m) => !m[2])
+                .map((m) => m[1]))),
+        ].filter((name) => !envKept.has(name) && !(name in envAdd));
+        if (referenced.length)
+            notes.push(`env reads ${referenced.join(", ")} from the project .env; add them there`);
+        const secretNames = validNames.filter((key) => !(key in env));
         const skippedNames = service.envKeys.filter((key) => !ENV_NAME.test(key));
         if (skippedNames.length)
             notes.push(`environment names not written (Flisk accepts A-Z, 0-9 and _): ${skippedNames.join(", ")}`);
@@ -196,6 +243,9 @@ export function planWrites(plan, force) {
             ...source,
             ...(isPrivate ? { exposeViaProxy: false } : {}),
             ...(dependsOn.length ? { dependsOn } : {}),
+            ...(Object.keys(env).length
+                ? { env: Object.fromEntries(Object.entries(env).sort(([a], [b]) => a.localeCompare(b))) }
+                : {}),
             ...(secretNames.length ? { secrets: { required: secretNames } } : {}),
             ...(service.restart ? { restart: service.restart } : {}),
             ...(service.container ? { container: service.container } : {}),

package/package.json

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