@abtnode/blocklet-services 1.16.27 → 1.16.28-beta-bfbab430

package/api/index.js

@@ -266,6 +266,7 @@ module.exports = function createServer(node, serverOptions = {}) {
   // API: notification
   notificationService.sendToUser.attach(server);
   notificationService.sendToMail.attach(server);
+  notificationService.sendToPush.attach(server);
   notificationService.sendToAppChannel.attach(server);
   relayService.sendToRelay.attach(server);
 
@@ -362,16 +363,16 @@ module.exports = function createServer(node, serverOptions = {}) {
   // After all service middleware, we can now safely pass all traffic to blocklets
   server.use(async (req, res) => {
     try {
-      const { target } = await ensureProxyUrl(req);
+      const { target, headers, error } = await ensureProxyUrl(req);
       if (target) {
         if (imageService.isImageAccepted(req) && imageService.isImageRequest(req)) {
           req.target = target; // for internal use
           imageService.processImage(req, res);
         } else {
-          proxy.safeWeb(req, res, { target });
+          proxy.safeWeb(req, res, { target, headers });
         }
       } else {
-        throw new Error('empty proxy target');
+        throw new Error(error);
       }
     } catch (err) {
       logger.error('Failed to get component target', { url: req.url, error: err });

package/api/libs/connect/session.js

@@ -158,7 +158,7 @@ const checkAppOwner = ({ role, blocklet, userDid, locale = 'en' }) => {
 const isDidSpaceRequiredOnConnect = (blocklet, request) => {
   let flag = false;
 
-  const [, componentDid] = request.headers['x-blocklet-component-id'].split('/');
+  const [, componentDid] = (request.get('x-blocklet-component-id') || '').split('/');
 
   forEachBlockletSync(blocklet, (b) => {
     flag =
@@ -472,7 +472,7 @@ module.exports = {
               locale,
               passport,
               sourceAppPid,
-              lastLoginIp: get(request, 'headers[x-real-ip]') || '',
+              lastLoginIp: request.get('x-real-aip') || '',
               connectedAccount: [connectAccount, connectedNft],
             },
           });
@@ -502,7 +502,7 @@ module.exports = {
               locale,
               passport,
               sourceAppPid,
-              lastLoginIp: get(request, 'headers[x-real-ip]') || '',
+              lastLoginIp: request.get('x-real-ip') || '',
               connectedAccount: [connectAccount, connectedNft],
             },
           });
@@ -522,8 +522,10 @@ module.exports = {
             node
           );
         }
-        const lastLoginIp = request.headers['x-real-ip'];
-        const ua = request.headers['user-agent'];
+        const lastLoginIp = request.get('x-real-ip');
+        const walletDeviceMessageToken = request.get('wallet-device-message-token');
+        const walletDeviceId = request.get('wallet-device-id');
+        const ua = request.get('user-agent');
         // request.context.store.connectedWallet
         const walletOS = request.context.didwallet.os;
 
@@ -538,6 +540,8 @@ module.exports = {
           lastLoginIp,
           extra: {
             walletOS,
+            walletDeviceMessageToken,
+            walletDeviceId,
           },
         });
 
@@ -571,6 +575,8 @@ module.exports = {
                 lastLoginIp,
                 extra: {
                   walletOS,
+                  walletDeviceMessageToken,
+                  walletDeviceId,
                 },
               });
             });
@@ -1106,7 +1112,7 @@ module.exports = {
           pk: oauthUser.pk,
           ...mergeProfile,
           locale,
-          lastLoginIp: get(request, 'headers[x-real-ip]') || '',
+          lastLoginIp: request.get('x-real-ap') || '',
           connectedAccounts: [connectedAccount],
           passports: mergePassport,
         },

package/api/libs/connect/v1.js

