@abtnode/core 1.16.14-beta-0c29907f → 1.16.14-beta-1936d3d0

package/lib/blocklet/manager/disk.js

@@ -77,7 +77,7 @@ const {
   SUSPENDED_REASON,
 } = require('@blocklet/constant');
 const isUndefined = require('lodash/isUndefined');
-const { WELLKNOWN_SERVICE_PATH_PREFIX } = require('@abtnode/constant');
+const { WELLKNOWN_SERVICE_PATH_PREFIX, WELLKNOWN_BLOCKLET_ADMIN_PATH } = require('@abtnode/constant');
 const { signV2 } = require('@arcblock/jwt');
 const normalizePathPrefix = require('@abtnode/util/lib/normalize-path-prefix');
 const pLimit = require('p-limit');
@@ -477,18 +477,6 @@ class DiskBlockletManager extends BaseBlockletManager {
       blocklet1.status = BlockletStatus.starting;
       this.emit(BlockletEvents.statusChange, doc1);
 
-      if (blocklet1.mode === BLOCKLET_MODES.DEVELOPMENT) {
-        const { logsDir } = blocklet1.env;
-
-        try {
-          fs.removeSync(logsDir);
-          fs.mkdirSync(logsDir, { recursive: true });
-        } catch {
-          // Windows && Node.js 18.x 下会发生删除错误(ENOTEMPTY)
-          // 但是这个错误并不影响后续逻辑，所以这里对这个错误做了 catch
-        }
-      }
-
       const blocklet = await ensureAppPortsNotOccupied({ blocklet: blocklet1, componentDids, states, manager: this });
 
       const getHookFn =
@@ -622,6 +610,16 @@ class DiskBlockletManager extends BaseBlockletManager {
         components: getComponentsInternalInfo(res),
       });
 
+      this._createNotification(did, {
+        title: '',
+        description: `${
+          componentDids?.length ? getComponentNamesWithVersion(blocklet, componentDids) : 'All components'
+        } is successfully stopped for ${blocklet.meta.title}.`,
+        entityType: 'blocklet',
+        entityId: did,
+        severity: 'success',
+      });
+
       return res;
     }
 
