From 533d7633e100ac9581395a421c1cd2b9285ee5b2 Mon Sep 17 00:00:00 2001
From: Nick Funk <nick.funk@outlook.com>
Date: Tue, 14 Jan 2020 15:26:33 -0700
Subject: [PATCH] [CORL-846] Restructure the slack comment message format
 (#2794)

* Restructure the slack comment message format

CORL-846

* feat: removed all comments

Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
---
 .../Configure/sections/Slack/SlackChannel.tsx | 138 +++++++-----------
 .../sections/Slack/SlackConfigContainer.tsx   |   3 -
 src/core/server/graph/schema/schema.graphql   |  10 --
 src/core/server/services/slack/publisher.ts   |  84 +++++------
 src/locales/en-US/admin.ftl                   |   1 -
 5 files changed, 90 insertions(+), 146 deletions(-)

diff --git a/src/core/client/admin/routes/Configure/sections/Slack/SlackChannel.tsx b/src/core/client/admin/routes/Configure/sections/Slack/SlackChannel.tsx
index 6773c9651..2842e163e 100644
--- a/src/core/client/admin/routes/Configure/sections/Slack/SlackChannel.tsx
+++ b/src/core/client/admin/routes/Configure/sections/Slack/SlackChannel.tsx
@@ -151,93 +151,63 @@ const SlackChannel: FunctionComponent<Props> = ({
                   <Label>Receive notifications in this Slack channel for</Label>
                 </Localized>
               </div>
-              <Field
-                name={`${channel}.triggers.allComments`}
-                subscription={{ value: true }}
-              >
-                {({ input: { value: allCommentsValue } }) => (
-                  <div className={styles.notificationToggles}>
-                    <Field
-                      name={`${channel}.triggers.allComments`}
-                      type="checkbox"
-                      parse={parseBool}
+
+              <div className={styles.notificationToggles}>
+                <Field
+                  name={`${channel}.triggers.reportedComments`}
+                  type="checkbox"
+                  parse={parseBool}
+                >
+                  {({ input }) => (
+                    <CheckBox
+                      id={`configure-slack-channel-triggers-reportedComments-${input.name}`}
+                      disabled={disabled || !channelEnabled}
+                      className={styles.trigger}
+                      {...input}
                     >
-                      {({ input }) => (
-                        <CheckBox
-                          id={`configure-slack-channel-triggers-allComments-${input.name}`}
-                          disabled={disabled || !channelEnabled}
-                          className={styles.trigger}
-                          {...input}
-                        >
-                          <Localized id="configure-slack-channel-triggers-allComments">
-                            All Comments
-                          </Localized>
-                        </CheckBox>
-                      )}
-                    </Field>
-                    <Field
-                      name={`${channel}.triggers.reportedComments`}
-                      type="checkbox"
-                      parse={parseBool}
+                      <Localized id="configure-slack-channel-triggers-reportedComments">
+                        Reported Comments
+                      </Localized>
+                    </CheckBox>
+                  )}
+                </Field>
+                <Field
+                  name={`${channel}.triggers.pendingComments`}
+                  type="checkbox"
+                  parse={parseBool}
+                >
+                  {({ input }) => (
+                    <CheckBox
+                      id={`configure-slack-channel-triggers-pendingComments-${input.name}`}
+                      disabled={disabled || !channelEnabled}
+                      className={styles.trigger}
+                      {...input}
                     >
-                      {({ input }) => (
-                        <CheckBox
-                          id={`configure-slack-channel-triggers-reportedComments-${input.name}`}
-                          disabled={
-                            disabled || allCommentsValue || !channelEnabled
-                          }
-                          className={styles.trigger}
-                          {...input}
-                        >
-                          <Localized id="configure-slack-channel-triggers-reportedComments">
-                            Reported Comments
-                          </Localized>
-                        </CheckBox>
-                      )}
-                    </Field>
-                    <Field
-                      name={`${channel}.triggers.pendingComments`}
-                      type="checkbox"
-                      parse={parseBool}
+                      <Localized id="configure-slack-channel-triggers-pendingComments">
+                        Pending Comments
+                      </Localized>
+                    </CheckBox>
+                  )}
+                </Field>
+                <Field
+                  name={`${channel}.triggers.featuredComments`}
+                  type="checkbox"
+                  parse={parseBool}
+                >
+                  {({ input }) => (
+                    <CheckBox
+                      id={`configure-slack-channel-triggers-featuredComments-${input.name}`}
+                      disabled={disabled || !channelEnabled}
+                      className={styles.trigger}
+                      {...input}
                     >
-                      {({ input }) => (
-                        <CheckBox
-                          id={`configure-slack-channel-triggers-pendingComments-${input.name}`}
-                          disabled={
-                            disabled || allCommentsValue || !channelEnabled
-                          }
-                          className={styles.trigger}
-                          {...input}
-                        >
-                          <Localized id="configure-slack-channel-triggers-pendingComments">
-                            Pending Comments
-                          </Localized>
-                        </CheckBox>
-                      )}
-                    </Field>
-                    <Field
-                      name={`${channel}.triggers.featuredComments`}
-                      type="checkbox"
-                      parse={parseBool}
-                    >
-                      {({ input }) => (
-                        <CheckBox
-                          id={`configure-slack-channel-triggers-featuredComments-${input.name}`}
-                          disabled={
-                            disabled || allCommentsValue || !channelEnabled
-                          }
-                          className={styles.trigger}
-                          {...input}
-                        >
-                          <Localized id="configure-slack-channel-triggers-featuredComments">
-                            Featured Comments
-                          </Localized>
-                        </CheckBox>
-                      )}
-                    </Field>
-                  </div>
-                )}
-              </Field>
+                      <Localized id="configure-slack-channel-triggers-featuredComments">
+                        Featured Comments
+                      </Localized>
+                    </CheckBox>
+                  )}
+                </Field>
+              </div>
             </FormField>
             <div>
               <Button
diff --git a/src/core/client/admin/routes/Configure/sections/Slack/SlackConfigContainer.tsx b/src/core/client/admin/routes/Configure/sections/Slack/SlackConfigContainer.tsx
index a0b5a8609..1a7e04686 100644
--- a/src/core/client/admin/routes/Configure/sections/Slack/SlackConfigContainer.tsx
+++ b/src/core/client/admin/routes/Configure/sections/Slack/SlackConfigContainer.tsx
@@ -41,7 +41,6 @@ const SlackConfigContainer: FunctionComponent<Props> = ({ form, settings }) => {
           name: "",
           hookURL: "",
           triggers: {
-            allComments: false,
             reportedComments: false,
             pendingComments: false,
             featuredComments: false,
@@ -57,7 +56,6 @@ const SlackConfigContainer: FunctionComponent<Props> = ({ form, settings }) => {
       enabled: true,
       hookURL: "",
       triggers: {
-        allComments: false,
         reportedComments: false,
         pendingComments: false,
         featuredComments: false,
@@ -143,7 +141,6 @@ const enhanced = withFragmentContainer<Props>({
           name
           hookURL
           triggers {
-            allComments
             reportedComments
             pendingComments
             featuredComments
diff --git a/src/core/server/graph/schema/schema.graphql b/src/core/server/graph/schema/schema.graphql
index 3e7acfcdf..38370477b 100644
--- a/src/core/server/graph/schema/schema.graphql
+++ b/src/core/server/graph/schema/schema.graphql
@@ -965,11 +965,6 @@ type SlackConfiguration {
 }
 
 type SlackChannelTriggers {
-  """
-  allComments is whether this channel will receive all comments entering moderation
-  """
-  allComments: Boolean!
-
   """
   reportedComments is whether this channel will receive reported comments
   """
@@ -3539,11 +3534,6 @@ input CommenterAccountFeaturesInput {
 }
 
 input SlackTriggersConfigurationInput {
-  """
-  allComments is whether this channel will receive all comments entering moderation
-  """
-  allComments: Boolean
-
   """
   reportedComments is whether this channel will receive reported comments
   """
diff --git a/src/core/server/services/slack/publisher.ts b/src/core/server/services/slack/publisher.ts
index c83bb8ecc..59fd6a724 100644
--- a/src/core/server/services/slack/publisher.ts
+++ b/src/core/server/services/slack/publisher.ts
@@ -31,35 +31,23 @@ type Payload =
   | CommentFeaturedInput
   | CommentReleasedInput;
 
-function enteredModeration(channel: SUBSCRIPTION_CHANNELS, payload: Payload) {
-  const p: any = payload;
-  return (
-    channel === SUBSCRIPTION_CHANNELS.COMMENT_ENTERED_MODERATION_QUEUE &&
-    p.hasOwnProperty("queue") &&
-    (p.queue === GQLMODERATION_QUEUE.REPORTED ||
-      p.queue === GQLMODERATION_QUEUE.PENDING)
-  );
-}
-
 function isFeatured(channel: SUBSCRIPTION_CHANNELS) {
   return channel === SUBSCRIPTION_CHANNELS.COMMENT_FEATURED;
 }
 
 function isReported(channel: SUBSCRIPTION_CHANNELS, payload: Payload) {
-  const p: any = payload;
   return (
     channel === SUBSCRIPTION_CHANNELS.COMMENT_ENTERED_MODERATION_QUEUE &&
-    p.hasOwnProperty("queue") &&
-    p.queue === GQLMODERATION_QUEUE.REPORTED
+    (payload as CommentEnteredModerationQueueInput).queue ===
+      GQLMODERATION_QUEUE.REPORTED
   );
 }
 
 function isPending(channel: SUBSCRIPTION_CHANNELS, payload: Payload) {
-  const p: any = payload;
   return (
     channel === SUBSCRIPTION_CHANNELS.COMMENT_ENTERED_MODERATION_QUEUE &&
-    p.hasOwnProperty("queue") &&
-    p.queue === GQLMODERATION_QUEUE.PENDING
+    (payload as CommentEnteredModerationQueueInput).queue ===
+      GQLMODERATION_QUEUE.PENDING
   );
 }
 
@@ -74,6 +62,7 @@ function createModerationLink(ctx: SlackContext, commentID: string) {
 
 async function postCommentToSlack(
   ctx: SlackContext,
+  message: string,
   commentID: string,
   hookURL: string
 ) {
@@ -100,29 +89,11 @@ async function postCommentToSlack(
   const body = commentBody.replace(/<br\/?>/g, "\n");
 
   const data = {
-    text: `${author.username} commented on: ${storyTitle}`,
-    blocks: [
+    text: `${message} on *<${story.url}|${storyTitle}>*`,
+    attachments: [
       {
-        type: "section",
-        text: {
-          type: "mrkdwn",
-          text: `${author.username} commented on:\n<${story.url}|${storyTitle}>`,
-        },
-      },
-      {
-        type: "section",
-        text: {
-          type: "mrkdwn",
-          text: `<${moderateLink}|Go to Moderation> | <${commentLink}|See Comment>`,
-        },
-      },
-      { type: "divider" },
-      {
-        type: "section",
-        text: {
-          type: "mrkdwn",
-          text: body,
-        },
+        text: body,
+        footer: `Authored by *${author.username}* | <${moderateLink}|Go to Moderation> | <${commentLink}|See Comment>`,
       },
     ],
   };
@@ -171,11 +142,16 @@ function createSlackPublisher(
     const ctx = new SlackContext({ mongo, config, tenant });
 
     try {
-      const inModeration = enteredModeration(channel, payload);
       const reported = isReported(channel, payload);
       const pending = isPending(channel, payload);
       const featured = isFeatured(channel);
 
+      // If the comment doesn't match any filter, then we don't need to send
+      // anything.
+      if (!reported && !pending && !featured) {
+        return;
+      }
+
       const { commentID } = payload;
 
       for (const ch of channels) {
@@ -194,17 +170,29 @@ function createSlackPublisher(
           return;
         }
 
-        if (
-          triggers.allComments &&
-          (reported || pending || featured || inModeration)
-        ) {
-          await postCommentToSlack(ctx, commentID, hookURL);
-        } else if (triggers.reportedComments && reported) {
-          await postCommentToSlack(ctx, commentID, hookURL);
+        // Add ticket to add back all comments option (including approved)
+
+        if (triggers.reportedComments && reported) {
+          await postCommentToSlack(
+            ctx,
+            "This comment has been reported",
+            commentID,
+            hookURL
+          );
         } else if (triggers.pendingComments && pending) {
-          await postCommentToSlack(ctx, commentID, hookURL);
+          await postCommentToSlack(
+            ctx,
+            "This comment is pending",
+            commentID,
+            hookURL
+          );
         } else if (triggers.featuredComments && featured) {
-          await postCommentToSlack(ctx, commentID, hookURL);
+          await postCommentToSlack(
+            ctx,
+            "This comment has been featured",
+            commentID,
+            hookURL
+          );
         }
       }
     } catch (err) {
diff --git a/src/locales/en-US/admin.ftl b/src/locales/en-US/admin.ftl
index 8c858f97c..a91e5fc09 100644
--- a/src/locales/en-US/admin.ftl
+++ b/src/locales/en-US/admin.ftl
@@ -423,7 +423,6 @@ configure-slack-channel-hookURL-description =
   follow the instructions <externalLink>here</externalLink>.
 configure-slack-channel-triggers-label =
   Receive notifications in this Slack channel for
-configure-slack-channel-triggers-allComments = All Comments
 configure-slack-channel-triggers-reportedComments = Reported Comments
 configure-slack-channel-triggers-pendingComments = Pending Comments
 configure-slack-channel-triggers-featuredComments = Featured Comments