@@ -83,7 +83,11 @@ module.exports = (node, opts) => {
 
     // Only handles did-connect updates, because we need to determine the actual app
     sendToRelayFn: async (topic, event, data) => {
-      const publisher = get(data, 'appInfo.agentDid', '') || get(data, 'appInfo.publisher', '');
+      // NOTICE: 这里需要和前端订阅的 ws channel 保持一致
+      // 1. 如果是统一登录的环境，那么前端订阅的 channel 是 memberAppInfo.publisher
+      // 2. 如果是非统一登录的环境，那么前端订阅的 channel 是 appInfo.publisher
+      // 永远保持订阅的通道是当前 blocklet 的 did
+      const publisher = get(data, 'memberAppInfo.publisher') || get(data, 'appInfo.publisher');
       if (!publisher) {
         return null;
       }

package/api/libs/push-kit/index.js

@@ -0,0 +1,114 @@
+const uniqWith = require('lodash/uniqWith');
+const { sign } = require('@blocklet/sdk/lib/util/verify-sign');
+const getBlockletInfo = require('@blocklet/meta/lib/info');
+const { joinURL } = require('ufo');
+const pRetry = require('p-retry');
+
+const { api } = require('../api');
+const logger = require('../logger')('blocklet-services:notification');
+
+async function sendPush(receiver, notification, { node, teamDid }) {
+  const blocklet = await node.getBlocklet({ did: teamDid, useCache: true });
+  if (!blocklet) {
+    logger.warn(`Failed to get blocklet: ${teamDid}`);
+    return null;
+  }
+
+  const config = blocklet.settings?.notification?.pushKit || {};
+
+  if (!config.enabled || !config.endpoint) {
+    // skip send email
+    return null;
+  }
+
+  const pushKitConfig = {
+    did: config.did || 'z2qa6xfPH6zHq5AQjb2Qm5CfmpndyQsvZrTKH',
+    pushPath: config.pushPath || '/api/push',
+  };
+
+  let pushKitUrl;
+  try {
+    const pushKitOrigin = new URL(config.endpoint).origin;
+    const { data: blockletJson } = await api.get(joinURL(pushKitOrigin, '/__blocklet__.js?type=json'));
+    const componentMountPoints = blockletJson?.componentMountPoints || [];
+    const findPushKitComponent = componentMountPoints.find((x) => x.did === pushKitConfig.did);
+    if (!findPushKitComponent) {
+      throw new Error(`Endpoint(${config.endpoint}) does not have push kit component`);
+    }
+    pushKitUrl = joinURL(pushKitOrigin, findPushKitComponent.mountPoint, pushKitConfig.pushPath);
+  } catch (error) {
+    logger.error(`Failed to get push kit endpoint: ${config.endpoint}`, { error });
+    throw new Error(`Invalid push kit endpoint: ${config.endpoint}`);
+  }
+
+  const { users = [] } = await node.getUsers({
+    teamDid,
+    dids: receiver,
+    query: {
+      approved: true,
+      includeUserSessions: true,
+    },
+  });
+
+  const targets = users.reduce((acc, user) => {
+    if (user.userSessions?.length > 0) {
+      user.userSessions.forEach((x) => {
+        const platform = x?.extra?.walletOS;
+        const deviceToken = x?.extra?.walletDeviceMessageToken;
+        if (platform && ['ios', 'android', 'ios-sandbox'].includes(platform) && deviceToken) {
+          acc.push({
+            platform,
+            deviceToken,
+          });
+        }
+      });
+    }
+    return acc;
+  }, []);
+
+  const filterTargets = uniqWith(targets, (a, b) => {
+    return a.targets === b.targets && a.platform === b.platform;
+  });
+
+  if (filterTargets.length === 0) {
+    throw new Error('Invalid receiver: empty target');
+  }
+
+  const blockletInfo = getBlockletInfo(blocklet);
+
+  const sig = sign(
+    {
+      targets: filterTargets,
+      data: notification,
+    },
+    { appSk: blockletInfo.wallet.secretKey }
+  );
+
+  try {
+    const result = await pRetry(
+      () =>
+        api.post(
+          pushKitUrl,
+          {
+            targets: filterTargets,
+            data: notification,
+          },
+          {
+            headers: {
+              'x-blocklet-sig': sig,
+              'x-blocklet-sig-pk': blockletInfo.wallet.publicKey,
+            },
+          }
+        ),
+      { retries: 3 }
+    );
+    return result?.data;
+  } catch (error) {
+    logger.error('Failed to send push kit', { error });
+    throw error;
+  }
+}
+
+module.exports = {
+  sendPush,
+};

package/api/routes/federated.js

@@ -2,7 +2,6 @@ const { WELLKNOWN_SERVICE_PATH_PREFIX, FEDERATED } = require('@abtnode/constant'
 const { signV2 } = require('@arcblock/jwt');
 const normalizePathPrefix = require('@abtnode/util/lib/normalize-path-prefix');
 const cloneDeep = require('lodash/cloneDeep');
-const get = require('lodash/get');
 const isNil = require('lodash/isNil');
 const pLimit = require('p-limit');
 const pRetry = require('p-retry');
@@ -546,7 +545,7 @@ module.exports = {
           const federatedSites = blocklet.settings?.federated?.sites || [];
           const loginSite = federatedSites.find((item) => {
             const siteHost = new URL(item.appUrl).host;
-            const fromHost = new URL(req.headers.origin).host;
+            const fromHost = new URL(req.get('origin')).host;
             return [siteHost, ...(item.aliasDomain || [])].includes(fromHost);
           });
 
@@ -561,7 +560,7 @@ module.exports = {
           });
 
           const user = pick(currentUser, ['did', 'pk', 'fullName', 'locale']);
-          user.lastLoginIp = get(req, 'headers[x-real-ip]') || '';
+          user.lastLoginIp = req.get('x-real-ip') || '';
 
           if (currentUser.email) {
             user.email = currentUser.email;

package/api/routes/oauth.js

@@ -4,7 +4,6 @@ const { WELLKNOWN_SERVICE_PATH_PREFIX, NODE_SERVICES, PASSPORT_STATUS } = requir
 const { extractUserAvatar, getUserAvatarUrl, getAppAvatarUrl } = require('@abtnode/util/lib/user');
 const { fromAppDid } = require('@arcblock/did-ext');
 const { getBlockletAppIdList } = require('@blocklet/meta/lib/util');
-const get = require('lodash/get');
 const uniq = require('lodash/uniq');
 const last = require('lodash/last');
 const pick = require('lodash/pick');
@@ -187,7 +186,7 @@ async function login(req, node, options) {
   const { dataDir } = await getApplicationInfo({ node, nodeInfo, teamDid });
   const [invitedUserOnly] = await isInvitedUserOnly(config, node, teamDid);
 
-  const lastLoginIp = get(req, 'headers[x-real-ip]') || '';
+  const lastLoginIp = req.get('x-real-ip') || '';
   let passport = { name: 'Guest', role: 'guest' };
   let currentUser = await federatedUtil.getUserWithinFederated(
     { sourceAppPid, teamDid, userDid, userPk },
@@ -275,6 +274,8 @@ async function login(req, node, options) {
   );
 
   const ua = req.get('user-agent');
+  const walletDeviceMessageToken = req.get('wallet-device-message-token');
+  const walletDeviceId = req.get('wallet-device-id');
   const userSessionDoc = await node.upsertUserSession({
     teamDid,
     userDid: currentUser.did,
@@ -286,6 +287,8 @@ async function login(req, node, options) {
     lastLoginIp,
     extra: {
       walletOS: 'web',
+      walletDeviceMessageToken,
+      walletDeviceId,
     },
   });
 
@@ -322,6 +325,8 @@ async function login(req, node, options) {
           lastLoginIp,
           extra: {
             walletOS: 'web',
+            walletDeviceMessageToken,
+            walletDeviceId,
           },
         });
       });
@@ -478,6 +483,8 @@ async function invite(req, node, options) {
   }
   const lastLoginIp = req.get('x-real-ip');
   const ua = req.get('user-agent');
+  const walletDeviceMessageToken = req.get('wallet-device-message-token');
+  const walletDeviceId = req.get('wallet-device-id');
   const userSessionDoc = await node.upsertUserSession({
     teamDid,
     userDid,
@@ -489,6 +496,8 @@ async function invite(req, node, options) {
     lastLoginIp,
     extra: {
       walletOS: 'web',
+      walletDeviceMessageToken,
+      walletDeviceId,
     },
   });
 
@@ -509,6 +518,8 @@ async function invite(req, node, options) {
           lastLoginIp,
           extra: {
             walletOS: 'web',
+            walletDeviceMessageToken,
+            walletDeviceId,
           },
         });
       });

package/api/routes/user-session.js

@@ -1,11 +1,11 @@
 /* eslint-disable no-await-in-loop */
 const { WELLKNOWN_SERVICE_PATH_PREFIX, SESSION_TTL } = require('@abtnode/constant');
 const { LOGIN_PROVIDER } = require('@blocklet/constant');
-const get = require('lodash/get');
 const pick = require('lodash/pick');
 const defaults = require('lodash/defaults');
 const cloneDeep = require('lodash/cloneDeep');
 const sortBy = require('lodash/sortBy');
+const omit = require('lodash/omit');
 const pLimit = require('p-limit');
 const { getSourceProvider } = require('@blocklet/meta/lib/did-utils');
 
@@ -132,7 +132,7 @@ module.exports = {
 
         const memberSite = federated.sites.find((item) => item.appPid === appPid);
         const postUser = pick(user, ['did', 'pk', 'fullName', 'locale']);
-        postUser.lastLoginAt = get(req, 'headers[x-real-ip]') || '';
+        postUser.lastLoginAt = req.get('x-real-ip') || '';
 
         if (user.email) {
           postUser.email = user.email;
@@ -196,6 +196,8 @@ module.exports = {
 
         const lastLoginIp = req.get('x-real-ip');
         const ua = req.get('user-agent');
+        const walletDeviceMessageToken = req.get('wallet-device-message-token');
+        const walletDeviceId = req.get('wallet-device-id');
 
         const userSessionDoc = await node.upsertUserSession({
           teamDid,
@@ -208,6 +210,8 @@ module.exports = {
           lastLoginIp,
           extra: {
             walletOS,
+            walletDeviceMessageToken,
+            walletDeviceId,
           },
         });
 
@@ -222,6 +226,8 @@ module.exports = {
             lastLoginIp,
             extra: {
               walletOS,
+              walletDeviceMessageToken,
+              walletDeviceId,
             },
           });
         }
@@ -270,11 +276,23 @@ module.exports = {
       });
 
       const pendingList = userSessions.map((item) =>
-        limit(() => patchUserSessionData(item, { blocklet, appPid, teamDid, node }))
+        limit(() =>
+          patchUserSessionData(item, {
+            blocklet,
+            appPid,
+            teamDid,
+            node,
+          })
+        )
       );
       await Promise.all(pendingList);
 
-      res.json(userSessions);
+      // NOTICE: 移除 walletDeviceId 和 walletDeviceMessageToken，避免泄露
+      const result = userSessions.map((x) => {
+        return omit(x, ['extra.walletDeviceId', 'extra.walletDeviceMessageToken']);
+      });
+
+      res.json(result);
     });
   },
 };

