MMI-3269 Override report from address

Fosol · Fosol · commit 9f9cf5e05a10 · 2025-06-25T14:53:37.000-07:00
Update DevOps
Publish tno-core:1.0.17
diff --git a/app/editor/.yarn/cache/tno-core-npm-1.0.17-238c76d901-997c603c0d.zip b/app/editor/.yarn/cache/tno-core-npm-1.0.17-238c76d901-997c603c0d.zip
diff --git a/app/editor/package.json b/app/editor/package.json
@@ -60,7 +60,7 @@
     "redux-logger": "3.0.6",
     "styled-components": "6.1.11",
     "stylis": "4.3.2",
-    "tno-core": "1.0.15"
+    "tno-core": "1.0.17"
   },
   "devDependencies": {
     "@simbathesailor/use-what-changed": "2.0.0",
diff --git a/app/editor/src/features/admin/reports/ReportFormSections.tsx b/app/editor/src/features/admin/reports/ReportFormSections.tsx
@@ -123,21 +123,19 @@ export const ReportFormSections = () => {
       <Row gap="1rem">
         <Col className="frm-in options" flex="1">
           <div>
-            <label>Subject Line Options</label>
+            <label>Email Options</label>
           </div>
-          <Col>
-            <p>Customize the email subject line.</p>
-            <Row alignItems="center">
-              <Col flex="1">
-                <FormikText label="Text" name="settings.subject.text" required />
-              </Col>
-              <FormikCheckbox
-                label="Show Today's Date"
-                name="settings.subject.showTodaysDate"
-                tooltip="Whether today's date will be included in the report subject line"
-              />
-            </Row>
-          </Col>
+          <FormikText label="From" name="settings.from" />
+          <Row alignItems="center">
+            <Col flex="1">
+              <FormikText label="Subject" name="settings.subject.text" required />
+            </Col>
+            <FormikCheckbox
+              label="Show Today's Date"
+              name="settings.subject.showTodaysDate"
+              tooltip="Whether today's date will be included in the report subject line"
+            />
+          </Row>
         </Col>
         <ReportOptions />
       </Row>
diff --git a/app/editor/yarn.lock b/app/editor/yarn.lock
@@ -12209,7 +12209,7 @@ __metadata:
     sass-extract-loader: 1.1.0
     styled-components: 6.1.11
     stylis: 4.3.2
-    tno-core: 1.0.15
+    tno-core: 1.0.17
     typescript: 4.9.5
     vitest: 3.0.7
   languageName: unknown
@@ -16674,9 +16674,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"tno-core@npm:1.0.15":
-  version: 1.0.15
-  resolution: "tno-core@npm:1.0.15"
+"tno-core@npm:1.0.17":
+  version: 1.0.17
+  resolution: "tno-core@npm:1.0.17"
   dependencies:
     "@elastic/elasticsearch": ^8.13.1
     "@fortawesome/free-solid-svg-icons": ^6.4.2
@@ -16709,7 +16709,7 @@ __metadata:
     styled-components: ^6.1.11
     stylis: ^4.3.2
     yup: ^1.1.1
-  checksum: 6afb49b193fdd9553e3c625846af61fa20f7ef8475dad175ce841652159416fff2802881e069595084c2f6d81ace0bc31a64de8ce980637047c2973927baaa99
+  checksum: 997c603c0df481a9ba0128058c8b3cedfede511248c5b93f6fcd341b9756f5cd4d4480d4e924b04222299cfe8f44a681d6983f9485e7a7446c11bca0630ee1bf
   languageName: node
   linkType: hard
 
diff --git a/app/subscriber/.yarn/cache/tno-core-npm-1.0.17-238c76d901-997c603c0d.zip b/app/subscriber/.yarn/cache/tno-core-npm-1.0.17-238c76d901-997c603c0d.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.15"
+    "tno-core": "1.0.17"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "6.6.3",
diff --git a/app/subscriber/yarn.lock b/app/subscriber/yarn.lock
@@ -12029,7 +12029,7 @@ __metadata:
     sheetjs: "file:packages/xlsx-0.20.1.tgz"
     styled-components: 6.1.11
     stylis: 4.3.2
-    tno-core: 1.0.15
+    tno-core: 1.0.17
     typescript: 4.9.5
     vitest: 3.0.7
   languageName: unknown
@@ -16367,9 +16367,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"tno-core@npm:1.0.15":
-  version: 1.0.15
-  resolution: "tno-core@npm:1.0.15"
+"tno-core@npm:1.0.17":
+  version: 1.0.17
+  resolution: "tno-core@npm:1.0.17"
   dependencies:
     "@elastic/elasticsearch": ^8.13.1
     "@fortawesome/free-solid-svg-icons": ^6.4.2
@@ -16402,7 +16402,7 @@ __metadata:
     styled-components: ^6.1.11
     stylis: ^4.3.2
     yup: ^1.1.1
-  checksum: 6afb49b193fdd9553e3c625846af61fa20f7ef8475dad175ce841652159416fff2802881e069595084c2f6d81ace0bc31a64de8ce980637047c2973927baaa99
+  checksum: 997c603c0df481a9ba0128058c8b3cedfede511248c5b93f6fcd341b9756f5cd4d4480d4e924b04222299cfe8f44a681d6983f9485e7a7446c11bca0630ee1bf
   languageName: node
   linkType: hard
 
diff --git a/libs/net/ches/ChesService.cs b/libs/net/ches/ChesService.cs
@@ -228,7 +228,7 @@ public async Task<EmailResponseModel> SendEmailAsync(IEmail email)
         {
             ArgumentNullException.ThrowIfNull(email);
 
-            email.From = this.Options.From ?? email.From;
+            email.From = !String.IsNullOrWhiteSpace(this.Options.From) ? this.Options.From : email.From;
 
             if (this.Options.BccUser)
             {
diff --git a/libs/net/kafka/Models/ReportRequestModel.cs b/libs/net/kafka/Models/ReportRequestModel.cs
@@ -51,6 +51,11 @@ public class ReportRequestModel
     /// </summary>
     public int? AssignedId { get; set; }
 
+    /// <summary>
+    /// get/set - Email Address that this report will be sent from.
+    /// </summary>
+    public string? From { get; set; }
+
     /// <summary>
     /// get/set - Comma separated email addresses that this report will be sent to instead of subscribers.
     /// </summary>
diff --git a/libs/net/models/Settings/ReportSettingsModel.cs b/libs/net/models/Settings/ReportSettingsModel.cs
@@ -6,6 +6,11 @@ namespace TNO.API.Models.Settings;
 public class ReportSettingsModel
 {
     #region Properties
+    /// <summary>
+    /// get/set - The email from address.
+    /// </summary>
+    public string From { get; set; } = "";
+
     /// <summary>
     /// get/set - Subject configuration settings.
     /// </summary>
@@ -42,6 +47,7 @@ public ReportSettingsModel() { }
 
     public ReportSettingsModel(Dictionary<string, object> settings, JsonSerializerOptions options)
     {
+        this.From = settings.GetDictionaryJsonValue<string>("from", "", options)!;
         this.Subject = settings.GetDictionaryJsonValue<ReportSubjectSettingsModel>("subject", new(), options)!;
         this.Headline = settings.GetDictionaryJsonValue<ReportHeadlineSettingsModel>("headline", new(), options)!;
         this.Content = settings.GetDictionaryJsonValue<ReportContentSettingsModel>("content", new(), options)!;
diff --git a/libs/net/template/ReportEngine.cs b/libs/net/template/ReportEngine.cs
@@ -233,7 +233,6 @@ public async Task<string> GenerateBase64ImageAsync(
         var optionsBytes = Encoding.UTF8.GetBytes(optionsJson);
         var optionsBase64 = Convert.ToBase64String(optionsBytes);
 
-
         // Send request to Charts API to generate base64
         var body = new StringContent(dataJson, Encoding.UTF8, System.Net.Mime.MediaTypeNames.Application.Json);
         var width = model.ChartTemplate.SectionSettings.Width.HasValue ? $"width={model.ChartTemplate.SectionSettings.Width.Value}" : "";
@@ -244,7 +243,7 @@ public async Task<string> GenerateBase64ImageAsync(
                 model.ChartTemplate.SectionSettings.ChartType ?? "bar",
                 $"?{width}{height}&options={optionsBase64}"),
             body);
-        this.Logger.LogDebug("Chart generated, chartTemplateId:{templateId} options:{options}", model.ChartTemplate.Id, optionsJson);
+        this.Logger.LogDebug("Chart generated, chartTemplateId:{templateId}", model.ChartTemplate.Id);
         return await response.Content.ReadAsStringAsync();
     }
 
@@ -499,7 +498,7 @@ await section.ChartTemplates.ForEachAsync(async chart =>
                 {
                     chart.SectionSettings ??= new();
                     chart.SectionSettings.Options = MergeChartOptions(chart.Settings, chart.SectionSettings);
-                    var chartOptions = chart.SectionSettings.Options.ToJson();
+                    // var chartOptions = chart.SectionSettings.Options.ToJson();
 
                     var chartModel = new ChartEngineContentModel(
                         ReportSectionModel.GenerateChartUid(section.Id, chart.Id),
@@ -508,7 +507,7 @@ await section.ChartTemplates.ForEachAsync(async chart =>
                         settings.UseAllContent ? null : content);
                     var chartRequestModel = new ChartRequestModel(chartModel);
                     var base64Image = await this.GenerateBase64ImageAsync(chartRequestModel);
-                    this.Logger.LogDebug("Chart generated, reportId:{reportId} instanceId:{instanceId} sectionId:{sectionId} chartId:{chartId} options:{options}", report.Id, reportInstance?.Id, section.Id, chart.Id, chartOptions);
+                    this.Logger.LogDebug("Chart generated, reportId:{reportId} instanceId:{instanceId} sectionId:{sectionId} chartId:{chartId}", report.Id, reportInstance?.Id, section.Id, chart.Id);
 
                     // Replace Chart Stubs with the generated image.
                     body = body.Replace(ReportSectionModel.GenerateChartUid(section.Id, chart.Id), base64Image);
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.15",
+  "version": "1.0.17",
   "homepage": "https://github.com/bcgov/tno",
   "license": "Apache-2.0",
   "files": [
diff --git a/libs/npm/core/src/hooks/api/interfaces/IReportSettingsModel.ts b/libs/npm/core/src/hooks/api/interfaces/IReportSettingsModel.ts
@@ -6,6 +6,7 @@ import {
 } from '.';
 
 export interface IReportSettingsModel {
+  from: string;
   subject: IReportSubjectSettingsModel;
   headline: IReportHeadlineSettingsModel;
   content: IReportContentSettingsModel;
diff --git a/openshift/kustomize/services/reporting/base/deploy.yaml b/openshift/kustomize/services/reporting/base/deploy.yaml
@@ -162,13 +162,13 @@ spec:
                 configMapKeyRef:
                   name: reporting-service
                   key: TOPICS
-
-            # CHES Configuration
-            - name: CHES__From
+            - name: Service__DefaultFrom
               valueFrom:
                 configMapKeyRef:
                   name: ches
                   key: CHES_FROM
+
+            # CHES Configuration
             - name: CHES__EmailEnabled
               valueFrom:
                 configMapKeyRef:
diff --git a/openshift/kustomize/shared_resources/overlays/dev/kustomization.yaml b/openshift/kustomize/shared_resources/overlays/dev/kustomization.yaml
@@ -21,6 +21,13 @@ generatorOptions:
   disableNameSuffixHash: true
 
 patches:
+  - target:
+      kind: ConfigMap
+      name: ches
+    patch: |-
+      - op: replace
+        path: /data/CHES_FROM
+        value: Media Monitoring Insights <dev.mmi@gov.bc.ca>
   - target:
       kind: ConfigMap
       name: keycloak
diff --git a/openshift/kustomize/shared_resources/overlays/prod/kustomization.yaml b/openshift/kustomize/shared_resources/overlays/prod/kustomization.yaml
@@ -21,6 +21,13 @@ generatorOptions:
   disableNameSuffixHash: true
 
 patches:
+  - target:
+      kind: ConfigMap
+      name: ches
+    patch: |-
+      - op: replace
+        path: /data/CHES_FROM
+        value: Media Monitoring Insights <mmi@gov.bc.ca>
   - target:
       kind: ConfigMap
       name: keycloak
diff --git a/openshift/kustomize/shared_resources/overlays/test/kustomization.yaml b/openshift/kustomize/shared_resources/overlays/test/kustomization.yaml
@@ -21,6 +21,13 @@ generatorOptions:
   disableNameSuffixHash: true
 
 patches:
+  - target:
+      kind: ConfigMap
+      name: ches
+    patch: |-
+      - op: replace
+        path: /data/CHES_FROM
+        value: Media Monitoring Insights <test.mmi@gov.bc.ca>
   - target:
       kind: ConfigMap
       name: keycloak
diff --git a/services/net/reporting/Config/ReportingOptions.cs b/services/net/reporting/Config/ReportingOptions.cs
@@ -38,5 +38,10 @@ public class ReportingOptions : ServiceOptions
     /// get/set - Number of retries allowed when a concurrency error occurs.
     /// </summary>
     public int RetryConcurrencyFailureLimit { get; set; } = 10;
+
+    /// <summary>
+    /// get/set - The default email address to use when sending reports.
+    /// </summary>
+    public string DefaultFrom { get; set; } = "";
     #endregion
 }
diff --git a/services/net/reporting/ReportingManager.cs b/services/net/reporting/ReportingManager.cs
@@ -782,6 +782,11 @@ private async Task SendEmailsAsync(
         string linkBody,
         string fullBody)
     {
+        if (!String.IsNullOrWhiteSpace(report.Settings.From))
+        {
+            request.From = report.Settings.From;
+        }
+
         // TODO: This implementation can result in one set of emails being successful and the second failing.
         var responseModel = new ReportEmailResponseModel();
         try
@@ -1293,7 +1298,7 @@ private async Task GenerateAndSendReportAsync(ReportRequestModel request, API.Ar
 
         if (this.Options.UseMailMerge)
         {
-            var merge = new EmailMergeModel(this.ChesOptions.From, contexts.Select(c => c.Context), subject, body)
+            var merge = new EmailMergeModel(request.From ?? this.Options.DefaultFrom, contexts.Select(c => c.Context), subject, body)
             {
                 // TODO: Extract values from report settings.
                 Encoding = EmailEncodings.Utf8,
@@ -1345,7 +1350,7 @@ private async Task GenerateAndSendReportAsync(ReportRequestModel request, API.Ar
                 {
                     try
                     {
-                        var email = new EmailModel(this.ChesOptions.From, context.To.ToArray(), subject, body)
+                        var email = new EmailModel(request.From ?? this.Options.DefaultFrom, context.To.ToArray(), subject, body)
                         {
                             Cc = context.Cc.ToArray(),
                             Bcc = context.Bcc.ToArray(),
diff --git a/services/net/reporting/appsettings.Development.json b/services/net/reporting/appsettings.Development.json
@@ -8,7 +8,8 @@
     }
   },
   "Service": {
-    "MaxFailLimit": 5
+    "MaxFailLimit": 5,
+    "DefaultFrom": "Media Monitoring Insights <dev.mmi@gov.bc.ca>"
   },
   "Reporting": {
     "SubscriberAppUrl": "https://dev.mmi.gov.bc.ca",
@@ -18,7 +19,6 @@
   "CHES": {
     "AuthUrl": "https://dev.loginproxy.gov.bc.ca/auth/realms/comsvcauth/protocol/openid-connect/token",
     "HostUri": "https://ches-dev.api.gov.bc.ca/api/v1",
-    "From": "Media Monitoring Insights <mmi@gov.bc.ca>",
     "EmailEnabled": true,
     "EmailAuthorized": false
   },
diff --git a/services/net/reporting/appsettings.Staging.json b/services/net/reporting/appsettings.Staging.json
@@ -8,7 +8,8 @@
   },
   "Service": {
     "MaxFailLimit": 5,
-    "ApiUrl": "http://api:8080"
+    "ApiUrl": "http://api:8080",
+    "DefaultFrom": "Media Monitoring Insights <test.mmi@gov.bc.ca>"
   },
   "Reporting": {
     "SubscriberAppUrl": "https://test.mmi.gov.bc.ca",
@@ -18,7 +19,6 @@
   "CHES": {
     "AuthUrl": "https://test.loginproxy.gov.bc.ca/auth/realms/comsvcauth/protocol/openid-connect/token",
     "HostUri": "https://ches-test.api.gov.bc.ca/api/v1",
-    "From": "Media Monitoring Insights <mmi@gov.bc.ca>",
     "EmailEnabled": true,
     "EmailAuthorized": false
   },
diff --git a/services/net/reporting/appsettings.json b/services/net/reporting/appsettings.json
@@ -17,7 +17,8 @@
     "ApiUrl": "http://api:8080",
     "TimeZone": "Pacific Standard Time",
     "Topics": "reporting",
-    "SendEmailOnFailure": true
+    "SendEmailOnFailure": true,
+    "DefaultFrom": "Media Monitoring Insights <mmi@gov.bc.ca>"
   },
   "Reporting": {
     "SubscriberAppUrl": "https://mmi.gov.bc.ca",
@@ -32,7 +33,6 @@
   "CHES": {
     "AuthUrl": "https://loginproxy.gov.bc.ca/auth/realms/comsvcauth/protocol/openid-connect/token",
     "HostUri": "https://ches.api.gov.bc.ca/api/v1",
-    "From": "Media Monitoring Insights <mmi@gov.bc.ca>",
     "EmailEnabled": true,
     "EmailAuthorized": false
   },

Original file line number	Diff line number	Diff line change
`@@ -228,7 +228,7 @@ public async Task<EmailResponseModel> SendEmailAsync(IEmail email)`
`228`	`228`	`{`
`229`	`229`	`ArgumentNullException.ThrowIfNull(email);`
`230`	`230`
`231`		`- email.From = this.Options.From ?? email.From;`
	`231`	`+ email.From = !String.IsNullOrWhiteSpace(this.Options.From) ? this.Options.From : email.From;`
`232`	`232`
`233`	`233`	`if (this.Options.BccUser)`
`234`	`234`	`{`