Merge pull request #4825 from coralproject/feat/ext-notifications-send-site-story

send the site and story info to external notifications

Author: tessalt

server/src/core/server/graph/context.ts

@@ -159,8 +159,7 @@ export default class GraphContext {
 
     this.externalNotifications = new ExternalNotificationsService(
       this.config,
-      this.logger,
-      this.mongo
+      this.logger
     );
 
     this.notifications = new InternalNotificationContext(

server/src/core/server/graph/mutators/Comments.ts

@@ -119,19 +119,12 @@ export const Comments = (ctx: GraphContext) => ({
     commentRevisionID,
   }: GQLCreateCommentReactionInput) =>
     createReaction(
-      ctx.mongo,
-      ctx.redis,
-      ctx.config,
-      ctx.i18n,
-      ctx.cache,
-      ctx.broker,
-      ctx.tenant,
+      ctx,
       ctx.user!,
       {
         commentID,
         commentRevisionID,
       },
-      ctx.externalNotifications,
       ctx.now
     ),
   removeReaction: ({

server/src/core/server/index.ts

@@ -262,8 +262,7 @@ class Server {
 
     const externalNotifications = new ExternalNotificationsService(
       this.config,
-      logger,
-      this.mongo
+      logger
     );
 
     // Create the Job Queue.

server/src/core/server/services/comments/actions.ts

@@ -25,7 +25,6 @@ import {
 import { getLatestRevision } from "coral-server/models/comment/helpers";
 import { retrieveSite } from "coral-server/models/site";
 import { Tenant } from "coral-server/models/tenant";
-import { retrieveUser, User } from "coral-server/models/user";
 import { isSiteBanned } from "coral-server/models/user/helpers";
 import { AugmentedRedis } from "coral-server/services/redis";
 import {
@@ -36,12 +35,13 @@ import { Request } from "coral-server/types/express";
 
 import { GQLCOMMENT_FLAG_REPORTED_REASON } from "coral-server/graph/schema/__generated__/types";
 
+import GraphContext from "coral-server/graph/context";
+import { User } from "coral-server/models/user";
 import {
   publishCommentFlagCreated,
   publishCommentReactionCreated,
 } from "../events";
 import { I18n } from "../i18n";
-import { ExternalNotificationsService } from "../notifications/externalService";
 import { submitCommentAsSpam } from "../spam";
 
 export type CreateAction = CreateActionInput;
@@ -312,18 +312,22 @@ export type CreateCommentReaction = Pick<
 >;
 
 export async function createReaction(
-  mongo: MongoContext,
-  redis: AugmentedRedis,
-  config: Config,
-  i18n: I18n,
-  cache: DataCache,
-  broker: CoralEventPublisherBroker,
-  tenant: Tenant,
+  context: GraphContext,
   author: User,
   input: CreateCommentReaction,
-  externalNotifications: ExternalNotificationsService,
   now = new Date()
 ) {
+  const {
+    mongo,
+    redis,
+    i18n,
+    cache,
+    config,
+    broker,
+    tenant,
+    externalNotifications,
+  } = context;
+
   const { comment, action } = await addCommentAction(
     mongo,
     redis,
@@ -359,14 +363,25 @@ export async function createReaction(
     if (externalNotifications.active()) {
       const reccingUser = author;
       const reccedUser = comment.authorID
-        ? await retrieveUser(mongo, comment.tenantID, comment.authorID)
+        ? await context.loaders.Users.user.load(comment.authorID)
         : null;
 
-      if (reccedUser) {
+      const story = await context.loaders.Stories.find.load({
+        id: comment.storyID,
+      });
+
+      const site =
+        story && story.siteID
+          ? await context.loaders.Sites.site.load(story.siteID)
+          : null;
+
+      if (reccedUser && story && site) {
         await externalNotifications.createRec({
           from: reccingUser,
           to: reccedUser,
           comment,
+          story,
+          site,
         });
       }
     }

server/src/core/server/services/notifications/externalService.ts

@@ -1,8 +1,8 @@
 import Logger from "bunyan";
 import { Config } from "coral-server/config";
-import { MongoContext } from "coral-server/data/context";
 import { Comment, getLatestRevision } from "coral-server/models/comment";
-import { getURLWithCommentID, retrieveStory } from "coral-server/models/story";
+import { Site } from "coral-server/models/site";
+import { getURLWithCommentID, Story } from "coral-server/models/story";
 import { User } from "coral-server/models/user";
 import { convert } from "html-to-text";
 import fetch from "node-fetch";
@@ -12,16 +12,22 @@ const ProfileType = "Coral";
 
 // From Coral input types
 
-interface CreateReplyInput {
+interface CreateReplyParams {
   from: User;
   to: User;
+
+  story: Readonly<Story>;
+  site: Readonly<Site>;
   parent: Comment;
   reply: Comment;
 }
 
-interface CreateRecInput {
+interface CreateRecParams {
   from: User;
   to: User;
+
+  story: Readonly<Story>;
+  site: Readonly<Site>;
   comment: Comment;
 }
 
@@ -33,6 +39,17 @@ enum NotificationType {
   CoralReply = "CoralReply",
 }
 
+interface StoryInput {
+  id: string;
+  title: string;
+  url: string;
+}
+
+interface SiteInput {
+  id: string;
+  name: string;
+}
+
 interface ExternalUserProfile {
   id: string;
   type: string;
@@ -43,7 +60,7 @@ interface ExternalUserProfile {
   ssoIds?: string[];
 }
 
-interface CommentPayload {
+interface CommentInput {
   id: string;
   storyId: string;
   snippet?: string | null;
@@ -64,11 +81,9 @@ export class ExternalNotificationsService {
   private url?: string | null;
   private apiKey?: string | null;
   private logger: Logger;
-  private mongo: MongoContext;
 
-  constructor(config: Config, logger: Logger, mongo: MongoContext) {
+  constructor(config: Config, logger: Logger) {
     this.logger = logger;
-    this.mongo = mongo;
 
     this.url = config.get("external_notifications_api_url");
     this.apiKey = config.get("external_notifications_api_key");
@@ -101,13 +116,11 @@ export class ExternalNotificationsService {
     }
   }
 
-  private async commentToPayload(comment: Comment): Promise<CommentPayload> {
-    const story = await retrieveStory(
-      this.mongo,
-      comment.tenantID,
-      comment.storyID
-    );
-    const url = story ? getURLWithCommentID(story.url, comment.id) : null;
+  private async commentToInput(
+    comment: Comment,
+    story: Story
+  ): Promise<CommentInput> {
+    const url = getURLWithCommentID(story.url, comment.id);
 
     return {
       id: comment.id,
@@ -117,7 +130,22 @@ export class ExternalNotificationsService {
     };
   }
 
-  public async createRec(input: CreateRecInput) {
+  private storyToInput(story: Story): StoryInput {
+    return {
+      id: story.id,
+      title: story.metadata?.title ?? "",
+      url: story.url,
+    };
+  }
+
+  private siteToInput(site: Site): SiteInput {
+    return {
+      id: site.id,
+      name: site.name,
+    };
+  }
+
+  public async createRec(input: CreateRecParams) {
     if (!this.active()) {
       return;
     }
@@ -128,8 +156,9 @@ export class ExternalNotificationsService {
         type: NotificationType.CoralRec,
         from: this.userToExternalProfile(input.from),
         to: this.userToExternalProfile(input.to),
-        storyId: input.comment.storyID,
-        comment: this.commentToPayload(input.comment),
+        story: this.storyToInput(input.story),
+        site: this.siteToInput(input.site),
+        comment: this.commentToInput(input.comment, input.story),
       };
 
       return await this.send(data);
@@ -143,7 +172,7 @@ export class ExternalNotificationsService {
     return false;
   }
 
-  public async createReply(input: CreateReplyInput) {
+  public async createReply(input: CreateReplyParams) {
     if (!this.active()) {
       return;
     }
@@ -154,9 +183,10 @@ export class ExternalNotificationsService {
         type: NotificationType.CoralReply,
         from: this.userToExternalProfile(input.from),
         to: this.userToExternalProfile(input.to),
-        storyId: input.parent.storyID,
-        comment: await this.commentToPayload(input.parent),
-        reply: await this.commentToPayload(input.reply),
+        story: this.storyToInput(input.story),
+        site: this.siteToInput(input.site),
+        comment: await this.commentToInput(input.parent, input.story),
+        reply: await this.commentToInput(input.reply, input.story),
       };
 
       return await this.send(data);

server/src/core/server/stacks/createComment.ts

@@ -454,12 +454,16 @@ export default async function create(
           ? await retrieveUser(mongo, parent.tenantID, parent.authorID)
           : null;
 
-        if (repliedToUser) {
+        const site = await retrieveSite(mongo, tenant.id, story.siteID!);
+
+        if (repliedToUser && site) {
           await externalNotifications.createReply({
             from: replyingUser,
             to: repliedToUser,
             parent,
             reply: comment,
+            story,
+            site,
           });
         }
       }