@nocobase/cli 1.7.0-beta.8 → 1.8.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli",
-  "version": "1.7.0-beta.8",
+  "version": "1.8.0-beta.1",
   "description": "",
   "license": "AGPL-3.0",
   "main": "./src/index.js",
@@ -8,29 +8,30 @@
     "nocobase": "./bin/index.js"
   },
   "dependencies": {
-    "@nocobase/app": "1.7.0-beta.8",
+    "@nocobase/app": "1.8.0-beta.1",
     "@types/fs-extra": "^11.0.1",
     "@umijs/utils": "3.5.20",
     "chalk": "^4.1.1",
     "commander": "^9.2.0",
+    "deepmerge": "^4.3.1",
     "dotenv": "^16.0.0",
     "execa": "^5.1.1",
     "fast-glob": "^3.3.1",
     "fs-extra": "^11.1.1",
     "p-all": "3.0.0",
-    "pm2": "^5.2.0",
+    "pm2": "^6.0.5",
     "portfinder": "^1.0.28",
-    "serve": "^13.0.2",
+    "tar": "^7.4.3",
     "tree-kill": "^1.2.2",
     "tsx": "^4.19.0"
   },
   "devDependencies": {
-    "@nocobase/devtools": "1.7.0-beta.8"
+    "@nocobase/devtools": "1.8.0-beta.1"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/core/cli"
   },
-  "gitHead": "9ad35ee90db98d95dfa660645d155f4f4e81b47c"
+  "gitHead": "103935669123174f2942247202e3d9ff15f0d4ed"
 }

package/src/commands/benchmark.js

@@ -0,0 +1,73 @@
+/**
+ * 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 glob = require('fast-glob');
+const { Command } = require('commander');
+const { run } = require('../util');
+
+/**
+ *
+ * @param {Command} cli
+ */
+module.exports = (cli) => {
+  return (
+    cli
+      .command('benchmark')
+      .description('Run benchmark tests')
+      // .option('--single-thread [singleThread]')
+      .option('-a, --all [all]', 'Run all benchmark files which ends with .benchmark.{js,ts}')
+      .arguments('[paths...]')
+      .allowUnknownOption()
+      .action(async (paths, opts) => {
+        process.env.NODE_ENV = 'test';
+        process.env.LOGGER_LEVEL = 'error';
+
+        const cliArgs = ['--max_old_space_size=14096'];
+
+        // if (process.argv.includes('-h') || process.argv.includes('--help')) {
+        //   await run('node', cliArgs);
+        //   return;
+        // }
+
+        // if (!opts.singleThread) {
+        //   process.argv.splice(process.argv.indexOf('--single-thread=false'), 1);
+        // } else {
+        //   process.argv.push('--poolOptions.threads.singleThread=true');
+        // }
+
+        if (!paths.length) {
+          if (opts.all) {
+            paths.push('**/*.benchmark.ts');
+          } else {
+            console.warn(
+              'No benchmark files specified. Please provide at least 1 benchmark file or path to run. Or use --all to run all "*.benchmark.ts".',
+            );
+            return;
+          }
+        }
+
+        const files = [];
+
+        for (const pattern of paths) {
+          for (const file of glob.sync(pattern)) {
+            files.push(file);
+          }
+        }
+
+        if (!files.length) {
+          console.log('No benchmark files found');
+          return;
+        }
+
+        for (const file of files) {
+          await run('tsx', [...cliArgs, file]);
+        }
+      })
+  );
+};

package/src/commands/dev.js

@@ -8,7 +8,7 @@
  */
 const _ = require('lodash');
 const { Command } = require('commander');
-const { generatePlugins, run, postCheck, nodeCheck, promptForTs, isPortReachable } = require('../util');
+const { generatePlugins, run, postCheck, nodeCheck, promptForTs, isPortReachable, checkDBDialect } = require('../util');
 const { getPortPromise } = require('portfinder');
 const chokidar = require('chokidar');
 const { uid } = require('@formily/shared');
