@abtnode/core 1.16.27 → 1.16.28-beta-bfbab430

package/lib/api/team.js

@@ -1526,7 +1526,15 @@ class TeamAPI extends EventEmitter {
     } else {
       const exist = await state.findOne({ userDid, visitorId, appPid });
       if (exist) {
-        [, [data]] = await state.update(exist.id, { ua, lastLoginIp, passportId, status, extra });
+        const mergeExtra = defaults({}, extra || {}, exist.extra || {});
+
+        [, [data]] = await state.update(exist.id, {
+          ua,
+          lastLoginIp,
+          passportId,
+          status,
+          extra: mergeExtra,
+        });
         logger.info('update userSession successfully', { id: exist.id, ua, lastLoginIp, passportId, status, extra });
       } else {
         data = await state.insert({

package/lib/blocklet/manager/disk.js

@@ -34,7 +34,7 @@ const {
   SESSION_CACHE_TTL,
 } = require('@abtnode/constant');
 
-const getBlockletEngine = require('@blocklet/meta/lib/engine');
+const { getBlockletEngine } = require('@blocklet/meta/lib/engine');
 const {
   isDeletableBlocklet,
   getComponentMissingConfigs,
@@ -103,6 +103,7 @@ const formatContext = require('@abtnode/util/lib/format-context');
 const md5 = require('@abtnode/util/lib/md5');
 const { callFederated } = require('@abtnode/auth/lib/util/federated');
 const pAll = require('p-all');
+const toBlockletDid = require('@blocklet/meta/lib/did');
 const launcher = require('../../util/launcher');
 const util = require('../../util');
 const {
@@ -218,13 +219,6 @@ const pm2StatusMap = {
   stop: BlockletStatus.stopped,
 };
 
-/**
- * get blocklet engine info, default is node
- * @param {object} blockletMeta blocklet meta
- * @return {string} engine name
- */
-const getBlockletEngineNameByPlatform = (blockletMeta) => getBlockletEngine(blockletMeta).interpreter;
-
 const getWalletAppNotification = async (blocklet, tempBlockletInfo) => {
   let blockletInfo = tempBlockletInfo;
   if (!blockletInfo) {
@@ -1733,6 +1727,26 @@ class DiskBlockletManager extends BaseBlockletManager {
     throw new Error(result?.reason || 'failed to send email');
   }
 
+  async sendPush({ did, receiver, notification }) {
+    const blocklet = await this.getBlocklet(did);
+    const nodeInfo = await states.node.read();
+    const { wallet } = getBlockletInfo(blocklet, nodeInfo.sk);
+    // HACK: 因为发送方法是按照数组来处理的
+
+    const result = await sendToUser(
+      receiver,
+      JSON.parse(notification),
+      {
+        appDid: wallet.address,
+        appSk: wallet.secretKey,
+      },
+      undefined,
+      undefined,
+      'send-to-push-kit'
+    );
+    return result;
+  }
+
   async configNotification({ did, notification = {} }, context) {
     let newConfig = {};
     try {
@@ -3211,7 +3225,27 @@ class DiskBlockletManager extends BaseBlockletManager {
 
       // app disk info, component runtime info, component engine
       await forEachBlocklet(blocklet, async (component, { level }) => {
-        component.engine = getEngine(getBlockletEngineNameByPlatform(component.meta)).describe();
+        const engine = getBlockletEngine(component.meta);
+        if (engine.interpreter === 'blocklet') {
+          const engineId = toBlockletDid(engine.source.name);
+          const engineComponent = findComponentByIdV2(blocklet, [engineId]);
+          if (engineComponent) {
+            component.engine = {
+              name: engineComponent.meta.did,
+              displayName: engineComponent.meta.title,
+              description: engineComponent.meta.description,
+              version: engineComponent.meta.version,
+              available: true,
+              visible: true,
+              // FIXME: @wangshijun this should be dynamic
+              logo: '',
+            };
+          } else {
+            throw new Error(`engine component ${engineId} not found`);
+          }
+        } else {
+          component.engine = getEngine(engine.interpreter)?.describe();
+        }
 
         if (level === 0) {
           component.diskInfo = await getDiskInfo(component, {
@@ -3471,6 +3505,7 @@ class DiskBlockletManager extends BaseBlockletManager {
               deployedFrom || fromBlockletSource(source)
             })`,
             action: `/blocklets/${did}/overview`,
+            blockletDashboardAction: '/.well-known/service/admin/blocklets',
             entityType: 'blocklet',
             entityId: did,
             severity: 'success',
@@ -3639,6 +3674,7 @@ class DiskBlockletManager extends BaseBlockletManager {
             componentDids
           )} is ${actionName} successfully for ${title}`,
           action: `/blocklets/${did}/overview`,
+          blockletDashboardAction: '/.well-known/service/admin/blocklets',
           entityType: 'blocklet',
           entityId: did,
           severity: 'success',

package/lib/blocklet/manager/engine.js

@@ -82,6 +82,9 @@ const validate = (engine) => {
   if (!engine) {
     return true;
   }
+  if (engine === 'blocklet') {
+    return true;
+  }
 
   if (!engineMap.has(engine)) {
     throw new Error(
@@ -89,7 +92,7 @@ const validate = (engine) => {
     );
   }
 
-  if (!engineMap.get(engine).isAvailable()) {
+  if (!engineMap.get(engine)?.isAvailable()) {
     throw new Error(`${engine} bin path does not exist`);
   }
 

package/lib/blocklet/project/create-pack-release.js

@@ -5,9 +5,10 @@
 const path = require('path');
 const fs = require('fs-extra');
 const createArchive = require('archiver');
+const pick = require('lodash/pick');
 const { slugify } = require('transliteration');
-const { BLOCKLET_META_FILE, PROJECT } = require('@blocklet/constant');
-const { update: updateMetaFile } = require('@blocklet/meta/lib/file');
+const { BLOCKLET_META_FILE, PROJECT, BLOCKLET_INTERFACE_TYPE_WEB } = require('@blocklet/constant');
+const { update: updateMetaFile, read: readMetaFile } = require('@blocklet/meta/lib/file');
 const { createRelease: createBlockletRelease } = require('@abtnode/util/lib/create-blocklet-release');
 const urlPathFriendly = require('@blocklet/meta/lib/url-path-friendly').default;
 const { hasStartEngine } = require('@blocklet/meta/lib/util');
@@ -16,7 +17,13 @@ const logger = require('@abtnode/logger')('create-resource-blocklet-pack');
 
 const { createReleaseSchema } = require('../../validators/project');
 
-const { getLogoFile, exportBlockletResources, getResourceList, checkResourceExists } = require('./util');
+const {
+  getLogoFile,
+  exportBlockletResources,
+  getResourceList,
+  checkResourceExists,
+  getExtendedMetaFile,
+} = require('./util');
 
 const createPackRelease = async ({
   did,
@@ -215,6 +222,30 @@ const createPackRelease = async ({
       files: project.blockletScreenshots?.length ? ['screenshots'] : [],
       screenshots: project.blockletScreenshots || [],
     };
+
+    // merge extended blocklet.yml
+    const extendedMetaFile = getExtendedMetaFile({ app: blocklet, projectId, releaseId });
+    if (fs.existsSync(extendedMetaFile)) {
+      const extendedMeta = readMetaFile(extendedMetaFile);
+      logger.info('merge extended blocklet.yml', extendedMeta);
+      Object.assign(meta, pick(extendedMeta, ['environments', 'engine']));
+    }
+
+    // Reset group for blocklets with engine specified
+    if (meta.engine?.interpreter === 'blocklet') {
+      delete meta.group;
+      meta.interfaces = [
+        {
+          name: 'publicUrl',
+          path: '/',
+          port: 'BLOCKLET_PORT',
+          prefix: '*',
+          protocol: 'tcp',
+          type: BLOCKLET_INTERFACE_TYPE_WEB,
+        },
+      ];
+    }
+
     await updateMetaFile(path.join(releaseBundleDir, BLOCKLET_META_FILE), meta);
 
     // create release

package/lib/blocklet/project/index.js

@@ -1,9 +1,10 @@
 const path = require('path');
 const fs = require('fs-extra');
 const createArchive = require('archiver');
+const pick = require('lodash/pick');
 const { slugify } = require('transliteration');
-const { BLOCKLET_META_FILE, PROJECT } = require('@blocklet/constant');
-const { update: updateMetaFile } = require('@blocklet/meta/lib/file');
+const { BLOCKLET_META_FILE, PROJECT, BLOCKLET_INTERFACE_TYPE_WEB } = require('@blocklet/constant');
+const { update: updateMetaFile, read: readMetaFile } = require('@blocklet/meta/lib/file');
 const { createRelease: createBlockletRelease } = require('@abtnode/util/lib/create-blocklet-release');
 const { titleSchema } = require('@blocklet/meta/lib/schema');
 const { validateNewDid } = require('@blocklet/meta/lib/name');
@@ -14,7 +15,13 @@ const logger = require('@abtnode/logger')('create-resource-blocklet');
 const { createReleaseSchema } = require('../../validators/project');
 const getIsMultipleTenant = require('./get-is-multiple-tenant');
 
-const { getLogoFile, exportBlockletResources, getResourceList, checkResourceExists } = require('./util');
+const {
+  getLogoFile,
+  exportBlockletResources,
+  getResourceList,
+  checkResourceExists,
+  getExtendedMetaFile,
+} = require('./util');
 const createPackRelease = require('./create-pack-release');
 const connectToStore = require('./connect-to-store');
 const publishToStore = require('./publish-to-store');
@@ -356,6 +363,29 @@ const createRelease = async ({
       files: project.blockletScreenshots?.length ? ['screenshots'] : [],
       screenshots: project.blockletScreenshots || [],
     };
+
+    // merge extended blocklet.yml
+    const extendedMetaFile = getExtendedMetaFile({ app: blocklet, projectId, releaseId });
+    if (fs.existsSync(extendedMetaFile)) {
+      const extendedMeta = readMetaFile(extendedMetaFile);
+      logger.info('merge extended blocklet.yml', extendedMeta);
+      Object.assign(meta, pick(extendedMeta, ['environments', 'engine']));
+    }
+
+    // Enable mountPoint for blocklets with engine specified
+    if (meta.engine?.interpreter === 'blocklet') {
+      meta.interfaces = [
+        {
+          name: 'publicUrl',
+          path: '/',
+          port: 'BLOCKLET_PORT',
+          prefix: '*',
+          protocol: 'tcp',
+          type: BLOCKLET_INTERFACE_TYPE_WEB,
+        },
+      ];
+    }
+
     await updateMetaFile(path.join(releaseBundleDir, BLOCKLET_META_FILE), meta);
 
     // create release

package/lib/blocklet/project/util.js

@@ -2,7 +2,7 @@ const path = require('path');
 const fs = require('fs-extra');
 const fg = require('fast-glob');
 const { isValid: isValidDid } = require('@arcblock/did');
-const { PROJECT, BLOCKLET_RESOURCE_DIR } = require('@blocklet/constant');
+const { PROJECT, BLOCKLET_RESOURCE_DIR, BLOCKLET_META_FILE } = require('@blocklet/constant');
 
 const COMPONENT_CONFIG_MAP_DIR = '.component_config';
 
@@ -135,9 +135,20 @@ const checkResourceExists = async (projectDir, action, releaseId) => {
   }
 };
 
+const getExtendedMetaFile = ({ app, projectId, releaseId }) => {
+  const { dataDir } = app.env;
+  const dirArr = [dataDir, PROJECT.DIR, projectId || '/'];
+  if (releaseId) {
+    dirArr.push(PROJECT.RELEASE_DIR, releaseId || '/');
+  }
+  dirArr.push(BLOCKLET_META_FILE);
+  return path.join(...dirArr);
+};
+
 module.exports = {
   getLogoFile,
   exportBlockletResources,
   getResourceList,
   checkResourceExists,
+  getExtendedMetaFile,
 };

package/lib/index.js

@@ -328,6 +328,7 @@ function ABTNode(options) {
     loginFederated: blockletManager.loginFederated.bind(blockletManager),
     configNotification: blockletManager.configNotification.bind(blockletManager),
     sendEmail: blockletManager.sendEmail.bind(blockletManager),
+    sendPush: blockletManager.sendPush.bind(blockletManager),
     updateWhoCanAccess: blockletManager.updateWhoCanAccess.bind(blockletManager),
     updateAppSessionConfig: blockletManager.updateAppSessionConfig.bind(blockletManager),
     updateComponentTitle: blockletManager.updateComponentTitle.bind(blockletManager),

package/lib/router/manager.js

@@ -30,15 +30,10 @@ const {
   BLOCKLET_BUNDLE_FOLDER,
   BLOCKLET_DYNAMIC_PATH_PREFIX,
   BLOCKLET_INTERFACE_TYPE_WEB,
-  BlockletGroup,
 } = require('@blocklet/constant');
-const {
-  forEachComponentV2Sync,
-  hasStartEngine,
-  isGatewayBlocklet,
-  getComponentId,
-} = require('@blocklet/meta/lib/util');
+const { forEachComponentV2Sync, isGatewayBlocklet, getComponentId } = require('@blocklet/meta/lib/util');
 const { fromPublicKey } = require('@ocap/wallet');
+const { hasMountPoint } = require('@blocklet/meta/lib/engine');
 
 const {
   validateAddSite,
@@ -712,15 +707,14 @@ class RouterManager extends EventEmitter {
     const rootComponentPrefix = joinUrl(blockletPrefix, blocklet.mountPoint || '/');
     rawRule.from.pathPrefix = normalizePathPrefix(rootComponentPrefix);
 
-    const isOccupiable = blocklet.meta.group === BlockletGroup.gateway;
-
+    const isOccupiable = isGatewayBlocklet(blocklet.meta);
     if (!isOccupiable) {
       rules.push(rawRule);
     }
 
     forEachComponentV2Sync(blocklet, (component) => {
       const { meta } = component;
-      if (isGatewayBlocklet(meta) || !hasStartEngine(meta)) {
+      if (hasMountPoint(meta) === false) {
         return;
       }
 

package/lib/states/user.js

@@ -252,7 +252,7 @@ class User extends ExtendBase {
 
   // eslint-disable-next-line require-await
   async getUsersByDids({ dids, query }) {
-    const { approved, includeTags, includePassports } = query || {};
+    const { approved, includeTags, includePassports, includeUserSessions } = query || {};
     const condition = { did: dids };
     if (isNullOrUndefined(approved) === false) {
       condition.approved = !!approved;
@@ -267,6 +267,16 @@ class User extends ExtendBase {
         as: 'passports',
       });
     }
+    if (includeUserSessions) {
+      include.push({
+        model: this.models.UserSession,
+        as: 'userSessions',
+        where: {
+          status: 'online',
+        },
+        required: false,
+      });
+    }
 
     return this.find({ where: condition, include });
   }

package/lib/util/blocklet.js

@@ -33,13 +33,7 @@ const getFolderSize = require('@abtnode/util/lib/get-folder-size');
 const normalizePathPrefix = require('@abtnode/util/lib/normalize-path-prefix');
 const hashFiles = require('@abtnode/util/lib/hash-files');
 const didDocument = require('@abtnode/util/lib/did-document');
-const {
-  BLOCKLET_MAX_MEM_LIMIT_IN_MB,
-  BLOCKLET_INSTALL_TYPE,
-  APP_STRUCT_VERSION,
-  BLOCKLET_STORE,
-  BLOCKLET_STORE_DEV,
-} = require('@abtnode/constant');
+const { BLOCKLET_MAX_MEM_LIMIT_IN_MB, BLOCKLET_INSTALL_TYPE, APP_STRUCT_VERSION } = require('@abtnode/constant');
 const {
   parseComponents,
   ensureMeta,
@@ -75,7 +69,7 @@ const {
   BLOCKLET_TENANT_MODES,
 } = require('@blocklet/constant');
 const validateBlockletEntry = require('@blocklet/meta/lib/entry');
-const getBlockletEngine = require('@blocklet/meta/lib/engine');
+const { getBlockletEngine } = require('@blocklet/meta/lib/engine');
 const getBlockletInfo = require('@blocklet/meta/lib/info');
 const getBlockletWallet = require('@blocklet/meta/lib/wallet');
 const {
@@ -111,10 +105,10 @@ const { installExternalDependencies } = require('./install-external-dependencies
 
 /**
  * get blocklet engine info, default is node
- * @param {object} blockletMeta blocklet meta
+ * @param {object} meta blocklet meta
  * @return {string} engine name
  */
-const getBlockletEngineNameByPlatform = (blockletMeta) => getBlockletEngine(blockletMeta).interpreter;
+const getBlockletEngineNameByPlatform = (meta) => getBlockletEngine(meta).interpreter;
 
 const noop = () => {};
 const noopAsync = async () => {};
@@ -209,6 +203,9 @@ const getComponentStartEngine = (component, { e2eMode = false } = {}) => {
   }
 
   const blockletEngineInfo = getBlockletEngine(component.meta);
+  if (blockletEngineInfo.interpreter === 'blocklet') {
+    return {};
+  }
 
   let script = null;
   let interpreter = '';
@@ -218,10 +215,11 @@ const getComponentStartEngine = (component, { e2eMode = false } = {}) => {
 
   if (startFromDevEntry) {
     script = startFromDevEntry;
-  } else if (group === 'dapp') {
-    script = blockletEngineInfo.script || BLOCKLET_ENTRY_FILE;
+  } else if (group === 'dapp' || group === 'engine') {
+    script = blockletEngineInfo.source || BLOCKLET_ENTRY_FILE;
     args = blockletEngineInfo.args || [];
   } else if (group === 'static') {
+    // FIXME: @wangshijun deprecate this
     script = require.resolve('@abtnode/static-server');
     environmentObj.BLOCKLET_MAIN_DIR = path.join(appDir, main);
   }
@@ -562,6 +560,10 @@ const startBlockletProcess = async (
       const { cwd, script, args, environmentObj, interpreter, interpreterArgs } = getComponentStartEngine(b, {
         e2eMode,
       });
+      if (!script) {
+        logger.info('skip start process without script', { processId });
+        return;
+      }
 
       // get env
       const env = getRuntimeEnvironments(b, nodeEnvironments, ancestors);
@@ -809,6 +811,12 @@ const checkBlockletProcessHealthy = async (blocklet, { minConsecutiveTime, timeo
         return;
       }
 
+      // components that relies on another engine component should not be checked
+      const engine = getBlockletEngine(b.meta);
+      if (engine.interpreter === 'blocklet') {
+        return;
+      }
+
       if (!hasStartEngine(b.meta)) {
         return;
       }
@@ -1308,27 +1316,6 @@ const getBlocklet = async ({
 
   const nodeInfo = await states.node.read();
 
-  // FIXME: 梁柱, 下面的代码块, 在 1.16.29 之后的版本, 可以删除
-  {
-    // 对于历史项目, server.db -> servers -> blockletRegistryList 已经存储了没有 id 的 store, 这里需要兼容处理
-    let isNeedFixRedundantData = false;
-    const urlToId = {
-      [BLOCKLET_STORE.url]: BLOCKLET_STORE.id,
-      [BLOCKLET_STORE_DEV.url]: BLOCKLET_STORE_DEV.id,
-    };
-    (nodeInfo?.blockletRegistryList || []).forEach((store) => {
-      if (!store.id) {
-        store.id = urlToId[store.url];
-        isNeedFixRedundantData = true;
-      }
-    });
-
-    // 更新历史数据中遗漏的 store id, 方便后期删除这段代码
-    if (isNeedFixRedundantData) {
-      await states.node.updateNodeInfo({ blockletRegistryList: nodeInfo.blockletRegistryList });
-    }
-  }
-
   (nodeInfo?.blockletRegistryList || []).forEach((store) => {
     if (!blocklet.settings.storeList.find((x) => x.url === store.url)) {
       blocklet.settings.storeList.push({

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.27",
+  "version": "1.16.28-beta-bfbab430",
   "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.27",
-    "@abtnode/auth": "1.16.27",
-    "@abtnode/certificate-manager": "1.16.27",
-    "@abtnode/constant": "1.16.27",
-    "@abtnode/cron": "1.16.27",
-    "@abtnode/logger": "1.16.27",
-    "@abtnode/models": "1.16.27",
-    "@abtnode/queue": "1.16.27",
-    "@abtnode/rbac": "1.16.27",
-    "@abtnode/router-provider": "1.16.27",
-    "@abtnode/static-server": "1.16.27",
-    "@abtnode/timemachine": "1.16.27",
-    "@abtnode/util": "1.16.27",
+    "@abtnode/analytics": "1.16.28-beta-bfbab430",
+    "@abtnode/auth": "1.16.28-beta-bfbab430",
+    "@abtnode/certificate-manager": "1.16.28-beta-bfbab430",
+    "@abtnode/constant": "1.16.28-beta-bfbab430",
+    "@abtnode/cron": "1.16.28-beta-bfbab430",
+    "@abtnode/logger": "1.16.28-beta-bfbab430",
+    "@abtnode/models": "1.16.28-beta-bfbab430",
+    "@abtnode/queue": "1.16.28-beta-bfbab430",
+    "@abtnode/rbac": "1.16.28-beta-bfbab430",
+    "@abtnode/router-provider": "1.16.28-beta-bfbab430",
+    "@abtnode/static-server": "1.16.28-beta-bfbab430",
+    "@abtnode/timemachine": "1.16.28-beta-bfbab430",
+    "@abtnode/util": "1.16.28-beta-bfbab430",
     "@arcblock/did": "1.18.123",
     "@arcblock/did-auth": "1.18.123",
     "@arcblock/did-ext": "^1.18.123",
@@ -42,12 +42,12 @@
     "@arcblock/pm2-events": "^0.0.5",
     "@arcblock/validator": "^1.18.123",
     "@arcblock/vc": "1.18.123",
-    "@blocklet/constant": "1.16.27",
-    "@blocklet/env": "1.16.27",
-    "@blocklet/meta": "1.16.27",
-    "@blocklet/resolver": "1.16.27",
-    "@blocklet/sdk": "1.16.27",
-    "@blocklet/store": "1.16.27",
+    "@blocklet/constant": "1.16.28-beta-bfbab430",
+    "@blocklet/env": "1.16.28-beta-bfbab430",
+    "@blocklet/meta": "1.16.28-beta-bfbab430",
+    "@blocklet/resolver": "1.16.28-beta-bfbab430",
+    "@blocklet/sdk": "1.16.28-beta-bfbab430",
+    "@blocklet/store": "1.16.28-beta-bfbab430",
     "@did-space/client": "^0.4.20",
     "@fidm/x509": "^1.2.1",
     "@ocap/mcrypto": "1.18.123",
@@ -103,5 +103,5 @@
     "jest": "^29.7.0",
     "unzipper": "^0.10.11"
   },
-  "gitHead": "b7dcd46b040c5ad3a273b14b1a411fafc1390828"
+  "gitHead": "f1fbf0752de46be00d1faa0d54eb7d28016e0bb9"
 }