Update Papers and Reports #1206

Fosol · 2023-10-31T19:17:53Z

The Papers page now provides a way to preview the Front Page Images report and the Morning report. It also provides a way to manually initiate the request to publish (send out) the Front Page Images report, Morning Report and the Top Story Notifications.

Notifications has been enhanced to use an Elasticsearch query filter. Administrators are able to create two types of notifications, those that are run when content is indexed (Basic Alert), and those that are run manually. Those that are run manually use their filter to determine what content will be included. They also will not return content older than the last notification sent out.

Run the make renew command to update your local environment.

Summary

Add send notifications by filter
Add Top Story Notification
Publish tno-core:0.0.355
Add DB migration 1.0.83
Notification admin can now reuse notification templates
Notification admin can now test notifications and preview template changes
Fixed implementation issues discovered while making changes to API and hooks
Updated Editor app
Updated Subscriber app
Updated API
Updated Reporting Service
Updated Notification Service

Papers

Notification Admin

Addsend notifications by filter Add Top Story Notification Publish tno-core:0.0.355 Add DB migration 1.0.83

Fosol · 2023-10-31T19:18:35Z

api/net/Areas/Admin/Controllers/ChartTemplateController.cs

@@ -147,7 +147,7 @@ public async Task<IActionResult> PreviewJsonAsync(ChartPreviewRequestModel model
            Template = model.Template,
            SectionSettings = model.Settings
        };
-        var chartTemplate = new TemplateEngine.Models.Reports.ChartEngineContentModel("test", chart, model.Content?.Select(c => new TemplateEngine.Models.Reports.ContentModel(c)));
+        var chartTemplate = new TemplateEngine.Models.Reports.ChartEngineContentModel("test", chart, model.Content?.Select(c => new TemplateEngine.Models.ContentModel(c)));


Moved models to more generic location as they are used by more than one service.

Fosol · 2023-10-31T19:19:15Z

