@nocobase/cli-v1 2.2.0-alpha.11 → 2.2.0-alpha.12

package/nocobase.conf.tpl

@@ -128,6 +128,34 @@ server {
         send_timeout 600;
     }
 
+    location ^~ {{settingsAssetsPath}} {
+        alias {{cwd}}/node_modules/@nocobase/app/dist/client/settings/assets/;
+        expires 365d;
+        add_header Cache-Control "public";
+        access_log off;
+        autoindex off;
+    }
+
+    # The standalone Settings SPA is a Client V2 surface. Keep this matcher
+    # narrow so legacy /admin/settings routes continue to use the v1 HTML.
+    location ~ {{settingsDocumentPattern}} {
+        proxy_pass http://127.0.0.1:{{apiPort}};
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header 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';
+        proxy_cache_bypass $http_upgrade;
+        proxy_connect_timeout 600;
+        proxy_send_timeout 600;
+        proxy_read_timeout 600;
+        send_timeout 600;
+    }
+
     # RFC 8414 root-mounted discovery compatibility for path-based issuers/resources.
     location ~ ^/\.well-known/oauth-authorization-server/(.+)$ {
         rewrite ^/\.well-known/oauth-authorization-server/(.+)$ /$1/.well-known/oauth-authorization-server break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli-v1",
-  "version": "2.2.0-alpha.11",
+  "version": "2.2.0-alpha.12",
   "description": "",
   "license": "Apache-2.0",
   "main": "./src/index.js",
@@ -9,9 +9,9 @@
     "nocobase-v1": "./bin/index.js"
   },
   "dependencies": {
-    "@nocobase/cli": "2.2.0-alpha.11",
+    "@nocobase/cli": "2.2.0-alpha.12",
     "@nocobase/license-kit": "^0.3.8",
-    "@nocobase/utils": "2.2.0-alpha.11",
+    "@nocobase/utils": "2.2.0-alpha.12",
     "chalk": "^4.1.1",
     "commander": "^9.2.0",
     "deepmerge": "^4.3.1",
@@ -33,5 +33,5 @@
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/core/cli"
   },
-  "gitHead": "c9ff1f51e5c33bc6437b64eb779212be71b78f58"
+  "gitHead": "96ae69754a6398de63037ead3a4aad5e5d0ab918"
 }

package/src/__tests__/create-nginx-conf.test.js

@@ -0,0 +1,68 @@
+/**
+ * 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.
+ */
+
+/* eslint-env jest */
+
+const fs = require('fs-extra');
+const os = require('os');
+const path = require('path');
+
+const registerCreateNginxConf = require('../commands/create-nginx-conf');
+
+describe('create-nginx-conf Settings SPA routing', () => {
+  const originalEnv = { ...process.env };
+  let storagePath;
+
+  afterEach(async () => {
+    process.env = { ...originalEnv };
+    if (storagePath) {
+      await fs.remove(storagePath);
+      storagePath = undefined;
+    }
+  });
+
+  async function renderConfig(appPublicPath) {
+    storagePath = await fs.mkdtemp(path.join(os.tmpdir(), 'nocobase-nginx-settings-'));
+    process.env.APP_PUBLIC_PATH = appPublicPath;
+    process.env.APP_MODERN_CLIENT_PREFIX = 'v';
+    process.env.APP_PORT = '13000';
+    process.env.STORAGE_PATH = storagePath;
+
+    let action;
+    registerCreateNginxConf({
+      command() {
+        return {
+          action(callback) {
+            action = callback;
+          },
+        };
+      },
+    });
+    await action();
+    return await fs.readFile(path.join(storagePath, 'nocobase.conf'), 'utf8');
+  }
+
+  test.each([
+    ['root mount', '/', '/settings/assets/', '^/settings(?:/|$)'],
+    ['custom public path', '/nocobase/', '/nocobase/settings/assets/', '^/nocobase/settings(?:/|$)'],
+  ])(
+    'proxies Settings documents and caches Settings assets for %s',
+    async (_label, publicPath, assetsPath, routePattern) => {
+      const config = await renderConfig(publicPath);
+
+      expect(config).toContain(`location ^~ ${assetsPath} {`);
+      expect(config).toContain('dist/client/settings/assets/;');
+      expect(config).toContain('expires 365d;');
+      expect(config).toContain(`location ~ ${routePattern} {`);
+      expect(config).toContain('proxy_pass http://127.0.0.1:13000;');
+      expect(config).not.toContain('location ~ ^/admin/settings');
+      expect(config).toContain('try_files $uri $uri/ /index.html;');
+    },
+  );
+});

