mfeflow 0.6.0 → 0.7.0

package/assets/features/deploy-docker/files/nginx.shell.conf

@@ -0,0 +1,84 @@
+# The shell. Every response says how long it may be cached: revalidate by default, a year only for
+# files whose name changes when their content does (/static/). nginx drops the headers of the
+# level above as soon as a location sets its own, so each location repeats Cache-Control.
+
+# The stock mime.types has no .mjs. This block sits at http level, where it adds to the stock
+# list; inside a server block a types block would replace the whole list.
+types {
+  text/javascript mjs;
+}
+
+# add_header is not inherited by a location that sets its own, so every location repeats the
+# security headers beside Cache-Control.
+gzip on;
+gzip_vary on;
+gzip_min_length 256;
+gzip_types text/css text/javascript application/javascript application/json image/svg+xml;
+# This image has no brotli module. Let a CDN or ingress do brotli if you want it.
+
+server {
+  listen 8080;
+  server_name _;
+  server_tokens off;
+  root /usr/share/nginx/html;
+
+  location = /healthz {
+    access_log off;
+    default_type text/plain;
+    return 200 "ok\n";
+  }
+
+  # Dotfiles (.env, .git) are never served. .well-known stays reachable.
+  location ~ /\.(?!well-known) { return 404; }
+
+  # Written by the start script (or mounted as a ConfigMap) so the image holds no environment.
+  location = /config/runtime-config.json {
+    alias /tmp/mfe-runtime/runtime-config.json;
+    default_type application/json;
+    add_header Cache-Control "no-cache" always;
+    add_header X-Content-Type-Options "nosniff" always;
+    add_header Referrer-Policy "strict-origin-when-cross-origin" always;
+    add_header X-Frame-Options "SAMEORIGIN" always;
+  }
+
+  # Mounted, never baked in: a ConfigMap in Kubernetes, a file in Docker, or leave it out and point
+  # registryUrls in the runtime config at a registry you host elsewhere.
+  location = /registry/index.json {
+    alias /tmp/mfe-registry/index.json;
+    default_type application/json;
+    add_header Cache-Control "no-cache" always;
+    add_header X-Content-Type-Options "nosniff" always;
+    add_header Referrer-Policy "strict-origin-when-cross-origin" always;
+    add_header X-Frame-Options "SAMEORIGIN" always;
+  }
+
+  location ^~ /config/ { return 404; }
+  location ^~ /registry/ { return 404; }
+
+  # Hashed build output.
+  location ^~ /static/ {
+    try_files $uri =404;
+    add_header Cache-Control "public, max-age=31536000, immutable";
+    add_header X-Content-Type-Options "nosniff" always;
+    add_header Referrer-Policy "strict-origin-when-cross-origin" always;
+    add_header X-Frame-Options "SAMEORIGIN" always;
+  }
+
+  # Any other file (favicon, mf-manifest.json): a missing one is a real 404, never index.html.
+  location ~ \.[A-Za-z0-9]+$ {
+    try_files $uri =404;
+    add_header Cache-Control "no-cache" always;
+    add_header X-Content-Type-Options "nosniff" always;
+    add_header Referrer-Policy "strict-origin-when-cross-origin" always;
+    add_header X-Frame-Options "SAMEORIGIN" always;
+  }
+
+  # Routes. The fallback to index.html lives here and nowhere else.
+  location / {
+    try_files $uri /index.html;
+    add_header Cache-Control "no-cache" always;
+    add_header X-Content-Type-Options "nosniff" always;
+    add_header Referrer-Policy "strict-origin-when-cross-origin" always;
+    add_header X-Frame-Options "SAMEORIGIN" always;
+  }
+}

package/assets/templates/monorepo/feature.json

