@nocobase/cli 2.1.0-alpha.46 → 2.1.0-alpha.47

package/assets/env-proxy/nginx/app.conf.tpl

@@ -0,0 +1,23 @@
+# Rendered by `nb env proxy`.
+# Context:
+# publicBasePath={{publicBasePath}}
+# apiBasePath={{apiBasePath}}
+# wsPath={{wsPath}}
+# v2PublicPath={{v2PublicPath}}
+# backendUrl={{backendUrl}}
+# snippetsDir={{snippetsDir}}
+# uploadsDir={{uploadsDir}}
+# distRootDir={{distRootDir}}
+# entryDir={{entryDir}}
+# publicDir={{publicDir}}
+
+server {
+    listen 80;
+    server_name _;
+
+    # Add custom directives or locations above the managed block as needed.
+
+{{managedConfigBlock}}
+
+    # Add custom directives or locations below the managed block as needed.
+}

package/assets/env-proxy/nginx/nocobase.conf.tpl

@@ -0,0 +1,5 @@
+# Managed by `nb env proxy`. Changes will be overwritten.
+
+include {{snippetsDir}}/log-format-http.conf;
+include {{snippetsDir}}/maps-http.conf;
+include {{appConfigIncludePath}};

package/assets/env-proxy/nginx/snippets/dist-location.conf

@@ -0,0 +1,5 @@
+expires 365d;
+add_header Cache-Control "public" always;
+
+access_log off;
+autoindex off;

package/assets/env-proxy/nginx/snippets/gzip.conf

@@ -0,0 +1,17 @@
+gzip on;
+gzip_types
+    text/plain
+    text/css
+    text/xml
+    text/markdown
+    text/javascript
+    application/javascript
+    application/json
+    application/manifest+json
+    application/atom+xml
+    application/rss+xml
+    application/xml
+    application/xml+rss
+    application/xhtml+xml
+    application/wasm
+    image/svg+xml;

package/assets/env-proxy/nginx/snippets/log-format-http.conf

@@ -0,0 +1,13 @@
+log_format apm '"$time_local" client=$remote_addr '
+               'method=$request_method request="$request" '
+               'request_length=$request_length '
+               'status=$status bytes_sent=$bytes_sent '
+               'body_bytes_sent=$body_bytes_sent '
+               'referer=$http_referer '
+               'user_agent="$http_user_agent" '
+               'upstream_addr=$upstream_addr '
+               'upstream_status=$upstream_status '
+               'request_time=$request_time '
+               'upstream_response_time=$upstream_response_time '
+               'upstream_connect_time=$upstream_connect_time '
+               'upstream_header_time=$upstream_header_time';

package/assets/env-proxy/nginx/snippets/maps-http.conf

@@ -0,0 +1,14 @@
+map $http_upgrade $connection_upgrade {
+    default upgrade;
+    ""      close;
+}
+
+map $http_x_forwarded_proto $upstream_x_forwarded_proto {
+    default $http_x_forwarded_proto;
+    ""      $scheme;
+}
+
+map $http_host $final_host {
+    default $http_host;
+    ""      $host;
+}

package/assets/env-proxy/nginx/snippets/mime-types.conf

@@ -0,0 +1,98 @@
+types {
+    text/html                                        html htm shtml;
+    text/css                                         css;
+    text/xml                                         xml;
+    image/gif                                        gif;
+    image/jpeg                                       jpeg jpg;
+    application/javascript                           js mjs;
+    application/atom+xml                             atom;
+    application/rss+xml                              rss;
+
+    text/mathml                                      mml;
+    text/plain                                       txt;
+    text/vnd.sun.j2me.app-descriptor                 jad;
+    text/vnd.wap.wml                                 wml;
+    text/x-component                                 htc;
+
+    image/avif                                       avif;
+    image/png                                        png;
+    image/svg+xml                                    svg svgz;
+    image/tiff                                       tif tiff;
+    image/vnd.wap.wbmp                               wbmp;
+    image/webp                                       webp;
+    image/x-icon                                     ico;
+    image/x-jng                                      jng;
+    image/x-ms-bmp                                   bmp;
+
+    font/woff                                        woff;
+    font/woff2                                       woff2;
+
+    application/java-archive                         jar war ear;
+    application/json                                 json;
+    application/mac-binhex40                         hqx;
+    application/msword                               doc;
+    application/pdf                                  pdf;
+    application/postscript                           ps eps ai;
+    application/rtf                                  rtf;
+    application/vnd.apple.mpegurl                    m3u8;
+    application/vnd.google-earth.kml+xml             kml;
+    application/vnd.google-earth.kmz                 kmz;
+    application/vnd.ms-excel                         xls;
+    application/vnd.ms-fontobject                    eot;
+    application/vnd.ms-powerpoint                    ppt;
+    application/vnd.oasis.opendocument.graphics      odg;
+    application/vnd.oasis.opendocument.presentation  odp;
+    application/vnd.oasis.opendocument.spreadsheet   ods;
+    application/vnd.oasis.opendocument.text          odt;
+    application/vnd.openxmlformats-officedocument.presentationml.presentation
+                                                     pptx;
+    application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+                                                     xlsx;
+    application/vnd.openxmlformats-officedocument.wordprocessingml.document
+                                                     docx;
+    application/vnd.wap.wmlc                         wmlc;
+    application/wasm                                 wasm;
+    application/x-7z-compressed                      7z;
+    application/x-cocoa                              cco;
+    application/x-java-archive-diff                  jardiff;
+    application/x-java-jnlp-file                     jnlp;
+    application/x-makeself                           run;
+    application/x-perl                               pl pm;
+    application/x-pilot                              prc pdb;
+    application/x-rar-compressed                     rar;
+    application/x-redhat-package-manager             rpm;
+    application/x-sea                                sea;
+    application/x-shockwave-flash                    swf;
+    application/x-stuffit                            sit;
+    application/x-tcl                                tcl tk;
+    application/x-x509-ca-cert                       der pem crt;
+    application/x-xpinstall                          xpi;
+    application/xhtml+xml                            xhtml;
+    application/xspf+xml                             xspf;
+    application/zip                                  zip;
+
+    application/octet-stream                         bin exe dll;
+    application/octet-stream                         deb;
+    application/octet-stream                         dmg;
+    application/octet-stream                         iso img;
+    application/octet-stream                         msi msp msm;
+
+    audio/midi                                       mid midi kar;
+    audio/mpeg                                       mp3;
+    audio/ogg                                        ogg;
+    audio/x-m4a                                      m4a;
+    audio/x-realaudio                                ra;
+
+    video/3gpp                                       3gpp 3gp;
+    video/mp2t                                       ts;
+    video/mp4                                        mp4;
+    video/mpeg                                       mpeg mpg;
+    video/quicktime                                  mov;
+    video/webm                                       webm;
+    video/x-flv                                      flv;
+    video/x-m4v                                      m4v;
+    video/x-mng                                      mng;
+    video/x-ms-asf                                   asx asf;
+    video/x-ms-wmv                                   wmv;
+    video/x-msvideo                                  avi;
+}

package/assets/env-proxy/nginx/snippets/proxy-location.conf

@@ -0,0 +1,17 @@
+proxy_http_version 1.1;
+
+proxy_set_header Upgrade $http_upgrade;
+proxy_set_header Connection $connection_upgrade;
+proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+proxy_set_header X-Forwarded-Proto $upstream_x_forwarded_proto;
+proxy_set_header Host $final_host;
+proxy_set_header Referer $http_referer;
+proxy_set_header User-Agent $http_user_agent;
+
+add_header Cache-Control "no-cache, no-store" always;
+proxy_cache_bypass $http_upgrade;
+
+proxy_connect_timeout 600;
+proxy_send_timeout 600;
+proxy_read_timeout 600;
+send_timeout 600;

package/assets/env-proxy/nginx/snippets/spa-location.conf

@@ -0,0 +1,6 @@
+add_header Cache-Control "no-store, no-cache, must-revalidate" always;
+add_header X-Robots-Tag "noindex, nofollow" always;
+
+if_modified_since off;
+expires off;
+etag off;

package/assets/env-proxy/nginx/snippets/uploads-location.conf

@@ -0,0 +1,21 @@
+add_header Cache-Control "public" always;
+add_header X-Content-Type-Options "nosniff" always;
+
+access_log off;
+autoindex off;
+
+# Force potentially renderable uploaded files to download.
+location ~* \.(?:htm|html|svg|svgz|xhtml)$ {
+    add_header Cache-Control "public" always;
+    add_header X-Content-Type-Options "nosniff" always;
+    add_header Content-Disposition "attachment" always;
+}
+
+# Let Markdown files render as plain Markdown text.
+location ~* \.md$ {
+    default_type text/markdown;
+
+    add_header Cache-Control "public" always;
+    add_header X-Content-Type-Options "nosniff" always;
+    add_header Content-Disposition "inline" always;
+}

package/bin/run.js

@@ -66,6 +66,10 @@ if (isDev && !process.env._NOCO_CLI_TSX_CHILD) {
 
 const bootstrapPath = isDev ? path.join(root, 'src/lib/bootstrap.ts') : path.join(root, 'dist/lib/bootstrap.js');
 const { ensureRuntimeFromArgv } = await import(pathToFileURL(bootstrapPath).href);
+const commandLogPath = isDev ? path.join(root, 'src/lib/command-log.ts') : path.join(root, 'dist/lib/command-log.js');
+const { finalizeCommandLogSessionSync, initCommandLogSession, installCommandLogWriteHooks } = await import(
+  pathToFileURL(commandLogPath).href
+);
 const startupUpdatePath = isDev
   ? path.join(root, 'src/lib/startup-update.ts')
   : path.join(root, 'dist/lib/startup-update.js');
@@ -73,15 +77,43 @@ const { maybeRunStartupUpdate } = await import(pathToFileURL(startupUpdatePath).
 const cliEntryErrorPath = isDev
   ? path.join(root, 'src/lib/cli-entry-error.ts')
   : path.join(root, 'dist/lib/cli-entry-error.js');
-const { formatCliEntryError } = await import(pathToFileURL(cliEntryErrorPath).href);
+const { appendDiagnosticLogPath, formatCliEntryError } = await import(pathToFileURL(cliEntryErrorPath).href);
 const { flush, run, settings } = await import('@oclif/core');
 
 if (isDev) {
   settings.debug = true;
 }
 
+const cliPackageJson = requireFromCli(path.join(root, 'package.json'));
+const argv = process.argv.slice(2);
+const commandLogSession = await initCommandLogSession({
+  argv,
+  cwd: process.cwd(),
+  sessionId: process.env.NB_SESSION_ID,
+  cliVersion: cliPackageJson?.version,
+  nodeVersion: process.version,
+  platform: process.platform,
+  interactive: Boolean(process.stdin.isTTY && process.stdout.isTTY),
+  verbose: argv.includes('--verbose'),
+});
+const restoreCommandLogHooks = installCommandLogWriteHooks();
+let commandLogFinalized = false;
+
+function finalizeCommandLogOnce(options = {}) {
+  if (commandLogFinalized) {
+    return;
+  }
+
+  commandLogFinalized = true;
+  restoreCommandLogHooks?.();
+  finalizeCommandLogSessionSync(commandLogSession, options);
+}
+
+process.once('exit', (code) => {
+  finalizeCommandLogOnce({ exitCode: code ?? undefined });
+});
+
 try {
-  const argv = process.argv.slice(2);
   const startupUpdate = await maybeRunStartupUpdate(argv);
   if (startupUpdate.kind === 'updated') {
     const result = spawnSync(process.execPath, process.argv.slice(1), {
@@ -100,8 +132,13 @@ try {
   }
   await run(argv, import.meta.url);
   flush();
+  finalizeCommandLogOnce({ exitCode: 0 });
 } catch (error) {
-  const message = formatCliEntryError(error, process.argv.slice(2));
+  const message = appendDiagnosticLogPath(
+    formatCliEntryError(error, process.argv.slice(2)),
+    commandLogSession?.logFile,
+  );
   console.error(pc.red(message));
+  finalizeCommandLogOnce({ exitCode: 1, errorMessage: message });
   process.exit(1);
 }

package/dist/commands/app/autostart/disable.js

@@ -0,0 +1,55 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../../lib/env-guard.js';
+import { getEnv } from '../../../lib/auth-store.js';
+import { formatMissingManagedAppEnvMessage } from '../../../lib/app-runtime.js';
+import { announceTargetEnv } from '../../../lib/ui.js';
+import { updateAutostartSetting } from './shared.js';
+export default class AppAutostartDisable extends Command {
+    static description = 'Disable app autostart for the selected env.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --yes',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to remove from app autostart. Defaults to the current env when omitted',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AppAutostartDisable);
+        const requestedEnv = flags.env?.trim() || undefined;
+        if (requestedEnv && hasExplicitEnvSelection(this.argv)) {
+            const confirmed = await ensureCrossEnvConfirmed({
+                command: this,
+                requestedEnv,
+                yes: flags.yes,
+            });
+            if (!confirmed) {
+                return;
+            }
+        }
+        const env = await getEnv(requestedEnv);
+        if (!env?.name) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        const envName = env.name;
+        await updateAutostartSetting(envName, false);
+        announceTargetEnv(envName);
+        this.log(`Disabled app autostart for "${envName}".`);
+    }
+}

package/dist/commands/app/autostart/enable.js

@@ -0,0 +1,55 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../../lib/env-guard.js';
+import { getEnv } from '../../../lib/auth-store.js';
+import { formatMissingManagedAppEnvMessage } from '../../../lib/app-runtime.js';
+import { announceTargetEnv } from '../../../lib/ui.js';
+import { updateAutostartSetting } from './shared.js';
+export default class AppAutostartEnable extends Command {
+    static description = 'Enable app autostart for the selected local or Docker env.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --yes',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to add to app autostart. Defaults to the current env when omitted',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AppAutostartEnable);
+        const requestedEnv = flags.env?.trim() || undefined;
+        if (requestedEnv && hasExplicitEnvSelection(this.argv)) {
+            const confirmed = await ensureCrossEnvConfirmed({
+                command: this,
+                requestedEnv,
+                yes: flags.yes,
+            });
+            if (!confirmed) {
+                return;
+            }
+        }
+        const env = await getEnv(requestedEnv);
+        if (!env?.name) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        const envName = env.name;
+        await updateAutostartSetting(envName, true);
+        announceTargetEnv(envName);
+        this.log(`Enabled app autostart for "${envName}".`);
+    }
+}

package/dist/commands/app/autostart/list.js

@@ -0,0 +1,37 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command } from '@oclif/core';
+import { getCurrentEnvName, listEnvs } from '../../../lib/auth-store.js';
+import { renderTable } from '../../../lib/ui.js';
+import { isAutostartEnabled } from './shared.js';
+export default class AppAutostartList extends Command {
+    static description = 'List app autostart status for configured envs.';
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    async run() {
+        await this.parse(AppAutostartList);
+        const { envs } = await listEnvs();
+        const currentEnv = await getCurrentEnvName();
+        const names = Object.keys(envs).sort();
+        if (!names.length) {
+            this.log('No environments are configured.');
+            return;
+        }
+        const rows = names.map((name) => {
+            const env = envs[name];
+            return [
+                name === currentEnv ? '*' : '',
+                name,
+                env.kind ?? '-',
+                env.source ? String(env.source) : '-',
+                isAutostartEnabled(env) ? 'yes' : 'no',
+            ];
+        });
+        this.log(renderTable(['Current', 'Env', 'Kind', 'Source', 'Autostart'], rows));
+    }
+}

package/dist/commands/app/autostart/run.js

@@ -0,0 +1,84 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { listEnvs } from '../../../lib/auth-store.js';
+import { resolveManagedAppRuntime } from '../../../lib/app-runtime.js';
+import { renderTable } from '../../../lib/ui.js';
+import { ensureManagedAutostartRuntime, isAutostartEnabled } from './shared.js';
+function formatSummary(results) {
+    return renderTable(['Env', 'Status', 'Detail'], results.map((result) => [result.env, result.status, result.detail]));
+}
+export default class AppAutostartRun extends Command {
+    static description = 'Start every env that has app autostart enabled.';
+    static examples = ['<%= config.bin %> <%= command.id %>', '<%= config.bin %> <%= command.id %> --verbose'];
+    static flags = {
+        verbose: Flags.boolean({
+            description: 'Show raw startup output from the underlying local or Docker command',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AppAutostartRun);
+        const { envs } = await listEnvs();
+        const enabledNames = Object.keys(envs)
+            .filter((name) => isAutostartEnabled(envs[name]))
+            .sort((left, right) => left.localeCompare(right));
+        if (!enabledNames.length) {
+            this.log('No environments have app autostart enabled.');
+            return;
+        }
+        const results = [];
+        for (const envName of enabledNames) {
+            const env = envs[envName];
+            try {
+                ensureManagedAutostartRuntime({ ...env, name: envName });
+            }
+            catch (error) {
+                results.push({
+                    env: envName,
+                    status: 'skipped',
+                    detail: error instanceof Error ? error.message : String(error),
+                });
+                continue;
+            }
+            const runtime = await resolveManagedAppRuntime(envName);
+            if (!runtime) {
+                results.push({
+                    env: envName,
+                    status: 'failed',
+                    detail: 'Env configuration could not be resolved.',
+                });
+                continue;
+            }
+            try {
+                const argv = ['--env', envName, '--yes'];
+                if (flags.verbose) {
+                    argv.push('--verbose');
+                }
+                await this.config.runCommand('app:start', argv);
+                results.push({
+                    env: envName,
+                    status: 'started',
+                    detail: `Started ${runtime.kind} app runtime.`,
+                });
+            }
+            catch (error) {
+                results.push({
+                    env: envName,
+                    status: 'failed',
+                    detail: error instanceof Error ? error.message : String(error),
+                });
+            }
+        }
+        this.log(formatSummary(results));
+        if (results.some((result) => result.status === 'failed')) {
+            this.error('Some app autostart envs failed to start.');
+        }
+    }
+}

package/dist/commands/app/autostart/shared.js

@@ -0,0 +1,49 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { loadExactAuthConfig, saveAuthConfig } from '../../../lib/auth-store.js';
+export function isAutostartEnabled(config) {
+    return config?.autostart?.enabled === true;
+}
+export function ensureManagedAutostartRuntime(config) {
+    const kind = String(config.kind ?? '').trim();
+    const source = String(config.source ?? '').trim();
+    const inferredLocal = source === 'npm' || source === 'git' || source === 'local';
+    if (kind === 'local' || kind === 'docker' || (!kind && (source === 'docker' || inferredLocal))) {
+        return;
+    }
+    const envName = String(config.name ?? '').trim() || 'unknown';
+    throw new Error([
+        `Env "${envName}" cannot be added to app autostart.`,
+        'Only local and Docker envs with CLI-managed app runtimes can be started automatically on this machine.',
+    ].join('\n'));
+}
+export async function updateAutostartSetting(envName, enabled) {
+    const config = await loadExactAuthConfig();
+    const previous = config.envs[envName];
+    if (!previous) {
+        throw new Error(`Env "${envName}" is not configured`);
+    }
+    ensureManagedAutostartRuntime({ ...previous, name: envName });
+    const next = { ...previous };
+    const wasEnabled = isAutostartEnabled(previous);
+    if (enabled) {
+        next.autostart = { enabled: true };
+    }
+    else {
+        delete next.autostart;
+    }
+    config.envs[envName] = next;
+    if (wasEnabled !== enabled) {
+        await saveAuthConfig(config);
+    }
+    return {
+        config,
+        changed: wasEnabled !== enabled,
+    };
+}