@@ -36,6 +36,7 @@ module.exports = (cli) => {
     .option('-i, --inspect [port]')
     .allowUnknownOption()
     .action(async (opts) => {
+      checkDBDialect();
       let subprocess;
       const runDevClient = () => {
         console.log('starting client', 1 * clientPort);

package/src/commands/e2e.js

@@ -8,7 +8,7 @@
  */
 
 const { Command } = require('commander');
-const { run, isPortReachable } = require('../util');
+const { run, isPortReachable, checkDBDialect } = require('../util');
 const { execSync } = require('node:child_process');
 const axios = require('axios');
 const { pTest } = require('./p-test');
@@ -165,6 +165,7 @@ const filterArgv = () => {
  */
 module.exports = (cli) => {
   const e2e = cli.command('e2e').hook('preAction', () => {
+    checkDBDialect();
     if (process.env.APP_BASE_URL) {
       process.env.APP_BASE_URL = process.env.APP_BASE_URL.replace('localhost', '127.0.0.1');
       console.log('APP_BASE_URL:', process.env.APP_BASE_URL);

package/src/commands/global.js

@@ -8,7 +8,7 @@
  */
 
 const { Command } = require('commander');
-const { run, isDev, isProd, promptForTs, downloadPro } = require('../util');
+const { run, isDev, isProd, promptForTs, downloadPro, checkDBDialect } = require('../util');
 
 /**
  *
@@ -21,6 +21,7 @@ module.exports = (cli) => {
     .option('-h, --help')
     .option('--ts-node-dev')
     .action(async (options) => {
+      checkDBDialect();
       const cmd = process.argv.slice(2)?.[0];
       if (cmd === 'install') {
         await downloadPro();

package/src/commands/index.js

@@ -29,7 +29,9 @@ module.exports = (cli) => {
   require('./pm2')(cli);
   require('./test')(cli);
   require('./test-coverage')(cli);
+  require('./benchmark')(cli);
   require('./umi')(cli);
+  require('./update-deps')(cli);
   require('./upgrade')(cli);
   require('./postinstall')(cli);
   require('./pkg')(cli);

package/src/commands/start.js

@@ -8,7 +8,7 @@
  */
 const _ = require('lodash');
 const { Command } = require('commander');
-const { run, postCheck, downloadPro, promptForTs } = require('../util');
+const { run, postCheck, downloadPro, promptForTs, checkDBDialect } = require('../util');
 const { existsSync, rmSync } = require('fs');
 const { resolve, isAbsolute } = require('path');
 const chalk = require('chalk');
@@ -48,8 +48,10 @@ module.exports = (cli) => {
     .option('-i, --instances [instances]')
     .option('--db-sync')
     .option('--quickstart')
+    .option('--launch-mode [launchMode]')
     .allowUnknownOption()
     .action(async (opts) => {
+      checkDBDialect();
       if (opts.quickstart) {
         await downloadPro();
       }
@@ -118,17 +120,27 @@ module.exports = (cli) => {
         ]);
         process.exit();
       } else {
-        run(
-          'pm2-runtime',
-          [
-            'start',
-            ...instancesArgs,
-            `${APP_PACKAGE_ROOT}/lib/index.js`,
-            NODE_ARGS ? `--node-args="${NODE_ARGS}"` : undefined,
-            '--',
-            ...process.argv.slice(2),
-          ].filter(Boolean),
-        );
+        const launchMode = opts.launchMode || process.env.APP_LAUNCH_MODE || 'pm2';
+        if (launchMode === 'pm2') {
+          run(
+            'pm2-runtime',
+            [
+              'start',
+              ...instancesArgs,
+              `${APP_PACKAGE_ROOT}/lib/index.js`,
+              NODE_ARGS ? `--node-args="${NODE_ARGS}"` : undefined,
+              '--',
+              ...process.argv.slice(2),
+            ].filter(Boolean),
+          );
+        } else {
+          run(
+            'node',
+            [`${APP_PACKAGE_ROOT}/lib/index.js`, ...(NODE_ARGS || '').split(' '), ...process.argv.slice(2)].filter(
+              Boolean,
+            ),
+          );
+        }
       }
     });
 };

package/src/commands/test-coverage.js

@@ -7,7 +7,7 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-const { run } = require('../util');
+const { run, checkDBDialect } = require('../util');
 const fg = require('fast-glob');
 
 const coreClientPackages = ['packages/core/client', 'packages/core/sdk'];
@@ -30,6 +30,7 @@ const getPackagesDir = (isClient) => {
 
 module.exports = (cli) => {
   cli.command('test-coverage:server').action(async () => {
+    checkDBDialect();
     const packageRoots = getPackagesDir(false);
     for (const dir of packageRoots) {
       try {
@@ -41,6 +42,7 @@ module.exports = (cli) => {
   });
 
   cli.command('test-coverage:client').action(async () => {
+    checkDBDialect();
     const packageRoots = getPackagesDir(true);
     for (const dir of packageRoots) {
       try {

package/src/commands/test.js

@@ -8,7 +8,7 @@
  */
 
 const { Command } = require('commander');
-const { run } = require('../util');
+const { run, checkDBDialect } = require('../util');
 const path = require('path');
 
 /**
@@ -29,6 +29,7 @@ function addTestCommand(name, cli) {
     .arguments('[paths...]')
     .allowUnknownOption()
     .action(async (paths, opts) => {
+      checkDBDialect();
       if (name === 'test:server') {
         process.env.TEST_ENV = 'server-side';
       } else if (name === 'test:client') {

package/src/commands/update-deps.js

@@ -0,0 +1,71 @@
+/**
+ * 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 { Command } = require('commander');
+const { resolve } = require('path');
+const { run, promptForTs, runAppCommand, hasCorePackages, downloadPro, hasTsNode, checkDBDialect } = require('../util');
+const { existsSync, rmSync } = require('fs');
+const { readJSON, writeJSON } = require('fs-extra');
+const deepmerge = require('deepmerge');
+
+const rmAppDir = () => {
+  // If ts-node is not installed, do not do the following
+  const appDevDir = resolve(process.cwd(), './storage/.app-dev');
+  if (existsSync(appDevDir)) {
+    rmSync(appDevDir, { recursive: true, force: true });
+  }
+};
+
+/**
+ *
+ * @param {Command} cli
+ */
+module.exports = (cli) => {
+  cli
+    .command('update-deps')
+    .option('--force')
+    .allowUnknownOption()
+    .action(async (options) => {
+      if (hasCorePackages() || !hasTsNode()) {
+        await downloadPro();
+        return;
+      }
+      const pkg = require('../../package.json');
+      let distTag = 'latest';
+      if (pkg.version.includes('alpha')) {
+        distTag = 'alpha';
+      } else if (pkg.version.includes('beta')) {
+        distTag = 'beta';
+      }
+      const { stdout } = await run('npm', ['info', `@nocobase/cli@${distTag}`, 'version'], {
+        stdio: 'pipe',
+      });
+      if (!options.force && pkg.version === stdout) {
+        await downloadPro();
+        rmAppDir();
+        return;
+      }
+      const descPath = resolve(process.cwd(), 'package.json');
+      const descJson = await readJSON(descPath, 'utf8');
+      const sourcePath = resolve(__dirname, '../../templates/create-app-package.json');
+      const sourceJson = await readJSON(sourcePath, 'utf8');
+      if (descJson['dependencies']?.['@nocobase/cli']) {
+        descJson['dependencies']['@nocobase/cli'] = stdout;
+      }
+      if (descJson['devDependencies']?.['@nocobase/devtools']) {
+        descJson['devDependencies']['@nocobase/devtools'] = stdout;
+      }
+      const json = deepmerge(descJson, sourceJson);
+      await writeJSON(descPath, json, { spaces: 2, encoding: 'utf8' });
+      await run('yarn', ['install']);
+      await downloadPro();
+      rmAppDir();
+    });
+};

package/src/commands/upgrade.js

@@ -10,15 +10,25 @@
 const chalk = require('chalk');
 const { Command } = require('commander');
 const { resolve } = require('path');
-const { run, promptForTs, runAppCommand, hasCorePackages, downloadPro, hasTsNode } = require('../util');
+const { run, promptForTs, runAppCommand, hasCorePackages, downloadPro, hasTsNode, checkDBDialect } = require('../util');
 const { existsSync, rmSync } = require('fs');
+const { readJSON, writeJSON } = require('fs-extra');
+const deepmerge = require('deepmerge');
+
+async function updatePackage() {
+  const sourcePath = resolve(__dirname, '../../templates/create-app-package.json');
+  const descPath = resolve(process.cwd(), 'package.json');
+  const sourceJson = await readJSON(sourcePath, 'utf8');
+  const descJson = await readJSON(descPath, 'utf8');
+  const json = deepmerge(descJson, sourceJson);
+  await writeJSON(descPath, json, { spaces: 2, encoding: 'utf8' });
+}
 
 /**
  *
  * @param {Command} cli
  */
 module.exports = (cli) => {
-  const { APP_PACKAGE_ROOT } = process.env;
   cli
     .command('upgrade')
     .allowUnknownOption()
@@ -26,52 +36,12 @@ module.exports = (cli) => {
     .option('--next')
     .option('-S|--skip-code-update')
     .action(async (options) => {
-      if (hasTsNode()) promptForTs();
-      if (hasCorePackages()) {
-        // await run('yarn', ['install']);
-        await downloadPro();
-        await runAppCommand('upgrade');
-        return;
-      }
+      checkDBDialect();
       if (options.skipCodeUpdate) {
-        await downloadPro();
-        await runAppCommand('upgrade');
-        return;
-      }
-      // await runAppCommand('upgrade');
-      if (!hasTsNode()) {
-        await downloadPro();
-        await runAppCommand('upgrade');
-        return;
-      }
-      const rmAppDir = () => {
-        // If ts-node is not installed, do not do the following
-        const appDevDir = resolve(process.cwd(), './storage/.app-dev');
-        if (existsSync(appDevDir)) {
-          rmSync(appDevDir, { recursive: true, force: true });
-        }
-      };
-      const pkg = require('../../package.json');
-      let distTag = 'latest';
-      if (pkg.version.includes('alpha')) {
-        distTag = 'alpha';
-      } else if (pkg.version.includes('beta')) {
-        distTag = 'beta';
-      }
-      // get latest version
-      const { stdout } = await run('npm', ['info', `@nocobase/cli@${distTag}`, 'version'], {
-        stdio: 'pipe',
-      });
-      if (pkg.version === stdout) {
-        await downloadPro();
         await runAppCommand('upgrade');
-        await rmAppDir();
-        return;
+      } else {
+        await run('nocobase', ['update-deps']);
+        await run('nocobase', ['upgrade', '--skip-code-update']);
       }
-      await run('yarn', ['add', `@nocobase/cli@${distTag}`, `@nocobase/devtools@${distTag}`, '-W']);
-      await run('yarn', ['install']);
-      await downloadPro();
-      await runAppCommand('upgrade');
-      await rmAppDir();
     });
 };

package/src/util.js

@@ -360,7 +360,7 @@ exports.initEnv = function initEnv() {
     API_BASE_PATH: '/api/',
     API_CLIENT_STORAGE_PREFIX: 'NOCOBASE_',
     API_CLIENT_STORAGE_TYPE: 'localStorage',
-    DB_DIALECT: 'sqlite',
+    // DB_DIALECT: 'sqlite',
     DB_STORAGE: 'storage/db/nocobase.sqlite',
     // DB_TIMEZONE: '+00:00',
     DB_UNDERSCORED: parseEnv('DB_UNDERSCORED'),
@@ -389,7 +389,7 @@ exports.initEnv = function initEnv() {
   if (
     !process.env.APP_ENV_PATH &&
     process.argv[2] &&
-    ['test', 'test:client', 'test:server'].includes(process.argv[2])
+    ['test', 'test:client', 'test:server', 'benchmark'].includes(process.argv[2])
   ) {
     if (fs.existsSync(resolve(process.cwd(), '.env.test'))) {
       process.env.APP_ENV_PATH = '.env.test';
@@ -460,8 +460,22 @@ exports.initEnv = function initEnv() {
   process.env.SOCKET_PATH = generateGatewayPath();
   fs.mkdirpSync(dirname(process.env.SOCKET_PATH), { force: true, recursive: true });
   fs.mkdirpSync(process.env.PM2_HOME, { force: true, recursive: true });
-  const pkgDir = resolve(process.cwd(), 'storage/plugins', '@nocobase/plugin-multi-app-manager');
-  fs.existsSync(pkgDir) && fs.rmdirSync(pkgDir, { force: true });
+  const pkgs = [
+    '@nocobase/plugin-multi-app-manager',
+    '@nocobase/plugin-departments',
+    '@nocobase/plugin-field-attachment-url',
+    '@nocobase/plugin-workflow-response-message',
+  ];
+  for (const pkg of pkgs) {
+    const pkgDir = resolve(process.cwd(), 'storage/plugins', pkg);
+    fs.existsSync(pkgDir) && fs.rmdirSync(pkgDir, { recursive: true, force: true });
+  }
+};
+
+exports.checkDBDialect = function () {
+  if (!process.env.DB_DIALECT) {
+    throw new Error('DB_DIALECT is required.');
+  }
 };
 
 exports.generatePlugins = function () {

package/templates/create-app-package.json

@@ -0,0 +1,39 @@
+{
+  "private": true,
+  "workspaces": ["packages/*/*", "packages/*/*/*"],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "nocobase": "nocobase",
+    "pm": "nocobase pm",
+    "pm2": "nocobase pm2",
+    "dev": "nocobase dev",
+    "start": "nocobase start",
+    "clean": "nocobase clean",
+    "build": "nocobase build",
+    "test": "nocobase test",
+    "e2e": "nocobase e2e",
+    "tar": "nocobase tar",
+    "postinstall": "nocobase postinstall",
+    "lint": "eslint ."
+  },
+  "resolutions": {
+    "cytoscape": "3.28.0",
+    "@types/react": "18.3.18",
+    "@types/react-dom": "^18.0.0",
+    "react-router-dom": "6.28.1",
+    "react-router": "6.28.1",
+    "async": "^3.2.6",
+    "antd": "5.12.8",
+    "rollup": "4.24.0",
+    "semver": "^7.7.1"
+  },
+  "dependencies": {
+    "pm2": "^6.0.5",
+    "mysql2": "^3.14.0",
+    "mariadb": "^2.5.6",
+    "pg": "^8.14.1",
+    "pg-hstore": "^2.3.4"
+  }
+}