@abtnode/blocklet-services 1.16.17-beta-3232a7af → 1.16.17-beta-703fb879

package/api/index.js

@@ -38,6 +38,7 @@ const createEnvRoutes = require('./routes/env');
 const createOAuthRoutes = require('./routes/oauth');
 const createFederatedRoutes = require('./routes/federated');
 const createUserRoutes = require('./routes/user');
+const createUserSessionRoutes = require('./routes/user-session');
 const createBlockletRoutes = require('./routes/blocklet');
 const createConnectRelayRoutes = require('./routes/connect/relay');
 const createConnectSessionRoutes = require('./routes/connect/session');
@@ -260,6 +261,7 @@ module.exports = function createServer(node, serverOptions = {}) {
   // API: auth
   createOAuthRoutes.init(server, node, options);
   createFederatedRoutes.init(server, node, options);
+  createUserSessionRoutes.init(server, node, options);
   createUserRoutes.init(server, node, options);
   createEnvRoutes.init(server, node, options);
   createBlockletRoutes.init(server, node);

package/api/libs/connect/session.js

@@ -49,6 +49,7 @@ const { transferPassport } = require('../auth/utils');
 const { migrateAccount, declareAccount } = require('../../services/oauth');
 const { getTrustedIssuers, getFederatedTrustedIssuers } = require('../../util/blocklet-utils');
 const { getUserAvatarUrl, migrateAuth0, getFederatedMaster, shouldSyncFederated } = require('../../util/federated');
+const { upsertUserSession } = require('../../util/user-session');
 
 const vcTypes = [VC_TYPE_GENERAL_PASSPORT, VC_TYPE_NODE_PASSPORT];
 
@@ -210,6 +211,7 @@ module.exports = {
       createSessionToken,
       componentId,
       action,
+      visitorId,
     }) => {
       const blocklet = await request.getBlocklet();
       const blockletInfo = await request.getBlockletInfo();
@@ -408,9 +410,8 @@ module.exports = {
         );
       }
 
