MMI-2997 Turn off sentiment in Alerts (#2402)

- updated UI user settings vacation mode styles
- added UI user settings Report Sentiment
- updated notifications to enable/disable the report sentiment
- added db migration to update basic alert template

Author: laidaoyu

api/net/Areas/Helpers/INotificationHelper.cs

@@ -25,12 +25,14 @@ public interface INotificationHelper
     /// </summary>
     /// <param name="model"></param>
     /// <param name="isPreview"></param>
+    /// <param name="enableReportSentiment"></param>
     /// <returns></returns>
     /// <exception cref="ArgumentException"></exception>
     /// <exception cref="InvalidOperationException"></exception>
     Task<NotificationResultModel> GenerateNotificationAsync(
         Areas.Services.Models.NotificationInstance.NotificationInstanceModel model,
-        bool isPreview = false);
+        bool isPreview = false,
+        bool enableReportSentiment = false);
 
     /// <summary>
     /// Execute the notification template to generate the subject and body.
@@ -54,10 +56,12 @@ Task<IEnumerable<NotificationResultModel>> GenerateNotificationsAsync(
     /// <param name="notification"></param>
     /// <param name="content"></param>
     /// <param name="isPreview"></param>
+    /// <param name="enableReportSentiment"></param>
     /// <returns></returns>
     /// <exception cref="InvalidOperationException"></exception>
     Task<NotificationResultModel> GenerateNotificationAsync(
         Areas.Services.Models.Notification.NotificationModel notification,
         ContentModel content,
-        bool isPreview = false);
+        bool isPreview = false,
+        bool enableReportSentiment = false);
 }

api/net/Areas/Helpers/NotificationHelper.cs

