tt-minigame-ide-cli 0.0.1-beta.0

package/lib/util/helper.js

@@ -0,0 +1,242 @@
+const archiver = require('archiver');
+const path = require('path');
+const fs = require('fs-extra');
+const glob = require('glob');
+const {
+  getStoragePath
+} = require('./config');
+const previewFilePath = path.join(getStoragePath(), 'preview.json');
+fs.ensureFileSync(previewFilePath);
+
+function mixEncode(data) {
+  const str = data.toString();
+  const buff = [];
+  let i, len;
+  for (i = 0, len = str.length; i < len; i++) {
+    buff.push(str.charCodeAt(i));
+  }
+  const results = buff.map(b => b ^ 5);
+  const encode = [];
+  for (i = 0, len = results.length; i < len; i++) {
+    encode.push(results[i].toString(16));
+  }
+  return encode.join('');
+}
+
+async function zipFile(sourcePath, targetPath) {
+  const appJsonPath = path.join(sourcePath, 'app.json');
+  const isMiniProgram = await fs.pathExists(appJsonPath);
+  const subpackageInfoPath = path.join(sourcePath, `${isMiniProgram ? 'app.json' : 'game.json'}`);
+  const projectConfigJson = fs.readJSONSync(subpackageInfoPath);
+  const subPackagesArr = projectConfigJson.subPackages || projectConfigJson.subpackages;
+  const zipFileRet = {
+    filePath: null,
+  };
+  if (subPackagesArr && subPackagesArr.length > 0) {
+    const ifSubPackageUploadable = await verifySubPackageSize(projectConfigJson, isMiniProgram, sourcePath);
+    if (ifSubPackageUploadable) {
+      zipFileRet.filePath = await normalZipFile(sourcePath, targetPath, isMiniProgram, true);
+    }
+  } else {
+    zipFileRet.filePath = await normalZipFile(sourcePath, targetPath, isMiniProgram, false);
+  }
+  return zipFileRet;
+}
+
+/**
+ * @description 校验分包大小, 小游戏和小程序的不同在于子包不同
+ */
+async function verifySubPackageSize(projectConfigJson, isMiniProgram, sourcePath) {
+  let subPackageTotalSize = 0; // 子包+主包
+  // 做大小比较全拿字节数，精确
+  const packageSizeConfig = {
+    mainPackageMaxSize: 4 * 1024 * 1024,
+    subPackageSize: (this.isGame ? 4 : 2) * 1024 * 1024,
+    totalSize: 16 * 1024 * 1024,
+  };
+  // console.log('校验', projectConfigJson, packageSizeConfig);
+  // 开放数据域文件校验，可以认为开放数据域也作为一个子包
+  if (isMiniProgram && projectConfigJson.openDataContext) {
+    const openDataContextPath = path.join(sourcePath, projectConfigJson.openDataContext);
+    const openDataContextSize = await getFolderSize(openDataContextPath);
+    if (openDataContextSize > packageSizeConfig.subPackageSize) {
+      console.error(
+        `开放数据域文件大小为 ${getFormattedSize(
+                        openDataContextSize,
+                    )} MB, 超过 ${getFormattedSize(packageSizeConfig.subPackageSize)} MB，请调整包大小后再进行上传`,
+      );
+      return false;
+    }
+    subPackageTotalSize += openDataContextSize;
+  }
+  const totalPackageSize = await getFolderSize(sourcePath);
+  if (totalPackageSize > packageSizeConfig.totalSize) {
+    console.error(
+      `小${this.isGame ? '游戏' : '程序'}包大小为 ${getFormattedSize(
+                    totalPackageSize,
+                )} MB, 超过 16 MB，请调整包大小后再进行上传`,
+    );
+    return false;
+  }
+  const subPackagesArr = projectConfigJson.subPackages || projectConfigJson.subpackages;
+  // 遍历子包数组，比较大小
+  for (let subPackage of subPackagesArr) {
+    const subPackagePath = path.join(sourcePath, subPackage.root);
+    const subPackageSize = await getFolderSize(subPackagePath);
+    if (subPackageSize > packageSizeConfig.subPackageSize) {
+      console.error(
+        `${subPackage.root}子包大小为 ${getFormattedSize(
+          subPackageSize,
+                    )}MB, 超过${getFormattedSize(packageSizeConfig.subPackageSize)}MB，请调整包大小后再进行上传`,
+      );
+      return false;
+    } else {
+      console.log(
+        `${subPackage.root}子包大小为 ${getFormattedSize(
+          subPackageSize,
+                    )}MB, 符合上传 / 预览要求`,
+      );
+    }
+    subPackageTotalSize += subPackageSize;
+  }
+
+  const mainPackageSize = totalPackageSize - subPackageTotalSize;
+  if (mainPackageSize > packageSizeConfig.mainPackageMaxSize) {
+    console.error(
+      `主包大小为 ${getFormattedSize(mainPackageSize)}MB, 超过 4 MB，请调整包大小后再进行上传`,
+    );
+    return false;
+  }
+  console.log(`主包大小为 ${getFormattedSize(mainPackageSize)} MB, 符合上传 / 预览要求`)
+  return true;
+}
+
+async function normalZipFile(sourcePath, targetPath, isMiniProgram, isSubPackage) {
+
+  const packageSize = isMiniProgram ? 4 : 8;
+  const zipPath = path.join(targetPath, `${path.basename(sourcePath)}.zip`);
+  return new Promise(function (resolve, reject) {
+    const output = fs.createWriteStream(zipPath);
+    const archive = archiver('zip');
+
+    output.on('close', function () {
+      // zip包生成以后，填写appId，更新日志，上传，打包
+      if (!isSubPackage) {
+        const stats = fs.statSync(zipPath)
+        const fileSizeInBytes = stats["size"];
+        const fileSizeMb = fileSizeInBytes / 1000000.0;
+        if (fileSizeMb > packageSize) {
+          return reject(`zip file is larger than ${packageSize}MB`)
+        }
+      }
+      return resolve(zipPath);
+    });
+
+    archive.on('warning', function (err) {
+      if (err.code === 'ENOENT') {
+        // log warning
+      } else {
+        return reject(err)
+      }
+    });
+
+    archive.on('error', function (err) {
+      return reject(err)
+    });
+
+    archive.pipe(output);
+
+    archive.glob('**/*', {
+      cwd: sourcePath,
+      ignore: ['.*/**/*', 'node_modules/**/*']
+    }, {})
+
+    archive.finalize(function (err, bytes) {
+      if (err) {
+        return reject(err);
+      }
+    });
+  });
+}
+
+function compileErrFormat(errMsg = '') {
+  errMsg = errMsg.split('\n').filter(item => !item.trim().startsWith('at'));
+  return errMsg.join('\n');
+}
+
+function getPackageName() {
+  return require(`../../package.json`).name;
+}
+
+function savePreviewResult(url, type, hash) {
+  try {
+    const currentResult = JSON.parse(fs.readFileSync(previewFilePath, 'utf-8') || '{}');
+    currentResult[type] = url;
+    currentResult.time = Date.now();
+    currentResult.hash = hash;
+    fs.writeFileSync(previewFilePath, JSON.stringify(currentResult));
+  } catch (_) {
+    // do not report such error
+  }
+}
+
+/**
+ * @description 输入字节数，返回MB字符串
+ * @param [size] - number
+ */
+function getFormattedSize(size) {
+  const formattedSize = (size / 1024 / 1024).toFixed(2);
+  return formattedSize;
+}
+
+function getCachedPreviewResult(type, hash) {
+  try {
+    const currentResult = JSON.parse(fs.readFileSync(previewFilePath, 'utf-8') || '{}');
+    if (currentResult.hash === hash && currentResult[type]) {
+      const cacheTime = currentResult.time;
+      const daysPassed = (Date.now() - cacheTime || 0) / (60 * 60 * 1000 * 24);
+      if (daysPassed < 1) {
+        return currentResult[type];
+      }
+    }
+  } catch (_) {
+    // do not report such error
+  }
+}
+
+function getFolderSize(folderPath, options = {}) {
+  return new Promise((resolve, reject) => {
+    glob(
+      '**', 
+      {
+        cwd: folderPath,
+        ignore: options.ignore || ['**/.*', '**/node_modules/**', '**/**.js.map'],
+        absolute: true,
+      },
+      (err, matches) => {
+        if (err) {
+          return reject(err);
+        }
+        try {
+          let totalSize = 0;
+          matches.forEach(file => {
+            const stat = fs.statSync(file);
+            if (!stat.isDirectory()) totalSize += stat.size;
+          });
+          resolve(totalSize);
+        } catch (err) {
+          reject(err);
+        }
+      },
+    );
+  });
+}
+
+module.exports = {
+  mixEncode,
+  zipFile,
+  compileErrFormat,
+  getPackageName,
+  savePreviewResult,
+  getCachedPreviewResult
+}

