@abtnode/core 1.7.8 → 1.7.11

package/lib/api/team.js

@@ -104,6 +104,19 @@ class TeamAPI extends EventEmitter {
     return state.getUser(user.did);
   }
 
+  async getOwner({ teamDid }) {
+    const owner = await this.teamManager.getOwner(teamDid);
+
+    if (!owner) {
+      return null;
+    }
+
+    const state = await this.getUserState(teamDid);
+
+    const full = await state.getUser(owner.did);
+    return full || owner;
+  }
+
   async updateUser({ teamDid, user }) {
     const state = await this.getUserState(teamDid);
 

package/lib/blocklet/manager/disk.js

@@ -114,6 +114,7 @@ const {
   shouldUpdateBlockletStatus,
   getBlockletMeta,
   validateBlockletMeta,
+  validateOwner,
 } = util;
 
 const preDownloadLock = new Lock('pre-download-lock');
@@ -256,7 +257,7 @@ class BlockletManager extends BaseBlockletManager {
     }
 
     const blocklet = await states.blocklet.getBlocklet(meta.did);
-    const isRunning = blocklet?.status === BlockletStatus.running;
+    const isRunning = blocklet ? blocklet.status === BlockletStatus.running : false;
 
     return { meta, isFree, isInstalled: !!blocklet, isRunning };
   }
@@ -626,7 +627,7 @@ class BlockletManager extends BaseBlockletManager {
   }
 
   // eslint-disable-next-line no-unused-vars
-  async config({ did, childDid, configs: newConfigs }, context) {
+  async config({ did, childDid, configs: newConfigs, skipHook }, context) {
     logger.info('config blocklet', { did });
     if (!Array.isArray(newConfigs)) {
       throw new Error('configs list is not an array');
@@ -693,15 +694,17 @@ class BlockletManager extends BaseBlockletManager {
       blocklet.configObj[x.key] = x.value;
     }
 
-    // FIXME: we should also call preConfig for child blocklets
-    await hooks.preConfig(blocklet.env.appId, {
-      appDir: blocklet.env.appDir,
-      hooks: Object.assign(blocklet.meta.hooks || {}, blocklet.meta.scripts || {}),
-      exitOnError: true,
-      env: { ...getRuntimeEnvironments(blocklet, nodeEnvironments), ...blocklet.configObj },
-      did,
-      context,
-    });
+    if (!skipHook) {
+      // FIXME: we should also call preConfig for child blocklets
+      await hooks.preConfig(blocklet.env.appId, {
+        appDir: blocklet.env.appDir,
+        hooks: Object.assign(blocklet.meta.hooks || {}, blocklet.meta.scripts || {}),
+        exitOnError: true,
+        env: { ...getRuntimeEnvironments(blocklet, nodeEnvironments), ...blocklet.configObj },
+        did,
+        context,
+      });
+    }
 
     // update db
     const configs = childDid
@@ -1147,9 +1150,14 @@ class BlockletManager extends BaseBlockletManager {
     return blocklet;
   }
 
-  async setInitialized({ did }) {
+  async setInitialized({ did, owner }) {
+    if (!validateOwner(owner)) {
+      throw new Error('Blocklet owner is invalid');
+    }
+
     const blocklet = await states.blocklet.getBlocklet(did);
-    await states.blockletExtras.setSettings(blocklet.meta.did, { initialized: true });
+    await states.blockletExtras.setSettings(blocklet.meta.did, { initialized: true, owner });
+    logger.info('Blocklet initialized', { did, owner });
 
     this.emit(BlockletEvents.updated, { meta: { did: blocklet.meta.did } });
 

package/lib/blocklet/migration.js

@@ -21,6 +21,7 @@ async function runScripts({
   printSuccess,
   printError,
 }) {
+  // 获取所有待执行的脚本
   let scripts = [];
   try {
     scripts = await getScripts(scriptsDir);
@@ -37,13 +38,17 @@ async function runScripts({
   }
 
   printInfo('pending scripts', pendingScripts);
+  // 执行脚本前需要对数据库文件做一次备份
   try {
     await doBackup({ dbDir, backupDir, printInfo, printSuccess, printError });
   } catch (err) {
     printError(`Failed to backup state db due to ${err.message}, abort!`);
+    // 备份失败时，需要移除备份目录
+    fs.removeSync(backupDir);
     throw err;
   }
 
+  // 按照顺序依次执行 migration 脚本
   for (let i = 0; i < pendingScripts.length; i++) {
     const { script: scriptPath } = pendingScripts[i];
     try {
@@ -59,7 +64,10 @@ async function runScripts({
 
       try {
         await doRestore({ dbDir, backupDir, printInfo, printSuccess, printError });
+        // 恢复备份成功时，需要移除备份目录
+        fs.removeSync(backupDir);
       } catch (restoreErr) {
+        // 如果恢复备份失败，则保留备份目录，恢复数据
         printError(`Failed to restore state db due to: ${restoreErr.message}`);
       }
 

package/lib/cert.js

@@ -37,6 +37,16 @@ const onCertIssued = (cert) => {
   });
 };
 
+const onCertIssueFailed = (cert) => {
+  states.notification.create({
+    title: 'Certificate Issue Failed',
+    description: `Failed to issue certificate for ${cert.domain}`,
+    severity: 'error',
+    entityType: 'certificate',
+    entityId: cert.id,
+  });
+};
+
 const getDomainFromInput = (input) => {
   if (Object.prototype.toString.call(input) === '[object Object]') {
     return input.domain;
@@ -58,6 +68,10 @@ class Cert extends EventEmitter {
 
     this.manager.on('cert.expired', onCertExpired);
     this.manager.on('cert.about_to_expire', onCertAboutExpire);
+    this.manager.on('cert.error', (cert) => {
+      this.emit('cert.error', cert);
+      onCertIssueFailed(cert);
+    });
   }
 
   start() {

package/lib/event.js

@@ -25,6 +25,7 @@ module.exports = ({
   handleRouting,
   domainStatus,
   teamAPI,
+  certManager,
 }) => {
   const notificationState = states.notification;
   const nodeState = states.node;
@@ -125,6 +126,14 @@ module.exports = ({
       await teamAPI.refreshBlockletInterfacePermissions(blocklet.meta);
     } catch (error) {
       logger.error('upgrade blocklet routing rules error', { event: name, error });
+      notificationState.create({
+        title: 'Blocklet URL Mapping Error',
+        // eslint-disable-next-line max-len
+        description: `Failed to upgrade URL mapping for blocklet ${blocklet.meta.name}@${blocklet.meta.version}, due to: ${error.message}`,
+        entityType: 'blocklet',
+        entityId: blocklet.meta.did,
+        severity: 'error',
+      });
     }
 
     try {
@@ -222,5 +231,8 @@ module.exports = ({
   events.handleServerEvent = handleServerEvent;
   events.handleBlockletEvent = handleBlockletEvent;
 
+  certManager.on('cert.issued', (data) => onEvent(EVENTS.CERT_ISSUED, data));
+  certManager.on('cert.error', (data) => onEvent(EVENTS.CERT_ERROR, data));
+
   return events;
 };

package/lib/index.js

@@ -10,6 +10,7 @@ const {
   fromBlockletSource,
   toBlockletSource,
 } = require('@blocklet/meta/lib/constants');
+const { getServiceMetas } = require('@blocklet/meta/lib/service');
 const { listProviders } = require('@abtnode/router-provider');
 const { DEFAULT_CERTIFICATE_EMAIL, EVENTS } = require('@abtnode/constant');
 
@@ -29,7 +30,6 @@ const IP = require('./util/ip');
 const DomainStatus = require('./util/domain-status');
 const Upgrade = require('./util/upgrade');
 const resetNode = require('./util/reset-node');
-const { getServices } = require('./util/service');
 const DiskMonitor = require('./util/disk-monitor');
 const createQueue = require('./queue');
 const createEvents = require('./event');
@@ -265,6 +265,7 @@ function ABTNode(options) {
     getUsers: teamAPI.getUsers.bind(teamAPI),
     getUsersCount: teamAPI.getUsersCount.bind(teamAPI),
     getUser: teamAPI.getUser.bind(teamAPI),
+    getOwner: teamAPI.getOwner.bind(teamAPI),
     getNodeUsers: () => teamAPI.getUsers({ teamDid: options.nodeDid }),
     getNodeUser: (user) => teamAPI.getUser({ teamDid: options.nodeDid, user }),
     addUser: teamAPI.addUser.bind(teamAPI),
@@ -376,7 +377,7 @@ function ABTNode(options) {
     endSession: (params, context) => states.session.end(params.id, context),
 
     // Services
-    getServices: (params, context) => getServices({ stringifySchema: true }, context),
+    getServices: (params, context) => getServiceMetas({ stringifySchema: true }, context),
 
     // Utilities: moved here because some deps require native build
     getSysInfo,

package/lib/router/helper.js

@@ -863,88 +863,6 @@ module.exports = function getRouterHelpers({ dataDirs, routingSnapshot, routerMa
     return changes.some(Boolean);
   };
 
-  /**
-   * Add system routing rules for blocklet in dashboard site
-   *
-   * @returns {boolean} if routing changed
-   * TODO: do we still need this?
-   */
-  const _ensureBlockletRulesForDashboardSite = async (blocklet, sites, nodeInfo, context = {}) => {
-    // blocklet level duplication detection
-    const findRulesByInterface = (site, value) =>
-      site.rules.filter((x) => x.isProtected && x.to.did === blocklet.meta.did && get(x, 'to.interfaceName') === value);
-
-    const ipSite = sites.find((x) => x.domain === DOMAIN_FOR_IP_SITE);
-    if (!ipSite) {
-      logger.warn(`Routing rule for dashboard not found, abort on ensure rules for blocklet ${blocklet.meta.did}`);
-      return false;
-    }
-
-    // If we have rule for legacy path prefix, just return
-    const pathPrefixLegacy = normalizePathPrefix(`/${nodeInfo.routing.adminPath}/${blocklet.meta.name}`);
-    if (hasRuleByPrefix(ipSite, pathPrefixLegacy)) {
-      return false;
-    }
-
-    const removedRuleIds = [];
-    const changes = await Promise.all(
-      blocklet.meta.interfaces.map(async (x) => {
-        let changed = false; // if state db was mutated
-        let pathPrefix = '';
-        if (x.prefix === BLOCKLET_DYNAMIC_PATH_PREFIX) {
-          // pathPrefix for dynamic path: `/{adminPath}/{blockletName}/{interfaceName}`
-          pathPrefix = normalizePathPrefix(`/${pathPrefixLegacy}/${x.name}`);
-        } else {
-          // pathPrefix for fixed path: `/{interfacePrefix}`
-          pathPrefix = normalizePathPrefix(x.prefix);
-        }
-
-        // Remove if we have rule with same interface
-        const exists = findRulesByInterface(ipSite, x.name);
-        if (exists.length) {
-          // Note: we need to keep a list of removed rules since we might remove multiple rules in the loop
-          exists.forEach((e) => removedRuleIds.push(e.id));
-          await states.site.update(
-            { _id: ipSite.id },
-            { $set: { rules: ipSite.rules.filter((r) => removedRuleIds.includes(r.id) === false) } }
-          );
-          changed = true;
-        } else if (hasRuleByPrefix(ipSite, pathPrefix)) {
-          // Skip same pathPrefix rules
-          return changed;
-        }
-
-        // 不在 dashboard site 中添加 path 和 prefix 都是根路径(/) 的路由
-        if (x.path === '/' && x.prefix === '/') {
-          return changed;
-        }
-
-        await routerManager.addRoutingRule(
-          {
-            id: ipSite.id,
-            rule: {
-              from: { pathPrefix },
-              to: {
-                type: ROUTING_RULE_TYPES.BLOCKLET,
-                port: findInterfacePortByName(blocklet, x.name),
-                did: blocklet.meta.did, // root blocklet did
-                interfaceName: x.name, // root blocklet interface
-              },
-              isProtected: true,
-            },
-            skipCheckDynamicBlacklist: true,
-          },
-          context
-        );
-        changed = true;
-
-        return changed;
-      })
-    );
-
-    return changes.some(Boolean);
-  };
-
   const _removeBlockletSites = async (blocklet, nodeInfo, context = {}) => {
     let changed = false;
 
@@ -980,14 +898,6 @@ module.exports = function getRouterHelpers({ dataDirs, routingSnapshot, routerMa
       _ensureBlockletSites(blocklet, sites, nodeInfo, context),
     ];
 
-    if (nodeInfo.mode === NODE_MODES.DEBUG || ['e2e', 'test'].includes(process.env.NODE_ENV)) {
-      logger.info('Add blocklet endpoint in dashboard site', {
-        nodeMode: nodeInfo.mode,
-        NODE_ENV: process.env.NODE_ENV,
-      });
-      tasks.push(_ensureBlockletRulesForDashboardSite(blocklet, sites, nodeInfo, context));
-    }
-
     const changes = await Promise.all(tasks);
 
     return changes.some(Boolean);

package/lib/router/index.js

@@ -110,7 +110,7 @@ class Router {
     await this.provider.update({
       routingTable: this.routingTable,
       certificates,
-      globalHeaders: headers,
+      commonHeaders: headers,
       services,
       nodeInfo: pick(nodeInfo, ['name', 'version', 'port', 'mode', 'enableWelcomePage', 'routing']),
     });

package/lib/router/manager.js

@@ -222,7 +222,7 @@ class RouterManager extends EventEmitter {
     }
 
     // let custom domain in front of protected domain
-    const domainAliases = [{ value: domainAlias, isProtected: false }, ...dbSite.domainAliases];
+    const domainAliases = [{ value: domainAlias, isProtected: false }, ...(dbSite.domainAliases || [])];
 
     const updateResult = await states.site.update({ _id: id }, { $set: { domainAliases } });
     logger.debug('add domain alias update result', { id, updateResult, domainAlias });
@@ -420,7 +420,7 @@ class RouterManager extends EventEmitter {
   }
 
   async getMatchedCert(domain) {
-    const certs = await this.certManager.getAll();
+    const certs = await this.certManager.getAllNormal();
     const matchedCert = certs.find((cert) => this.isCertMatchedDomain(cert, domain));
 
     if (matchedCert) {
@@ -546,7 +546,7 @@ class RouterManager extends EventEmitter {
       getRoutingParams: async () => ({
         sites: await ensureLatestInfo(sites),
         certificates,
-        globalHeaders: get(info, 'routing.headers', {}),
+        commonHeaders: get(info, 'routing.headers', {}),
         services: [], // TODO: do we need to add some item here?
         nodeInfo: info,
       }),

package/lib/team/manager.js

@@ -267,6 +267,19 @@ class TeamManager extends EventEmitter {
     }
   }
 
+  async getOwner(did) {
+    let owner;
+    if (this.isNodeTeam(did)) {
+      const nodeInfo = await this.states.node.read();
+      owner = get(nodeInfo, 'nodeOwner');
+    } else {
+      const settings = await this.states.blockletExtras.getSettings(did);
+      owner = get(settings, 'owner');
+    }
+
+    return owner;
+  }
+
   // =======
   // Private
   // =======

package/lib/util/blocklet.js

@@ -48,7 +48,6 @@ const { validate: validateEngine, get: getEngine } = require('../blocklet/manage
 
 const isRequirementsSatisfied = require('./requirement');
 const { getDidDomainForBlocklet } = require('./get-domain-for-blocklet');
-const { getServices } = require('./service');
 const {
   isBeforeInstalled,
   expandBundle,
@@ -1024,7 +1023,7 @@ const fixAndVerifyBlockletMeta = (meta, did) => {
   }
 
   // this step comes last because it has side effects: the meta is changed
-  return fixAndValidateService(meta, getServices());
+  return fixAndValidateService(meta);
 };
 
 const getUpdateMetaList = (oldMetas = [], newMetas = []) => {

package/lib/util/index.js

@@ -35,7 +35,6 @@ const DEFAULT_WELLKNOWN_PORT = 8088;
 
 const logger = require('@abtnode/logger')('@abtnode/core:util');
 
-const { getServices } = require('./service');
 const request = require('./request');
 
 const validateOwner = (owner) => {
@@ -496,13 +495,9 @@ const lib = {
   ensureDataDirs,
   getDataDirs,
   getBaseUrls,
-  getBlockletMeta: (dir, opts = {}) =>
-    parseBlockletMeta(dir, {
-      serviceMetas: getServices(),
-      ...opts,
-    }),
+  getBlockletMeta: parseBlockletMeta,
   validateBlockletMeta: (meta, opts = {}) => {
-    fixAndValidateService(meta, getServices(), opts.fix);
+    fixAndValidateService(meta);
     return validateMeta(meta, opts);
   },
   getBlockletMetaByUrl,

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.7.8",
+  "version": "1.7.11",
   "description": "",
   "main": "lib/index.js",
   "files": [
@@ -19,31 +19,30 @@
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/certificate-manager": "1.7.8",
-    "@abtnode/constant": "1.7.8",
-    "@abtnode/cron": "1.7.8",
-    "@abtnode/db": "1.7.8",
-    "@abtnode/logger": "1.7.8",
-    "@abtnode/queue": "1.7.8",
-    "@abtnode/rbac": "1.7.8",
-    "@abtnode/router-provider": "1.7.8",
-    "@abtnode/static-server": "1.7.8",
-    "@abtnode/timemachine": "1.7.8",
-    "@abtnode/util": "1.7.8",
-    "@arcblock/did": "^1.16.3",
+    "@abtnode/certificate-manager": "1.7.11",
+    "@abtnode/constant": "1.7.11",
+    "@abtnode/cron": "1.7.11",
+    "@abtnode/db": "1.7.11",
+    "@abtnode/logger": "1.7.11",
+    "@abtnode/queue": "1.7.11",
+    "@abtnode/rbac": "1.7.11",
+    "@abtnode/router-provider": "1.7.11",
+    "@abtnode/static-server": "1.7.11",
+    "@abtnode/timemachine": "1.7.11",
+    "@abtnode/util": "1.7.11",
+    "@arcblock/did": "^1.16.5",
     "@arcblock/did-motif": "^1.1.5",
-    "@arcblock/event-hub": "1.16.3",
+    "@arcblock/event-hub": "1.16.5",
     "@arcblock/pm2-events": "^0.0.5",
-    "@arcblock/vc": "^1.16.3",
-    "@blocklet/meta": "1.7.8",
+    "@arcblock/vc": "^1.16.5",
+    "@blocklet/meta": "1.7.11",
     "@fidm/x509": "^1.2.1",
     "@nedb/core": "^1.2.2",
     "@nedb/multi": "^1.2.2",
-    "@ocap/mcrypto": "^1.16.3",
-    "@ocap/util": "^1.16.3",
-    "@ocap/wallet": "^1.16.3",
+    "@ocap/mcrypto": "^1.16.5",
+    "@ocap/util": "^1.16.5",
+    "@ocap/wallet": "^1.16.5",
     "@slack/webhook": "^5.0.3",
-    "ajv": "^7.0.3",
     "axios": "^0.26.1",
     "axon": "^2.0.3",
     "chalk": "^4.0.0",
@@ -78,5 +77,5 @@
     "express": "^4.17.1",
     "jest": "^27.4.5"
   },
-  "gitHead": "ae75dd20b4750a31dc53c88b75ed1d95c8f15397"
+  "gitHead": "84e741e6b37e47d52bf834ce3ace8ed601d0896c"
 }

package/lib/util/service.js

@@ -1,81 +0,0 @@
-const fs = require('fs-extra');
-const cloneDeep = require('lodash/cloneDeep');
-const Ajv = require('ajv').default;
-
-const { NODE_SERVICES } = require('@abtnode/constant');
-
-const ajv = new Ajv({
-  useDefaults: true,
-  removeAdditional: 'all',
-});
-
-const SERVICES = {
-  AUTH: fs.readJSONSync(require.resolve('@abtnode/blocklet-services/configs/auth.json')),
-};
-
-const getServices = ({ stringifySchema = false } = {}) => {
-  const list = Object.values(SERVICES).map((x) => {
-    const data = cloneDeep(x);
-    if (stringifySchema) {
-      data.schema = JSON.stringify(x.schema);
-    }
-    return data;
-  });
-
-  // backward compatible
-  const authService = cloneDeep(list.find((x) => x.name === NODE_SERVICES.AUTH));
-  authService.name = NODE_SERVICES.AUTH_SERVICE;
-  list.push(authService);
-
-  return list;
-};
-
-const getServiceMeta = (serviceName) => {
-  if (!serviceName) {
-    throw new Error('service name should not be empty');
-  }
-  const metas = getServices();
-  const meta = metas.find((x) => x.name === serviceName);
-  if (!meta) {
-    throw new Error(`service ${serviceName} does not exist`);
-  }
-
-  return meta;
-};
-
-const getServiceConfig = (service, customConfig) => {
-  const serviceMeta = typeof service === 'string' ? getServiceMeta(service) : service;
-
-  const validate = ajv.compile(serviceMeta.schema.JSONSchema);
-
-  const data = cloneDeep(customConfig || {});
-  // this method may have side effect thar will fill default value to customConfig
-  validate(data || {});
-
-  return data;
-};
-
-const getDefaultServiceConfig = (service) => {
-  const serviceMeta = typeof service === 'string' ? getServiceMeta(service) : service;
-
-  // parse empty custom config to get default config
-  return getServiceConfig(serviceMeta, {});
-};
-
-const findService = (services, name) => {
-  const names = [name];
-
-  // backward compatible
-  if (name === NODE_SERVICES.AUTH) {
-    names.push(NODE_SERVICES.AUTH_SERVICE);
-  }
-
-  return (services || []).find((x) => names.includes(x.name));
-};
-
-module.exports = {
-  getServices,
-  getServiceConfig,
-  getDefaultServiceConfig,
-  findService,
-};