@nocobase/cli 0.17.0-alpha.7 → 0.18.0-alpha.8

package/bin/index.js

@@ -1,85 +1,30 @@
 #!/usr/bin/env node
 
-const dotenv = require('dotenv');
-const { resolve } = require('path');
-const fs = require('fs');
 const chalk = require('chalk');
-const { genTsConfigPaths } = require('../src/util');
-
-const env = {
-  APP_ENV: 'development',
-  APP_KEY: 'test-jwt-secret',
-  APP_PORT: 13000,
-  API_BASE_PATH: '/api/',
-  DB_DIALECT: 'sqlite',
-  DB_STORAGE: 'storage/db/nocobase.sqlite',
-  DB_TIMEZONE: '+00:00',
-  DEFAULT_STORAGE_TYPE: 'local',
-  LOCAL_STORAGE_DEST: 'storage/uploads',
-  PLUGIN_STORAGE_PATH: resolve(process.cwd(), 'storage/plugins'),
-  MFSU_AD: 'none',
-  NODE_MODULES_PATH: resolve(process.cwd(), 'node_modules'),
-  PM2_HOME: resolve(process.cwd(), './storage/.pm2'),
-  PLUGIN_PACKAGE_PREFIX: '@nocobase/plugin-,@nocobase/plugin-sample-,@nocobase/preset-',
-  SERVER_TSCONFIG_PATH: './tsconfig.server.json',
-};
-
-if (!process.env.APP_ENV_PATH && process.argv[2] && process.argv[2] === 'test') {
-  if (fs.existsSync(resolve(process.cwd(), '.env.test'))) {
-    process.env.APP_ENV_PATH = '.env.test';
-  }
-}
-
-if (process.argv[2] === 'e2e') {
-  // 用于存放 playwright 自动生成的相关的文件
-  if (!fs.existsSync('playwright')) {
-    fs.mkdirSync('playwright');
-  }
-  if (!fs.existsSync('.env.e2e') && fs.existsSync('.env.e2e.example')) {
-    const env = fs.readFileSync('.env.e2e.example');
-    fs.writeFileSync('.env.e2e', env);
-  }
-  if (!fs.existsSync('.env.e2e')) {
-    throw new Error('Please create .env.e2e file first!');
-  }
-  process.env.APP_ENV_PATH = '.env.e2e';
-}
+const { initEnv, genTsConfigPaths } = require('../src/util');
 
+initEnv();
 genTsConfigPaths();
 
-dotenv.config({
-  path: resolve(process.cwd(), process.env.APP_ENV_PATH || '.env'),
-});
-
-for (const key in env) {
-  if (!process.env[key]) {
-    process.env[key] = env[key];
-  }
-}
-
-if (process.argv[2] === 'e2e' && !process.env.APP_BASE_URL) {
-  process.env.APP_BASE_URL = `http://127.0.0.1:${process.env.APP_PORT}`;
-}
-
 if (require('semver').satisfies(process.version, '<16')) {
   console.error(chalk.red('[nocobase cli]: Node.js version must be >= 16'));
   process.exit(1);
 }
 
-if (require('semver').satisfies(process.version, '>16') && !process.env.UNSET_NODE_OPTIONS) {
-  if (process.env.NODE_OPTIONS) {
-    let opts = process.env.NODE_OPTIONS;
-    if (!opts.includes('--openssl-legacy-provider')) {
-      opts = opts + ' --openssl-legacy-provider';
-    }
-    if (!opts.includes('--no-experimental-fetch')) {
-      opts = opts + ' --no-experimental-fetch';
-    }
-    process.env.NODE_OPTIONS = opts;
-  } else {
-    process.env.NODE_OPTIONS = '--openssl-legacy-provider --no-experimental-fetch';
-  }
-}
+// if (require('semver').satisfies(process.version, '>16') && !process.env.UNSET_NODE_OPTIONS) {
+//   if (process.env.NODE_OPTIONS) {
+//     let opts = process.env.NODE_OPTIONS;
+//     if (!opts.includes('--openssl-legacy-provider')) {
+//       opts = opts + ' --openssl-legacy-provider';
+//     }
+//     if (!opts.includes('--no-experimental-fetch')) {
+//       opts = opts + ' --no-experimental-fetch';
+//     }
+//     process.env.NODE_OPTIONS = opts;
+//   } else {
+//     process.env.NODE_OPTIONS = '--openssl-legacy-provider --no-experimental-fetch';
+//   }
+// }
 
 const cli = require('../src/cli');
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli",
-  "version": "0.17.0-alpha.7",
+  "version": "0.18.0-alpha.8",
   "description": "",
   "license": "Apache-2.0",
   "main": "./src/index.js",