package/src/__tests__/dev-command.test.js

@@ -9,7 +9,13 @@
 
 /* eslint-env jest */
 
-const { buildAppDevForwardArgs, forwardDevToAppDev, resolveDevRuntimeMode } = require('../commands/dev')._test;
+const {
+  buildAppDevForwardArgs,
+  createSettingsDevProcessOptions,
+  forwardDevToAppDev,
+  resolveDevRuntimeMode,
+  resolveSettingsDevPort,
+} = require('../commands/dev')._test;
 
 describe('cli-v1 dev command', () => {
   test('buildAppDevForwardArgs rewrites dev argv to app-dev while preserving extra args', () => {
@@ -46,6 +52,7 @@ describe('cli-v1 dev command', () => {
       useModernOnlyEntryMode: false,
       shouldRunClient: true,
       shouldRunClientV2: true,
+      shouldRunSettings: true,
       shouldRunServer: true,
     });
   });
@@ -55,6 +62,7 @@ describe('cli-v1 dev command', () => {
       useModernOnlyEntryMode: true,
       shouldRunClient: false,
       shouldRunClientV2: true,
+      shouldRunSettings: true,
       shouldRunServer: true,
     });
   });
@@ -64,7 +72,37 @@ describe('cli-v1 dev command', () => {
       useModernOnlyEntryMode: false,
       shouldRunClient: false,
       shouldRunClientV2: true,
+      shouldRunSettings: true,
       shouldRunServer: false,
     });
   });
+
+  test('resolveSettingsDevPort reserves APP_PORT + 3 by default', () => {
+    expect(resolveSettingsDevPort(13001)).toBe(13004);
+  });
+
+  test('createSettingsDevProcessOptions uses the standalone config and settings HMR path', () => {
+    expect(
+      createSettingsDevProcessOptions({
+        appPackageRoot: '/repo/packages/core/app',
+        appPort: 13001,
+        settingsPort: 13004,
+        browserPort: 13001,
+        appPublicPath: '/nocobase/',
+        processEnv: { API_BASE_URL: '/api/' },
+      }),
+    ).toMatchObject({
+      command: 'rsbuild',
+      args: ['dev', '--config', '/repo/packages/core/app/client-settings/rsbuild.config.ts'],
+      runOptions: {
+        prefix: 'client-settings',
+        env: {
+          APP_PORT: '13001',
+          APP_SETTINGS_PORT: '13004',
+          RSPACK_HMR_CLIENT_PORT: '13001',
+          RSPACK_HMR_PATH: '/nocobase/settings/__rspack_hmr',
+        },
+      },
+    });
+  });
 });

package/src/__tests__/util.test.js

@@ -9,9 +9,14 @@
 
 /* eslint-env jest */
 