@@ -83,12 +83,14 @@ public NotificationHelper(
     /// </summary>
     /// <param name="model"></param>
     /// <param name="isPreview"></param>
+    /// <param name="enableReportSentiment"></param>
     /// <returns></returns>
     /// <exception cref="ArgumentException"></exception>
     /// <exception cref="InvalidOperationException"></exception>
     public async Task<NotificationResultModel> GenerateNotificationAsync(
         Areas.Services.Models.NotificationInstance.NotificationInstanceModel model,
-        bool isPreview = false)
+        bool isPreview = false,
+        bool enableReportSentiment = false)
     {
         var notification = _notificationService.FindById(model.NotificationId) ?? throw new ArgumentException("Parameter 'model.NotificationId' did not return a notification.");
         if (notification.Template == null) throw new InvalidOperationException("Parameter 'Notification.Template' is required");
@@ -138,14 +140,16 @@ public async Task<IEnumerable<NotificationResultModel>> GenerateNotificationsAsy
     /// <param name="notification"></param>
     /// <param name="content"></param>
     /// <param name="isPreview"></param>
+    /// <param name="enableReportSentiment"></param>
     /// <returns></returns>
     /// <exception cref="InvalidOperationException"></exception>
     public async Task<NotificationResultModel> GenerateNotificationAsync(
         Areas.Services.Models.Notification.NotificationModel notification,
         ContentModel content,
-        bool isPreview = false)
+        bool isPreview = false,
+        bool enableReportSentiment = false)
     {
-        var subject = await _notificationEngine.GenerateNotificationSubjectAsync(notification, content, isPreview);
+        var subject = await _notificationEngine.GenerateNotificationSubjectAsync(notification, content, isPreview, enableReportSentiment);
         var body = await _notificationEngine.GenerateNotificationBodyAsync(notification, content, _storageOptions.GetUploadPath(), isPreview);
 
         return new NotificationResultModel(subject, body);

app/subscriber/src/features/settings/MyAccountSettings.tsx

@@ -1,5 +1,5 @@
 import React from 'react';
-import { FaEnvelope, FaToggleOff, FaToggleOn, FaUmbrellaBeach } from 'react-icons/fa';
+import { FaEnvelope, FaSmile, FaToggleOff, FaToggleOn } from 'react-icons/fa';
 import { toast } from 'react-toastify';
 import { useUsers } from 'store/hooks';
 import { useProfileStore } from 'store/slices';
@@ -13,6 +13,9 @@ const MyAccountSettings = () => {
   const isVacationMode: boolean = !!impersonate
     ? impersonate?.preferences?.isVacationMode ?? false
     : profile?.preferences?.isVacationMode ?? false;
+  const enableReportSentiment: boolean = !!impersonate
+    ? impersonate?.preferences?.enableReportSentiment ?? false
+    : profile?.preferences?.enableReportSentiment ?? false;
 
   const toggleVacationMode = React.useCallback(
     async (
@@ -48,6 +51,40 @@ const MyAccountSettings = () => {
     [updateUser],
   );
 
+  const toggleReportSentiment = React.useCallback(
+    async (
+      profile: ISubscriberUserModel | undefined,
+      impersonate: ISubscriberUserModel | undefined,
+      enableReportSentiment: boolean,
+    ) => {
+      if (!profile) {
+        toast.error('User information is missing. Please try again later');
+        return;
+      }
+      const baseProfile = impersonate ?? profile;
+      const createUser = (): ISubscriberUserModel => {
+        // use impersonate if it exists, otherwise use profile
+        return {
+          ...baseProfile,
+          preferences: {
+            ...baseProfile.preferences,
+            enableReportSentiment: enableReportSentiment,
+          },
+        };
+      };
+      const user = createUser();
+
+      try {
+        await updateUser(user, !!impersonate);
+        toast.success('Report sentiment has successfully been updated.');
+      } catch (error) {
+        // Handle the error, if needed
+        console.error('Failed to update user:', error);
+      }
+    },
+    [updateUser],
+  );
+
   return (
     <styled.MyAccountSettings>
       <div className="header-row">
@@ -59,22 +96,37 @@ const MyAccountSettings = () => {
         disable vacation mode. This will include subscriptions to MMI Products, Alerts and Reports.
       </p>
       <div className="toggleContainer">
+        <span className="vacation-mode-label">Vacation Mode</span>
         <ToggleButton
           on={<FaToggleOn />}
           off={<FaToggleOff />}
           onClick={() => toggleVacationMode(profile, impersonate, !isVacationMode)}
           width="25px"
           height="25px"
-          color="#008000"
-          label={
-            <span className="vacation-mode-label">
-              <FaUmbrellaBeach className="icon" />
-              Vacation Mode
-            </span>
-          }
+          label=""
           value={isVacationMode}
         />
       </div>
+      <div className="header-row">
+        <FaSmile className="icon" />
+        <span className="header-text">Report sentiment</span>
+      </div>
+      <p className="description">
+        Enables display of sentiment in the reports you receive. Sentiment reflects the tone of
+        media articles towards government and appears in reports and alerts as emoticons.
+      </p>
+      <div className="toggleContainer">
+        <span className="vacation-mode-label">Report sentiment</span>
+        <ToggleButton
+          on={<FaToggleOn />}
+          off={<FaToggleOff />}
+          onClick={() => toggleReportSentiment(profile, impersonate, !enableReportSentiment)}
+          width="25px"
+          height="25px"
+          label=""
+          value={enableReportSentiment}
+        />
+      </div>
     </styled.MyAccountSettings>
   );
 };

app/subscriber/src/features/settings/styled/MyAccountSettings.tsx

@@ -32,16 +32,12 @@ export const MyAccountSettings = styled(Col)`
   .toggleContainer {
     display: flex;
     align-items: center;
-    margin-left: 3rem;
+    margin-left: 2.8rem;
 
     .vacation-mode-label {
-      color: #008000;
       display: flex;
-      align-items: center;
-    }
-
-    .icon {
-      margin-right: 5px;
+      align-items: left;
+      margin-right: 1rem;
     }
   }
 `;

libs/net/dal/Migrations/1.3.18/Down/PostDown/00-UpdateBasicAlertTemplate.sql

@@ -0,0 +1,35 @@
+DO $$
+BEGIN
+
+-- Update custom chart with latest template.
+UPDATE public."notification_template" SET
+    "subject" = '@inherits RazorEngineCore.RazorEngineTemplateBase<TNO.Services.Notification.Models.TemplateModel>
+@using System.Linq
+@{
+  var isAV = @Content.ContentType == TNO.Entities.ContentType.AudioVideo;
+  var isTranscriptAvailable = isAV && !string.IsNullOrWhiteSpace(@Content.Body) && @Content.IsApproved;
+  var sourceCode = !string.IsNullOrEmpty(@Content.Source?.Code) ? @Content.Source.Code : @Content.OtherSource;
+  var body = isTranscriptAvailable ? @Content.Body : (isAV ? @Content.Summary : @Content.Body);
+  var transcriptIcon = isTranscriptAvailable ? "▶️📄" : (isAV ? "▶️" : "");
+  var toneIcon = "";
+  switch (@Content.TonePools.FirstOrDefault()?.Value)
+  {
+    case 0:
+      toneIcon = "😐 ";
+      break;
+    case -3:
+    case -4:
+    case -5:
+      toneIcon = "☹️ ";
+      break;
+    case 3:
+    case 4:
+    case 5:
+      toneIcon = "🙂 ";
+      break;
+  }
+}@toneIcon@sourceCode: @Content.Headline @transcriptIcon'
+WHERE "id" = cast((SELECT value FROM setting
+	WHERE name = 'BasicAlertTemplateId') as integer);
+
+END $$;

libs/net/dal/Migrations/1.3.18/Up/PostUp/00-UpdateBasicAlertTemplate.sql

@@ -0,0 +1,38 @@
+DO $$
+BEGIN
+
+-- Update custom chart with latest template.
+UPDATE public."notification_template" SET
+    "subject" = '@inherits RazorEngineCore.RazorEngineTemplateBase<TNO.Services.Notification.Models.TemplateModel>
+@using System.Linq
+@{
+  var isAV = @Content.ContentType == TNO.Entities.ContentType.AudioVideo;
+  var isTranscriptAvailable = isAV && !string.IsNullOrWhiteSpace(@Content.Body) && @Content.IsApproved;
+  var sourceCode = !string.IsNullOrEmpty(@Content.Source?.Code) ? @Content.Source.Code : @Content.OtherSource;
+  var body = isTranscriptAvailable ? @Content.Body : (isAV ? @Content.Summary : @Content.Body);
+  var transcriptIcon = isTranscriptAvailable ? "▶️📄" : (isAV ? "▶️" : "");
+  var toneIcon = "";
+  if (@EnableReportSentiment)
+  {
+    switch (@Content.TonePools.FirstOrDefault()?.Value)
+    {
+      case 0:
+        toneIcon = "😐 ";
+        break;
+      case -3:
+      case -4:
+      case -5:
+        toneIcon = "☹️ ";
+        break;
+      case 3:
+      case 4:
+      case 5:
+        toneIcon = "🙂 ";
+        break;
+    }
+  }
+}@toneIcon@sourceCode: @Content.Headline @transcriptIcon'
+WHERE "id" = cast((SELECT value FROM setting
+	WHERE name = 'BasicAlertTemplateId') as integer);
+
+END $$;