@abtnode/core 1.16.6-beta-4562aa60 → 1.16.6-beta-eaa4d39d

package/lib/util/maintain.js

@@ -1,59 +1,15 @@
 /* eslint-disable no-param-reassign */
-const semver = require('semver');
 const sleep = require('@abtnode/util/lib/sleep');
 const SysInfo = require('systeminformation');
 const { NODE_MODES, NODE_MAINTAIN_PROGRESS, EVENTS } = require('@abtnode/constant');
-const listNpmPackageVersion = require('@abtnode/util/lib/list-npm-package-version');
 const Lock = require('@abtnode/util/lib/lock');
 const logger = require('@abtnode/logger')('@abtnode/core:maintain');
 
 const states = require('../states');
-const doRpc = require('./rpc');
+const { doRpcCall, startRpcServer } = require('./rpc');
 
 const lock = new Lock('node-upgrade-lock');
 
-// eslint-disable-next-line no-unused-vars
-const checkNewVersion = async (params, context) => {
-  try {
-    const info = await states.node.read();
-
-    if (!process.env.ABT_NODE_PACKAGE_NAME) {
-      logger.error('ABT_NODE_PACKAGE_NAME name was not found in environment');
-      return '';
-    }
-
-    const versions = await listNpmPackageVersion(process.env.ABT_NODE_PACKAGE_NAME);
-    if (Array.isArray(versions) && versions.length) {
-      const latestVersion = versions[0].version;
-      if (semver.gt(latestVersion, info.version)) {
-        // if (semver.gte(latestVersion, info.version)) {
-        logger.info('New version found for Blocklet Server', {
-          latestVersion,
-          currentVersion: info.version,
-          nextVersion: info.nextVersion,
-        });
-        await states.node.updateNodeInfo({ nextVersion: latestVersion });
-        await states.notification.create({
-          title: 'Blocklet Server upgrade available',
-          description: 'A new and improved version of blocklet server is now available',
-          entityType: 'node',
-          severity: 'info',
-          sticky: true,
-          action: '/settings/about',
-        });
-
-        return latestVersion;
-      }
-    }
-
-    return '';
-  } catch (err) {
-    logger.error('Failed to check new version for Blocklet Server', { error: err });
-  }
-
-  return '';
-};
-
 const triggerMaintain = async ({ action, next }) => {
   if (['upgrade', 'restart'].includes(action) === false) {
     throw new Error(`Unrecognized server maintain action: ${action}`);
@@ -98,6 +54,8 @@ const triggerMaintain = async ({ action, next }) => {
     throw new Error(`${action} aborted due to invalid session: ${sessionId}`);
   }
 
+  await startRpcServer();
+
   process.nextTick(async () => {
     await next(session);
   });
@@ -134,7 +92,7 @@ const resumeMaintain = async (session) => {
 
   // 2. install new version
   if (session.stage === NODE_MAINTAIN_PROGRESS.INSTALLING) {
-    const result = await doRpc({ command: 'install', version: to });
+    const result = await doRpcCall({ command: 'install', version: to });
     logger.info('new version installed', { from, to, sessionId });
     if (result.code !== 0) {
       await sleep(3000);
@@ -144,7 +102,7 @@ const resumeMaintain = async (session) => {
 
   // 2. verify new version
   if (session.stage === NODE_MAINTAIN_PROGRESS.VERIFYING) {
-    const result = await doRpc({ command: 'verify', version: to });
+    const result = await doRpcCall({ command: 'verify', version: to });
     await sleep(3000);
     if (result.code === 0) {
       logger.info('new version verified', { from, to, sessionId });
@@ -164,6 +122,7 @@ const resumeMaintain = async (session) => {
     await states.node.updateNodeInfo({ nextVersion: '', version: from, upgradeSessionId: '' });
     try {
       await states.node.exitMode(NODE_MODES.MAINTENANCE);
+      await doRpcCall({ command: 'shutdown' });
     } catch (error) {
       logger.error('Failed to rollback', { error });
     }
@@ -177,7 +136,7 @@ const resumeMaintain = async (session) => {
     await sleep(3000);
     await goNextState(NODE_MAINTAIN_PROGRESS.CLEANUP, true);
     await sleep(3000);
-    await doRpc({ command: 'restart', dataDir: process.env.ABT_NODE_DATA_DIR });
+    await doRpcCall({ command: 'restart', dataDir: process.env.ABT_NODE_DATA_DIR });
     await lock.release();
     return; // we should abort here and resume after restart
   }
@@ -190,6 +149,7 @@ const resumeMaintain = async (session) => {
     await states.node.updateNodeInfo({ nextVersion: '', version: to, upgradeSessionId: '' });
     try {
       await states.node.exitMode(NODE_MODES.MAINTENANCE);
+      await doRpcCall({ command: 'shutdown' });
     } catch (error) {
       logger.error('Failed to exit maintenance mode', { error });
     }
@@ -215,19 +175,4 @@ const isBeingMaintained = async () => {
   return session;
 };
 
-const getCron = () => ({
-  name: 'check-update',
-  time: '0 0 8 * * *', // check every day
-  // time: '0 */5 * * * *', // check every 5 minutes
-  fn: async () => {
-    const info = await states.node.read();
-    if (!info.autoUpgrade) {
-      return;
-    }
-
-    checkNewVersion();
-  },
-  options: { runOnInit: false },
-});
-
-module.exports = { getCron, checkNewVersion, resumeMaintain, triggerMaintain, isBeingMaintained };
+module.exports = { resumeMaintain, triggerMaintain, isBeingMaintained };

package/lib/util/rotator.js

@@ -0,0 +1,194 @@
+/**
+ * Base on: https://github.com/keymetrics/pm2-logrotate
+ */
+const fs = require('fs-extra');
+const path = require('path');
+const moment = require('moment-timezone');
+const zlib = require('zlib');
+const log = require('@abtnode/logger');
+
+const buildLogger =
+  (func) =>
+  (...args) => {
+    if (typeof args[0] === 'string') {
+      func(`pm2.log.rotate.${args[0]}`, ...args.slice(1));
+      return;
+    }
+
+    func('pm2.log.rotate', ...args);
+  };
+
+// eslint-disable-next-line no-console
+const logInfo = buildLogger(console.info);
+const logError = buildLogger(console.error);
+
+module.exports = class LogRotate {
+  constructor({ compress, dateFormat, tz, retain } = {}) {
+    this.compress = compress;
+    this.dateFormat = dateFormat;
+    this.tz = tz;
+    this.retain = retain;
+    this.compressedFileFormat = '.gz';
+  }
+
+  getLimitSize(maxSize) {
+    if (!maxSize) {
+      return 1024 * 1024 * 10; // 10M
+    }
+
+    if (typeof maxSize === 'number') {
+      return maxSize;
+    }
+
+    if (typeof maxSize !== 'string') {
+      throw new Error('maxSize must be a string or number');
+    }
+
+    // eslint-disable-next-line no-param-reassign
+    maxSize = maxSize.trim();
+
+    const unit = maxSize[maxSize.length - 1].toUpperCase();
+    if (unit === 'G') {
+      return parseInt(maxSize, 10) * 1024 * 1024 * 1024;
+    }
+
+    if (unit === 'M') {
+      return parseInt(maxSize, 10) * 1024 * 1024;
+    }
+
+    if (unit === 'K') {
+      return parseInt(maxSize, 10) * 1024;
+    }
+
+    return parseInt(maxSize, 10);
+  }
+
+  /**
+   * Apply the rotation process of the log file.
+   *
+   * @param {string} file
+   */
+  proceed(file, callback = () => {}) {
+    // set default final time
+    let finalTime = moment().subtract(1, 'day').format(this.dateFormat);
+    // check for a timezone
+    if (this.tz) {
+      try {
+        finalTime = moment().tz(this.tz).subtract(1, 'day').format(this.dateFormat);
+      } catch (err) {
+        // use default
+      }
+    }
+
+    const filename = path.basename(file, path.extname(file));
+    const dirname = path.dirname(file);
+    const extName = this.compress ? `.log${this.compressedFileFormat}` : '.log';
+
+    let finalName = `${path.join(dirname, filename)}-${finalTime}${extName}`;
+
+    // 这种情况是为了兼容，之间的日志文件名中的日志大了一天，所以升级时旧数据可能存在重复
+    if (fs.existsSync(finalName)) {
+      finalName = `${path.join(dirname, filename)}-${finalTime}.1${extName}`;
+    }
+
+    // if compression is enabled, add gz extention and create a gzip instance
+    let GZIP;
+    if (this.compress) {
+      GZIP = zlib.createGzip({
+        level: zlib.constants.Z_BEST_COMPRESSION,
+        memLevel: zlib.constants.Z_BEST_COMPRESSION,
+      });
+    }
+
+    // create our read/write streams
+    const readStream = fs.createReadStream(file);
+    const writeStream = fs.createWriteStream(finalName, { flags: 'w+' });
+
+    // pipe all stream
+    if (this.compress) {
+      readStream.pipe(GZIP).pipe(writeStream);
+    } else {
+      readStream.pipe(writeStream);
+    }
+
+    const onError = (err) => {
+      logError(err);
+      callback(err);
+    };
+
+    // listen for error
+    readStream.on('error', onError);
+    writeStream.on('error', onError);
+    if (this.compression) {
+      GZIP.on('error', onError);
+    }
+
+    // when the read is done, empty the file and check for retain option
+    writeStream.on('finish', () => {
+      if (GZIP) {
+        GZIP.close();
+      }
+      readStream.close();
+      writeStream.close();
+
+      fs.truncateSync(file);
+      logInfo('rotated file:', finalName);
+
+      callback(null, finalName);
+    });
+  }
+
+  proceedSync(file) {
+    return new Promise((resolve, reject) => {
+      this.proceed(file, (err, res) => {
+        if (err) {
+          return reject(err);
+        }
+
+        return resolve(res);
+      });
+    });
+  }
+
+  /**
+   * Apply the rotation process if the `file` size exceeds the `SIZE_LIMIT`.
+   *
+   * @param {string} file
+   */
+  async proceedFile(file) {
+    if (!fs.existsSync(file)) {
+      return;
+    }
+
+    if (fs.statSync(file).size > 0) {
+      await this.proceedSync(file);
+    }
+
+    log.deleteOldLogfiles(file, this.retain);
+  }
+
+  /**
+   * Apply the rotation process of all log files of `app` where the file size exceeds the`SIZE_LIMIT`.
+   *
+   * @param {Object} app
+   */
+  async proceedPm2App(app) {
+    // Check all log path
+    // Note: If same file is defined for multiple purposes, it will be processed once only.
+    if (app.pm2_env.pm_out_log_path) {
+      await this.proceedFile(app.pm2_env.pm_out_log_path);
+    }
+
+    if (app.pm2_env.pm_err_log_path && app.pm2_env.pm_err_log_path !== app.pm2_env.pm_out_log_path) {
+      await this.proceedFile(app.pm2_env.pm_err_log_path);
+    }
+
+    if (
+      app.pm2_env.pm_log_path &&
+      app.pm2_env.pm_log_path !== app.pm2_env.pm_out_log_path &&
+      app.pm2_env.pm_log_path !== app.pm2_env.pm_err_log_path
+    ) {
+      await this.proceedFile(app.pm2_env.pm_log_path);
+    }
+  }
+};

package/lib/util/rpc.js

@@ -1,16 +1,77 @@
+/* eslint-disable no-console */
 const axon = require('axon');
+const kill = require('kill-port');
+const path = require('path');
+const spawn = require('cross-spawn');
+
 const logger = require('@abtnode/logger')('@abtnode/core:rpc');
 
-const sock = axon.socket('req');
-sock.connect(Number(process.env.ABT_NODE_UPDATER_PORT || 40405), '127.0.0.1');
+const host = '127.0.0.1';
+const port = Number(process.env.ABT_NODE_UPDATER_PORT || 40405);
 
-const doRpc = async (message) =>
+const doRpcCall = async (message) =>
   new Promise((resolve) => {
-    logger.info('send rpc request', message);
-    sock.send(JSON.stringify(message), (result) => {
-      logger.info('receive rpc response', result);
-      resolve(result);
+    logger.info('try send rpc request', message);
+    const sock = axon.socket('req');
+    sock.connect(port, host);
+    sock.on('connect', () => {
+      sock.send(JSON.stringify(message), (result) => {
+        logger.info('receive rpc response', result);
+        sock.close();
+        resolve(result);
+      });
     });
   });
 
-module.exports = doRpc;
+const startRpcServer = async () => {
+  try {
+    await kill(port, 'tcp');
+    console.info('Killed existing rpc server');
+  } catch (err) {
+    console.error('Failed to kill existing rpc server', err);
+  }
+
+  console.info(`Rpc Server started on ${new Date().toISOString()}`);
+  const child = spawn('node', [path.join(__dirname, '../processes/updater.js')], {
+    detached: true,
+    windowsHide: true, // required for Windows
+    cwd: process.cwd(),
+    timeout: 60 * 60 * 1000, // 60 minutes
+    shell: process.env.SHELL || false,
+    stdio: ['ignore', process.stdout, process.stderr],
+    env: {
+      PATH: process.env.PATH,
+      PM2_HOME: process.env.PM2_HOME,
+      ABT_NODE_UPDATER_PORT: process.env.ABT_NODE_UPDATER_PORT,
+      ABT_NODE_PACKAGE_NAME: process.env.ABT_NODE_PACKAGE_NAME,
+      ABT_NODE_BINARY_NAME: process.env.ABT_NODE_BINARY_NAME,
+      ABT_NODE_COMMAND_NAME: process.env.ABT_NODE_COMMAND_NAME,
+    },
+  });
+
+  child.on('error', (err) => {
+    console.error('Rpc Server errored', err);
+  });
+
+  child.on('close', (code) => {
+    console.info(`Rpc Server exited with code ${code} on ${new Date().toISOString()}`);
+  });
+
+  child.unref();
+};
+
+module.exports = { doRpcCall, startRpcServer };
+
+// Following script used to test the upgrade process
+// process.env.SHELL = '/opt/homebrew/bin/zsh';
+// process.env.PM2_HOME = '/Users/wangshijun/.arcblock/abtnode';
+// process.env.ABT_NODE_UPDATER_PORT = '40405';
+// process.env.ABT_NODE_PACKAGE_NAME = '@blocklet/cli';
+// process.env.ABT_NODE_BINARY_NAME = 'blocklet';
+// process.env.ABT_NODE_COMMAND_NAME = 'blocklet server';
+// startRpcServer().then(async () => {
+//   let result = await doRpcCall({ command: 'verify', version: '1.16.5' });
+//   console.log(result);
+//   result = await doRpcCall({ command: 'shutdown', version: '1.16.5' });
+//   console.log(result);
+// });

package/lib/validators/user.js

@@ -0,0 +1,44 @@
+const JOI = require('joi');
+const { didExtension } = require('@blocklet/meta/lib/extension');
+
+const Joi = JOI.extend(didExtension);
+
+// TODO: @zhanghan 这里目前仅包含必填的字段，后续需要增加其他字段
+const passportSchema = Joi.object({
+  id: Joi.string().required(),
+  role: Joi.string().required(),
+  name: Joi.string().required(),
+})
+  .unknown()
+  .empty(null);
+
+// TODO: @zhanghan 这里目前仅包含必填的字段，后续需要增加其他字段
+const connectedAccountSchema = Joi.object({
+  provider: Joi.string().required(),
+  did: Joi.DID().trim().required(),
+  pk: Joi.string().optional(),
+  id: Joi.string().optional(),
+  firstLoginAt: Joi.string().optional(),
+  lastLoginAt: Joi.string().optional(),
+})
+  .unknown()
+  .empty(null);
+
+const loginSchema = Joi.object({
+  did: Joi.DID().trim().required(),
+  pk: Joi.string().required(),
+  fullName: Joi.string().empty(''),
+  avatar: Joi.string().empty(''),
+  email: Joi.string().empty(''),
+  role: Joi.string().empty(''),
+  locale: Joi.string().empty(''),
+  extra: Joi.object(),
+  remark: Joi.string().empty(''),
+  lastLoginIp: Joi.string().empty(''),
+  passport: passportSchema.optional(),
+  connectedAccount: Joi.alternatives()
+    .try(connectedAccountSchema.required(), Joi.array().items(connectedAccountSchema).min(1).sparse(true))
+    .required(),
+}).unknown();
+
+exports.loginSchema = loginSchema;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.6-beta-4562aa60",
+  "version": "1.16.6-beta-eaa4d39d",
   "description": "",
   "main": "lib/index.js",
   "files": [
@@ -19,39 +19,42 @@
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/auth": "1.16.6-beta-4562aa60",
-    "@abtnode/certificate-manager": "1.16.6-beta-4562aa60",
-    "@abtnode/constant": "1.16.6-beta-4562aa60",
-    "@abtnode/cron": "1.16.6-beta-4562aa60",
-    "@abtnode/db": "1.16.6-beta-4562aa60",
-    "@abtnode/logger": "1.16.6-beta-4562aa60",
-    "@abtnode/queue": "1.16.6-beta-4562aa60",
-    "@abtnode/rbac": "1.16.6-beta-4562aa60",
-    "@abtnode/router-provider": "1.16.6-beta-4562aa60",
-    "@abtnode/static-server": "1.16.6-beta-4562aa60",
-    "@abtnode/timemachine": "1.16.6-beta-4562aa60",
-    "@abtnode/util": "1.16.6-beta-4562aa60",
-    "@arcblock/did": "1.18.72",
+    "@abtnode/auth": "1.16.6-beta-eaa4d39d",
+    "@abtnode/certificate-manager": "1.16.6-beta-eaa4d39d",
+    "@abtnode/constant": "1.16.6-beta-eaa4d39d",
+    "@abtnode/cron": "1.16.6-beta-eaa4d39d",
+    "@abtnode/db": "1.16.6-beta-eaa4d39d",
+    "@abtnode/logger": "1.16.6-beta-eaa4d39d",
+    "@abtnode/queue": "1.16.6-beta-eaa4d39d",
+    "@abtnode/rbac": "1.16.6-beta-eaa4d39d",
+    "@abtnode/router-provider": "1.16.6-beta-eaa4d39d",
+    "@abtnode/static-server": "1.16.6-beta-eaa4d39d",
+    "@abtnode/timemachine": "1.16.6-beta-eaa4d39d",
+    "@abtnode/util": "1.16.6-beta-eaa4d39d",
+    "@arcblock/did": "1.18.73",
+    "@arcblock/did-auth": "1.18.73",
+    "@arcblock/did-ext": "^1.18.73",
     "@arcblock/did-motif": "^1.1.10",
-    "@arcblock/did-util": "1.18.72",
-    "@arcblock/event-hub": "1.18.72",
-    "@arcblock/jwt": "^1.18.72",
+    "@arcblock/did-util": "1.18.73",
+    "@arcblock/event-hub": "1.18.73",
+    "@arcblock/jwt": "^1.18.73",
     "@arcblock/pm2-events": "^0.0.5",
-    "@arcblock/vc": "1.18.72",
-    "@blocklet/constant": "1.16.6-beta-4562aa60",
-    "@blocklet/meta": "1.16.6-beta-4562aa60",
-    "@blocklet/sdk": "1.16.6-beta-4562aa60",
-    "@did-space/client": "^0.2.77",
+    "@arcblock/vc": "1.18.73",
+    "@blocklet/constant": "1.16.6-beta-eaa4d39d",
+    "@blocklet/meta": "1.16.6-beta-eaa4d39d",
+    "@blocklet/sdk": "1.16.6-beta-eaa4d39d",
+    "@did-space/client": "^0.2.80",
     "@fidm/x509": "^1.2.1",
-    "@ocap/client": "1.18.72",
-    "@ocap/mcrypto": "1.18.72",
-    "@ocap/util": "1.18.72",
-    "@ocap/wallet": "1.18.72",
+    "@ocap/client": "1.18.73",
+    "@ocap/mcrypto": "1.18.73",
+    "@ocap/util": "1.18.73",
+    "@ocap/wallet": "1.18.73",
     "@slack/webhook": "^5.0.4",
     "archiver": "^5.3.1",
     "axios": "^0.27.2",
     "axon": "^2.0.3",
     "chalk": "^4.1.2",
+    "cross-spawn": "^7.0.3",
     "dayjs": "^1.11.7",
     "deep-diff": "^1.0.2",
     "detect-port": "^1.5.1",
@@ -67,8 +70,10 @@
     "is-url": "^1.2.4",
     "joi": "17.7.0",
     "js-yaml": "^4.1.0",
+    "kill-port": "^2.0.1",
     "lodash": "^4.17.21",
     "lru-cache": "^6.0.0",
+    "moment-timezone": "^0.5.37",
     "node-stream-zip": "^1.15.0",
     "p-limit": "^3.1.0",
     "p-retry": "4.6.1",
@@ -93,5 +98,5 @@
     "express": "^4.18.2",
     "jest": "^27.5.1"
   },
-  "gitHead": "e49856099ffc3c16eda77480a7ad93b2e9760764"
+  "gitHead": "0d2ab99f67109e989f8182fc70bc3ee9fa430585"
 }