@nocobase/cli 2.0.0-alpha.9 → 2.0.0-beta.1

package/nocobase.conf.tpl

@@ -73,7 +73,10 @@ server {
         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 $scheme;
         proxy_set_header Host $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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli",
-  "version": "2.0.0-alpha.9",
+  "version": "2.0.0-beta.1",
   "description": "",
   "license": "AGPL-3.0",
   "main": "./src/index.js",
@@ -8,8 +8,8 @@
     "nocobase": "./bin/index.js"
   },
   "dependencies": {
-    "@nocobase/app": "2.0.0-alpha.9",
-    "@nocobase/license-kit": "^0.2.17",
+    "@nocobase/app": "2.0.0-beta.1",
+    "@nocobase/license-kit": "^0.3.5",
     "@types/fs-extra": "^11.0.1",
     "@umijs/utils": "3.5.20",
     "chalk": "^4.1.1",
@@ -27,12 +27,12 @@
     "tsx": "^4.19.0"
   },
   "devDependencies": {
-    "@nocobase/devtools": "2.0.0-alpha.9"
+    "@nocobase/devtools": "2.0.0-beta.1"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/core/cli"
   },
-  "gitHead": "4a9acf96f21a3aa35bccbd188b942595b09da0a9"
+  "gitHead": "b3d1f65848fc91e673372ee734dafe6b1cf80586"
 }

package/src/commands/instance-id.js

@@ -13,6 +13,7 @@ const { run, isDev } = require('../util');
 const { getInstanceIdAsync } = require('@nocobase/license-kit');
 const path = require('path');
 const fs = require('fs');