api/net/Areas/Admin/Controllers/NotificationController.cs

    {
-        return new JsonResult(_notificationService.FindAll().Select(ds => new NotificationModel(ds, _serializerOptions)));
+        var uri = new Uri(this.Request.GetDisplayUrl());
+        var query = Microsoft.AspNetCore.WebUtilities.QueryHelpers.ParseQuery(uri.Query);


We can search for notifications now.

Fosol · 2023-10-31T19:21:02Z

api/net/Areas/Editor/Controllers/AVOverviewController.cs

@@ -164,16 +164,16 @@ public IActionResult Delete(AVOverviewInstanceModel model)
    /// </summary>
    /// <param name="instanceId"></param>
    /// <returns></returns>
-    [HttpPost("{instanceId}/preview")]
+    [HttpPost("{instanceId}/view")]


View is a better way to describe an instance. Preview is before an instance is created.

Fosol · 2023-10-31T19:22:42Z

api/net/Areas/Services/Controllers/ReportController.cs

    [SwaggerOperation(Tags = new[] { "Report" })]
-    public async Task<IActionResult> FindContentForReportIdAsync(int id)
+    public async Task<IActionResult> FindContentForReportIdAsync(int id, int? requestorId)


Including the requestor allows other users to generate instances from a report they do not own.

Fosol · 2023-10-31T19:23:43Z

api/net/Areas/Subscriber/Controllers/AVOverviewController.cs

+[Route("[area]/reports/av/overviews")]
+[ProducesResponseType(typeof(ErrorResponseModel), (int)HttpStatusCode.Unauthorized)]
+[ProducesResponseType(typeof(ErrorResponseModel), (int)HttpStatusCode.Forbidden)]
+public class AVOverviewController : ControllerBase


@jdtoombs I thought the Evening Overview was visible on the Subscriber app? If it is, I don't know how it can be currently working correctly because there was no endpoints for it.

Fosol · 2023-10-31T19:23:56Z

api/net/Areas/Subscriber/Controllers/CacheController.cs

@@ -14,7 +14,7 @@ namespace TNO.API.Areas.Subscriber.Controllers;
 /// </summary>
 [ClientRoleAuthorize(ClientRole.Subscriber)]
 [ApiController]
-[Area("editor")]
+[Area("subscriber")]


Fosol · 2023-10-31T19:25:53Z

api/net/BackgroundWorkItem/BackgroundWorkerQueue.cs

 /// <summary>
 ///
 /// </summary>
 public class BackgroundTaskQueue : IBackgroundTaskQueue
 {
-    private ConcurrentQueue<Func<CancellationToken, Task>> _workItems = new ConcurrentQueue<Func<CancellationToken, Task>>();
-    private SemaphoreSlim _signal = new SemaphoreSlim(0);
+    private readonly ConcurrentQueue<Func<CancellationToken, Task>> _workItems = new();


@kylgarmor you should add a linter to your vscode. It will also catch many of the nullable issues.

Fosol · 2023-10-31T19:26:54Z

app/editor/src/features/admin/data-locations/DataLocationForm.tsx

@@ -45,7 +45,7 @@ const DataLocationForm: React.FC = () => {
  );

  const dataLocationId = Number(id);
-  const connectionOptions = getSortableOptions(connections, [
+  const connectionOptions = getSortableOptions(connections, dataLocation.connectionId, [


Had to do this to fix the bug where the currently selected value has been disabled and it wasn't been included in the list.

Fosol · 2023-10-31T19:28:22Z

app/editor/src/features/admin/notifications/constants/defaultNotification.ts

  isEnabled: false,
  isPublic: false,
  sortOrder: 0,
  subscribers: [],
  notificationType: NotificationTypeName.Email,
-  requireAlert: false,
+  alertOnIndex: false,


This replaces the logic of requireAlert. Now if a notification requires an alert it simply includes that as part of its filter.

Fosol · 2023-10-31T19:31:30Z

app/subscriber/src/store/hooks/subscriber/useAVOverviewInstances.ts

@jdtoombs Keep common hooks used to communicate with the API in consistent location.

Fosol · 2023-10-31T19:32:11Z

libs/net/dal/Configuration/NotificationConfiguration.cs

        builder.Property(m => m.Settings).IsRequired().HasColumnType("jsonb").HasDefaultValueSql("'{}'::jsonb");
-        builder.Property(m => m.Template).IsRequired().HasColumnType("text");
+        builder.Property(m => m.Query).IsRequired().HasColumnType("jsonb").HasDefaultValueSql("'{}'::jsonb");


Similar to structure to Filters

Fosol · 2023-10-31T19:32:37Z

libs/net/dal/Configuration/NotificationTemplateConfiguration.cs

+using Microsoft.EntityFrameworkCore.Metadata.Builders;
+using TNO.Entities;
+
+public class NotificationTemplateConfiguration : BaseTypeConfiguration<NotificationTemplate, int>


Extracted notification templates to be similar to report templates.

Fosol · 2023-10-31T19:34:28Z

libs/net/dal/Services/NotificationService.cs

@@ -75,12 +124,60 @@ public override Notification Update(Notification entity)
            }
        });

+
+        // Add/Update the report template.
+        if (entity.Template != null)


Notification updates will update the template. Same thing happens with reports. I don't love this solution, but it works for us currently.

Fosol · 2023-10-31T19:35:53Z

libs/net/dal/Services/NotificationService.cs

+    /// <param name="notification"></param>
+    /// <param name="requestorId"></param>
+    /// <returns></returns>
+    public async Task<Elastic.Models.SearchResultModel<API.Areas.Services.Models.Content.ContentModel>> FindContentWithElasticsearchAsync(Notification notification, int? requestorId)


The main issue I see with this implementation is that the first time the notification runs it will get a lot of content... I'll need to create a story to handle this.

Update Papers and Reports

90173d8

Addsend notifications by filter Add Top Story Notification Publish tno-core:0.0.355 Add DB migration 1.0.83

Fosol self-assigned this Oct 31, 2023

Fosol commented Oct 31, 2023

View reviewed changes

Fosol merged commit e5aa56b into bcgov:dev Oct 31, 2023
3 checks passed

Fosol deleted the papers branch October 31, 2023 20:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Papers and Reports #1206

Update Papers and Reports #1206

Fosol commented Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Fosol Oct 31, 2023

Update Papers and Reports #1206

Update Papers and Reports #1206

Conversation

Fosol commented Oct 31, 2023

Summary

Papers

Notification Admin

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment