@abtnode/core 1.16.14-beta-1936d3d0 → 1.16.14-beta-dd4f6a50

package/lib/blocklet/manager/disk.js

@@ -51,6 +51,7 @@ const { update: updateMetaFile } = require('@blocklet/meta/lib/file');
 const { titleSchema, updateMountPointSchema, environmentNameSchema } = require('@blocklet/meta/lib/schema');
 const { emailConfigSchema } = require('@blocklet/sdk/lib/validators/email');
 const Lock = require('@abtnode/util/lib/lock');
+const defaults = require('lodash/defaults');
 
 const {
   BlockletStatus,
@@ -1405,6 +1406,9 @@ class DiskBlockletManager extends BaseBlockletManager {
 
     if (validateConfig.cacheTtl) {
       sessionConfig.cacheTtl = validateConfig.cacheTtl;
+    } else {
+      // NOTE: 将 cacheTtl 默认值设置为 3600s
+      sessionConfig.cacheTtl = 60 * 60; // seconds
     }
     if (validateConfig.ttl) {
       sessionConfig.ttl = validateConfig.ttl;
@@ -3416,21 +3420,24 @@ class DiskBlockletManager extends BaseBlockletManager {
 class FederatedBlockletManager extends DiskBlockletManager {
   /**
    * Joins federated login.
-   * @param {{appUrl: string, did: string;}} options - The federated login appUrl.
-   * @returns {Promise<any>} The data received from the appUrl.
+   * @param {object} options
+   * @param {{string}} options.did - blocklet pid
+   * @param {{string}} options.appUrl - 申请加入统一登录的 master appUrl
+   * @returns {Promise<any>} 更新后的 blocklet 数据
    */
   async joinFederatedLogin({ appUrl, did }) {
     const url = new URL(appUrl);
+    // master service api 的地址
     url.pathname = `${WELLKNOWN_SERVICE_PATH_PREFIX}/api/federated/join`;
 
     const blocklet = await this.getBlocklet(did);
     const nodeInfo = await states.node.read();
     const blockletInfo = getBlockletInfo(blocklet, nodeInfo.sk);
-    const { permanentWallet, wallet } = blockletInfo;
+    const { permanentWallet } = blockletInfo;
     const memberSite = {
-      appId: wallet.address,
-      appPid: permanentWallet.address,
-      migratedFrom: blocklet.migratedFrom || [],
+      appId: blocklet.appDid,
+      appPid: blocklet.appPid,
+      aliasDid: (blocklet.migratedFrom || []).map((item) => item.appDid),
       appName: blockletInfo.name,
       appDescription: blockletInfo.description,
       appUrl: blockletInfo.appUrl,
@@ -3439,33 +3446,99 @@ class FederatedBlockletManager extends DiskBlockletManager {
         normalizePathPrefix(`${WELLKNOWN_SERVICE_PATH_PREFIX}/blocklet/logo`) ||
         '/',
       appLogoRect: blocklet.environmentObj.BLOCKLET_APP_LOGO_RECT,
-      did: blockletInfo.did,
+      did: permanentWallet.address,
       pk: permanentWallet.publicKey,
       serverId: nodeInfo.did,
       serverVersion: nodeInfo.version,
       version: blockletInfo.version,
     };
 
-    const { data } = await request.post(url.href, {
-      // 初次申请时，member 不在站点群中，不需要对数据进行加密
-      site: memberSite,
+    logger.info('Apply to join federated login', {
+      memberSite: pick(memberSite, ['appId', 'appPid', 'appName', 'appDescription', 'appUrl']),
+      masterAppUrl: appUrl,
     });
-    await states.blockletExtras.setSettings(blocklet.meta.did, {
+
+    let data;
+    try {
+      const result = await request.post(url.href, {
+        // 初次申请时，member 不在站点群中，不需要对数据进行加密
+        site: memberSite,
+      });
+      data = result.data;
+    } catch (error) {
+      logger.error('Failed to join federated login', { error, did, url: url.href });
+      throw error;
+    }
+
+    await states.blockletExtras.setSettings(blocklet.appPid, {
       federated: {
         config: {
           appId: blocklet.appDid,
-          appPid: blocklet.appPid || blocklet.appDid,
+          appPid: blocklet.appPid,
           isMaster: false,
         },
         sites: data.sites,
       },
     });
 
+    const newState = await this.getBlocklet(did);
+    this.emit(BlockletEvents.updated, {
+      masterAppUrl: appUrl,
+    });
+    return newState;
+  }
+
+  async quitFederatedLogin({ did }) {
+    const blocklet = await this.getBlocklet(did);
+    const federated = defaults(cloneDeep(blocklet.settings.federated || {}), {
+      config: {},
+      sites: [],
+    });
+    const masterSite = federated.sites[0];
+    if (masterSite && masterSite.isMaster !== false) {
+      const nodeInfo = await states.node.read();
+      const blockletInfo = getBlockletInfo(blocklet, nodeInfo.sk);
+      const { permanentWallet } = blockletInfo;
+      logger.info('Quit federated login', {
+        memberSite: {
+          appId: blocklet.appDid,
+          appPid: blocklet.appPid,
+          appName: blockletInfo.name,
+          appDescription: blockletInfo.description,
+          appUrl: blockletInfo.appUrl,
+        },
+        masterAppUrl: masterSite.appUrl,
+      });
+      const url = new URL(masterSite.appUrl);
+      url.pathname = `${WELLKNOWN_SERVICE_PATH_PREFIX}/api/federated/quit`;
+      try {
+        await request.post(url.href, {
+          signer: permanentWallet.address,
+          data: signV2(permanentWallet.address, permanentWallet.secretKey, {
+            memberPid: blocklet.appPid,
+          }),
+        });
+      } catch (error) {
+        logger.error('Failed to quit blocklet', { error, did, url: url.href });
+        throw error;
+      }
+    }
+
+    await states.blockletExtras.setSettings(blocklet.appPid, {
+      federated: null,
+    });
     const newState = await this.getBlocklet(did);
     this.emit(BlockletEvents.updated, newState);
     return newState;
   }
 
+  /**
+   * 更改 federated 配置
+   * @param {object} param
+   * @param {string} param.did blocklet pid
+   * @param {object} param.config federated 配置内容
+   * @returns {Promise<any>} 更新后的 blocklet 数据
+   */
   async setFederated({ did, config }) {
     await states.blockletExtras.setSettings(did, { federated: config });
 
@@ -3474,6 +3547,13 @@ class FederatedBlockletManager extends DiskBlockletManager {
     return newState;
   }
 
+  /**
+   * 配置 federated 设置
+   * @param {object} param
+   * @param {string} param.did blocklet pid
+   * @param {boolean} param.autoLogin 是否自动登录
+   * @returns {Promise<any>} 更新后的 blocklet 数据
+   */
   async configFederated({ did, autoLogin = false }) {
     const blocklet = await this.getBlocklet(did);
     const federated = cloneDeep(blocklet.settings.federated || {});
@@ -3485,23 +3565,40 @@ class FederatedBlockletManager extends DiskBlockletManager {
     return newState;
   }
 
-  async auditFederatedLogin({ appId, did, status }) {
+  /**
+   * 审核 federated 申请
+   * @param {object} param
+   * @param {string} param.did master blocklet pid
+   * @param {string} param.memberPid member blocklet pid
+   * @param {boolean} param.autoLogin 是否自动登录
+   * @returns {Promise<any>} 更新后的 blocklet 数据
+   */
+  async auditFederatedLogin({ memberPid, did, status }) {
     const blocklet = await this.getBlocklet(did);
 
-    const federated = cloneDeep(blocklet.settings.federated || {});
-    const memberSite = federated.sites.find((item) => item.appId === appId);
+    const federated = defaults(cloneDeep(blocklet.settings.federated || {}), {
+      config: {},
+      sites: [],
+    });
+    const memberSite = federated.sites.find((item) => item.appPid === memberPid);
     memberSite.status = status;
     if ([null, undefined].includes(federated.config.isMaster)) {
-      const masterSite = federated.sites.find((item) => item.appId === blocklet.meta.did);
+      const { sites, config } = federated;
+      const masterSite = sites.find((item) => item.appPid === blocklet.appPid);
 
       masterSite.isMaster = true;
-      federated.config.isMaster = true;
+      config.isMaster = true;
     }
     // 有审批操作的一方，自动成为 master
     const newState = await this.setFederated({
-      did: blocklet.meta.did,
+      did: blocklet.appPid,
       config: federated,
     });
+    logger.info('Audit member join federated login', {
+      memberSite: pick(memberSite, ['appId', 'appPid', 'appName', 'appDescription', 'appUrl']),
+      status,
+    });
+
     const nodeInfo = await states.node.read();
     const { permanentWallet } = getBlockletInfo(blocklet, nodeInfo.sk);
     let delegation;
@@ -3520,25 +3617,37 @@ class FederatedBlockletManager extends DiskBlockletManager {
               'agreement',
               'verifiableCredential',
               'asset',
-              // 'keyPair',
-              // 'encryptionKey',
+              'keyPair',
+              // 'encryptionKey',  // 备份还原应用时使用
             ],
           },
         ],
         exp: Math.floor(new Date().getTime() / 1000) + 86400 * 365 * 100, // valid for 100 year
       });
-      roles = await this.teamManager.getRoles(blocklet.meta.did);
+      roles = await this.teamManager.getRoles(blocklet.appPid);
     }
 
-    await request.post(`${memberSite.appUrl}/${WELLKNOWN_SERVICE_PATH_PREFIX}/api/federated/audit-res`, {
-      signer: permanentWallet.address,
-      data: signV2(permanentWallet.address, permanentWallet.secretKey, {
-        appId: blocklet.meta.did,
-        status,
-        delegation,
-        roles: roles.map((item) => pick(item, ['name', 'title', 'description'])),
-      }),
+    const postUrl = `${memberSite.appUrl}/${WELLKNOWN_SERVICE_PATH_PREFIX}/api/federated/audit-res`;
+
+    logger.info('Audit member join federated login', {
+      status,
+      postUrl,
     });
+    try {
+      const roleList = roles.map((item) => pick(item, ['name', 'title', 'description']));
+      await request.post(postUrl, {
+        signer: permanentWallet.address,
+        data: signV2(permanentWallet.address, permanentWallet.secretKey, {
+          masterPid: blocklet.appPid,
+          status,
+          delegation,
+          roles: roleList,
+        }),
+      });
+    } catch (error) {
+      logger.error('Failed to post audit res to member-site', { error, did, url: postUrl });
+      throw error;
+    }
     const waitingList = federated.sites
       .filter((item) => item.appId !== federated.config.appId)
       .map((item) => {

package/lib/index.js

@@ -259,6 +259,7 @@ function ABTNode(options) {
     configNavigations: blockletManager.configNavigations.bind(blockletManager),
     configOAuth: blockletManager.configOAuth.bind(blockletManager),
     joinFederatedLogin: blockletManager.joinFederatedLogin.bind(blockletManager),
+    quitFederatedLogin: blockletManager.quitFederatedLogin.bind(blockletManager),
     auditFederatedLogin: blockletManager.auditFederatedLogin.bind(blockletManager),
     configFederated: blockletManager.configFederated.bind(blockletManager),
     setFederated: blockletManager.setFederated.bind(blockletManager),

package/lib/states/audit-log.js

@@ -138,16 +138,21 @@ const getLogContent = async (action, args, context, result, info, node) => {
       return `set publicToStore to ${args.publicToStore ? 'true' : 'false'}`;
     case 'configNavigations':
       // eslint-disable-next-line prettier/prettier
-      return `updated following navigations:\n${args.navigations.map(
-        (x) => `- ${x.title}: ${x.link}\n`
-      )}`;
+      return `updated following navigations:\n${args.navigations.map((x) => `- ${x.title}: ${x.link}\n`)}`;
     case 'configOAuth':
       return `updated following OAuth for blocklet ${getBlockletInfo(result, info)}:\n${args.oauth}`;
-    // TODO: @zhanghan 配置审计日志
     case 'joinFederatedLogin':
-      return `updated following OAuth for blocklet ${getBlockletInfo(result, info)}:\n${args.oauth}`;
+      return `blocklet ${getBlockletInfo(result, info)} join federated login to ${args.appUrl}`;
+    case 'quitFederatedLogin':
+      return `blocklet ${getBlockletInfo(result, info)} quit federated login`;
     case 'auditFederatedLogin':
-      return `updated following OAuth:\n${args.oauth}`;
+      return `blocklet ${getBlockletInfo(result, info)} audit federated login member ${args.memberPid} with status: ${
+        args.status
+      }`;
+    case 'configFederated':
+      return `blocklet ${getBlockletInfo(result, info)} config federated login settings with autoLogin: ${
+        args.autoLogin
+      }`;
     case 'configNotification':
       return `updated following notification setting: ${args.notification}`;
     case 'updateComponentTitle':
@@ -315,6 +320,10 @@ const getLogCategory = (action) => {
     case 'updateComponentTitle':
     case 'updateComponentMountPoint':
     case 'backupToSpaces':
+    case 'joinFederatedLogin':
+    case 'quitFederatedLogin':
+    case 'auditFederatedLogin':
+    case 'configFederated':
       return 'blocklet';
 
     // store，此处应该返回 server

package/lib/util/blocklet.js

@@ -1229,6 +1229,7 @@ const getBlocklet = async ({
   }
 
   // app settings
+  // FIXME: @zhanghan 在 server 开发模式下，使用 `node /workspace/arcblock/blocklet-server/core/cli/tools/dev.js` 运行的 blocklet，blocklet.meta.did 和 blocklet.appPid 是不一致的
   const settings = await states.blockletExtras.getSettings(blocklet.meta.did);
   blocklet.trustedPassports = get(settings, 'trustedPassports') || [];
   blocklet.trustedFactories = (get(settings, 'trustedFactories') || []).map((x) => {

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.14-beta-1936d3d0",
+  "version": "1.16.14-beta-dd4f6a50",
   "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-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",
+    "@abtnode/analytics": "1.16.14-beta-dd4f6a50",
+    "@abtnode/auth": "1.16.14-beta-dd4f6a50",
+    "@abtnode/certificate-manager": "1.16.14-beta-dd4f6a50",
+    "@abtnode/constant": "1.16.14-beta-dd4f6a50",
+    "@abtnode/cron": "1.16.14-beta-dd4f6a50",
+    "@abtnode/logger": "1.16.14-beta-dd4f6a50",
+    "@abtnode/models": "1.16.14-beta-dd4f6a50",
+    "@abtnode/queue": "1.16.14-beta-dd4f6a50",
+    "@abtnode/rbac": "1.16.14-beta-dd4f6a50",
+    "@abtnode/router-provider": "1.16.14-beta-dd4f6a50",
+    "@abtnode/static-server": "1.16.14-beta-dd4f6a50",
+    "@abtnode/timemachine": "1.16.14-beta-dd4f6a50",
+    "@abtnode/util": "1.16.14-beta-dd4f6a50",
     "@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-1936d3d0",
-    "@blocklet/meta": "1.16.14-beta-1936d3d0",
-    "@blocklet/resolver": "1.16.14-beta-1936d3d0",
-    "@blocklet/sdk": "1.16.14-beta-1936d3d0",
+    "@blocklet/constant": "1.16.14-beta-dd4f6a50",
+    "@blocklet/meta": "1.16.14-beta-dd4f6a50",
+    "@blocklet/resolver": "1.16.14-beta-dd4f6a50",
+    "@blocklet/sdk": "1.16.14-beta-dd4f6a50",
     "@did-space/client": "^0.2.129",
     "@fidm/x509": "^1.2.1",
     "@ocap/mcrypto": "1.18.87",
@@ -99,5 +99,5 @@
     "jest": "^27.5.1",
     "unzipper": "^0.10.11"
   },
-  "gitHead": "32bcf5b55889ebd7302887eedd306d331e9cd3b8"
+  "gitHead": "fb3858f842b221f0a8c298307b393d55c555af45"
 }