package/api/routes/user.js

@@ -303,6 +303,8 @@ async function login(req, node, options) {
   );
   const lastLoginIp = req.get('x-real-ip');
   const ua = req.get('user-agent');
+  const walletDeviceMessageToken = req.get('wallet-device-message-token');
+  const walletDeviceId = req.get('wallet-device-id');
   const userSession = await node.upsertUserSession({
     visitorId,
     teamDid,
@@ -313,6 +315,8 @@ async function login(req, node, options) {
     lastLoginIp,
     extra: {
       walletOS: 'api',
+      walletDeviceMessageToken,
+      walletDeviceId,
     },
   });
   node.syncUserSession({
@@ -325,6 +329,8 @@ async function login(req, node, options) {
     lastLoginIp,
     extra: {
       walletOS: 'api',
+      walletDeviceMessageToken,
+      walletDeviceId,
     },
   });
   return {
@@ -466,6 +472,8 @@ module.exports = {
         { ...sessionConfig, didConnectVersion: getDidConnectVersion(req) }
       );
       const ua = req.get('user-agent');
+      const walletDeviceMessageToken = req.get('wallet-device-message-token');
+      const walletDeviceId = req.get('wallet-device-id');
       const userSession = await node.upsertUserSession({
         visitorId,
         teamDid,
@@ -476,6 +484,8 @@ module.exports = {
         lastLoginIp,
         extra: {
           walletOS,
+          walletDeviceMessageToken,
+          walletDeviceId,
         },
       });
       node.syncUserSession({
@@ -488,6 +498,8 @@ module.exports = {
         lastLoginIp,
         extra: {
           walletOS,
+          walletDeviceMessageToken,
+          walletDeviceId,
         },
       });
 

package/api/services/auth/connect/invite.js

@@ -103,6 +103,8 @@ module.exports = function createRoutes(node, authenticator, createSessionToken)
 
       const lastLoginIp = req.get('x-real-ip');
       const ua = req.get('user-agent');
+      const walletDeviceMessageToken = req.get('wallet-device-message-token');
+      const walletDeviceId = req.get('wallet-device-id');
       const userSessionDoc = await node.upsertUserSession({
         teamDid,
         visitorId,
@@ -114,6 +116,8 @@ module.exports = function createRoutes(node, authenticator, createSessionToken)
         lastLoginIp,
         extra: {
           walletOS,
+          walletDeviceMessageToken,
+          walletDeviceId,
         },
       });
       node.syncUserSession({
@@ -126,6 +130,8 @@ module.exports = function createRoutes(node, authenticator, createSessionToken)
         lastLoginIp,
         extra: {
           walletOS,
+          walletDeviceMessageToken,
+          walletDeviceId,
         },
       });
       await updateSession(

package/api/services/auth/connect/issue-passport.js

@@ -46,6 +46,8 @@ module.exports = function createRoutes(node, authenticator, createSessionToken)
       const walletOS = req.context?.didwallet?.os;
       const lastLoginIp = req.get('x-real-ip');
       const ua = req.get('user-agent');
+      const walletDeviceMessageToken = req.get('wallet-device-message-token');
+      const walletDeviceId = req.get('wallet-device-id');
 
       const { response, passport, role } = await handleIssuePassportResponse({
         req,
@@ -89,6 +91,8 @@ module.exports = function createRoutes(node, authenticator, createSessionToken)
         lastLoginIp,
         extra: {
           walletOS,
+          walletDeviceMessageToken,
+          walletDeviceId,
         },
       });
       node.syncUserSession({
@@ -101,6 +105,8 @@ module.exports = function createRoutes(node, authenticator, createSessionToken)
         lastLoginIp,
         extra: {
           walletOS,
+          walletDeviceMessageToken,
+          walletDeviceId,
         },
       });
 

package/api/services/auth/session.js

@@ -54,7 +54,7 @@ module.exports = {
             user.avatar.split('/').slice(-1)[0]
           }`;
 
-          if (req.headers['x-avatar-host'] === '1') {
+          if (req.get('x-avatar-host') === '1') {
             const appUrl = blocklet.environmentObj.BLOCKLET_APP_URL;
             user.avatar = joinURL(appUrl, user.avatar);
           }
@@ -193,7 +193,7 @@ module.exports = {
                 user.avatar.split('/').slice(-1)[0]
               }`;
 
-              if (req.headers['x-avatar-host'] === '1') {
+              if (req.get('x-avatar-host') === '1') {
                 const appUrl = blocklet.environmentObj.BLOCKLET_APP_URL;
                 user.avatar = joinURL(appUrl, user.avatar);
               }
@@ -214,6 +214,8 @@ module.exports = {
             );
             const ua = req.get('user-agent');
             const lastLoginIp = req.get('x-real-ip');
+            const walletDeviceMessageToken = req.get('wallet-device-message-token');
+            const walletDeviceId = req.get('wallet-device-id');
             const userSession = await node.upsertUserSession({
               visitorId,
               teamDid,
@@ -224,6 +226,8 @@ module.exports = {
               lastLoginIp,
               extra: {
                 walletOS,
+                walletDeviceMessageToken,
+                walletDeviceId,
               },
             });
             if (user?.sourceAppPid) {
@@ -236,6 +240,8 @@ module.exports = {
                 lastLoginIp,
                 extra: {
                   walletOS,
+                  walletDeviceMessageToken,
+                  walletDeviceId,
                 },
               });
             }

package/api/services/notification/index.js

@@ -8,7 +8,7 @@ const { PREFIXES } = require('../../util/constants');
 const logger = require('../../libs/logger')('notification');
 const { sendToAppChannel } = require('../../socket/channel/app');
 const { sendToAppComponents } = require('../../socket/channel/component');
-const { sendToUserDid, sendToAppDid, sendToMail } = require('../../socket/channel/did');
+const { sendToUserDid, sendToAppDid, sendToMail, sendToPush } = require('../../socket/channel/did');
 const getHooksByChannel = require('../../socket/channel/hooks');
 const { getTokenInfo } = require('../../socket/util');
 
@@ -131,6 +131,17 @@ const init = ({ node }) => {
     }
   };
 
+  const onSendToPush = async (req, res) => {
+    try {
+      const results = await sendToPush({ ...req.body.data, node });
+      res.status(200).json(results);
+    } catch (error) {
+      logger.error('Send batch mail failed', { error });
+      res.statusMessage = error.message;
+      res.status(400).send(error.message);
+    }
+  };
+
   const onSendToAppChannel = async (req, res) => {
     try {
       await sendToAppChannel({ ...req.body.data, node, wsServer });
@@ -162,6 +173,15 @@ const init = ({ node }) => {
       exec: (data) => sendToMail({ ...data, node, wsServer }),
     },
 
+    sendToPush: {
+      attach: (app) => {
+        PREFIXES.forEach((prefix) => {
+          app.post(`${prefix}/api/send-to-push-kit`, onSendToPush);
+        });
+      },
+      exec: (data) => sendToMail({ ...data, node, wsServer }),
+    },
+
     sendToApp: {
       exec: ({ event, appDid, data }) => sendToAppDid({ event, appDid, data, node, wsServer }),
     },