+const { logger } = require('../logger');
 
 /**
  *
@@ -24,11 +25,11 @@ module.exports = (cli) => {
     .description('Generate InstanceID')
     .option('--force', 'Force generate InstanceID')
     .action(async (options) => {
-      console.log('Generating InstanceID...');
+      logger.info('Generating InstanceID...');
       const dir = path.resolve(process.cwd(), 'storage/.license');
       const filePath = path.resolve(dir, 'instance-id');
       if (fs.existsSync(filePath) && !options.force) {
-        console.log('InstanceID already exists at ' + filePath);
+        logger.info('InstanceID already exists at ' + filePath);
         return;
       } else {
         if (!fs.existsSync(dir)) {
@@ -37,9 +38,9 @@ module.exports = (cli) => {
         try {
           const instanceId = await getInstanceIdAsync();
           fs.writeFileSync(filePath, instanceId + '\n');
-          console.log(chalk.greenBright(`InstanceID saved to ${filePath}`));
+          logger.info(`InstanceID saved to ${filePath}`);
         } catch (e) {
-          console.log(e);
+          logger.error('Failed to generate InstanceID', e.message || e);
         }
       }
     });

package/src/commands/perf.js

@@ -53,8 +53,8 @@ module.exports = (cli) => {
           dotenv.config({ path: envFilePath, override: true });
         }
       }
-      if (!process.env.API_BASE_URL) {
-        throw new Error('Please set API_BASE_URL in environment variables or in .env.perf file');
+      if (!process.env.TARGET_ORIGIN) {
+        throw new Error('Please set TARGET_ORIGIN in environment variables or in .env.perf file');
       }
       const args = command.args.filter((arg) => arg !== file);
       await run(`k6`, ['run', f, ...(args.length ? ['--', ...args] : [])]);

package/src/commands/pkg.js

@@ -14,8 +14,8 @@ const zlib = require('zlib');
 const tar = require('tar');
 const path = require('path');
 const { createStoragePluginsSymlink } = require('@nocobase/utils/plugin-symlink');
-const chalk = require('chalk');
-const { getAccessKeyPair, showLicenseInfo, LicenseKeyError } = require('../util');
+const { getAccessKeyPair, showLicenseInfo, LicenseKeyError } = require('../license');
+const { logger } = require('../logger');
 
 class Package {
   data;
@@ -78,7 +78,7 @@ class Package {
     }
 
     if (!this.data.versions[version]) {
-      console.log(chalk.redBright(`Download failed: ${this.packageName}@${version} package does not exist`));
+      logger.error(`Download failed: ${this.packageName}@${version} package does not exist`);
     }
 
     return [version, this.data.versions[version].dist.tarball];
@@ -99,7 +99,7 @@ class Package {
   async isDepPackage() {
     const pkg1 = path.resolve(process.cwd(), 'node_modules', this.packageName, 'package.json');
     const pkg2 = path.resolve(process.cwd(), process.env.PLUGIN_STORAGE_PATH, this.packageName, 'package.json');
-    if (await fs.exists(pkg1) && await fs.exists(pkg2)) {
+    if ((await fs.exists(pkg1)) && (await fs.exists(pkg2))) {
       const readPath1 = fs.realpathSync(pkg1);
       const readPath2 = fs.realpathSync(pkg2);
       if (readPath1 !== readPath2) {
@@ -122,11 +122,11 @@ class Package {
 
   async download(options = {}) {
     if (await this.isDevPackage()) {
-      console.log(chalk.yellowBright(`Skipped: ${this.packageName} is dev package`));
+      logger.info(`Skipped: ${this.packageName} is dev package`);
       return;
     }
     if (await this.isDepPackage()) {
-      console.log(chalk.yellowBright(`Skipped: ${this.packageName} is dependency package`));
+      logger.info(`Skipped: ${this.packageName} is dependency package`);
       return;
     }
     if (await this.isDownloaded(options.version)) {
@@ -134,7 +134,7 @@ class Package {
     }
     await this.getInfo();
     if (!this.data) {
-      console.log(chalk.redBright(`Download failed: ${this.packageName} package does not exist`));
+      logger.error(`Download failed: ${this.packageName} package does not exist`);
       return;
     }
     try {
@@ -158,7 +158,7 @@ class Package {
           .on('finish', resolve)
           .on('error', reject);
       });
-      console.log(chalk.greenBright(`Downloaded: ${this.packageName}@${version}`));
+      logger.info(`Downloaded: ${this.packageName}@${version}`);
     } catch (error) {
       if (error?.response?.data && typeof error?.response?.data?.pipe === 'function') {
         let errorMessageBuffer = '';
@@ -167,11 +167,11 @@ class Package {
         });
         error.response.data.on?.('end', () => {
           if (error.response.status === 403) {
-            console.error(chalk.redBright('You do not have permission to download this package version.'));
+            logger.error('You do not have permission to download this package version.');
           }
         });
       }
-      console.log(chalk.redBright(`Download failed: ${this.packageName}`));
+      logger.error(`Download failed: ${this.packageName}`);
     }
   }
 }
@@ -202,12 +202,13 @@ class PackageManager {
         responseType: 'json',
       });
       this.token = res1.data.token;
+      logger.info('Login success');
     } catch (error) {
       if (error?.response?.data?.error === 'license not valid') {
         showLicenseInfo(LicenseKeyError.notValid);
       }
-      console.error(chalk.redBright(`Login failed: ${this.baseURL}`));
-      console.error(error);
+      logger.error(`Login failed: ${this.baseURL}`);
+      logger.error(error?.message || error);
     }
   }
 
@@ -244,7 +245,7 @@ class PackageManager {
     const dir = path.resolve(process.env.PLUGIN_STORAGE_PATH, packageName);
     const r = await fs.exists(dir);
     if (r) {
-      console.log(chalk.yellowBright(`Removed: ${packageName}`));
+      logger.info(`Removed: ${packageName}`);
       await fs.rm(dir, { force: true, recursive: true });
     }
   }
@@ -260,9 +261,11 @@ class PackageManager {
         await this.removePackage(pkg);
       }
     }
+    logger.info(`Download plugins...`);
     for (const pkg of licensed_plugins) {
       await this.getPackage(pkg).download({ version });
     }
+    logger.info('Download plugins done');
   }
 }
 
@@ -286,8 +289,14 @@ module.exports = (cli) => {
       try {
         ({ accessKeyId, accessKeySecret } = await getAccessKeyPair());
       } catch (e) {
+        // logger.error('Get AccessKey Pair error', e);
         return;
       }
+      if (NOCOBASE_PKG_USERNAME && NOCOBASE_PKG_PASSWORD && !accessKeyId && !accessKeySecret) {
+        logger.warn(
+          'NOCOBASE_PKG_USERNAME and NOCOBASE_PKG_PASSWORD will be deprecated in future versions. Please log in to NocoBase Service and refer to the documentation to learn how to install and upgrade commercial plugins.\n',
+        );
+      }
       if (!(NOCOBASE_PKG_USERNAME && NOCOBASE_PKG_PASSWORD) && !(accessKeyId && accessKeySecret)) {
         return;
       }
@@ -302,6 +311,6 @@ module.exports = (cli) => {
       await createStoragePluginsSymlink();
     });
   pkg.command('export-all').action(async () => {
-    console.log('Todo...');
+    logger.info('Todo...');
   });
 };

package/src/commands/start.js

@@ -56,32 +56,34 @@ module.exports = (cli) => {
         await downloadPro();
       }
 
-      const watcher = chokidar.watch('./storage/plugins/**/*', {
-        cwd: process.cwd(),
-        ignoreInitial: true,
-        ignored: /(^|[\/\\])\../, // 忽略隐藏文件
-        persistent: true,
-        depth: 1, // 只监听第一层目录
-      });
+      if (process.env.NO_WATCH_PLUGINS === true || process.env.NO_WATCH_PLUGINS === 'true') {
+        const restart = _.debounce(async () => {
+          console.log('restarting...');
+          await run('yarn', ['nocobase', 'pm2-restart']);
+        }, 500);
 
-      const restart = _.debounce(async () => {
-        console.log('restarting...');
-        await run('yarn', ['nocobase', 'pm2-restart']);
-      }, 500);
-
-      watcher
-        .on('ready', () => {
-          isReady = true;
-        })
-        .on('addDir', async (pathname) => {
-          if (!isReady) return;
-          restart();
-        })
-        .on('unlinkDir', async (pathname) => {
-          if (!isReady) return;
-          restart();
+        const watcher = chokidar.watch('./storage/plugins/**/*', {
+          cwd: process.cwd(),
+          ignoreInitial: true,
+          ignored: /(^|[\/\\])\../, // 忽略隐藏文件
+          persistent: true,
+          depth: 1, // 只监听第一层目录
         });
 
+        watcher
+          .on('ready', () => {
+            isReady = true;
+          })
+          .on('addDir', async (pathname) => {
+            if (!isReady) return;
+            restart();
+          })
+          .on('unlinkDir', async (pathname) => {
+            if (!isReady) return;
+            restart();
+          });
+      }
+
       if (opts.port) {
         process.env.APP_PORT = opts.port;
       }

package/src/commands/test.js

@@ -54,7 +54,7 @@ function addTestCommand(name, cli) {
       const first = paths?.[0];
       if (!process.env.TEST_ENV && first) {
         const key = first.split(path.sep).join('/');
-        if (key.includes('/client/') || key.includes('/flow-engine/')) {
+        if (key.includes('/client/') || key.includes('/client-v2/') || key.includes('/flow-engine/')) {
           process.env.TEST_ENV = 'client-side';
         } else {
           process.env.TEST_ENV = 'server-side';

package/src/license.js

@@ -0,0 +1,76 @@
+/**
+ * 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.
+ */
+
+const chalk = require('chalk');
+const { resolve } = require('path');
+const fs = require('fs-extra');
+const { keyDecrypt, getEnvAsync } = require('@nocobase/license-kit');
+const { isEnvMatch } = require('@nocobase/plugin-license/utils/env');
+const { logger } = require('./logger');
+const { pick } = require('lodash');
+
+exports.getAccessKeyPair = async function () {
+  const keyFile = resolve(process.cwd(), 'storage/.license/license-key');
+  if (!fs.existsSync(keyFile)) {
+    logger.error('License key not found');
+    return {};
+  }
+  logger.info('License key found');
+  let keyData = {};
+  try {
+    const str = fs.readFileSync(keyFile, 'utf-8');
+    const keyDataStr = keyDecrypt(str);
+    keyData = JSON.parse(keyDataStr);
+  } catch (error) {
+    showLicenseInfo(LicenseKeyError.parseFailed);
+    throw new Error(LicenseKeyError.parseFailed.title);
+  }
+  const env = await getEnvAsync();
+  const isEnvMatched = await isEnvMatch(env, keyData);
+  if (!isEnvMatched) {
+    showLicenseInfo({
+      ...LicenseKeyError.notMatch,
+      env,
+    });
+    throw new Error(LicenseKeyError.notMatch.title);
+  }
+  const { accessKeyId, accessKeySecret } = keyData;
+  return { accessKeyId, accessKeySecret };
+};
+
+const LicenseKeyError = {
+  notExist: {
+    title: 'License key not found',
+    content:
+      'Please go to the license settings page to obtain the Instance ID for the current environment, and then generate the license key on the service platform.',
+  },
+  parseFailed: {
+    title: 'Invalid license key format',
+    content: 'Please check your license key, or regenerate the license key on the service platform.',
+  },
+  notMatch: {
+    title: 'License key not match current environment',
+    content:
+      'Please go to the license settings page to obtain the Instance ID for the current environment, and then regenerate the license key on the service platform.',
+  },
+  notValid: {
+    title: 'Invalid license key',
+    content:
+      'Please go to the license settings page to obtain the Instance ID for the current environment, and then regenerate the license key on the service platform.',
+  },
+};
+
+exports.LicenseKeyError = LicenseKeyError;
+
+function showLicenseInfo({ title, content, env }) {
+  logger.error(title + '. ' + content);
+  logger.error('Current environment', pick(env, ['sys', 'osVer', 'db']));
+}
+
+exports.showLicenseInfo = showLicenseInfo;

package/src/logger.js

@@ -0,0 +1,75 @@
+/**
+ * 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.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const winston = require('winston');
+require('winston-daily-rotate-file');
+
+function ensureDir(dir) {
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+}
+
+function createSystemLogger({ dirname, filename, defaultMeta = {} }) {
+  ensureDir(dirname);
+
+  const commonFormat = winston.format.combine(
+    winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
+    winston.format.printf((info) => {
+      const meta = info.meta ? JSON.stringify(info.meta) : '';
+      return `${info.timestamp} [${info.level}] ${info.message} ${meta}`;
+    }),
+  );
+
+  const consoleFormat = winston.format.combine(winston.format.colorize(), commonFormat);
+
+  const fileTransport = new winston.transports.DailyRotateFile({
+    dirname,
+    filename: `${filename}_%DATE%.log`,
+    datePattern: 'YYYY-MM-DD',
+    zippedArchive: false,
+    format: commonFormat,
+  });
+
+  const consoleTransport = new winston.transports.Console({
+    format: consoleFormat,
+  });
+
+  const logger = winston.createLogger({
+    level: 'info',
+    transports: [consoleTransport, fileTransport],
+    defaultMeta,
+  });
+
+  const wrap = (level) => (message, meta) => {
+    logger.log({ level, message, meta });
+    return logger;
+  };
+
+  return {
+    info: wrap('info'),
+    warn: wrap('warn'),
+    error: wrap('error'),
+  };
+}
+
+const getLoggerFilePath = (...paths) => {
+  return path.resolve(process.env.LOGGER_BASE_PATH || path.resolve(process.cwd(), 'storage', 'logs'), ...paths);
+};
+
+const logger = createSystemLogger({
+  dirname: getLoggerFilePath('main'),
+  filename: 'system',
+});
+
+module.exports = {
+  logger,
+};

package/src/util.js

@@ -18,8 +18,6 @@ const dotenv = require('dotenv');
 const fs = require('fs-extra');
 const os = require('os');
 const moment = require('moment-timezone');
-const { keyDecrypt, getEnvAsync } = require('@nocobase/license-kit');
-const omit = require('lodash/omit');
 
 exports.isPackageValid = (pkg) => {
   try {
@@ -490,89 +488,3 @@ exports.generatePlugins = function () {
     return;
   }
 };
-
-async function isEnvMatch(keyData) {
-  const env = await getEnvAsync();
-  if (env?.container?.id && keyData?.instanceData?.container?.id) {
-    return (
-      JSON.stringify(omit(env, ['timestamp', 'container', 'hostname', 'mac'])) ===
-      JSON.stringify(omit(keyData?.instanceData, ['timestamp', 'container', 'hostname', 'mac']))
-    );
-  }
-  return (
-    JSON.stringify(omit(env, ['timestamp', 'mac'])) ===
-    JSON.stringify(omit(keyData?.instanceData, ['timestamp', 'mac']))
-  );
-}
-
-exports.getAccessKeyPair = async function () {
-  const keyFile = resolve(process.cwd(), 'storage/.license/license-key');
-  if (!fs.existsSync(keyFile)) {
-    return {};
-  }
-
-  let keyData = {};
-  try {
-    const str = fs.readFileSync(keyFile, 'utf-8');
-    const keyDataStr = keyDecrypt(str);
-    keyData = JSON.parse(keyDataStr);
-  } catch (error) {
-    showLicenseInfo(LicenseKeyError.parseFailed);
-    throw new Error(LicenseKeyError.parseFailed.title);
-  }
-
-  const isEnvMatched = await isEnvMatch(keyData);
-  if (!isEnvMatched) {
-    showLicenseInfo(LicenseKeyError.notMatch);
-    throw new Error(LicenseKeyError.notMatch.title);
-  }
-
-  const { accessKeyId, accessKeySecret } = keyData;
-  return { accessKeyId, accessKeySecret };
-};
-
-const LicenseKeyError = {
-  notExist: {
-    title: 'License key not found',
-    content:
-      'Please go to the license settings page to obtain the Instance ID for the current environment, and then generate the license key on the service platform.',
-  },
-  parseFailed: {
-    title: 'Invalid license key format',
-    content: 'Please check your license key, or regenerate the license key on the service platform.',
-  },
-  notMatch: {
-    title: 'License key mismatch',
-    content:
-      'Please go to the license settings page to obtain the Instance ID for the current environment, and then regenerate the license key on the service platform.',
-  },
-  notValid: {
-    title: 'Invalid license key',
-    content:
-      'Please go to the license settings page to obtain the Instance ID for the current environment, and then regenerate the license key on the service platform.',
-  },
-};
-
-exports.LicenseKeyError = LicenseKeyError;
-
-function showLicenseInfo({ title, content }) {
-  const rows = [];
-  const length = 80;
-  let row = '';
-  content.split(' ').forEach((word) => {
-    if (row.length + word.length > length) {
-      rows.push(row);
-      row = '';
-    }
-    row += word + ' ';
-  });
-  if (row) {
-    rows.push(row);
-  }
-  console.log(Array(length).fill('-').join(''));
-  console.log(chalk.yellow(title));
-  console.log(chalk.yellow(rows.join('\n')));
-  console.log(Array(length).fill('-').join(''));
-}
-
-exports.showLicenseInfo = showLicenseInfo;

package/templates/plugin/package.json.tpl

@@ -4,8 +4,8 @@
   "main": "dist/server/index.js",
   "dependencies": {},
   "peerDependencies": {
-    "@nocobase/client": "1.x",
-    "@nocobase/server": "1.x",
-    "@nocobase/test": "1.x"
+    "@nocobase/client": "2.x",
+    "@nocobase/server": "2.x",
+    "@nocobase/test": "2.x"
   }
 }