@opentapd/tplugin-cli 0.19.0

package/util/axios.js

@@ -0,0 +1,52 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: gobichen@tencent.com
+ *
+ * Axios interceptors
+ */
+
+const axios = require('axios');
+const { Base64 } = require('js-base64');
+const { tapd } = require('../config');
+const Session = require('../util/session');
+const session = new Session();
+const { get } = require('lodash');
+
+// 创建一个独立的axios实例
+const instance = axios.create({
+  baseURL: `${tapd.apiHost}`,
+  headers: {
+    'Content-Type': 'application/json',
+    // 登录统一使用tapd-personal账号
+    Authorization: `Basic ${Base64.encode('tapd-personal:tapd-personal')}`,
+  },
+});
+
+instance.interceptors.request.use((config) => {
+  // 排除登录url
+  if (
+    // pin+token登录接口
+    !config.url.includes('oa_user_access_token')
+    // token换取接口
+    && !(config.url.includes('tokens/request_token'))
+    // 工蜂IDE登录token接口
+    && !(config.url.includes('token/oa_user_access_token_by_tgit_token'))
+  ) {
+    config.headers.Authorization = `Bearer ${session.token()}`;
+  }
+  config.errorContext = new Error('Thrown at:');
+  return config;
+});
+
+instance.interceptors.response.use(undefined, async (error) => {
+  // 获取原始调用栈
+  const originalStackTrace = get(error, 'config.errorContext.stack');
+  if (originalStackTrace) {
+    // 调用栈补充进error
+    error.stack = `${error.stack}\n${originalStackTrace}`;
+  }
+
+  throw error;
+});
+
+module.exports = instance;

package/util/checkNodeVersion.js

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: gobichen@tencent.com
+ *
+ * Node Version Check
+ */
+
+const semver = require('semver');
+const { engines } = require('../package.json');
+const requiredNodeVersion = engines.node;
+
+// 判断Node版本范围
+const isSatisfiedVersion = semver.satisfies(
+  process.version,
+  requiredNodeVersion,
+);
+
+if (!isSatisfiedVersion) {
+  console.log(`This project require node version: ${requiredNodeVersion}`);
+  process.exit(-1);
+}

package/util/checkPluginYaml.js

@@ -0,0 +1,19 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: gobichen@tencent.com
+ *
+ * plugin.yaml is exist
+ */
+
+const chalk = require('chalk');
+const fs = require('fs-extra');
+
+module.exports = () => {
+  const yamlPath = `${process.cwd()}/plugin.yaml`;
+
+  // 判断 plugin.yaml 文件是否缺失
+  if (!fs.pathExistsSync(yamlPath)) {
+    console.log(chalk.red('当前目录未找到plugin.yaml文件'));
+    process.exit(1);
+  }
+};

package/util/createDevWorkspace.js

@@ -0,0 +1,62 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: gobichen@tencent.com
+ *
+ * 创建开发项目
+ */
+
+const inquirer = require('inquirer');
+const tapdsdk = require('../util/tapd');
+const getPluginCode = require('./getPluginCode');
+const spinner = require('../util/spinner');
+const { get } = require('lodash');
+const Session = require('../util/session');
+
+module.exports = async () => {
+  // 判断当前用户是否已经创建了 开发项目
+  const { data } = await tapdsdk.request({ url: '/open_user_app/check_user_dev_workspace_exist', method: 'GET' });
+  const hasDevWorkspace = data.data;
+  const neverCreateDevKey = 'never-create-dev-workspace';
+  const alreadyCreateDevKey = 'already-create-dev-workspace';
+
+  const session = new Session();
+  const neverCreateDev = session.getConfig(neverCreateDevKey);
+  const alreadyCreateDev = session.getConfig(alreadyCreateDevKey);
+
+  // 未创建开发项目
+  if (!neverCreateDev && !alreadyCreateDev && !hasDevWorkspace) {
+    const choices = [
+      { name: '马上创建', value: 'create' },
+      { name: '稍后创建', value: 'cancel' },
+      { name: '不再提醒', value: 'never' },
+    ];
+
+    // 选择是否创建
+    const createStatus = await inquirer.prompt([{
+      type: 'list',
+      name: 'isCreate',
+      message: '是否创建一个TAPD项目进行开发',
+      choices,
+    }]);
+
+    if (createStatus.isCreate === 'create') {
+      spinner.start('创建中, 请稍等...');
+      const appCode = getPluginCode();
+
+      // 发起开发项目创建
+      const { data } = await tapdsdk.request({ url: '/open_user_app/create_user_dev_workspace', params: { code: appCode }, method: 'POST' });
+      spinner.succeed('创建开发项目成功');
+      const workspaceId = get(data, 'data.workspace_id') || false;
+
+      // 保存状态“已创建”到Session
+      session.setConfig(alreadyCreateDevKey, true);
+      return workspaceId;
+    }
+
+    if (createStatus.isCreate === 'never') {
+      // 保存状态“不再提醒”到Session
+      session.setConfig(neverCreateDevKey, true);
+    }
+  }
+  return false;
+};

