Fix update report (#2411)

Fosol · web-flow · commit e33b05fee555 · 2025-02-25T09:05:30.000-08:00
Published tno-core:1.0.8
diff --git a/api/net/Areas/Services/Controllers/ReportInstanceController.cs b/api/net/Areas/Services/Controllers/ReportInstanceController.cs
@@ -218,6 +218,7 @@ public IActionResult UpdateUserReportInstanceStatus(long id, int userId, Entitie
         }
         else throw new BadRequestException("Parameter 'type' must be 'link' or 'text'.");
         _reportInstanceService.UpdateAndSave(userInstance);
+
         return new JsonResult(new UserReportInstanceModel(userInstance));
     }
 
@@ -232,11 +233,22 @@ public IActionResult UpdateUserReportInstanceStatus(long id, int userId, Entitie
     [ProducesResponseType(typeof(UserReportInstanceModel), (int)HttpStatusCode.OK)]
     [ProducesResponseType(typeof(ErrorResponseModel), (int)HttpStatusCode.BadRequest)]
     [SwaggerOperation(Tags = new[] { "Report" })]
-    public IActionResult UpdateReportInstanceStatus(long id, Entities.ReportStatus status)
+    public async Task<IActionResult> UpdateReportInstanceStatusAsync(long id, Entities.ReportStatus status)
     {
         var instance = _reportInstanceService.FindById(id) ?? throw new NoContentException();
         instance.Status = status;
         _reportInstanceService.UpdateAndSave(instance);
+
+        var ownerId = instance.OwnerId ?? instance.Report?.OwnerId;
+        if (ownerId.HasValue)
+        {
+            var user = _userService.FindById(ownerId.Value) ?? throw new NotAuthorizedException();
+            await _kafkaMessenger.SendMessageAsync(
+                _kafkaHubOptions.HubTopic,
+                new KafkaHubMessage(HubEvent.SendUser, user.Username, new KafkaInvocationMessage(MessageTarget.ReportStatus, new[] { new ReportMessageModel(instance) { Message = "status" } }))
+            );
+        }
+
         return new JsonResult(new ReportInstanceModel(instance, _serializerOptions));
     }
     #endregion
diff --git a/app/subscriber/.yarn/cache/tno-core-npm-1.0.8-6bb9908e3f-7316655502.zip b/app/subscriber/.yarn/cache/tno-core-npm-1.0.8-6bb9908e3f-7316655502.zip
diff --git a/app/subscriber/package.json b/app/subscriber/package.json
@@ -45,7 +45,7 @@
     "sheetjs": "file:packages/xlsx-0.20.1.tgz",
     "styled-components": "6.1.11",
     "stylis": "4.3.2",
-    "tno-core": "1.0.7"
+    "tno-core": "1.0.8"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "6.4.5",
diff --git a/app/subscriber/src/components/layout/DefaultLayout.tsx b/app/subscriber/src/components/layout/DefaultLayout.tsx
@@ -69,6 +69,8 @@ export const DefaultLayout: React.FC<ILayoutProps> = ({ children, ...rest }) =>
     // Report has been updated, go fetch latest.
     try {
       if (message.status === ReportStatusName.Accepted)
+        toast.info(`Report "${message.subject}" has been generated and email requested.`);
+      else if (message.status === ReportStatusName.Completed)
         toast.info(`Report "${message.subject}" has been sent out by email.`);
       else if (message.status === ReportStatusName.Failed)
         toast.error(`Report "${message.subject}" failed to be sent out by email.`);
diff --git a/app/subscriber/src/features/my-reports/MyReports.tsx b/app/subscriber/src/features/my-reports/MyReports.tsx
@@ -46,12 +46,21 @@ export const MyReports: React.FC = () => {
   hub.useHubEffect(MessageTargetKey.ReportStatus, async (message: IReportMessageModel) => {
     if (report) {
       try {
-        const instance = await getReportInstance(message.id, false);
-        if (instance) {
+        if (message.message === 'status') {
           setReport({
             ...report,
-            instances: report.instances.map((i) => (i.id === message.id ? instance : i)),
+            instances: report.instances.map((i) =>
+              i.id === message.id ? { ...i, status: message.status, version: message.version } : i,
+            ),
           });
+        } else {
+          const instance = await getReportInstance(message.id, false);
+          if (instance) {
+            setReport({
+              ...report,
+              instances: report.instances.map((i) => (i.id === message.id ? instance : i)),
+            });
+          }
         }
       } catch {}
     }
diff --git a/app/subscriber/src/features/my-reports/edit/ReportEditPage.tsx b/app/subscriber/src/features/my-reports/edit/ReportEditPage.tsx
@@ -161,17 +161,26 @@ export const ReportEditPage = () => {
     // TODO: This can blow away a users' changes.
     try {
       if (message.reportId === report.id) {
-        const instance = await getReportInstance(message.id, true);
-        if (instance) {
-          // If there is a new instance, prepend it.
-          const add = !report.instances.some((i) => i.id === message.id);
+        if (message.message === 'status') {
           setReport({
             ...report,
-            instances: add
-              ? [instance, ...report.instances]
-              : report.instances.map((i) => (i.id === message.id ? instance : i)),
+            instances: report.instances.map((i) =>
+              i.id === message.id ? { ...i, status: message.status, version: message.version } : i,
+            ),
           });
-          navigate(`/reports/${report.id}/content`);
+        } else {
+          const instance = await getReportInstance(message.id, true);
+          if (instance) {
+            // If there is a new instance, prepend it.
+            const add = !report.instances.some((i) => i.id === message.id);
+            setReport({
+              ...report,
+              instances: add
+                ? [instance, ...report.instances]
+                : report.instances.map((i) => (i.id === message.id ? instance : i)),
+            });
+            navigate(`/reports/${report.id}/content`);
+          }
         }
       }
     } catch {}
diff --git a/app/subscriber/src/store/hooks/subscriber/useReportSync.ts b/app/subscriber/src/store/hooks/subscriber/useReportSync.ts
@@ -21,29 +21,48 @@ export const useReportSync = () => {
 
         // Only fetch the latest if the current report instance is older, or doesn't exist.
         if (report && (!instance || instance.version !== message.version)) {
-          const response = await getReportInstance(message.id, true);
-          if (response.status === 200 && response.data) {
-            const instance = response.data;
+          if (message.message === 'status') {
+            // Update the status of the instance.
             storeMyReports((reports) => {
-              let addInstance = true;
-              let instances = report.instances.map((i) => {
-                if (i.id === message.id) {
-                  addInstance = false;
-                  return instance;
-                }
-                return i;
-              });
-              if (addInstance) instances = [instance, ...instances];
               const results = reports.map((r) =>
                 r.id === report.id
                   ? {
                       ...report,
-                      instances,
+                      instances: report.instances.map((i) =>
+                        i.id === message.id
+                          ? { ...i, status: message.status, version: message.version }
+                          : i,
+                      ),
                     }
                   : r,
               );
               return results;
             });
+          } else {
+            const response = await getReportInstance(message.id, true);
+            if (response.status === 200 && response.data) {
+              const instance = response.data;
+              storeMyReports((reports) => {
+                let addInstance = true;
+                let instances = report.instances.map((i) => {
+                  if (i.id === message.id) {
+                    addInstance = false;
+                    return instance;
+                  }
+                  return i;
+                });
+                if (addInstance) instances = [instance, ...instances];
+                const results = reports.map((r) =>
+                  r.id === report.id
+                    ? {
+                        ...report,
+                        instances,
+                      }
+                    : r,
+                );
+                return results;
+              });
+            }
           }
         }
       } catch {}
diff --git a/app/subscriber/yarn.lock b/app/subscriber/yarn.lock
@@ -10665,7 +10665,7 @@ __metadata:
     sheetjs: "file:packages/xlsx-0.20.1.tgz"
     styled-components: 6.1.11
     stylis: 4.3.2
-    tno-core: 1.0.7
+    tno-core: 1.0.8
     typescript: 4.9.5
   languageName: unknown
   linkType: soft
@@ -14698,9 +14698,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"tno-core@npm:1.0.7":
-  version: 1.0.7
-  resolution: "tno-core@npm:1.0.7"
+"tno-core@npm:1.0.8":
+  version: 1.0.8
+  resolution: "tno-core@npm:1.0.8"
   dependencies:
     "@elastic/elasticsearch": ^8.13.1
     "@fortawesome/free-solid-svg-icons": ^6.4.2
@@ -14733,7 +14733,7 @@ __metadata:
     styled-components: ^6.1.11
     stylis: ^4.3.2
     yup: ^1.1.1
-  checksum: 634b354d7b527f378052b6fc57a4cd97fc281f2ae0c3fefa663e6672eeae8c8dc7ddaa38822144d0e4d1ed84def6b4b8a6b2f078bf8c8e5c2fb7302bfdcf8e42
+  checksum: 7316655502311ed6e399073aa5f107d55975c3d65ec095f13e92a9bc7ce6f4733ba3f36f38bd91e2d6988bdb75339d5a86972f3c8c94c77e27a5a9b6472bc01a
   languageName: node
   linkType: hard
 
diff --git a/libs/net/models/Settings/ReportContentSettingsModel.cs b/libs/net/models/Settings/ReportContentSettingsModel.cs
@@ -12,9 +12,25 @@ public class ReportContentSettingsModel
     public IEnumerable<int> ExcludeReports { get; set; } = Array.Empty<int>();
     public bool ShowLinkToStory { get; set; }
     public bool HighlightKeywords { get; set; }
+
+    /// <summary>
+    /// get/set - Accumulate content on each run until sent.
+    /// </summary>
     public bool CopyPriorInstance { get; set; }
+
+    /// <summary>
+    /// get/set - Empty report when starting next report.
+    /// </summary>
     public bool ClearOnStartNewReport { get; set; }
+
+    /// <summary>
+    /// get/set - Exclude content in current unsent report.
+    /// </summary>
     public bool ExcludeContentInUnsentReport { get; set; }
+
+    /// <summary>
+    /// get/set - Whether to omit stories related to the BC Calendar.
+    /// </summary>
     public bool OmitBCUpdates { get; set; }
     #endregion
 
diff --git a/libs/net/models/SignalR/ReportMessageModel.cs b/libs/net/models/SignalR/ReportMessageModel.cs
@@ -32,6 +32,11 @@ public class ReportMessageModel : AuditColumnsModel
     /// get/set - Foreign key to the user owns this report.
     /// </summary>
     public int? OwnerId { get; set; }
+
+    /// <summary>
+    /// get/set - A message to identify what action was taken.
+    /// </summary>
+    public string? Message { get; set; }
     #endregion
 
     #region Constructors
diff --git a/libs/npm/core/package.json b/libs/npm/core/package.json
@@ -1,7 +1,7 @@
 {
   "name": "tno-core",
   "description": "TNO shared library",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "homepage": "https://github.com/bcgov/tno",
   "license": "Apache-2.0",
   "files": [
diff --git a/libs/npm/core/src/hooks/api/interfaces/IReportMessageModel.ts b/libs/npm/core/src/hooks/api/interfaces/IReportMessageModel.ts
@@ -7,4 +7,5 @@ export interface IReportMessageModel extends IAuditColumnsModel {
   status: ReportStatusName;
   ownerId?: number;
   owner?: IUserModel;
+  message?: string;
 }
diff --git a/services/net/ches-retry/ChesRetryManager.cs b/services/net/ches-retry/ChesRetryManager.cs
@@ -101,6 +101,7 @@ public override async Task RunAsync()
                                         // The message is possibly stuck, we need to ask CHES to promote.
                                         // Promoting doesn't change the status.
                                         // Which means it may get picked up again in the Accepted status until it gets sent.
+                                        this.Logger.LogDebug("Promote email request.  Report Instance ID: {reportId}, User Id: {userId}, Message Id: {messageId}", report.ReportInstanceId, report.UserId, messageId);
                                         await this.Ches.PromoteAsync(messageId);
                                     }
                                     catch (ChesException ex)
@@ -109,6 +110,7 @@ public override async Task RunAsync()
                                         {
                                             // The status changed between the first call and an attempt to promote.
                                             statusResponse = await this.Ches.GetStatusAsync(messageId);
+                                            this.Logger.LogWarning("Email status changed.  Report Instance ID: {reportId}, User Id: {userId}, Message Id: {messageId}, Status: {status}", report.ReportInstanceId, report.UserId, messageId, statusResponse.Status);
                                             status = Enum.Parse<Entities.ReportStatus>(statusResponse.Status);
                                         }
                                         else
@@ -121,6 +123,7 @@ public override async Task RunAsync()
 
                                 if (report.Status != status)
                                 {
+                                    this.Logger.LogInformation("Email status changed, update report.  Report Instance ID: {reportId}, User Id: {userId}, Message Id: {messageId}, status: {status}", report.ReportInstanceId, report.UserId, messageId, status);
                                     // Update the report with the latest status.
                                     if (report.ReportType == ReportType.Content)
                                     {
@@ -142,6 +145,7 @@ public override async Task RunAsync()
                         // If all user report instances have been updated then the report instance should be updated to.
                         if (group.All(r => r.Status == Entities.ReportStatus.Completed))
                         {
+                            this.Logger.LogInformation("Update report status to completed.  Report Instance ID: {reportId}", group.Key);
                             await this.Api.UpdateReportInstanceAsync(group.Key, Entities.ReportStatus.Completed);
                         }
                     }