@@ -1,6 +1,6 @@
 {
   "name": "core",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "The shell, the remotes, the registry and the workspace around them.",
   "files": [
     {

package/assets/templates/monorepo/files/root/pnpm-workspace.yaml.eta

@@ -2,8 +2,9 @@ packages:
   - apps/*
   - packages/*
 
-# Dependencies allowed to run install scripts. esbuild (pulled in by Storybook) works without its
-# script; listing it as false keeps pnpm from stopping the install to ask.
+# Dependencies allowed to run install scripts. esbuild (pulled in by Storybook) and workerd (pulled in
+# by wrangler) work without their script; listing them as false keeps pnpm from stopping the install to ask.
 allowBuilds:
   lefthook: true
   esbuild: false
+  workerd: false

package/dist/commands/doctor.d.ts

@@ -43,6 +43,11 @@ export declare const DOCTOR_ARGS: {
         readonly alias: 'h';
         readonly description: 'Show this help';
     };
+    readonly against: {
+        readonly type: 'string';
+        readonly description: 'Check against the shell a registry index or a deployed mf-manifest.json describes (file or https URL)';
+        readonly valueHint: 'url|file';
+    };
     readonly fix: {
         readonly type: 'boolean';
         readonly description: 'Repair what is safe: missing workspace versions and registry entries';

package/dist/index.js

@@ -1,6 +1,6 @@
 import { stripVTControlCharacters } from "node:util";
-import { COST_MODEL, DOCS_URL, MFE_NAME, REGISTRY_NAMESPACE, ROUTE_OVERLAP, isLoopbackHttp, isRegistryProtocol, isSafeRelativePath, judgeCost, judgeRemoteInitial, primaryExpose, redactUrl, redactUrlsIn, registryIndexUrl, registryTemplateProblem, remoteDistFiles, round1, routesOverlap, validateMfeManifest, validateRegistryEntry, validateRegistryIndex } from "@mfeflow/contracts";
-import { APP_FILE, LEGACY_APP_FILE, MfeflowError, PROJECT_FILE, PlanBuilder, TRUST_ENV, addTrusted, applyPlan, buildRegistry, checkIntegrity, configDirOf, detectFederation, dotenvKeys, fetchFeatureIndex, findDiverged, findProjectRoot, getHttps, hasErrno, inOrder, isMfeflowError, legacyAppFileNotice, loadFeature, loadProject, messageOf, parseFeature, parseTrustEnv, planAdoption, planUpgrade, readAppFile, readCappedText, readTrusted, realFs, recordPlan, removeTrusted, renderDiff, renderTemplate, resolveFeature, runtimeConfigFiles, saveProject, schemaKeys, serializeProject, summarize, symlinkedPrefix, trustedNamespaces, writeFileAtomic } from "@mfeflow/core";
+import { COST_MODEL, DOCS_URL, ENV_KEY_NAME, MFE_NAME, REGISTRY_NAMESPACE, ROUTE_OVERLAP, isLoopbackHttp, isRegistryProtocol, isSafeRelativePath, judgeCost, judgeRemoteInitial, primaryExpose, redactUrl, redactUrlsIn, registryIndexUrl, registryTemplateProblem, remoteDistFiles, round1, routesOverlap, validateMfeManifest, validateRegistryEntry, validateRegistryIndex } from "@mfeflow/contracts";
+import { APP_FILE, LEGACY_APP_FILE, MfeflowError, PROJECT_FILE, PlanBuilder, TRUST_ENV, addTrusted, applyPlan, buildRegistry, checkIntegrity, configDirOf, detectFederation, dotenvKeys, fetchFeatureIndex, findDiverged, findProjectRoot, getHttps, hasErrno, inOrder, isMfeflowError, legacyAppFileNotice, loadFeature, loadProject, messageOf, parseFeature, parseTrustEnv, planAdoption, planUpgrade, readAppFile, readCappedText, readTrusted, realFs, recordEnvKey, recordPlan, removeTrusted, renderDiff, renderTemplate, resolveFeature, runtimeConfigFiles, saveProject, schemaKeys, serializeProject, summarize, symlinkedPrefix, trustedNamespaces, writeFileAtomic } from "@mfeflow/core";
 import { defineCommand, runCommand } from "citty";
 import node_path from "node:path";
 import promises from "node:fs/promises";
@@ -242,6 +242,16 @@ const FIRST_PARTY = [
         name: 'registry-server',
         always: false,
         default: false
+    },
+    {
+        name: 'deploy-cloudflare',
+        always: false,
+        default: false
+    },
+    {
+        name: 'deploy-docker',
+        always: false,
+        default: false
     }
 ];
 function isFirstParty(name) {
@@ -1379,7 +1389,6 @@ async function writePlan(request) {
         installed: installing
     };
 }
-const KEY = /^[A-Za-z_][A-Za-z0-9_]*$/;
 const GROUPS = [
     'root',
     'shell',
@@ -1460,7 +1469,7 @@ function envKeyOp(input) {
 async function addEnvKey(rt, globals, args, key) {
     const scope = args_text(args, 'scope');
     const schema = args_text(args, 'schema');
-    if (void 0 === key || !KEY.test(key)) throw new MfeflowError('E107', 'add env-key needs a key like API_ORIGIN: mfeflow add env-key <KEY>');
+    if (void 0 === key || !ENV_KEY_NAME.test(key)) throw new MfeflowError('E107', 'add env-key needs a key like API_ORIGIN: mfeflow add env-key <KEY>');
     if ('server' !== scope && 'runtime' !== scope) throw new MfeflowError('E107', '--scope must be server or runtime');
     if (void 0 === schema) throw new MfeflowError('E107', '--schema is required, for example --schema "z.url()"');
     const root = await findProjectRoot(globals.cwd);
@@ -1501,6 +1510,7 @@ async function addEnvKey(rt, globals, args, key) {
         ...builder.build(),
         features: []
     };
+    const recorded = recordEnvKey(project, plan.changes.map((change)=>change.path), key);
     const outcome = await writePlan({
         rt,
         globals: {
@@ -1509,7 +1519,7 @@ async function addEnvKey(rt, globals, args, key) {
         },
         root,
         plan,
-        project
+        project: recorded
     });
     const result = {
         ok: true,
@@ -3457,7 +3467,7 @@ const singletonVersions = {
     }
 };
 const ABSENT_SHELL_WARNING = 'shell is not in this repo, pass --against <url|file>';
-const ABSENT_UNDER_DOCTOR = 'shell is not in this repo, run `mfeflow check-compat --against <url|file>`';
+const ABSENT_UNDER_DOCTOR = 'shell is not in this repo, run `mfeflow doctor --against <url|file>`';
 async function versionsOf(app, names, root) {
     const found = await Promise.all(names.map(async (name)=>[
             name,
@@ -4069,22 +4079,26 @@ const DOCTOR_CHECKS = [
     runtimePlugins,
     ...envChecks
 ];
+const AGAINST_ARG = {
+    against: {
+        type: 'string',
+        description: 'Check against the shell a registry index or a deployed mf-manifest.json describes (file or https URL)',
+        valueHint: 'url|file'
+    }
+};
 const DOCTOR_ARGS = {
     fix: {
         type: 'boolean',
         description: 'Repair what is safe: missing workspace versions and registry entries'
     },
+    ...AGAINST_ARG,
     ...GLOBAL_ARGS
 };
 const VALIDATE_ARGS = {
     ...GLOBAL_ARGS
 };
 const COMPAT_ARGS = {
-    against: {
-        type: 'string',
-        description: 'Check against the shell a registry index or a deployed mf-manifest.json describes (file or https URL)',
-        valueHint: 'url|file'
-    },
+    ...AGAINST_ARG,
     ...GLOBAL_ARGS
 };
 const DEFAULT_VERSION = '0.0.0';
@@ -4199,7 +4213,17 @@ async function runGroup(rt, args, raw, defs, command, checks, fix) {
     };
 }
 function runDoctor(rt, args, raw) {
-    return runGroup(rt, args, raw, DOCTOR_ARGS, 'doctor', DOCTOR_CHECKS, true === args.fix);
+    const against = 'string' == typeof args.against ? args.against : void 0;
+    return runGroup(rt, args, raw, DOCTOR_ARGS, 'doctor', void 0 === against ? DOCTOR_CHECKS : async (globals)=>{
+        const shell = await loadShell(against, {
+            cwd: globals.cwd,
+            fetch: rt.fetch
+        });
+        return DOCTOR_CHECKS.map((check)=>check.id === compat.id ? compatCheck(shell, 'doctor') : check);
+    }, true === args.fix).then((result)=>void 0 === against ? result : {
+            ...result,
+            against: redactUrl(against)
+        });
 }
 function runValidate(rt, args, raw) {
     return runGroup(rt, args, raw, VALIDATE_ARGS, 'validate', VALIDATE_CHECKS, false);
@@ -4893,6 +4917,40 @@ class ServerClient {
     scrubAll(value) {
         return JSON.parse(this.scrub(JSON.stringify(value)));
     }
+    scrubError(error, seen = new WeakSet()) {
+        if ('string' == typeof error) return this.scrub(error);
+        if ('object' != typeof error || null === error) return error;
+        if (seen.has(error)) return error;
+        seen.add(error);
+        if (!(error instanceof Error)) try {
+            return this.scrubAll(error);
+        } catch  {
+            return this.scrub(Object.prototype.toString.call(error));
+        }
+        error.message = this.scrub(error.message);
+        if (void 0 !== error.stack) error.stack = this.scrub(error.stack);
+        if (error instanceof MfeflowError) error.fix = this.scrub(error.fix);
+        if (void 0 !== error.cause) error.cause = this.scrubError(error.cause, seen);
+        if (error instanceof AggregateError) error.errors = error.errors.map((inner)=>this.scrubError(inner, seen));
+        return error;
+    }
+    async guarded(rt, work) {
+        const prompter = {
+            ...rt.prompter,
+            confirm: (options)=>rt.prompter.confirm({
+                    ...options,
+                    message: this.scrub(options.message)
+                })
+        };
+        try {
+            return this.scrubAll(await work({
+                ...rt,
+                prompter
+            }));
+        } catch (error) {
+            throw this.scrubError(error);
+        }
+    }
     get hasToken() {
         return void 0 !== this.token;
     }
@@ -5651,24 +5709,24 @@ async function killInner(rt, args, raw, restore, client) {
 }
 const rate = (c)=>`${String(c.loads)} loads, ${String(c.errors)} errors`;
 async function deployViaServer(rt, args, raw, defs, client) {
-    return client.scrubAll(await deployInner(rt, args, raw, defs, client));
+    return client.guarded(rt, (guarded)=>deployInner(guarded, args, raw, defs, client));
 }
 async function promoteViaServer(rt, args, raw, defs, client) {
-    return client.scrubAll(await promoteInner(rt, args, raw, defs, client));
+    return client.guarded(rt, (guarded)=>promoteInner(guarded, args, raw, defs, client));
 }
 async function rollbackViaServer(rt, args, raw, defs, client) {
-    return client.scrubAll(await rollbackInner(rt, args, raw, defs, client));
+    return client.guarded(rt, (guarded)=>rollbackInner(guarded, args, raw, defs, client));
 }
 async function statusViaServer(rt, args, raw, defs, client) {
-    return client.scrubAll(await statusInner(rt, args, raw, defs, client));
+    return client.guarded(rt, (guarded)=>statusInner(guarded, args, raw, defs, client));
 }
 async function runRolloutCommand(rt, args, raw, client) {
-    const result = await rolloutInner(rt, args, raw, client);
-    return void 0 === client ? result : client.scrubAll(result);
+    if (void 0 === client) return rolloutInner(rt, args, raw, client);
+    return client.guarded(rt, (guarded)=>rolloutInner(guarded, args, raw, client));
 }
 async function runKillCommand(rt, args, raw, restore, client) {
-    const result = await killInner(rt, args, raw, restore, client);
-    return void 0 === client ? result : client.scrubAll(result);
+    if (void 0 === client) return killInner(rt, args, raw, restore, client);
+    return client.guarded(rt, (guarded)=>killInner(guarded, args, raw, restore, client));
 }
 function formatServerAction(result) {
     if ('rollout' === result.command) {
@@ -8108,7 +8166,8 @@ const COMMANDS = [
             'mfeflow doctor',
             'mfeflow doctor --fix',
             'mfeflow doctor --json',
-            'mfeflow doctor --fix --dry-run'
+            'mfeflow doctor --fix --dry-run',
+            'mfeflow doctor --against https://cdn.example.com/envs/prod/index.json'
         ],
         run: runDoctor
     },

package/dist/output.d.ts

@@ -195,7 +195,7 @@ export interface ReportResult {
     summary: Summary;
     checks: CheckReport[];
     findings: Finding[];
-    /** `check-compat --against`: where the shell's versions came from. */
+    /** `doctor` and `check-compat --against`: where the shell's versions came from. */
     against?: string;
 }
 export interface ShellBudget {

package/dist/server-client.d.ts

@@ -43,6 +43,14 @@ export declare class ServerClient {
     scrub(words: string): string;
     /** A result document with every string scrubbed. The server's words reach the output through it. */
     scrubAll<T>(value: T): T;
+    /**
+     * Whatever was thrown, with the token taken out for errors raised outside `run`: message, stack,
+     * `fix`, the `cause` chain and the errors of an AggregateError. Strings and plain objects are
+     * scrubbed too.
+     */
+    scrubError(error: unknown, seen?: WeakSet<object>): unknown;
+    /** Runs a whole server-mode command: whatever it prints, prompts or throws is scrubbed. */
+    guarded<T>(rt: Runtime, work: (rt: Runtime) => Promise<T>): Promise<T>;
     get hasToken(): boolean;
     /** Throws the catalogue error for anything that is not a 2xx reply; `gates_failed` is thrown as a ServerError. */
     get(route: string, needsToken?: boolean): Promise<unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mfeflow",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Create and grow a React micro-frontend platform: mfeflow init, add remote, add <feature>.",
   "keywords": [
     "micro-frontend",
@@ -49,15 +49,15 @@
   },
   "dependencies": {
     "@clack/prompts": "1.8.1",
-    "@mfeflow/contracts": "0.6.0",
-    "@mfeflow/core": "0.6.0",
-    "@mfeflow/registry": "0.6.0",
+    "@mfeflow/contracts": "0.7.0",
+    "@mfeflow/core": "0.7.0",
+    "@mfeflow/registry": "0.7.0",
     "citty": "0.2.2",
     "semver": "7.8.5",
     "yaml": "2.9.1"
   },
   "devDependencies": {
-    "@mfeflow/rsbuild": "0.6.0",
+    "@mfeflow/rsbuild": "0.7.0",
     "@rslib/core": "1.0.5",
     "@types/node": "26.6.6",
     "@types/semver": "7.8.0",