-      // NOTICE: 采用异步来更新，不阻塞接口的正常响应
       if (shouldSyncFederated(sourceAppPid, masterSite, blocklet)) {
-        node.syncFederated({
+        await node.syncFederated({
           did: teamDid,
           data: {
             users: [
@@ -429,6 +430,18 @@ module.exports = {
         });
       }
 
+      const userSessionDoc = await upsertUserSession(
+        {
+          teamDid,
+          visitorId,
+          userDid: realDid,
+          appPid: teamDid,
+          passportId: passport?.id,
+          status: 'online',
+        },
+        { req: request, node, sourceAppPid }
+      );
+
       // Generate new session token that client can save to localStorage
       const createToken = createTokenFn(createSessionToken);
       const sessionConfig = blocklet.settings?.session || {};
@@ -468,6 +481,7 @@ module.exports = {
           data: vc,
           sessionToken,
           refreshToken,
+          visitorId: userSessionDoc.visitorId,
           nextWorkflowData: {
             userDid: realDid,
           },
@@ -477,6 +491,7 @@ module.exports = {
       return {
         sessionToken,
         refreshToken,
+        visitorId: userSessionDoc.visitorId,
         nextWorkflowData: {
           userDid: realDid,
         },

package/api/libs/open-graph/emoji.js

@@ -0,0 +1,80 @@
+/* eslint-disable consistent-return */
+/* eslint-disable no-bitwise */
+const fetch = require('node-fetch').default;
+
+const U200D = String.fromCharCode(8205); // zero-width joiner
+const UFE0Fg = /\uFE0F/g; // variation selector regex
+
+const getIconCode = (char) => toCodePoint(char.indexOf(U200D) < 0 ? char.replace(UFE0Fg, '') : char);
+
+const toCodePoint = (unicodeSurrogates) => {
+  const r = [];
+  let c = 0;
+  let p = 0;
+  let i = 0;
+  while (i < unicodeSurrogates.length) {
+    c = unicodeSurrogates.charCodeAt(i++);
+    if (p) {
+      r.push((65536 + ((p - 55296) << 10) + (c - 56320)).toString(16));
+      p = 0;
+    } else if (c >= 55296 && c <= 56319) {
+      p = c;
+    } else {
+      r.push(c.toString(16));
+    }
+  }
+  return r.join('-');
+};
+
+const apis = {
+  twemoji: (code) => `https://cdn.jsdelivr.net/gh/twitter/twemoji@14.0.2/assets/svg/${code.toLowerCase()}.svg`,
+  openmoji: 'https://cdn.jsdelivr.net/npm/@svgmoji/openmoji@2.0.0/svg/',
+  blobmoji: 'https://cdn.jsdelivr.net/npm/@svgmoji/blob@2.0.0/svg/',
+  noto: 'https://cdn.jsdelivr.net/gh/svgmoji/svgmoji/packages/svgmoji__noto/svg/',
+  fluent: (code) => `https://cdn.jsdelivr.net/gh/shuding/fluentui-emoji-unicode/assets/${code.toLowerCase()}_color.svg`,
+  fluentFlat: (code) =>
+    `https://cdn.jsdelivr.net/gh/shuding/fluentui-emoji-unicode/assets/${code.toLowerCase()}_flat.svg`,
+};
+
+// https://github.com/svgmoji/svgmoji
+const loadEmoji = (code, type) => {
+  const api = apis[type] ?? apis.twemoji;
+  if (typeof api === 'function') {
+    return fetch(api(code));
+  }
+  return fetch(`${api}${code.toUpperCase()}.svg`);
+};
+
+const cache = new Map();
+const loadDynamicAsset = (emojiType = 'twemoji') => {
+  const fn = async (languageCode, text) => {
+    if (languageCode === 'emoji') {
+      const code = getIconCode(text);
+      try {
+        const emoji = await loadEmoji(code, emojiType);
+        return `data:image/svg+xml;base64,${btoa(await emoji.text())}`;
+      } catch (err) {
+        console.error(`Failed to fetch emoji: ${text}:${code}`, err);
+      }
+    }
+  };
+
+  return async (...args) => {
+    const key = JSON.stringify({ ...args, emojiType });
+    const cached = cache.get(key);
+    if (cached) {
+      return cached;
+    }
+
+    const font = await fn(...args);
+    cache.set(key, font);
+    return font;
+  };
+};
+
+module.exports = {
+  apis,
+  getIconCode,
+  loadEmoji,
+  loadDynamicAsset,
+};

package/api/libs/open-graph/index.js

@@ -15,6 +15,7 @@ const logger = require('@abtnode/logger')('@abtnode/blocklet-services/og');
 
 const { getTemplate, getLogoSvg } = require('./template');
 const { getCacheFilePath } = require('../image');
+const emoji = require('./emoji');
 
 const TEMPLATES = ['default', 'section', 'cover'];
 
@@ -64,6 +65,12 @@ const schema = Joi.object({
   logo: Joi.string()
     .uri({ scheme: ['https'] })
     .optional(),
+
+  // custom emoji
+  emoji: Joi.string()
+    .valid(...Object.keys(emoji.apis))
+    .optional()
+    .default('twemoji'),
 }).options({ stripUnknown: true, allowUnknown: true, noDefaults: false });
 
 const generateTasks = {};
@@ -133,9 +140,14 @@ const convertExternalImage = (url, dest) => {
           headers: { Accept: 'image/*' },
         },
         (res) => {
+          if (res.statusCode && res.statusCode >= 400) {
+            reject(new Error(`unexpected external image status: ${res.statusCode}`));
+            return;
+          }
+
           const [type] = (res.headers['content-type'] || '').split('/');
           if (type !== 'image') {
-            reject(new Error('external image is not an image'));
+            reject(new Error(`unexpected external image format: ${type}`));
             return;
           }
 
@@ -226,6 +238,7 @@ const generateOgImage = async (params, tmpDir) => {
         style: 'normal',
       },
     ],
+    loadAdditionalAsset: emoji.loadDynamicAsset(params.emoji),
   });
 
   if (params.format === 'svg') {

package/api/routes/federated.js

@@ -312,7 +312,7 @@ module.exports = {
       const { blocklet } = req;
       const { verifySite } = req.body;
       const teamDid = blocklet.appPid;
-      const { users = null, sites = null } = req.body.verifyData;
+      const { users = null, sites = null, userSessions = null } = req.body.verifyData;
 
       // FIXME: @zhanghan 校验 users 和 sites 数据合法性
       const pendingList = [];
@@ -346,11 +346,31 @@ module.exports = {
         }
       }
 
+      if (!isNil(userSessions)) {
+        if (Array.isArray(userSessions)) {
+          for (const userSession of userSessions) {
+            const { action, ...userSessionItem } = userSession;
+            pendingList.push(
+              limitSync(async () => {
+                if (action === 'login') {
+                  await node.upsertUserSession(
+                    { ...userSessionItem, teamDid, status: 'online' },
+                    { req, node, sourceAppPid: teamDid }
+                  );
+                } else if (action === 'logout') {
+                  await node.logoutUser({ ...userSessionItem, teamDid });
+                }
+              })
+            );
+          }
+        }
+      }
+
       await Promise.all(pendingList);
       await node.createAuditLog(
         {
           action: 'syncFederated',
-          args: { users, sites, callerSite: verifySite, teamDid },
+          args: { users, sites, userSessions, callerSite: verifySite, teamDid },
           context: {
             user: getAuditLogActorByFederatedSite(verifySite),
           },
@@ -661,6 +681,84 @@ module.exports = {
       res.json({ sessionToken, refreshToken });
     });
 
+    // 用于在 master 站点登录页面获取 member 登录的 token
+    server.post(`${prefix}/loginByMaster`, ensureBlocklet(), verifyFederatedCall(), async (req, res) => {
+      const { verifySite } = req.body;
+      const { passport, user, walletOS, provider } = req.body.verifyData;
+      const { createSessionToken } = initJwt(node, options);
+      const createToken = createTokenFn(createSessionToken);
+      const { secret } = await req.getBlockletInfo();
+      const { blocklet } = req;
+      const teamDid = blocklet.appPid;
+
+      const sessionConfig = blocklet.settings?.session || {};
+      const prevUser = await node.getUser({
+        teamDid,
+        user: { did: user.did },
+        options: { enableConnectedAccount: true },
+      });
+      // HACK: member 调用 master 时，将 passport 的 role 还原为 master 中原有的 role
+      const targetPassport = passport?.id ? (prevUser?.passports || []).find((item) => item.id === passport.id) : null;
+
+      // HACK: 用户在 master 中存在时，不更新任何用户信息；不存在时，将新增一个用户
+      const filterUserInfo = prevUser ? {} : user;
+      if (filterUserInfo.avatar) {
+        let avatar = await getAvatarByUrl(filterUserInfo.avatar);
+        const nodeInfo = await req.getNodeInfo();
+
+        const { dataDir } = await getApplicationInfo({ node, nodeInfo, teamDid });
+        avatar = await extractUserAvatar(avatar, { dataDir });
+        filterUserInfo.avatar = avatar;
+      }
+      const realDid = prevUser?.did || user.did;
+      const realPk = prevUser?.pk || user.pk;
+      // NOTICE: 这里是 Master 登录，不需要 sourceAppPid 字段
+      const newUser = await node.loginUser({
+        teamDid,
+        user: {
+          ...filterUserInfo,
+          did: realDid,
+          pk: realPk,
+          passport: targetPassport,
+          connectedAccount: {
+            provider: provider || LOGIN_PROVIDER.WALLET,
+            did: user.did,
+            pk: user.pk,
+          },
+        },
+      });
+
+      const { sessionToken, refreshToken } = createToken(
+        user.did,
+        {
+          secret,
+          passport: targetPassport,
+          role: targetPassport?.role || 'guest',
+          fullName: newUser.fullName,
+          provider: provider || LOGIN_PROVIDER.WALLET,
+          walletOS,
+          sourceAppPid: verifySite.appPid,
+        },
+        {
+          ...sessionConfig,
+          didConnectVersion: getDidConnectVersion(req),
+        }
+      );
+
+      await node.createAuditLog(
+        {
+          action: 'loginByMaster',
+          args: { masterSite: verifySite, teamDid, blocklet },
+          context: {
+            user: newUser,
+          },
+        },
+        node
+      );
+
+      res.json({ sessionToken, refreshToken });
+    });
+
     // member 向 master 申请 auth0 账号的 migrate
     server.post(`${prefix}/migrateAuth0`, ensureBlocklet(), verifyFederatedCall(), async (req, res) => {
       const { blocklet } = req;
@@ -728,5 +826,13 @@ module.exports = {
       );
       res.json(data);
     });
+
+    server.post(`${prefix}/getPassport`, ensureBlocklet(), verifyFederatedCall(), async (req, res) => {
+      const { blocklet } = req;
+      const teamDid = blocklet.appPid;
+      const { passportId } = req.body.verifyData;
+      const result = await node.getPassportById({ teamDid, passportId });
+      res.json(result);
+    });
   },
 };

package/api/routes/oauth.js

@@ -24,6 +24,7 @@ const { sendToUser } = require('../libs/notification');
 const { isInvitedUserOnly, createTokenFn, getDidConnectVersion } = require('../util');
 const { ApiError } = require('../util/error');
 const { loginAuth0, getFederatedMaster, getOAuthUserInfo, shouldSyncFederated } = require('../util/federated');
+const { upsertUserSession } = require('../util/user-session');
 
 const PREFIX = WELLKNOWN_SERVICE_PATH_PREFIX;
 
@@ -64,7 +65,7 @@ function getAuthClient(blocklet, provider) {
 
 async function login(req, node, options) {
   const blocklet = await req.getBlocklet();
-  const { token, locale = 'en', provider, componentId, sourceAppPid } = req.body;
+  const { token, locale = 'en', provider, componentId, sourceAppPid, visitorId } = req.body;
 
   if (!blocklet.settings?.owner) {
     throw new ApiError(400, t('oauthCantBeOwner', locale));
@@ -187,7 +188,6 @@ async function login(req, node, options) {
   );
 
   const masterSite = getFederatedMaster(blocklet);
-  // NOTICE: 采用异步来更新，不阻塞接口的正常响应
   if (shouldSyncFederated(sourceAppPid, masterSite, blocklet)) {
     const syncUserData = {
       did: userDid,
@@ -196,7 +196,7 @@ async function login(req, node, options) {
       avatar: getUserAvatarUrl(appUrl, profile.avatar),
       connectedAccount: [connectedAccount],
     };
-    node.syncFederated({
+    await node.syncFederated({
       did: teamDid,
       data: {
         users: [
@@ -210,6 +210,22 @@ async function login(req, node, options) {
     });
   }
 
+  const userSessionDoc = await upsertUserSession(
+    {
+      teamDid,
+      userDid,
+      visitorId,
+      appPid: teamDid,
+      passportId: passport?.id,
+      status: 'online',
+    },
+    {
+      node,
+      req,
+      sourceAppPid: sourceAppPid || masterSite.appPid,
+    }
+  );
+
   const { createSessionToken } = initJwt(node, options);
 
   const createToken = createTokenFn(createSessionToken);
@@ -235,11 +251,12 @@ async function login(req, node, options) {
   return {
     sessionToken,
     refreshToken,
+    visitorId: userSessionDoc.visitorId,
   };
 }
 
 async function invite(req, node, options) {
-  const { locale, inviteId, token, baseUrl, provider = LOGIN_PROVIDER.AUTH0, sourceAppPid } = req.body;
+  const { locale, inviteId, token, baseUrl, provider = LOGIN_PROVIDER.AUTH0, sourceAppPid, visitorId } = req.body;
   const blocklet = await req.getBlocklet();
   let userWallet;
   let oauthInfo;
@@ -312,6 +329,7 @@ async function invite(req, node, options) {
     locale,
     provider,
   });
+  const masterSite = getFederatedMaster(blocklet);
 
   if (currentUser) {
     const walletDid = getWalletDid(currentUser);
@@ -351,8 +369,7 @@ async function invite(req, node, options) {
         sourceAppPid,
       },
     });
-    const masterSite = getFederatedMaster(blocklet);
-    // NOTICE: 采用异步来更新，不阻塞接口的正常响应
+
     if (shouldSyncFederated(sourceAppPid, masterSite, blocklet)) {
       const syncUserData = {
         did: userDid,
@@ -360,7 +377,7 @@ async function invite(req, node, options) {
         ...profile,
         connectedAccount: [connectedAccount],
       };
-      node.syncFederated({
+      await node.syncFederated({
         did: teamDid,
         data: {
           users: [
@@ -391,7 +408,27 @@ async function invite(req, node, options) {
     return sessionToken;
   }
 
-  return { sessionToken, refreshToken };
+  const userSessionDoc = await upsertUserSession(
+    {
+      teamDid,
+      userDid,
+      visitorId,
+      appPid: teamDid,
+      passportId: passport.id,
+      status: 'online',
+    },
+    {
+      node,
+      req,
+      sourceAppPid: sourceAppPid || masterSite.appPid,
+    }
+  );
+
+  return {
+    sessionToken,
+    refreshToken,
+    visitorId: userSessionDoc.visitorId,
+  };
 }
 
 // 给 DID Wallet 绑定 Auth0 的流程
@@ -679,8 +716,8 @@ module.exports = {
 
     async function getUserFn(req, res) {
       const { token, provider } = req.body;
-      const blocklet = await req.getBlocklet();
       const { wallet: blockletWallet } = await req.getBlockletInfo();
+      const blocklet = await req.getBlocklet();
       const authClient = getAuthClient(blocklet, provider);
       const oauthInfo = await authClient.getProfile(token);
       const userWallet = fromAppDid(oauthInfo.sub, blockletWallet.secretKey);

package/api/routes/user-session.js

@@ -0,0 +1,165 @@
+/* eslint-disable no-await-in-loop */
+const { WELLKNOWN_SERVICE_PATH_PREFIX } = require('@abtnode/constant');
+const { LOGIN_PROVIDER } = require('@blocklet/constant');
+const defaults = require('lodash/defaults');
+const cloneDeep = require('lodash/cloneDeep');
+const pLimit = require('p-limit');
+
+const ensureBlocklet = require('../middlewares/ensure-blocklet');
+const { upsertUserSession } = require('../util/user-session');
+const { getUserAvatarUrl } = require('../util/federated');
+
+const prefix = `${WELLKNOWN_SERVICE_PATH_PREFIX}/api/user-session`;
+const limit = pLimit(5);
+
+async function getPassportRole(passportId, { node, teamDid }) {
+  const passport = await node.getPassportById({ teamDid, passportId });
+  return passport?.role;
+}
+
+async function getPassportRoleFromFederatedSite(passportId, { appPid, node, teamDid, federated }) {
+  const currentSite = federated.sites.find((x) => x.appPid === appPid);
+  if (currentSite) {
+    const passport = await node.getPassportFromFederated({
+      site: currentSite,
+      passportId,
+      teamDid,
+    });
+    return passport?.role;
+  }
+  return undefined;
+}
+
+async function patchUserSessionData(userSession, { blocklet, appPid, teamDid, node }) {
+  // 修正 avatar 地址，从 bn:// 转换为 http
+  if (userSession.user?.avatar) {
+    userSession.user.avatar = getUserAvatarUrl(userSession.user.avatar, blocklet);
+  }
+
+  const federated = defaults(cloneDeep(blocklet.settings.federated || {}), {
+    config: {
+      appId: blocklet.appDid,
+      appPid: teamDid,
+    },
+    sites: [],
+  });
+  const site = federated.sites.find((siteItem) => siteItem.appPid === userSession.appPid);
+  // 获取 appName，展示在前端
+  if (site) {
+    userSession.appName = site.appName;
+  }
+
+  // 通过 userSession 信息判断 passport 对应的 role（针对 appPid 做转换）
+  let role;
+  if (userSession.passportId) {
+    if (appPid === teamDid) {
+      role = await getPassportRole(userSession?.passportId, { node, teamDid });
+    } else {
+      role = await getPassportRoleFromFederatedSite(userSession.passportId, {
+        appPid,
+        node,
+        teamDid,
+        federated,
+      });
+    }
+  } else {
+    role = userSession.user.role;
+  }
+  userSession.user.role = role || 'guest';
+}
+
+module.exports = {
+  init(app, node) {
+    // NOTE: 保留 /login 路由，该功能不是针对于某一个实体来操作的，需要更明确表达意图
+    app.post(`${prefix}/login`, ensureBlocklet(), async (req, res) => {
+      const { blocklet } = req;
+      const { visitorId, userDid, appPid, passportId } = req.body;
+      if (!userDid) {
+        res.status(400).json({ error: 'userDid is required' });
+        return;
+      }
+      if (!appPid) {
+        res.status(400).json({ error: 'appPid is required' });
+        return;
+      }
+
+      const teamDid = blocklet.appPid;
+
+      const userSessions = await node.getUserSession({
+        teamDid,
+        userDid,
+        visitorId,
+      });
+
+      if (userSessions.length > 0) {
+        const user = await node.getUser({ teamDid, user: { did: userDid } });
+        const federated = defaults(cloneDeep(blocklet.settings.federated || {}), {
+          config: {
+            appId: blocklet.appDid,
+            appPid: teamDid,
+          },
+          sites: [],
+        });
+
+        const memberSite = federated.sites.find((item) => item.appPid === appPid);
+
+        const result = await node.loginFederated({
+          did: appPid,
+          data: {
+            user,
+            passport: passportId ? { id: passportId } : undefined,
+            walletOS: 'web',
+            provider: LOGIN_PROVIDER.WALLET,
+          },
+          site: memberSite,
+        });
+
+        const userSessionDoc = await upsertUserSession(
+          {
+            teamDid: appPid,
+            userDid,
+            visitorId,
+            appPid,
+            passportId,
+            status: 'online',
+          },
+          {
+            node,
+            req,
+            sourceAppPid: teamDid,
+          }
+        );
+
+        res.json({ ...result, visitorId: userSessionDoc.visitorId });
+      } else {
+        res.json({});
+      }
+    });
+
+    app.get(`${prefix}`, ensureBlocklet(), async (req, res) => {
+      const { blocklet } = req;
+      const teamDid = blocklet.appPid;
+      const { visitorId, userDid, appPid = teamDid } = req.query;
+
+      if (!visitorId) {
+        res.json([]);
+        return;
+      }
+
+      const userSessions = await node.getUserSession({
+        teamDid,
+        userDid,
+        visitorId,
+      });
+
+      patchUserSessionData();
+
+      const pendingList = userSessions.map((item) =>
+        limit(() => patchUserSessionData(item, { blocklet, appPid, teamDid, node }))
+      );
+      await Promise.all(pendingList);
+
+      res.json(userSessions);
+    });
+  },
+};

package/api/routes/user.js

@@ -15,6 +15,7 @@ const { ApiError } = require('../util/error');
 const { loginWalletSchema, loginOAuthSchema } = require('../validators/login');
 const verifySig = require('../middlewares/verify-sig');
 const { getAvatarByEmail } = require('../libs/auth/utils');
+const ensureBlocklet = require('../middlewares/ensure-blocklet');
 
 const validateUser = (user) => {
   try {
@@ -298,5 +299,25 @@ module.exports = {
     }
     server.post(`${prefix}/login`, verifySig, loginFn);
     server.post(`${prefixApi}/login`, verifySig, loginFn);
+
+    server.post(`${prefixApi}/logout`, ensureBlocklet(), async (req, res) => {
+      if (req.user) {
+        const { blocklet } = req;
+        const teamDid = blocklet.appPid;
+        const { visitorId } = req.body;
+        if (!visitorId) {
+          res.status(400).json({ error: 'visitorId is required' });
+          return;
+        }
+
+        await node.logoutUser({
+          userDid: req.user.did,
+          visitorId,
+          appPid: teamDid,
+          teamDid,
+        });
+      }
+      res.json({});
+    });
   },
 };