@@ -8,7 +8,7 @@
     "nocobase": "./bin/index.js"
   },
   "dependencies": {
-    "@nocobase/app": "0.17.0-alpha.7",
+    "@nocobase/app": "0.18.0-alpha.8",
     "@types/fs-extra": "^11.0.1",
     "@umijs/utils": "3.5.20",
     "chalk": "^4.1.1",
@@ -17,18 +17,19 @@
     "execa": "^5.1.1",
     "fast-glob": "^3.3.1",
     "fs-extra": "^11.1.1",
+    "p-all": "3.0.0",
     "pm2": "^5.2.0",
     "portfinder": "^1.0.28",
     "serve": "^13.0.2",
     "tsx": "^4.6.2"
   },
   "devDependencies": {
-    "@nocobase/devtools": "0.17.0-alpha.7"
+    "@nocobase/devtools": "0.18.0-alpha.8"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/core/cli"
   },
-  "gitHead": "91377a3abd1124f79fb3819f2d0e80905e091a32"
+  "gitHead": "727d42f6f14e5f863831da3dbf3255ba1165b567"
 }

package/src/commands/e2e.js

@@ -2,6 +2,7 @@ const { Command } = require('commander');
 const { run, isPortReachable } = require('../util');
 const { execSync } = require('node:child_process');
 const axios = require('axios');
+const { pTest } = require('./p-test');
 
 /**
  * 检查服务是否启动成功
@@ -96,13 +97,13 @@ const commonConfig = {
 const runCodegenSync = () => {
   try {
     execSync(
-      `npx playwright codegen --load-storage=playwright/.auth/codegen.auth.json ${process.env.APP_BASE_URL} --save-storage=playwright/.auth/codegen.auth.json`,
+      `npx playwright codegen --load-storage=storage/playwright/.auth/codegen.auth.json ${process.env.APP_BASE_URL} --save-storage=storage/playwright/.auth/codegen.auth.json`,
       commonConfig,
     );
   } catch (err) {
     if (err.message.includes('auth.json')) {
       execSync(
-        `npx playwright codegen ${process.env.APP_BASE_URL} --save-storage=playwright/.auth/codegen.auth.json`,
+        `npx playwright codegen ${process.env.APP_BASE_URL} --save-storage=storage/playwright/.auth/codegen.auth.json`,
         commonConfig,
       );
     } else {
@@ -196,4 +197,16 @@ module.exports = (cli) => {
   e2e.command('reinstall-app').action(async (options) => {
     await run('nocobase', ['install', '-f'], options);
   });
+
+  e2e.command('install-deps').action(async () => {
+    await run('npx', ['playwright', 'install', '--with-deps']);
+  });
+
+  e2e
+    .command('p-test')
+    .option('--stop-on-error')
+    .option('--concurrency [concurrency]', '', 3)
+    .action(async (opts) => {
+      await pTest(opts);
+    });
 };

package/src/commands/index.js

@@ -12,10 +12,10 @@ module.exports = (cli) => {
   require('./tar')(cli);
   require('./dev')(cli);
   require('./start')(cli);
-  require('./test')(cli);
   require('./e2e')(cli);
   require('./clean')(cli);
   require('./doc')(cli);
+  require('./test')(cli);
   require('./umi')(cli);
   require('./upgrade')(cli);
   require('./postinstall')(cli);

package/src/commands/p-test.js

@@ -0,0 +1,68 @@
+const execa = require('execa');
+const { resolve, dirname } = require('path');
+const pAll = require('p-all');
+const dotenv = require('dotenv');
+const fs = require('fs');
+const { Client } = require('pg');
+const glob = require('glob');
+
+let ENV_FILE = resolve(process.cwd(), '.env.e2e');
+
+if (!fs.existsSync(ENV_FILE)) {
+  ENV_FILE = resolve(process.cwd(), '.env.e2e.example');
+}
+
+const data = fs.readFileSync(ENV_FILE, 'utf-8');
+const config = {
+  ...dotenv.parse(data),
+  ...process.env,
+};
+
+async function runApp(index = 1, dir) {
+  const database = `nocobase${index}`;
+  const client = new Client({
+    host: config['DB_HOST'],
+    port: Number(config['DB_PORT']),
+    user: config['DB_USER'],
+    password: config['DB_PASSWORD'],
+    database: 'postgres',
+  });
+  await client.connect();
+  await client.query(`DROP DATABASE IF EXISTS "${database}"`);
+  await client.query(`CREATE DATABASE "${database}";`);
+  await client.end();
+  return execa('yarn', ['nocobase', 'e2e', 'test', dir, '-x', '--skip-reporter'], {
+    shell: true,
+    stdio: 'inherit',
+    env: {
+      ...config,
+      CI: true,
+      __E2E__: true,
+      APP_BASE_URL: undefined,
+      LOGGER_LEVEL: 'error',
+      APP_ENV: 'production',
+      APP_PORT: 20000 + index,
+      DB_DATABASE: `nocobase${index}`,
+      SOCKET_PATH: `storage/gateway-e2e-${index}.sock`,
+      PM2_HOME: resolve(process.cwd(), `storage/.pm2-${index}`),
+      PLAYWRIGHT_AUTH_FILE: resolve(process.cwd(), `storage/playwright/.auth/admin-${index}.json`),
+    },
+  });
+}
+
+exports.pTest = async (options) => {
+  const files = glob.sync('packages/**/__e2e__/**/*.test.ts', {
+    root: process.cwd(),
+  });
+  const fileSet = new Set();
+
+  for (const file of files) {
+    fileSet.add(dirname(file));
+  }
+
+  const commands = [...fileSet.values()].map((v, i) => {
+    return () => runApp(i + 1, v);
+  });
+
+  await pAll(commands, { concurrency: 3, stopOnError: false, ...options });
+};

