@nocobase/cli 2.1.0-beta.2 → 2.1.0-beta.20

package/src/commands/pkg.js

@@ -1,321 +0,0 @@
-/**
- * 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 { Command } = require('commander');
-const axios = require('axios');
-const fs = require('fs-extra');
-const zlib = require('zlib');
-const tar = require('tar');
-const path = require('path');
-const { createStoragePluginsSymlink } = require('@nocobase/utils/plugin-symlink');
-const { getAccessKeyPair, showLicenseInfo, LicenseKeyError } = require('../license');
-const { logger } = require('../logger');
-
-class Package {
-  data;
-  constructor(packageName, packageManager) {
-    this.packageName = packageName;
-    this.packageManager = packageManager;
-    this.outputDir = path.resolve(process.cwd(), `storage/plugins/${this.packageName}`);
-  }
-
-  get token() {
-    return this.packageManager.getToken();
-  }
-
-  url(path) {
-    return this.packageManager.url(path);
-  }
-
-  async mkdir() {
-    if (await fs.exists(this.outputDir)) {
-      await fs.rm(this.outputDir, { recursive: true, force: true });
-    }
-    await fs.mkdirp(this.outputDir);
-  }
-
-  async getInfo() {
-    try {
-      const res = await axios.get(this.url(this.packageName), {
-        headers: {
-          Authorization: `Bearer ${this.token}`,
-        },
-        responseType: 'json',
-      });
-      this.data = res.data;
-    } catch (error) {
-      return;
-    }
-  }
-
-  getTarball(version = 'latest') {
-    if (this.data.versions[version]) {
-      return [version, this.data.versions[version].dist.tarball];
-    }
-
-    const keys = version.split('.');
-    const length = keys.length;
-
-    if (version.includes('rc')) {
-      version = version.split('-').shift();
-    }
-
-    if (length === 5) {
-      keys.pop();
-      version = keys.join('.');
-    }
-
-    if (version === 'latest') {
-      version = this.data['dist-tags']['latest'];
-    } else if (version === 'next') {
-      version = this.data['dist-tags']['next'];
-    }
-
-    if (!this.data.versions[version]) {
-      logger.error(`Download failed: ${this.packageName}@${version} package does not exist`);
-    }
-
-    return [version, this.data.versions[version].dist.tarball];
-  }
-
-  async isDevPackage() {
-    let file = path.resolve(process.cwd(), 'packages/plugins', this.packageName, 'package.json');
-    if (await fs.exists(file)) {
-      return true;
-    }
-    file = path.resolve(process.cwd(), 'packages/pro-plugins', this.packageName, 'package.json');
-    if (await fs.exists(file)) {
-      return true;
-    }
-    return false;
-  }
-
-  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))) {
-      const readPath1 = fs.realpathSync(pkg1);
-      const readPath2 = fs.realpathSync(pkg2);
-      if (readPath1 !== readPath2) {
-        return true;
-      }
-    }
-    return false;
-  }
-
-  async isDownloaded(version) {
-    const packageFile = path.resolve(process.env.PLUGIN_STORAGE_PATH, this.packageName, 'package.json');
-    if (await fs.exists(packageFile)) {
-      const json = await fs.readJson(packageFile);
-      if (json.version === version) {
-        return true;
-      }
-    }
-    return false;
-  }
-
-  async download(options = {}) {
-    if (await this.isDevPackage()) {
-      logger.info(`Skipped: ${this.packageName} is dev package`);
-      return;
-    }
-    if (await this.isDepPackage()) {
-      logger.info(`Skipped: ${this.packageName} is dependency package`);
-      return;
-    }
-    if (await this.isDownloaded(options.version)) {
-      return;
-    }
-    await this.getInfo();
-    if (!this.data) {
-      logger.error(`Download failed: ${this.packageName} package does not exist`);
-      return;
-    }
-    try {
-      const [version, url] = this.getTarball(options.version);
-      if (await this.isDownloaded(version)) {
-        return;
-      }
-      const response = await axios({
-        url,
-        responseType: 'stream',
-        method: 'GET',
-        headers: {
-          Authorization: `Bearer ${this.token}`,
-        },
-      });
-      await this.mkdir();
-      await new Promise((resolve, reject) => {
-        response.data
-          .pipe(zlib.createGunzip()) // 解压 gzip
-          .pipe(tar.extract({ cwd: this.outputDir, strip: 1 })) // 解压 tar
-          .on('finish', resolve)
-          .on('error', reject);
-      });
-      logger.info(`Downloaded: ${this.packageName}@${version}`);
-    } catch (error) {
-      if (error?.response?.data && typeof error?.response?.data?.pipe === 'function') {
-        let errorMessageBuffer = '';
-        error.response.data.on?.('data', (chunk) => {
-          errorMessageBuffer += chunk.toString('utf8'); // 收集错误信息
-        });
-        error.response.data.on?.('end', () => {
-          if (error.response.status === 403) {
-            logger.error('You do not have permission to download this package version.');
-          }
-        });
-      }
-      logger.error(`Download failed: ${this.packageName}`);
-    }
-  }
-}
-
-class PackageManager {
-  token;
-  baseURL;
-
-  constructor({ baseURL }) {
-    this.baseURL = baseURL;
-  }
-
-  getToken() {
-    return this.token;
-  }
-
-  getBaseURL() {
-    return this.baseURL;
-  }
-
-  url(path) {
-    return this.baseURL + path;
-  }
-
-  async login(credentials) {
-    try {
-      const res1 = await axios.post(`${this.baseURL}-/verdaccio/sec/login`, credentials, {
-        responseType: 'json',
-      });
-      this.token = res1.data.token;
-      logger.info('Login success');
-    } catch (error) {
-      if (error?.response?.data?.error === 'license not valid') {
-        showLicenseInfo(LicenseKeyError.notValid);
-      }
-      logger.error(`Login failed: ${this.baseURL}`);
-      logger.error(error?.message, { error });
-    }
-  }
-
-  getPackage(packageName) {
-    return new Package(packageName, this);
-  }
-
-  async getProPackages() {
-    const res = await axios.get(this.url('pro-packages'), {
-      headers: {
-        Authorization: `Bearer ${this.token}`,
-      },
-      responseType: 'json',
-    });
-    return {
-      licensed_plugins: res.data?.data || [],
-      commercial_plugins: res.data?.meta?.commercial_plugins || [],
-    };
-  }
-
-  async getPackages() {
-    const pkgs = await this.getProPackages();
-
-    if (Array.isArray(pkgs)) {
-      return {
-        commercial_plugins: pkgs,
-        licensed_plugins: pkgs,
-      };
-    }
-    return pkgs;
-  }
-
-  async removePackage(packageName) {
-    const dir = path.resolve(process.env.PLUGIN_STORAGE_PATH, packageName);
-    const r = await fs.exists(dir);
-    if (r) {
-      logger.info(`Removed: ${packageName}`);
-      await fs.rm(dir, { force: true, recursive: true });
-    }
-  }
-
-  async download(options = {}) {
-    const { version } = options;
-    if (!this.token) {
-      return;
-    }
-    const { commercial_plugins, licensed_plugins } = await this.getPackages();
-    for (const pkg of commercial_plugins) {
-      if (!licensed_plugins.includes(pkg)) {
-        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');
-  }
-}
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  const pkg = cli.command('pkg');
-  pkg
-    .command('download-pro')
-    .option('-V, --version [version]')
-    .action(async () => {
-      const {
-        NOCOBASE_PKG_URL = 'https://pkg.nocobase.com/',
-        NOCOBASE_PKG_USERNAME,
-        NOCOBASE_PKG_PASSWORD,
-        DISABLE_PKG_DOWNLOAD,
-      } = process.env;
-      if (DISABLE_PKG_DOWNLOAD === 'true') {
-        logger.info('Package download is disabled.');
-        return;
-      }
-      let accessKeyId;
-      let accessKeySecret;
-      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;
-      }
-      const credentials = accessKeyId
-        ? { username: accessKeyId, password: accessKeySecret }
-        : { username: NOCOBASE_PKG_USERNAME, password: NOCOBASE_PKG_PASSWORD };
-      const pm = new PackageManager({ baseURL: NOCOBASE_PKG_URL });
-      await pm.login(credentials);
-      const file = path.resolve(__dirname, '../../package.json');
-      const json = await fs.readJson(file);
-      await pm.download({ version: json.version });
-      await createStoragePluginsSymlink();
-    });
-  pkg.command('export-all').action(async () => {
-    logger.info('Todo...');
-  });
-};

package/src/commands/pm2.js

@@ -1,37 +0,0 @@
-/**
- * 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 { run, isDev } = require('../util');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('pm2')
-    .allowUnknownOption()
-    .action(() => {
-      run('pm2', process.argv.slice(3));
-    });
-  cli
-    .command('pm2-restart')
-    .allowUnknownOption()
-    .action(() => {
-      run('pm2', ['restart', 'all']);
-    });
-  cli
-    .command('pm2-stop')
-    .allowUnknownOption()
-    .action(() => {
-      run('pm2', ['kill']);
-    });
-};

package/src/commands/postinstall.js

@@ -1,88 +0,0 @@
-/**
- * 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 { Command } = require('commander');
-const { run, isDev, isPackageValid, generatePlaywrightPath, generatePlugins } = require('../util');
-const { dirname, resolve } = require('path');
-const { existsSync, mkdirSync, readFileSync, appendFileSync } = require('fs');
-const { readFile, writeFile } = require('fs').promises;
-const { createStoragePluginsSymlink, createDevPluginsSymlink } = require('@nocobase/utils/plugin-symlink');
-
-function runPatchPackage() {
-  // run yarn patch-package
-  // console.log('patching third party packages...');
-  run('yarn', ['patch-package'], {
-    stdio: 'pipe',
-  });
-}
-
-function writeToExclude() {
-  const excludePath = resolve(process.cwd(), '.git', 'info', 'exclude');
-  const content = 'packages/pro-plugins/\n';
-  const dirPath = dirname(excludePath);
-
-  if (!existsSync(dirPath)) {
-    try {
-      mkdirSync(dirPath, { recursive: true });
-    } catch (e) {
-      console.log(`${e.message}, ignore write to git exclude`);
-      return;
-    }
-  }
-
-  let fileContent = '';
-  if (existsSync(excludePath)) {
-    fileContent = readFileSync(excludePath, 'utf-8');
-  }
-  if (!fileContent.includes(content)) {
-    appendFileSync(excludePath, content);
-  }
-}
-
-/**
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  const { APP_PACKAGE_ROOT } = process.env;
-  cli
-    .command('postinstall')
-    .allowUnknownOption()
-    .option('--skip-umi')
-    .action(async (options) => {
-      runPatchPackage();
-      writeToExclude();
-      generatePlugins();
-      generatePlaywrightPath(true);
-      await createStoragePluginsSymlink();
-      if (!isDev()) {
-        return;
-      }
-      await createDevPluginsSymlink();
-      const cwd = process.cwd();
-      if (!existsSync(resolve(cwd, '.env')) && existsSync(resolve(cwd, '.env.example'))) {
-        const content = await readFile(resolve(cwd, '.env.example'), 'utf-8');
-        await writeFile(resolve(cwd, '.env'), content, 'utf-8');
-      }
-      if (!existsSync(resolve(cwd, '.env.test')) && existsSync(resolve(cwd, '.env.test.example'))) {
-        const content = await readFile(resolve(cwd, '.env.test.example'), 'utf-8');
-        await writeFile(resolve(cwd, '.env.test'), content, 'utf-8');
-      }
-      if (!isPackageValid('umi')) {
-        return;
-      }
-      if (!options.skipUmi) {
-        run('umi', ['generate', 'tmp'], {
-          stdio: 'pipe',
-          env: {
-            APP_ROOT: `${APP_PACKAGE_ROOT}/client`,
-          },
-        });
-      }
-    });
-};

package/src/commands/start.js

@@ -1,148 +0,0 @@
-/**
- * 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 _ = require('lodash');
-const { Command } = require('commander');
-const { run, postCheck, downloadPro, promptForTs, checkDBDialect } = require('../util');
-const { existsSync, rmSync } = require('fs');
-const { resolve, isAbsolute } = require('path');
-const chalk = require('chalk');
-const chokidar = require('chokidar');
-
-function getSocketPath() {
-  const { SOCKET_PATH } = process.env;
-
-  if (isAbsolute(SOCKET_PATH)) {
-    return SOCKET_PATH;
-  }
-
-  return resolve(process.cwd(), SOCKET_PATH);
-}
-
-function deleteSockFiles() {
-  const { PM2_HOME } = process.env;
-  if (existsSync(PM2_HOME)) {
-    rmSync(PM2_HOME, { recursive: true });
-  }
-  const socketPath = getSocketPath();
-  if (existsSync(socketPath)) {
-    rmSync(socketPath);
-  }
-}
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  const { APP_PACKAGE_ROOT, NODE_ARGS } = process.env;
-  cli
-    .command('start')
-    .option('-p, --port [port]')
-    .option('-d, --daemon')
-    .option('-i, --instances [instances]')
-    .option('--db-sync')
-    .option('--quickstart')
-    .option('--launch-mode [launchMode]')
-    .allowUnknownOption()
-    .action(async (opts) => {
-      checkDBDialect();
-      if (opts.quickstart) {
-        await downloadPro();
-      }
-
-      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 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;
-      }
-      if (process.argv.includes('-h') || process.argv.includes('--help')) {
-        promptForTs();
-        run('ts-node', [
-          '-P',
-          process.env.SERVER_TSCONFIG_PATH,
-          '-r',
-          'tsconfig-paths/register',
-          `${APP_PACKAGE_ROOT}/src/index.ts`,
-          ...process.argv.slice(2),
-        ]);
-        return;
-      }
-      if (!existsSync(resolve(process.cwd(), `${APP_PACKAGE_ROOT}/lib/index.js`))) {
-        console.log('The code is not compiled, please execute it first');
-        console.log(chalk.yellow('$ yarn build'));
-        console.log('If you want to run in development mode, please execute');
-        console.log(chalk.yellow('$ yarn dev'));
-        return;
-      }
-      await postCheck(opts);
-      if (!opts.daemon) {
-        deleteSockFiles();
-      }
-      const instances = opts.instances || process.env.CLUSTER_MODE;
-      const instancesArgs = instances ? ['-i', instances] : [];
-      if (opts.daemon) {
-        await run('pm2', [
-          'start',
-          ...instancesArgs,
-          `${APP_PACKAGE_ROOT}/lib/index.js`,
-          '--',
-          ...process.argv.slice(2),
-        ]);
-        process.exit();
-      } else {
-        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/tar.js

@@ -1,36 +0,0 @@
-/**
- * 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 { resolve } = require('path');
-const { Command } = require('commander');
-const { run, nodeCheck, isPackageValid } = require('../util');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('tar')
-    .allowUnknownOption()
-    .argument('[packages...]')
-    .option('-v, --version', 'print version')
-    .option('-c, --compile', 'compile the @nocobase/build package')
-    .option('-w, --watch', 'watch compile the @nocobase/build package')
-    .action(async (pkgs, options) => {
-      nodeCheck();
-      if (options.compile || options.watch || isPackageValid('@nocobase/build/src/index.ts')) {
-        await run('yarn', ['build', options.watch ? '--watch' : ''], {
-          cwd: resolve(process.cwd(), 'packages/core/build'),
-        });
-        if (options.watch) return;
-      }
-      await run('nocobase-build', [...pkgs, '--only-tar', options.version ? '--version' : '']);
-    });
-};

package/src/commands/test-coverage.js

@@ -1,55 +0,0 @@
-/**
- * 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 { run, checkDBDialect } = require('../util');
-const fg = require('fast-glob');
-
-const coreClientPackages = ['packages/core/client', 'packages/core/sdk'];
-const isCore = (dir) => dir.startsWith('packages/core');
-
-const getPackagesDir = (isClient) => {
-  if (process.argv.length > 3 && !process.argv[3].startsWith('-')) {
-    return [process.argv[3]];
-  }
-
-  const allPackageJson = fg.sync(['packages/*/*/package.json', 'packages/*/*/*/package.json'], {
-    cwd: process.cwd(),
-    onlyFiles: true,
-  });
-  const res = allPackageJson.map((pkg) => pkg.replace('/package.json', ''));
-  return isClient
-    ? res.filter((dir) => (isCore(dir) ? coreClientPackages.includes(dir) : true))
-    : res.filter((dir) => (isCore(dir) ? !coreClientPackages.includes(dir) : true));
-};
-
-module.exports = (cli) => {
-  cli.command('test-coverage:server').action(async () => {
-    checkDBDialect();
-    const packageRoots = getPackagesDir(false);
-    for (const dir of packageRoots) {
-      try {
-        await run('yarn', ['test:server', dir, '--coverage']);
-      } catch (e) {
-        continue;
-      }
-    }
-  });
-
-  cli.command('test-coverage:client').action(async () => {
-    checkDBDialect();
-    const packageRoots = getPackagesDir(true);
-    for (const dir of packageRoots) {
-      try {
-        await run('yarn', ['test:client', dir, '--coverage']);
-      } catch (e) {
-        continue;
-      }
-    }
-  });
-};