package/util/enhanceErrorMessages.js

@@ -0,0 +1,23 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: gobichen@tencent.com
+ *
+ * 错误信息处理
+ */
+
+
+const program = require('commander');
+const chalk = require('chalk');
+
+module.exports = (methodName, log) => {
+  program.Command.prototype[methodName] = function (...args) {
+    if (methodName === 'unknownOption' && this._allowUnknownOption) {
+      return;
+    }
+    this.outputHelp();
+    // 标红输出 errorMessage
+    console.log(`  ${chalk.red(log(...args))}`);
+    console.log();
+    process.exit(1);
+  };
+};

package/util/errorHandler.js

@@ -0,0 +1,131 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: gobichen@tencent.com
+ *
+ * 错误处理
+ */
+
+const chalk = require('chalk');
+const { get } = require('lodash');
+const fs = require('fs-extra');
+const { resolve } = require('path');
+const os = require('os');
+const { tryFunc } = require('./tools');
+
+/**
+ * error 解析入口
+ * parseError(error): 根据axios error类型，选择解析方式
+ */
+function parseError(error) {
+  return error.isAxiosError
+    ? parseAxiosError(error)
+    : parseProcessError(error);
+}
+
+function isTokenError(error) {
+  const responseCode = get(error, 'response.status', 500);
+  const responseMessage = get(error, 'response.data.info', error.message);
+
+  // tapd 的特定逻辑
+  return responseCode === 422 && [
+    'The access token provided is invalid',
+    'Malformed token (missing "expires")',
+    'The access token provided has expired',
+  ].includes(responseMessage);
+}
+
+/**
+ * axios错误时调用
+ * @description parseAxiosError(error) 主要解析代理 TADP 接口的错误
+ * @param error object
+ * @return object
+ */
+function parseAxiosError(error) {
+  // 当代理不成功的时候推送 500
+  const responseCode = get(error, 'response.status', 500);
+  // TAPD 的错误原因会放在 data.info 中。当代理失败的时候直接用 error.message
+  const responseMessage = get(error, 'response.data.info', error.message);
+  const responseStatusText = get(error, 'response.statusText', 'Proxy Error');
+  const responseMeta = get(error, 'response.data.meta', {});
+
+  // 使用tryFunc 包装 JSON 解析方法
+  const stringifier = tryFunc(
+    error => JSON.stringify({
+      ...error.toJSON(),
+      responseHeader: error?.response?.headers,
+      responseData: error?.response?.data,
+    }, null, 2),
+    error.stack,
+  );
+
+  return {
+    code: responseCode,
+    status: responseStatusText,
+    message: isTokenError(error) ? `Token 失效，请重新登陆(${responseMessage})` : responseMessage,
+    // 解析json，return返回错误
+    detail: stringifier(error),
+    meta: responseMeta,
+  };
+}
+
+/**
+ * 解析进程错误
+ */
+function parseProcessError(error) {
+  return {
+    message: error.message,
+    detail: error.stack,
+  };
+}
+
+/**
+ * 错误处理入口
+ * @description ErrorHandle(error) 负责解析并格式化输出错误
+ */
+function ErrorHandle(error, { exit = true } = {}) {
+  const { title = 'TPLUGIN ERROR' } = error;
+
+  // 解析error报错信息 和 状态
+  const { message, detail, code = 500, status = '', meta = {} } = parseError(error);
+  const homedir = os.homedir();
+  const TAPD_PATH = resolve(homedir, '.tapd', 'logs');
+
+  if (!fs.pathExistsSync(TAPD_PATH)) {
+    fs.mkdirsSync(TAPD_PATH);
+  }
+
+  const date = new Date();
+  const logName = [
+    date.getFullYear(),
+    date.getMonth(),
+    date.getDate(),
+    date.getHours(),
+    date.getMinutes(),
+    date.getSeconds(),
+  ].join('-');
+  const logFile = resolve(TAPD_PATH, `${logName}.log`);
+
+  const requestIdMsg = meta.request_id ? `\nOr Ask Help to TAPDHelper With RequestId: ${meta.request_id}` : '';
+  // 格式化error
+  const log = `
+${chalk.red(title)}:
+code: ${code} ${status}
+message: ${message}
+
+A complete log of this run can be found in:
+  ${logFile}
+${requestIdMsg}`;
+
+  try {
+    // error msg 写log文件
+    fs.writeFileSync(logFile, detail);
+    // 控制台输出 error msg
+    console.log(log);
+  } catch (e) {
+    console.log(chalk.red(detail));
+  }
+
+  exit && process.exit(1);
+}
+
+module.exports = ErrorHandle;