package/src/commands/postinstall.js

@@ -1,5 +1,5 @@
 const { Command } = require('commander');
-const { run, isDev, isPackageValid } = require('../util');
+const { run, isDev, isPackageValid, generatePlaywrightPath } = require('../util');
 const { resolve } = require('path');
 const { existsSync } = require('fs');
 const { readFile, writeFile } = require('fs').promises;
@@ -14,6 +14,7 @@ module.exports = (cli) => {
     .command('postinstall')
     .allowUnknownOption()
     .action(async () => {
+      generatePlaywrightPath(true);
       await createStoragePluginsSymlink();
       if (!isDev()) {
         return;

package/src/commands/test.js

@@ -1,30 +1,87 @@
 const { Command } = require('commander');
-const { nodeCheck, runAppCommand, promptForTs, genTsConfigPaths } = require('../util');
+const { run } = require('../util');
+const path = require('path');
 
 /**
  *
+ * @param {String} name
  * @param {Command} cli
  */
-module.exports = (cli) => {
-  cli
-    .command('test')
-    .option('-c, --db-clean')
+function addTestCommand(name, cli) {
+  return cli
+    .command(name)
+    .option('-w, --watch')
+    .option('--run')
+    .option('--allowOnly')
+    .option('--bail')
+    .option('-h, --help')
+    .option('--single-thread [singleThread]')
+    .arguments('[paths...]')
     .allowUnknownOption()
-    .action(async (options) => {
-      nodeCheck();
-      if (options.dbClean) {
-        promptForTs();
-        await runAppCommand('db:clean', ['-y']);
-      }
-      let index = process.argv.indexOf('-c');
-      if (index > 0) {
-        process.argv.splice(index, 1);
-      }
-      index = process.argv.indexOf('--db-clean');
-      if (index > 0) {
-        process.argv.splice(index, 1);
-      }
-      process.argv.splice(2, 1, '-i');
-      require('jest-cli/bin/jest');
+    .action(async (paths, opts) => {
+      if (name === 'test:server') {
+        process.env.TEST_ENV = 'server-side';
+      } else if (name === 'test:client') {
+        process.env.TEST_ENV = 'client-side';
+      }
+      if (opts.server) {
+        process.env.TEST_ENV = 'server-side';
+        process.argv.splice(process.argv.indexOf('--server'), 1);
+      }
+      if (opts.client) {
+        process.env.TEST_ENV = 'client-side';
+        process.argv.splice(process.argv.indexOf('--client'), 1);
+      }
+      process.env.NODE_ENV = 'test';
+      if (!opts.watch && !opts.run) {
+        process.argv.push('--run');
+      }
+      if (process.env.TEST_ENV === 'server-side' && opts.singleThread !== 'false') {
+        process.argv.push('--poolOptions.threads.singleThread=true');
+      }
+      if (opts.singleThread === 'false') {
+        process.argv.splice(process.argv.indexOf('--single-thread=false'), 1);
+      }
+      const cliArgs = ['--max_old_space_size=4096', './node_modules/.bin/vitest', ...process.argv.slice(3)];
+      if (process.argv.includes('-h') || process.argv.includes('--help')) {
+        await run('node', cliArgs);
+        return;
+      }
+      const first = paths?.[0];
+      if (!process.env.TEST_ENV && first) {
+        const key = first.split(path.sep).join('/');
+        if (key.includes('/client/')) {
+          process.env.TEST_ENV = 'client-side';
+        } else {
+          process.env.TEST_ENV = 'server-side';
+        }
+      }
+      if (process.env.TEST_ENV) {
+        console.log('process.env.TEST_ENV', process.env.TEST_ENV, cliArgs);
+        await run('node', cliArgs);
+      } else {
+        await Promise.all([
+          run('node', cliArgs, {
+            env: {
+              TEST_ENV: 'client-side',
+            },
+          }),
+          run('node', cliArgs, {
+            env: {
+              TEST_ENV: 'server-side',
+            },
+          }),
+        ]);
+      }
     });
+}
+
+/**
+ *
+ * @param {Command} cli
+ */
+module.exports = (cli) => {
+  addTestCommand('test:server', cli);
+  addTestCommand('test:client', cli);
+  addTestCommand('test', cli).option('--client').option('--server');
 };

package/src/util.js

@@ -5,10 +5,12 @@ const fg = require('fast-glob');
 const { dirname, join, resolve, sep } = require('path');
 const { readFile, writeFile } = require('fs').promises;
 const { existsSync, mkdirSync, cpSync, writeFileSync } = require('fs');
+const dotenv = require('dotenv');
+const fs = require('fs');
 
-exports.isPackageValid = (package) => {
+exports.isPackageValid = (pkg) => {
   try {
-    require.resolve(package);
+    require.resolve(pkg);
     return true;
   } catch (error) {
     return false;
@@ -55,6 +57,10 @@ exports.nodeCheck = () => {
 };
 
 exports.run = (command, args, options = {}) => {
+  if (command === 'tsx') {
+    command = 'node';
+    args = ['./node_modules/tsx/dist/cli.mjs'].concat(args || []);
+  }
   return execa(command, args, {
     shell: true,
     stdio: 'inherit',
@@ -177,6 +183,17 @@ exports.generateAppDir = function generateAppDir() {
 };
 
 exports.genTsConfigPaths = function genTsConfigPaths() {
+  try {
+    fs.unlinkSync(resolve(process.cwd(), 'node_modules/.bin/tsx'));
+    fs.symlinkSync(
+      resolve(process.cwd(), 'node_modules/tsx/dist/cli.mjs'),
+      resolve(process.cwd(), 'node_modules/.bin/tsx'),
+      'file',
+    );
+  } catch (error) {
+    //
+  }
+
   const cwd = process.cwd();
   const cwdLength = cwd.length;
   const paths = {
@@ -193,8 +210,16 @@ exports.genTsConfigPaths = function genTsConfigPaths() {
       .slice(cwdLength + 1)
       .split(sep)
       .join('/');
-    paths[packageJsonName] = [`${relativePath}/src`];
     paths[`${packageJsonName}/client`] = [`${relativePath}/src/client`];
+    paths[`${packageJsonName}/package.json`] = [`${relativePath}/package.json`];
+    paths[packageJsonName] = [`${relativePath}/src`];
+    if (packageJsonName === '@nocobase/test') {
+      paths[`${packageJsonName}/server`] = [`${relativePath}/src/server`];
+      paths[`${packageJsonName}/e2e`] = [`${relativePath}/src/e2e`];
+    }
+    if (packageJsonName === '@nocobase/plugin-workflow-test') {
+      paths[`${packageJsonName}/e2e`] = [`${relativePath}/src/e2e`];
+    }
   });
 
   const tsConfigJsonPath = join(cwd, './tsconfig.paths.json');
@@ -202,3 +227,78 @@ exports.genTsConfigPaths = function genTsConfigPaths() {
   writeFileSync(tsConfigJsonPath, JSON.stringify(content, null, 2), 'utf-8');
   return content;
 };
+
+function generatePlaywrightPath(clean = false) {
+  try {
+    const playwright = resolve(process.cwd(), 'storage/playwright/tests');
+    if (clean && fs.existsSync(playwright)) {
+      fs.rmSync(dirname(playwright), { force: true, recursive: true });
+    }
+    if (!fs.existsSync(playwright)) {
+      const testPkg = require.resolve('@nocobase/test/package.json');
+      fs.cpSync(resolve(dirname(testPkg), 'playwright/tests'), playwright, { recursive: true });
+    }
+  } catch (error) {
+    // empty
+  }
+}
+
+exports.generatePlaywrightPath = generatePlaywrightPath;
+
+exports.initEnv = function initEnv() {
+  const env = {
+    APP_ENV: 'development',
+    APP_KEY: 'test-jwt-secret',
+    APP_PORT: 13000,
+    API_BASE_PATH: '/api/',
+    DB_DIALECT: 'sqlite',
+    DB_STORAGE: 'storage/db/nocobase.sqlite',
+    DB_TIMEZONE: '+00:00',
+    DEFAULT_STORAGE_TYPE: 'local',
+    LOCAL_STORAGE_DEST: 'storage/uploads',
+    PLUGIN_STORAGE_PATH: resolve(process.cwd(), 'storage/plugins'),
+    MFSU_AD: 'none',
+    NODE_MODULES_PATH: resolve(process.cwd(), 'node_modules'),
+    PM2_HOME: resolve(process.cwd(), './storage/.pm2'),
+    PLUGIN_PACKAGE_PREFIX: '@nocobase/plugin-,@nocobase/plugin-sample-,@nocobase/preset-',
+    SERVER_TSCONFIG_PATH: './tsconfig.server.json',
+    PLAYWRIGHT_AUTH_FILE: resolve(process.cwd(), 'storage/playwright/.auth/admin.json'),
+  };
+
+  if (
+    !process.env.APP_ENV_PATH &&
+    process.argv[2] &&
+    ['test', 'test:client', 'test:server'].includes(process.argv[2])
+  ) {
+    if (fs.existsSync(resolve(process.cwd(), '.env.test'))) {
+      process.env.APP_ENV_PATH = '.env.test';
+    }
+  }
+
+  if (!process.env.APP_ENV_PATH && process.argv[2] === 'e2e') {
+    // 用于存放 playwright 自动生成的相关的文件
+    generatePlaywrightPath();
+    if (!fs.existsSync('.env.e2e') && fs.existsSync('.env.e2e.example')) {
+      const env = fs.readFileSync('.env.e2e.example');
+      fs.writeFileSync('.env.e2e', env);
+    }
+    if (!fs.existsSync('.env.e2e')) {
+      throw new Error('Please create .env.e2e file first!');
+    }
+    process.env.APP_ENV_PATH = '.env.e2e';
+  }
+
+  dotenv.config({
+    path: resolve(process.cwd(), process.env.APP_ENV_PATH || '.env'),
+  });
+
+  if (process.argv[2] === 'e2e' && !process.env.APP_BASE_URL) {
+    process.env.APP_BASE_URL = `http://127.0.0.1:${process.env.APP_PORT}`;
+  }
+
+  for (const key in env) {
+    if (!process.env[key]) {
+      process.env[key] = env[key];
+    }
+  }
+};