@nocobase/cli 0.15.0-alpha.2 → 0.15.0-alpha.4

package/bin/index.js

@@ -2,7 +2,7 @@
 
 const dotenv = require('dotenv');
 const { resolve } = require('path');
-const { existsSync } = require('fs');
+const fs = require('fs');
 const chalk = require('chalk');
 const { genTsConfigPaths } = require('../src/util');
 
@@ -25,11 +25,26 @@ const env = {
 };
 
 if (!process.env.APP_ENV_PATH && process.argv[2] && process.argv[2] === 'test') {
-  if (existsSync(resolve(process.cwd(), '.env.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';
+}
+
 genTsConfigPaths();
 
 dotenv.config({
@@ -42,6 +57,10 @@ for (const key in 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}`;
+}
+
 if (require('semver').satisfies(process.version, '<16')) {
   console.error(chalk.red('[nocobase cli]: Node.js version must be >= 16'));
   process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli",
-  "version": "0.15.0-alpha.2",
+  "version": "0.15.0-alpha.4",
   "description": "",
   "license": "Apache-2.0",
   "main": "./src/index.js",
@@ -8,7 +8,7 @@
     "nocobase": "./bin/index.js"
   },
   "dependencies": {
-    "@nocobase/app": "0.15.0-alpha.2",
+    "@nocobase/app": "0.15.0-alpha.4",
     "@types/fs-extra": "^11.0.1",
     "@umijs/utils": "3.5.20",
     "chalk": "^4.1.1",
@@ -23,12 +23,12 @@
     "tsx": "^3.12.7"
   },
   "devDependencies": {
-    "@nocobase/devtools": "0.15.0-alpha.2"
+    "@nocobase/devtools": "0.15.0-alpha.4"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/core/cli"
   },
-  "gitHead": "2504887cf82935200bf546b28adf2872cab3e452"
+  "gitHead": "380045c660ea0432f3e8fd7cf01c3cfe7275db34"
 }

package/src/commands/e2e.js

@@ -0,0 +1,199 @@
+const { Command } = require('commander');
+const { run, isPortReachable } = require('../util');
+const { execSync } = require('node:child_process');
+const axios = require('axios');
+
+/**
+ * 检查服务是否启动成功
+ */
+const checkServer = async (duration = 1000, max = 60 * 10) => {
+  return new Promise((resolve, reject) => {
+    let count = 0;
+    const timer = setInterval(async () => {
+      if (count++ > max) {
+        clearInterval(timer);
+        return reject(new Error('Server start timeout.'));
+      }
+
+      // if (!(await checkPort(PORT))) {
+      //   return;
+      // }
+
+      const url = `${process.env.APP_BASE_URL}/api/__health_check`;
+      // console.log('url', url);
+
+      axios
+        .get(url)
+        .then((response) => {
+          if (response.status === 200) {
+            clearInterval(timer);
+            resolve(true);
+          }
+        })
+        .catch((error) => {
+          console.error('Request error:', error.message);
+        });
+    }, duration);
+  });
+};
+
+/**
+ * 检查 UI 是否启动成功
+ * @param duration
+ */
+const checkUI = async (duration = 1000, max = 60 * 10) => {
+  return new Promise((resolve, reject) => {
+    let count = 0;
+    const timer = setInterval(async () => {
+      if (count++ > max) {
+        clearInterval(timer);
+        return reject(new Error('UI start timeout.'));
+      }
+
+      axios
+        .get(`${process.env.APP_BASE_URL}/__umi/api/bundle-status`)
+        .then((response) => {
+          if (response.data === 'ok') {
+            clearInterval(timer);
+            resolve(true);
+            return;
+          }
+          if (response.data.bundleStatus.done) {
+            clearInterval(timer);
+            resolve(true);
+          }
+        })
+        .catch((error) => {
+          console.error('Request error:', error.message);
+        });
+    }, duration);
+  });
+};
+
+async function appReady() {
+  console.log('check server...');
+  await checkServer();
+  console.log('server is ready, check UI...');
+  await checkUI();
+  console.log('UI is ready.');
+}
+
+async function runApp(options = {}) {
+  console.log('installing...');
+  await run('nocobase', ['install', '-f']);
+  if (await isPortReachable(process.env.APP_PORT)) {
+    console.log('app started');
+    return;
+  }
+  console.log('starting...');
+  run('nocobase', [process.env.APP_ENV === 'production' ? 'start' : 'dev'], options);
+}
+
+const commonConfig = {
+  stdio: 'inherit',
+};
+
+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`,
+      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`,
+        commonConfig,
+      );
+    } else {
+      console.error(err);
+    }
+  }
+};
+
+const filterArgv = () => {
+  const arr = process.argv.slice(4);
+  const argv = [];
+  for (let index = 0; index < arr.length; index++) {
+    const element = arr[index];
+    if (element === '--url') {
+      index++;
+      continue;
+    }
+    if (element.startsWith('--url=')) {
+      continue;
+    }
+    if (element === '--skip-reporter') {
+      continue;
+    }
+    argv.push(element);
+  }
+  return argv;
+};
+
+/**
+ *
+ * @param {Command} cli
+ */
+module.exports = (cli) => {
+  const e2e = cli.command('e2e').hook('preAction', () => {
+    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);
+    }
+  });
+  e2e
+    .command('test')
+    .allowUnknownOption()
+    .option('--url [url]')
+    .option('--skip-reporter')
+    .action(async (options) => {
+      if (options.skipReporter) {
+        process.env.PLAYWRIGHT_SKIP_REPORTER = true;
+      }
+      if (options.url) {
+        process.env.APP_BASE_URL = options.url.replace('localhost', '127.0.0.1');
+      } else {
+        await runApp({
+          stdio: 'ignore',
+        });
+      }
+      await appReady();
+      await run('npx', ['playwright', 'test', ...filterArgv()]);
+      process.exit();
+    });
+
+  e2e
+    .command('codegen')
+    .allowUnknownOption()
+    .option('--url [url]')
+    .action(async (options) => {
+      if (options.url) {
+        process.env.APP_BASE_URL = options.url.replace('localhost', '127.0.0.1');
+      } else {
+        await runApp({
+          stdio: 'ignore',
+        });
+      }
+      await appReady();
+      runCodegenSync();
+    });
+
+  e2e
+    .command('start-app')
+    .option('--production')
+    .option('--port [port]')
+    .action(async (options) => {
+      if (options.production) {
+        process.env.APP_ENV = 'production';
+      }
+      if (options.port) {
+        process.env.APP_PORT = options.port;
+      }
+      runApp();
+    });
+
+  e2e.command('reinstall-app').action(async (options) => {
+    await run('nocobase', ['install', '-f'], options);
+  });
+};

package/src/commands/index.js

@@ -13,6 +13,7 @@ module.exports = (cli) => {
   require('./dev')(cli);
   require('./start')(cli);
   require('./test')(cli);
+  require('./e2e')(cli);
   require('./clean')(cli);
   require('./doc')(cli);
   require('./umi')(cli);