package/lib/util/logger.js

@@ -0,0 +1,54 @@
+const readline = require('readline');
+const chalk = require('chalk');
+
+function formatTitle(severity, message) {
+  return chalk[bgColor(severity)].black('', message, '');
+}
+
+function formatText(severity, message) {
+  return chalk[textColor(severity)](message);
+}
+
+function textColor(severity) {
+  switch (severity.toLowerCase()) {
+    case 'success': return 'green';
+    case 'info': return 'blue';
+    case 'note': return 'white';
+    case 'warning': return 'yellow';
+    case 'error': return 'red';
+    default: return 'red';
+  }
+}
+
+function bgColor(severity) {
+  const color = textColor(severity);
+  return 'bg'+ capitalizeFirstLetter(color)
+}
+
+function capitalizeFirstLetter(string) {
+  return string.charAt(0).toUpperCase() + string.slice(1);
+}
+
+function outputResult(severity, title, subtitle) {
+  const titleFormatted = formatTitle(severity, title);
+  const subTitleFormatted = formatText(severity, subtitle);
+  const message = `${titleFormatted} ${subTitleFormatted}`;
+  console.log(message);
+}
+
+function clearConsole(title) {
+  if (process.stdout.isTTY) {
+    const blank = '\n'.repeat(process.stdout.rows);
+    console.log(blank);
+    readline.cursorTo(process.stdout, 0, 0);
+    readline.clearScreenDown(process.stdout);
+    if (title) {
+      console.log(title);
+    }
+  }
+}
+
+module.exports = {
+  clearConsole,
+  outputResult
+}