package/util/getPluginCode.js

@@ -0,0 +1,38 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: terrysxu@tencent.com
+ *
+ * 获取当前插件Code
+ */
+const chalk = require('chalk');
+const fs = require('fs-extra');
+const yaml = require('js-yaml');
+
+/**
+ * @param {boolean} failBreak 错误时是否中断 指令 true: 中断当前CLI，用于单独的lint判断 false: 不中断进程，用于中间步骤判断
+ * @returns {boolean|string}
+ */
+module.exports = (failBreak = true) => {
+  const yamlPath = `${process.cwd()}/plugin.yaml`;
+  let docObj = {};
+  try {
+    // 读取并解析 plugin.yaml 文件
+    docObj = yaml.load(fs.readFileSync(yamlPath, 'utf8'));
+  } catch (e) {
+    console.log(chalk.red(`plugin.yaml格式错误.Err:${e}`));
+    if (failBreak) {
+      throw e;
+    }
+    return false;
+  }
+
+  if (!docObj.app.code) {
+    console.log(chalk.red('plugin.yaml 格式错误app code not found!'));
+    if (failBreak) {
+      process.exit(1);
+    }
+    return false;
+  }
+
+  return docObj.app.code;
+};

package/util/selectWorkspace.js

@@ -0,0 +1,70 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: terrysxu@tencent.com
+ *
+ * 获取当前插件Code
+ */
+
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const tapdsdk = require('../util/tapd');
+const tpluginConf = require('../config');
+const getPluginCode = require('./getPluginCode');
+
+/**
+ * 用于选择或者创建自己管理的项目
+ * @param {boolean} failBreak 错误时是否中断 指令 true: 中断当前CLI，用于单独的lint判断  false: 不中断进程，用于其他CLI的中间步骤，只关注结果
+ * @param {string} defaultItem 默认选择的项目
+ * @return object 返回选择的项目信息
+ */
+module.exports = async (failBreak = true, defaultItem = false) => {
+  const appCode = getPluginCode();
+  // 获取管理的项目列表
+  const { data } = await tapdsdk.request({ url: '/open_user_app/workspace_list', params: { code: appCode }, method: 'GET' });
+  const workspaces = data.data;
+  if (workspaces && workspaces.length === 0) {
+    // 空提示
+    console.log(chalk.red(`没有任何项目的管理权限。\n1.申请项目权限\n2.创建自己的调试项目：${tpluginConf.tapd.tapdHost}/workspaces/user_register_choose_template`));
+    if (failBreak) {
+      process.exit(1);
+    }
+    return false;
+  }
+
+  let workspace;
+  const choices = [];
+  for (let i = 0;i < workspaces.length;i++) {
+    workspace = workspaces[i].Workspace;
+
+    let itemInfo = `${workspace.id}:${workspace.name}`;
+    // 标记版本号到已经安装插件的项目
+    if (workspace.installed_type) {
+      if (workspace.installed_type === 2) {
+        itemInfo += chalk.red('\t[Debugging]');
+      } else {
+        itemInfo += chalk.red(`\t[已安装: ${workspace.app_version}]`);
+      }
+    }
+
+    const item = {
+      name: itemInfo,
+      value: i,
+    };
+    if (defaultItem && defaultItem === workspace.id) {
+      choices.unshift(item);
+    } else {
+      choices.push(item);
+    }
+  }
+
+  console.log('');
+  // 选择项目
+  const selectWorkspaceResult = await inquirer.prompt([{
+    type: 'list',
+    name: 'workspace',
+    message: '请选择一个调试项目',
+    choices,
+  }]);
+  const selectWorkspaceIdx = selectWorkspaceResult.workspace;
+  return workspaces[selectWorkspaceIdx].Workspace;
+};

package/util/session.js

@@ -0,0 +1,119 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: raferzeng@tencent.com
+ *
+ * local session
+ */
+
+const path = require('path');
+const fs = require('fs-extra');
+const homedir = require('os').homedir();
+const chalk = require('chalk');
+
+class Session {
+  constructor() {
+    this.tapdPath = path.resolve(homedir, '.tapd');
+    if (!fs.pathExistsSync(this.tapdPath)) {
+      fs.mkdirsSync(this.tapdPath);
+    }
+    this.configFile = path.resolve(this.tapdPath, 'config');
+  }
+
+  /**
+   * @param token 登录用户token
+   * @param userId 登录用户ID
+   */
+  persist(token, userId, companyId = '') {
+    const authInfo = {
+      token,
+      userId,
+      timestamp: Date.now(),
+      companyId,
+    };
+    try {
+      fs.writeFileSync(this.configFile, JSON.stringify(authInfo));
+      return true;
+    } catch (e) {
+      console.log(chalk.red('登陆信息写入失败'));
+      process.exit(1);
+    }
+  }
+
+  /**
+   * setConfig(key, val): 添加配置信息到配置文件中
+   * @param key 键
+   * @param val 值
+   * @return boolean
+   */
+  setConfig(key, val) {
+    try {
+      // 锁的需求场景几乎没有，暂时不引入
+      const info = JSON.parse(fs.readFileSync(this.configFile));
+      info[key] = val;
+      fs.writeFileSync(this.configFile, JSON.stringify(info));
+      return true;
+    } catch (e) {
+      console.log(chalk.red(`配置写入错误，[${key}] ,Err: ${e}`));
+      return false;
+    }
+  }
+
+  /**
+   * getConfig(key): 从配置文件中获取配置项 key
+   * @param key 键
+   */
+  getConfig(key) {
+    try {
+      const info = JSON.parse(fs.readFileSync(this.configFile));
+      return key in info ? info[key] : false;
+    } catch (e) {
+      console.log(chalk.red(`配置写入错误，[${key}] ,Err: ${e}`));
+      return false;
+    }
+  }
+
+  /**
+   * clear(): 清除登录和配置信息
+   */
+  clear() {
+    try {
+      fs.truncate(this.configFile);
+      return true;
+    } catch (e) {
+      console.log(chalk.red('登陆信息清除失败'));
+    }
+  }
+
+  /**
+   * token(): 获取登录用户token, 过期时，返回null
+   * @return null|string
+   */
+  token() {
+    if (!fs.pathExistsSync(this.configFile)) return null;
+
+    try {
+      const now = Date.now();
+      const session = fs.readJsonSync(this.configFile);
+      // 有效期两周
+      if (now - session.timestamp > 1000 * 3600 * 24 * 14) {
+        this.clear();
+        return null;
+      }
+      return session.token.trim();
+    } catch (e) {
+      return null;
+    }
+  }
+
+  /**
+   * checkAuth(): 校验当前登录态是否过期
+   */
+  checkAuth() {
+    if (!this.token()) {
+      console.log(chalk.red('未登陆或登陆态过期，请重新登录'));
+      process.exit(1);
+    }
+  }
+}
+
+module.exports = Session;

package/util/spinner.js

@@ -0,0 +1,14 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: raferzeng@tencent.com
+ *
+ * spinner config
+ */
+
+const ora = require('ora');
+const spinner = ora();
+
+// 统一添加 spinner 前缀
+spinner.prefixText = '\n';
+
+module.exports = spinner;

package/util/tapd.js

@@ -0,0 +1,14 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: gobichen@tencent.com
+ *
+ * tapd sdk import
+ */
+
+const Sdk = require('@tencent/tapd-node-sdk');
+const Session = require('./session');
+const session = new Session();
+const accessToken = session.token();
+const tpluginConf = require('../config');
+const tapdsdk = new Sdk({ address: tpluginConf.tapd.apiHost, accessToken });
+module.exports = tapdsdk;

package/util/tools.js

@@ -0,0 +1,46 @@
+/**
+ * tryFunc() 调用并包装异常为正常返回值
+ * @param {CallableFunction} fn - 调用的函数
+ * @param {Object} defaultRes - 默认的异常返回值
+ */
+function tryFunc(fn, defaultRes) {
+  return function (...args) {
+    try {
+      return fn(...args);
+    } catch (e) {
+      return defaultRes;
+    }
+  };
+}
+
+const fs = require('fs');
+const unzipper = require('unzipper');
+const axios = require('axios');
+
+
+const downloadAndUnzip = async (url) => {
+  const response = await axios.get(url, { responseType: 'stream' });
+  const writer = fs.createWriteStream('temp.zip');
+  response.data.pipe(writer);
+
+  await new Promise((resolve, reject) => {
+    writer.on('finish', resolve);
+    writer.on('error', reject);
+  });
+
+  const unzip = fs.createReadStream('temp.zip').pipe(unzipper.Extract({ path: '.' }));
+
+  await new Promise((resolve, reject) => {
+    unzip.on('close', resolve);
+    unzip.on('error', reject);
+  });
+
+  fs.unlinkSync('temp.zip');
+  console.log('Download and unzip complete!');
+};
+
+
+module.exports = {
+  tryFunc,
+  downloadAndUnzip,
+};

package/util/trimObjectValue.js

@@ -0,0 +1,10 @@
+/**
+ * Copyright 2021 Tencent Inc. All rights reserved.
+ * Author: gobichen@tencent.com
+ *
+ * object value trim
+ */
+
+module.exports = (obj) => {
+  Object.keys(obj).map(key => obj[key] = obj[key].trim());
+};