Add API for user comment notification #1245 (#1246)

* Support Comment Notification #1245

* add space info #1245

* improve #1245

* split type #1245

* add title #1245

* add cid #1245

Author: wolyshaw

backend/packages/backend/package.json

@@ -16,6 +16,7 @@
     "@polkadot/util": "^13.0.2",
     "@polkadot/util-crypto": "^13.0.2",
     "bignumber.js": "^9.0.1",
+    "cheerio": "^1.1.2",
     "data-uri-to-buffer": "^4.0.1",
     "dotenv": "^10.0.0",
     "ethers": "5.8.0",

backend/packages/backend/src/constants/index.js

@@ -17,6 +17,9 @@ const NotificationType = Object.freeze({
   ProposalStarted: "proposalStarted",
   ProposalCloseToEnd: "proposalCloseToEnd",
   ProposalEnd: "proposalEnd",
+  CommentMentionUser: "commentMentionUser",
+  AppendantMentionUser: "appendantMentionUser",
+  VoteMentionUser: "voteMentionUser",
 });
 
 module.exports = {

backend/packages/backend/src/services/appendant.service.js

@@ -1,6 +1,8 @@
+const { NotificationType } = require("../constants");
 const { HttpError } = require("../exc");
 const { getProposalCollection, getAppendantCollection } = require("../mongo");
 const { isSameAddress } = require("../utils/address");
+const { createMentionNotification } = require("./notification");
 const { pinData } = require("./proposal.service/common");
 
 async function addAppendant(
@@ -44,6 +46,18 @@ async function addAppendant(
     createdAt: now,
   });
 
+  await createMentionNotification(
+    NotificationType.AppendantMentionUser,
+    content,
+    contentType,
+    {
+      space: proposal.space,
+      proposalCid,
+      title: proposal.title,
+      cid,
+    },
+  );
+
   return {
     cid,
   };

backend/packages/backend/src/services/notification/createMentionNotification.js

@@ -0,0 +1,29 @@
+const { getNotificationCollection } = require("../../mongo");
+const { extractMentionUsers } = require("../../utils/comment");
+const { logger } = require("../../utils/logger");
+
+async function createMentionNotification(type, content, contentType, data) {
+  try {
+    const { space, proposalCid, title, cid } = data;
+    const memberPublicKeys = await extractMentionUsers(content, contentType);
+
+    const createdAt = new Date().getTime();
+
+    const notificationCol = await getNotificationCollection();
+    await notificationCol.insertMany(
+      memberPublicKeys.map((memberPublicKey) => ({
+        owner: memberPublicKey,
+        type,
+        read: false,
+        data: { space, proposalCid, title, content, contentType, cid },
+        createdAt,
+      })),
+    );
+  } catch (error) {
+    logger.error(
+      `Failed to create notification for notificationType: ${type}, error: ${error.message}`,
+    );
+  }
+}
+
+module.exports = createMentionNotification;

backend/packages/backend/src/services/notification/index.js

@@ -1,10 +1,12 @@
 const createNotification = require("./createNotification");
+const createMentionNotification = require("./createMentionNotification");
 const getNotifications = require("./getNotifications");
 const clearUnreadNotifications = require("./clearUnreadNotifications");
 const getUnreadNotificationsCount = require("./getUnreadNotificationsCount");
 
 module.exports = {
   createNotification,
+  createMentionNotification,
   getNotifications,
   clearUnreadNotifications,
   getUnreadNotificationsCount,

backend/packages/backend/src/services/proposal.service/postComment.js

@@ -1,9 +1,10 @@
 const { safeHtml } = require("../../utils/post");
 const { getProposalCollection, getCommentCollection } = require("../../mongo");
 const { HttpError } = require("../../exc");
-const { ContentType } = require("../../constants");
+const { ContentType, NotificationType } = require("../../constants");
 const { pinData } = require("./common");
 const { SpaceType } = require("../../consts/space");
+const { createMentionNotification } = require("../notification");
 
 async function postComment(
   proposalCid,
@@ -68,6 +69,18 @@ async function postComment(
     },
   );
 
+  await createMentionNotification(
+    NotificationType.CommentMentionUser,
+    content,
+    contentType,
+    {
+      space: proposal.space,
+      proposalCid,
+      title: proposal.title,
+      cid,
+    },
+  );
+
   return newCommentId;
 }
 

backend/packages/backend/src/services/proposal.service/vote.js

@@ -23,6 +23,8 @@ const {
   hasOnePersonOneVoteStrategy,
 } = require("../../utils/strategy");
 const { isSameAddress, normalizeAddress } = require("../../utils/address");
+const { NotificationType } = require("../../constants");
+const { createMentionNotification } = require("../notification");
 
 async function getDelegatorBalances({ proposal, voter, voterNetwork }) {
   const snapshotHeight = proposal.snapshotHeights?.[voterNetwork];
@@ -391,6 +393,18 @@ async function saveVote({
       },
     },
   );
+
+  await createMentionNotification(
+    NotificationType.VoteMentionUser,
+    remark,
+    remarkType,
+    {
+      space: proposal.space,
+      proposalCid,
+      title: proposal.title,
+      cid,
+    },
+  );
 }
 
 async function handleBalanceVote({

backend/packages/backend/src/utils/comment.js

@@ -0,0 +1,82 @@
+const { isAddress, isEthereumAddress } = require("@polkadot/util-crypto");
+const { ContentType } = require("../constants");
+const cheerio = require("cheerio");
+const { toPublicKey } = require(".");
+
+function findDIDMentionsFromMarkdown(content) {
+  const mentions = [];
+  const reMention = /\[@[^\]]+\]\((\w+)-(\w+)\)/g;
+  let match;
+  while ((match = reMention.exec(content)) !== null) {
+    const [, address] = match;
+    if (!isAddress(address) && !isEthereumAddress(address)) {
+      continue;
+    }
+    mentions.push(address);
+  }
+
+  return mentions;
+}
+
+function findNonDIDMentionsFromMarkdown(content) {
+  const mentions = [];
+
+  const reMention = /\[@[^\]]+\]\(\/(member|user)\/([-\w]+)\)/g;
+  let match;
+  while ((match = reMention.exec(content)) !== null) {
+    const [, , usernameOrAddr] = match;
+    mentions.push(usernameOrAddr);
+  }
+
+  return mentions;
+}
+
+function extractMentions(content, contentType) {
+  const mentions = new Set();
+  if (contentType === ContentType.Markdown) {
+    const foundMentions = [
+      ...findDIDMentionsFromMarkdown(content),
+      ...findNonDIDMentionsFromMarkdown(content),
+    ];
+    for (const item of foundMentions) {
+      mentions.add(item);
+    }
+  }
+
+  if (contentType === ContentType.Html) {
+    const $ = cheerio.load(content);
+    $(".mention").each((i, el) => {
+      const at = $(el).attr("data-id");
+      if (at) {
+        mentions.add(at);
+      }
+    });
+  }
+
+  return mentions;
+}
+
+async function extractMentionUsers(content, contentType) {
+  const mentions = extractMentions(content, contentType);
+
+  const polkadotAddresses = [];
+  const ethereumAddresses = [];
+  for (const item of mentions) {
+    if (isEthereumAddress(item)) {
+      ethereumAddresses.push(item);
+      continue;
+    }
+    if (isAddress(item)) {
+      polkadotAddresses.push(item);
+      continue;
+    }
+  }
+
+  return [...polkadotAddresses, ...ethereumAddresses].map((item) =>
+    toPublicKey(item),
+  );
+}
+
+module.exports = {
+  extractMentionUsers,
+};