package/lib/util/qrcode.js

@@ -0,0 +1,19 @@
+const qrcode = require('qrcode-terminal');
+const chalk = require('chalk');
+function generateQrCode(url, options) {
+    // sometimes can not use small type, see: https://github.com/gtanner/qrcode-terminal/issues/21
+    qrcode.generate(url, { small: options.small });
+    let copied = '';
+    if (options.copy) {
+        require('clipboardy').writeSync(url);
+        copied = chalk.dim('(copied to clipboard)');
+    }
+    if (options.small) {
+        console.log(`${chalk.yellow('small QR Code may not work in some environments')}\n`);
+    }
+    console.log(`${chalk.cyan(JSON.stringify(url))} ${copied}`);
+}
+
+module.exports = {
+    generateQrCode,
+};

package/lib/util/request.js

@@ -0,0 +1,360 @@
+const axios = require('axios');
+const FormData = require('form-data');
+const querystring = require('querystring');
+const url = require('url');
+const fs = require('fs');
+const execa = require('execa');
+const {
+    getUserCookies
+} = require('./cookie');
+const {
+    compileErrFormat,
+    getPackageName
+} = require('./helper');
+const {
+    getVersion
+} = require('./version');
+const useBoeRequest = getVersion().includes('test');
+const URL = require('url');
+const baseParams = {
+    aid: 1365
+};
+const VERIFICATION_CODE_URL = '/passport/web/send_code';
+const MOBILE_LOGIN_URL = '/passport/web/sms_login';
+const EMAIL_LOGIN_URL = '/passport/web/email/login';
+const GET_USER_INFO = '/api/v1/user';
+const BASE_URL = useBoeRequest ? 'http://developer-boe.toutiao.com' : 'https://developer.toutiao.com';
+const REFERER = 'developer.toutiao.com';
+axios.defaults.baseURL = BASE_URL;
+
+// 为请求添加referer
+axios.interceptors.request.use(config => {
+    config.headers.Referer = REFERER;
+    if (config.data instanceof FormData) {
+        Object.assign(config.headers, config.data.getHeaders());
+      }
+    if(config.proxy) {
+        const parseURL = URL.parse(config.proxy.host);
+        config.httpsAgent = require('tunnel').httpsOverHttp({
+            proxy: {
+                host: parseURL.host,
+                port: config.proxy.port,
+            },
+            rejectUnauthorized: false
+        });
+        config.proxy = false;
+    }
+    return config;
+})
+
+exports.getMobileVerificationCode = function (mobile, proxy) {
+    const verificationOptions = {
+        method: 'get',
+        url: VERIFICATION_CODE_URL,
+        params: {
+            ...baseParams,
+            type: 24,
+            mobile
+        },
+        headers: {
+            'User-Agent': 'bytedanceide'
+        }
+    }
+    if (proxy && proxy.indexOf(':') > -1) {
+        const proxySplitArr = proxy.split(':');
+        const proxyPort = proxySplitArr.pop();
+        const proxyHost = proxySplitArr.join(':');
+        verificationOptions.proxy = {
+            host: proxyHost,
+            port: proxyPort
+        }
+    }
+    return axios(verificationOptions).then(res => {
+        const isSuccess = res.data.message === 'success';
+        // Not send res.data.data.description temporarily，because the tip is not for i18n
+        return {
+            success: isSuccess,
+            // msg: !isSuccess ? (res.data.data.description || 'Get verification code fail, please try later') : ''
+            msg: !isSuccess ? 'Get verification code fail, please try later' : ''
+        }
+    }).catch(err => {
+        return {
+            success: false,
+            msg: err.message
+        }
+    });
+}
+
+exports.userLogin = function (type, params, proxy) {
+    const userLoginOptions = {
+        url: type === 'mobile' ? MOBILE_LOGIN_URL : EMAIL_LOGIN_URL,
+        method: 'POST',
+        data: querystring.stringify({
+            ...baseParams,
+            ...params
+        }),
+        headers: {
+            'content-type': 'application/x-www-form-urlencoded'
+        }
+    }
+    if (proxy && proxy.indexOf(':') > -1) {
+        const proxySplitArr = proxy.split(':');
+        const proxyPort = proxySplitArr.pop();
+        const proxyHost = proxySplitArr.join(':');
+        userLoginOptions.proxy = {
+            host: proxyHost,
+            port: proxyPort
+        }
+    }
+    return axios(userLoginOptions).then(res => {
+        const isSuccess = res.data.message === 'success';
+        return {
+            success: isSuccess,
+            cookies: res.headers['set-cookie'],
+            msg: !isSuccess ? (res.data.data.description || 'Login failed, please try again') : ''
+        }
+    }).catch(err => {
+        return {
+            success: false,
+            msg: err.message
+        }
+    });
+}
+
+exports.getUserData = function (proxy) {
+    const userDataOption = {
+        params: {},
+        headers: {
+            Cookie: getUserCookies()
+        }
+    }
+    if (proxy && proxy.indexOf(':') > -1) {
+        const proxySplitArr = proxy.split(':');
+        const proxyPort = proxySplitArr.pop();
+        const proxyHost = proxySplitArr.join(':');
+        userDataOption.proxy = {
+            host: proxyHost,
+            port: proxyPort
+        }
+    }
+    return axios.get(GET_USER_INFO, userDataOption).then(res => {
+        const isSuccess = !res.data.error;
+        const userData = {
+            username: res.data.name || '',
+            avatar: res.data.avatar || '',
+            developerId: res.data.developer_id || '',
+            mobile: res.data.mobile || '',
+            email: res.data.email || '',
+            auditStatus: res.data.audit_status || 0,
+            uid: res.data.uid
+        };
+        return {
+            success: isSuccess,
+            userData,
+            msg: !isSuccess ? 'Login fail, please try later' : ''
+        }
+    }).catch(err => {
+        return {
+            success: false,
+            msg: err.message
+        }
+    });
+}
+
+exports.uploadProject = function ({
+    type,
+    appId,
+    zipPath,
+    versionInfo,
+    updateInfo,
+    proxy
+}) {
+    return new Promise(function (resolve, reject) {
+        let path;
+        const form = new FormData();
+        if (type === 'preview') {
+            // path = `/api/v2/app/${appId}/preview`
+            path = `/api/developer/ide/microgame/v1/preview?appid=${appId}`
+        } else {
+            // path = `/api/v2/app/${appId}/testing`
+            path = `/api/developer/ide/microgame/v1/testing?appid=${appId}`
+            form.append('version', versionInfo);
+            form.append('intro', updateInfo);
+        }
+        // form.append('render_type', 3);
+        form.append('source', fs.createReadStream(zipPath));
+        form.append('local_compile_version', '4.0.0-rc.12.ide');
+        const uploadOptions = {
+            method: 'put',
+            headers: {
+                'Cookie': getUserCookies()
+            },
+            url: path,
+            form,
+        }
+        if (proxy && proxy.indexOf(':') > -1) {
+            const proxySplitArr = proxy.split(':');
+            const proxyPort = proxySplitArr.pop();
+            const proxyHost = proxySplitArr.join(':');
+            uploadOptions.proxy = {
+                host: proxyHost,
+                port: proxyPort
+            }
+        }
+        axios.put(path, form, uploadOptions).then(res => {
+            if (res.data && res.data.error === 0) {
+                resolve();
+            } else {
+                reject(res.data.message)
+            }
+        }).catch(err => {
+            reject(err.message);
+        });
+    })
+}
+
+exports.getCompileProgress = function (appId, proxy) {
+    const compileProgressOption = {
+        headers: {
+            Cookie: getUserCookies()
+        }
+    }
+    if (proxy && proxy.indexOf(':') > -1) {
+        const proxySplitArr = proxy.split(':');
+        const proxyPort = proxySplitArr.pop();
+        const proxyHost = proxySplitArr.join(':');
+        compileProgressOption.proxy = {
+            host: proxyHost,
+            port: proxyPort
+        }
+    }
+    // return axios.get(`/api/v1/app/${appId}/compile_progress`, compileProgressOption).then(res => {
+    return axios.get(`/api/developer/ide/microgame/v1/compile_progress?appid=${appId}`, compileProgressOption).then(res => {
+        const {
+            error,
+            status,
+            message = ''
+        } = res.data || {};
+        if (error === 1) {
+            msg = message ? compileErrFormat(message) : 'Preview failed, please try later';
+            return {
+                success: false,
+                msg
+            }
+        }
+        return {
+            success: true,
+            done: error === 0 && status === 2,
+            msg: ''
+        }
+    }).catch(err => {
+        return {
+            success: false,
+            msg: err.message
+        }
+    });
+}
+
+exports.getQrCode = function (appId, proxy, type = 'preview') {
+    const requestHeader = {
+        Cookie: getUserCookies()
+    }
+    if (useBoeRequest) {
+        requestHeader['X-TT-ENV'] = 'test';
+    }
+    const qrCodeOptions = {
+        params: {
+            t: Date.now()
+        },
+        headers: requestHeader
+    }
+    if (proxy && proxy.indexOf(':') > -1) {
+        const proxySplitArr = proxy.split(':');
+        const proxyPort = proxySplitArr.pop();
+        const proxyHost = proxySplitArr.join(':');
+        qrCodeOptions.proxy = {
+            host: proxyHost,
+            port: proxyPort
+        }
+    }
+    return axios.get(`/api/v1/app/${appId}/${type}/qrcode_url`, qrCodeOptions).then(res => {
+        return {
+            success: true,
+            url: res.data,
+            msg: ''
+        }
+    }).catch(err => {
+        return {
+            success: false,
+            msg: err.message
+        }
+    });
+}
+
+exports.checkUserPermissions = function (appId, proxy) {
+    const permissionsOptions = {
+        headers: {
+            Cookie: getUserCookies()
+        }
+    }
+    if (proxy && proxy.indexOf(':') > -1) {
+        const proxySplitArr = proxy.split(':');
+        const proxyPort = proxySplitArr.pop();
+        const proxyHost = proxySplitArr.join(':');
+        permissionsOptions.proxy = {
+            host: proxyHost,
+            port: proxyPort
+        }
+    }
+    return axios.get(`/api/v1/app/${appId}/permissions`, permissionsOptions).then(res => {
+        const {
+            error,
+            message,
+            data
+        } = res.data || {};
+        if (error) {
+            const msg = message || 'Upload failed，please check if your appId is valid';
+            return {
+                success: false,
+                msg
+            };
+        }
+        if (data.is_admin || data.publish === 2) {
+            return {
+                success: true,
+                msg: ''
+            };
+        } else {
+            return {
+                success: false,
+                msg: 'You do not have permission to upload app'
+            };
+        }
+    }).catch(err => {
+        console.log(err)
+        return {
+            success: false,
+            msg: err.message
+        }
+    });
+}
+// 该方法暂无调用
+exports.checkRemoteVersion = async function () {
+    const registry = (await execa('npm', ['config', 'get', 'registry'])).stdout;
+    return axios.get(`${registry}${getPackageName()}`, {
+        params: {},
+        headers: {
+            Accept: 'application/vnd.npm.install-v1+json'
+        }
+    }).then(res => {
+        return {
+            version: res.data['dist-tags'].latest,
+            success: true
+        }
+    }).catch(err => {
+        return {
+            success: false,
+            msg: err.message
+        }
+    });
+}

package/lib/util/version.js

@@ -0,0 +1,27 @@
+const fs = require('fs-extra');
+const path = require('path');
+const { getStoragePath } = require('./config');
+const versionFilePath = path.join(getStoragePath(), 'version.json');
+fs.ensureFileSync(versionFilePath);
+
+function getVersion() {
+  return require(`../../package.json`).version;
+}
+
+async function saveLatestVersionToLocal(version, time) {
+  await fs.writeFile(versionFilePath, JSON.stringify({
+    "version": version,
+    "time": time
+  }));
+}
+
+async function getLatestVersionFromLocal() {
+  const fileData = await fs.readFile(versionFilePath, 'utf-8');
+  return JSON.parse(fileData || "{}");
+}
+
+module.exports = {
+  getVersion,
+  saveLatestVersionToLocal,
+  getLatestVersionFromLocal
+}