@@ -1311,7 +1309,7 @@ class DiskBlockletManager extends BaseBlockletManager {
     const enabled = newConfig?.email?.enabled;
     if (enabled) {
       const { error } = emailConfigSchema.validate(
-        pick(newConfig?.email || {}, ['from', 'host', 'port', 'user', 'password'])
+        pick(newConfig?.email || {}, ['from', 'host', 'port', 'user', 'password', 'secure'])
       );
       if (error) {
         logger.error('configNotification validate error', { error });
@@ -1510,7 +1508,7 @@ class DiskBlockletManager extends BaseBlockletManager {
             addToUpdates(component.meta.did, status);
             logger.info('will sync status from pm2', { did, status, oldStatus, componentDid: component.meta.did });
           }
-        } catch {
+        } catch (error) {
           if (
             ![
               BlockletStatus.added,
@@ -1519,11 +1517,21 @@ class DiskBlockletManager extends BaseBlockletManager {
               BlockletStatus.installing,
               BlockletStatus.installed,
               BlockletStatus.upgrading,
-            ].includes(component.status)
+            ].includes(component.status) &&
+            (error.code !== 'BLOCKLET_PROCESS_404' ||
+              ![BlockletStatus.stopped, BlockletStatus.error].includes(component.status))
           ) {
+            const oldStatus = component.status;
             const status = BlockletStatus.stopped;
             component.status = status;
             addToUpdates(component.meta.did, status);
+            logger.info('will sync status from pm2', {
+              did,
+              status,
+              oldStatus,
+              componentDid: component.meta.did,
+              error: error.message,
+            });
           }
         }
       },
@@ -2013,6 +2021,16 @@ class DiskBlockletManager extends BaseBlockletManager {
 
       this.emit(BlockletEvents.statusChange, res);
       this.emit(BlockletEvents.started, { ...res, componentDids });
+      this._createNotification(did, {
+        title: '',
+        description: `${getComponentNamesWithVersion(blocklet, componentDids)} is successfully started for ${
+          blocklet.meta.title
+        }.`,
+        entityType: 'blocklet',
+        entityId: did,
+        severity: 'success',
+      });
+
       logger.info('blocklet healthy', { did, name, time: Date.now() - startedAt });
     } catch (error) {
       const status = await states.blocklet.getBlockletStatus(did);
@@ -2543,7 +2561,7 @@ class DiskBlockletManager extends BaseBlockletManager {
     try {
       // delete old process
       try {
-        await this.deleteProcess({ did }, context);
+        await this.deleteProcess({ did, componentDids }, context);
         logger.info('delete blocklet process for upgrading', { did, name });
       } catch (err) {
         logger.error('delete blocklet process for upgrading', { did, name, error: err });
@@ -2965,7 +2983,9 @@ class DiskBlockletManager extends BaseBlockletManager {
         if (blocklet) {
           const urls = blocklet.site?.domainAliases || [];
           const customUrl = urls.find((x) => !x.isProtected)?.value;
-          blockletUrl = `http://${customUrl || getDidDomainForBlocklet({ appPid: blocklet.appPid })}`;
+          blockletUrl = `http://${
+            customUrl || getDidDomainForBlocklet({ appPid: blocklet.appPid })
+          }${WELLKNOWN_BLOCKLET_ADMIN_PATH}`;
         }
       } catch (error) {
         logger.error('[_createNotification] get blocklet url failed', { error });

package/lib/states/audit-log.js

@@ -128,7 +128,7 @@ const getLogContent = async (action, args, context, result, info, node) => {
     case 'deleteComponent':
       return `removed ${result.deletedComponent.meta.title}@${result.deletedComponent.meta.version} ${ args.keepData !== false ? 'but kept its data and config' : 'and its data and config' }`; // prettier-ignore
     case 'configBlocklet':
-      return `updated following config for ${args.did?.length > 1 ? componentOrApplicationInfo(result, [args.did[1]]) : 'application'}: ${args.configs.map(x => `* ${x.key}`).join(', ')}`; // prettier-ignore
+      return `updated following config for ${args.did?.length > 1 ? componentOrApplicationInfo(result, [args.did[1]]) : 'application'}: ${args.configs.map(x => `*${x.key}*`).join(', ')}`; // prettier-ignore
     case 'backupToSpaces':
       if (args?.success) {
         return `Backup application to ${args.url} successfully:\n- Backup files have been stored [here](${args.backupUrl})`;

package/lib/util/blocklet.js

@@ -157,10 +157,9 @@ const getComponentDirs = (
   // FIXME 这个函数做了太多的事
   // get data dirs
 
-  const { name: appName } = ancestors.concat(component)[0].meta;
   const componentName = getComponentName(component, ancestors);
 
-  const logsDir = path.join(dataDirs.logs, appName);
+  const logsDir = path.join(dataDirs.logs, componentName);
   const dataDir = path.join(dataDirs.data, componentName);
   const cacheDir = path.join(dataDirs.cache, componentName);
 

package/lib/util/log.js

@@ -0,0 +1,403 @@
+/* eslint-disable no-underscore-dangle */
+const path = require('path');
+const createArchive = require('archiver');
+const fs = require('fs-extra');
+const glob = require('fast-glob');
+const isEqual = require('lodash/isEqual');
+const { Tail } = require('tail');
+const readLastLines = require('read-last-lines');
+const { BLOCKLET_MODES } = require('@blocklet/constant');
+const { findComponentByIdV2 } = require('@blocklet/meta/lib/util');
+const dayjs = require('@abtnode/util/lib/dayjs');
+const logger = require('@abtnode/logger')(require('../../package.json').name);
+
+class StreamLog {
+  constructor() {
+    this._files = null; // Object { <level>: <filePath> }
+    this._tails = null; // Object { <level>: <Tail> }
+  }
+
+  /**
+   * @param {Object} files Object { <level>: <filePath> }
+   * @return {Boolean} if files change
+   */
+  setFiles(files) {
+    if (!isEqual(this._files, files)) {
+      this.clearTails();
+      this._files = files;
+      return true;
+    }
+    return false;
+  }
+
+  getRecent(lineNum, callback) {
+    if (!this._files) {
+      callback(new Error('files is empty'));
+    }
+    Object.entries(this._files).forEach(([level, file]) => {
+      if (!file || !fs.existsSync(file)) {
+        return;
+      }
+      readLastLines
+        .read(file, lineNum || 0)
+        .then((data) => {
+          callback(null, level, data);
+        })
+        .catch((error) => {
+          callback(error, level);
+        });
+    });
+  }
+
+  ensureTails() {
+    if (this._tails) {
+      return this._tails;
+    }
+    if (!this._files) {
+      return {};
+    }
+    try {
+      this._tails = {};
+      Object.entries(this._files).forEach(([level, file]) => {
+        if (!file || !fs.existsSync(file)) {
+          return;
+        }
+
+        // 测试发现 Windows 下 fs.watch 没有效果，但是 fs.watch 的性能更好，所以只在 windows 下使用 fs.watchFile
+        this._tails[level] = new Tail(file, {
+          useWatchFile: process.platform === 'win32',
+          fsWatchOptions: { interval: 1500 },
+        });
+      });
+      return this._tails;
+    } catch (error) {
+      this._tails = null;
+      throw error;
+    }
+  }
+
+  clearTails() {
+    if (this._tails) {
+      Object.values(this._tails).forEach((tail) => {
+        tail.unwatch();
+      });
+      this._tails = null;
+    }
+  }
+}
+
+const createFile = (files) => {
+  Object.values(files).forEach((file) => {
+    if (!fs.existsSync(file)) {
+      try {
+        const dir = path.dirname(file);
+        fs.mkdirSync(dir, { recursive: true });
+      } catch (err) {
+        // Do nothing
+      }
+      fs.writeFileSync(file, '', 'utf8');
+    }
+  });
+};
+
+const getLogFiles = async ({ name, node }) => {
+  const dt = new Date();
+  const { yyyy, mm, dd } = {
+    yyyy: dt.getFullYear(),
+    mm: `${dt.getMonth() + 1}`.padStart(2, 0),
+    dd: `${dt.getDate()}`.padStart(2, 0),
+  };
+  const date = `${yyyy}-${mm}-${dd}`;
+
+  if (name === 'abtnode') {
+    const logDir = path.join(node.dataDirs.logs, '_abtnode');
+
+    const info = path.join(logDir, `daemon-${date}.log`);
+    const error = path.join(logDir, `daemon-error-${date}.log`);
+    const access = path.join(logDir, 'access.log');
+    const stdout = path.join(logDir, 'daemon.stdout.log');
+    const stderr = path.join(logDir, 'daemon.stderr.log');
+
+    createFile({
+      info,
+      error,
+      access,
+      stdout,
+      stderr,
+    });
+
+    return {
+      info,
+      error,
+      access,
+      stdout,
+      stderr,
+    };
+  }
+
+  if (name === 'blocklet-services') {
+    const logDir = path.join(node.dataDirs.logs, '_abtnode');
+    const info = path.join(logDir, 'service.log');
+    const error = path.join(logDir, 'service.error.log');
+    createFile({ info, error });
+    return { info, error };
+  }
+
+  if (name.indexOf('blocklet-') === 0) {
+    const did = name.substring('blocklet-'.length);
+    const [appId, componentId] = did.split('/');
+    const blocklet = await node.getBlocklet({ did: appId, useCache: true });
+    let { name: blockletName } = blocklet.meta;
+
+    if (componentId) {
+      const component = findComponentByIdV2(blocklet, componentId);
+      if (component) {
+        blockletName = path.join(blockletName, component.meta.name);
+      }
+    }
+
+    const dir = path.join(node.dataDirs.logs, blockletName);
+    const info = path.join(dir, `info-${date}.log`);
+    const error = path.join(dir, `info-error-${date}.log`);
+    const access = path.join(dir, 'access.log');
+    const stdout = path.join(dir, 'output.log');
+    const stderr = path.join(dir, 'error.log');
+
+    createFile({
+      info,
+      error,
+      access,
+      stdout,
+      stderr,
+    });
+
+    return {
+      info,
+      error,
+      access,
+      stdout,
+      stderr,
+      recent: blocklet.mode === BLOCKLET_MODES.DEVELOPMENT ? 0 : 100,
+    };
+  }
+
+  if (name.startsWith('service-gateway-')) {
+    const providerName = name.substring('service-gateway-'.length);
+    const provider = node.getRouterProvider(providerName);
+    if (!provider) {
+      logger.error('router engine is empty', { name, providerName });
+      return {};
+    }
+
+    return provider.getLogFilesForToday();
+  }
+
+  return {};
+};
+
+const getDownloadLogFilesFromServer = async ({ dates, nodeInfo, node } = {}) => {
+  const logDir = path.join(node.dataDirs.logs, '_abtnode');
+
+  const pm2Log = path.join(logDir, 'pm2.log');
+  const pm2LogSrc = path.join(process.env.PM2_HOME, 'pm2.log');
+  if (fs.existsSync(pm2LogSrc)) {
+    await fs.copy(pm2LogSrc, pm2Log);
+  }
+
+  const provider = node.getRouterProvider(nodeInfo.routing.provider);
+  if (!provider) {
+    logger.error('router engine is empty');
+  }
+
+  const list = [];
+
+  dates.forEach((d) => {
+    // log file created by @abtnode/log
+    // log file created by abt-node-log-rotate
+    list.push(path.join(logDir, `*-${d}*`));
+
+    // log file create by router
+    const routerLogDir = provider.getLogDir();
+    if (routerLogDir) {
+      list.push(path.join(routerLogDir, `*-${d}*`));
+    }
+  });
+
+  // abt-node-daemon console & gateway
+  list.push(path.join(logDir, 'daemon.stdout.log*'));
+  list.push(path.join(logDir, 'daemon.stderr.log*'));
+  list.push(path.join(logDir, 'access.log*'));
+
+  // abt-node-service console & gateway
+  list.push(path.join(logDir, 'service.output.log*'));
+  list.push(path.join(logDir, 'service.error.log*'));
+  list.push(path.join(logDir, 'service.log*'));
+
+  // abt-node-db-hub console & backup
+  list.push(path.join(logDir, 'db.output.log*'));
+  list.push(path.join(logDir, 'db.error.log*'));
+
+  // abt-node-event-hub console
+  list.push(path.join(logDir, 'event.output.log*'));
+  list.push(path.join(logDir, 'event.error.log*'));
+
+  // abt-node-log-rotate console
+  list.push(path.join(logDir, 'pm2-logrotate.stdout.log*'));
+  list.push(path.join(logDir, 'pm2-logrotate.stderr.log*'));
+
+  // abt-node-updater console
+  list.push(path.join(logDir, 'updater.error.log*'));
+  list.push(path.join(logDir, 'updater.output.log*'));
+
+  // fallback log
+  list.push(path.join(logDir, 'stderr.log*'));
+  list.push(path.join(logDir, 'stdout.log*'));
+
+  // router
+  list.push(...Object.values(provider.getLogFilesForToday() || {}));
+
+  // pm2 log
+  list.push(pm2Log);
+
+  return glob(list);
+};
+
+const getDownloadLogFilesFromBlocklet = ({ dates, blocklet } = {}) => {
+  const appLogDir = path.join(blocklet.env.logsDir);
+  const componentLogDirs = blocklet.children.map((c) => path.join(c.env.logsDir));
+
+  const list = [];
+
+  [appLogDir, ...componentLogDirs].forEach((logDir) => {
+    dates.forEach((d) => {
+      // log file created by @abtnode/log
+      // log file created by abt-node-log-rotate
+      list.push(path.join(logDir, `*-${d}*`));
+    });
+
+    list.push(path.join(logDir, 'output.log*'));
+    list.push(path.join(logDir, 'error.log*'));
+    list.push(path.join(logDir, 'access.log*'));
+  });
+
+  return glob(list);
+};
+
+const getDownloadLogFiles = async ({ did, node, days = 1, now } = {}) => {
+  const dates = [dayjs(now).format('YYYY-MM-DD')];
+
+  for (let i = 1; i <= days; i++) {
+    dates.unshift(dayjs(now).subtract(i, 'day').format('YYYY-MM-DD'));
+  }
+
+  const nodeInfo = await node.getNodeInfo({ useCache: true });
+
+  if (nodeInfo.did === did) {
+    return getDownloadLogFilesFromServer({ dates, node, nodeInfo });
+  }
+
+  const blocklet = await node.getBlocklet({ did });
+  if (!blocklet) {
+    throw new Error('blocklet not found');
+  }
+
+  return getDownloadLogFilesFromBlocklet({ dates, blocklet });
+};
+
+const createStreamLogManager = ({ onLog, onGetLogFiles }) => {
+  const store = {}; // Object<name: streamLog>
+
+  const ensure = (name) => {
+    if (!store[name]) {
+      store[name] = new StreamLog();
+    }
+    return store[name];
+  };
+
+  const destroy = (name) => {
+    logger.info('log stream: destroy', { name });
+    if (!store[name]) {
+      return;
+    }
+    const log = store[name];
+    try {
+      log.clearTails();
+      delete store[name];
+    } catch (error) {
+      logger.error('log stream: remove ref error ', error);
+      delete store[name];
+    }
+  };
+
+  const add = async (name, topic, firstLogCb) => {
+    logger.info('log stream: add', { name });
+    const log = ensure(name);
+    try {
+      // update files
+      // push recent 100 log
+      const { recent = 100, ...logFiles } = await onGetLogFiles(name);
+      const changed = await log.setFiles(logFiles);
+      logger.info('log stream: added', { name, logFiles });
+      log.getRecent(recent, (error, level, data) => {
+        if (error) {
+          logger.error('log stream error ', error);
+        }
+        if (firstLogCb) {
+          firstLogCb(level, data, logFiles);
+        }
+      });
+      // stream
+      if (changed) {
+        const tails = log.ensureTails();
+        Object.entries(tails).forEach(([level, tail]) => {
+          tail.on('line', (data) => {
+            onLog({ topic, level, logFiles, data });
+          });
+          tail.on('error', (error) => {
+            logger.error('log tail error ', { error });
+            destroy(name);
+          });
+        });
+      }
+    } catch (error) {
+      logger.error('log stream error ', error);
+    }
+  };
+
+  return {
+    add,
+    destroy,
+  };
+};
+
+const createDownloadLogStream = async ({ node, did, days, now }) => {
+  const files = await getDownloadLogFiles({ node, did, days, now });
+
+  if (!files.length) {
+    throw new Error('Log file does not found');
+  }
+
+  const cwd = path.dirname(node.dataDirs.logs);
+
+  const archive = createArchive('zip', { zlib: { level: 9 } });
+  files.forEach((x) => {
+    archive.file(x, {
+      name: x.replace(`${cwd}/logs`, '/logs').replace(`${cwd}`, '/logs').replace('/_abtnode', '/blocklet-server'),
+    });
+  });
+
+  archive.rawPipe = archive.pipe.bind(archive);
+  archive.pipe = (s) => {
+    archive.rawPipe(s);
+    archive.finalize();
+  };
+
+  return archive;
+};
+
+module.exports = {
+  createStreamLogManager,
+  getLogFiles,
+  getDownloadLogFiles,
+  createDownloadLogStream,
+};

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.14-beta-0c29907f",
+  "version": "1.16.14-beta-1936d3d0",
   "description": "",
   "main": "lib/index.js",
   "files": [
@@ -19,19 +19,19 @@
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@abtnode/analytics": "1.16.14-beta-0c29907f",
-    "@abtnode/auth": "1.16.14-beta-0c29907f",
-    "@abtnode/certificate-manager": "1.16.14-beta-0c29907f",
-    "@abtnode/constant": "1.16.14-beta-0c29907f",
-    "@abtnode/cron": "1.16.14-beta-0c29907f",
-    "@abtnode/logger": "1.16.14-beta-0c29907f",
-    "@abtnode/models": "1.16.14-beta-0c29907f",
-    "@abtnode/queue": "1.16.14-beta-0c29907f",
-    "@abtnode/rbac": "1.16.14-beta-0c29907f",
-    "@abtnode/router-provider": "1.16.14-beta-0c29907f",
-    "@abtnode/static-server": "1.16.14-beta-0c29907f",
-    "@abtnode/timemachine": "1.16.14-beta-0c29907f",
-    "@abtnode/util": "1.16.14-beta-0c29907f",
+    "@abtnode/analytics": "1.16.14-beta-1936d3d0",
+    "@abtnode/auth": "1.16.14-beta-1936d3d0",
+    "@abtnode/certificate-manager": "1.16.14-beta-1936d3d0",
+    "@abtnode/constant": "1.16.14-beta-1936d3d0",
+    "@abtnode/cron": "1.16.14-beta-1936d3d0",
+    "@abtnode/logger": "1.16.14-beta-1936d3d0",
+    "@abtnode/models": "1.16.14-beta-1936d3d0",
+    "@abtnode/queue": "1.16.14-beta-1936d3d0",
+    "@abtnode/rbac": "1.16.14-beta-1936d3d0",
+    "@abtnode/router-provider": "1.16.14-beta-1936d3d0",
+    "@abtnode/static-server": "1.16.14-beta-1936d3d0",
+    "@abtnode/timemachine": "1.16.14-beta-1936d3d0",
+    "@abtnode/util": "1.16.14-beta-1936d3d0",
     "@arcblock/did": "1.18.87",
     "@arcblock/did-auth": "1.18.87",
     "@arcblock/did-ext": "^1.18.87",
@@ -42,10 +42,10 @@
     "@arcblock/pm2-events": "^0.0.5",
     "@arcblock/validator": "^1.18.87",
     "@arcblock/vc": "1.18.87",
-    "@blocklet/constant": "1.16.14-beta-0c29907f",
-    "@blocklet/meta": "1.16.14-beta-0c29907f",
-    "@blocklet/resolver": "1.16.14-beta-0c29907f",
-    "@blocklet/sdk": "1.16.14-beta-0c29907f",
+    "@blocklet/constant": "1.16.14-beta-1936d3d0",
+    "@blocklet/meta": "1.16.14-beta-1936d3d0",
+    "@blocklet/resolver": "1.16.14-beta-1936d3d0",
+    "@blocklet/sdk": "1.16.14-beta-1936d3d0",
     "@did-space/client": "^0.2.129",
     "@fidm/x509": "^1.2.1",
     "@ocap/mcrypto": "1.18.87",
@@ -76,6 +76,7 @@
     "node-stream-zip": "^1.15.0",
     "p-limit": "^3.1.0",
     "p-retry": "4.6.1",
+    "read-last-lines": "^1.8.0",
     "semver": "^7.3.8",
     "sequelize": "^6.31.0",
     "shelljs": "^0.8.5",
@@ -83,6 +84,7 @@
     "stream-throttle": "^0.1.3",
     "stream-to-promise": "^3.0.0",
     "systeminformation": "^5.17.12",
+    "tail": "^2.2.4",
     "tar": "^6.1.11",
     "transliteration": "^2.3.5",
     "ua-parser-js": "^1.0.2",
@@ -94,7 +96,8 @@
     "compression": "^1.7.4",
     "expand-tilde": "^2.0.2",
     "express": "^4.18.2",
-    "jest": "^27.5.1"
+    "jest": "^27.5.1",
+    "unzipper": "^0.10.11"
   },
-  "gitHead": "1f02851a71861dbf09bfedfa9df6d9fc6d2355a3"
+  "gitHead": "32bcf5b55889ebd7302887eedd306d331e9cd3b8"
 }