+const { normalizeModernClientPrefix } = require('../util');
 const { colorizedDevLogEnv, createRunWithPrefixLabel } = require('../util')._test;
 
 describe('cli-v1 util helpers', () => {
+  test('normalizeModernClientPrefix reserves the Settings SPA path', () => {
+    expect(() => normalizeModernClientPrefix('/settings/')).toThrow('APP_MODERN_CLIENT_PREFIX "settings" is reserved');
+  });
+
   test('colorizedDevLogEnv enables color for dev child output by default', () => {
     expect(colorizedDevLogEnv({})).toEqual({ FORCE_COLOR: '1' });
   });

package/src/commands/create-nginx-conf.js

@@ -11,6 +11,10 @@ const { resolve, posix } = require('path');
 const { storagePathJoin, resolvePublicPath, resolveV2PublicPath, normalizeModernClientPrefix } = require('../util');
 const { readFileSync, writeFileSync } = require('fs');
 
+function escapeRegExp(value) {
+  return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
 /**
  *
  * @param {Command} cli
@@ -24,6 +28,8 @@ module.exports = (cli) => {
     const modernClientPrefix = normalizeModernClientPrefix(process.env.APP_MODERN_CLIENT_PREFIX);
     const appPublicPathWithoutTrailingSlash = appPublicPath.replace(/\/$/, '');
     const v2PublicPathWithoutTrailingSlash = v2PublicPath.replace(/\/$/, '');
+    const settingsAssetsPath = `${appPublicPath}settings/assets/`;
+    const settingsDocumentPattern = `^${escapeRegExp(appPublicPath)}settings(?:/|$)`;
     const file = resolve(__dirname, '../../nocobase.conf.tpl');
     const data = readFileSync(file, 'utf-8');
     let otherLocation = '';
@@ -64,6 +70,8 @@ module.exports = (cli) => {
       .replace(/\{\{distPath\}\}/g, distPath)
       .replace(/\{\{v2PublicPath\}\}/g, v2PublicPath)
       .replace(/\{\{v2PublicPathNoTrailingSlash\}\}/g, v2PublicPathWithoutTrailingSlash)
+      .replace(/\{\{settingsAssetsPath\}\}/g, settingsAssetsPath)
+      .replace(/\{\{settingsDocumentPattern\}\}/g, settingsDocumentPattern)
       .replace(/\{\{apiPort\}\}/g, process.env.APP_PORT)
       .replace(/\{\{otherLocation\}\}/g, otherLocation);
     const targetFile = storagePathJoin('nocobase.conf');

package/src/commands/dev.js

@@ -48,6 +48,48 @@ function buildAppDevForwardArgs(argv = process.argv) {
   return ['app-dev', ...argv.slice(3)];
 }
 
+function resolveSettingsDevPort(appPort) {
+  return Number(appPort) + 3;
+}
+
+function normalizePublicPath(value) {
+  let normalized = value || '/';
+  if (!normalized.startsWith('/')) {
+    normalized = `/${normalized}`;
+  }
+  if (!normalized.endsWith('/')) {
+    normalized = `${normalized}/`;
+  }
+  return normalized.replace(/\/{2,}/g, '/');
+}
+
+function createSettingsDevProcessOptions({
+  appPackageRoot,
+  appPort,
+  settingsPort,
+  browserPort,
+  appPublicPath,
+  processEnv = process.env,
+}) {
+  const settingsHmrPath = `${normalizePublicPath(appPublicPath)}settings/__rspack_hmr`;
+  return {
+    command: 'rsbuild',
+    args: ['dev', '--config', `${appPackageRoot}/client-settings/rsbuild.config.ts`],
+    runOptions: {
+      prefix: 'client-settings',
+      color: 'yellow',
+      env: {
+        ...processEnv,
+        APP_PORT: `${appPort}`,
+        APP_SETTINGS_PORT: `${settingsPort}`,
+        NODE_ENV: 'development',
+        RSPACK_HMR_CLIENT_PORT: `${browserPort}`,
+        RSPACK_HMR_PATH: settingsHmrPath,
+      },
+    },
+  };
+}
+
 function resolveDevRuntimeMode(opts = {}) {
   const appClientEntryMode = opts.appClientEntryMode || resolveAppClientEntryMode();
   const useModernOnlyEntryMode = appClientEntryMode === 'modern-only';
@@ -57,6 +99,7 @@ function resolveDevRuntimeMode(opts = {}) {
   const shouldRunClientV2 = clientV2Only || useModernOnlyEntryMode || forceClient || !forceServer;
   const shouldRunClient = !clientV2Only && !useModernOnlyEntryMode && (forceClient || !forceServer);
   const shouldRunServer = !clientV2Only && (forceServer || !forceClient || useModernOnlyEntryMode);
+  const shouldRunSettings = shouldRunClientV2;
 
   return {
     appClientEntryMode,
@@ -64,6 +107,7 @@ function resolveDevRuntimeMode(opts = {}) {
     shouldRunClientV2,
     shouldRunClient,
     shouldRunServer,
+    shouldRunSettings,
   };
 }
 
@@ -124,13 +168,18 @@ module.exports = (cli) => {
       let clientPort = APP_PORT;
       let serverPort;
       let clientV2Port = APP_PORT;
+      let settingsPort = resolveSettingsDevPort(APP_PORT);
 
       nodeCheck();
       await postCheck(opts);
 
-      const { useModernOnlyEntryMode, shouldRunClientV2, shouldRunClient, shouldRunServer } = resolveDevRuntimeMode(
-        opts,
-      );
+      const {
+        useModernOnlyEntryMode,
+        shouldRunClientV2,
+        shouldRunClient,
+        shouldRunServer,
+        shouldRunSettings,
+      } = resolveDevRuntimeMode(opts);
       const shouldRunClientWithRsbuild = shouldRunClient && !!rsbuild;
 
       if (shouldRunServer && server) {
@@ -151,8 +200,15 @@ module.exports = (cli) => {
         clientV2Port = APP_PORT;
       }
 
+      if (shouldRunSettings) {
+        settingsPort = await getPortPromise({
+          port: resolveSettingsDevPort(APP_PORT),
+        });
+      }
+
       let subprocessClient;
       let subprocessClientV2;
+      let subprocessSettings;
 
       const runDevClientV2 = () => {
         console.log('starting client-v2', 1 * clientV2Port);
@@ -165,6 +221,7 @@ module.exports = (cli) => {
             env: {
               ...process.env,
               APP_V2_PORT: `${clientV2Port}`,
+              APP_SETTINGS_PORT: `${settingsPort}`,
               NODE_ENV: 'development',
               RSPACK_HMR_CLIENT_PORT: `${clientV2Only ? clientV2Port : clientPort}`,
               API_BASE_URL: process.env.API_BASE_URL || process.env.API_BASE_PATH,
@@ -182,8 +239,34 @@ module.exports = (cli) => {
         );
       };
 
+      const runDevSettings = () => {
+        console.log('starting client-settings', 1 * settingsPort);
+        const { command, args, runOptions } = createSettingsDevProcessOptions({
+          appPackageRoot: APP_PACKAGE_ROOT,
+          appPort: APP_PORT,
+          settingsPort,
+          browserPort: clientV2Only ? clientV2Port : clientPort,
+          appPublicPath: process.env.APP_PUBLIC_PATH,
+          processEnv: {
+            ...process.env,
+            API_BASE_URL: process.env.API_BASE_URL || process.env.API_BASE_PATH,
+            API_CLIENT_STORAGE_PREFIX: process.env.API_CLIENT_STORAGE_PREFIX,
+            API_CLIENT_STORAGE_TYPE: process.env.API_CLIENT_STORAGE_TYPE,
+            API_CLIENT_SHARE_TOKEN: process.env.API_CLIENT_SHARE_TOKEN || 'false',
+            WEBSOCKET_URL: process.env.WEBSOCKET_URL || buildWSURL(process.env.API_BASE_URL, serverPort),
+            WS_PATH: process.env.WS_PATH,
+            ESM_CDN_BASE_URL: process.env.ESM_CDN_BASE_URL || 'https://esm.sh',
+            ESM_CDN_SUFFIX: process.env.ESM_CDN_SUFFIX || '',
+            PROXY_TARGET_URL:
+              process.env.PROXY_TARGET_URL || (serverPort ? `http://127.0.0.1:${serverPort}` : undefined),
+          },
+        });
+        subprocessSettings = runWithPrefix(command, args, runOptions);
+      };
+
       if (clientV2Only) {
         runDevClientV2();
+        runDevSettings();
         return;
       }
 
@@ -204,6 +287,7 @@ module.exports = (cli) => {
             APP_PORT: `${clientPort}`,
             APP_ROOT: `${APP_PACKAGE_ROOT}/client`,
             APP_V2_PORT: `${clientV2Port}`,
+            APP_SETTINGS_PORT: `${settingsPort}`,
             NODE_ENV: 'development',
             RSPACK_HMR_CLIENT_PORT: `${clientPort}`,
             API_BASE_URL: process.env.API_BASE_URL || process.env.API_BASE_PATH,
@@ -256,6 +340,9 @@ module.exports = (cli) => {
           if (shouldRunClientV2) {
             await restartSubprocess(subprocessClientV2, clientV2Port, runDevClientV2);
           }
+          if (shouldRunSettings) {
+            await restartSubprocess(subprocessSettings, settingsPort, runDevSettings);
+          }
           await fs.promises.writeFile(process.env.WATCH_FILE, `export const watchId = '${uid()}';`, 'utf-8');
         }, 500);
 
@@ -325,11 +412,17 @@ module.exports = (cli) => {
       if (shouldRunClientV2) {
         runDevClientV2();
       }
+
+      if (shouldRunSettings) {
+        runDevSettings();
+      }
     });
 };
 
 module.exports._test = {
   buildAppDevForwardArgs,
+  createSettingsDevProcessOptions,
   forwardDevToAppDev,
   resolveDevRuntimeMode,
+  resolveSettingsDevPort,
 };

package/src/util.js

@@ -462,7 +462,11 @@ function normalizeModernClientPrefix(value) {
   const segment = String(value || '')
     .trim()
     .replace(/^\/+|\/+$/g, '');
-  return segment || DEFAULT_MODERN_CLIENT_PREFIX;
+  const normalized = segment || DEFAULT_MODERN_CLIENT_PREFIX;
+  if (normalized === 'settings') {
+    throw new Error('APP_MODERN_CLIENT_PREFIX "settings" is reserved for the standalone Settings application.');
+  }
+  return normalized;
 }
 
 exports.normalizeModernClientPrefix = normalizeModernClientPrefix;