From fbb039c9cbefdca2caa272e0ed448ef92dc1d44d Mon Sep 17 00:00:00 2001 From: abarz722 Date: Sun, 30 Aug 2026 11:50:34 +0200 Subject: [PATCH 01/48] rework modelling notifications --- .../subscribeDailyCheckConfigChanges.graphql | 1 - .../files/sql/creation/fworch-fill-config.sql | 9 - .../files/sql/idempotent/fworch-texts.sql | 58 +-- roles/database/files/upgrade/9.4.5.sql | 213 ++++++++++ .../files/FWO.Config.Api/Data/ConfigData.cs | 9 + .../files/FWO.Data/EmailRecipientSelection.cs | 8 +- roles/lib/files/FWO.Data/FwoNotification.cs | 2 +- .../EmailNotification/EmailHelper.cs | 58 ++- .../NotificationEmailLayoutHelper.cs | 2 +- .../NotificationPlaceholderResolver.cs | 68 ++++ .../NotificationScheduleHelper.cs | 114 ++++++ ...odellingConnectionHandlerInterfHandling.cs | 128 ++++-- .../FWO.Services/Properties/AssemblyInfo.cs | 3 + .../Jobs/DailyCheckJob.cs | 35 +- .../NotificationService.cs | 91 +---- .../files/FWO.Test/DailyCheckJobTest.cs | 69 +++- .../FWO.Test/EmailHelperRecipientTest.cs | 202 +++++++++ .../FWO.Test/EmailNotificationContentTest.cs | 132 ++++++ ...ellingConnectionHandlerDecommissionTest.cs | 75 ++-- .../ModellingEmailRecipientSelectionTest.cs | 72 +++- .../NotificationPlaceholderResolverTest.cs | 59 +++ .../NotificationScheduleHelperTest.cs | 47 +++ .../files/FWO.Test/NotificationTest.cs | 7 + .../files/FWO.Test/SimulatedUserConfig.cs | 4 +- .../files/FWO.Test/UiEditNotificationsTest.cs | 69 ++++ .../UiEmailRecipientSelectionEditorTest.cs | 82 ++++ .../FWO.Test/UiRequestAndRejectPopupTest.cs | 383 +++++++++++++++++- .../UiSettingsModellingNotificationsTest.cs | 342 ++++++++-------- .../HelpSettingsModellingNotifications.cshtml | 15 +- .../RequestInterfacePopup.razor | 81 +++- .../EmailRecipientSelectionEditor.razor | 28 +- .../SettingsModellingNotifications.razor | 100 +---- .../FWO.UI/Shared/EditNotifications.razor | 60 ++- 33 files changed, 2080 insertions(+), 546 deletions(-) create mode 100644 roles/database/files/upgrade/9.4.5.sql create mode 100644 roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs create mode 100644 roles/lib/files/FWO.Services/Properties/AssemblyInfo.cs create mode 100644 roles/tests-unit/files/FWO.Test/NotificationPlaceholderResolverTest.cs create mode 100644 roles/tests-unit/files/FWO.Test/NotificationScheduleHelperTest.cs diff --git a/roles/common/files/fwo-api-calls/config/subscribeDailyCheckConfigChanges.graphql b/roles/common/files/fwo-api-calls/config/subscribeDailyCheckConfigChanges.graphql index 4e528c2add..f287cdd62a 100644 --- a/roles/common/files/fwo-api-calls/config/subscribeDailyCheckConfigChanges.graphql +++ b/roles/common/files/fwo-api-calls/config/subscribeDailyCheckConfigChanges.graphql @@ -23,7 +23,6 @@ {config_key: {_eq: "notificationLanguage"}}, {config_key: {_eq: "maxImportDuration"}}, {config_key: {_eq: "maxImportInterval"}}, - {config_key: {_eq: "modUnansweredReqEmailBody"}}, {config_key: {_eq: "ruleExpiryEmailBody"}}, {config_key: {_eq: "ownerActiveRuleEmailBody"}}, {config_key: {_eq: "ruleExpiryInitiatorKeys"}}, diff --git a/roles/database/files/sql/creation/fworch-fill-config.sql b/roles/database/files/sql/creation/fworch-fill-config.sql index 452a5a7445..22ff86dde8 100644 --- a/roles/database/files/sql/creation/fworch-fill-config.sql +++ b/roles/database/files/sql/creation/fworch-fill-config.sql @@ -82,17 +82,8 @@ insert into config (config_key, config_value, config_user) VALUES ('modNamingCon insert into config (config_key, config_value, config_user) VALUES ('modCommonAreas', '[]', 0); insert into config (config_key, config_value, config_user) VALUES ('modAppServerTypes', '[{"Id":0,"Name":"Default"}]', 0); insert into config (config_key, config_value, config_user) VALUES ('modReqInterfaceName', '', 0); -insert into config (config_key, config_value, config_user) VALUES ('modReqEmailReceiver', 'OwnerGroupOnly', 0); -insert into config (config_key, config_value, config_user) VALUES ('modReqEmailRequesterInCc', 'true', 0); -insert into config (config_key, config_value, config_user) VALUES ('modReqEmailOtherAddresses', '', 0); -insert into config (config_key, config_value, config_user) VALUES ('modReqEmailSubject', '', 0); -insert into config (config_key, config_value, config_user) VALUES ('modReqEmailBody', '', 0); insert into config (config_key, config_value, config_user) VALUES ('modReqTicketTitle', '', 0); insert into config (config_key, config_value, config_user) VALUES ('modReqTaskTitle', '', 0); -insert into config (config_key, config_value, config_user) VALUES ('modDecommEmailReceiver', 'None', 0); -insert into config (config_key, config_value, config_user) VALUES ('modDecommEmailOtherAddresses', '', 0); -insert into config (config_key, config_value, config_user) VALUES ('modDecommEmailSubject', '', 0); -insert into config (config_key, config_value, config_user) VALUES ('modDecommEmailBody', '', 0); insert into config (config_key, config_value, config_user) VALUES ('modIntegrationMode', 'FullyIntegrated', 0); insert into config (config_key, config_value, config_user) VALUES ('modIntegrationStates', '[]', 0); insert into config (config_key, config_value, config_user) VALUES ('modIntegrationStateMarker', 'ImplementationState', 0); diff --git a/roles/database/files/sql/idempotent/fworch-texts.sql b/roles/database/files/sql/idempotent/fworch-texts.sql index b1dfd3304a..efd4df1e68 100644 --- a/roles/database/files/sql/idempotent/fworch-texts.sql +++ b/roles/database/files/sql/idempotent/fworch-texts.sql @@ -1,4 +1,4 @@ --- text codes (roughly) categorized: +-- text codes (roughly) categorized: -- U: user texts (explanation or confirmation texts) -- E: error texts -- A: Api errors @@ -540,6 +540,7 @@ INSERT INTO txt VALUES ('whats_new_facts', 'German', '
  • Regelreports können nach den Objekttypen von Quelle und Ziel gefiltert werden.
  • FQDN-, dynamische und Access-Role-Objekte ohne IP-Adresse werden als adresslose Objekte behandelt.
  • ANY-Serviceobjekte (alle Protokolle und Ports) werden automatisch dem ANY-Flow-Serviceobjekt korrekt zugeordnet.
    • +
  • Die Benachrichtigungen für Schnittstellenanfragen werden jetzt zentral über Notification-Einträge verwaltet, inklusive Erinnerungs- und Antrags-Texten sowie optionaler CC an den Antragsteller.
  • Details: siehe Release Notes.
    • '); @@ -554,6 +555,7 @@ INSERT INTO txt VALUES ('whats_new_facts', 'English', '
  • Rule reports can be filtered by source and destination object types.
  • FQDN, dynamic, and access-role objects without an IP address are handled as addressless objects.
  • ANY service objects (all protocols and ports) are automatically mapped to the correct ANY flow service object.
    • +
  • Interface request notifications are now managed centrally through notification entries, including reminder and request bodies as well as optional CC to the requester.
  • Details: see release notes.
    • '); @@ -1766,6 +1768,8 @@ INSERT INTO txt VALUES ('display_interface', 'German', 'Schnittstelle darstel INSERT INTO txt VALUES ('display_interface', 'English', 'Display Interface'); INSERT INTO txt VALUES ('interface_permission', 'German', 'Berechtigung'); INSERT INTO txt VALUES ('interface_permission', 'English', 'Permission'); +INSERT INTO txt VALUES ('initial_request', 'German', 'Antragsbenachrichtigung'); +INSERT INTO txt VALUES ('initial_request', 'English', 'Initial request'); INSERT INTO txt VALUES ('request_interface', 'German', 'Schnittstelle anfordern'); INSERT INTO txt VALUES ('request_interface', 'English', 'Request Interface'); INSERT INTO txt VALUES ('requested_interface', 'German', 'Angeforderte Schnittstelle'); @@ -1960,6 +1964,8 @@ INSERT INTO txt VALUES ('decommission', 'German', 'Stilllegen'); INSERT INTO txt VALUES ('decommission', 'English', 'Decommission'); INSERT INTO txt VALUES ('decomm_interface', 'German', 'Schnittstelle stilllegen'); INSERT INTO txt VALUES ('decomm_interface', 'English', 'Decommission interface'); +INSERT INTO txt VALUES ('decomm_owner', 'German', 'Eigentümer stilllegen'); +INSERT INTO txt VALUES ('decomm_owner', 'English', 'Decommission Owner'); INSERT INTO txt VALUES ('on', 'German', ' auf '); INSERT INTO txt VALUES ('on', 'English', ' on '); INSERT INTO txt VALUES ('create_rule', 'German', 'Regeln anlegen'); @@ -3100,8 +3106,6 @@ INSERT INTO txt VALUES ('modReqInterfaceName', 'German', 'Name der beantragte INSERT INTO txt VALUES ('modReqInterfaceName', 'English', 'Name of requested interface'); INSERT INTO txt VALUES ('modReqEmailReceiver', 'German', 'Empfänger der Antragsbenachrichtigung'); INSERT INTO txt VALUES ('modReqEmailReceiver', 'English', 'Receiver of request email'); -INSERT INTO txt VALUES ('modReqEmailRequesterInCc','German','Antragssteller in CC'); -INSERT INTO txt VALUES ('modReqEmailRequesterInCc','English','Requester in CC'); INSERT INTO txt VALUES ('modReqEmailOtherAddresses','German','Weitere Email-Adressen'); INSERT INTO txt VALUES ('modReqEmailOtherAddresses','English','Additional email addresses'); INSERT INTO txt VALUES ('modEnsureAtLeastOneEmailNotification','German','Mindestens eine Email-Benachrichtigung sicherstellen'); @@ -3339,6 +3343,8 @@ INSERT INTO txt VALUES ('notification', 'German', 'Benachrichtigung'); INSERT INTO txt VALUES ('notification', 'English', 'Notification'); INSERT INTO txt VALUES ('notifications', 'German', 'Benachrichtigungen'); INSERT INTO txt VALUES ('notifications', 'English', 'Notifications'); +INSERT INTO txt VALUES ('reminder', 'German', 'Erinnerung'); +INSERT INTO txt VALUES ('reminder', 'English', 'Reminder'); INSERT INTO txt VALUES ('reminders', 'German', 'Erinnerungsbenachrichtigungen'); INSERT INTO txt VALUES ('reminders', 'English', 'Reminders'); INSERT INTO txt VALUES ('edit_notification', 'German', 'Benachrichtigung bearbeiten'); @@ -7034,18 +7040,22 @@ INSERT INTO txt VALUES ('H5621', 'English', 'A modeller can overwrite some perso '); INSERT INTO txt VALUES ('H5622', 'German', 'Name der beantragten Schnittstelle: Namensvorschlag bei der Beantragung einer Schnittstelle. Kann vom Antragsteller noch geändert werden.'); INSERT INTO txt VALUES ('H5622', 'English', 'Name of requested interface: Proposed name of the requested interface. Can be changed by the requester.'); -INSERT INTO txt VALUES ('H5623', 'German', 'Titel der Antragsbenachrichtigung: Betreff der Email-Benachrichtigung an die Beauftragten.'); -INSERT INTO txt VALUES ('H5623', 'English', 'Subject of request emails: Subject of the email to the addressed owners.'); -INSERT INTO txt VALUES ('H5624', 'German', 'Text der Antragsbenachrichtigung: Text der Email-Benachrichtigung an die Beauftragten. Wird noch durch Antragsteller (zu Beginn) und Beauftragtem (am Ende) ergänzt. - Hinzu kommt noch jeweils ein Link auf den Auftrag im Workflowmodul und auf die beauftragte Schnittstelle im Modellierungsmodul. +INSERT INTO txt VALUES ('H5623', 'German', 'Titel der Antragsbenachrichtigung: Betreff der Email-Benachrichtigung für die initiale Schnittstellenanfrage.'); +INSERT INTO txt VALUES ('H5623', 'English', 'Subject of initial request emails: Subject of the email notification for the initial interface request.'); +INSERT INTO txt VALUES ('H5624', 'German', 'Text der Antragsbenachrichtigung: Text der Email-Benachrichtigung für die initiale Schnittstellenanfrage. Sie wird sofort ohne Frist versendet. + Verfügbare Platzhalter: + @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTDATE@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_LINK@@. '); -INSERT INTO txt VALUES ('H5624', 'English', 'Body of request emails: Text of the email notification to the addressed owners. Will be appended by the requester (at the beginning) and the addressed owner (at the end). - Additionally links to the request in the Workflow module and the requested interface in the Modelling module are added. +INSERT INTO txt VALUES ('H5624', 'English', 'Body of initial request emails: Text of the email notification for the initial interface request. It is sent immediately without a deadline. + Available placeholders: + @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTDATE@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_LINK@@. '); -INSERT INTO txt VALUES ('H5624a', 'German', 'Text der Erinnerungsbenachrichtigung: Text der Email-Benachrichtigung an die Beauftragten. Verfügbare Platzhalter: +INSERT INTO txt VALUES ('H5624a', 'German', 'Text der Erinnerungsbenachrichtigung: Text der Email-Benachrichtigung für Erinnerungen an offene Schnittstellenanfragen. + Verfügbare Platzhalter: @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTDATE@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_LINK@@. '); -INSERT INTO txt VALUES ('H5624a', 'English', 'Body of unanswered request emails: Text of the email notification to the addressed owners. Available placeholders: +INSERT INTO txt VALUES ('H5624a', 'English', 'Body of reminder emails: Text of the email notification for reminders about open interface requests. + Available placeholders: @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTDATE@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_LINK@@. '); INSERT INTO txt VALUES ('H5625', 'German', 'Titel des Schnittstellentickets: Titel, mit dem ein neues Ticket zur Beantragung einer Schnittstelle angelegt wird.'); @@ -7064,17 +7074,17 @@ INSERT INTO txt VALUES ('H5628', 'German', 'Vordefinierte Dienste: Hier wird de INSERT INTO txt VALUES ('H5628', 'English', 'Predefined Services: Offers a menu to the administrator to define, change or delete predefined services or service groups. These services are available for all applications. '); -INSERT INTO txt VALUES ('H5629', 'German', 'Erinnerungsbenachrichtigungen: Legt fest, wer wie oft in welchem Zeitintervall über offene Schnittstellenanträge benachrichtigt wird.'); -INSERT INTO txt VALUES ('H5629', 'English', 'Reminders: Defines who will be notified how often and in which time interval about open interface requests.'); -INSERT INTO txt VALUES ('H5630', 'German', 'Empfänger der Antragsbenachrichtigung: Mehrfachauswahl, an wen die Email geschickt werden soll. +INSERT INTO txt VALUES ('H5629', 'German', 'Erinnerungsbenachrichtigungen: Legt fest, welche Erinnerungsbenachrichtigungen für offene Schnittstellenanfragen mit der Frist RequestDate versendet werden.'); +INSERT INTO txt VALUES ('H5629', 'English', 'Reminders: Defines which reminder notifications are sent for open interface requests with deadline RequestDate.'); +INSERT INTO txt VALUES ('H5630', 'German', 'Empfänger der Antragsbenachrichtigung: Mehrfachauswahl, an wen die initiale Benachrichtigung als To, Cc oder Bcc geschickt werden soll. Verfügbare Optionen sind Keine, Andere Adressen, die Option "Mindestens eine Email-Benachrichtigung sicherstellen" und alle aktiven Verantwortlichkeitsstufen. Ist "Keine" gesetzt, sind alle anderen Optionen deaktiviert. Wenn "Mindestens eine Email-Benachrichtigung sicherstellen" aktiv ist, werden zuerst die ausgewählten Optionen verwendet. Nur falls daraus keine Empfänger entstehen, werden nicht ausgewählte Verantwortlichkeitsstufen von hoher zu niedriger Sortierreihenfolge durchsucht, bis eine Stufe mit Empfängern gefunden wird. - Zusätzlich kann festgelegt werden, ob der Antragsteller die Nachricht im Cc bekommen soll (Default: ja). + Der Antragsteller kann dabei als Empfänger in der gewünschten Spalte ausgewählt werden. '); -INSERT INTO txt VALUES ('H5630', 'English', 'Receiver of request emails: Multi-select list defining who receives the request notification email. +INSERT INTO txt VALUES ('H5630', 'English', 'Receiver of initial request emails: Multi-select list defining who receives the initial notification in To, Cc or Bcc. Available options are None, Other addresses, the option "Ensure at least one email notification can be sent", and all active responsible levels. If "None" is selected, all other options are disabled. If "Ensure at least one email notification can be sent" is active, selected options are used first. Only if they yield no recipients, non-selected responsible levels are checked from highest to lowest sort order until a level with recipients is found. - It can also be configured whether the requester receives the email in Cc (default: yes). + The requester can also be selected as recipient in the desired column. '); INSERT INTO txt VALUES ('H5631', 'German', 'Servicegruppen auflösen: Ersetze beim Erzeugen eines externen Auftrags die Servicegruppen durch die einzelnen Mitglieder.'); INSERT INTO txt VALUES ('H5631', 'English', 'Resolve service groups: Replace service groups by its members when creating an external request.'); @@ -7154,19 +7164,19 @@ INSERT INTO txt VALUES ('H5658', 'German', 'Rezertifizierungstext: Text, der zu INSERT INTO txt VALUES ('H5658', 'English', 'Recertification Text: Text to be shown to confirm recertification. If the text contains a placeholder "@@APPNAME@@", it is replaced by the app name.'); INSERT INTO txt VALUES ('H5659', 'German', 'Netzwerkareas für Updatable Objects: Vom Administrator vorgegebene Netzwerkareas, welche für die Zuordnung über die Sonderkonfiguration "Updatable Objects" genutzt werden dürfen. Die beiden Auswahlfelder "in Quelle" und "in Ziel" legen fest, wo die Netzwerkarea genutzt werden darf.'); INSERT INTO txt VALUES ('H5659', 'English', 'Network Areas for Updatable Objects: Network areas defined by the administrator, which are permitted to be used for assignment via the Extra Configurations "Updatable Objects". The flags "in Source" and "in Destination" determine, where the Network Areas are allowed to be used.'); -INSERT INTO txt VALUES ('H5660', 'German', 'Empfänger der Stilllegungsbenachrichtigung: Mehrfachauswahl, an wen die Email geschickt werden soll. +INSERT INTO txt VALUES ('H5660', 'German', 'Empfänger der Stilllegungsbenachrichtigung: Mehrfachauswahl, an wen die Stilllegungsbenachrichtigung als To, Cc oder Bcc geschickt werden soll. Verfügbare Optionen sind Keine, Andere Adressen, die Option "Mindestens eine Email-Benachrichtigung sicherstellen" und alle aktiven Verantwortlichkeitsstufen. Ist "Keine" gesetzt, sind alle anderen Optionen deaktiviert. Wenn "Mindestens eine Email-Benachrichtigung sicherstellen" aktiv ist, werden zuerst die ausgewählten Optionen verwendet. Nur falls daraus keine Empfänger entstehen, werden nicht ausgewählte Verantwortlichkeitsstufen von hoher zu niedriger Sortierreihenfolge durchsucht, bis eine Stufe mit Empfängern gefunden wird.'); -INSERT INTO txt VALUES ('H5660', 'English', 'Receiver of decommission emails: Multi-select list defining who receives the decommission notification email. +INSERT INTO txt VALUES ('H5660', 'English', 'Receiver of decommission emails: Multi-select list defining who receives the decommission notification in To, Cc or Bcc. Available options are None, Other addresses, the option "Ensure at least one email notification can be sent", and all active responsible levels. If "None" is selected, all other options are disabled. If "Ensure at least one email notification can be sent" is active, selected options are used first. Only if they yield no recipients, non-selected responsible levels are checked from highest to lowest sort order until a level with recipients is found.'); -INSERT INTO txt VALUES ('H5661', 'German', 'Titel der Stilllegungsbenachrichtigung: Betreff der Email-Benachrichtigung an die betroffenen Eigentümer. Platzhalter @@INTERFACE_NAME@@ werden mit dem Namen der zu löschenden Schnittstelle ersetzt.'); -INSERT INTO txt VALUES ('H5661', 'English', 'Subject of decommission emails: Subject of the email to the addressed owners. Placeholders @@INTERFACE_NAME@@ will be replaced by the name of the interface to be decommissioned.'); -INSERT INTO txt VALUES ('H5662', 'German', 'Text der Stilllegungsbenachrichtigung: Text der Email-Benachrichtigung an die Nutzer der Schnittstelle, gefolgt von der Liste der betroffenen Verbindungen. Es können folgende Platzhalter genutzt werden: +INSERT INTO txt VALUES ('H5661', 'German', 'Titel der Stilllegungsbenachrichtigung: Betreff der Email-Benachrichtigung für die Stilllegung eines Eigentümers. Platzhalter @@INTERFACE_NAME@@ werden mit dem Namen der stillzulegenden Schnittstelle ersetzt.'); +INSERT INTO txt VALUES ('H5661', 'English', 'Subject of decommission emails: Subject of the email notification for decommissioning an owner. Placeholders @@INTERFACE_NAME@@ will be replaced by the name of the interface to be decommissioned.'); +INSERT INTO txt VALUES ('H5662', 'German', 'Text der Stilllegungsbenachrichtigung: Text der Email-Benachrichtigung für die Stilllegung eines Eigentümers, gefolgt von der Liste der betroffenen Verbindungen. Es können folgende Platzhalter genutzt werden: @@INTERFACE_NAME@@ wird durch den Namen der stillzulegenden Schnittstelle ersetzt, @@NEW_INTERFACE_NAME@@ mit dem Namen der vorgeschlagenen Ersatzschnittstelle, @@NEW_INTERFACE_LINK@@ mit einem Link auf diese, - @@REASON@@ mit dem Begründungstext, der im Stillegungsformular eingegeben wurde, @@USER_NAME@@ mit dem Nutzer, der die Stillegung veranlasst hat. + @@REASON@@ mit dem Begründungstext, der im Stilllegungsformular eingegeben wurde, @@USER_NAME@@ mit dem Nutzer, der die Stilllegung veranlasst hat. '); -INSERT INTO txt VALUES ('H5662', 'English', 'Body of decommission emails: Text of the email notification to the addressed owners, followed by a list of the affected connections. Some placeholders can be used: +INSERT INTO txt VALUES ('H5662', 'English', 'Body of decommission emails: Text of the email notification for decommissioning an owner, followed by a list of the affected connections. Some placeholders can be used: @@INTERFACE_NAME@@ will be replaced by the name of the interface to be decommissioned, @@NEW_INTERFACE_NAME@@ by the name of the proposed new interface, @@NEW_INTERFACE_LINK@@ by a link to this interface, @@REASON@@ by the reason text filled in the decommission form, @@USER_NAME@@ by the user initiating the decommissioning. '); diff --git a/roles/database/files/upgrade/9.4.5.sql b/roles/database/files/upgrade/9.4.5.sql new file mode 100644 index 0000000000..a82ca8f9be --- /dev/null +++ b/roles/database/files/upgrade/9.4.5.sql @@ -0,0 +1,213 @@ +-- migrate interface request notification text from legacy config to notification rows +WITH request_config AS +( + SELECT + MAX(CASE WHEN config_key = 'modReqEmailReceiver' THEN COALESCE(config_value, '') END) AS recipients, + MAX(CASE WHEN config_key = 'modReqEmailSubject' THEN COALESCE(config_value, '') END) AS subject, + MAX(CASE WHEN config_key = 'modReqEmailBody' THEN COALESCE(config_value, '') END) AS body, + MAX(CASE WHEN config_key = 'modUnansweredReqEmailBody' THEN COALESCE(config_value, '') END) AS reminder_body + FROM config + WHERE config_user = 0 + AND config_key IN ('modReqEmailReceiver', 'modReqEmailSubject', 'modReqEmailBody', 'modUnansweredReqEmailBody') +), +initial_notification_seed AS +( + SELECT COUNT(*) AS notification_count + FROM notification + WHERE notification_client = 'InterfaceRequest' + AND COALESCE(deadline, 'None') = 'None' +), +reminder_notification_seed AS +( + SELECT COUNT(*) AS notification_count + FROM notification + WHERE notification_client = 'InterfaceRequest' + AND deadline = 'RequestDate' +), +insert_initial_notification AS +( + INSERT INTO notification + ( + notification_client, + name, + channel, + recipient_to, + email_address_to, + recipient_cc, + email_address_cc, + recipient_bcc, + email_address_bcc, + email_subject, + email_body, + layout, + deadline, + interval_before_deadline, + offset_before_deadline, + repeat_interval_after_deadline, + initial_offset_after_deadline, + repeat_offset_after_deadline, + repetitions_after_deadline + ) + SELECT + 'InterfaceRequest', + 'Interface requested', + 'Email', + CASE + WHEN recipients = '' THEN 'None' + WHEN recipients LIKE '{%' THEN 'ConfiguredResponsibles' + ELSE 'OtherAddresses' + END, + recipients, + 'None', + '', + 'None', + '', + CASE + WHEN LENGTH(subject) = 0 THEN 'Interface requested' + ELSE subject + END, + body, + 'SimpleText', + 'None', + NULL, + NULL, + NULL, + NULL, + NULL, + NULL + FROM request_config + CROSS JOIN initial_notification_seed + WHERE notification_count = 0 + AND recipients <> '' + RETURNING 1 +), +update_initial_bodies AS +( + UPDATE notification n + SET email_body = CASE + WHEN COALESCE(n.email_body, '') = '' THEN request_config.body + ELSE n.email_body + END + FROM request_config + CROSS JOIN initial_notification_seed + WHERE n.notification_client = 'InterfaceRequest' + AND COALESCE(n.deadline, 'None') = 'None' + AND initial_notification_seed.notification_count > 0 + RETURNING 1 +), +update_reminder_bodies AS +( + UPDATE notification n + SET email_body = CASE + WHEN COALESCE(n.email_body, '') = '' THEN request_config.reminder_body + ELSE n.email_body + END + FROM request_config + CROSS JOIN reminder_notification_seed + WHERE n.notification_client = 'InterfaceRequest' + AND n.deadline = 'RequestDate' + AND reminder_notification_seed.notification_count > 0 + RETURNING 1 +) +SELECT 1; + +WITH decomm_config AS +( + SELECT + MAX(CASE WHEN config_key = 'modDecommEmailReceiver' THEN COALESCE(config_value, '') END) AS recipients, + MAX(CASE WHEN config_key = 'modDecommEmailOtherAddresses' THEN COALESCE(config_value, '') END) AS other_addresses, + MAX(CASE WHEN config_key = 'modDecommEmailSubject' THEN COALESCE(config_value, '') END) AS subject, + MAX(CASE WHEN config_key = 'modDecommEmailBody' THEN COALESCE(config_value, '') END) AS body + FROM config + WHERE config_user = 0 + AND config_key IN ('modDecommEmailReceiver', 'modDecommEmailOtherAddresses', 'modDecommEmailSubject', 'modDecommEmailBody') +), +decomm_notification_seed AS +( + SELECT COUNT(*) AS notification_count + FROM notification + WHERE notification_client = 'AppDecomm' + AND COALESCE(deadline, 'None') = 'None' +), +insert_decomm_notification AS +( + INSERT INTO notification + ( + notification_client, + name, + channel, + recipient_to, + email_address_to, + recipient_cc, + email_address_cc, + recipient_bcc, + email_address_bcc, + email_subject, + email_body, + layout, + deadline, + interval_before_deadline, + offset_before_deadline, + repeat_interval_after_deadline, + initial_offset_after_deadline, + repeat_offset_after_deadline, + repetitions_after_deadline + ) + SELECT + 'AppDecomm', + 'Interface decommissioned', + 'Email', + CASE + WHEN recipients = '' AND other_addresses <> '' THEN 'OtherAddresses' + WHEN recipients = '' THEN 'None' + ELSE recipients + END, + other_addresses, + 'None', + '', + 'None', + '', + CASE + WHEN LENGTH(subject) = 0 THEN 'Interface decommissioned' + ELSE subject + END, + body, + 'SimpleText', + 'None', + NULL, + NULL, + NULL, + NULL, + NULL, + NULL + FROM decomm_config + CROSS JOIN decomm_notification_seed + WHERE notification_count = 0 + AND ( + LENGTH(recipients) > 0 + OR LENGTH(other_addresses) > 0 + OR LENGTH(subject) > 0 + OR LENGTH(body) > 0 + ) + RETURNING 1 +), +update_decomm_subject_bodies AS +( + UPDATE notification n + SET + email_subject = CASE + WHEN COALESCE(n.email_subject, '') = '' THEN CASE WHEN LENGTH(decomm_config.subject) = 0 THEN 'Interface decommissioned' ELSE decomm_config.subject END + ELSE n.email_subject + END, + email_body = CASE + WHEN COALESCE(n.email_body, '') = '' THEN decomm_config.body + ELSE n.email_body + END + FROM decomm_config + CROSS JOIN decomm_notification_seed + WHERE n.notification_client = 'AppDecomm' + AND COALESCE(n.deadline, 'None') = 'None' + AND decomm_notification_seed.notification_count > 0 + RETURNING 1 +) +SELECT 1; diff --git a/roles/lib/files/FWO.Config.Api/Data/ConfigData.cs b/roles/lib/files/FWO.Config.Api/Data/ConfigData.cs index 4479e684b5..7f0abf4969 100644 --- a/roles/lib/files/FWO.Config.Api/Data/ConfigData.cs +++ b/roles/lib/files/FWO.Config.Api/Data/ConfigData.cs @@ -409,21 +409,26 @@ public class ConfigData : ICloneable [JsonProperty("flowNamingSourceManagementRanking"), JsonPropertyName("flowNamingSourceManagementRanking")] public string FlowNamingSourceManagementRanking { get; set; } = "[]"; + [Obsolete("Use notification entries with NotificationClient.InterfaceRequest instead.")] [JsonProperty("modReqEmailReceiver"), JsonPropertyName("modReqEmailReceiver")] public string ModReqEmailReceiver { get; set; } = nameof(EmailRecipientOption.None); + [Obsolete("Use notification recipient selection for NotificationClient.InterfaceRequest instead.")] [JsonProperty("modReqEmailRequesterInCc"), JsonPropertyName("modReqEmailRequesterInCc")] public bool ModReqEmailRequesterInCc { get; set; } = true; [JsonProperty("modReqEmailOtherAddresses"), JsonPropertyName("modReqEmailOtherAddresses")] public string ModReqEmailOtherAddresses { get; set; } = ""; + [Obsolete("Use notification entries with NotificationClient.InterfaceRequest instead.")] [JsonProperty("modReqEmailSubject"), JsonPropertyName("modReqEmailSubject")] public string ModReqEmailSubject { get; set; } = ""; + [Obsolete("Use notification entries with NotificationClient.InterfaceRequest instead.")] [JsonProperty("modReqEmailBody"), JsonPropertyName("modReqEmailBody")] public string ModReqEmailBody { get; set; } = ""; + [Obsolete("Use notification entries with NotificationClient.InterfaceRequest instead.")] [JsonProperty("modUnansweredReqEmailBody"), JsonPropertyName("modUnansweredReqEmailBody")] public string ModUnansweredReqEmailBody { get; set; } = ""; @@ -442,15 +447,19 @@ public class ConfigData : ICloneable [JsonProperty("modReqTaskTitle"), JsonPropertyName("modReqTaskTitle")] public string ModReqTaskTitle { get; set; } = ""; + [Obsolete("Use notification entries with NotificationClient.AppDecomm instead.")] [JsonProperty("modDecommEmailReceiver"), JsonPropertyName("modDecommEmailReceiver")] public string ModDecommEmailReceiver { get; set; } = nameof(EmailRecipientOption.None); + [Obsolete("Use notification entries with NotificationClient.AppDecomm instead.")] [JsonProperty("modDecommEmailOtherAddresses"), JsonPropertyName("modDecommEmailOtherAddresses")] public string ModDecommEmailOtherAddresses { get; set; } = ""; + [Obsolete("Use notification entries with NotificationClient.AppDecomm instead.")] [JsonProperty("modDecommEmailSubject"), JsonPropertyName("modDecommEmailSubject")] public string ModDecommEmailSubject { get; set; } = ""; + [Obsolete("Use notification entries with NotificationClient.AppDecomm instead.")] [JsonProperty("modDecommEmailBody"), JsonPropertyName("modDecommEmailBody")] public string ModDecommEmailBody { get; set; } = ""; diff --git a/roles/lib/files/FWO.Data/EmailRecipientSelection.cs b/roles/lib/files/FWO.Data/EmailRecipientSelection.cs index 08490c4850..67711782b1 100644 --- a/roles/lib/files/FWO.Data/EmailRecipientSelection.cs +++ b/roles/lib/files/FWO.Data/EmailRecipientSelection.cs @@ -19,6 +19,9 @@ public class EmailRecipientSelection [JsonPropertyName("other_address_list")] public List OtherAddressList { get; set; } = []; + [JsonPropertyName("requester")] + public bool Requester { get; set; } = false; + [JsonPropertyName("ensure_at_least_one_notification")] public bool EnsureAtLeastOneNotification { get; set; } = false; @@ -60,7 +63,7 @@ public string ToConfigValue(IEnumerable? activeOwnerResponsibleTypeIds = nu /// public bool HasAnyRecipientOption() { - return OtherAddresses || OwnerResponsibleTypeIds.Count > 0; + return Requester || OtherAddresses || OwnerResponsibleTypeIds.Count > 0; } /// @@ -104,6 +107,7 @@ private EmailRecipientSelection Sanitize(IEnumerable? activeOwnerResponsibl .Select(address => address.Trim()) .Distinct(StringComparer.OrdinalIgnoreCase) .ToList(), + Requester = Requester, EnsureAtLeastOneNotification = EnsureAtLeastOneNotification, OwnerResponsibleTypeIds = OwnerResponsibleTypeIds .Where(id => id > 0) @@ -130,7 +134,7 @@ private EmailRecipientSelection Sanitize(IEnumerable? activeOwnerResponsibl sanitized.OtherAddresses = false; } - sanitized.None = !sanitized.OtherAddresses && sanitized.OwnerResponsibleTypeIds.Count == 0; + sanitized.None = !sanitized.Requester && !sanitized.OtherAddresses && sanitized.OwnerResponsibleTypeIds.Count == 0; if (sanitized.None) { sanitized.EnsureAtLeastOneNotification = false; diff --git a/roles/lib/files/FWO.Data/FwoNotification.cs b/roles/lib/files/FWO.Data/FwoNotification.cs index fdb54a7e93..473d392f8e 100644 --- a/roles/lib/files/FWO.Data/FwoNotification.cs +++ b/roles/lib/files/FWO.Data/FwoNotification.cs @@ -209,7 +209,7 @@ public static List OfferedDeadlineOptions(NotificationClie NotificationClient.Recertification => [NotificationDeadline.RecertDate], NotificationClient.ImportChange => [NotificationDeadline.None], NotificationClient.RuleTimer => [NotificationDeadline.RuleExpiry], - NotificationClient.InterfaceRequest => [NotificationDeadline.RequestDate], + NotificationClient.InterfaceRequest => [NotificationDeadline.None, NotificationDeadline.RequestDate], NotificationClient.AppDecomm => [NotificationDeadline.None, NotificationDeadline.DecommissionDate], NotificationClient.WfAction => [NotificationDeadline.None], _ => Enum.GetValues(typeof(NotificationDeadline)).Cast().ToList() diff --git a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs index cd8c159c3c..9f55edde77 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs @@ -74,17 +74,24 @@ public virtual async Task Init(string? scopedUserTo = null, string? scopedUserCc ScopedUserEmailBcc = scopedUserEmailBcc; } - public virtual async Task SendEmailToOwnerResponsibles(FwoOwner owner, string subject, string body, EmailRecipientOption recOpt, bool reqInCc = false) - { - List? requester = reqInCc ? new() { GetEmailAddress(userConfig.User.Dn) } : null; - return await SendEmail(await GetRecipients(recOpt, null, owner, null, null), subject, body, requester); - } - - public virtual async Task SendEmailToOwnerResponsibles(FwoOwner owner, string subject, string body, string recipientConfig, bool reqInCc = false, List? otherAddresses = null) - { - List? requester = reqInCc ? new() { GetEmailAddress(userConfig.User.Dn) } : null; - List recipients = await GetRecipients(recipientConfig, owner, otherAddresses); - return await SendEmail(recipients, subject, body, requester); + /// + /// Sends a notification email using the notification recipient fields. + /// + /// Notification template and recipient configuration. + /// Owner context used to resolve configured responsibles. + /// Rendered notification subject. + /// Rendered notification body. + /// True when an email was sent; otherwise false. + public virtual async Task SendEmailToNotificationRecipients(FwoNotification notification, FwoOwner? owner, string subject, string body) + { + List tos = await GetNotificationRecipients(notification.RecipientTo, notification.EmailAddressTo, owner); + List? ccs = notification.RecipientCc == EmailRecipientOption.None + ? null + : await GetNotificationRecipients(notification.RecipientCc, notification.EmailAddressCc, owner); + List? bccs = notification.RecipientBcc == EmailRecipientOption.None + ? null + : await GetNotificationRecipients(notification.RecipientBcc, notification.EmailAddressBcc, owner); + return await SendEmail(tos, subject, body, ccs, bccs, notification.Layout == NotificationLayout.HtmlInBody); } /// @@ -135,7 +142,7 @@ private static WfStatefulObject AssignedGroupRecipientContext(EmailRecipientOpti return new WfStatefulObject(statefulObject) { AssignedGroup = assignedGroupDn }; } - private async Task SendEmail(List tos, string subject, string body, List? ccs = null, List? bccs = null, + protected virtual async Task SendEmail(List tos, string subject, string body, List? ccs = null, List? bccs = null, bool mailFormatHtml = true, FormFile? attachment = null) { EmailConnection emailConnection = new(userConfig.EmailServerAddress, userConfig.EmailPort, @@ -244,6 +251,7 @@ public async Task> GetRecipients(EmailRecipientSelection selection, HashSet recipients = new(StringComparer.OrdinalIgnoreCase); AddOtherAddresses(selection, otherAddresses, recipients); + AddRequesterRecipients(selection, recipients); if (owner != null) { await AddOwnerTypeRecipients(owner, selection.OwnerResponsibleTypeIds.Distinct(), recipients); @@ -259,6 +267,24 @@ public async Task> GetRecipients(string recipientConfig, FwoOwner? return await GetRecipients(selection, owner, otherAddresses); } + private async Task> GetNotificationRecipients(EmailRecipientOption recipientOption, string addressList, FwoOwner? owner) + { + if (recipientOption == EmailRecipientOption.ConfiguredResponsibles) + { + return await GetRecipients(addressList, owner, null); + } + if (recipientOption == EmailRecipientOption.OtherAddresses && LooksLikeRecipientSelectionJson(addressList)) + { + return await GetRecipients(addressList, null, null); + } + return await GetRecipients(recipientOption, null, owner, null, SplitAddresses(addressList)); + } + + private static bool LooksLikeRecipientSelectionJson(string? recipientValue) + { + return recipientValue?.TrimStart().StartsWith('{') == true; + } + private static void AddOtherAddresses(EmailRecipientSelection selection, List? otherAddresses, HashSet recipients) { if (selection.OtherAddresses) @@ -268,6 +294,14 @@ private static void AddOtherAddresses(EmailRecipientSelection selection, List recipients) + { + if (selection.Requester && !string.IsNullOrWhiteSpace(userConfig.User.Email)) + { + AddAddresses(recipients, new List { userConfig.User.Email }); + } + } + private async Task AddOwnerTypeRecipients(FwoOwner owner, IEnumerable responsibleTypeIds, HashSet recipients) { foreach (int responsibleTypeId in responsibleTypeIds) diff --git a/roles/lib/files/FWO.Services/EmailNotification/NotificationEmailLayoutHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/NotificationEmailLayoutHelper.cs index c45263a043..fd9c735358 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/NotificationEmailLayoutHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/NotificationEmailLayoutHelper.cs @@ -98,7 +98,7 @@ private static string ResolveContent(NotificationLayout layout, string? content) : content; } - private static async Task ToPdf(string html) + internal static async Task ToPdf(string html) { OperatingSystem os = Environment.OSVersion; string path = os.Platform == PlatformID.Unix ? GlobalConst.ChromeBinPathLinux : ""; diff --git a/roles/lib/files/FWO.Services/EmailNotification/NotificationPlaceholderResolver.cs b/roles/lib/files/FWO.Services/EmailNotification/NotificationPlaceholderResolver.cs index 0e38de5cb5..5881672c48 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/NotificationPlaceholderResolver.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/NotificationPlaceholderResolver.cs @@ -9,6 +9,28 @@ namespace FWO.Services /// public static class NotificationPlaceholderResolver { + /// + /// Carries the values required to resolve notification placeholders. + /// Callers populate the data they have; the resolver decides how to render it. + /// + public sealed record NotificationPlaceholderValues + { + public FwoOwner Application { get; init; } = new(); + public FwoOwner? RequestingOwner { get; init; } + public string InterfaceName { get; init; } = ""; + public string InterfaceLinkText { get; init; } = ""; + public string InterfaceLinkName { get; init; } = ""; + public string InterfaceLinkUrl { get; init; } = ""; + public string NewInterfaceName { get; init; } = ""; + public string NewInterfaceLinkText { get; init; } = ""; + public string NewInterfaceLinkName { get; init; } = ""; + public string NewInterfaceLinkUrl { get; init; } = ""; + public string Reason { get; init; } = ""; + public string UserName { get; init; } = ""; + public string RequesterName { get; init; } = ""; + public string RequestDate { get; init; } = ""; + } + /// /// Replaces owner and time interval placeholders. /// @@ -29,6 +51,26 @@ public static string ReplaceWorkflowPlaceholders(string text, WfStatefulObject s .Replace(Placeholder.REQUESTER, GetRequesterName(statefulObject)); } + /// + /// Replaces notification placeholders. + /// + public static string ReplaceNotificationPlaceholders(string text, NotificationPlaceholderValues values, bool renderHtmlLinks = false) + { + return text + .Replace(Placeholder.APPNAME, values.Application.Name ?? "") + .Replace(Placeholder.APPID, values.Application.ExtAppId ?? "") + .Replace(Placeholder.REQUESTING_APPNAME, values.RequestingOwner?.Name ?? "") + .Replace(Placeholder.REQUESTING_APPID, values.RequestingOwner?.ExtAppId ?? "") + .Replace(Placeholder.REQUESTER, FirstNonEmpty(values.RequesterName, values.RequestingOwner?.Name)) + .Replace(Placeholder.REQUESTDATE, values.RequestDate) + .Replace(Placeholder.INTERFACE_NAME, values.InterfaceName) + .Replace(Placeholder.INTERFACE_LINK, RenderLink(values.InterfaceLinkUrl, values.InterfaceLinkText, values.InterfaceLinkName, renderHtmlLinks)) + .Replace(Placeholder.NEW_INTERFACE_NAME, values.NewInterfaceName) + .Replace(Placeholder.NEW_INTERFACE_LINK, RenderLink(values.NewInterfaceLinkUrl, values.NewInterfaceLinkText, values.NewInterfaceLinkName, renderHtmlLinks)) + .Replace(Placeholder.REASON, values.Reason) + .Replace(Placeholder.USER_NAME, values.UserName); + } + private static FwoOwner? GetWorkflowOwner(WfStatefulObject statefulObject) { return statefulObject switch @@ -52,5 +94,31 @@ private static string FirstNonEmpty(params string?[] values) { return values.FirstOrDefault(value => !string.IsNullOrWhiteSpace(value)) ?? ""; } + + private static string RenderLink(string url, string text, string linkName, bool renderHtmlLinks) + { + if (string.IsNullOrWhiteSpace(url)) + { + return ""; + } + + if (!renderHtmlLinks) + { + return url; + } + + string displayText = string.IsNullOrWhiteSpace(text) ? linkName : text; + if (string.IsNullOrWhiteSpace(displayText)) + { + return url; + } + + if (string.IsNullOrWhiteSpace(linkName)) + { + return $"{displayText}"; + } + + return $"{displayText}: {linkName}"; + } } } diff --git a/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs new file mode 100644 index 0000000000..c43148f105 --- /dev/null +++ b/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs @@ -0,0 +1,114 @@ +using FWO.Basics; +using FWO.Data; +using FWO.Logging; + +namespace FWO.Services +{ + /// + /// Evaluates notification schedules against the current date. + /// + public static class NotificationScheduleHelper + { + /// + /// Returns whether the notification is due for sending at the current time. + /// + /// Owner context used for owner-based deadlines. + /// External deadline date, for example a request creation time. + /// Notification to evaluate. + /// True when the notification should be sent now. + public static bool IsNotificationDue(FwoOwner? owner, DateTime? extDeadline, FwoNotification notification) + { + if (notification.Deadline == NotificationDeadline.None) + { + return true; + } + + DateTime deadline = GetDeadlineDate(notification.Deadline, owner, extDeadline); + return deadline.Date >= DateTime.Now.Date + ? IsNotificationDueBeforeDeadline(deadline, notification) + : IsNotificationDueAfterDeadline(deadline, notification); + } + + private static bool IsTimeToSend(DateTime? lastSent, DateTime notifDate) + { + return (lastSent == null || ((DateTime)lastSent).Date < notifDate.Date) && notifDate.Date <= DateTime.Now.Date; + } + + private static bool TryGetConfiguredInterval(SchedulerInterval? interval, string propertyName, out SchedulerInterval configuredInterval) + { + if (interval != null) + { + configuredInterval = (SchedulerInterval)interval; + return true; + } + + Log.WriteWarning("Notifications", $"Notification interval '{propertyName}' is not configured. Skipping due evaluation."); + configuredInterval = default; + return false; + } + + private static bool IsNotificationDueBeforeDeadline(DateTime deadline, FwoNotification notification) + { + if (!TryGetConfiguredInterval(notification.IntervalBeforeDeadline, nameof(notification.IntervalBeforeDeadline), out SchedulerInterval intervalBeforeDeadline)) + { + return false; + } + + DateTime notifDate = ApplyIntervalOffset(deadline, intervalBeforeDeadline, -(int)(notification.OffsetBeforeDeadline ?? 0)); + return IsTimeToSend(notification.LastSent, notifDate); + } + + private static bool IsNotificationDueAfterDeadline(DateTime deadline, FwoNotification notification) + { + if (!TryGetConfiguredInterval(notification.RepeatIntervalAfterDeadline, nameof(notification.RepeatIntervalAfterDeadline), out SchedulerInterval repeatIntervalAfterDeadline)) + { + return false; + } + + DateTime nextNotifDate = ApplyIntervalOffset(deadline.Date, repeatIntervalAfterDeadline, (int)(notification.InitialOffsetAfterDeadline ?? 0)); + DateTime currentNotifDate = nextNotifDate; + int counter = -1; + while (nextNotifDate <= DateTime.Now.Date && counter++ <= notification.RepetitionsAfterDeadline) + { + currentNotifDate = nextNotifDate; + nextNotifDate = ApplyIntervalOffset(nextNotifDate, repeatIntervalAfterDeadline, (int)(notification.RepeatOffsetAfterDeadline ?? 0)); + } + + return counter <= notification.RepetitionsAfterDeadline && IsTimeToSend(notification.LastSent, currentNotifDate); + } + + private static DateTime GetDeadlineDate(NotificationDeadline deadline, FwoOwner? owner, DateTime? extDeadline) + { + if (deadline == NotificationDeadline.RecertDate && owner?.NextRecertDate != null) + { + return (DateTime)owner.NextRecertDate; + } + else if (deadline == NotificationDeadline.RequestDate && extDeadline != null) + { + return (DateTime)extDeadline; + } + else if (deadline == NotificationDeadline.RuleExpiry && extDeadline != null) + { + return (DateTime)extDeadline; + } + else if (deadline == NotificationDeadline.DecommissionDate && owner?.DecommDate != null) + { + return (DateTime)owner.DecommDate; + } + return DateTime.Now; + } + + private static DateTime ApplyIntervalOffset(DateTime dateTime, SchedulerInterval interval, long value) + { + return interval switch + { + SchedulerInterval.Minutes => dateTime.AddMinutes(value), + SchedulerInterval.Hours => dateTime.AddHours(value), + SchedulerInterval.Days => dateTime.AddDays(value), + SchedulerInterval.Weeks => dateTime.AddDays(value * GlobalConst.kDaysPerWeek), + SchedulerInterval.Months => dateTime.AddMonths((int)value), + _ => throw new NotSupportedException("Time interval is not supported.") + }; + } + } +} diff --git a/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs b/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs index a5313d3fbc..3f3df125ed 100644 --- a/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs +++ b/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs @@ -91,11 +91,13 @@ public async Task DecommissionInterface(string reason, bool proposeAlternative, await Save(true, true); await RemoveFromAllSelections(); - List appsToNotify = []; - if (!string.IsNullOrWhiteSpace(userConfig.ModDecommEmailReceiver) - && !userConfig.ModDecommEmailReceiver.Equals(nameof(EmailRecipientOption.None), StringComparison.Ordinal)) + List appsToNotify = UsingConnections + .Where(c => c.AppId != null && c.AppId != ActConn.AppId) + .Select(c => c.App) + .Distinct() + .ToList(); + if (appsToNotify.Count > 0) { - appsToNotify = UsingConnections.Where(c => c.AppId != null && c.AppId != ActConn.AppId).Select(c => c.App).Distinct().ToList(); await NotifyUsers(appsToNotify, reason, proposedInterface, middlewareClient); } @@ -109,23 +111,25 @@ protected virtual async Task NotifyUsers(List appsToNotify, string rea { EmailHelper emailHelper = CreateEmailHelper(middlewareClient); await emailHelper.Init(); - - string subject = userConfig.ModDecommEmailSubject.Replace(Placeholder.INTERFACE_NAME, ActConn.Name); + List decommissionNotifications = await LoadImmediateDecommissionNotifications(); + if (decommissionNotifications.Count == 0) + { + Log.WriteWarning("Modelling Interface Decommission", "No immediate app decommission notifications configured. Skipping email send."); + return; + } int successCount = 0; int failCount = 0; - List legacyOtherAddresses = EmailHelper.SplitAddresses(userConfig.ModDecommEmailOtherAddresses); foreach (var app in appsToNotify) { - if (await emailHelper.SendEmailToOwnerResponsibles(app, subject, ConstructBody(app, reason, proposedInterface), - userConfig.ModDecommEmailReceiver, false, legacyOtherAddresses)) - { - successCount++; - } - else - { - failCount++; - } + (int appSuccessCount, int appFailCount) = await SendDecommissionNotificationsForApp( + emailHelper, + decommissionNotifications, + app, + reason, + proposedInterface); + successCount += appSuccessCount; + failCount += appFailCount; } if (successCount > 0) { @@ -144,23 +148,93 @@ protected virtual async Task NotifyUsers(List appsToNotify, string rea } } + private async Task> LoadImmediateDecommissionNotifications() + { + List notifications = await apiConnection.SendQueryAsync>(NotificationQueries.getNotifications, + new { client = NotificationClient.AppDecomm.ToString() }); + return notifications.Where(notification => notification.Deadline == NotificationDeadline.None).ToList(); + } + + private async Task<(int successCount, int failCount)> SendDecommissionNotificationsForApp( + EmailHelper emailHelper, + List decommissionNotifications, + FwoOwner app, + string reason, + ModellingConnection? proposedInterface) + { + int successCount = 0; + int failCount = 0; + foreach (FwoNotification notification in decommissionNotifications.Where(notification => notification.OwnerId == null || notification.OwnerId == app.Id)) + { + string subject = RenderDecommissionPlaceholders(notification.EmailSubject, app, reason, proposedInterface); + string body = RenderDecommissionBody(notification, app, reason, proposedInterface); + if (await emailHelper.SendEmailToNotificationRecipients(notification, app, subject, body)) + { + successCount++; + } + else + { + failCount++; + } + } + + return (successCount, failCount); + } + protected virtual EmailHelper CreateEmailHelper(MiddlewareClient middlewareClient) { return new EmailHelper(apiConnection, middlewareClient, userConfig, DisplayMessageInUi); } - private string ConstructBody(FwoOwner app, string reason, ModellingConnection? proposedInterface) + private string RenderDecommissionPlaceholders(string text, FwoOwner app, string reason, ModellingConnection? proposedInterface) + { + NotificationPlaceholderResolver.NotificationPlaceholderValues placeholderValues = CreateDecommissionPlaceholderValues(app, reason, proposedInterface); + return NotificationPlaceholderResolver.ReplaceNotificationPlaceholders(text ?? "", placeholderValues, renderHtmlLinks: false); + } + + private string RenderDecommissionBody(FwoNotification notification, FwoOwner app, string reason, ModellingConnection? proposedInterface) + { + string body = RenderDecommissionBodyPlaceholders(notification.EmailBody, app, reason, proposedInterface); + string connList = string.Join(notification.Layout == NotificationLayout.HtmlInBody ? "
    " : Environment.NewLine, + UsingConnections.Where(c => c.AppId != null && c.AppId == app.Id).Select(a => a.Name)); + if (string.IsNullOrWhiteSpace(connList)) + { + return body; + } + + return notification.Layout == NotificationLayout.HtmlInBody + ? $"{body}
    {connList}" + : $"{body}{Environment.NewLine}{connList}"; + } + + private string RenderDecommissionBodyPlaceholders(string text, FwoOwner app, string reason, ModellingConnection? proposedInterface) + { + NotificationPlaceholderResolver.NotificationPlaceholderValues placeholderValues = CreateDecommissionPlaceholderValues(app, reason, proposedInterface); + return NotificationPlaceholderResolver.ReplaceNotificationPlaceholders(text ?? "", placeholderValues, renderHtmlLinks: true); + } + + private NotificationPlaceholderResolver.NotificationPlaceholderValues CreateDecommissionPlaceholderValues( + FwoOwner app, + string reason, + ModellingConnection? proposedInterface) { - string interfaceUrl = $"{userConfig.UiHostName}/{PageName.Modelling}/{proposedInterface?.App.ExtAppId}/{proposedInterface?.Id}"; - string interfacelink = $"{userConfig.GetText("interface")}: {proposedInterface?.Name}
    "; - string body = userConfig.ModDecommEmailBody - .Replace(Placeholder.INTERFACE_NAME, $"{ActConn.Name}") - .Replace(Placeholder.NEW_INTERFACE_NAME, $"{proposedInterface?.Name}") - .Replace(Placeholder.NEW_INTERFACE_LINK, $"{interfacelink}") - .Replace(Placeholder.REASON, $"{reason}") - .Replace(Placeholder.USER_NAME, $"{userConfig.User.Name}"); - string connList = string.Join("
    ", UsingConnections.Where(c => c.AppId != null && c.AppId == app.Id).Select(a => a.Name)); - return $"{body}
    {connList}"; + string proposedInterfaceUrl = proposedInterface == null + ? "" + : $"{userConfig.UiHostName}/{PageName.Modelling}/{proposedInterface.App.ExtAppId}/{proposedInterface.Id}"; + return new NotificationPlaceholderResolver.NotificationPlaceholderValues + { + Application = app, + InterfaceName = ActConn.Name ?? "", + NewInterfaceName = proposedInterface?.Name ?? "", + InterfaceLinkText = userConfig.GetText("interface"), + InterfaceLinkName = proposedInterface?.Name ?? "", + InterfaceLinkUrl = proposedInterfaceUrl, + NewInterfaceLinkText = userConfig.GetText("interface"), + NewInterfaceLinkName = proposedInterface?.Name ?? "", + NewInterfaceLinkUrl = proposedInterfaceUrl, + Reason = reason, + UserName = userConfig.User.Name + }; } private async Task AddToSelections(bool proposeAlternative, ModellingConnection? proposedInterface, List appsToNotify) diff --git a/roles/lib/files/FWO.Services/Properties/AssemblyInfo.cs b/roles/lib/files/FWO.Services/Properties/AssemblyInfo.cs new file mode 100644 index 0000000000..7271a539c7 --- /dev/null +++ b/roles/lib/files/FWO.Services/Properties/AssemblyInfo.cs @@ -0,0 +1,3 @@ +using System.Runtime.CompilerServices; + +[assembly: InternalsVisibleTo("FWO.Test")] diff --git a/roles/middleware/files/FWO.Middleware.Server/Jobs/DailyCheckJob.cs b/roles/middleware/files/FWO.Middleware.Server/Jobs/DailyCheckJob.cs index 4e501c6ec1..dce98e2594 100644 --- a/roles/middleware/files/FWO.Middleware.Server/Jobs/DailyCheckJob.cs +++ b/roles/middleware/files/FWO.Middleware.Server/Jobs/DailyCheckJob.cs @@ -274,7 +274,7 @@ private async Task CheckUnansweredInterfaceRequests() continue; } - int sentForTicket = await notificationService.SendNotification(notification, owner, await PrepareBody(ticket, owner)); + int sentForTicket = await notificationService.SendNotification(notification, owner, await PrepareBody(notification, ticket, owner)); emailsSent += sentForTicket; if (sentForTicket == 0) { @@ -320,19 +320,29 @@ private static long GetMaximumCutOffPeriod(SchedulerInterval interval) }; } - private async Task PrepareBody(WfTicket ticket, FwoOwner owner) + private async Task PrepareBody(FwoNotification notification, WfTicket ticket, FwoOwner owner) { WfReqTask? reqTask = ticket.Tasks.FirstOrDefault(r => r.TaskType == WfTaskType.new_interface.ToString()); FwoOwner? requestingOwner = await GetRequestingOwner(reqTask?.GetAddInfoIntValue(AdditionalInfoKeys.ReqOwner)); - - return globalConfig.ModUnansweredReqEmailBody - .Replace(Placeholder.REQUESTER, ticket.Requester?.Name) - .Replace(Placeholder.REQUESTDATE, ticket.CreationDate.ToString("dd.MM.yyyy")) - .Replace(Placeholder.REQUESTING_APPNAME, requestingOwner?.Name) - .Replace(Placeholder.REQUESTING_APPID, requestingOwner?.ExtAppId) - .Replace(Placeholder.APPNAME, owner.Name) - .Replace(Placeholder.APPID, owner.ExtAppId) - .Replace(Placeholder.INTERFACE_LINK, ConstructLink(owner, reqTask)); + FwoOwner effectiveRequestingOwner = requestingOwner ?? new FwoOwner(); + string interfaceName = reqTask?.Title ?? globalConfig.GetText("interface"); + string interfaceUrl = ConstructLink(owner, reqTask); + NotificationPlaceholderResolver.NotificationPlaceholderValues requestPlaceholderValues = new() + { + Application = owner, + RequestingOwner = effectiveRequestingOwner, + InterfaceName = interfaceName, + InterfaceLinkText = globalConfig.GetText("request_interface"), + InterfaceLinkUrl = interfaceUrl, + NewInterfaceName = interfaceName, + NewInterfaceLinkText = globalConfig.GetText("request_interface"), + NewInterfaceLinkUrl = interfaceUrl, + Reason = "", + UserName = ticket.Requester?.Name ?? "", + RequesterName = ticket.Requester?.Name ?? ticket.RequesterDn ?? "", + RequestDate = ticket.CreationDate.ToString("dd.MM.yyyy") + }; + return NotificationPlaceholderResolver.ReplaceNotificationPlaceholders(notification.EmailBody, requestPlaceholderValues, renderHtmlLinks: true); } private async Task GetRequestingOwner(int? ownerId) @@ -355,8 +365,7 @@ private async Task PrepareBody(WfTicket ticket, FwoOwner owner) private string ConstructLink(FwoOwner owner, WfReqTask? reqTask) { int? connId = reqTask?.GetAddInfoIntValue(AdditionalInfoKeys.ConnId); - string interfaceUrl = $"{globalConfig.UiHostName}/{PageName.Modelling}/{owner.ExtAppId}/{connId}"; - return $"{reqTask?.Title ?? globalConfig.GetText("interface")}"; + return $"{globalConfig.UiHostName}/{PageName.Modelling}/{owner.ExtAppId}/{connId}"; } } } diff --git a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs index c537862acc..836dddd424 100644 --- a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs +++ b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs @@ -210,96 +210,7 @@ public async Task UpdateNotificationsLastSent() /// True if the notification should be sent now; otherwise false. public static bool IsNotificationDue(FwoOwner? owner, DateTime? extDeadline, FwoNotification notification) { - if (notification.Deadline == NotificationDeadline.None) - { - return true; - } - - DateTime deadline = GetDeadlineDate(notification.Deadline, owner, extDeadline); - - return deadline >= DateTime.Now - ? IsNotificationDueBeforeDeadline(deadline, notification) - : IsNotificationDueAfterDeadline(deadline, notification); - } - - private static bool IsTimeToSend(DateTime? lastSent, DateTime notifDate) - { - return (lastSent == null || ((DateTime)lastSent).Date < notifDate.Date) && notifDate.Date <= DateTime.Now.Date; - } - - private static bool TryGetConfiguredInterval(SchedulerInterval? interval, string propertyName, out SchedulerInterval configuredInterval) - { - if (interval != null) - { - configuredInterval = (SchedulerInterval)interval; - return true; - } - - Log.WriteWarning("Notifications", $"Notification interval '{propertyName}' is not configured. Skipping due evaluation."); - configuredInterval = default; - return false; - } - - private static bool IsNotificationDueBeforeDeadline(DateTime deadline, FwoNotification notification) - { - if (!TryGetConfiguredInterval(notification.IntervalBeforeDeadline, nameof(notification.IntervalBeforeDeadline), out SchedulerInterval intervalBeforeDeadline)) - { - return false; - } - - DateTime notifDate = ApplyIntervalOffset(deadline, intervalBeforeDeadline, -notification.OffsetBeforeDeadline ?? 0); - return IsTimeToSend(notification.LastSent, notifDate); - } - - private static bool IsNotificationDueAfterDeadline(DateTime deadline, FwoNotification notification) - { - if (!TryGetConfiguredInterval(notification.RepeatIntervalAfterDeadline, nameof(notification.RepeatIntervalAfterDeadline), out SchedulerInterval repeatIntervalAfterDeadline)) - { - return false; - } - - DateTime nextNotifDate = ApplyIntervalOffset(deadline.Date, repeatIntervalAfterDeadline, notification.InitialOffsetAfterDeadline ?? 0); - DateTime currentNotifDate = nextNotifDate; - int counter = -1; - while (nextNotifDate <= DateTime.Now.Date && counter++ <= notification.RepetitionsAfterDeadline) - { - currentNotifDate = nextNotifDate; - nextNotifDate = ApplyIntervalOffset(nextNotifDate, repeatIntervalAfterDeadline, notification.RepeatOffsetAfterDeadline ?? 0); - } - - return counter <= notification.RepetitionsAfterDeadline && IsTimeToSend(notification.LastSent, currentNotifDate); - } - - private static DateTime ApplyIntervalOffset(DateTime value, SchedulerInterval interval, int offset) - { - return interval switch - { - SchedulerInterval.Days => value.AddDays(offset), - SchedulerInterval.Weeks => value.AddDays(offset * GlobalConst.kDaysPerWeek), - SchedulerInterval.Months => value.AddMonths(offset), - _ => throw new NotSupportedException("Time interval is not supported.") - }; - } - - private static DateTime GetDeadlineDate(NotificationDeadline deadline, FwoOwner? owner, DateTime? extDeadline) - { - if (deadline == NotificationDeadline.RecertDate && owner?.NextRecertDate != null) - { - return (DateTime)owner.NextRecertDate; - } - else if (deadline == NotificationDeadline.RequestDate && extDeadline != null) - { - return (DateTime)extDeadline; - } - else if (deadline == NotificationDeadline.RuleExpiry && extDeadline != null) - { - return (DateTime)extDeadline; - } - else if (deadline == NotificationDeadline.DecommissionDate && owner?.DecommDate != null) - { - return (DateTime)owner.DecommDate; - } - return DateTime.Now; + return NotificationScheduleHelper.IsNotificationDue(owner, extDeadline, notification); } /// diff --git a/roles/tests-unit/files/FWO.Test/DailyCheckJobTest.cs b/roles/tests-unit/files/FWO.Test/DailyCheckJobTest.cs index a290ca763d..f7339951d9 100644 --- a/roles/tests-unit/files/FWO.Test/DailyCheckJobTest.cs +++ b/roles/tests-unit/files/FWO.Test/DailyCheckJobTest.cs @@ -407,8 +407,7 @@ public async Task CheckUnansweredInterfaceRequests_LogsWarningAndSkipsTicketWith SimulatedGlobalConfig globalConfig = new() { UseDummyEmailAddress = true, - DummyEmailAddress = "dummy@example.test", - ModUnansweredReqEmailBody = "body" + DummyEmailAddress = "dummy@example.test" }; DailyCheckJob dailyCheckJob = new(apiConnection, globalConfig); MethodInfo checkUnansweredInterfaceRequests = typeof(DailyCheckJob).GetMethod("CheckUnansweredInterfaceRequests", BindingFlags.Instance | BindingFlags.NonPublic) @@ -456,8 +455,7 @@ public async Task CheckUnansweredInterfaceRequests_SendsDueNotificationForOwnedT SimulatedGlobalConfig globalConfig = new() { UseDummyEmailAddress = true, - DummyEmailAddress = "dummy@example.test", - ModUnansweredReqEmailBody = "body" + DummyEmailAddress = "dummy@example.test" }; DailyCheckJob dailyCheckJob = new(apiConnection, globalConfig); MethodInfo checkUnansweredInterfaceRequests = typeof(DailyCheckJob).GetMethod("CheckUnansweredInterfaceRequests", BindingFlags.Instance | BindingFlags.NonPublic) @@ -506,8 +504,7 @@ public async Task CheckUnansweredInterfaceRequests_LogsWarningWhenRecipientsCann SimulatedGlobalConfig globalConfig = new() { UseDummyEmailAddress = false, - DummyEmailAddress = "dummy@example.test", - ModUnansweredReqEmailBody = "body" + DummyEmailAddress = "dummy@example.test" }; DailyCheckJob dailyCheckJob = new(apiConnection, globalConfig); MethodInfo checkUnansweredInterfaceRequests = typeof(DailyCheckJob).GetMethod("CheckUnansweredInterfaceRequests", BindingFlags.Instance | BindingFlags.NonPublic) @@ -600,7 +597,7 @@ public void ConstructLink_ReturnsExpectedModellingUrl() string link = (string)(constructLink.Invoke(dailyCheckJob, [owner, reqTask]) ?? throw new InvalidOperationException("ConstructLink returned null.")); - Assert.That(link, Is.EqualTo($"Interface Request")); + Assert.That(link, Is.EqualTo($"https://fwo.example/{PageName.Modelling}/APP-42/123")); } [Test] @@ -618,7 +615,7 @@ public void ConstructLink_UsesLocalizedFallbackTitle_WhenTaskTitleIsMissing() string link = (string)(constructLink.Invoke(dailyCheckJob, [owner, null]) ?? throw new InvalidOperationException("ConstructLink returned null.")); - Assert.That(link, Is.EqualTo($"Interface")); + Assert.That(link, Is.EqualTo($"https://fwo.example/{PageName.Modelling}/APP-42/")); } [Test] @@ -631,7 +628,7 @@ public async Task PrepareBody_ReplacesAllKnownPlaceholders() SimulatedGlobalConfig globalConfig = new() { UiHostName = "https://fwo.example", - ModUnansweredReqEmailBody = string.Join("|", ExpectedModUnansweredReqEmailBodyPlaceholders) + ModReqInterfaceName = "Interface" }; DailyCheckJob dailyCheckJob = new(apiConnection, globalConfig); MethodInfo prepareBody = typeof(DailyCheckJob).GetMethod("PrepareBody", BindingFlags.Instance | BindingFlags.NonPublic) @@ -651,12 +648,62 @@ public async Task PrepareBody_ReplacesAllKnownPlaceholders() }; FwoOwner owner = new() { Name = "Owner A", ExtAppId = "APP-42" }; - Task task = (Task)(prepareBody.Invoke(dailyCheckJob, [ticket, owner]) + FwoNotification notification = new() + { + EmailBody = string.Join("|", ExpectedModUnansweredReqEmailBodyPlaceholders) + }; + Task task = (Task)(prepareBody.Invoke(dailyCheckJob, [notification, ticket, owner]) ?? throw new InvalidOperationException("PrepareBody returned null task.")); string body = await task; Assert.That(body, Is.EqualTo( - $"Requester A|02.01.2025|Requesting App|REQ-7|Owner A|APP-42|Interface Request")); + $"Requester A|02.01.2025|Requesting App|REQ-7|Owner A|APP-42|Request Interface")); + } + + [Test] + public async Task PrepareBody_UsesFallbackValuesWhenRequestContextIsIncomplete() + { + OwnerLookupApiConnection apiConnection = new(); + SimulatedGlobalConfig globalConfig = new() + { + UiHostName = "https://fwo.example", + ModReqInterfaceName = "Interface" + }; + DailyCheckJob dailyCheckJob = new(apiConnection, globalConfig); + MethodInfo prepareBody = typeof(DailyCheckJob).GetMethod("PrepareBody", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("PrepareBody method not found."); + WfReqTask reqTask = new() + { + Title = "Interface Request", + TaskType = WfTaskType.new_interface.ToString() + }; + reqTask.SetAddInfo(AdditionalInfoKeys.ConnId, "123"); + WfTicket ticket = new() + { + CreationDate = new DateTime(2025, 1, 2), + Requester = new UiUser { Name = "Requester A", Dn = "cn=requester,dc=test" }, + Tasks = new List { reqTask } + }; + FwoOwner owner = new() { Name = "Owner A", ExtAppId = "APP-42" }; + FwoNotification notification = new() + { + EmailBody = string.Join("|", new List + { + Placeholder.REQUESTER, + Placeholder.INTERFACE_NAME, + Placeholder.REQUESTING_APPNAME, + Placeholder.REQUESTING_APPID, + Placeholder.USER_NAME, + Placeholder.REQUESTDATE, + Placeholder.INTERFACE_LINK + }) + }; + + string body = await (Task)(prepareBody.Invoke(dailyCheckJob, new object?[] { notification, ticket, owner }) + ?? throw new InvalidOperationException("PrepareBody returned null task.")); + + Assert.That(body, Is.EqualTo( + $"Requester A|Interface Request|||Requester A|02.01.2025|Request Interface")); } [Test] diff --git a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs index 2960059481..930c6bf64c 100644 --- a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs +++ b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs @@ -73,6 +73,180 @@ public async Task GetRecipientsReturnsDummyForFallbackSelection() Assert.That(recipients, Is.EqualTo(kDummyRecipients)); } + [Test] + public async Task SendEmailToNotificationRecipients_UsesNotificationRecipientsAndLayout() + { + SimulatedUserConfig userConfig = new() + { + UseDummyEmailAddress = false + }; + CapturingEmailHelper helper = new(userConfig); + SetPrivateField(helper, "uiUsers", new List + { + new() { Dn = "cn=main,dc=test", Email = "main@example.test" }, + new() { Dn = "cn=cc,dc=test", Email = "cc@example.test" }, + new() { Dn = "cn=bcc,dc=test", Email = "bcc@example.test" } + }); + + FwoOwner owner = new() + { + Name = "Selected", + ExtAppId = "APP-1" + }; + owner.AddOwnerResponsible(GlobalConst.kOwnerResponsibleTypeMain, "cn=main,dc=test"); + FwoNotification notification = new() + { + Layout = NotificationLayout.HtmlInBody, + RecipientTo = EmailRecipientOption.OwnerMainResponsible, + RecipientCc = EmailRecipientOption.OtherAddresses, + EmailAddressCc = "cc@example.test", + RecipientBcc = EmailRecipientOption.OtherAddresses, + EmailAddressBcc = "bcc@example.test", + EmailSubject = "Subject", + EmailBody = "Body" + }; + + bool sent = await helper.SendEmailToNotificationRecipients(notification, owner, "Rendered subject", "Rendered body"); + + Assert.Multiple(() => + { + Assert.That(sent, Is.True); + Assert.That(helper.CapturedTo, Is.EqualTo(new List { "main@example.test" })); + Assert.That(helper.CapturedCc, Is.EqualTo(new List { "cc@example.test" })); + Assert.That(helper.CapturedBcc, Is.EqualTo(new List { "bcc@example.test" })); + Assert.That(helper.CapturedSubject, Is.EqualTo("Rendered subject")); + Assert.That(helper.CapturedBody, Is.EqualTo("Rendered body")); + Assert.That(helper.CapturedMailFormatHtml, Is.True); + }); + } + + [Test] + public async Task SendEmailToNotificationRecipients_ResolvesRequesterCcFromNotificationSelection() + { + SimulatedUserConfig userConfig = new() + { + UseDummyEmailAddress = false + }; + userConfig.User.Email = "requester@example.test"; + CapturingEmailHelper helper = new(userConfig); + SetPrivateField(helper, "uiUsers", new List + { + new() { Dn = "cn=main,dc=test", Email = "main@example.test" }, + new() { Dn = "cn=cc,dc=test", Email = "cc@example.test" }, + }); + + FwoOwner owner = new() + { + Name = "Selected", + ExtAppId = "APP-1" + }; + owner.AddOwnerResponsible(GlobalConst.kOwnerResponsibleTypeMain, "cn=main,dc=test"); + EmailRecipientSelection ccSelection = new() + { + Requester = true, + OtherAddresses = true, + OtherAddressList = new List { "cc@example.test" } + }; + FwoNotification notification = new() + { + RecipientTo = EmailRecipientOption.OwnerMainResponsible, + RecipientCc = EmailRecipientOption.ConfiguredResponsibles, + EmailAddressCc = ccSelection.ToConfigValue(), + EmailSubject = "Subject", + EmailBody = "Body" + }; + + bool sent = await helper.SendEmailToNotificationRecipients(notification, owner, "Rendered subject", "Rendered body"); + + Assert.Multiple(() => + { + Assert.That(sent, Is.True); + Assert.That(helper.CapturedCc, Is.EqualTo(new List { "cc@example.test", "requester@example.test" })); + }); + } + + [Test] + public async Task SendWorkflowActionEmail_UsesWorkflowRecipientsAndPlaceholderObject() + { + SimulatedUserConfig userConfig = new() + { + UseDummyEmailAddress = false + }; + CapturingEmailHelper helper = new(userConfig); + SetPrivateField(helper, "ownerGroups", new List + { + new() + { + Dn = "cn=workflow-group,dc=test", + Users = + [ + new UiUser { Dn = "cn=group-user,dc=test" } + ] + } + }); + SetPrivateField(helper, "uiUsers", new List + { + new() { Dn = "cn=requester,dc=test", Email = "requester@example.test" }, + new() { Dn = "cn=group-user,dc=test", Email = "group@example.test" } + }); + SetPrivateField(helper, "ScopedUserTo", "cn=requester,dc=test"); + SetPrivateField(helper, "ScopedUserEmailTo", "requester@example.test"); + + FwoOwner owner = new() + { + Name = "Owner A", + ExtAppId = "APP-42" + }; + WfTicket placeholderTicket = new() + { + Requester = new UiUser + { + Name = "Requester A", + Dn = "cn=requester,dc=test" + }, + RequesterDn = "cn=requester,dc=test" + }; + FwoNotification notification = new() + { + Layout = NotificationLayout.HtmlAsAttachment, + RecipientTo = EmailRecipientOption.Requester, + RecipientCc = EmailRecipientOption.AssignedGroup, + RecipientBcc = EmailRecipientOption.OtherAddresses, + EmailAddressBcc = "bcc@example.test", + EmailSubject = $"{Placeholder.REQUESTER}|{Placeholder.APPNAME}|{Placeholder.APPID}", + EmailBody = $"Body:{Placeholder.REQUESTER}|{Placeholder.APPNAME}|{Placeholder.APPID}" + }; + WorkflowEmailContent workflowContent = new() + { + Html = "

    Workflow content

    ", + PlainText = "Workflow content", + Json = "{}", + Csv = "workflow" + }; + + bool sent = await helper.SendWorkflowActionEmail( + notification, + new WfStatefulObject(), + owner, + "cn=workflow-group,dc=test", + workflowContent, + placeholderTicket); + + Assert.Multiple(() => + { + Assert.That(sent, Is.True); + Assert.That(helper.CapturedTo, Is.EqualTo(new List { "requester@example.test" })); + Assert.That(helper.CapturedCc, Is.EqualTo(new List { "group@example.test" })); + Assert.That(helper.CapturedBcc, Is.EqualTo(new List { "bcc@example.test" })); + Assert.That(helper.CapturedSubject, Is.EqualTo("Requester A|Owner A|APP-42")); + Assert.That(helper.CapturedBody, Is.EqualTo("Body:Requester A|Owner A|APP-42")); + Assert.That(helper.CapturedMailFormatHtml, Is.False); + Assert.That(helper.CapturedAttachment, Is.Not.Null); + Assert.That(helper.CapturedAttachment!.ContentType, Is.EqualTo("application/html")); + Assert.That(helper.CapturedAttachment.FileName, Does.EndWith(".html")); + }); + } + [Test] public async Task GetRecipientsReturnsDummyForOtherAddressesOption() { @@ -993,6 +1167,34 @@ public override Task SendQueryAsync(string } } + private sealed class CapturingEmailHelper : EmailHelper + { + public List CapturedTo { get; private set; } = []; + public List? CapturedCc { get; private set; } + public List? CapturedBcc { get; private set; } + public string CapturedSubject { get; private set; } = ""; + public string CapturedBody { get; private set; } = ""; + public bool CapturedMailFormatHtml { get; private set; } + public FormFile? CapturedAttachment { get; private set; } + + public CapturingEmailHelper(UserConfig userConfig) + : base(new SimulatedApiConnection(), null, userConfig, DefaultInit.DoNothing) + { + } + + protected override Task SendEmail(List tos, string subject, string body, List? ccs = null, List? bccs = null, bool mailFormatHtml = true, Microsoft.AspNetCore.Http.FormFile? attachment = null) + { + CapturedTo = [.. tos]; + CapturedCc = ccs == null ? null : [.. ccs]; + CapturedBcc = bccs == null ? null : [.. bccs]; + CapturedSubject = subject; + CapturedBody = body; + CapturedMailFormatHtml = mailFormatHtml; + CapturedAttachment = attachment; + return Task.FromResult(true); + } + } + private static async Task CaptureConsoleAsync(Func action) { TextWriter originalOut = Console.Out; diff --git a/roles/tests-unit/files/FWO.Test/EmailNotificationContentTest.cs b/roles/tests-unit/files/FWO.Test/EmailNotificationContentTest.cs index 3fab5ea4c1..ace4c32262 100644 --- a/roles/tests-unit/files/FWO.Test/EmailNotificationContentTest.cs +++ b/roles/tests-unit/files/FWO.Test/EmailNotificationContentTest.cs @@ -6,6 +6,7 @@ using FWO.Services.Modelling; using Microsoft.AspNetCore.Http; using NUnit.Framework; +using System.Text; namespace FWO.Test { @@ -288,6 +289,17 @@ public async Task BuildAttachmentWithDelegatesUsesPdfLayoutAndNullForUnsupported Assert.That(unsupportedAttachment, Is.Null); } + [Test] + public async Task ToPdf_ReturnsBase64EncodedPdfData() + { + string? pdf = await NotificationEmailLayoutHelper.ToPdf("

    Title

    "); + + Assert.That(pdf, Is.Not.Null); + byte[] decodedPdf = Convert.FromBase64String(pdf!); + string header = Encoding.ASCII.GetString(decodedPdf, 0, Math.Min(4, decodedPdf.Length)); + Assert.That(header, Is.EqualTo("%PDF")); + } + [Test] public void ReplaceWorkflowPlaceholdersUsesTicketOwnerFallback() { @@ -351,6 +363,126 @@ public void ReplaceOwnerPlaceholdersReplacesAppAndTimeInterval() Assert.That(text, Is.EqualTo("Application/APP-3/14 days")); } + [Test] + public void ReplaceNotificationPlaceholdersReplacesRequestContext() + { + FwoOwner selectedOwner = new() + { + Name = "Selected", + ExtAppId = "APP-1" + }; + FwoOwner requestingOwner = new() + { + Name = "Requester", + ExtAppId = "APP-2" + }; + + string text = NotificationPlaceholderResolver.ReplaceNotificationPlaceholders( + $"{Placeholder.APPNAME}/{Placeholder.APPID}/{Placeholder.REQUESTING_APPNAME}/{Placeholder.REQUESTING_APPID}/{Placeholder.REQUESTER}/{Placeholder.INTERFACE_NAME}/{Placeholder.INTERFACE_LINK}/{Placeholder.NEW_INTERFACE_NAME}/{Placeholder.NEW_INTERFACE_LINK}/{Placeholder.REASON}/{Placeholder.USER_NAME}", + new NotificationPlaceholderResolver.NotificationPlaceholderValues + { + Application = selectedOwner, + RequestingOwner = requestingOwner, + InterfaceName = "if-test", + InterfaceLinkText = "Interface Request", + InterfaceLinkUrl = "https://ui.example.test/networkmodelling/APP-1/99", + NewInterfaceName = "if-test", + NewInterfaceLinkText = "Interface Request", + NewInterfaceLinkUrl = "https://ui.example.test/networkmodelling/APP-1/99", + Reason = "Need access", + UserName = "Tester" + }, + renderHtmlLinks: true); + + Assert.That(text, Is.EqualTo( + "Selected/APP-1/Requester/APP-2/Requester/if-test/" + + "Interface Request" + + "/if-test/" + + "Interface Request" + + "/Need access/Tester")); + } + + [Test] + public void ReplaceDecommissionPlaceholdersReplacesDecommissionContext() + { + FwoOwner application = new() + { + Name = "Application", + ExtAppId = "APP-9" + }; + + string text = NotificationPlaceholderResolver.ReplaceNotificationPlaceholders( + $"{Placeholder.APPNAME}/{Placeholder.APPID}/{Placeholder.INTERFACE_NAME}/{Placeholder.NEW_INTERFACE_NAME}/{Placeholder.NEW_INTERFACE_LINK}/{Placeholder.REASON}/{Placeholder.USER_NAME}", + new NotificationPlaceholderResolver.NotificationPlaceholderValues + { + Application = application, + InterfaceName = "if-old", + NewInterfaceName = "if-new", + NewInterfaceLinkText = "Interface", + NewInterfaceLinkName = "if-new", + NewInterfaceLinkUrl = "https://ui.example.test/networkmodelling/APP-9/100", + Reason = "Planned decommission", + UserName = "Tester" + }); + + Assert.That(text, Is.EqualTo("Application/APP-9/if-old/if-new/https://ui.example.test/networkmodelling/APP-9/100/Planned decommission/Tester")); + } + + [Test] + public void ReplaceDecommissionBodyPlaceholdersRendersFormattedContext() + { + FwoOwner application = new() + { + Name = "Application", + ExtAppId = "APP-9" + }; + + string text = NotificationPlaceholderResolver.ReplaceNotificationPlaceholders( + $"{Placeholder.INTERFACE_NAME}/{Placeholder.NEW_INTERFACE_NAME}/{Placeholder.NEW_INTERFACE_LINK}/{Placeholder.REASON}/{Placeholder.USER_NAME}", + new NotificationPlaceholderResolver.NotificationPlaceholderValues + { + Application = application, + InterfaceName = "if-old", + NewInterfaceName = "if-new", + NewInterfaceLinkText = "Interface", + NewInterfaceLinkName = "if-new", + NewInterfaceLinkUrl = "https://ui.example.test/networkmodelling/APP-9/100", + Reason = "Planned decommission", + UserName = "Tester" + }, + renderHtmlLinks: true); + + Assert.That(text, Is.EqualTo("if-old/if-new/Interface: if-new/Planned decommission/Tester")); + } + + [Test] + public void NotificationScheduleHelper_ConsidersRequestNotificationsDueImmediately() + { + FwoNotification notification = new() + { + Deadline = NotificationDeadline.RequestDate, + IntervalBeforeDeadline = SchedulerInterval.Days, + OffsetBeforeDeadline = 0 + }; + + Assert.That(NotificationScheduleHelper.IsNotificationDue(new FwoOwner(), DateTime.Now, notification), Is.True); + } + + [Test] + public void NotificationScheduleHelper_SkipsDelayedRequestReminders() + { + FwoNotification notification = new() + { + Deadline = NotificationDeadline.RequestDate, + RepeatIntervalAfterDeadline = SchedulerInterval.Days, + InitialOffsetAfterDeadline = 2, + RepeatOffsetAfterDeadline = 1, + RepetitionsAfterDeadline = 2 + }; + + Assert.That(NotificationScheduleHelper.IsNotificationDue(new FwoOwner(), DateTime.Now.AddDays(-1), notification), Is.False); + } + [Test] public void NotificationRequestBuilderKeepsNetworkIpsWhenTicketIsSerialized() { diff --git a/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerDecommissionTest.cs b/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerDecommissionTest.cs index 61929ea037..d909f8ab56 100644 --- a/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerDecommissionTest.cs +++ b/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerDecommissionTest.cs @@ -26,10 +26,6 @@ public async Task DecommissionInterface_NotifiesAndAddsPermissionsAndSelections( { DecommissionTestApiConn apiConnection = new(); SimulatedUserConfig userConfig = new(); - userConfig.ModDecommEmailReceiver = nameof(EmailRecipientOption.OwnerMainResponsible); - userConfig.ModDecommEmailOtherAddresses = "extra1@example.test;extra2@example.test"; - userConfig.ModDecommEmailSubject = $"Subject {Placeholder.INTERFACE_NAME}"; - userConfig.ModDecommEmailBody = $"Body {Placeholder.INTERFACE_NAME} {Placeholder.NEW_INTERFACE_NAME} {Placeholder.NEW_INTERFACE_LINK} {Placeholder.REASON} {Placeholder.USER_NAME}"; userConfig.UiHostName = "https://ui.example.test"; userConfig.User.Name = "Tester"; @@ -50,17 +46,28 @@ public async Task DecommissionInterface_NotifiesAndAddsPermissionsAndSelections( App = new FwoOwner { Id = 4, Name = "Owner4", ExtAppId = "APP4" } }; + FwoNotification notification = new() + { + NotificationClient = NotificationClient.AppDecomm, + Deadline = NotificationDeadline.None, + Layout = NotificationLayout.HtmlInBody, + RecipientTo = EmailRecipientOption.OwnerMainResponsible, + EmailSubject = $"Subject {Placeholder.INTERFACE_NAME}", + EmailBody = $"Body {Placeholder.INTERFACE_NAME} {Placeholder.NEW_INTERFACE_NAME} {Placeholder.NEW_INTERFACE_LINK} {Placeholder.REASON} {Placeholder.USER_NAME}" + }; + apiConnection.Notifications = new List { notification }; + TestEmailHelper emailHelper = new(userConfig); - List interfaceUsers = - [ + List interfaceUsers = new() + { new ModellingConnection { Id = 20, AppId = 2, App = new FwoOwner { Id = 2, Name = "Owner2" }, Name = "Conn2" }, new ModellingConnection { Id = 21, AppId = 3, App = new FwoOwner { Id = 3, Name = "Owner3" }, Name = "Conn3" }, new ModellingConnection { Id = 22, AppId = 1, App = owner, Name = "ConnOwn" } - ]; + }; apiConnection.InterfaceUsers = interfaceUsers; apiConnection.ConnectionById = interfaceConn; - DecommissionTestHandler handler = new(apiConnection, userConfig, owner, [interfaceConn], interfaceConn, addMode: false, + DecommissionTestHandler handler = new(apiConnection, userConfig, owner, new List { interfaceConn }, interfaceConn, addMode: false, readOnly: false, DefaultInit.DoNothing, DefaultInit.DoNothing, isOwner: true) { UsingConnections = interfaceUsers, @@ -76,16 +83,15 @@ public async Task DecommissionInterface_NotifiesAndAddsPermissionsAndSelections( ClassicAssert.AreEqual(2, emailHelper.SentEmails.Count); ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Owner.Id != owner.Id)); ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Subject == $"Subject {interfaceConn.Name}")); - ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Body.Contains($"{interfaceConn.Name}"))); - ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Body.Contains($"{proposedInterface.Name}"))); - ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Body.Contains($"{userConfig.User.Name}"))); - ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Body.Contains($"Planned"))); + ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Body.Contains(interfaceConn.Name))); + ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Body.Contains(proposedInterface.Name))); + ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Body.Contains(userConfig.User.Name))); + ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Body.Contains("Planned"))); + ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Body.Contains($""))); ClassicAssert.IsTrue(emailHelper.SentEmails.All(email => email.Body.Contains($"{userConfig.UiHostName}/{PageName.Modelling}/{proposedInterface.App.ExtAppId}/{proposedInterface.Id}"))); - ClassicAssert.IsTrue(emailHelper.OtherAddressCalls.All(addresses => - addresses.SequenceEqual(new[] { "extra1@example.test", "extra2@example.test" }))); - CollectionAssert.AreEquivalent(new[] { 2, 3 }, apiConnection.AddedPermittedOwnerAppIds); - CollectionAssert.AreEquivalent(new[] { 2, 3 }, apiConnection.AddedSelectedConnectionAppIds); + CollectionAssert.AreEquivalent(new List { 2, 3 }, apiConnection.AddedPermittedOwnerAppIds); + CollectionAssert.AreEquivalent(new List { 2, 3 }, apiConnection.AddedSelectedConnectionAppIds); ClassicAssert.IsTrue(apiConnection.AddedSelectedConnections.All(c => c.ConnectionId == proposedInterface.Id)); ClassicAssert.IsTrue(apiConnection.RemovedSelectedConnections.Contains(interfaceConn.Id)); } @@ -110,8 +116,7 @@ protected override EmailHelper CreateEmailHelper(MiddlewareClient middlewareClie private sealed class TestEmailHelper : EmailHelper { public bool InitCalled { get; private set; } - public List<(FwoOwner Owner, string Subject, string Body, EmailRecipientOption Recipient)> SentEmails { get; } = []; - public List> OtherAddressCalls { get; } = []; + public List<(FwoOwner Owner, string Subject, string Body, FwoNotification Notification)> SentEmails { get; } = new(); public TestEmailHelper(UserConfig userConfig) : base(new SimulatedApiConnection(), null, userConfig, DefaultInit.DoNothing) @@ -125,30 +130,22 @@ public override Task Init(string? scopedUserTo = null, string? scopedUserCc = nu return Task.CompletedTask; } - public override Task SendEmailToOwnerResponsibles(FwoOwner owner, string subject, string body, EmailRecipientOption recOpt, bool reqInCc = false) + public override Task SendEmailToNotificationRecipients(FwoNotification notification, FwoOwner? owner, string subject, string body) { - SentEmails.Add((owner, subject, body, recOpt)); - return Task.FromResult(true); - } - - public override Task SendEmailToOwnerResponsibles(FwoOwner owner, string subject, string body, string recipientConfig, bool reqInCc = false, List? otherAddresses = null) - { - EmailRecipientSelection parsedSelection = EmailRecipientSelection.Parse(recipientConfig); - EmailRecipientOption recipient = parsedSelection.None ? EmailRecipientOption.None : EmailRecipientOption.OwnerMainResponsible; - SentEmails.Add((owner, subject, body, recipient)); - OtherAddressCalls.Add(otherAddresses ?? []); + SentEmails.Add((owner ?? new FwoOwner(), subject, body, notification)); return Task.FromResult(true); } } private sealed class DecommissionTestApiConn : SimulatedApiConnection { - public List AddedPermittedOwnerAppIds { get; } = []; - public List AddedSelectedConnectionAppIds { get; } = []; - public List<(int AppId, int ConnectionId)> AddedSelectedConnections { get; } = []; - public List RemovedSelectedConnections { get; } = []; - public List InterfaceUsers { get; set; } = []; - public List PermittedOwners { get; set; } = []; + public List AddedPermittedOwnerAppIds { get; } = new(); + public List AddedSelectedConnectionAppIds { get; } = new(); + public List<(int AppId, int ConnectionId)> AddedSelectedConnections { get; } = new(); + public List RemovedSelectedConnections { get; } = new(); + public List InterfaceUsers { get; set; } = new(); + public List PermittedOwners { get; set; } = new(); + public List Notifications { get; set; } = new(); public ModellingConnection? ConnectionById { get; set; } public override Task SendQueryAsync(string query, object? variables = null, string? operationName = null, FWO.Api.Client.QueryChunkingOptions? chunkingOptions = null) @@ -165,7 +162,7 @@ public override Task SendQueryAsync(string int connId = GetIntVariable(variables, "connectionId"); AddedSelectedConnectionAppIds.Add(appId); AddedSelectedConnections.Add((appId, connId)); - ReturnIdWrapper wrapper = new() { ReturnIds = [new ReturnId { InsertedId = connId }] }; + ReturnIdWrapper wrapper = new() { ReturnIds = new ReturnId[] { new ReturnId { InsertedId = connId } } }; return Task.FromResult((QueryResponseType)(object)wrapper); } if (query == ModellingQueries.removeSelectedConnection) @@ -178,9 +175,13 @@ public override Task SendQueryAsync(string { return Task.FromResult((QueryResponseType)(object)new ReturnId { AffectedRows = 1 }); } + if (typeof(QueryResponseType) == typeof(List) && query == NotificationQueries.getNotifications) + { + return Task.FromResult((QueryResponseType)(object)Notifications); + } if (query == ModellingQueries.addHistoryEntry) { - ReturnIdWrapper wrapper = new() { ReturnIds = [new ReturnId { AffectedRows = 1 }] }; + ReturnIdWrapper wrapper = new() { ReturnIds = new ReturnId[] { new ReturnId { AffectedRows = 1 } } }; return Task.FromResult((QueryResponseType)(object)wrapper); } if (responseType == typeof(List) && query == ModellingQueries.getSelectedConnections) diff --git a/roles/tests-unit/files/FWO.Test/ModellingEmailRecipientSelectionTest.cs b/roles/tests-unit/files/FWO.Test/ModellingEmailRecipientSelectionTest.cs index 10ce45441a..492ac175e2 100644 --- a/roles/tests-unit/files/FWO.Test/ModellingEmailRecipientSelectionTest.cs +++ b/roles/tests-unit/files/FWO.Test/ModellingEmailRecipientSelectionTest.cs @@ -10,19 +10,19 @@ public class EmailRecipientSelectionTest [Test] public void ParseLegacyOwnerGroupOnlyMapsToSupportingResponsible() { - EmailRecipientSelection selection = EmailRecipientSelection.Parse(nameof(EmailRecipientOption.OwnerGroupOnly), [1, 2, 3]); + EmailRecipientSelection selection = EmailRecipientSelection.Parse(nameof(EmailRecipientOption.OwnerGroupOnly), new List { 1, 2, 3 }); Assert.That(selection.None, Is.False); - Assert.That(selection.OwnerResponsibleTypeIds, Is.EqualTo(new[] { GlobalConst.kOwnerResponsibleTypeSupporting })); + Assert.That(selection.OwnerResponsibleTypeIds, Is.EqualTo(new List { GlobalConst.kOwnerResponsibleTypeSupporting })); } [Test] public void ParseLegacyAllOwnerResponsiblesUsesActiveResponsibleTypes() { - EmailRecipientSelection selection = EmailRecipientSelection.Parse(nameof(EmailRecipientOption.AllOwnerResponsibles), [1, 3]); + EmailRecipientSelection selection = EmailRecipientSelection.Parse(nameof(EmailRecipientOption.AllOwnerResponsibles), new List { 1, 3 }); Assert.That(selection.None, Is.False); - Assert.That(selection.OwnerResponsibleTypeIds.OrderBy(id => id), Is.EqualTo(new[] { 1, 3 })); + Assert.That(selection.OwnerResponsibleTypeIds.OrderBy(id => id), Is.EqualTo(new List { 1, 3 })); } [Test] @@ -38,11 +38,11 @@ public void ParseLegacyAllOwnerResponsiblesReturnsEmptyWhenNoResponsibleTypesAre public void ParseJsonDerivesNoneFromEffectiveSelections() { string rawConfig = "{\"none\":true,\"other_addresses\":true,\"owner_responsible_type_ids\":[1,2]}"; - EmailRecipientSelection selection = EmailRecipientSelection.Parse(rawConfig, [1, 2, 3]); + EmailRecipientSelection selection = EmailRecipientSelection.Parse(rawConfig, new List { 1, 2, 3 }); Assert.That(selection.None, Is.False); Assert.That(selection.OtherAddresses, Is.True); - Assert.That(selection.OwnerResponsibleTypeIds, Is.EqualTo(new[] { 1, 2 })); + Assert.That(selection.OwnerResponsibleTypeIds, Is.EqualTo(new List { 1, 2 })); } [Test] @@ -52,10 +52,10 @@ public void ToConfigValueWithoutRecipientsStoresNone() { None = false, OtherAddresses = false, - OwnerResponsibleTypeIds = [] + OwnerResponsibleTypeIds = new List() }; - Assert.That(selection.ToConfigValue([1, 2]), Is.EqualTo(nameof(EmailRecipientOption.None))); + Assert.That(selection.ToConfigValue(new List { 1, 2 }), Is.EqualTo(nameof(EmailRecipientOption.None))); } [Test] @@ -65,10 +65,10 @@ public void ToConfigValueWithEmptyOtherAddressListStoresNone() { None = false, OtherAddresses = true, - OtherAddressList = [] + OtherAddressList = new List() }; - Assert.That(selection.ToConfigValue([1, 2]), Is.EqualTo(nameof(EmailRecipientOption.None))); + Assert.That(selection.ToConfigValue(new List { 1, 2 }), Is.EqualTo(nameof(EmailRecipientOption.None))); } [Test] @@ -76,7 +76,7 @@ public void ParseJsonWithEmptyOtherAddressListClearsOtherAddresses() { string rawConfig = "{\"none\":false,\"other_addresses\":true,\"other_address_list\":[],\"owner_responsible_type_ids\":[]}"; - EmailRecipientSelection selection = EmailRecipientSelection.Parse(rawConfig, [1, 2]); + EmailRecipientSelection selection = EmailRecipientSelection.Parse(rawConfig, new List { 1, 2 }); Assert.That(selection.None, Is.True); Assert.That(selection.OtherAddresses, Is.False); @@ -85,7 +85,7 @@ public void ParseJsonWithEmptyOtherAddressListClearsOtherAddresses() [Test] public void ParseLegacyOtherAddressesKeepsSelectionForLegacyAddressMerge() { - EmailRecipientSelection selection = EmailRecipientSelection.Parse(nameof(EmailRecipientOption.OtherAddresses), [1, 2]); + EmailRecipientSelection selection = EmailRecipientSelection.Parse(nameof(EmailRecipientOption.OtherAddresses), new List { 1, 2 }); Assert.That(selection.None, Is.False); Assert.That(selection.OtherAddresses, Is.True); @@ -96,11 +96,39 @@ public void ParseJsonKeepsSanitizedOtherAddressList() { string rawConfig = "{\"none\":false,\"other_addresses\":true,\"other_address_list\":[\" a@test \",\"A@test\",\"b@test\"],\"owner_responsible_type_ids\":[]}"; - EmailRecipientSelection selection = EmailRecipientSelection.Parse(rawConfig, [1, 2]); + EmailRecipientSelection selection = EmailRecipientSelection.Parse(rawConfig, new List { 1, 2 }); Assert.That(selection.None, Is.False); Assert.That(selection.OtherAddresses, Is.True); - Assert.That(selection.OtherAddressList, Is.EqualTo(new[] { "a@test", "b@test" })); + Assert.That(selection.OtherAddressList, Is.EqualTo(new List { "a@test", "b@test" })); + } + + [Test] + public void ParseJsonKeepsRequesterSelection() + { + string rawConfig = "{\"none\":false,\"other_addresses\":true,\"other_address_list\":[\"cc@example.test\"],\"requester\":true,\"owner_responsible_type_ids\":[]}"; + List activeResponsibleTypeIds = new List { 1, 2 }; + + EmailRecipientSelection selection = EmailRecipientSelection.Parse(rawConfig, activeResponsibleTypeIds); + + Assert.That(selection.None, Is.False); + Assert.That(selection.Requester, Is.True); + Assert.That(selection.OtherAddresses, Is.True); + } + + [Test] + public void ToConfigValueKeepsRequesterSelection() + { + EmailRecipientSelection selection = new() + { + None = false, + Requester = true + }; + List activeResponsibleTypeIds = new List { 1, 2 }; + + string configValue = selection.ToConfigValue(activeResponsibleTypeIds); + + Assert.That(configValue, Does.Contain("\"requester\":true")); } [Test] @@ -109,29 +137,29 @@ public void GetOwnerResponsibleTypeFallbackOrderUsesHighestSortOrderFirst() EmailRecipientSelection selection = new() { None = false, - OwnerResponsibleTypeIds = [1, 2, 3] + OwnerResponsibleTypeIds = new List { 1, 2, 3 } }; - List ownerResponsibleTypes = - [ + List ownerResponsibleTypes = new List + { new OwnerResponsibleType { Id = 1, Active = true, SortOrder = 10 }, new OwnerResponsibleType { Id = 2, Active = true, SortOrder = 50 }, new OwnerResponsibleType { Id = 3, Active = false, SortOrder = 100 } - ]; + }; List fallbackOrder = selection.GetOwnerResponsibleTypeFallbackOrder(ownerResponsibleTypes).ToList(); - Assert.That(fallbackOrder, Is.EqualTo(new[] { 2, 1 })); + Assert.That(fallbackOrder, Is.EqualTo(new List { 2, 1 })); } [Test] public void ParseLegacyFallbackOptionEnablesEnsureAtLeastOneNotification() { - EmailRecipientSelection selection = EmailRecipientSelection.Parse(nameof(EmailRecipientOption.FallbackToMainResponsibleIfOwnerGroupEmpty), [1, 2]); + EmailRecipientSelection selection = EmailRecipientSelection.Parse(nameof(EmailRecipientOption.FallbackToMainResponsibleIfOwnerGroupEmpty), new List { 1, 2 }); Assert.That(selection.None, Is.False); Assert.That(selection.EnsureAtLeastOneNotification, Is.True); - Assert.That(selection.OwnerResponsibleTypeIds, Is.EqualTo(new[] { 2, 1 })); + Assert.That(selection.OwnerResponsibleTypeIds, Is.EqualTo(new List { 2, 1 })); } [Test] @@ -139,7 +167,7 @@ public void ParseInvalidJsonFallsBackToLegacyValue() { EmailRecipientSelection selection = EmailRecipientSelection.Parse( "{invalid-json", - [GlobalConst.kOwnerResponsibleTypeMain, GlobalConst.kOwnerResponsibleTypeSupporting]); + new List { GlobalConst.kOwnerResponsibleTypeMain, GlobalConst.kOwnerResponsibleTypeSupporting }); Assert.That(selection.None, Is.True); Assert.That(selection.OtherAddresses, Is.False); diff --git a/roles/tests-unit/files/FWO.Test/NotificationPlaceholderResolverTest.cs b/roles/tests-unit/files/FWO.Test/NotificationPlaceholderResolverTest.cs new file mode 100644 index 0000000000..1db7711980 --- /dev/null +++ b/roles/tests-unit/files/FWO.Test/NotificationPlaceholderResolverTest.cs @@ -0,0 +1,59 @@ +using FWO.Data; +using FWO.Services; +using NUnit.Framework; +using static FWO.Basics.Placeholder; + +namespace FWO.Test +{ + [TestFixture] + internal class NotificationPlaceholderResolverTest + { + [Test] + public void ReplaceNotificationPlaceholders_UsesRequestingOwnerWhenRequesterNameIsMissing() + { + FwoOwner application = new() + { + Name = "Selected", + ExtAppId = "APP-1" + }; + FwoOwner requestingOwner = new() + { + Name = "Requester", + ExtAppId = "APP-2" + }; + + string text = NotificationPlaceholderResolver.ReplaceNotificationPlaceholders( + REQUESTER, + new NotificationPlaceholderResolver.NotificationPlaceholderValues + { + Application = application, + RequestingOwner = requestingOwner + }); + + Assert.That(text, Is.EqualTo("Requester")); + } + + [Test] + public void ReplaceNotificationPlaceholders_RendersHtmlLinkWithoutLinkName() + { + FwoOwner application = new() + { + Name = "Selected", + ExtAppId = "APP-1" + }; + string interfaceUrl = "https://ui.example.test/networkmodelling/APP-1/99"; + + string text = NotificationPlaceholderResolver.ReplaceNotificationPlaceholders( + INTERFACE_LINK, + new NotificationPlaceholderResolver.NotificationPlaceholderValues + { + Application = application, + InterfaceLinkText = "Interface Request", + InterfaceLinkUrl = interfaceUrl + }, + renderHtmlLinks: true); + + Assert.That(text, Is.EqualTo($"Interface Request")); + } + } +} diff --git a/roles/tests-unit/files/FWO.Test/NotificationScheduleHelperTest.cs b/roles/tests-unit/files/FWO.Test/NotificationScheduleHelperTest.cs new file mode 100644 index 0000000000..c241b1edd4 --- /dev/null +++ b/roles/tests-unit/files/FWO.Test/NotificationScheduleHelperTest.cs @@ -0,0 +1,47 @@ +using FWO.Data; +using FWO.Services; +using NUnit.Framework; + +namespace FWO.Test +{ + [TestFixture] + internal class NotificationScheduleHelperTest + { + [Test] + public void IsNotificationDue_ReturnsTrueForNoneDeadline() + { + FwoNotification notification = new() + { + Deadline = NotificationDeadline.None + }; + + Assert.That(NotificationScheduleHelper.IsNotificationDue(new FwoOwner(), null, notification), Is.True); + } + + [Test] + public void IsNotificationDue_ReturnsTrueForImmediateRequestDeadline() + { + FwoNotification notification = new() + { + Deadline = NotificationDeadline.RequestDate, + IntervalBeforeDeadline = SchedulerInterval.Days, + OffsetBeforeDeadline = 0 + }; + + Assert.That(NotificationScheduleHelper.IsNotificationDue(new FwoOwner(), DateTime.Now, notification), Is.True); + } + + [Test] + public void IsNotificationDue_ReturnsFalseForFutureRequestDeadline() + { + FwoNotification notification = new() + { + Deadline = NotificationDeadline.RequestDate, + IntervalBeforeDeadline = SchedulerInterval.Days, + OffsetBeforeDeadline = 0 + }; + + Assert.That(NotificationScheduleHelper.IsNotificationDue(new FwoOwner(), DateTime.Now.AddDays(1), notification), Is.False); + } + } +} diff --git a/roles/tests-unit/files/FWO.Test/NotificationTest.cs b/roles/tests-unit/files/FWO.Test/NotificationTest.cs index 0bd486abcd..0002b36f8c 100644 --- a/roles/tests-unit/files/FWO.Test/NotificationTest.cs +++ b/roles/tests-unit/files/FWO.Test/NotificationTest.cs @@ -28,6 +28,7 @@ internal class NotificationTest private static readonly string[] kJsonRecipients = ["json@example.test"]; private static readonly string[] kMainRecipients = ["main@example.test"]; private static readonly NotificationDeadline[] kNoneDeadline = [NotificationDeadline.None]; + private static readonly NotificationDeadline[] kInterfaceRequestDeadlines = [NotificationDeadline.None, NotificationDeadline.RequestDate]; private static readonly Type[] kCollectRecipientsParameterTypes = [typeof(FwoNotification), typeof(FwoOwner), typeof(bool), typeof(bool)]; [Test] @@ -782,6 +783,12 @@ public void OfferedDeadlineOptions_ReturnsOnlyNone_ForWfAction() CollectionAssert.AreEqual(kNoneDeadline, FwoNotification.OfferedDeadlineOptions(NotificationClient.WfAction)); } + [Test] + public void OfferedDeadlineOptions_ReturnsNoneAndRequestDate_ForInterfaceRequest() + { + CollectionAssert.AreEqual(kInterfaceRequestDeadlines, FwoNotification.OfferedDeadlineOptions(NotificationClient.InterfaceRequest)); + } + [Test] public void NotificationClientGroups_ClassifiesWfActionAsWorkflowRecipientClient() { diff --git a/roles/tests-unit/files/FWO.Test/SimulatedUserConfig.cs b/roles/tests-unit/files/FWO.Test/SimulatedUserConfig.cs index cf75bac682..9583e0316d 100644 --- a/roles/tests-unit/files/FWO.Test/SimulatedUserConfig.cs +++ b/roles/tests-unit/files/FWO.Test/SimulatedUserConfig.cs @@ -455,11 +455,13 @@ internal class SimulatedUserConfig : UserConfig {"modelling","Modelling"}, {"modelling_general_settings","General Settings"}, {"notifications","Notifications"}, + {"initial_request","Initial request"}, {"request_interface","Request Interface"}, + {"reminder","Reminder"}, {"reminders","Reminders"}, {"decommission","Decommission"}, + {"decomm_owner","Decommission"}, {"modReqInterfaceName","Name of requested interface"}, - {"modReqEmailRequesterInCc","Requester in CC"}, {"modReqEmailReceiver","Receiver of request email"}, {"modReqEmailSubject","Subject of request emails"}, {"modReqEmailBody","Body of request emails"}, diff --git a/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs b/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs index 06b422bb37..1cece86d04 100644 --- a/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs @@ -381,6 +381,31 @@ public void DisplayRecipient_ShowsOtherAddressesAfterResponsibleTypes() Assert.That(displayedRecipient, Is.EqualTo("Responsible types (Main, Supporting, Other addresses)")); } + [Test] + public void DisplayRecipient_ReturnsLocalizedLabelForSimpleRecipients() + { + SimulatedUserConfig userConfig = new(); + EditNotifications component = new(); + SetInjectedUserConfig(component, userConfig); + + string displayedRecipient = (string)GetPrivateMethod("DisplayRecipient").Invoke(component, + new object?[] { EmailRecipientOption.Requester, null })!; + + Assert.That(displayedRecipient, Is.EqualTo(userConfig.GetText(nameof(EmailRecipientOption.Requester)))); + } + + [Test] + public void DisplayOtherAddresses_ReturnsLocalizedLabelWhenEmpty() + { + SimulatedUserConfig userConfig = new(); + EditNotifications component = new(); + SetInjectedUserConfig(component, userConfig); + + string displayedRecipient = (string)GetPrivateMethod("DisplayOtherAddresses").Invoke(component, new object?[] { "" })!; + + Assert.That(displayedRecipient, Is.EqualTo(userConfig.GetText(nameof(EmailRecipientOption.OtherAddresses)))); + } + [Test] public void EditNotification_MigratesLegacyMainResponsibleToConfiguredSelection() { @@ -421,6 +446,27 @@ public void EditNotification_KeepsLegacyMainResponsibleWhenMainTypeIsInactive() Assert.That(notification.RecipientTo, Is.EqualTo(EmailRecipientOption.OwnerMainResponsible)); } + [Test] + public void SyncAddresses_ClearsRequesterSelectionWhenRequesterOptionIsNotAvailable() + { + EditNotifications component = new(); + SetClient(component, NotificationClient.RuleTimer); + FwoNotification notification = new(); + + SetPrivateField(component, "actNotification", notification); + SetPrivateField(component, "ToRecipientSelection", new EmailRecipientSelection + { + None = false, + Requester = true + }); + + GetPrivateMethod("SyncAddresses").Invoke(component, null); + + EmailRecipientSelection selection = GetPrivateField(component, "ToRecipientSelection"); + Assert.That(selection.Requester, Is.False); + Assert.That(notification.RecipientTo, Is.EqualTo(EmailRecipientOption.None)); + } + [Test] public void CheckConsistency_ReturnsTrue_ForConfiguredResponsibleNotification() { @@ -447,6 +493,29 @@ public void CheckConsistency_ReturnsTrue_ForConfiguredResponsibleNotification() Assert.That(isConsistent, Is.True); } + [Test] + public void CheckConsistency_ReturnsFalse_WhenDeadlineRepeatsWithoutCount() + { + EnsureNotificationTranslations(); + EditNotifications component = new(); + SetClient(component, NotificationClient.RuleTimer); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateField(component, "actNotification", new FwoNotification + { + Channel = NotificationChannel.Email, + EmailSubject = "Subject", + RecipientTo = EmailRecipientOption.OtherAddresses, + EmailAddressTo = "to@example.org", + Deadline = NotificationDeadline.RuleExpiry, + RepeatOffsetAfterDeadline = 2, + RepeatIntervalAfterDeadline = SchedulerInterval.Weeks + }); + + bool isConsistent = (bool)GetPrivateMethod("CheckConsistency").Invoke(component, null)!; + + Assert.That(isConsistent, Is.False); + } + [Test] public void EnsureNotificationIntervals_SetsDefaultIntervalValues_WhenOffsetsAreFilled() { diff --git a/roles/tests-unit/files/FWO.Test/UiEmailRecipientSelectionEditorTest.cs b/roles/tests-unit/files/FWO.Test/UiEmailRecipientSelectionEditorTest.cs index 50cd6325a3..8fddfdaea2 100644 --- a/roles/tests-unit/files/FWO.Test/UiEmailRecipientSelectionEditorTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiEmailRecipientSelectionEditorTest.cs @@ -7,6 +7,7 @@ using Microsoft.AspNetCore.Components; using Microsoft.Extensions.DependencyInjection; using NUnit.Framework; +using System.Linq; namespace FWO.Test { @@ -48,6 +49,87 @@ public void Render_OrdersResponsiblesOtherAddressesAndEnsureFlag() })); } + [Test] + public void Render_ShowsRequesterOptionWhenEnabled() + { + SimulatedUserConfig userConfig = new(); + Services.AddSingleton(userConfig); + + IRenderedComponent component = Render(parameters => parameters + .Add(p => p.Selection, new EmailRecipientSelection()) + .Add(p => p.ShowRequesterOption, true)); + + Assert.That(component.FindAll("label.form-check-label").Select(label => label.TextContent), Does.Contain(userConfig.GetText(nameof(EmailRecipientOption.Requester)))); + } + + [Test] + public void RequesterCheckbox_TogglesRequesterSelectionAndDerivedNone() + { + Services.AddSingleton(new SimulatedUserConfig()); + EmailRecipientSelection selection = new(); + + IRenderedComponent component = Render(parameters => parameters + .Add(p => p.Selection, selection) + .Add(p => p.ShowRequesterOption, true) + .Add(p => p.CheckboxIdPrefix, "test_recipients")); + + component.Find("#test_recipients_requester").Change(true); + + Assert.That(selection.Requester, Is.True); + Assert.That(selection.None, Is.False); + + component.Find("#test_recipients_requester").Change(false); + + Assert.That(selection.Requester, Is.False); + Assert.That(selection.None, Is.True); + } + + [Test] + public void OtherAddressesCheckbox_TogglesSelectionAndDerivedNone() + { + Services.AddSingleton(new SimulatedUserConfig()); + EmailRecipientSelection selection = new(); + + IRenderedComponent component = Render(parameters => parameters + .Add(p => p.Selection, selection) + .Add(p => p.CheckboxIdPrefix, "test_recipients")); + + component.Find("#test_recipients_other").Change(true); + + Assert.That(selection.OtherAddresses, Is.True); + Assert.That(selection.None, Is.False); + + component.Find("#test_recipients_other").Change(false); + + Assert.That(selection.OtherAddresses, Is.False); + Assert.That(selection.None, Is.True); + } + + [Test] + public void OwnerResponsibleTypeCheckbox_TogglesSelectionAndDerivedNone() + { + Services.AddSingleton(new SimulatedUserConfig()); + EmailRecipientSelection selection = new(); + + IRenderedComponent component = Render(parameters => parameters + .Add(p => p.Selection, selection) + .Add(p => p.OwnerResponsibleTypes, new List + { + new() { Id = 7, Name = "Main responsible", Active = true, SortOrder = 10 } + }) + .Add(p => p.CheckboxIdPrefix, "test_recipients")); + + component.Find("#test_recipients_ort_7").Change(true); + + Assert.That(selection.OwnerResponsibleTypeIds, Is.EqualTo(new List { 7 })); + Assert.That(selection.None, Is.False); + + component.Find("#test_recipients_ort_7").Change(false); + + Assert.That(selection.OwnerResponsibleTypeIds, Is.Empty); + Assert.That(selection.None, Is.True); + } + [Test] public void OtherEmailAddressesEditor_AddsSanitizedAddressToList() { diff --git a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs index e48cb48479..a0d658894d 100644 --- a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs @@ -1,4 +1,5 @@ using Bunit; +using GraphQL; using FWO.Api.Client; using FWO.Api.Client.Queries; using FWO.Basics; @@ -6,6 +7,7 @@ using FWO.Data; using FWO.Data.Modelling; using FWO.Middleware.Client; +using FWO.Services; using FWO.Services.Modelling; using FWO.Ui.Pages.NetworkModelling; using Microsoft.AspNetCore.Authorization; @@ -14,6 +16,8 @@ using Microsoft.Extensions.DependencyInjection; using NUnit.Framework; using System.Security.Claims; +using System.Reflection; +using static FWO.Basics.Placeholder; namespace FWO.Test { @@ -91,6 +95,226 @@ public async Task RequestInterfacePopup_SendRequest_RejectsWhenSelectedOwnerMatc Assert.That(component.Instance.Display, Is.True); } + [Test] + public async Task RequestInterfacePopup_LoadImmediateRequestNotification_ReturnsDeadlineNoneNotification() + { + using BunitContext context = CreateContext(new RequestPopupNotificationApiConn(), Roles.Modeller); + IRenderedComponent component = RenderRequestInterfacePopup( + context, + new FwoOwner { Id = 11, Name = "Selected", ExtAppId = "APP-42" }, + new FwoOwner { Id = 12, Name = "Requester" }); + + MethodInfo loadImmediateNotification = typeof(RequestInterfacePopup).GetMethod("LoadImmediateRequestNotification", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("LoadImmediateRequestNotification method not found."); + Task task = (Task)(loadImmediateNotification.Invoke(component.Instance, Array.Empty()) + ?? throw new InvalidOperationException("LoadImmediateRequestNotification returned null task.")); + FwoNotification? notification = await task; + + Assert.Multiple(() => + { + Assert.That(notification, Is.Not.Null); + Assert.That(notification!.Deadline, Is.EqualTo(NotificationDeadline.None)); + Assert.That(notification.EmailSubject, Is.EqualTo("immediate-subject")); + }); + } + + [Test] + public async Task RequestInterfacePopup_LoadImmediateRequestNotification_ReturnsNullWhenNoImmediateNotificationExists() + { + using BunitContext context = CreateContext(new RequestPopupNoImmediateApiConn(), Roles.Modeller); + IRenderedComponent component = RenderRequestInterfacePopup( + context, + new FwoOwner { Id = 11, Name = "Selected", ExtAppId = "APP-42" }, + new FwoOwner { Id = 12, Name = "Requester" }); + + MethodInfo loadImmediateNotification = typeof(RequestInterfacePopup).GetMethod("LoadImmediateRequestNotification", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("LoadImmediateRequestNotification method not found."); + Task task = (Task)(loadImmediateNotification.Invoke(component.Instance, Array.Empty()) + ?? throw new InvalidOperationException("LoadImmediateRequestNotification returned null task.")); + FwoNotification? notification = await task; + + Assert.That(notification, Is.Null); + } + + [Test] + public async Task RequestInterfacePopup_SendEmail_DisplaysMissingNotificationErrorWhenNoImmediateNotificationExists() + { + using BunitContext context = CreateContext(new RequestPopupNoImmediateApiConn(), Roles.Modeller); + SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + userConfig.UiHostName = "https://fwo.example"; + IRenderedComponent component = RenderRequestInterfacePopup( + context, + new FwoOwner { Id = 11, Name = "Selected", ExtAppId = "APP-42" }, + new FwoOwner { Id = 12, Name = "Requester" }, + messageSink: null); + List<(Exception? Exception, string Title, string Message, bool IsError)> messages = []; + SetPrivateMember(component.Instance, "DisplayMessageInUi", (Action)((exception, title, message, isError) => messages.Add((exception, title, message, isError)))); + SetPrivateMember(component.Instance, "middlewareClient", null); + + MethodInfo sendEmail = typeof(RequestInterfacePopup).GetMethod("SendEmail", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("SendEmail method not found."); + Task task = (Task)(sendEmail.Invoke(component.Instance, new object?[] { 123L }) ?? throw new InvalidOperationException("SendEmail returned null task.")); + await task; + + Assert.Multiple(() => + { + Assert.That(messages, Has.Count.EqualTo(1)); + Assert.That(messages[0].Title, Is.EqualTo(userConfig.GetText("send_email"))); + Assert.That(messages[0].Message, Is.EqualTo(userConfig.GetText("E9011"))); + Assert.That(messages[0].IsError, Is.True); + }); + } + + [Test] + public async Task RequestInterfacePopup_SendEmail_DisplaysMissingRecipientErrorWhenNotificationHasNoRecipients() + { + using BunitContext context = CreateContext(new RequestPopupNoImmediateApiConn(), Roles.Modeller); + SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + userConfig.UiHostName = "https://fwo.example"; + IRenderedComponent component = RenderRequestInterfacePopup( + context, + new FwoOwner { Id = 11, Name = "Selected", ExtAppId = "APP-42" }, + new FwoOwner { Id = 12, Name = "Requester" }, + messageSink: null); + List<(Exception? Exception, string Title, string Message, bool IsError)> messages = []; + SetPrivateMember(component.Instance, "DisplayMessageInUi", (Action)((exception, title, message, isError) => messages.Add((exception, title, message, isError)))); + SetPrivateMember(component.Instance, "middlewareClient", null); + + RequestPopupNoRecipientsApiConn apiConn = new(); + SetPrivateMember(component.Instance, "apiConnection", apiConn); + + MethodInfo sendEmail = typeof(RequestInterfacePopup).GetMethod("SendEmail", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("SendEmail method not found."); + Task task = (Task)(sendEmail.Invoke(component.Instance, new object?[] { 123L }) ?? throw new InvalidOperationException("SendEmail returned null task.")); + await task; + + Assert.Multiple(() => + { + Assert.That(messages, Has.Count.EqualTo(1)); + Assert.That(messages[0].Title, Is.EqualTo(userConfig.GetText("send_email"))); + Assert.That(messages[0].Message, Is.EqualTo(userConfig.GetText("E9011"))); + Assert.That(messages[0].IsError, Is.True); + }); + } + + [Test] + public async Task RequestInterfacePopup_BuildRequestPlaceholderValues_UsesCurrentRequestState() + { + using BunitContext context = CreateContext(new RequestPopupNotificationApiConn(), Roles.Modeller); + SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + userConfig.UiHostName = "https://fwo.example"; + userConfig.ModReqInterfaceName = "req-interface"; + FwoOwner selectedApp = new() { Id = 11, Name = "Selected", ExtAppId = "APP-42" }; + FwoOwner requestingOwner = new() { Id = 12, Name = "Requester" }; + + IRenderedComponent component = RenderRequestInterfacePopup( + context, + selectedApp, + requestingOwner); + + component.Find("input[type='text']").Change("branch-if"); + component.Find("textarea").Change("needed"); + + MethodInfo buildPlaceholderValues = typeof(RequestInterfacePopup).GetMethod("BuildRequestPlaceholderValues", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("BuildRequestPlaceholderValues method not found."); + NotificationPlaceholderResolver.NotificationPlaceholderValues values = (NotificationPlaceholderResolver.NotificationPlaceholderValues)(buildPlaceholderValues.Invoke(component.Instance, new object?[] { 123L }) + ?? throw new InvalidOperationException("BuildRequestPlaceholderValues returned null.")); + + Assert.Multiple(() => + { + Assert.That(values.Application, Is.SameAs(selectedApp)); + Assert.That(values.RequestingOwner, Is.SameAs(requestingOwner)); + Assert.That(values.InterfaceName, Is.EqualTo("branch-if")); + Assert.That(values.InterfaceLinkText, Is.EqualTo(userConfig.GetText("request_interface"))); + Assert.That(values.InterfaceLinkUrl, Is.EqualTo("https://fwo.example/networkmodelling/APP-42/123")); + Assert.That(values.NewInterfaceName, Is.EqualTo("branch-if")); + Assert.That(values.NewInterfaceLinkText, Is.EqualTo(userConfig.GetText("request_interface"))); + Assert.That(values.NewInterfaceLinkUrl, Is.EqualTo("https://fwo.example/networkmodelling/APP-42/123")); + Assert.That(values.RequesterName, Is.EqualTo(userConfig.User.Name)); + Assert.That(values.UserName, Is.EqualTo(userConfig.User.Name)); + Assert.That(values.RequestDate, Is.EqualTo(DateTime.Now.ToString("dd.MM.yyyy"))); + }); + } + + [Test] + public async Task RequestInterfacePopup_SendRequest_StopsWhenAlreadyInProgress() + { + using BunitContext context = CreateContext(new RequestPopupNotificationApiConn(), Roles.Modeller); + IRenderedComponent component = RenderRequestInterfacePopup( + context, + new FwoOwner { Id = 11, Name = "Selected", ExtAppId = "APP-42" }, + new FwoOwner { Id = 12, Name = "Requester" }); + SetPrivateMember(component.Instance, "WorkInProgress", true); + + MethodInfo sendRequest = typeof(RequestInterfacePopup).GetMethod("SendRequest", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("SendRequest method not found."); + Task task = (Task)(sendRequest.Invoke(component.Instance, Array.Empty()) ?? throw new InvalidOperationException("SendRequest returned null task.")); + await task; + + Assert.That(component.Instance.Display, Is.True); + } + + [Test] + public void RequestInterfacePopup_Close_HidesPopup() + { + using BunitContext context = CreateContext(Roles.Modeller); + IRenderedComponent component = RenderRequestInterfacePopup( + context, + new FwoOwner { Id = 11, Name = "Selected", ExtAppId = "APP-42" }, + new FwoOwner { Id = 12, Name = "Requester" }); + + MethodInfo close = typeof(RequestInterfacePopup).GetMethod("Close", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("Close method not found."); + close.Invoke(component.Instance, Array.Empty()); + + Assert.That(component.Instance.Display, Is.False); + } + + [Test] + public void RequestInterfacePopup_BuildRequestEmailSubjectAndBody_ReplacesPlaceholders() + { + using BunitContext context = CreateContext(Roles.Modeller); + SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + userConfig.UiHostName = "https://fwo.example"; + userConfig.ModReqInterfaceName = "req-interface"; + FwoOwner selectedApp = new() { Id = 11, Name = "Selected", ExtAppId = "APP-42" }; + FwoOwner requestingOwner = new() { Id = 12, Name = "Requester" }; + + IRenderedComponent component = RenderRequestInterfacePopup( + context, + selectedApp, + requestingOwner); + + component.Find("input[type='text']").Change("branch-if"); + component.Find("textarea").Change("needed"); + + FwoNotification notification = new() + { + EmailSubject = $"{REQUESTER}/{APPNAME}/{INTERFACE_LINK}", + EmailBody = $"Body:{REQUESTER}/{APPNAME}/{INTERFACE_NAME}/{INTERFACE_LINK}" + }; + NotificationPlaceholderResolver.NotificationPlaceholderValues values = + (NotificationPlaceholderResolver.NotificationPlaceholderValues)(typeof(RequestInterfacePopup) + .GetMethod("BuildRequestPlaceholderValues", BindingFlags.Instance | BindingFlags.NonPublic) + ?.Invoke(component.Instance, new object?[] { 123L }) + ?? throw new InvalidOperationException("BuildRequestPlaceholderValues method not found.")); + + string subject = (string)(typeof(RequestInterfacePopup) + .GetMethod("BuildRequestEmailSubject", BindingFlags.Static | BindingFlags.NonPublic) + ?.Invoke(null, new object?[] { notification, values }) + ?? throw new InvalidOperationException("BuildRequestEmailSubject method not found.")); + string body = (string)(typeof(RequestInterfacePopup) + .GetMethod("BuildRequestEmailBody", BindingFlags.Static | BindingFlags.NonPublic) + ?.Invoke(null, new object?[] { notification, values }) + ?? throw new InvalidOperationException("BuildRequestEmailBody method not found.")); + + Assert.Multiple(() => + { + Assert.That(subject, Is.EqualTo($"{userConfig.User.Name}/Selected/https://fwo.example/networkmodelling/APP-42/123")); + Assert.That(body, Is.EqualTo($"Body:{userConfig.User.Name}/Selected/branch-if/Request Interface: branch-if")); + }); + } + [Test] public void RejectInterfacePopup_OnParametersSet_SetsMessageAndAdminReason() { @@ -161,6 +385,11 @@ public async Task RejectInterfacePopup_Reject_SavesPropertiesAndRemovesSelection } private static BunitContext CreateContext(params string[] roles) + { + return CreateContext(null, roles); + } + + private static BunitContext CreateContext(ApiConnection? apiConnection, params string[] roles) { BunitContext context = new(); context.JSInterop.Mode = JSRuntimeMode.Loose; @@ -168,7 +397,7 @@ private static BunitContext CreateContext(params string[] roles) context.Services.AddLocalization(); context.Services.AddSingleton(); context.Services.AddSingleton(new PopupAuthStateProvider(roles)); - context.Services.AddSingleton(new SimulatedApiConnection()); + context.Services.AddSingleton(apiConnection ?? new SimulatedApiConnection()); context.Services.AddSingleton(new MiddlewareClient("http://localhost/")); context.Services.AddSingleton(CreateUserConfig()); return context; @@ -267,6 +496,158 @@ private static IRenderedComponent RenderRejectInterfacePop return context.Render(fragment).FindComponent(); } + private static void SetPrivateMember(object target, string memberName, object? value) + { + FieldInfo? field = target.GetType().GetField(memberName, BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public); + if (field != null) + { + field.SetValue(target, value); + return; + } + + PropertyInfo? property = target.GetType().GetProperty(memberName, BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public); + if (property != null) + { + property.SetValue(target, value); + return; + } + + throw new MissingMemberException(target.GetType().FullName, memberName); + } + + private sealed class RequestPopupNotificationApiConn : SimulatedApiConnection + { + public override async Task SendQueryAsync(string query, object? variables = null, string? operationName = null, QueryChunkingOptions? chunkingOptions = null) + { + await Task.CompletedTask; + if (typeof(QueryResponseType) == typeof(List) && query == NotificationQueries.getNotifications) + { + GraphQLResponse response = new() + { + Data = new List + { + new() + { + Id = 1, + Deadline = NotificationDeadline.RequestDate, + EmailSubject = "request-subject" + }, + new() + { + Id = 2, + Deadline = NotificationDeadline.None, + EmailSubject = "immediate-subject" + } + } + }; + return response.Data; + } + + if (typeof(QueryResponseType) == typeof(List) && query == OwnerQueries.getOwnerResponsibleTypes) + { + return (QueryResponseType)(object)new List + { + new() { Id = GlobalConst.kOwnerResponsibleTypeMain, Name = "Main", Active = true, SortOrder = 10 } + }; + } + + if (typeof(QueryResponseType) == typeof(List) && query == AuthQueries.getUserEmails) + { + return (QueryResponseType)(object)new List + { + new() { Dn = "cn=requester,dc=test", Email = "requester@example.test" } + }; + } + + throw new AssertionException($"Unexpected query: {query}"); + } + } + + private sealed class RequestPopupNoImmediateApiConn : SimulatedApiConnection + { + public override async Task SendQueryAsync(string query, object? variables = null, string? operationName = null, QueryChunkingOptions? chunkingOptions = null) + { + await Task.CompletedTask; + if (typeof(QueryResponseType) == typeof(List) && query == NotificationQueries.getNotifications) + { + GraphQLResponse response = new() + { + Data = new List + { + new() + { + Id = 1, + Deadline = NotificationDeadline.RequestDate, + EmailSubject = "request-subject" + } + } + }; + return response.Data; + } + + if (typeof(QueryResponseType) == typeof(List) && query == OwnerQueries.getOwnerResponsibleTypes) + { + return (QueryResponseType)(object)new List + { + new() { Id = GlobalConst.kOwnerResponsibleTypeMain, Name = "Main", Active = true, SortOrder = 10 } + }; + } + + if (typeof(QueryResponseType) == typeof(List) && query == AuthQueries.getUserEmails) + { + return (QueryResponseType)(object)new List + { + new() { Dn = "cn=requester,dc=test", Email = "requester@example.test" } + }; + } + + throw new AssertionException($"Unexpected query: {query}"); + } + } + + private sealed class RequestPopupNoRecipientsApiConn : SimulatedApiConnection + { + public override async Task SendQueryAsync(string query, object? variables = null, string? operationName = null, QueryChunkingOptions? chunkingOptions = null) + { + await Task.CompletedTask; + if (typeof(QueryResponseType) == typeof(List) && query == NotificationQueries.getNotifications) + { + GraphQLResponse response = new() + { + Data = new List + { + new() + { + Id = 2, + Deadline = NotificationDeadline.None, + RecipientTo = EmailRecipientOption.OtherAddresses, + EmailAddressTo = "" + } + } + }; + return response.Data; + } + + if (typeof(QueryResponseType) == typeof(List) && query == OwnerQueries.getOwnerResponsibleTypes) + { + return (QueryResponseType)(object)new List + { + new() { Id = GlobalConst.kOwnerResponsibleTypeMain, Name = "Main", Active = true, SortOrder = 10 } + }; + } + + if (typeof(QueryResponseType) == typeof(List) && query == AuthQueries.getUserEmails) + { + return (QueryResponseType)(object)new List + { + new() { Dn = "cn=requester,dc=test", Email = "requester@example.test" } + }; + } + + throw new AssertionException($"Unexpected query: {query}"); + } + } + private sealed class PopupAuthStateProvider : AuthenticationStateProvider { private readonly ClaimsPrincipal principal; diff --git a/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs b/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs index b2bbddc66d..827568701c 100644 --- a/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs @@ -1,14 +1,17 @@ +using AngleSharp.Dom; using Bunit; using FWO.Api.Client; using FWO.Api.Client.Queries; +using FWO.Basics; using FWO.Config.Api; using FWO.Config.Api.Data; using FWO.Data; -using FWO.Basics; using FWO.Ui.Pages.Settings; -using Microsoft.AspNetCore.Components; +using FWO.Ui.Shared; using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Components; using Microsoft.AspNetCore.Components.Authorization; +using Microsoft.Extensions.Localization; using Microsoft.Extensions.DependencyInjection; using NUnit.Framework; using System.Linq; @@ -17,245 +20,220 @@ namespace FWO.Test { [TestFixture] + [FixtureLifeCycle(LifeCycle.InstancePerTestCase)] internal class UiSettingsModellingNotificationsTest { - private static readonly List RequestRecipientTypeIds = [1]; - private static readonly List DecommRecipientTypeIds = [2]; - private static readonly List ActiveRecipientTypeIds = [1, 2]; - private static readonly string[] RequestLegacyAddresses = ["legacy-request@example.org"]; - private static readonly string[] DecommLegacyAddresses = ["legacy-decomm@example.org"]; - private static readonly List RequestOtherAddressList = ["request@example.org"]; - private static readonly List DecommOtherAddressList = ["decomm@example.org"]; - private static MethodInfo GetPrivateMethod(string name) + [Test] + public async Task Page_RendersThreeNotificationEditorsWithExpectedSections() { - return typeof(SettingsModellingNotifications).GetMethod(name, BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static) - ?? throw new MissingMethodException(typeof(SettingsModellingNotifications).FullName, name); + await using BunitContext context = CreateContext(); + + IRenderedComponent wrapper = RenderPage(context); + IRenderedComponent page = wrapper.FindComponent(); + + page.WaitForAssertion(() => + { + Assert.That(page.Markup, Does.Contain("Notifications")); + Assert.That(page.Markup, Does.Contain("Initial request")); + Assert.That(page.Markup, Does.Contain("Reminder")); + Assert.That(page.Markup, Does.Contain("Decommission")); + + List> editors = page.FindComponents().ToList(); + Assert.That(editors, Has.Count.EqualTo(3)); + Assert.That(editors[0].Instance.Client, Is.EqualTo(NotificationClient.InterfaceRequest)); + Assert.That(editors[0].Instance.DeadlineFilter, Is.EqualTo(NotificationDeadline.None)); + Assert.That(editors[1].Instance.Client, Is.EqualTo(NotificationClient.InterfaceRequest)); + Assert.That(editors[1].Instance.DeadlineFilter, Is.EqualTo(NotificationDeadline.RequestDate)); + Assert.That(editors[2].Instance.Client, Is.EqualTo(NotificationClient.AppDecomm)); + Assert.That(editors[2].Instance.DeadlineFilter, Is.EqualTo(NotificationDeadline.None)); + }); } - private static void SetPrivateField(object component, string fieldName, object? value) + [Test] + public async Task Save_WritesChangedConfigData() { - FieldInfo? field = component.GetType().GetField(fieldName, BindingFlags.NonPublic | BindingFlags.Instance); - if (field == null) - { - throw new MissingFieldException(component.GetType().FullName, fieldName); - } - field.SetValue(component, value); - } + await using BunitContext context = CreateContext(); + IRenderedComponent wrapper = RenderPage(context); + IRenderedComponent page = wrapper.FindComponent(); - private static T GetPrivateField(object component, string fieldName) - { - FieldInfo? field = component.GetType().GetField(fieldName, BindingFlags.NonPublic | BindingFlags.Instance); - if (field == null) - { - throw new MissingFieldException(component.GetType().FullName, fieldName); - } - return (T)field.GetValue(component)!; - } + page.WaitForAssertion(() => Assert.That(page.FindAll("form"), Has.Count.EqualTo(1))); - private static void SetInjectedGlobalConfig(SettingsModellingNotifications component, GlobalConfig globalConfig) - { - PropertyInfo? prop = typeof(SettingsModellingNotifications).GetProperties(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance) - .FirstOrDefault(p => p.PropertyType == typeof(GlobalConfig)); - if (prop == null) - { - throw new MissingMemberException(typeof(SettingsModellingNotifications).FullName, "globalConfig"); - } - prop.SetValue(component, globalConfig); - } + IElement interfaceNameInput = page.FindAll("label") + .First(label => label.TextContent.Contains("Name of requested interface")) + .ParentElement! + .QuerySelector("input")!; + interfaceNameInput.Change("New interface name"); - private static void SetInjectedApiConnection(SettingsModellingNotifications component, RecordingSettingsApiConn apiConnection) - { - PropertyInfo? prop = typeof(SettingsModellingNotifications).GetProperties(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance) - .FirstOrDefault(p => p.PropertyType == typeof(ApiConnection)); - if (prop == null) + IElement saveButton = page.FindAll("button") + .Last(button => button.QuerySelector("span[title='Save']") != null); + saveButton.Click(); + + page.WaitForAssertion(() => { - throw new MissingMemberException(typeof(SettingsModellingNotifications).FullName, "apiConnection"); - } - prop.SetValue(component, apiConnection); + SettingsModellingNotificationsApiConn apiConnection = context.Services.GetRequiredService() as SettingsModellingNotificationsApiConn + ?? throw new InvalidOperationException("Test api connection missing."); + Assert.That(apiConnection.UpsertConfigCallCount, Is.EqualTo(1)); + }); + + SettingsModellingNotificationsApiConn apiConn = context.Services.GetRequiredService() as SettingsModellingNotificationsApiConn + ?? throw new InvalidOperationException("Test api connection missing."); + Assert.That(apiConn.LastUpsertConfigItems, Has.Count.EqualTo(1)); + Assert.That(apiConn.LastUpsertConfigItems[0].Key, Is.EqualTo("modReqInterfaceName")); + Assert.That(apiConn.LastUpsertConfigItems[0].Value, Is.EqualTo("New interface name")); } [Test] - public void MergeLegacyOtherAddresses_MergesUniqueAddressesAndSetsSelectionFlags() + public async Task Page_ShowsLoadingAndReportsErrorWhenGlobalConfigIsUnavailable() { - EmailRecipientSelection selection = new() - { - None = true, - OtherAddresses = false, - OtherAddressList = RequestLegacyAddresses.ToList() - }; + await using BunitContext context = CreateContext(disposeGlobalConfig: true); + List<(Exception? Exception, string Title, string Message, bool IsError)> messages = []; - object?[] mergeLegacyArgs = - [ - selection, - "new@example.org; existing@example.org | second@example.org" - ]; - GetPrivateMethod("MergeLegacyOtherAddresses").Invoke(null, mergeLegacyArgs); + IRenderedComponent wrapper = RenderPage(context, (exception, title, message, isError) => messages.Add((exception, title, message, isError))); + IRenderedComponent page = wrapper.FindComponent(); - Assert.Multiple(() => + page.WaitForAssertion(() => { - Assert.That(selection.OtherAddresses, Is.True); - Assert.That(selection.None, Is.False); - Assert.That(selection.OtherAddressList, Is.EqualTo(new List { "legacy-request@example.org", "new@example.org", "existing@example.org", "second@example.org" })); + Assert.That(messages, Has.Count.EqualTo(1)); + Assert.That(messages[0].Title, Is.EqualTo(new SimulatedUserConfig().GetText("read_config"))); + Assert.That(messages[0].Message, Is.EqualTo(new SimulatedUserConfig().GetText("E5301"))); + Assert.That(messages[0].IsError, Is.False); + Assert.That(page.FindAll("div[role='status']"), Has.Count.EqualTo(1)); }); } [Test] - public async Task OnInitializedAsync_LoadsRecipientsAndMergesLegacyAddresses() + public async Task Save_ReportsErrorWhenConfigWriteFails() { - SettingsModellingNotifications component = new(); - SimulatedGlobalConfig globalConfig = new() - { - ModReqEmailReceiver = new EmailRecipientSelection - { - OwnerResponsibleTypeIds = RequestRecipientTypeIds - }.ToConfigValue(ActiveRecipientTypeIds), - ModReqEmailOtherAddresses = "legacy-request@example.org", - ModDecommEmailReceiver = new EmailRecipientSelection - { - OwnerResponsibleTypeIds = DecommRecipientTypeIds - }.ToConfigValue(ActiveRecipientTypeIds), - ModDecommEmailOtherAddresses = "legacy-decomm@example.org" - }; - RecordingSettingsApiConn apiConnection = new() - { - OwnerResponsibleTypes = - [ - new() { Id = 1, Active = true, Name = "Main", SortOrder = 1 }, - new() { Id = 2, Active = true, Name = "Supporting", SortOrder = 2 }, - new() { Id = 3, Active = false, Name = "Inactive", SortOrder = 3 } - ] - }; + await using BunitContext context = CreateContext(throwOnUpsert: true); + List<(Exception? Exception, string Title, string Message, bool IsError)> messages = []; - SetInjectedGlobalConfig(component, globalConfig); - SetInjectedApiConnection(component, apiConnection); + IRenderedComponent wrapper = RenderPage(context, (exception, title, message, isError) => messages.Add((exception, title, message, isError))); + IRenderedComponent page = wrapper.FindComponent(); - Task initTask = (Task)GetPrivateMethod("OnInitializedAsync").Invoke(component, null)!; - await initTask; + page.WaitForAssertion(() => Assert.That(page.FindAll("form"), Has.Count.EqualTo(1))); - EmailRecipientSelection modReq = GetPrivateField(component, "modReqEmailRecipients"); - EmailRecipientSelection modDecomm = GetPrivateField(component, "modDecommEmailRecipients"); + IElement interfaceNameInput = page.FindAll("label") + .First(label => label.TextContent.Contains("Name of requested interface")) + .ParentElement! + .QuerySelector("input")!; + interfaceNameInput.Change("New interface name"); - Assert.Multiple(() => + IElement saveButton = page.FindAll("button") + .Last(button => button.QuerySelector("span[title='Save']") != null); + saveButton.Click(); + + page.WaitForAssertion(() => { - Assert.That(modReq.OwnerResponsibleTypeIds, Is.EqualTo(RequestRecipientTypeIds)); - Assert.That(modReq.OtherAddressList, Is.EqualTo(RequestLegacyAddresses)); - Assert.That(modDecomm.OwnerResponsibleTypeIds, Is.EqualTo(DecommRecipientTypeIds)); - Assert.That(modDecomm.OtherAddressList, Is.EqualTo(DecommLegacyAddresses)); + Assert.That(messages, Has.Count.EqualTo(1)); + Assert.That(messages[0].Title, Is.EqualTo(new SimulatedUserConfig().GetText("notifications"))); + Assert.That(messages[0].IsError, Is.True); }); } - [Test] - public async Task OnInitializedAsync_WhenOwnerQueryFails_KeepsFormAndSaveHidden() + private static BunitContext CreateContext(bool disposeGlobalConfig = false, bool throwOnUpsert = false) { SimulatedGlobalConfig globalConfig = new() { - ModReqEmailReceiver = new EmailRecipientSelection - { - OwnerResponsibleTypeIds = RequestRecipientTypeIds - }.ToConfigValue(ActiveRecipientTypeIds), - ModReqEmailOtherAddresses = "legacy-request@example.org", - ModDecommEmailReceiver = new EmailRecipientSelection - { - OwnerResponsibleTypeIds = DecommRecipientTypeIds - }.ToConfigValue(ActiveRecipientTypeIds), - ModDecommEmailOtherAddresses = "legacy-decomm@example.org" + ModReqInterfaceName = "Old interface name", + ModReqTicketTitle = "Old ticket title", + ModReqTaskTitle = "Old task title" + }; + if (disposeGlobalConfig) + { + globalConfig.Dispose(); + } + + SettingsModellingNotificationsApiConn apiConnection = new() + { + ThrowOnUpsert = throwOnUpsert, + OwnerResponsibleTypes = + [ + new() { Id = 1, Active = true, Name = "Main", SortOrder = 1 }, + new() { Id = 2, Active = true, Name = "Supporting", SortOrder = 2 } + ] }; - ThrowingSettingsApiConn apiConnection = new(OwnerQueries.getOwnerResponsibleTypes); - RecordingMessageSink sink = new(); - await using BunitContext context = new(); + SimulatedUserConfig userConfig = new(); + userConfig.User.Roles = [Roles.Admin]; + userConfig.SetExecutionMode(Roles.Admin); + + BunitContext context = new(); context.JSInterop.Mode = JSRuntimeMode.Loose; + context.Services.AddLocalization(); context.Services.AddAuthorizationCore(); context.Services.AddSingleton(); context.Services.AddSingleton(new AllowAllAuthStateProvider(Roles.Admin)); context.Services.AddSingleton(apiConnection); context.Services.AddSingleton(globalConfig); - context.Services.AddSingleton(new SimulatedUserConfig()); - - IRenderedComponent wrapper = context.Render(parameters => parameters - .AddChildContent>>(child => child - .Add(p => p.Value, sink.Handler) - .AddChildContent())); - - wrapper.WaitForAssertion(() => - { - Assert.That(wrapper.FindAll("form"), Is.Empty); - Assert.That(wrapper.FindAll("button"), Is.Empty); - Assert.That(sink.Messages, Has.Count.EqualTo(1)); - Assert.That(apiConnection.UpsertConfigCallCount, Is.Zero); - }); + context.Services.AddSingleton(userConfig); + context.Services.AddSingleton(typeof(IStringLocalizer<>), typeof(EmptyStringLocalizer<>)); + return context; } - [Test] - public void PrepareConfigData_SerializesRecipientsAndClearsLegacyAddresses() + private static IRenderedComponent RenderPage( + BunitContext context, + Action? messageSink = null) { - SettingsModellingNotifications component = new(); - ConfigData configData = new(); - SetPrivateField(component, "configData", configData); - SetPrivateField(component, "activeOwnerResponsibleTypes", new List - { - new() { Id = 1, Active = true, Name = "Main" }, - new() { Id = 2, Active = true, Name = "Supporting" } - }); - SetPrivateField(component, "modReqEmailRecipients", new EmailRecipientSelection - { - OwnerResponsibleTypeIds = RequestRecipientTypeIds, - OtherAddresses = true, - OtherAddressList = RequestOtherAddressList - }); - SetPrivateField(component, "modDecommEmailRecipients", new EmailRecipientSelection - { - OwnerResponsibleTypeIds = DecommRecipientTypeIds, - OtherAddresses = true, - OtherAddressList = DecommOtherAddressList - }); - - GetPrivateMethod("PrepareConfigData").Invoke(component, null); - - Assert.Multiple(() => - { - Assert.That(configData.ModReqEmailReceiver, Does.Contain("\"owner_responsible_type_ids\":[1]")); - Assert.That(configData.ModDecommEmailReceiver, Does.Contain("\"owner_responsible_type_ids\":[2]")); - Assert.That(configData.ModReqEmailOtherAddresses, Is.Empty); - Assert.That(configData.ModDecommEmailOtherAddresses, Is.Empty); - }); - } - - private sealed class RecordingMessageSink - { - public List<(Exception? Exception, string Title, string Message, bool IsError)> Messages { get; } = []; - - public void Handler(Exception? exception, string title, string message, bool isError) - { - Messages.Add((exception, title, message, isError)); - } + return context.Render(parameters => parameters + .AddChildContent(builder => + { + builder.OpenComponent>>(0); + builder.AddAttribute(1, "Value", messageSink ?? ((_, _, _, _) => { })); + builder.AddAttribute(2, "IsFixed", true); + builder.AddAttribute(3, "ChildContent", (RenderFragment)(childBuilder => + { + childBuilder.OpenComponent(0); + childBuilder.CloseComponent(); + })); + builder.CloseComponent(); + })); } - private sealed class ThrowingSettingsApiConn : SimulatedApiConnection + private sealed class SettingsModellingNotificationsApiConn : NotificationTestApiConn { - private readonly string failedQuery; - + public List OwnerResponsibleTypes { get; init; } = []; public int UpsertConfigCallCount { get; private set; } + public List LastUpsertConfigItems { get; private set; } = []; + public bool ThrowOnUpsert { get; init; } - public ThrowingSettingsApiConn(string failedQuery) + public override async Task SendQueryAsync(string query, object? variables = null, string? operationName = null, QueryChunkingOptions? chunkingOptions = null) { - this.failedQuery = failedQuery; - } - - public override Task SendQueryAsync(string query, object? variables = null, string? operationName = null, QueryChunkingOptions? chunkingOptions = null) - { - if (query == failedQuery) + if (query == OwnerQueries.getOwnerResponsibleTypes && typeof(QueryResponseType) == typeof(List)) { - throw new InvalidOperationException("Injected load failure."); + return (QueryResponseType)(object)OwnerResponsibleTypes; } if (query == ConfigQueries.upsertConfigItems) { UpsertConfigCallCount++; + if (ThrowOnUpsert) + { + throw new InvalidOperationException("Config write failed."); + } + if (variables != null) + { + PropertyInfo? configItemsProperty = variables.GetType().GetProperty("config_items"); + LastUpsertConfigItems = configItemsProperty == null + ? [] + : ((IEnumerable)configItemsProperty.GetValue(variables)!).ToList(); + } + + return default!; } - return Task.FromResult(default(QueryResponseType)!); + return await base.SendQueryAsync(query, variables, operationName, chunkingOptions); } } + + private sealed class EmptyStringLocalizer : IStringLocalizer + { + public LocalizedString this[string name] => new(name, name, resourceNotFound: true); + + public LocalizedString this[string name, params object[] arguments] => new(name, string.Format(name, arguments), resourceNotFound: true); + + public IEnumerable GetAllStrings(bool includeParentCultures) => []; + + public IStringLocalizer WithCulture(System.Globalization.CultureInfo culture) => this; + } } } diff --git a/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml b/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml index 751bb6eaf7..74d0e06562 100644 --- a/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml +++ b/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml @@ -13,19 +13,22 @@

    @(userConfig.GetText("notifications"))

    -

    @(Html.Raw(userConfig.GetText("request_interface")))

    +

    @(Html.Raw(userConfig.GetText("initial_request")))

    • @(Html.Raw(userConfig.GetText("H5622")))
      • -
    • @(Html.Raw(userConfig.GetText("H5630")))
      • -
    • @(Html.Raw(userConfig.GetText("H5623")))
      • -
    • @(Html.Raw(userConfig.GetText("H5624")))
    • @(Html.Raw(userConfig.GetText("H5625")))
    • @(Html.Raw(userConfig.GetText("H5626")))
      • -
    • @(Html.Raw(userConfig.GetText("H5624a")))
      • +
    • @(Html.Raw(userConfig.GetText("H5630")))
      • +
    • @(Html.Raw(userConfig.GetText("H5624")))
    -

    @(Html.Raw(userConfig.GetText("reminders")))

    +

    @(Html.Raw(userConfig.GetText("reminder")))

    • @(Html.Raw(userConfig.GetText("H5629")))
      • +
    • @(Html.Raw(userConfig.GetText("H5624a")))
      • +
    • @(Html.Raw(userConfig.GetText("H4106")))
      • +
    • @(Html.Raw(userConfig.GetText("H4107")))
      • +
    • @(Html.Raw(userConfig.GetText("H4108")))
      • +
    • @(Html.Raw(userConfig.GetText("H4108a")))

    @(Html.Raw(userConfig.GetText("decommission")))

      diff --git a/roles/ui/files/FWO.UI/Pages/NetworkModelling/RequestInterfacePopup.razor b/roles/ui/files/FWO.UI/Pages/NetworkModelling/RequestInterfacePopup.razor index 0fe8b27322..86fe5c1129 100644 --- a/roles/ui/files/FWO.UI/Pages/NetworkModelling/RequestInterfacePopup.razor +++ b/roles/ui/files/FWO.UI/Pages/NetworkModelling/RequestInterfacePopup.razor @@ -1,7 +1,8 @@ -@using FWO.Middleware.Client - +@using FWO.Data +@using FWO.Api.Client.Queries @using FWO.Compliance - +@using FWO.Middleware.Client +@using FWO.Services @inject ApiConnection apiConnection @inject UserConfig userConfig @inject MiddlewareClient middlewareClient @@ -150,19 +151,24 @@ } private async Task SendEmail(long connId) - { + { try { - EmailHelper emailHelper = new(apiConnection, middlewareClient, userConfig, DisplayMessageInUi); - + EmailHelper emailHelper = new(apiConnection, middlewareClient, userConfig, DisplayMessageInUi); await emailHelper.Init(); - string interfaceUrl = $"{userConfig.UiHostName}/{PageName.Modelling}/{SelectedOwner.ExtAppId}/{connId}"; - string subject = userConfig.ModReqEmailSubject; - string body = $"{RequestingOwner.Name} {userConfig.ModReqEmailBody} {SelectedOwner.Name}
      " + - $"{userConfig.GetText("interface")}: {InterfaceName}
      "; - List legacyOtherAddresses = EmailHelper.SplitAddresses(userConfig.ModReqEmailOtherAddresses); - if(await emailHelper.SendEmailToOwnerResponsibles(SelectedOwner, subject, body, userConfig.ModReqEmailReceiver, userConfig.ModReqEmailRequesterInCc, legacyOtherAddresses)) + FwoNotification? notification = await LoadImmediateRequestNotification(); + if (notification == null) + { + DisplayMessageInUi(null, userConfig.GetText("send_email"), userConfig.GetText("E9011"), true); + return; + } + + NotificationPlaceholderResolver.NotificationPlaceholderValues requestPlaceholderValues = BuildRequestPlaceholderValues(connId); + string subject = BuildRequestEmailSubject(notification, requestPlaceholderValues); + string body = BuildRequestEmailBody(notification, requestPlaceholderValues); + bool sent = await emailHelper.SendEmailToNotificationRecipients(notification, SelectedOwner, subject, body); + if (sent) { DisplayMessageInUi(null, userConfig.GetText("send_email"), userConfig.GetText("U9011"), false); } @@ -177,6 +183,57 @@ } } + private async Task LoadImmediateRequestNotification() + { + List notifications; + try + { + notifications = await apiConnection.SendQueryAsync>(NotificationQueries.getNotifications, + new { client = NotificationClient.InterfaceRequest.ToString() }); + } + catch + { + notifications = new List(); + } + + return notifications.FirstOrDefault(notification => notification.Deadline == NotificationDeadline.None); + } + + private NotificationPlaceholderResolver.NotificationPlaceholderValues BuildRequestPlaceholderValues(long connId) + { + string interfaceUrl = $"{userConfig.UiHostName}/{PageName.Modelling}/{SelectedOwner.ExtAppId}/{connId}"; + return new NotificationPlaceholderResolver.NotificationPlaceholderValues + { + Application = SelectedOwner, + RequestingOwner = RequestingOwner, + InterfaceName = InterfaceName, + InterfaceLinkText = userConfig.GetText("request_interface"), + InterfaceLinkName = InterfaceName, + InterfaceLinkUrl = interfaceUrl, + NewInterfaceName = InterfaceName, + NewInterfaceLinkText = userConfig.GetText("request_interface"), + NewInterfaceLinkName = InterfaceName, + NewInterfaceLinkUrl = interfaceUrl, + Reason = Reason, + UserName = userConfig.User.Name, + RequesterName = userConfig.User.Name, + RequestDate = DateTime.Now.ToString("dd.MM.yyyy") + }; + } + + private static string BuildRequestEmailSubject(FwoNotification notification, NotificationPlaceholderResolver.NotificationPlaceholderValues requestPlaceholderValues) + { + return NotificationPlaceholderResolver.ReplaceNotificationPlaceholders(notification.EmailSubject, requestPlaceholderValues); + } + + private static string BuildRequestEmailBody(FwoNotification notification, NotificationPlaceholderResolver.NotificationPlaceholderValues requestPlaceholderValues) + { + return NotificationPlaceholderResolver.ReplaceNotificationPlaceholders( + NotificationEmailLayoutHelper.BuildBody(notification, (string?)null), + requestPlaceholderValues, + renderHtmlLinks: true); + } + private void Close() { Display = false; diff --git a/roles/ui/files/FWO.UI/Pages/Settings/EmailRecipientSelectionEditor.razor b/roles/ui/files/FWO.UI/Pages/Settings/EmailRecipientSelectionEditor.razor index b6b0b273cb..0886b5f0c4 100644 --- a/roles/ui/files/FWO.UI/Pages/Settings/EmailRecipientSelectionEditor.razor +++ b/roles/ui/files/FWO.UI/Pages/Settings/EmailRecipientSelectionEditor.razor @@ -3,6 +3,15 @@ @inject UserConfig userConfig
      + @if (ShowRequesterOption) + { +
      + + +
      + } @if (ShowOwnerResponsibleTypes) { @foreach (OwnerResponsibleType ownerResponsibleType in GetOrderedOwnerResponsibleTypes()) @@ -55,6 +64,9 @@ [Parameter] public NotificationClient Client { get; set; } = NotificationClient.None; + [Parameter] + public bool ShowRequesterOption { get; set; } = false; + private bool ShowOwnerResponsibleTypes => Client == NotificationClient.None || Client.IsModellingRecipientClient(); private bool ShowEnsureAtLeastOneNotification => ShowOwnerResponsibleTypes; private List GetOrderedOwnerResponsibleTypes() @@ -79,6 +91,20 @@ } } + private void ToggleRequesterSelection(ChangeEventArgs args) + { + bool isChecked = IsChecked(args); + Selection.Requester = isChecked; + if (isChecked) + { + Selection.None = false; + } + else + { + UpdateDerivedNone(); + } + } + private Task SetOtherAddressList(List addresses) { Selection.OtherAddressList = addresses; @@ -111,7 +137,7 @@ private void UpdateDerivedNone() { - Selection.None = !Selection.OtherAddresses && Selection.OwnerResponsibleTypeIds.Count == 0; + Selection.None = !Selection.Requester && !Selection.OtherAddresses && Selection.OwnerResponsibleTypeIds.Count == 0; } private static bool IsChecked(ChangeEventArgs args) diff --git a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor index c128cb0165..57ba28e86b 100644 --- a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor +++ b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor @@ -24,65 +24,36 @@ @if (configData != null && initComplete) {
      +

      @(userConfig.GetText("initial_request"))

      - -
      - -
      -
      -
      - -
      - -
      -
      -
      - - -
      -
      - - -
      -
      -
      +
      -
      - - +
      +
      -
      - -
      - -
      +
      +

      @(userConfig.GetText("reminder"))

      +
      -
      -
      - -
      - -
      -
      -
      - - +
      +
      +

      @(userConfig.GetText("decomm_owner"))

      -
      - - +
      +
      @@ -110,9 +81,6 @@ else Action DisplayMessageInUi { get; set; } = DefaultInit.DoNothing; private ConfigData? configData; - private List activeOwnerResponsibleTypes = []; - private EmailRecipientSelection modReqEmailRecipients = new(); - private EmailRecipientSelection modDecommEmailRecipients = new(); private bool initComplete; protected override async Task OnInitializedAsync() @@ -120,15 +88,6 @@ else try { ConfigData editableConfig = await globalConfig.GetEditableConfig(); - List ownerResponsibleTypes = await apiConnection.SendQueryAsync>(OwnerQueries.getOwnerResponsibleTypes); - activeOwnerResponsibleTypes = ownerResponsibleTypes - .Where(type => type.Active) - .ToList(); - List activeTypeIds = activeOwnerResponsibleTypes.Select(type => type.Id).ToList(); - modReqEmailRecipients = EmailRecipientSelection.Parse(editableConfig.ModReqEmailReceiver, activeTypeIds); - modDecommEmailRecipients = EmailRecipientSelection.Parse(editableConfig.ModDecommEmailReceiver, activeTypeIds); - MergeLegacyOtherAddresses(modReqEmailRecipients, editableConfig.ModReqEmailOtherAddresses); - MergeLegacyOtherAddresses(modDecommEmailRecipients, editableConfig.ModDecommEmailOtherAddresses); configData = editableConfig; initComplete = true; } @@ -147,7 +106,6 @@ else throw new ArgumentException("Data saved before loaded. This should be impossible."); } - PrepareConfigData(); await globalConfig.WriteToDatabase(configData, apiConnection); DisplayMessageInUi(null, userConfig.GetText("notifications"), userConfig.GetText("U5301"), false); } @@ -156,32 +114,4 @@ else DisplayMessageInUi(exception, userConfig.GetText("notifications"), "", true); } } - - private void PrepareConfigData() - { - List activeTypeIds = activeOwnerResponsibleTypes.Select(type => type.Id).ToList(); - configData!.ModReqEmailReceiver = modReqEmailRecipients.ToConfigValue(activeTypeIds); - configData!.ModDecommEmailReceiver = modDecommEmailRecipients.ToConfigValue(activeTypeIds); - configData!.ModReqEmailOtherAddresses = ""; - configData!.ModDecommEmailOtherAddresses = ""; - } - - private static void MergeLegacyOtherAddresses(EmailRecipientSelection selection, string legacyOtherAddresses) - { - List addresses = EmailHelper.SplitAddresses(legacyOtherAddresses); - if (addresses.Count == 0) - { - return; - } - - selection.OtherAddresses = true; - selection.None = false; - foreach (string address in addresses) - { - if (!selection.OtherAddressList.Contains(address, StringComparer.OrdinalIgnoreCase)) - { - selection.OtherAddressList.Add(address); - } - } - } } diff --git a/roles/ui/files/FWO.UI/Shared/EditNotifications.razor b/roles/ui/files/FWO.UI/Shared/EditNotifications.razor index 2590f3004f..2cd4622077 100644 --- a/roles/ui/files/FWO.UI/Shared/EditNotifications.razor +++ b/roles/ui/files/FWO.UI/Shared/EditNotifications.razor @@ -93,7 +93,11 @@
      - @if(OfferedDeadlineOptions().Count > 1) + @if (IsDeadlineLocked) + { + @(userConfig.GetText(actNotification.Deadline.ToString())) + } + else if(OfferedDeadlineOptions().Count > 1) { @@ -182,7 +186,7 @@
      @@ -191,7 +195,7 @@
      @@ -199,7 +203,7 @@
      @@ -261,11 +265,14 @@ [Parameter] public EventCallback> NotificationIdsChanged { get; set; } + [Parameter] + public NotificationDeadline? DeadlineFilter { get; set; } + private List Notifications = []; private List DisplayedNotifications => - NotificationIds == null - ? Notifications - : [.. Notifications.Where(notification => NotificationIds.Contains(notification.Id))]; + [.. Notifications + .Where(notification => DeadlineFilter == null || notification.Deadline == DeadlineFilter) + .Where(notification => NotificationIds == null || NotificationIds.Contains(notification.Id))]; private FwoNotification actNotification = new(); private List ToAddresses = []; @@ -281,6 +288,8 @@ private bool DeleteNotifMode = false; private bool ResetNotifMode = false; private const string EditNotifString = "edit_notification"; + private bool ShowRequesterOption => Client == NotificationClient.InterfaceRequest; + private bool IsDeadlineLocked => DeadlineFilter.HasValue; protected override async Task OnInitializedAsync() @@ -303,6 +312,7 @@ actNotification.RecipientTo = EmailRecipientOption.None; actNotification.RecipientCc = EmailRecipientOption.None; actNotification.RecipientBcc = EmailRecipientOption.None; + ApplyDeadlineFilter(); ToRecipientSelection = CreateDefaultToSelection(); CcRecipientSelection = CreateDefaultSelectionForRecipient(actNotification.RecipientCc); BccRecipientSelection = CreateDefaultSelectionForRecipient(actNotification.RecipientBcc); @@ -331,6 +341,7 @@ private void EditNotification(FwoNotification notification) { actNotification = new FwoNotification(notification); + ApplyDeadlineFilter(); ToAddresses = EmailHelper.SplitAddresses(notification.EmailAddressTo); CcAddresses = EmailHelper.SplitAddresses(notification.EmailAddressCc); BccAddresses = EmailHelper.SplitAddresses(notification.EmailAddressBcc); @@ -393,6 +404,10 @@ .ThenBy(type => type.Name, StringComparer.OrdinalIgnoreCase) .Select(GetOwnerResponsibleTypeDisplayName) .ToList(); + if (selection.Requester) + { + selectedTypeNames.Add(userConfig.GetText(nameof(EmailRecipientOption.Requester))); + } if (selection.OtherAddresses) { selectedTypeNames.Add(userConfig.GetText(nameof(EmailRecipientOption.OtherAddresses))); @@ -603,6 +618,11 @@ private List OfferedDeadlineOptions() { + if (DeadlineFilter.HasValue) + { + return new List { DeadlineFilter.Value }; + } + return FwoNotification.OfferedDeadlineOptions(Client); } @@ -610,6 +630,7 @@ { try { + ApplyDeadlineFilter(); SyncAddresses(); EnsureNotificationIntervals(); if(CheckConsistency()) @@ -636,6 +657,7 @@ private void SyncAddresses() { + ApplyDeadlineFilter(); if (Client.IsWorkflowRecipientClient()) { return; @@ -647,6 +669,7 @@ actNotification.RecipientBcc = string.IsNullOrWhiteSpace(actNotification.EmailAddressBcc) ? EmailRecipientOption.None : EmailRecipientOption.OtherAddresses; return; } + NormalizeRequesterSelections(); (actNotification.RecipientTo, actNotification.EmailAddressTo) = RecipientFieldsFromSelection(ToRecipientSelection, ToAddresses); (actNotification.RecipientCc, actNotification.EmailAddressCc) = RecipientFieldsFromSelection(CcRecipientSelection, CcAddresses); (actNotification.RecipientBcc, actNotification.EmailAddressBcc) = RecipientFieldsFromSelection(BccRecipientSelection, BccAddresses); @@ -661,7 +684,7 @@ } string recipientValue = effectiveSelection.ToConfigValue(ActiveOwnerResponsibleTypeIds()); - return effectiveSelection.OwnerResponsibleTypeIds.Count > 0 + return effectiveSelection.OwnerResponsibleTypeIds.Count > 0 || effectiveSelection.Requester ? (EmailRecipientOption.ConfiguredResponsibles, recipientValue) : (EmailRecipientOption.OtherAddresses, recipientValue); } @@ -678,10 +701,23 @@ private static bool HasEffectiveRecipient(EmailRecipientSelection selection, List legacyAddresses) { return selection.OwnerResponsibleTypeIds.Count > 0 + || selection.Requester || selection.OtherAddresses && selection.OtherAddressList.Count > 0 || legacyAddresses.Count > 0; } + private void NormalizeRequesterSelections() + { + if (ShowRequesterOption) + { + return; + } + + ToRecipientSelection.Requester = false; + CcRecipientSelection.Requester = false; + BccRecipientSelection.Requester = false; + } + private void EnsureNotificationIntervals() { if (actNotification.OffsetBeforeDeadline != null && actNotification.IntervalBeforeDeadline == null) @@ -749,6 +785,14 @@ || recipientOption == EmailRecipientOption.OtherAddresses && EmailHelper.SplitAddresses(addresses).Count == 0; } + private void ApplyDeadlineFilter() + { + if (DeadlineFilter.HasValue) + { + actNotification.Deadline = DeadlineFilter.Value; + } + } + private Task SetDirectAddressTo(string addresses) { actNotification.EmailAddressTo = addresses; From 180f8ad0b431d997f7d0e5d5ed4237816da059ff Mon Sep 17 00:00:00 2001 From: abarz722 Date: Sun, 30 Aug 2026 12:14:03 +0200 Subject: [PATCH 02/48] fix + revision --- documentation/revision-history.md | 4 ++++ inventory/group_vars/all.yml | 2 +- roles/database/files/sql/idempotent/fworch-texts.sql | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/documentation/revision-history.md b/documentation/revision-history.md index 76e7e74ea3..43403efa1d 100644 --- a/documentation/revision-history.md +++ b/documentation/revision-history.md @@ -634,3 +634,7 @@ Not supported any longer are: - Rule and connection reports filtered by destination port or protocol now also match the canonical ANY service, so these filters can return more rows than before the upgrade. - Cisco ASA: keep the legacy `ANY` UID for the imported "any ip protocol" service object while showing it as `any-ip` in reports; existing compliance criteria or queries pinned to the old `any-ip` UID need to be updated to use `ANY` instead. - OPNsense: a `tcp/udp` rule with no destination port now creates and references two separate service objects (`Any/tcp` and `Any/udp`) instead of one combined object. + +## 9.4.5 - 30.08.2026 +- rework modelling notifications and move interface-request notifications to centralized notification entries +- interface-request notifications now support separate request and reminder bodies plus optional CC to the requester diff --git a/inventory/group_vars/all.yml b/inventory/group_vars/all.yml index 42f8fa6efe..8e57796df5 100644 --- a/inventory/group_vars/all.yml +++ b/inventory/group_vars/all.yml @@ -1,5 +1,5 @@ ### general settings -product_version: "9.4.4" +product_version: "9.4.5" ansible_user: "{{ lookup('env', 'USER') }}" ansible_become_method: sudo ansible_python_interpreter: /usr/bin/python3 diff --git a/roles/database/files/sql/idempotent/fworch-texts.sql b/roles/database/files/sql/idempotent/fworch-texts.sql index efd4df1e68..f0461bb102 100644 --- a/roles/database/files/sql/idempotent/fworch-texts.sql +++ b/roles/database/files/sql/idempotent/fworch-texts.sql @@ -1,4 +1,4 @@ --- text codes (roughly) categorized: +-- text codes (roughly) categorized: -- U: user texts (explanation or confirmation texts) -- E: error texts -- A: Api errors From 023eba81e2c8f32011f8a4702dc33e9f6ecd11da Mon Sep 17 00:00:00 2001 From: abarz722 Date: Mon, 31 Aug 2026 19:21:11 +0200 Subject: [PATCH 03/48] notification log --- roles/api/files/replace_metadata.json | 165 +++++++++++++++--- .../monitor/getNotificationLogEntrys.graphql | 11 ++ .../notification/addNotification.graphql | 2 + .../notification/getNotifications.graphql | 1 + .../notification/updateNotification.graphql | 2 + .../insertNotificationLog.graphql | 5 + .../creation/fworch-create-tables-base.sql | 14 +- .../files/sql/idempotent/fworch-texts.sql | 17 ++ roles/database/files/upgrade/9.4.5.sql | 18 ++ .../FWO.Api.Client/Queries/MonitorQueries.cs | 2 + .../Queries/NotificationQueries.cs | 2 + roles/lib/files/FWO.Data/FwoNotification.cs | 23 +++ .../files/FWO.Data/NotificationLogEntry.cs | 32 ++++ .../EmailNotification/EmailHelper.cs | 30 ++++ .../FWO.Test/EmailHelperRecipientTest.cs | 105 ++++++++++- .../NotificationMutationHelperTest.cs | 11 +- .../files/FWO.Test/UiEditNotificationsTest.cs | 1 + .../FWO.Test/UiMonitoringLogPagesTest.cs | 39 +++++ .../UiSettingsModellingNotificationsTest.cs | 4 +- .../Pages/Help/HelpMonitoringEmailLog.cshtml | 17 ++ .../Pages/Help/HelpMonitoringSidebar.cshtml | 5 + .../HelpSettingsModellingNotifications.cshtml | 1 + roles/ui/files/FWO.UI/Pages/Help/Index.cshtml | 3 + .../Pages/Monitoring/MonitorEmailLog.razor | 62 +++++++ .../SettingsModellingNotifications.razor | 6 +- .../Services/NotificationMutationHelper.cs | 9 +- .../FWO.UI/Shared/EditNotifications.razor | 13 ++ .../FWO.UI/Shared/MonitoringLayout.razor | 9 + 28 files changed, 572 insertions(+), 37 deletions(-) create mode 100644 roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql create mode 100644 roles/common/files/fwo-api-calls/notification_log/insertNotificationLog.graphql create mode 100644 roles/lib/files/FWO.Data/NotificationLogEntry.cs create mode 100644 roles/ui/files/FWO.UI/Pages/Help/HelpMonitoringEmailLog.cshtml create mode 100644 roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor diff --git a/roles/api/files/replace_metadata.json b/roles/api/files/replace_metadata.json index 4ad057d01a..f741c7b336 100644 --- a/roles/api/files/replace_metadata.json +++ b/roles/api/files/replace_metadata.json @@ -11765,7 +11765,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ] }, "comment": "" @@ -11800,7 +11801,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ] }, "comment": "" @@ -11835,7 +11837,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ] }, "comment": "" @@ -11870,7 +11873,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ] }, "comment": "" @@ -11905,7 +11909,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ] }, "comment": "" @@ -11940,7 +11945,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ] }, "comment": "" @@ -11976,7 +11982,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "notification_client": { @@ -12015,7 +12022,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": {} }, @@ -12050,7 +12058,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_or": [ @@ -12098,7 +12107,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "notification_client": { @@ -12137,7 +12147,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": {} }, @@ -12172,7 +12183,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_or": [ @@ -12220,7 +12232,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "notification_client": { @@ -12259,7 +12272,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_or": [ @@ -12307,7 +12321,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_or": [ @@ -12355,7 +12370,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_or": [ @@ -12403,7 +12419,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "notification_client": { @@ -12442,7 +12459,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "notification_client": { @@ -12483,7 +12501,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_and": [ @@ -12563,7 +12582,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_or": [ @@ -12600,7 +12620,8 @@ "role": "middleware-server", "permission": { "columns": [ - "last_sent" + "last_sent", + "logging" ], "filter": {}, "check": {} @@ -12636,7 +12657,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_or": [ @@ -12698,7 +12720,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_or": [ @@ -12760,7 +12783,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_or": [ @@ -12822,7 +12846,8 @@ "repetitions_after_deadline", "schedule_id", "user_id", - "last_sent" + "last_sent", + "logging" ], "filter": { "_or": [ @@ -12988,6 +13013,96 @@ } ] }, + { + "table": { + "name": "notification_log", + "schema": "public" + }, + "insert_permissions": [ + { + "role": "fw-admin", + "permission": { + "check": {}, + "columns": [ + "timestamp", + "notification_id", + "notification_type", + "to", + "cc", + "bcc", + "subject" + ] + }, + "comment": "" + }, + { + "role": "middleware-server", + "permission": { + "check": {}, + "columns": [ + "timestamp", + "notification_id", + "notification_type", + "to", + "cc", + "bcc", + "subject" + ] + }, + "comment": "" + }, + { + "role": "modeller", + "permission": { + "check": {}, + "columns": [ + "timestamp", + "notification_id", + "notification_type", + "to", + "cc", + "bcc", + "subject" + ] + }, + "comment": "" + } + ], + "select_permissions": [ + { + "role": "auditor", + "permission": { + "columns": [ + "timestamp", + "notification_id", + "notification_type", + "to", + "cc", + "bcc", + "subject" + ], + "filter": {} + }, + "comment": "" + }, + { + "role": "fw-admin", + "permission": { + "columns": [ + "timestamp", + "notification_id", + "notification_type", + "to", + "cc", + "bcc", + "subject" + ], + "filter": {} + }, + "comment": "" + } + ] + }, { "table": { "name": "nw_object", diff --git a/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql b/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql new file mode 100644 index 0000000000..57393b05f9 --- /dev/null +++ b/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql @@ -0,0 +1,11 @@ +query getNotificationLogEntrys { + notification_log(order_by: { timestamp: desc }) { + timestamp + notification_id + notification_type + to + cc + bcc + subject + } +} diff --git a/roles/common/files/fwo-api-calls/notification/addNotification.graphql b/roles/common/files/fwo-api-calls/notification/addNotification.graphql index a9c24e93ea..066fcdfa2e 100644 --- a/roles/common/files/fwo-api-calls/notification/addNotification.graphql +++ b/roles/common/files/fwo-api-calls/notification/addNotification.graphql @@ -22,6 +22,7 @@ mutation addNotification( $initialOffsetAfterDeadline: Int $offsetAfterDeadline: Int $repetitionsAfterDeadline: Int + $logging: String ) { insert_notification(objects: { notification_client: $client @@ -47,6 +48,7 @@ mutation addNotification( initial_offset_after_deadline: $initialOffsetAfterDeadline repeat_offset_after_deadline: $offsetAfterDeadline repetitions_after_deadline: $repetitionsAfterDeadline + logging: $logging }) { returning { newId: id diff --git a/roles/common/files/fwo-api-calls/notification/getNotifications.graphql b/roles/common/files/fwo-api-calls/notification/getNotifications.graphql index 7274551dfc..a888e35f30 100644 --- a/roles/common/files/fwo-api-calls/notification/getNotifications.graphql +++ b/roles/common/files/fwo-api-calls/notification/getNotifications.graphql @@ -27,5 +27,6 @@ query getNotifications ($client: String! ){ repeat_offset_after_deadline repetitions_after_deadline last_sent + logging } } diff --git a/roles/common/files/fwo-api-calls/notification/updateNotification.graphql b/roles/common/files/fwo-api-calls/notification/updateNotification.graphql index cbd80767ee..c759bb451a 100644 --- a/roles/common/files/fwo-api-calls/notification/updateNotification.graphql +++ b/roles/common/files/fwo-api-calls/notification/updateNotification.graphql @@ -22,6 +22,7 @@ mutation updateNotification( $initialOffsetAfterDeadline: Int $offsetAfterDeadline: Int $repetitionsAfterDeadline: Int + $logging: String ) { update_notification_by_pk( pk_columns: { id: $id } @@ -48,6 +49,7 @@ mutation updateNotification( initial_offset_after_deadline: $initialOffsetAfterDeadline repeat_offset_after_deadline: $offsetAfterDeadline repetitions_after_deadline: $repetitionsAfterDeadline + logging: $logging }) { updatedId: id } diff --git a/roles/common/files/fwo-api-calls/notification_log/insertNotificationLog.graphql b/roles/common/files/fwo-api-calls/notification_log/insertNotificationLog.graphql new file mode 100644 index 0000000000..092fc77eaf --- /dev/null +++ b/roles/common/files/fwo-api-calls/notification_log/insertNotificationLog.graphql @@ -0,0 +1,5 @@ +mutation insertNotificationLog($entries: [notification_log_insert_input!]!) { + insert_notification_log(objects: $entries) { + affected_rows + } +} diff --git a/roles/database/files/sql/creation/fworch-create-tables-base.sql b/roles/database/files/sql/creation/fworch-create-tables-base.sql index 0bb2fa898f..8276b550df 100755 --- a/roles/database/files/sql/creation/fworch-create-tables-base.sql +++ b/roles/database/files/sql/creation/fworch-create-tables-base.sql @@ -330,9 +330,21 @@ create table notification bundle_type Varchar, bundle_id Varchar, recipient_bcc Varchar, - email_address_bcc Varchar + email_address_bcc Varchar, + logging Varchar NOT NULL DEFAULT 'send_only' ); +create table notification_log +( + "timestamp" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(), + notification_id INTEGER NOT NULL, + notification_type Varchar NOT NULL, + "to" Varchar NOT NULL DEFAULT '', + cc Varchar NOT NULL DEFAULT '', + bcc Varchar NOT NULL DEFAULT '', + subject Varchar NOT NULL DEFAULT '' +); + -- configuration Create table "ldap_connection" diff --git a/roles/database/files/sql/idempotent/fworch-texts.sql b/roles/database/files/sql/idempotent/fworch-texts.sql index f0461bb102..a568fdec4b 100644 --- a/roles/database/files/sql/idempotent/fworch-texts.sql +++ b/roles/database/files/sql/idempotent/fworch-texts.sql @@ -3240,6 +3240,8 @@ INSERT INTO txt VALUES ('use_in_dst', 'German', 'in Ziel'); INSERT INTO txt VALUES ('use_in_dst', 'English', 'in Destination'); INSERT INTO txt VALUES ('email_subject', 'German', 'Email-Betreff'); INSERT INTO txt VALUES ('email_subject', 'English', 'Email subject'); +INSERT INTO txt VALUES ('email_log', 'German', 'Email-Protokoll'); +INSERT INTO txt VALUES ('email_log', 'English', 'Email log'); INSERT INTO txt VALUES ('email_body', 'German', 'Email-Inhalt'); INSERT INTO txt VALUES ('email_body', 'English', 'Email body'); INSERT INTO txt VALUES ('email_to', 'German', 'An'); @@ -3347,6 +3349,14 @@ INSERT INTO txt VALUES ('reminder', 'German', 'Erinnerung'); INSERT INTO txt VALUES ('reminder', 'English', 'Reminder'); INSERT INTO txt VALUES ('reminders', 'German', 'Erinnerungsbenachrichtigungen'); INSERT INTO txt VALUES ('reminders', 'English', 'Reminders'); +INSERT INTO txt VALUES ('logging_mode', 'German', 'Protokollierungsmodus'); +INSERT INTO txt VALUES ('logging_mode', 'English', 'Logging mode'); +INSERT INTO txt VALUES ('send_only', 'German', 'Nur senden'); +INSERT INTO txt VALUES ('send_only', 'English', 'Send only'); +INSERT INTO txt VALUES ('send_and_log', 'German', 'Senden und protokollieren'); +INSERT INTO txt VALUES ('send_and_log', 'English', 'Send and log'); +INSERT INTO txt VALUES ('log_only', 'German', 'Nur protokollieren'); +INSERT INTO txt VALUES ('log_only', 'English', 'Log only'); INSERT INTO txt VALUES ('edit_notification', 'German', 'Benachrichtigung bearbeiten'); INSERT INTO txt VALUES ('edit_notification', 'English', 'Edit Notification'); INSERT INTO txt VALUES ('delete_notification', 'German', 'Benachrichtigung löschen'); @@ -5766,6 +5776,8 @@ INSERT INTO txt VALUES ('H4109', 'German', 'Name: Name der Benachrichtigung, nu INSERT INTO txt VALUES ('H4109', 'English', 'Name: Name of notification, only for display purposes.'); INSERT INTO txt VALUES ('H4110', 'German', 'Email-Inhalt: Text der Benachrichtigung. Bei Layouts ohne Anhang kann der Platzhalter @@CONTENT@@ verwendet werden, um den erzeugten Inhalt an dieser Stelle einzufügen. Wenn ein App-Kontext vorhanden ist, werden auch @@APPNAME@@ und @@APPID@@ ersetzt. In Workflow-Aktionsmails wird zusätzlich @@REQUESTER@@ ersetzt, wenn das Ticket bekannt ist.'); INSERT INTO txt VALUES ('H4110', 'English', 'Email body: Text of the notification. For layouts without attachment, the @@CONTENT@@ placeholder can be used to insert the generated content at this position. If an app context is available, @@APPNAME@@ and @@APPID@@ are replaced as well. In workflow action emails, @@REQUESTER@@ is also replaced when the ticket is known.'); +INSERT INTO txt VALUES ('H4111', 'German', 'Protokollierungsmodus: Legt fest, ob eine Benachrichtigung nur gesendet, nur protokolliert oder beides gemacht wird.'); +INSERT INTO txt VALUES ('H4111', 'English', 'Logging mode: Defines whether a notification is sent only, logged only, or both.'); INSERT INTO txt VALUES ('H5001', 'German', 'In diesem Abschnitt werden die Setup- und Verwaltungseinstellungen behandelt. Die meisten Einstellungen können nur von Nutzern mit der Administrator-Rolle gesehen und geändert werden. @@ -7928,6 +7940,11 @@ INSERT INTO txt VALUES ('H7413', 'German', 'Die Tabellen sind in Abschnitte gegl INSERT INTO txt VALUES ('H7413', 'English', 'The tables are grouped in sections. Use the action column to remove orphaned entries from the connection. '); +INSERT INTO txt VALUES ('H7414', 'German', 'Email-Protokoll: Zeigt alle protokollierten Benachrichtigungs-Emails mit Zeitstempel, Benachrichtigungstyp, Empfängern und Betreff. +'); +INSERT INTO txt VALUES ('H7414', 'English', 'Email log: Shows all logged notification emails with timestamp, notification type, recipients and subject. +'); + INSERT INTO txt VALUES ('H7421', 'German', 'Diese Seite zeigt alle angeforderten Schnittstellen mit beantragender und angefragter Applikation, Ticket, Status und Erstellungsdatum. Zusätzlich zeigt die Spalte "Verwendet in Verbindungs-IDs", in welchen bestehenden Verbindungen die Schnittstelle bereits referenziert wird. Über die Aktionsspalte können Schnittstellendetails und das zugehörige Ticket angezeigt werden. diff --git a/roles/database/files/upgrade/9.4.5.sql b/roles/database/files/upgrade/9.4.5.sql index a82ca8f9be..119e5ff6e7 100644 --- a/roles/database/files/upgrade/9.4.5.sql +++ b/roles/database/files/upgrade/9.4.5.sql @@ -111,6 +111,24 @@ update_reminder_bodies AS ) SELECT 1; +ALTER TABLE notification + ADD COLUMN IF NOT EXISTS logging Varchar NOT NULL DEFAULT 'send_only'; + +UPDATE notification +SET logging = 'send_only' +WHERE COALESCE(logging, '') = ''; + +CREATE TABLE IF NOT EXISTS notification_log +( + "timestamp" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(), + notification_id INTEGER NOT NULL, + notification_type Varchar NOT NULL, + "to" Varchar NOT NULL DEFAULT '', + cc Varchar NOT NULL DEFAULT '', + bcc Varchar NOT NULL DEFAULT '', + subject Varchar NOT NULL DEFAULT '' +); + WITH decomm_config AS ( SELECT diff --git a/roles/lib/files/FWO.Api.Client/Queries/MonitorQueries.cs b/roles/lib/files/FWO.Api.Client/Queries/MonitorQueries.cs index 23d2ad3990..2c9418cc22 100644 --- a/roles/lib/files/FWO.Api.Client/Queries/MonitorQueries.cs +++ b/roles/lib/files/FWO.Api.Client/Queries/MonitorQueries.cs @@ -9,6 +9,7 @@ public class MonitorQueries : Queries public static readonly string addUiLogEntry; public static readonly string getUiLogEntrys; public static readonly string getAllUiLogEntrys; + public static readonly string getNotificationLogEntrys; public static readonly string getImportLogEntrys; public static readonly string addAlert; public static readonly string getOpenAlerts; @@ -38,6 +39,7 @@ static MonitorQueries() addUiLogEntry = GetQueryText("monitor/addUiLogEntry.graphql"); getUiLogEntrys = GetQueryText("monitor/getUiLogEntrys.graphql"); getAllUiLogEntrys = GetQueryText("monitor/getAllUiLogEntrys.graphql"); + getNotificationLogEntrys = GetQueryText("monitor/getNotificationLogEntrys.graphql"); getImportLogEntrys = GetQueryText("monitor/getImportLogEntrys.graphql"); diff --git a/roles/lib/files/FWO.Api.Client/Queries/NotificationQueries.cs b/roles/lib/files/FWO.Api.Client/Queries/NotificationQueries.cs index 2cfac0ee49..191800d349 100644 --- a/roles/lib/files/FWO.Api.Client/Queries/NotificationQueries.cs +++ b/roles/lib/files/FWO.Api.Client/Queries/NotificationQueries.cs @@ -8,6 +8,7 @@ public class NotificationQueries : Queries public static readonly string addNotification; public static readonly string updateNotification; public static readonly string updateNotificationsLastSent; + public static readonly string insertNotificationLog; public static readonly string deleteNotification; @@ -20,6 +21,7 @@ static NotificationQueries() addNotification = File.ReadAllText(QueryPath + "notification/addNotification.graphql"); updateNotification = File.ReadAllText(QueryPath + "notification/updateNotification.graphql"); updateNotificationsLastSent = File.ReadAllText(QueryPath + "notification/updateNotificationsLastSent.graphql"); + insertNotificationLog = File.ReadAllText(QueryPath + "notification_log/insertNotificationLog.graphql"); deleteNotification = File.ReadAllText(QueryPath + "notification/deleteNotification.graphql"); } catch (Exception exception) diff --git a/roles/lib/files/FWO.Data/FwoNotification.cs b/roles/lib/files/FWO.Data/FwoNotification.cs index 473d392f8e..96fa9451d1 100644 --- a/roles/lib/files/FWO.Data/FwoNotification.cs +++ b/roles/lib/files/FWO.Data/FwoNotification.cs @@ -80,6 +80,25 @@ NotificationDeadline.RequestDate or } } + public static class NotificationLoggingMode + { + public const string SendOnly = "send_only"; + public const string SendAndLog = "send_and_log"; + public const string LogOnly = "log_only"; + + public static List OfferedOptions() => [SendOnly, SendAndLog, LogOnly]; + + public static bool ShouldLog(string? loggingMode) + { + return loggingMode is SendAndLog or LogOnly; + } + + public static bool ShouldSend(string? loggingMode) + { + return loggingMode != LogOnly; + } + } + public class FwoNotification { public FwoNotification() @@ -114,6 +133,7 @@ public FwoNotification(FwoNotification notification) RepeatOffsetAfterDeadline = notification.RepeatOffsetAfterDeadline; RepetitionsAfterDeadline = notification.RepetitionsAfterDeadline; LastSent = notification.LastSent; + Logging = notification.Logging; } [JsonProperty("id"), JsonPropertyName("id")] @@ -201,6 +221,9 @@ public EmailRecipientOption RecipientBcc [JsonProperty("last_sent"), JsonPropertyName("last_sent")] public DateTime? LastSent { get; set; } + [JsonProperty("logging"), JsonPropertyName("logging")] + public string Logging { get; set; } = NotificationLoggingMode.SendOnly; + public static List OfferedDeadlineOptions(NotificationClient client) { diff --git a/roles/lib/files/FWO.Data/NotificationLogEntry.cs b/roles/lib/files/FWO.Data/NotificationLogEntry.cs new file mode 100644 index 0000000000..d905b1d76f --- /dev/null +++ b/roles/lib/files/FWO.Data/NotificationLogEntry.cs @@ -0,0 +1,32 @@ +using Newtonsoft.Json; +using System.Text.Json.Serialization; + +namespace FWO.Data +{ + /// + /// Log entry for a notification send attempt. + /// + public class NotificationLogEntry + { + [JsonProperty("timestamp"), JsonPropertyName("timestamp")] + public DateTimeOffset Timestamp { get; set; } + + [JsonProperty("notification_id"), JsonPropertyName("notification_id")] + public int NotificationId { get; set; } + + [JsonProperty("notification_type"), JsonPropertyName("notification_type")] + public string NotificationType { get; set; } = ""; + + [JsonProperty("to"), JsonPropertyName("to")] + public string To { get; set; } = ""; + + [JsonProperty("cc"), JsonPropertyName("cc")] + public string Cc { get; set; } = ""; + + [JsonProperty("bcc"), JsonPropertyName("bcc")] + public string Bcc { get; set; } = ""; + + [JsonProperty("subject"), JsonPropertyName("subject")] + public string Subject { get; set; } = ""; + } +} diff --git a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs index 9f55edde77..d1f530b660 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs @@ -91,6 +91,20 @@ public virtual async Task SendEmailToNotificationRecipients(FwoNotificatio List? bccs = notification.RecipientBcc == EmailRecipientOption.None ? null : await GetNotificationRecipients(notification.RecipientBcc, notification.EmailAddressBcc, owner); + if (NotificationLoggingMode.ShouldLog(notification.Logging)) + { + List loggedTos = [.. tos]; + List? loggedCcs = ccs == null ? null : [.. ccs]; + List? loggedBccs = bccs == null ? null : [.. bccs]; + ApplyDummyRecipientOverride(ref loggedTos, ref loggedCcs, ref loggedBccs); + await InsertNotificationLog(notification, loggedTos, loggedCcs, loggedBccs, subject); + } + + if (!NotificationLoggingMode.ShouldSend(notification.Logging)) + { + return true; + } + return await SendEmail(tos, subject, body, ccs, bccs, notification.Layout == NotificationLayout.HtmlInBody); } @@ -170,6 +184,22 @@ protected virtual async Task SendEmail(List tos, string subject, s return sent; } + private async Task InsertNotificationLog(FwoNotification notification, List tos, List? ccs, List? bccs, string subject) + { + NotificationLogEntry entry = new() + { + Timestamp = DateTimeOffset.UtcNow, + NotificationId = notification.Id, + NotificationType = notification.NotificationClient.ToString(), + To = string.Join(", ", tos), + Cc = string.Join(", ", ccs ?? []), + Bcc = string.Join(", ", bccs ?? []), + Subject = subject + }; + + await apiConnection.SendQueryAsync(NotificationQueries.insertNotificationLog, new { entries = new List { entry } }); + } + public async Task> GetRecipients(EmailRecipientOption recipientOption, WfStatefulObject? statefulObject, FwoOwner? owner, string? scopedUser, List? otherAddresses, string? scopedUserEmail = null) { diff --git a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs index 930c6bf64c..42581edbae 100644 --- a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs +++ b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs @@ -165,6 +165,81 @@ public async Task SendEmailToNotificationRecipients_ResolvesRequesterCcFromNotif }); } + [Test] + public async Task SendEmailToNotificationRecipients_SendAndLog_WritesNotificationLogAndSendsEmail() + { + SimulatedUserConfig userConfig = new() + { + UseDummyEmailAddress = false + }; + RecordingNotificationLogApiConnection apiConnection = new(); + CapturingEmailHelper helper = new(userConfig, apiConnection); + + FwoNotification notification = new() + { + Id = 41, + NotificationClient = NotificationClient.InterfaceRequest, + Logging = NotificationLoggingMode.SendAndLog, + RecipientTo = EmailRecipientOption.OtherAddresses, + EmailAddressTo = "to@example.test", + RecipientCc = EmailRecipientOption.OtherAddresses, + EmailAddressCc = "cc@example.test", + RecipientBcc = EmailRecipientOption.OtherAddresses, + EmailAddressBcc = "bcc@example.test", + EmailSubject = "Subject", + EmailBody = "Body" + }; + + bool sent = await helper.SendEmailToNotificationRecipients(notification, null, "Rendered subject", "Rendered body"); + + Assert.Multiple(() => + { + Assert.That(sent, Is.True); + Assert.That(helper.SendEmailCallCount, Is.EqualTo(1)); + Assert.That(apiConnection.InsertCalls, Has.Count.EqualTo(1)); + Assert.That(apiConnection.InsertCalls[0].NotificationId, Is.EqualTo(41)); + Assert.That(apiConnection.InsertCalls[0].NotificationType, Is.EqualTo(NotificationClient.InterfaceRequest.ToString())); + Assert.That(apiConnection.InsertCalls[0].To, Is.EqualTo("to@example.test")); + Assert.That(apiConnection.InsertCalls[0].Cc, Is.EqualTo("cc@example.test")); + Assert.That(apiConnection.InsertCalls[0].Bcc, Is.EqualTo("bcc@example.test")); + Assert.That(apiConnection.InsertCalls[0].Subject, Is.EqualTo("Rendered subject")); + Assert.That(apiConnection.InsertCalls[0].Timestamp, Is.GreaterThan(DateTimeOffset.UtcNow.AddMinutes(-1))); + }); + } + + [Test] + public async Task SendEmailToNotificationRecipients_LogOnly_WritesNotificationLogWithoutSendingEmail() + { + SimulatedUserConfig userConfig = new() + { + UseDummyEmailAddress = false + }; + RecordingNotificationLogApiConnection apiConnection = new(); + CapturingEmailHelper helper = new(userConfig, apiConnection); + + FwoNotification notification = new() + { + Id = 42, + NotificationClient = NotificationClient.AppDecomm, + Logging = NotificationLoggingMode.LogOnly, + RecipientTo = EmailRecipientOption.OtherAddresses, + EmailAddressTo = "to@example.test", + EmailSubject = "Subject", + EmailBody = "Body" + }; + + bool sent = await helper.SendEmailToNotificationRecipients(notification, null, "Rendered subject", "Rendered body"); + + Assert.Multiple(() => + { + Assert.That(sent, Is.True); + Assert.That(helper.SendEmailCallCount, Is.Zero); + Assert.That(apiConnection.InsertCalls, Has.Count.EqualTo(1)); + Assert.That(apiConnection.InsertCalls[0].NotificationId, Is.EqualTo(42)); + Assert.That(apiConnection.InsertCalls[0].Subject, Is.EqualTo("Rendered subject")); + }); + } + [Test] public async Task SendWorkflowActionEmail_UsesWorkflowRecipientsAndPlaceholderObject() { @@ -1169,6 +1244,7 @@ public override Task SendQueryAsync(string private sealed class CapturingEmailHelper : EmailHelper { + public int SendEmailCallCount { get; private set; } public List CapturedTo { get; private set; } = []; public List? CapturedCc { get; private set; } public List? CapturedBcc { get; private set; } @@ -1177,13 +1253,14 @@ private sealed class CapturingEmailHelper : EmailHelper public bool CapturedMailFormatHtml { get; private set; } public FormFile? CapturedAttachment { get; private set; } - public CapturingEmailHelper(UserConfig userConfig) - : base(new SimulatedApiConnection(), null, userConfig, DefaultInit.DoNothing) + public CapturingEmailHelper(UserConfig userConfig, ApiConnection? apiConnection = null) + : base(apiConnection ?? new SimulatedApiConnection(), null, userConfig, DefaultInit.DoNothing) { } protected override Task SendEmail(List tos, string subject, string body, List? ccs = null, List? bccs = null, bool mailFormatHtml = true, Microsoft.AspNetCore.Http.FormFile? attachment = null) { + SendEmailCallCount++; CapturedTo = [.. tos]; CapturedCc = ccs == null ? null : [.. ccs]; CapturedBcc = bccs == null ? null : [.. bccs]; @@ -1195,6 +1272,30 @@ protected override Task SendEmail(List tos, string subject, string } } + private sealed class RecordingNotificationLogApiConnection : SimulatedApiConnection + { + public List InsertCalls { get; } = []; + + public override Task SendQueryAsync(string query, object? variables = null, string? operationName = null, FWO.Api.Client.QueryChunkingOptions? chunkingOptions = null) + { + if (query == NotificationQueries.insertNotificationLog && typeof(QueryResponseType) == typeof(object)) + { + if (variables != null) + { + PropertyInfo? entriesProperty = variables.GetType().GetProperty("entries"); + if (entriesProperty?.GetValue(variables) is IEnumerable entries) + { + InsertCalls.AddRange(entries); + } + } + + return Task.FromResult((QueryResponseType)(object)new object()); + } + + throw new NotImplementedException(); + } + } + private static async Task CaptureConsoleAsync(Func action) { TextWriter originalOut = Console.Out; diff --git a/roles/tests-unit/files/FWO.Test/NotificationMutationHelperTest.cs b/roles/tests-unit/files/FWO.Test/NotificationMutationHelperTest.cs index 2ad5d9c24d..d4581acfe6 100644 --- a/roles/tests-unit/files/FWO.Test/NotificationMutationHelperTest.cs +++ b/roles/tests-unit/files/FWO.Test/NotificationMutationHelperTest.cs @@ -24,9 +24,11 @@ public async Task AddAsync_PersistsNotificationAndReturnsAssignedId() Assert.That(persistedNotification.NotificationClient, Is.EqualTo(NotificationClient.Report)); Assert.That(persistedNotification.Name, Is.EqualTo(notification.Name)); Assert.That(persistedNotification.EmailAddressTo, Is.EqualTo(notification.EmailAddressTo)); + Assert.That(persistedNotification.Logging, Is.EqualTo(notification.Logging)); Assert.That(apiConnection.AddCalls[0].Client, Is.EqualTo(NotificationClient.Report.ToString())); Assert.That(apiConnection.AddCalls[0].Name, Is.EqualTo(notification.Name)); Assert.That(apiConnection.AddCalls[0].BundleId, Is.EqualTo(notification.BundleId)); + Assert.That(apiConnection.AddCalls[0].Logging, Is.EqualTo(notification.Logging)); }); } @@ -45,9 +47,11 @@ public async Task UpdateAsync_PersistsNotificationAndReturnsUpdatedCopy() Assert.That(apiConnection.UpdateCalls, Has.Count.EqualTo(1)); Assert.That(persistedNotification.Id, Is.EqualTo(17)); Assert.That(persistedNotification.EmailSubject, Is.EqualTo("Updated Subject")); + Assert.That(persistedNotification.Logging, Is.EqualTo(notification.Logging)); Assert.That(apiConnection.UpdateCalls[0].Id, Is.EqualTo(17)); Assert.That(apiConnection.UpdateCalls[0].Subject, Is.EqualTo("Updated Subject")); Assert.That(apiConnection.UpdateCalls[0].Layout, Is.EqualTo(notification.Layout.ToString())); + Assert.That(apiConnection.UpdateCalls[0].Logging, Is.EqualTo(notification.Logging)); }); } @@ -78,7 +82,8 @@ private static FwoNotification NewNotification() BundleType = BundleType.Attachments, BundleId = "bundle-1", Layout = NotificationLayout.PdfAsAttachment, - Deadline = NotificationDeadline.None + Deadline = NotificationDeadline.None, + Logging = NotificationLoggingMode.SendOnly }; } @@ -139,6 +144,7 @@ private sealed class NotificationMutationCall internal string Subject { get; init; } = ""; internal string Layout { get; init; } = ""; internal string? BundleId { get; init; } + internal string Logging { get; init; } = ""; internal static NotificationMutationCall From(object? variables) { @@ -149,7 +155,8 @@ internal static NotificationMutationCall From(object? variables) Name = ReadString(variables, "name"), Subject = ReadString(variables, "subject"), Layout = ReadString(variables, "layout"), - BundleId = ReadNullableString(variables, "bundleId") + BundleId = ReadNullableString(variables, "bundleId"), + Logging = ReadString(variables, "logging") }; } diff --git a/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs b/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs index 1cece86d04..deafa0b352 100644 --- a/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs @@ -78,6 +78,7 @@ public void InitActNotification_ForRuleTimer_SetsExpectedDefaults() Assert.That(actNotification.RecipientCc, Is.EqualTo(EmailRecipientOption.None)); Assert.That(actNotification.Layout, Is.EqualTo(NotificationLayout.HtmlInBody)); Assert.That(actNotification.Deadline, Is.EqualTo(FwoNotification.OfferedDeadlineOptions(NotificationClient.RuleTimer).Single())); + Assert.That(actNotification.Logging, Is.EqualTo(NotificationLoggingMode.SendOnly)); } [Test] diff --git a/roles/tests-unit/files/FWO.Test/UiMonitoringLogPagesTest.cs b/roles/tests-unit/files/FWO.Test/UiMonitoringLogPagesTest.cs index e65f7d08e9..977e59fa75 100644 --- a/roles/tests-unit/files/FWO.Test/UiMonitoringLogPagesTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiMonitoringLogPagesTest.cs @@ -73,6 +73,23 @@ public void MonitorAll_LoadsLogEntries() }); } + [Test] + public void MonitorEmailLog_LoadsNotificationLogEntries() + { + MonitorTestApiConn apiConn = RenderApiConn(); + apiConn.NotificationLogEntries.Add(CreateNotificationLogEntry("InterfaceRequest", "to@example.test")); + + using TestSetup setup = RenderComponent(apiConn); + + Assert.Multiple(() => + { + Assert.That(apiConn.NotificationLogQueryCount, Is.EqualTo(1)); + Assert.That(apiConn.LastQuery, Is.EqualTo(MonitorQueries.getNotificationLogEntrys)); + Assert.That(GetPrivateField>(setup.Component, "notificationLogEntries"), Has.Count.EqualTo(1)); + Assert.That(GetPrivateField(setup.Component, "InitComplete"), Is.True); + }); + } + [Test] public void MonitorAlerts_LoadsAlertsUsersAndManagements() { @@ -163,6 +180,20 @@ private static LogEntry CreateLogEntry(long id, string source) }; } + private static NotificationLogEntry CreateNotificationLogEntry(string notificationType, string to) + { + return new NotificationLogEntry + { + Timestamp = new DateTimeOffset(new DateTime(2026, 1, 1, 12, 0, 0), TimeSpan.Zero), + NotificationId = 1, + NotificationType = notificationType, + To = to, + Cc = "", + Bcc = "", + Subject = "subject" + }; + } + private static Alert CreateAlert(long id) { return new Alert @@ -197,12 +228,14 @@ private static Management CreateManagement(int id, string name) internal sealed class MonitorTestApiConn : SimulatedApiConnection { public List LogEntries { get; } = new(); + public List NotificationLogEntries { get; } = new(); public List Alerts { get; } = new(); public List UiUsers { get; } = new(); public List Managements { get; } = new(); public List LastQueries { get; } = new(); public int LogQueryCount { get; private set; } + public int NotificationLogQueryCount { get; private set; } public int AlertQueryCount { get; private set; } public int UserQueryCount { get; private set; } public int ManagementQueryCount { get; private set; } @@ -226,6 +259,12 @@ public override Task SendQueryAsync(string return Task.FromResult((QueryResponseType)(object)LogEntries); } + if (typeof(QueryResponseType) == typeof(List) && query == MonitorQueries.getNotificationLogEntrys) + { + NotificationLogQueryCount++; + return Task.FromResult((QueryResponseType)(object)NotificationLogEntries); + } + if (typeof(QueryResponseType) == typeof(List) && query == MonitorQueries.getDataImportLogEntrys) { LogQueryCount++; diff --git a/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs b/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs index 827568701c..18f18bf55d 100644 --- a/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs @@ -33,7 +33,7 @@ public async Task Page_RendersThreeNotificationEditorsWithExpectedSections() page.WaitForAssertion(() => { - Assert.That(page.Markup, Does.Contain("Notifications")); + Assert.That(page.Markup, Does.Contain("Interfaces")); Assert.That(page.Markup, Does.Contain("Initial request")); Assert.That(page.Markup, Does.Contain("Reminder")); Assert.That(page.Markup, Does.Contain("Decommission")); @@ -125,7 +125,7 @@ public async Task Save_ReportsErrorWhenConfigWriteFails() page.WaitForAssertion(() => { Assert.That(messages, Has.Count.EqualTo(1)); - Assert.That(messages[0].Title, Is.EqualTo(new SimulatedUserConfig().GetText("notifications"))); + Assert.That(messages[0].Title, Is.EqualTo(new SimulatedUserConfig().GetText("interfaces"))); Assert.That(messages[0].IsError, Is.True); }); } diff --git a/roles/ui/files/FWO.UI/Pages/Help/HelpMonitoringEmailLog.cshtml b/roles/ui/files/FWO.UI/Pages/Help/HelpMonitoringEmailLog.cshtml new file mode 100644 index 0000000000..c3c5dc4917 --- /dev/null +++ b/roles/ui/files/FWO.UI/Pages/Help/HelpMonitoringEmailLog.cshtml @@ -0,0 +1,17 @@ +@page "/help/monitoring/email_log" +@model FWO.Ui.Pages.Help.MainModel +@{ + Layout = "HelpLayout"; +} +@section sidebar{ + @{ + await Html.RenderPartialAsync("HelpMonitoringSidebar.cshtml"); + } +} +@using FWO.Config.Api +@inject UserConfig userConfig + +
      +

      @userConfig.GetText("email_log")

      + @(Html.Raw(userConfig.GetText("H7414"))) +
      diff --git a/roles/ui/files/FWO.UI/Pages/Help/HelpMonitoringSidebar.cshtml b/roles/ui/files/FWO.UI/Pages/Help/HelpMonitoringSidebar.cshtml index 13cd7c87ae..07991ec867 100644 --- a/roles/ui/files/FWO.UI/Pages/Help/HelpMonitoringSidebar.cshtml +++ b/roles/ui/files/FWO.UI/Pages/Help/HelpMonitoringSidebar.cshtml @@ -62,6 +62,11 @@ @(userConfig.GetText("tickets"))

      +
      @(userConfig.GetText("notifications"))
      + + @(userConfig.GetText("email_log")) + +

      @(userConfig.GetText("personal"))
      @(userConfig.GetText("ui_messages")) diff --git a/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml b/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml index 74d0e06562..98b56f1d8c 100644 --- a/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml +++ b/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml @@ -18,6 +18,7 @@
    • @(Html.Raw(userConfig.GetText("H5622")))
    • @(Html.Raw(userConfig.GetText("H5625")))
    • @(Html.Raw(userConfig.GetText("H5626")))
      • +
    • @(Html.Raw(userConfig.GetText("H4111")))
    • @(Html.Raw(userConfig.GetText("H5630")))
    • @(Html.Raw(userConfig.GetText("H5624")))
      • diff --git a/roles/ui/files/FWO.UI/Pages/Help/Index.cshtml b/roles/ui/files/FWO.UI/Pages/Help/Index.cshtml index b94b520e75..bf29b9a6f1 100644 --- a/roles/ui/files/FWO.UI/Pages/Help/Index.cshtml +++ b/roles/ui/files/FWO.UI/Pages/Help/Index.cshtml @@ -155,6 +155,9 @@
    • @userConfig.GetText("workflow") @userConfig.GetText("tickets")
      • +
    • + @userConfig.GetText("email_log") +
    • @userConfig.GetText("ext_request_tickets")
      • diff --git a/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor b/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor new file mode 100644 index 0000000000..f30deaac84 --- /dev/null +++ b/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor @@ -0,0 +1,62 @@ +@inject ApiConnection apiConnection +@inject UserConfig userConfig + +@page "/monitoring/email_log" +@attribute [Authorize(Roles = $"{Roles.Admin}, {Roles.FwAdmin}, {Roles.Auditor}")] + +
      +

      @(userConfig.GetText("email_log"))

      + +
      +@(userConfig.GetText("H7414")) +
      + +@if (InitComplete) +{ +
      + + + + + + + + + + +
      +
      +} +else +{ + +} + +@code +{ + [CascadingParameter] + Action DisplayMessageInUi { get; set; } = DefaultInit.DoNothing; + + private List notificationLogEntries = []; + private bool InitComplete = false; + + private int PageSize { get; set; } + + protected override async Task OnInitializedAsync() + { + try + { + notificationLogEntries = await apiConnection.SendQueryAsync>(MonitorQueries.getNotificationLogEntrys); + InitComplete = true; + } + catch (Exception exception) + { + DisplayMessageInUi(exception, userConfig.GetText("fetch_log_entrys"), "", true); + } + } + + private void UpdatePageSize(int pageSize) + { + PageSize = pageSize; + } +} diff --git a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor index 57ba28e86b..f9a1697cd2 100644 --- a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor +++ b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor @@ -16,7 +16,7 @@ @inject UserConfig userConfig
      -

      @(userConfig.GetText("notifications"))

      +

      @(userConfig.GetText("interfaces"))

      @@ -107,11 +107,11 @@ else } await globalConfig.WriteToDatabase(configData, apiConnection); - DisplayMessageInUi(null, userConfig.GetText("notifications"), userConfig.GetText("U5301"), false); + DisplayMessageInUi(null, userConfig.GetText("interfaces"), userConfig.GetText("U5301"), false); } catch (Exception exception) { - DisplayMessageInUi(exception, userConfig.GetText("notifications"), "", true); + DisplayMessageInUi(exception, userConfig.GetText("interfaces"), "", true); } } } diff --git a/roles/ui/files/FWO.UI/Services/NotificationMutationHelper.cs b/roles/ui/files/FWO.UI/Services/NotificationMutationHelper.cs index c92182cdfe..9428116ec2 100644 --- a/roles/ui/files/FWO.UI/Services/NotificationMutationHelper.cs +++ b/roles/ui/files/FWO.UI/Services/NotificationMutationHelper.cs @@ -96,7 +96,8 @@ private static FwoNotification Clone(FwoNotification notification) InitialOffsetAfterDeadline = notification.InitialOffsetAfterDeadline, RepeatOffsetAfterDeadline = notification.RepeatOffsetAfterDeadline, RepetitionsAfterDeadline = notification.RepetitionsAfterDeadline, - LastSent = notification.LastSent + LastSent = notification.LastSent, + Logging = notification.Logging }; } @@ -149,6 +150,8 @@ private record NotificationMutationVariables public int? repetitionsAfterDeadline { get; init; } + public string? logging { get; init; } + protected NotificationMutationVariables() { } @@ -177,6 +180,7 @@ protected NotificationMutationVariables(NotificationMutationVariables variables) initialOffsetAfterDeadline = variables.initialOffsetAfterDeadline; offsetAfterDeadline = variables.offsetAfterDeadline; repetitionsAfterDeadline = variables.repetitionsAfterDeadline; + logging = variables.logging; } public static NotificationMutationVariables Create(FwoNotification notification) @@ -204,7 +208,8 @@ public static NotificationMutationVariables Create(FwoNotification notification) intervalAfterDeadline = (int?)notification.RepeatIntervalAfterDeadline, initialOffsetAfterDeadline = notification.InitialOffsetAfterDeadline, offsetAfterDeadline = notification.RepeatOffsetAfterDeadline, - repetitionsAfterDeadline = notification.RepetitionsAfterDeadline + repetitionsAfterDeadline = notification.RepetitionsAfterDeadline, + logging = notification.Logging }; } } diff --git a/roles/ui/files/FWO.UI/Shared/EditNotifications.razor b/roles/ui/files/FWO.UI/Shared/EditNotifications.razor index 2cd4622077..790c2d8596 100644 --- a/roles/ui/files/FWO.UI/Shared/EditNotifications.razor +++ b/roles/ui/files/FWO.UI/Shared/EditNotifications.razor @@ -163,6 +163,19 @@ +
      + +
      + + + @(userConfig.GetText(mode)) + + +
      +
      + @if(Client.IsWorkflowRecipientClient()) {
      +
    • +
      @(userConfig.GetText("notifications"))
      +
      • +
    • + + @(userConfig.GetText("email_log")) + +
      • +
    • @(userConfig.GetText("personal"))
      From 589cb7f902ad10f868147b168d40ae2626c115c8 Mon Sep 17 00:00:00 2001 From: abarz722 Date: Thu, 3 Sep 2026 14:59:43 +0200 Subject: [PATCH 04/48] generalize action placeholders --- .../files/sql/idempotent/fworch-texts.sql | 8 +-- .../Middleware/WorkflowActionParameters.cs | 1 + .../FWO.Data/NotificationPlaceholderData.cs | 53 +++++++++++++++++ .../FWO.Data/Workflow/WfStatefulObject.cs | 7 +++ .../EmailNotification/EmailHelper.cs | 8 ++- .../NotificationPlaceholderResolver.cs | 59 ++++++++++++++++++- .../FWO.Services/Workflow/ActionHandler.cs | 3 +- .../Workflow/ActionHandlerSendEmail.cs | 3 +- .../FWO.Services/Workflow/TicketCreator.cs | 9 ++- .../Controllers/WorkflowController.cs | 2 + .../FWO.Test/EmailNotificationContentTest.cs | 51 ++++++++++++++++ .../FWO.Test/UiRequestAndRejectPopupTest.cs | 35 +++++++++++ .../RejectInterfacePopup.razor | 24 +++++++- 13 files changed, 247 insertions(+), 16 deletions(-) create mode 100644 roles/lib/files/FWO.Data/NotificationPlaceholderData.cs diff --git a/roles/database/files/sql/idempotent/fworch-texts.sql b/roles/database/files/sql/idempotent/fworch-texts.sql index 2b6ca483df..70ff68bdc2 100644 --- a/roles/database/files/sql/idempotent/fworch-texts.sql +++ b/roles/database/files/sql/idempotent/fworch-texts.sql @@ -5780,8 +5780,8 @@ INSERT INTO txt VALUES ('H4105', 'German', 'Benachrichtigungen nach Termin: Def INSERT INTO txt VALUES ('H4105', 'English', 'Notifications after Deadline: Defines a time interval for recurring notifications after reaching the reference date with a maximum number of repetitions. The initial offset is added only to the first interval (also negative numbers possible). '); -INSERT INTO txt VALUES ('H4106', 'German', 'Email-Betreff: Betreff der Benachrichtigung. Verfügbare Platzhalter: @@APPNAME@@, @@APPID@@.'); -INSERT INTO txt VALUES ('H4106', 'English', 'Email subject: Subject line of the notification. Available placeholders: @@APPNAME@@, @@APPID@@.'); +INSERT INTO txt VALUES ('H4106', 'German', 'Email-Betreff: Betreff der Benachrichtigung. Verfügbare Platzhalter: @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_NAME@@, @@INTERFACE_LINK@@, @@NEW_INTERFACE_NAME@@, @@NEW_INTERFACE_LINK@@, @@REASON@@, @@USER_NAME@@, @@REQUESTDATE@@.'); +INSERT INTO txt VALUES ('H4106', 'English', 'Email subject: Subject line of the notification. Available placeholders: @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_NAME@@, @@INTERFACE_LINK@@, @@NEW_INTERFACE_NAME@@, @@NEW_INTERFACE_LINK@@, @@REASON@@, @@USER_NAME@@, @@REQUESTDATE@@.'); INSERT INTO txt VALUES ('H4107', 'German', 'Empfänger (To): Es werden verschiedene Rollen (je nach Kontext) als Empfänger angeboten, zu denen dann automatisch die entsprechenden Adressen ermittelt werden. Bei "Andere Adressen" können manuell Adressen eingegeben werden.'); INSERT INTO txt VALUES ('H4107', 'English', 'Recipient (To): Different roles are offered as recipients (depending on context), for which the addresses are determined automatically. With "Other Addresses" addreesses can be inserted manually.'); INSERT INTO txt VALUES ('H4108', 'German', 'Empfänger (Cc). Wie "Empfänger (To)" für Empfänger im CC.'); @@ -5790,8 +5790,8 @@ INSERT INTO txt VALUES ('H4108a','German', 'Empfänger (Bcc). Wie "Empf&aum INSERT INTO txt VALUES ('H4108a','English', 'Recipient (Bcc). As "Recipient (To)" for blind-copy recipients.'); INSERT INTO txt VALUES ('H4109', 'German', 'Name: Name der Benachrichtigung, nur für Darstellungszwecke.'); INSERT INTO txt VALUES ('H4109', 'English', 'Name: Name of notification, only for display purposes.'); -INSERT INTO txt VALUES ('H4110', 'German', 'Email-Inhalt: Text der Benachrichtigung. Bei Layouts ohne Anhang kann der Platzhalter @@CONTENT@@ verwendet werden, um den erzeugten Inhalt an dieser Stelle einzufügen. Wenn ein App-Kontext vorhanden ist, werden auch @@APPNAME@@ und @@APPID@@ ersetzt. In Workflow-Aktionsmails wird zusätzlich @@REQUESTER@@ ersetzt, wenn das Ticket bekannt ist.'); -INSERT INTO txt VALUES ('H4110', 'English', 'Email body: Text of the notification. For layouts without attachment, the @@CONTENT@@ placeholder can be used to insert the generated content at this position. If an app context is available, @@APPNAME@@ and @@APPID@@ are replaced as well. In workflow action emails, @@REQUESTER@@ is also replaced when the ticket is known.'); +INSERT INTO txt VALUES ('H4110', 'German', 'Email-Inhalt: Text der Benachrichtigung. Bei Layouts ohne Anhang kann der Platzhalter @@CONTENT@@ verwendet werden, um den erzeugten Inhalt an dieser Stelle einzufügen. Die Platzhalter @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_NAME@@, @@INTERFACE_LINK@@, @@NEW_INTERFACE_NAME@@, @@NEW_INTERFACE_LINK@@, @@REASON@@, @@USER_NAME@@ und @@REQUESTDATE@@ werden ersetzt, wenn der jeweilige Kontext vom Aufrufer bereitgestellt wird.'); +INSERT INTO txt VALUES ('H4110', 'English', 'Email body: Text of the notification. For layouts without attachment, the @@CONTENT@@ placeholder can be used to insert the generated content at this position. The placeholders @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_NAME@@, @@INTERFACE_LINK@@, @@NEW_INTERFACE_NAME@@, @@NEW_INTERFACE_LINK@@, @@REASON@@, @@USER_NAME@@ and @@REQUESTDATE@@ are replaced when the caller provides the respective context.'); INSERT INTO txt VALUES ('H4111', 'German', 'Protokollierungsmodus: Legt fest, ob eine Benachrichtigung nur gesendet, nur protokolliert oder beides gemacht wird.'); INSERT INTO txt VALUES ('H4111', 'English', 'Logging mode: Defines whether a notification is sent only, logged only, or both.'); diff --git a/roles/lib/files/FWO.Data/Middleware/WorkflowActionParameters.cs b/roles/lib/files/FWO.Data/Middleware/WorkflowActionParameters.cs index 05b2cd64fd..0d7efb250a 100644 --- a/roles/lib/files/FWO.Data/Middleware/WorkflowActionParameters.cs +++ b/roles/lib/files/FWO.Data/Middleware/WorkflowActionParameters.cs @@ -13,6 +13,7 @@ public class WorkflowActionParameters public bool StateChangedByCreation { get; set; } public string Phase { get; set; } = WorkflowPhases.request.ToString(); public string ExecutionMode { get; set; } = ""; + public NotificationPlaceholderData? NotificationPlaceholders { get; set; } } public class WorkflowActionResult diff --git a/roles/lib/files/FWO.Data/NotificationPlaceholderData.cs b/roles/lib/files/FWO.Data/NotificationPlaceholderData.cs new file mode 100644 index 0000000000..800d3ef9fb --- /dev/null +++ b/roles/lib/files/FWO.Data/NotificationPlaceholderData.cs @@ -0,0 +1,53 @@ +using System.Text.Json.Serialization; +using Newtonsoft.Json; + +namespace FWO.Data +{ + /// + /// Transient values supplied by a workflow caller for notification placeholder replacement. + /// + public class NotificationPlaceholderData + { + [JsonProperty("requesting_app_name"), JsonPropertyName("requesting_app_name")] + public string RequestingAppName { get; set; } = ""; + + [JsonProperty("requesting_app_id"), JsonPropertyName("requesting_app_id")] + public string RequestingAppId { get; set; } = ""; + + [JsonProperty("interface_name"), JsonPropertyName("interface_name")] + public string InterfaceName { get; set; } = ""; + + [JsonProperty("interface_link_text"), JsonPropertyName("interface_link_text")] + public string InterfaceLinkText { get; set; } = ""; + + [JsonProperty("interface_link_name"), JsonPropertyName("interface_link_name")] + public string InterfaceLinkName { get; set; } = ""; + + [JsonProperty("interface_link_url"), JsonPropertyName("interface_link_url")] + public string InterfaceLinkUrl { get; set; } = ""; + + [JsonProperty("new_interface_name"), JsonPropertyName("new_interface_name")] + public string NewInterfaceName { get; set; } = ""; + + [JsonProperty("new_interface_link_text"), JsonPropertyName("new_interface_link_text")] + public string NewInterfaceLinkText { get; set; } = ""; + + [JsonProperty("new_interface_link_name"), JsonPropertyName("new_interface_link_name")] + public string NewInterfaceLinkName { get; set; } = ""; + + [JsonProperty("new_interface_link_url"), JsonPropertyName("new_interface_link_url")] + public string NewInterfaceLinkUrl { get; set; } = ""; + + [JsonProperty("reason"), JsonPropertyName("reason")] + public string Reason { get; set; } = ""; + + [JsonProperty("user_name"), JsonPropertyName("user_name")] + public string UserName { get; set; } = ""; + + [JsonProperty("requester_name"), JsonPropertyName("requester_name")] + public string RequesterName { get; set; } = ""; + + [JsonProperty("request_date"), JsonPropertyName("request_date")] + public string RequestDate { get; set; } = ""; + } +} diff --git a/roles/lib/files/FWO.Data/Workflow/WfStatefulObject.cs b/roles/lib/files/FWO.Data/Workflow/WfStatefulObject.cs index 2af4a657a2..def9c11041 100644 --- a/roles/lib/files/FWO.Data/Workflow/WfStatefulObject.cs +++ b/roles/lib/files/FWO.Data/Workflow/WfStatefulObject.cs @@ -40,6 +40,12 @@ public int StateId [JsonProperty("assigned_group"), JsonPropertyName("assigned_group")] public string? AssignedGroup { get; set; } + /// + /// Carries caller-supplied values for workflow notification placeholders. + /// + [JsonProperty("notification_placeholders"), JsonPropertyName("notification_placeholders")] + public NotificationPlaceholderData? NotificationPlaceholders { get; set; } + // need private declarations, else we get problems with request_reqtask_arr_rel_insert_input in newTicket private int stateId; @@ -101,6 +107,7 @@ public WfStatefulObject(WfStatefulObject obj) CurrentHandler = obj.CurrentHandler; RecentHandler = obj.RecentHandler; AssignedGroup = obj.AssignedGroup; + NotificationPlaceholders = obj.NotificationPlaceholders; } public virtual bool Sanitize() diff --git a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs index d1f530b660..fd45a2710b 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs @@ -112,7 +112,8 @@ public virtual async Task SendEmailToNotificationRecipients(FwoNotificatio /// Sends an immediate workflow action email using notification recipient fields. /// public async Task SendWorkflowActionEmail(FwoNotification notification, WfStatefulObject statefulObject, FwoOwner? owner, string? userGrpDn = null, - WorkflowEmailContent? workflowContent = null, WfStatefulObject? placeholderObject = null) + WorkflowEmailContent? workflowContent = null, WfStatefulObject? placeholderObject = null, + NotificationPlaceholderData? placeholderData = null) { List tos = await GetWorkflowActionRecipients(notification.RecipientTo, notification.EmailAddressTo, statefulObject, owner, ScopedUserTo, ScopedUserEmailTo, userGrpDn); List? ccs = notification.RecipientCc == EmailRecipientOption.None @@ -122,8 +123,9 @@ public async Task SendWorkflowActionEmail(FwoNotification notification, Wf ? null : await GetWorkflowActionRecipients(notification.RecipientBcc, notification.EmailAddressBcc, statefulObject, owner, ScopedUserBcc, ScopedUserEmailBcc, userGrpDn); WfStatefulObject placeholderContext = placeholderObject ?? statefulObject; - string subject = NotificationPlaceholderResolver.ReplaceWorkflowPlaceholders(notification.EmailSubject, placeholderContext, owner); - string body = NotificationPlaceholderResolver.ReplaceWorkflowPlaceholders(NotificationEmailLayoutHelper.BuildBody(notification, workflowContent), placeholderContext, owner); + string subject = NotificationPlaceholderResolver.ReplaceWorkflowPlaceholders(notification.EmailSubject, placeholderContext, owner, placeholderData); + string body = NotificationPlaceholderResolver.ReplaceWorkflowPlaceholders(NotificationEmailLayoutHelper.BuildBody(notification, workflowContent), placeholderContext, owner, + placeholderData, renderHtmlLinks: true); FormFile? attachment = await NotificationEmailLayoutHelper.BuildAttachment(notification.Layout, workflowContent, subject); return await SendEmail(tos, subject, body, ccs, bccs, notification.Layout == NotificationLayout.HtmlInBody, attachment); diff --git a/roles/lib/files/FWO.Services/EmailNotification/NotificationPlaceholderResolver.cs b/roles/lib/files/FWO.Services/EmailNotification/NotificationPlaceholderResolver.cs index 5881672c48..cfcdb2e6f3 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/NotificationPlaceholderResolver.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/NotificationPlaceholderResolver.cs @@ -45,10 +45,18 @@ public static string ReplaceOwnerPlaceholders(string text, FwoOwner? owner, stri /// /// Replaces workflow placeholders. /// - public static string ReplaceWorkflowPlaceholders(string text, WfStatefulObject statefulObject, FwoOwner? owner) + public static string ReplaceWorkflowPlaceholders(string text, WfStatefulObject statefulObject, FwoOwner? owner, + NotificationPlaceholderData? placeholderData = null, bool renderHtmlLinks = false) { - return ReplaceOwnerPlaceholders(text, owner ?? GetWorkflowOwner(statefulObject)) - .Replace(Placeholder.REQUESTER, GetRequesterName(statefulObject)); + NotificationPlaceholderValues values = new() + { + Application = owner ?? GetWorkflowOwner(statefulObject) ?? new(), + RequesterName = GetRequesterName(statefulObject), + Reason = GetWorkflowReason(statefulObject), + RequestDate = GetWorkflowRequestDate(statefulObject) + }; + values = ApplyWorkflowPlaceholderData(values, placeholderData); + return ReplaceNotificationPlaceholders(text, values, renderHtmlLinks); } /// @@ -90,6 +98,51 @@ private static string GetRequesterName(WfStatefulObject statefulObject) return ""; } + private static string GetWorkflowReason(WfStatefulObject statefulObject) + { + return statefulObject switch + { + WfTicket ticket => ticket.Reason ?? "", + WfReqTask reqTask => reqTask.Reason ?? "", + WfImplTask implTask => implTask.Comments.LastOrDefault()?.Comment.CommentText ?? "", + _ => statefulObject.OptComment() ?? "" + }; + } + + private static string GetWorkflowRequestDate(WfStatefulObject statefulObject) + { + return statefulObject is WfTicket ticket && ticket.CreationDate != default + ? ticket.CreationDate.ToString("dd.MM.yyyy") + : ""; + } + + private static NotificationPlaceholderValues ApplyWorkflowPlaceholderData(NotificationPlaceholderValues values, NotificationPlaceholderData? data) + { + if (data == null) + { + return values; + } + + return values with + { + RequestingOwner = !string.IsNullOrWhiteSpace(data.RequestingAppName) || !string.IsNullOrWhiteSpace(data.RequestingAppId) + ? new FwoOwner { Name = data.RequestingAppName, ExtAppId = data.RequestingAppId } + : values.RequestingOwner, + InterfaceName = FirstNonEmpty(data.InterfaceName, values.InterfaceName), + InterfaceLinkText = FirstNonEmpty(data.InterfaceLinkText, values.InterfaceLinkText), + InterfaceLinkName = FirstNonEmpty(data.InterfaceLinkName, values.InterfaceLinkName), + InterfaceLinkUrl = FirstNonEmpty(data.InterfaceLinkUrl, values.InterfaceLinkUrl), + NewInterfaceName = FirstNonEmpty(data.NewInterfaceName, values.NewInterfaceName), + NewInterfaceLinkText = FirstNonEmpty(data.NewInterfaceLinkText, values.NewInterfaceLinkText), + NewInterfaceLinkName = FirstNonEmpty(data.NewInterfaceLinkName, values.NewInterfaceLinkName), + NewInterfaceLinkUrl = FirstNonEmpty(data.NewInterfaceLinkUrl, values.NewInterfaceLinkUrl), + Reason = FirstNonEmpty(data.Reason, values.Reason), + UserName = FirstNonEmpty(data.UserName, values.UserName), + RequesterName = FirstNonEmpty(data.RequesterName, values.RequesterName), + RequestDate = FirstNonEmpty(data.RequestDate, values.RequestDate) + }; + } + private static string FirstNonEmpty(params string?[] values) { return values.FirstOrDefault(value => !string.IsNullOrWhiteSpace(value)) ?? ""; diff --git a/roles/lib/files/FWO.Services/Workflow/ActionHandler.cs b/roles/lib/files/FWO.Services/Workflow/ActionHandler.cs index 6b1e836dd2..10b197c215 100644 --- a/roles/lib/files/FWO.Services/Workflow/ActionHandler.cs +++ b/roles/lib/files/FWO.Services/Workflow/ActionHandler.cs @@ -258,7 +258,8 @@ private WorkflowActionParameters BuildWorkflowActionParameters(WfStatefulObject NewStateId = statefulObject.StateId, StateChangedByCreation = statefulObject.StateChangedByCreation(), Phase = wfHandler.Phase.ToString(), - ExecutionMode = wfHandler.userConfig.ExecutionMode + ExecutionMode = wfHandler.userConfig.ExecutionMode, + NotificationPlaceholders = statefulObject.NotificationPlaceholders }; } diff --git a/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs b/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs index bf824110d3..4702a60cb9 100644 --- a/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs +++ b/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs @@ -26,7 +26,8 @@ public async Task SendEmail(WfStateAction action, WfStatefulObject statefulObjec EmailHelper emailHelper = new(apiConnection, wfHandler.MiddlewareClient, wfHandler.userConfig, wfHandler.DisplayMessage, UserGroups, useInMwServer, workflowRecipientResolver); await emailHelper.Init(ScopedUserTo, ScopedUserCc, ScopedUserBcc, ScopedUserEmailTo, ScopedUserEmailCc, ScopedUserEmailBcc); WfStatefulObject placeholderObject = WorkflowPlaceholderObject(statefulObject); - if (await emailHelper.SendWorkflowActionEmail(actionNotification, statefulObject, owner, userGrpDn, workflowContent, placeholderObject)) + if (await emailHelper.SendWorkflowActionEmail(actionNotification, statefulObject, owner, userGrpDn, workflowContent, placeholderObject, + statefulObject.NotificationPlaceholders)) { ++sentEmailCount; if (actionNotification.Id > 0) diff --git a/roles/lib/files/FWO.Services/Workflow/TicketCreator.cs b/roles/lib/files/FWO.Services/Workflow/TicketCreator.cs index ac3c270d29..ee7ffb2a7a 100644 --- a/roles/lib/files/FWO.Services/Workflow/TicketCreator.cs +++ b/roles/lib/files/FWO.Services/Workflow/TicketCreator.cs @@ -156,15 +156,17 @@ public async Task SetInterfaceId(long ticketId, long connId) /// /// Promotes the first new-interface implementation task of the given ticket. /// - public async Task PromoteNewInterfaceImplTask(long ticketId, ExtStates extState, string comment = "") + public async Task PromoteNewInterfaceImplTask(long ticketId, ExtStates extState, string comment = "", + NotificationPlaceholderData? placeholderData = null) { - return await PromoteNewInterfaceImplTasks(ticketId, extState, null, comment) > 0; + return await PromoteNewInterfaceImplTasks(ticketId, extState, null, comment, placeholderData) > 0; } /// /// Promotes selected new-interface implementation tasks of the given ticket. /// - public async Task PromoteNewInterfaceImplTasks(long ticketId, ExtStates extState, IEnumerable? requestTaskIds, string comment = "") + public async Task PromoteNewInterfaceImplTasks(long ticketId, ExtStates extState, IEnumerable? requestTaskIds, string comment = "", + NotificationPlaceholderData? placeholderData = null) { ExtStateHandler extStateHandler = new(apiConnection); await wfHandler.Init(); @@ -179,6 +181,7 @@ public async Task PromoteNewInterfaceImplTasks(long ticketId, ExtStates ext foreach (WfImplTask implTask in implTasks) { await wfHandler.ContinueImplPhase(implTask); + wfHandler.ActImplTask.NotificationPlaceholders = placeholderData; if (comment != "") { await wfHandler.ConfAddCommentToImplTask(comment); diff --git a/roles/middleware/files/FWO.Middleware.Server/Controllers/WorkflowController.cs b/roles/middleware/files/FWO.Middleware.Server/Controllers/WorkflowController.cs index 7e0d11ea74..6b40ed7d9e 100644 --- a/roles/middleware/files/FWO.Middleware.Server/Controllers/WorkflowController.cs +++ b/roles/middleware/files/FWO.Middleware.Server/Controllers/WorkflowController.cs @@ -181,6 +181,8 @@ private async Task ExecuteActionsInMiddlewareContext(ApiCo return result; } + statefulObject.NotificationPlaceholders = parameters.NotificationPlaceholders; + if (!await CallerCanAccessVisibility(User, wfHandler, scope, statefulObject)) { SetWarning(result, $"User is not authorized to access workflow visibility for scope '{scope}' and state {statefulObject.StateId}."); diff --git a/roles/tests-unit/files/FWO.Test/EmailNotificationContentTest.cs b/roles/tests-unit/files/FWO.Test/EmailNotificationContentTest.cs index ace4c32262..a461b73365 100644 --- a/roles/tests-unit/files/FWO.Test/EmailNotificationContentTest.cs +++ b/roles/tests-unit/files/FWO.Test/EmailNotificationContentTest.cs @@ -348,6 +348,57 @@ public void ReplaceWorkflowPlaceholdersUsesRequesterDnWhenRequesterNameIsMissing Assert.That(text, Is.EqualTo("Application/APP-2/cn=requester,dc=test")); } + [Test] + public void ReplaceWorkflowPlaceholdersAppliesCallerProvidedContext() + { + WfTicket ticket = new() + { + Requester = new() { Name = "Requester" }, + Reason = "Original reason", + CreationDate = new DateTime(2025, 1, 2) + }; + NotificationPlaceholderData placeholderData = new() + { + RequestingAppName = "Requesting App", + RequestingAppId = "REQ-APP", + InterfaceName = "old-interface", + InterfaceLinkText = "Interface", + InterfaceLinkName = "old-interface", + InterfaceLinkUrl = "https://example.test/old", + NewInterfaceName = "new-interface", + NewInterfaceLinkText = "New interface", + NewInterfaceLinkName = "new-interface", + NewInterfaceLinkUrl = "https://example.test/new", + Reason = "Rejected reason", + UserName = "Rejecter", + RequestDate = "03.01.2025" + }; + + string text = NotificationPlaceholderResolver.ReplaceWorkflowPlaceholders( + string.Join("|", new List + { + Placeholder.APPNAME, + Placeholder.APPID, + Placeholder.REQUESTER, + Placeholder.REQUESTING_APPNAME, + Placeholder.REQUESTING_APPID, + Placeholder.INTERFACE_NAME, + Placeholder.INTERFACE_LINK, + Placeholder.NEW_INTERFACE_NAME, + Placeholder.NEW_INTERFACE_LINK, + Placeholder.REASON, + Placeholder.USER_NAME, + Placeholder.REQUESTDATE + }), + ticket, + new FwoOwner { Name = "Owner", ExtAppId = "APP-1" }, + placeholderData, + renderHtmlLinks: true); + + Assert.That(text, Is.EqualTo( + "Owner|APP-1|Requester|Requesting App|REQ-APP|old-interface|Interface: old-interface|new-interface|New interface: new-interface|Rejected reason|Rejecter|03.01.2025")); + } + [Test] public void ReplaceOwnerPlaceholdersReplacesAppAndTimeInterval() { diff --git a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs index a0d658894d..1acedef9cd 100644 --- a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs @@ -340,6 +340,41 @@ public void RejectInterfacePopup_OnParametersSet_SetsMessageAndAdminReason() }); } + [Test] + public void RejectInterfacePopup_BuildsNotificationContextWithRejectReason() + { + using BunitContext context = CreateContext(Roles.Admin, Roles.Modeller); + SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + userConfig.User.Roles = [Roles.Admin, Roles.Modeller]; + userConfig.SetExecutionMode(Roles.Admin); + ModellingConnection actConn = new() + { + Id = 21, + Name = "iface21", + App = new FwoOwner { Name = "Requesting App", ExtAppId = "REQ-APP" }, + CreationDate = new DateTime(2025, 1, 2), + IsInterface = true + }; + ModellingConnectionHandler handler = CreateConnectionHandler(new RejectInterfacePopupTestApiConn(), userConfig, actConn); + handler.Application.ExtAppId = "OWNER-APP"; + IRenderedComponent component = RenderRejectInterfacePopup( + context, handler, allowAdminReject: true); + + component.Find("textarea").Change("not approved"); + MethodInfo method = typeof(RejectInterfacePopup).GetMethod("BuildNotificationPlaceholderData", BindingFlags.Instance | BindingFlags.NonPublic)!; + NotificationPlaceholderData data = (NotificationPlaceholderData)method.Invoke(component.Instance, null)!; + + Assert.Multiple(() => + { + Assert.That(data.InterfaceName, Is.EqualTo("iface21")); + Assert.That(data.RequestingAppName, Is.EqualTo("Requesting App")); + Assert.That(data.RequestingAppId, Is.EqualTo("REQ-APP")); + Assert.That(data.Reason, Is.EqualTo("not approved")); + Assert.That(data.RequestDate, Is.EqualTo("02.01.2025")); + Assert.That(data.InterfaceLinkUrl, Is.EqualTo("https://fwo.example/networkmodelling/OWNER-APP/21")); + }); + } + [Test] public async Task RejectInterfacePopup_Reject_SavesPropertiesAndRemovesSelection() { diff --git a/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor b/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor index 47c6bf786b..7258a7e1b0 100644 --- a/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor +++ b/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor @@ -1,4 +1,5 @@ @using FWO.Middleware.Client +@using FWO.Data @using FWO.Compliance @@ -124,13 +125,34 @@ if(ConnHandler != null && ConnHandler.ActConn.TicketId != null) { TicketCreator ticketCreator = new(apiConnection, userConfig, authenticationStateTask!.Result.User, middlewareClient, WorkflowPhases.implementation, new ComplianceRequestedRulePolicyChecker(userConfig, apiConnection)); - if(await ticketCreator.PromoteNewInterfaceImplTask((long)ConnHandler.ActConn.TicketId, ExtStates.Rejected, Reason)) + if(await ticketCreator.PromoteNewInterfaceImplTask((long)ConnHandler.ActConn.TicketId, ExtStates.Rejected, Reason, + BuildNotificationPlaceholderData())) { DisplayMessageInUi(null, userConfig.GetText("reject_interface"), userConfig.GetText("U9018"), false); } } } + private NotificationPlaceholderData BuildNotificationPlaceholderData() + { + string interfaceName = ConnHandler?.ActConn.Name ?? ""; + string interfaceUrl = ConnHandler == null + ? "" + : $"{userConfig.UiHostName}/{PageName.Modelling}/{ConnHandler.Application.ExtAppId}/{ConnHandler.ActConn.Id}"; + return new NotificationPlaceholderData + { + RequestingAppName = ConnHandler?.ActConn.App.Name ?? "", + RequestingAppId = ConnHandler?.ActConn.App.ExtAppId ?? "", + InterfaceName = interfaceName, + InterfaceLinkText = userConfig.GetText("interface"), + InterfaceLinkName = interfaceName, + InterfaceLinkUrl = interfaceUrl, + Reason = Reason, + UserName = userConfig.User.Name, + RequestDate = ConnHandler?.ActConn.CreationDate?.ToString("dd.MM.yyyy") ?? "" + }; + } + private void Close() { Display = false; From 82c6d92117ea565475ec313d1d48f200f752bab1 Mon Sep 17 00:00:00 2001 From: abarz722 Date: Fri, 4 Sep 2026 18:06:14 +0200 Subject: [PATCH 05/48] revision --- documentation/revision-history.md | 2 +- roles/database/files/upgrade/{9.4.5.sql => 9.5.5.sql} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename roles/database/files/upgrade/{9.4.5.sql => 9.5.5.sql} (100%) diff --git a/documentation/revision-history.md b/documentation/revision-history.md index 698498c170..0ad2e38368 100644 --- a/documentation/revision-history.md +++ b/documentation/revision-history.md @@ -642,6 +642,6 @@ Not supported any longer are: - Flow sync now recalculates the hashes stored in the flow database when they no longer match the current hash logic, instead of skipping the affected management. Entries whose hash was generated randomly keep their hash, groups and accesses are recalculated from their members, and only changed hashes are written. Creating a flow from a request while such a recalculation runs can fail or reuse a wrong entry, because flow entries are identified by their hash; repeat the action in that case. Hashes are only recalculated when the hash logic itself changes. - Flow time objects created by the request module before 9.4.5 stored their start and end time shifted by the UTC offset of the middleware server. The hash recalculation takes the stored times as they are, so these time objects keep the shifted period and get a new hash, which also changes the hash of every flow access using them. They are not repaired automatically: check time restrictions of flows created before 9.4.5 and request them again if the period is wrong. -## 9.4.6 - 02.09.2026 +## 9.5.5 - 04.09.2026 - rework modelling notifications and move interface-request notifications to centralized notification entries - interface-request notifications now support separate request and reminder bodies plus optional CC to the requester diff --git a/roles/database/files/upgrade/9.4.5.sql b/roles/database/files/upgrade/9.5.5.sql similarity index 100% rename from roles/database/files/upgrade/9.4.5.sql rename to roles/database/files/upgrade/9.5.5.sql From 364ac09c56d1225ac260b861750d1e247ba7db49 Mon Sep 17 00:00:00 2001 From: abarz722 Date: Fri, 4 Sep 2026 19:58:53 +0200 Subject: [PATCH 06/48] fix fworch-texts --- roles/database/files/sql/idempotent/fworch-texts.sql | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/roles/database/files/sql/idempotent/fworch-texts.sql b/roles/database/files/sql/idempotent/fworch-texts.sql index 795d50192c..5f84d80d89 100644 --- a/roles/database/files/sql/idempotent/fworch-texts.sql +++ b/roles/database/files/sql/idempotent/fworch-texts.sql @@ -1,4 +1,4 @@ --- text codes (roughly) categorized: +-- text codes (roughly) categorized: -- U: user texts (explanation or confirmation texts) -- E: error texts -- A: Api errors @@ -3403,6 +3403,8 @@ INSERT INTO txt VALUES ('accesstoken_lifetime', 'German', 'Access Token Gü INSERT INTO txt VALUES ('accesstoken_lifetime', 'English', 'Access Token Lifetime'); INSERT INTO txt VALUES ('refreshtoken_lifetime','German', 'Refresh Token Gültigkeitsdauer'); INSERT INTO txt VALUES ('refreshtoken_lifetime','English', 'Refresh Token Lifetime'); +INSERT INTO txt VALUES ('path_analysis_algorithm','German', 'Pfadanalyse Algorithmus'); +INSERT INTO txt VALUES ('path_analysis_algorithm','English','Path Analysis Algorithm'); -- monitoring INSERT INTO txt VALUES ('system', 'German', 'System'); From 68ed3e8e3f6161472ec2290a68bcdcec7e0920a3 Mon Sep 17 00:00:00 2001 From: abarz722 Date: Fri, 4 Sep 2026 20:52:31 +0200 Subject: [PATCH 07/48] fix test --- roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs index 1acedef9cd..7d3822f1e6 100644 --- a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs @@ -345,6 +345,7 @@ public void RejectInterfacePopup_BuildsNotificationContextWithRejectReason() { using BunitContext context = CreateContext(Roles.Admin, Roles.Modeller); SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + userConfig.UiHostName = "https://fwo.example"; userConfig.User.Roles = [Roles.Admin, Roles.Modeller]; userConfig.SetExecutionMode(Roles.Admin); ModellingConnection actConn = new() From b49cb104b81a611647d63b170ec2076687832092 Mon Sep 17 00:00:00 2001 From: abarz722 Date: Sat, 5 Sep 2026 19:34:59 +0200 Subject: [PATCH 08/48] some fixes --- .../FWO.Data/Workflow/WfStatefulObject.cs | 8 ---- .../EmailNotification/EmailHelper.cs | 45 +++++++++---------- .../NotificationLogHelper.cs | 39 ++++++++++++++++ .../NotificationScheduleHelper.cs | 6 +-- .../FWO.Services/Workflow/ActionHandler.cs | 28 ++++++------ .../Workflow/ActionHandlerSendEmail.cs | 5 ++- .../FWO.Services/Workflow/TicketCreator.cs | 3 +- .../files/FWO.Services/Workflow/WfDbAccess.cs | 4 +- .../Workflow/WfHandlerStateChanges.cs | 9 ++-- .../Controllers/WorkflowController.cs | 7 ++- .../NotificationService.cs | 10 +++++ 11 files changed, 102 insertions(+), 62 deletions(-) create mode 100644 roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs diff --git a/roles/lib/files/FWO.Data/Workflow/WfStatefulObject.cs b/roles/lib/files/FWO.Data/Workflow/WfStatefulObject.cs index def9c11041..11e798fab2 100644 --- a/roles/lib/files/FWO.Data/Workflow/WfStatefulObject.cs +++ b/roles/lib/files/FWO.Data/Workflow/WfStatefulObject.cs @@ -40,13 +40,6 @@ public int StateId [JsonProperty("assigned_group"), JsonPropertyName("assigned_group")] public string? AssignedGroup { get; set; } - /// - /// Carries caller-supplied values for workflow notification placeholders. - /// - [JsonProperty("notification_placeholders"), JsonPropertyName("notification_placeholders")] - public NotificationPlaceholderData? NotificationPlaceholders { get; set; } - - // need private declarations, else we get problems with request_reqtask_arr_rel_insert_input in newTicket private int stateId; private int oldStateId; @@ -107,7 +100,6 @@ public WfStatefulObject(WfStatefulObject obj) CurrentHandler = obj.CurrentHandler; RecentHandler = obj.RecentHandler; AssignedGroup = obj.AssignedGroup; - NotificationPlaceholders = obj.NotificationPlaceholders; } public virtual bool Sanitize() diff --git a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs index fd45a2710b..5b141f0b2d 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs @@ -91,14 +91,7 @@ public virtual async Task SendEmailToNotificationRecipients(FwoNotificatio List? bccs = notification.RecipientBcc == EmailRecipientOption.None ? null : await GetNotificationRecipients(notification.RecipientBcc, notification.EmailAddressBcc, owner); - if (NotificationLoggingMode.ShouldLog(notification.Logging)) - { - List loggedTos = [.. tos]; - List? loggedCcs = ccs == null ? null : [.. ccs]; - List? loggedBccs = bccs == null ? null : [.. bccs]; - ApplyDummyRecipientOverride(ref loggedTos, ref loggedCcs, ref loggedBccs); - await InsertNotificationLog(notification, loggedTos, loggedCcs, loggedBccs, subject); - } + await LogNotificationIfConfigured(notification, tos, ccs, bccs, subject); if (!NotificationLoggingMode.ShouldSend(notification.Logging)) { @@ -127,10 +120,30 @@ public async Task SendWorkflowActionEmail(FwoNotification notification, Wf string body = NotificationPlaceholderResolver.ReplaceWorkflowPlaceholders(NotificationEmailLayoutHelper.BuildBody(notification, workflowContent), placeholderContext, owner, placeholderData, renderHtmlLinks: true); FormFile? attachment = await NotificationEmailLayoutHelper.BuildAttachment(notification.Layout, workflowContent, subject); + await LogNotificationIfConfigured(notification, tos, ccs, bccs, subject); + if (!NotificationLoggingMode.ShouldSend(notification.Logging)) + { + return true; + } return await SendEmail(tos, subject, body, ccs, bccs, notification.Layout == NotificationLayout.HtmlInBody, attachment); } + private async Task LogNotificationIfConfigured(FwoNotification notification, List tos, List? ccs, + List? bccs, string subject) + { + if (!NotificationLoggingMode.ShouldLog(notification.Logging)) + { + return; + } + + List loggedTos = [.. tos]; + List? loggedCcs = ccs == null ? null : [.. ccs]; + List? loggedBccs = bccs == null ? null : [.. bccs]; + ApplyDummyRecipientOverride(ref loggedTos, ref loggedCcs, ref loggedBccs); + await NotificationLogHelper.InsertAsync(apiConnection, notification, loggedTos, loggedCcs, loggedBccs, subject); + } + private async Task> GetWorkflowActionRecipients( EmailRecipientOption recipientOption, string addressList, @@ -186,22 +199,6 @@ protected virtual async Task SendEmail(List tos, string subject, s return sent; } - private async Task InsertNotificationLog(FwoNotification notification, List tos, List? ccs, List? bccs, string subject) - { - NotificationLogEntry entry = new() - { - Timestamp = DateTimeOffset.UtcNow, - NotificationId = notification.Id, - NotificationType = notification.NotificationClient.ToString(), - To = string.Join(", ", tos), - Cc = string.Join(", ", ccs ?? []), - Bcc = string.Join(", ", bccs ?? []), - Subject = subject - }; - - await apiConnection.SendQueryAsync(NotificationQueries.insertNotificationLog, new { entries = new List { entry } }); - } - public async Task> GetRecipients(EmailRecipientOption recipientOption, WfStatefulObject? statefulObject, FwoOwner? owner, string? scopedUser, List? otherAddresses, string? scopedUserEmail = null) { diff --git a/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs new file mode 100644 index 0000000000..206f70f6ca --- /dev/null +++ b/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs @@ -0,0 +1,39 @@ +using FWO.Api.Client; +using FWO.Api.Client.Queries; +using FWO.Data; + +namespace FWO.Services +{ + /// + /// Persists notification delivery data for the email log. + /// + public static class NotificationLogHelper + { + /// + /// Inserts one notification delivery log entry. + /// + /// API connection used to persist the entry. + /// Notification configuration being delivered. + /// Resolved To recipients. + /// Resolved Cc recipients. + /// Resolved Bcc recipients. + /// Rendered subject. + public static async Task InsertAsync(ApiConnection apiConnection, FwoNotification notification, + IEnumerable tos, IEnumerable? ccs, IEnumerable? bccs, string subject) + { + NotificationLogEntry entry = new() + { + Timestamp = DateTimeOffset.UtcNow, + NotificationId = notification.Id, + NotificationType = notification.NotificationClient.ToString(), + To = string.Join(", ", tos), + Cc = string.Join(", ", ccs ?? []), + Bcc = string.Join(", ", bccs ?? []), + Subject = subject + }; + + await apiConnection.SendQueryAsync(NotificationQueries.insertNotificationLog, + new { entries = new List { entry } }); + } + } +} diff --git a/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs index c43148f105..84c04c0da5 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs @@ -1,6 +1,5 @@ using FWO.Basics; using FWO.Data; -using FWO.Logging; namespace FWO.Services { @@ -24,7 +23,7 @@ public static bool IsNotificationDue(FwoOwner? owner, DateTime? extDeadline, Fwo } DateTime deadline = GetDeadlineDate(notification.Deadline, owner, extDeadline); - return deadline.Date >= DateTime.Now.Date + return deadline >= DateTime.Now ? IsNotificationDueBeforeDeadline(deadline, notification) : IsNotificationDueAfterDeadline(deadline, notification); } @@ -42,7 +41,8 @@ private static bool TryGetConfiguredInterval(SchedulerInterval? interval, string return true; } - Log.WriteWarning("Notifications", $"Notification interval '{propertyName}' is not configured. Skipping due evaluation."); + // Before- and after-deadline schedules are optional. An unset interval + // disables only the corresponding phase; it is not an error. configuredInterval = default; return false; } diff --git a/roles/lib/files/FWO.Services/Workflow/ActionHandler.cs b/roles/lib/files/FWO.Services/Workflow/ActionHandler.cs index 10b197c215..111751f406 100644 --- a/roles/lib/files/FWO.Services/Workflow/ActionHandler.cs +++ b/roles/lib/files/FWO.Services/Workflow/ActionHandler.cs @@ -71,7 +71,8 @@ public List GetOfferedActions(WfStatefulObject statefulObject, Wf return offeredActions; } - public async Task DoStateChangeActions(WfStatefulObject statefulObject, WfObjectScopes scope, FwoOwner? owner = null, long? ticketId = null, string? userGrpDn = null) + public async Task DoStateChangeActions(WfStatefulObject statefulObject, WfObjectScopes scope, FwoOwner? owner = null, long? ticketId = null, string? userGrpDn = null, + NotificationPlaceholderData? placeholderData = null) { if (!statefulObject.StateChanged()) { @@ -83,7 +84,7 @@ public async Task DoStateChangeActions(WfStatefulObject statefulObject, WfObject { try { - await ExecuteInMiddleware(BuildWorkflowActionParameters(statefulObject, scope, ticketId)); + await ExecuteInMiddleware(BuildWorkflowActionParameters(statefulObject, scope, ticketId, placeholderData: placeholderData)); } finally { @@ -101,8 +102,8 @@ public async Task DoStateChangeActions(WfStatefulObject statefulObject, WfObject List onLeaveActions = StateActionsForEvent(statefulObject, scope, StateActionEvents.OnLeave, false); statefulObject.ResetStateChanged(); - await PerformStateActions(onSetActions, StateActionEvents.OnSet, statefulObject, scope, owner, ticketId, userGrpDn); - await PerformStateActions(onLeaveActions, StateActionEvents.OnLeave, statefulObject, scope, owner, ticketId, userGrpDn); + await PerformStateActions(onSetActions, StateActionEvents.OnSet, statefulObject, scope, owner, ticketId, userGrpDn, placeholderData); + await PerformStateActions(onLeaveActions, StateActionEvents.OnLeave, statefulObject, scope, owner, ticketId, userGrpDn, placeholderData); } private List StateActionsForEvent(WfStatefulObject statefulObject, WfObjectScopes scope, StateActionEvents actionEvent, bool currentState) @@ -111,7 +112,7 @@ private List StateActionsForEvent(WfStatefulObject statefulObject } private async Task PerformStateActions(List actions, StateActionEvents actionEvent, WfStatefulObject statefulObject, - WfObjectScopes scope, FwoOwner? owner, long? ticketId, string? userGrpDn) + WfObjectScopes scope, FwoOwner? owner, long? ticketId, string? userGrpDn, NotificationPlaceholderData? placeholderData) { foreach (var action in actions.Where(IsActionInCurrentPhase)) { @@ -119,7 +120,7 @@ private async Task PerformStateActions(List actions, StateActionE Log.WriteDebug("DoStateChangeActions", $"Perform {actionEvent} action '{action.Name}' ({action.ActionType}) for {scope} state {stateText}."); try { - await PerformAction(action, statefulObject, scope, owner, ticketId, userGrpDn); + await PerformAction(action, statefulObject, scope, owner, ticketId, userGrpDn, placeholderData); } catch (Exception exc) { @@ -166,12 +167,12 @@ private static bool IsSamePersistedAction(WfStateAction firstAction, WfStateActi } public async Task PerformAction(WfStateAction action, WfStatefulObject statefulObject, WfObjectScopes scope, - FwoOwner? owner = null, long? ticketId = null, string? userGrpDn = null) + FwoOwner? owner = null, long? ticketId = null, string? userGrpDn = null, NotificationPlaceholderData? placeholderData = null) { if (scope != WfObjectScopes.None && !useInMwServer && wfHandler.MiddlewareClient != null && !WfStateAction.IsReadonlyType(action.ActionType)) { Log.WriteDebug("PerformAction", $"Delegating action '{action.Name}' ({action.ActionType}) to middleware."); - await ExecuteInMiddleware(BuildWorkflowActionParameters(statefulObject, scope, ticketId, action.Id)); + await ExecuteInMiddleware(BuildWorkflowActionParameters(statefulObject, scope, ticketId, action.Id, placeholderData)); return; } @@ -199,7 +200,7 @@ public async Task PerformAction(WfStateAction action, WfStatefulObject statefulO await CallExternal(action); break; case nameof(StateActionTypes.SendEmail): - await SendEmail(action, statefulObject, scope, owner, userGrpDn); + await SendEmail(action, statefulObject, scope, owner, userGrpDn, placeholderData); break; case nameof(StateActionTypes.CreateFlow): await CreateFlow(action, statefulObject, scope, owner, ticketId); @@ -234,7 +235,7 @@ public async Task PerformAction(WfStateAction action, WfStatefulObject statefulO } public async Task PerformActionById(int actionId, WfStatefulObject statefulObject, WfObjectScopes scope, - FwoOwner? owner = null, long? ticketId = null, string? userGrpDn = null) + FwoOwner? owner = null, long? ticketId = null, string? userGrpDn = null, NotificationPlaceholderData? placeholderData = null) { WfStateAction? action = GetOfferedActions(statefulObject, scope, wfHandler.Phase).FirstOrDefault(action => action.Id == actionId); if (action == null) @@ -242,11 +243,12 @@ public async Task PerformActionById(int actionId, WfStatefulObject statefu Log.WriteError("Workflow Actions", $"Action id {actionId} is not offered for {scope} in state {statefulObject.StateId} and phase {wfHandler.Phase}."); return false; } - await PerformAction(action, statefulObject, scope, owner, ticketId, userGrpDn); + await PerformAction(action, statefulObject, scope, owner, ticketId, userGrpDn, placeholderData); return true; } - private WorkflowActionParameters BuildWorkflowActionParameters(WfStatefulObject statefulObject, WfObjectScopes scope, long? ticketId, int actionId = 0) + private WorkflowActionParameters BuildWorkflowActionParameters(WfStatefulObject statefulObject, WfObjectScopes scope, long? ticketId, int actionId = 0, + NotificationPlaceholderData? placeholderData = null) { return new() { @@ -259,7 +261,7 @@ private WorkflowActionParameters BuildWorkflowActionParameters(WfStatefulObject StateChangedByCreation = statefulObject.StateChangedByCreation(), Phase = wfHandler.Phase.ToString(), ExecutionMode = wfHandler.userConfig.ExecutionMode, - NotificationPlaceholders = statefulObject.NotificationPlaceholders + NotificationPlaceholders = placeholderData }; } diff --git a/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs b/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs index 4702a60cb9..30592ddac0 100644 --- a/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs +++ b/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs @@ -9,7 +9,8 @@ namespace FWO.Services.Workflow { public partial class ActionHandler { - public async Task SendEmail(WfStateAction action, WfStatefulObject statefulObject, WfObjectScopes scope, FwoOwner? owner, string? userGrpDn = null) + public async Task SendEmail(WfStateAction action, WfStatefulObject statefulObject, WfObjectScopes scope, FwoOwner? owner, string? userGrpDn = null, + NotificationPlaceholderData? placeholderData = null) { Log.WriteDebug("SendEmail", "Perform Action"); EmailActionParams? emailActionParams = null; @@ -27,7 +28,7 @@ public async Task SendEmail(WfStateAction action, WfStatefulObject statefulObjec await emailHelper.Init(ScopedUserTo, ScopedUserCc, ScopedUserBcc, ScopedUserEmailTo, ScopedUserEmailCc, ScopedUserEmailBcc); WfStatefulObject placeholderObject = WorkflowPlaceholderObject(statefulObject); if (await emailHelper.SendWorkflowActionEmail(actionNotification, statefulObject, owner, userGrpDn, workflowContent, placeholderObject, - statefulObject.NotificationPlaceholders)) + placeholderData)) { ++sentEmailCount; if (actionNotification.Id > 0) diff --git a/roles/lib/files/FWO.Services/Workflow/TicketCreator.cs b/roles/lib/files/FWO.Services/Workflow/TicketCreator.cs index ee7ffb2a7a..ad3f28bd7c 100644 --- a/roles/lib/files/FWO.Services/Workflow/TicketCreator.cs +++ b/roles/lib/files/FWO.Services/Workflow/TicketCreator.cs @@ -181,12 +181,11 @@ public async Task PromoteNewInterfaceImplTasks(long ticketId, ExtStates ext foreach (WfImplTask implTask in implTasks) { await wfHandler.ContinueImplPhase(implTask); - wfHandler.ActImplTask.NotificationPlaceholders = placeholderData; if (comment != "") { await wfHandler.ConfAddCommentToImplTask(comment); } - await wfHandler.PromoteImplTask(new() { StateId = (int)newState }); + await wfHandler.PromoteImplTask(new() { StateId = (int)newState }, placeholderData); promotedCount++; } return promotedCount; diff --git a/roles/lib/files/FWO.Services/Workflow/WfDbAccess.cs b/roles/lib/files/FWO.Services/Workflow/WfDbAccess.cs index 5f87433ef6..109f7d1562 100644 --- a/roles/lib/files/FWO.Services/Workflow/WfDbAccess.cs +++ b/roles/lib/files/FWO.Services/Workflow/WfDbAccess.cs @@ -461,7 +461,7 @@ public async Task UpdateReqTaskStateInDb(WfReqTask reqtask, bool triggerActions return !string.IsNullOrWhiteSpace(ticket.Requester?.Dn) ? ticket.Requester.Dn : ticket.RequesterDn; } - public async Task UpdateImplTaskStateInDb(WfImplTask impltask, bool triggerActions = true) + public async Task UpdateImplTaskStateInDb(WfImplTask impltask, bool triggerActions = true, NotificationPlaceholderData? placeholderData = null) { try { @@ -484,7 +484,7 @@ public async Task UpdateImplTaskStateInDb(WfImplTask impltask, bool triggerActio { if (triggerActions) { - await ActionHandler.DoStateChangeActions(impltask, WfObjectScopes.ImplementationTask); + await ActionHandler.DoStateChangeActions(impltask, WfObjectScopes.ImplementationTask, placeholderData: placeholderData); } } } diff --git a/roles/lib/files/FWO.Services/Workflow/WfHandlerStateChanges.cs b/roles/lib/files/FWO.Services/Workflow/WfHandlerStateChanges.cs index dace6d835c..4ff1b5fe58 100644 --- a/roles/lib/files/FWO.Services/Workflow/WfHandlerStateChanges.cs +++ b/roles/lib/files/FWO.Services/Workflow/WfHandlerStateChanges.cs @@ -1,4 +1,5 @@ using FWO.Basics; +using FWO.Data; using FWO.Data.Workflow; using FWO.Logging; @@ -88,7 +89,7 @@ public async Task PromoteReqTask(WfStatefulObject reqTask) } } - public async Task PromoteImplTask(WfStatefulObject implTask) + public async Task PromoteImplTask(WfStatefulObject implTask, NotificationPlaceholderData? placeholderData = null) { try { @@ -98,7 +99,7 @@ public async Task PromoteImplTask(WfStatefulObject implTask) { ActImplTask.Stop = DateTime.Now; } - await UpdateActImplTaskState(); + await UpdateActImplTaskState(placeholderData: placeholderData); ResetImplTaskList(); await UpdateReqTaskStatesFromActImplTask(); await UpdateActTicketStateFromReqTasks(); @@ -459,12 +460,12 @@ private List GetBundledRequestTasks(WfReqTask reqTask) : [.. ActTicket.Tasks.Where(task => task.GetAddInfoValue(AdditionalInfoKeys.FlowBundleId) == bundleId)]; } - private async Task UpdateActImplTaskState(bool triggerActions = true) + private async Task UpdateActImplTaskState(bool triggerActions = true, NotificationPlaceholderData? placeholderData = null) { if (dbAcc != null) { AuditUnexpectedStateTransition(ActImplTask, WfObjectScopes.ImplementationTask, ActStateMatrix); - await dbAcc.UpdateImplTaskStateInDb(ActImplTask, triggerActions); + await dbAcc.UpdateImplTaskStateInDb(ActImplTask, triggerActions, placeholderData); } int index = ActReqTask.ImplementationTasks.FindIndex(x => x.Id == ActImplTask.Id); if (index >= 0) diff --git a/roles/middleware/files/FWO.Middleware.Server/Controllers/WorkflowController.cs b/roles/middleware/files/FWO.Middleware.Server/Controllers/WorkflowController.cs index 6b40ed7d9e..97cd16cec5 100644 --- a/roles/middleware/files/FWO.Middleware.Server/Controllers/WorkflowController.cs +++ b/roles/middleware/files/FWO.Middleware.Server/Controllers/WorkflowController.cs @@ -181,8 +181,6 @@ private async Task ExecuteActionsInMiddlewareContext(ApiCo return result; } - statefulObject.NotificationPlaceholders = parameters.NotificationPlaceholders; - if (!await CallerCanAccessVisibility(User, wfHandler, scope, statefulObject)) { SetWarning(result, $"User is not authorized to access workflow visibility for scope '{scope}' and state {statefulObject.StateId}."); @@ -350,11 +348,12 @@ private static async Task ExecuteResolvedAction(WfHandler wfHandler, Workf { if (parameters.ActionId > 0) { - return await wfHandler.ActionHandler!.PerformActionById(parameters.ActionId, statefulObject, scope, owner, actionTicketId, userGrpDn); + return await wfHandler.ActionHandler!.PerformActionById(parameters.ActionId, statefulObject, scope, owner, actionTicketId, userGrpDn, + parameters.NotificationPlaceholders); } MarkStateChanged(statefulObject, parameters.OldStateId, parameters.NewStateId); - await wfHandler.ActionHandler!.DoStateChangeActions(statefulObject, scope, owner, actionTicketId, userGrpDn); + await wfHandler.ActionHandler!.DoStateChangeActions(statefulObject, scope, owner, actionTicketId, userGrpDn, parameters.NotificationPlaceholders); return true; } diff --git a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs index 836dddd424..13cfe7d5b3 100644 --- a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs +++ b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs @@ -308,6 +308,16 @@ private async Task SendEmail(FwoNotification notification, string? content return false; } + if (NotificationLoggingMode.ShouldLog(notification.Logging)) + { + await NotificationLogHelper.InsertAsync(ApiConnection, notification, mail.To, mail.Cc, mail.Bcc, mail.Subject); + } + + if (!NotificationLoggingMode.ShouldSend(notification.Logging)) + { + return true; + } + string decryptedSecret = AesEnc.TryDecrypt(GlobalConfig.EmailPassword, false, "NotificationService", "Could not decrypt mailserver password."); EmailConnection emailConnection = new(GlobalConfig.EmailServerAddress, GlobalConfig.EmailPort, GlobalConfig.EmailTls, GlobalConfig.EmailUser, decryptedSecret, GlobalConfig.EmailSenderAddress); From 259439915d98abc1bb6fe887a52345d1f8aa6f36 Mon Sep 17 00:00:00 2001 From: abarz722 Date: Sat, 5 Sep 2026 19:52:48 +0200 Subject: [PATCH 09/48] fix test cases --- .../EmailNotification/NotificationScheduleHelper.cs | 9 ++++++++- roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs | 10 +++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs index 84c04c0da5..ee1181a70c 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs @@ -22,8 +22,15 @@ public static bool IsNotificationDue(FwoOwner? owner, DateTime? extDeadline, Fwo return true; } + if (notification.Deadline == NotificationDeadline.RequestDate + && extDeadline?.Date == DateTime.Now.Date + && notification.OffsetBeforeDeadline == 0) + { + return notification.LastSent == null || notification.LastSent.Value.Date < DateTime.Now.Date; + } + DateTime deadline = GetDeadlineDate(notification.Deadline, owner, extDeadline); - return deadline >= DateTime.Now + return deadline.Date >= DateTime.Now.Date ? IsNotificationDueBeforeDeadline(deadline, notification) : IsNotificationDueAfterDeadline(deadline, notification); } diff --git a/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs b/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs index f147c79676..e5aba1d88e 100644 --- a/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs +++ b/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs @@ -1063,7 +1063,7 @@ public void BuildWorkflowActionParameters_IncludesCreationStateChangeFlag() ticket.MarkCreatedStateChanged(1); WorkflowActionParameters parameters = (WorkflowActionParameters)GetPrivateMethod("BuildWorkflowActionParameters") - .Invoke(handler, [ticket, WfObjectScopes.Ticket, null, 0])!; + .Invoke(handler, [ticket, WfObjectScopes.Ticket, null, 0, null])!; Assert.Multiple(() => { @@ -1083,13 +1083,13 @@ public void BuildWorkflowActionParameters_UsesScopeSpecificIds() WfApproval approval = new() { Id = 13, StateId = 4 }; WorkflowActionParameters reqParams = (WorkflowActionParameters)GetPrivateMethod("BuildWorkflowActionParameters") - .Invoke(handler, [reqTask, WfObjectScopes.RequestTask, null, 5])!; + .Invoke(handler, [reqTask, WfObjectScopes.RequestTask, null, 5, null])!; WorkflowActionParameters implParams = (WorkflowActionParameters)GetPrivateMethod("BuildWorkflowActionParameters") - .Invoke(handler, [implTask, WfObjectScopes.ImplementationTask, null, 6])!; + .Invoke(handler, [implTask, WfObjectScopes.ImplementationTask, null, 6, null])!; WorkflowActionParameters approvalParams = (WorkflowActionParameters)GetPrivateMethod("BuildWorkflowActionParameters") - .Invoke(handler, [approval, WfObjectScopes.Approval, null, 7])!; + .Invoke(handler, [approval, WfObjectScopes.Approval, null, 7, null])!; WorkflowActionParameters explicitTicketParams = (WorkflowActionParameters)GetPrivateMethod("BuildWorkflowActionParameters") - .Invoke(handler, [reqTask, WfObjectScopes.RequestTask, 999L, 8])!; + .Invoke(handler, [reqTask, WfObjectScopes.RequestTask, 999L, 8, null])!; Assert.Multiple(() => { From c95aedb44181d23faa0cdee39d17fbb83fa7b2cb Mon Sep 17 00:00:00 2001 From: abarz722 Date: Mon, 7 Sep 2026 18:36:34 +0200 Subject: [PATCH 10/48] several fixes --- roles/lib/files/FWO.Config.Api/Config.cs | 9 +- .../FWO.Data/NotificationPlaceholderData.cs | 3 + roles/lib/files/FWO.Mail/MailerMailKit.cs | 94 ++++++- .../EmailNotification/EmailHelper.cs | 13 +- .../Modelling/ModellingConnectionHandler.cs | 2 +- .../FWO.Services/Workflow/StateMatrix.cs | 9 +- .../files/FWO.Services/Workflow/WfDbAccess.cs | 11 +- .../Workflow/WfHandlerImplTasks.cs | 5 +- .../Workflow/WfHandlerStateChanges.cs | 26 +- .../files/FWO.Test/ActionHandlerTest.cs | 14 + .../FWO.Test/EmailHelperRecipientTest.cs | 23 ++ .../files/FWO.Test/MailerMailKitTest.cs | 261 ++++++++++++++++++ .../files/FWO.Test/NotificationTest.cs | 7 +- .../files/FWO.Test/StateMatrixTest.cs | 23 ++ .../FWO.Test/UiRequestAndRejectPopupTest.cs | 2 +- .../files/FWO.Test/WfHandlerImplTasksTest.cs | 19 ++ .../FWO.Test/WfHandlerStateChangesTest.cs | 2 +- .../RejectInterfacePopup.razor | 20 +- 18 files changed, 499 insertions(+), 44 deletions(-) create mode 100644 roles/tests-unit/files/FWO.Test/MailerMailKitTest.cs diff --git a/roles/lib/files/FWO.Config.Api/Config.cs b/roles/lib/files/FWO.Config.Api/Config.cs index 8e9334f70e..b3624a24a7 100644 --- a/roles/lib/files/FWO.Config.Api/Config.cs +++ b/roles/lib/files/FWO.Config.Api/Config.cs @@ -27,6 +27,13 @@ public abstract class Config : ConfigData, IDisposable protected readonly SemaphoreSlim semaphoreSlim = new(1, 1); + private static readonly HashSet ignoredLegacyConfigKeys = + [ + "manageOwnerLdapGroups", + "ownerLdapId", + "ownerLdapGroupNames" + ]; + // To detect redundant dispose calls private bool _isDisposed; protected bool IsDisposed => _isDisposed; @@ -127,7 +134,7 @@ protected void Update(ConfigItem[] configItems) ApplyConfigValue(property, resolvedKey, configItem, remainingConfigItemNames); } } - foreach (var name in remainingConfigItemNames.Where(n => !n.Contains("StateMatrix"))) // StateMatrix ConfigItems are handled separately + foreach (var name in remainingConfigItemNames.Where(n => !n.Contains("StateMatrix") && !ignoredLegacyConfigKeys.Contains(n))) // StateMatrix and retired settings are handled separately { Log.WriteDebug($"Load {(UserId == 0 ? "Global " : "")}Config Items", $"Config item with key \"{name}\" could not be found. {(UserId == 0 ? "" : "User might not have customized the setting. ")}Using default value."); } diff --git a/roles/lib/files/FWO.Data/NotificationPlaceholderData.cs b/roles/lib/files/FWO.Data/NotificationPlaceholderData.cs index 800d3ef9fb..1fb290ec7d 100644 --- a/roles/lib/files/FWO.Data/NotificationPlaceholderData.cs +++ b/roles/lib/files/FWO.Data/NotificationPlaceholderData.cs @@ -41,6 +41,9 @@ public class NotificationPlaceholderData [JsonProperty("reason"), JsonPropertyName("reason")] public string Reason { get; set; } = ""; + [JsonProperty("content"), JsonPropertyName("content")] + public string Content { get; set; } = ""; + [JsonProperty("user_name"), JsonPropertyName("user_name")] public string UserName { get; set; } = ""; diff --git a/roles/lib/files/FWO.Mail/MailerMailKit.cs b/roles/lib/files/FWO.Mail/MailerMailKit.cs index 20d63bcb4b..a9f21230a6 100644 --- a/roles/lib/files/FWO.Mail/MailerMailKit.cs +++ b/roles/lib/files/FWO.Mail/MailerMailKit.cs @@ -48,15 +48,12 @@ public static async Task SendAsync( CancellationToken ct = default ) { + MailData pendingMail = CopyMailData(mailData); + using var smtp = new SmtpClient(); + smtp.Timeout = 5000; + try { - var mail = new MimeMessage(); - AddRecipients(emailConn, mailData, mail); - await AddContent(mailData, mail, mailFormatHtml); - - using var smtp = new SmtpClient(); - smtp.Timeout = 5000; - switch (emailConn.Encryption) { case EmailEncryptionMethod.None: @@ -90,10 +87,37 @@ await smtp.ConnectAsync( { await smtp.AuthenticateAsync(emailConn.User, AesEnc.TryDecrypt(emailConn.Password ?? "", true), ct); } - await smtp.SendAsync(mail, ct); - await smtp.DisconnectAsync(true, ct); - return true; + while (HasRecipients(pendingMail)) + { + var mail = new MimeMessage(); + AddRecipients(emailConn, pendingMail, mail); + await AddContent(pendingMail, mail, mailFormatHtml); + + try + { + await smtp.SendAsync(mail, ct); + await smtp.DisconnectAsync(true, ct); + return true; + } + catch (SmtpCommandException exception) when (exception.Mailbox != null) + { + string rejectedAddress = exception.Mailbox.Address; + if (!RemoveRecipient(pendingMail, rejectedAddress)) + { + throw; + } + + Log.WriteWarning( + "Send Email", + $"SMTP rejected recipient '{rejectedAddress}'. Retrying with the remaining recipients." + ); + } + } + + await smtp.DisconnectAsync(true, ct); + Log.WriteWarning("Send Email", "SMTP rejected all recipients. No email was sent."); + return false; } catch (Exception exception) { @@ -102,6 +126,56 @@ await smtp.ConnectAsync( } } + private static MailData CopyMailData(MailData source) + { + return new MailData([.. source.To], source.Subject) + { + Bcc = [.. source.Bcc], + Cc = [.. source.Cc], + From = source.From, + DisplayName = source.DisplayName, + ReplyTo = source.ReplyTo, + ReplyToName = source.ReplyToName, + Body = source.Body, + Attachments = source.Attachments + }; + } + + private static bool HasRecipients(MailData mailData) + { + return mailData.To.Any(IsAddressPresent) + || mailData.Cc.Any(IsAddressPresent) + || mailData.Bcc.Any(IsAddressPresent); + } + + private static bool IsAddressPresent(string address) + { + return !string.IsNullOrWhiteSpace(address); + } + + private static bool RemoveRecipient(MailData mailData, string rejectedAddress) + { + return RemoveRecipient(mailData.To, rejectedAddress) + || RemoveRecipient(mailData.Cc, rejectedAddress) + || RemoveRecipient(mailData.Bcc, rejectedAddress); + } + + private static bool RemoveRecipient(List recipients, string rejectedAddress) + { + int index = recipients.FindIndex(address => string.Equals( + address.Trim(), + rejectedAddress, + StringComparison.OrdinalIgnoreCase + )); + if (index < 0) + { + return false; + } + + recipients.RemoveAt(index); + return true; + } + private static void AddRecipients(EmailConnection emailConn, MailData mailData, MimeMessage mail) { string senderString = ""; diff --git a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs index 5b141f0b2d..3831f0939a 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs @@ -117,7 +117,7 @@ public async Task SendWorkflowActionEmail(FwoNotification notification, Wf : await GetWorkflowActionRecipients(notification.RecipientBcc, notification.EmailAddressBcc, statefulObject, owner, ScopedUserBcc, ScopedUserEmailBcc, userGrpDn); WfStatefulObject placeholderContext = placeholderObject ?? statefulObject; string subject = NotificationPlaceholderResolver.ReplaceWorkflowPlaceholders(notification.EmailSubject, placeholderContext, owner, placeholderData); - string body = NotificationPlaceholderResolver.ReplaceWorkflowPlaceholders(NotificationEmailLayoutHelper.BuildBody(notification, workflowContent), placeholderContext, owner, + string body = NotificationPlaceholderResolver.ReplaceWorkflowPlaceholders(BuildWorkflowActionBody(notification, workflowContent, placeholderData), placeholderContext, owner, placeholderData, renderHtmlLinks: true); FormFile? attachment = await NotificationEmailLayoutHelper.BuildAttachment(notification.Layout, workflowContent, subject); await LogNotificationIfConfigured(notification, tos, ccs, bccs, subject); @@ -129,6 +129,17 @@ public async Task SendWorkflowActionEmail(FwoNotification notification, Wf notification.Layout == NotificationLayout.HtmlInBody, attachment); } + private static string BuildWorkflowActionBody(FwoNotification notification, WorkflowEmailContent? workflowContent, + NotificationPlaceholderData? placeholderData) + { + if (!string.IsNullOrWhiteSpace(placeholderData?.Content)) + { + return NotificationEmailLayoutHelper.BuildBody(notification, placeholderData.Content); + } + + return NotificationEmailLayoutHelper.BuildBody(notification, workflowContent); + } + private async Task LogNotificationIfConfigured(FwoNotification notification, List tos, List? ccs, List? bccs, string subject) { diff --git a/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandler.cs b/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandler.cs index 61c815aaa4..5ecbabb95f 100644 --- a/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandler.cs +++ b/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandler.cs @@ -168,7 +168,7 @@ public async Task RefreshObjects() RefreshSelectableNwObjects(); } - private async Task RefreshActConn() + public async Task RefreshActConn() { try { diff --git a/roles/lib/files/FWO.Services/Workflow/StateMatrix.cs b/roles/lib/files/FWO.Services/Workflow/StateMatrix.cs index 223a3b90e0..3162b90b63 100644 --- a/roles/lib/files/FWO.Services/Workflow/StateMatrix.cs +++ b/roles/lib/files/FWO.Services/Workflow/StateMatrix.cs @@ -70,12 +70,17 @@ public async Task Init(WorkflowPhases phase, ApiConnection apiConnection, List p.Value == true).Key].LowestEndState; + WorkflowPhases lastActivePhase = PhaseActive + .Where(entry => entry.Value) + .Select(entry => entry.Key) + .DefaultIfEmpty(phase) + .Max(); + MinTicketCompleted = glbStateMatrix.GlobalMatrix[lastActivePhase].LowestEndState; } public bool getNextActivePhase(ref WorkflowPhases phase) { - foreach (var tmpPhase in PhaseActive) + foreach (var tmpPhase in PhaseActive.OrderBy(entry => entry.Key)) { if (tmpPhase.Key > phase && tmpPhase.Value) { diff --git a/roles/lib/files/FWO.Services/Workflow/WfDbAccess.cs b/roles/lib/files/FWO.Services/Workflow/WfDbAccess.cs index 109f7d1562..3353551c5d 100644 --- a/roles/lib/files/FWO.Services/Workflow/WfDbAccess.cs +++ b/roles/lib/files/FWO.Services/Workflow/WfDbAccess.cs @@ -392,7 +392,8 @@ private async Task RemoveOwnerInDb(long reqTaskId, long ownerId) // State changes - public async Task UpdateTicketStateInDb(WfTicket ticket, bool triggerActions = true) + public async Task UpdateTicketStateInDb(WfTicket ticket, bool triggerActions = true, + NotificationPlaceholderData? placeholderData = null) { try { @@ -413,7 +414,7 @@ public async Task UpdateTicketStateInDb(WfTicket ticket, bool triggerActions = t { if (triggerActions) { - await ActionHandler.DoStateChangeActions(ticket, WfObjectScopes.Ticket, null, ticket.Id, GetRequesterDn(ticket)); + await ActionHandler.DoStateChangeActions(ticket, WfObjectScopes.Ticket, null, ticket.Id, GetRequesterDn(ticket), placeholderData); } } } @@ -423,7 +424,8 @@ public async Task UpdateTicketStateInDb(WfTicket ticket, bool triggerActions = t } } - public async Task UpdateReqTaskStateInDb(WfReqTask reqtask, bool triggerActions = true) + public async Task UpdateReqTaskStateInDb(WfReqTask reqtask, bool triggerActions = true, + NotificationPlaceholderData? placeholderData = null) { try { @@ -446,7 +448,8 @@ public async Task UpdateReqTaskStateInDb(WfReqTask reqtask, bool triggerActions { if (triggerActions) { - await ActionHandler.DoStateChangeActions(reqtask, WfObjectScopes.RequestTask, reqtask.Owners.Count > 0 ? reqtask.Owners.First().Owner : null, reqtask.TicketId); + await ActionHandler.DoStateChangeActions(reqtask, WfObjectScopes.RequestTask, reqtask.Owners.Count > 0 ? reqtask.Owners.First().Owner : null, reqtask.TicketId, + placeholderData: placeholderData); } } } diff --git a/roles/lib/files/FWO.Services/Workflow/WfHandlerImplTasks.cs b/roles/lib/files/FWO.Services/Workflow/WfHandlerImplTasks.cs index 941363cd1b..bfe1ad8b66 100644 --- a/roles/lib/files/FWO.Services/Workflow/WfHandlerImplTasks.cs +++ b/roles/lib/files/FWO.Services/Workflow/WfHandlerImplTasks.cs @@ -331,7 +331,10 @@ private async Task> RequestTasksForInitialImplCreation(List LoadReqTaskDetailsForImplCreation(WfReqTask reqTask) { - if (reqTask.Elements.Count > 0 || reqTask.Id <= 0 || reqTask.TicketId <= 0 || dbAcc == null) + // Only access tasks need their elements reloaded. Generic tasks, including new-interface tasks, + // intentionally have no request elements and must keep the active ticket instance unchanged. + if (reqTask.TaskType != WfTaskType.access.ToString() + || reqTask.Elements.Count > 0 || reqTask.Id <= 0 || reqTask.TicketId <= 0 || dbAcc == null) { return reqTask; } diff --git a/roles/lib/files/FWO.Services/Workflow/WfHandlerStateChanges.cs b/roles/lib/files/FWO.Services/Workflow/WfHandlerStateChanges.cs index 4ff1b5fe58..185f52843f 100644 --- a/roles/lib/files/FWO.Services/Workflow/WfHandlerStateChanges.cs +++ b/roles/lib/files/FWO.Services/Workflow/WfHandlerStateChanges.cs @@ -101,8 +101,8 @@ public async Task PromoteImplTask(WfStatefulObject implTask, NotificationPlaceho } await UpdateActImplTaskState(placeholderData: placeholderData); ResetImplTaskList(); - await UpdateReqTaskStatesFromActImplTask(); - await UpdateActTicketStateFromReqTasks(); + await UpdateReqTaskStatesFromActImplTask(placeholderData: placeholderData); + await UpdateActTicketStateFromReqTasks(placeholderData: placeholderData); DisplayPromoteImplTaskMode = false; } catch (Exception exception) @@ -297,7 +297,8 @@ private static void AuditUnexpectedStateTransition(WfStatefulObject statefulObje // synchronization between the different objects - private async Task UpdateActTicketState(bool triggerActions = true, bool syncImplementationTasks = true) + private async Task UpdateActTicketState(bool triggerActions = true, bool syncImplementationTasks = true, + NotificationPlaceholderData? placeholderData = null) { if (ActTicket.StateId >= MasterStateMatrix.MinTicketCompleted) { @@ -310,7 +311,7 @@ private async Task UpdateActTicketState(bool triggerActions = true, bool syncImp if (dbAcc != null) { AuditUnexpectedStateTransition(ActTicket, WfObjectScopes.Ticket, MasterStateMatrix); - await dbAcc.UpdateTicketStateInDb(ActTicket, triggerActions); + await dbAcc.UpdateTicketStateInDb(ActTicket, triggerActions, placeholderData); } int idx = TicketList.FindIndex(x => x.Id == ActTicket.Id); if (idx >= 0) @@ -328,7 +329,8 @@ private void SyncActTicketFromReqTask(WfReqTask reqTask) } } - private async Task UpdateActTicketStateFromReqTasks(bool triggerActions = true, bool syncImplementationTasks = true) + private async Task UpdateActTicketStateFromReqTasks(bool triggerActions = true, bool syncImplementationTasks = true, + NotificationPlaceholderData? placeholderData = null) { if (ActTicket.Tasks.Count > 0) { @@ -341,7 +343,7 @@ private async Task UpdateActTicketStateFromReqTasks(bool triggerActions = true, Log.WriteDebug("UpdateActTicketStateFromReqTasks", $"Ticket {ActTicket.Id}: derived state {derivedState} from request task states {string.Join(", ", taskStates)}."); ActTicket.StateId = derivedState; } - await UpdateActTicketState(triggerActions, syncImplementationTasks); + await UpdateActTicketState(triggerActions, syncImplementationTasks, placeholderData); } public async Task UpdateActReqTaskState(bool triggerActions = true) @@ -406,7 +408,8 @@ private async Task UpdateReqTaskAndApprovalStatesFromTicket(WfReqTask reqTask, S } } - private async Task UpdateReqTaskStateFromImplTasks(WfReqTask reqTask, bool triggerActions = true) + private async Task UpdateReqTaskStateFromImplTasks(WfReqTask reqTask, bool triggerActions = true, + NotificationPlaceholderData? placeholderData = null) { if (reqTask.ImplementationTasks.Count > 0) { @@ -420,15 +423,16 @@ private async Task UpdateReqTaskStateFromImplTasks(WfReqTask reqTask, bool trigg if (dbAcc != null) { AuditUnexpectedStateTransition(reqTask, WfObjectScopes.RequestTask, stateMatrixDict.Matrices[reqTask.TaskType]); - await dbAcc.UpdateReqTaskStateInDb(reqTask, triggerActions); + await dbAcc.UpdateReqTaskStateInDb(reqTask, triggerActions, placeholderData); } SyncActTicketFromReqTask(reqTask); } - private async Task UpdateReqTaskStatesFromActImplTask(bool triggerActions = true) + private async Task UpdateReqTaskStatesFromActImplTask(bool triggerActions = true, + NotificationPlaceholderData? placeholderData = null) { SyncReqTaskStopTime(ActReqTask); - await UpdateReqTaskStateFromImplTasks(ActReqTask, triggerActions); + await UpdateReqTaskStateFromImplTasks(ActReqTask, triggerActions, placeholderData); List bundledTasks = [.. GetBundledRequestTasks(ActReqTask).Where(task => task.Id != ActReqTask.Id)]; foreach (WfReqTask bundledTask in bundledTasks) @@ -441,7 +445,7 @@ private async Task UpdateReqTaskStatesFromActImplTask(bool triggerActions = true if (dbAcc != null) { AuditUnexpectedStateTransition(bundledTask, WfObjectScopes.RequestTask, stateMatrixDict.Matrices[bundledTask.TaskType]); - await dbAcc.UpdateReqTaskStateInDb(bundledTask, triggerActions); + await dbAcc.UpdateReqTaskStateInDb(bundledTask, triggerActions, placeholderData); } SyncActTicketFromReqTask(bundledTask); } diff --git a/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs b/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs index e5aba1d88e..a52cd2b829 100644 --- a/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs +++ b/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs @@ -1073,6 +1073,20 @@ public void BuildWorkflowActionParameters_IncludesCreationStateChangeFlag() }); } + [Test] + public void BuildWorkflowActionParameters_PropagatesNotificationPlaceholderData() + { + ActionHandler handler = new(new ActionHandlerTestApiConn(), new WfHandler()); + WfImplTask implTask = new() { Id = 12, TicketId = 42, StateId = 5 }; + NotificationPlaceholderData placeholderData = new() { Content = "Rejected because the interface is obsolete." }; + + WorkflowActionParameters parameters = (WorkflowActionParameters)GetPrivateMethod("BuildWorkflowActionParameters") + .Invoke(handler, [implTask, WfObjectScopes.ImplementationTask, null, 66, placeholderData])!; + + Assert.That(parameters.NotificationPlaceholders, Is.SameAs(placeholderData)); + Assert.That(parameters.NotificationPlaceholders!.Content, Is.EqualTo("Rejected because the interface is obsolete.")); + } + [Test] public void BuildWorkflowActionParameters_UsesScopeSpecificIds() { diff --git a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs index 42581edbae..94c121f963 100644 --- a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs +++ b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs @@ -322,6 +322,29 @@ public async Task SendWorkflowActionEmail_UsesWorkflowRecipientsAndPlaceholderOb }); } + [Test] + public async Task SendWorkflowActionEmail_UsesCallerContentForContentPlaceholder() + { + CapturingEmailHelper helper = new(new SimulatedUserConfig()); + FwoNotification notification = new() + { + RecipientTo = EmailRecipientOption.OtherAddresses, + EmailAddressTo = "owner@example.test", + EmailBody = $"Reject reason: {Placeholder.CONTENT}" + }; + WorkflowEmailContent workflowContent = new() + { + PlainText = "workflow content", + Html = "

      workflow content

      " + }; + NotificationPlaceholderData placeholderData = new() { Content = "not approved" }; + + await helper.SendWorkflowActionEmail(notification, new WfStatefulObject(), null, + workflowContent: workflowContent, placeholderData: placeholderData); + + Assert.That(helper.CapturedBody, Is.EqualTo("Reject reason: not approved")); + } + [Test] public async Task GetRecipientsReturnsDummyForOtherAddressesOption() { diff --git a/roles/tests-unit/files/FWO.Test/MailerMailKitTest.cs b/roles/tests-unit/files/FWO.Test/MailerMailKitTest.cs new file mode 100644 index 0000000000..8c2f21aa90 --- /dev/null +++ b/roles/tests-unit/files/FWO.Test/MailerMailKitTest.cs @@ -0,0 +1,261 @@ +using FWO.Mail; +using Microsoft.AspNetCore.Http; +using MimeKit; +using NUnit.Framework; +using System.Reflection; +using System.Text; + +namespace FWO.Test +{ + [TestFixture] + internal class MailerMailKitTest + { + [Test] + public void MailData_InitializesRecipientsAndSubject() + { + List recipients = new() { "to@example.test" }; + + MailData mail = new(recipients, "Subject") + { + Body = "Body" + }; + + Assert.Multiple(() => + { + Assert.That(mail.To, Is.SameAs(recipients)); + Assert.That(mail.Cc, Is.Empty); + Assert.That(mail.Bcc, Is.Empty); + Assert.That(mail.Subject, Is.EqualTo("Subject")); + Assert.That(mail.Body, Is.EqualTo("Body")); + }); + } + + [Test] + public void CopyMailData_CopiesCollectionsWithoutSharingThem() + { + MailData source = new(new List { "to@example.test" }, "Subject") + { + Cc = new List { "cc@example.test" }, + Bcc = new List { "bcc@example.test" }, + From = "from@example.test", + DisplayName = "Sender", + ReplyTo = "reply@example.test", + ReplyToName = "Reply", + Body = "Body" + }; + + MailData copy = Invoke("CopyMailData", source); + + Assert.Multiple(() => + { + Assert.That(copy.To, Is.EqualTo(source.To)); + Assert.That(copy.Cc, Is.EqualTo(source.Cc)); + Assert.That(copy.Bcc, Is.EqualTo(source.Bcc)); + Assert.That(copy.To, Is.Not.SameAs(source.To)); + Assert.That(copy.Cc, Is.Not.SameAs(source.Cc)); + Assert.That(copy.Bcc, Is.Not.SameAs(source.Bcc)); + Assert.That(copy.From, Is.EqualTo(source.From)); + Assert.That(copy.DisplayName, Is.EqualTo(source.DisplayName)); + Assert.That(copy.ReplyTo, Is.EqualTo(source.ReplyTo)); + Assert.That(copy.ReplyToName, Is.EqualTo(source.ReplyToName)); + Assert.That(copy.Body, Is.EqualTo(source.Body)); + }); + } + + [TestCase(false)] + [TestCase(true)] + public void HasRecipients_RecognizesPresentAddresses(bool present) + { + MailData mail = new(new List { present ? "to@example.test" : " " }, "Subject") + { + Cc = new List { present ? "cc@example.test" : " " } + }; + + bool result = Invoke("HasRecipients", mail); + + Assert.That(result, Is.EqualTo(present)); + } + + [Test] + public void RemoveRecipient_RemovesMatchingAddressFromAnyRecipientList() + { + MailData mail = new(new List { "to@example.test" }, "Subject") + { + Cc = new List { " CC@example.test " }, + Bcc = new List { "bcc@example.test" } + }; + + bool removed = Invoke("RemoveRecipient", mail, "cc@example.test"); + + Assert.Multiple(() => + { + Assert.That(removed, Is.True); + Assert.That(mail.Cc, Is.Empty); + Assert.That(mail.To, Is.EqualTo(new List { "to@example.test" })); + Assert.That(mail.Bcc, Is.EqualTo(new List { "bcc@example.test" })); + }); + } + + [Test] + public void RemoveRecipient_ReturnsFalseWhenAddressIsUnknown() + { + MailData mail = new(new List { "to@example.test" }, "Subject"); + + bool removed = Invoke("RemoveRecipient", mail, "missing@example.test"); + + Assert.That(removed, Is.False); + } + + [Test] + public void RemoveRecipient_SearchesToAndBccAfterEarlierLists() + { + MailData mail = new(new List { "to@example.test" }, "Subject") + { + Cc = new List { "cc@example.test" }, + Bcc = new List { "bcc@example.test" } + }; + + bool removedTo = Invoke("RemoveRecipient", mail, "to@example.test"); + bool removedBcc = Invoke("RemoveRecipient", mail, "bcc@example.test"); + + Assert.Multiple(() => + { + Assert.That(removedTo, Is.True); + Assert.That(removedBcc, Is.True); + Assert.That(mail.To, Is.Empty); + Assert.That(mail.Bcc, Is.Empty); + }); + } + + [Test] + public void AddRecipients_AddsSenderRecipientsAndReplyTo() + { + MailData mail = new(new List { "to@example.test", " " }, "Subject") + { + Cc = new List { "cc@example.test" }, + Bcc = new List { " bcc@example.test " }, + ReplyTo = "reply@example.test", + ReplyToName = "Reply" + }; + EmailConnection connection = new() { SenderEmailAddress = "sender@example.test" }; + MimeMessage message = new(); + + Invoke("AddRecipients", connection, mail, message); + + Assert.Multiple(() => + { + Assert.That(message.From.Mailboxes.Single().Address, Is.EqualTo("sender@example.test")); + Assert.That(message.Sender?.Address, Is.EqualTo("sender@example.test")); + Assert.That(message.To.Mailboxes.Select(x => x.Address), Is.EqualTo(new List { "to@example.test" })); + Assert.That(message.Cc.Mailboxes.Single().Address, Is.EqualTo("cc@example.test")); + Assert.That(message.Bcc.Mailboxes.Single().Address, Is.EqualTo("bcc@example.test")); + Assert.That(message.ReplyTo.Mailboxes.Single().Address, Is.EqualTo("reply@example.test")); + Assert.That(message.ReplyTo.Mailboxes.Single().Name, Is.EqualTo("Reply")); + }); + } + + [Test] + public async Task AddContent_CreatesPlainTextBodyAndAttachments() + { + FormFile attachment = CreateFile("attachment.txt", "text/plain", "attachment"); + MailData mail = new(new List(), "Subject") + { + Body = "Plain body", + Attachments = new FormFileCollection { attachment } + }; + MimeMessage message = new(); + + await InvokeAsync("AddContent", mail, message, false); + + MimePart attachmentPart = (MimePart)message.Attachments.Single(); + Assert.Multiple(() => + { + Assert.That(message.Subject, Is.EqualTo("Subject")); + Assert.That(message.TextBody, Is.EqualTo("Plain body")); + Assert.That(attachmentPart.FileName, Is.EqualTo("attachment.txt")); + Assert.That(attachmentPart.ContentType.MimeType, Is.EqualTo("text/plain")); + }); + } + + [Test] + public async Task AddContent_SkipsEmptyAttachments() + { + FormFile attachment = CreateFile("empty.txt", "text/plain", ""); + MailData mail = new(new List(), "Subject") + { + Body = "Plain body", + Attachments = new FormFileCollection { attachment } + }; + MimeMessage message = new(); + + await InvokeAsync("AddContent", mail, message, false); + + Assert.That(message.Attachments, Is.Empty); + } + + [Test] + public async Task AddContent_CreatesHtmlBodyWithoutAttachments() + { + MailData mail = new(new List(), "Subject") { Body = "

      HTML body

      " }; + MimeMessage message = new(); + + await InvokeAsync("AddContent", mail, message, true); + + Assert.Multiple(() => + { + Assert.That(message.HtmlBody, Is.EqualTo("

      HTML body

      ")); + Assert.That(message.TextBody, Is.Null); + }); + } + + [TestCase(EmailEncryptionMethod.None)] + [TestCase(EmailEncryptionMethod.StartTls)] + [TestCase(EmailEncryptionMethod.Tls)] + public async Task SendAsync_ReturnsFalseWhenConnectionFails(EmailEncryptionMethod encryption) + { + MailData mail = new(new List { "to@example.test" }, "Subject"); + EmailConnection connection = new("127.0.0.1", 1, encryption, "", "", "sender@example.test"); + + bool result = await MailKitMailer.SendAsync(mail, connection); + + Assert.That(result, Is.False); + } + + private static FormFile CreateFile(string fileName, string contentType, string content) + { + byte[] bytes = Encoding.UTF8.GetBytes(content); + MemoryStream stream = new(bytes); + return new FormFile(stream, 0, bytes.Length, "file", fileName) + { + Headers = new HeaderDictionary(), + ContentType = contentType + }; + } + + private static MethodInfo GetPrivateMethod(string name, object?[] arguments) + { + return typeof(MailKitMailer).GetMethods(BindingFlags.NonPublic | BindingFlags.Static) + .Single(method => method.Name == name + && method.GetParameters().Length == arguments.Length + && method.GetParameters().Select((parameter, index) => parameter.ParameterType.IsInstanceOfType(arguments[index])).All(result => result)) + ?? throw new MissingMethodException(typeof(MailKitMailer).FullName, name); + } + + private static T Invoke(string name, params object?[] arguments) + { + return (T)(GetPrivateMethod(name, arguments).Invoke(null, arguments) + ?? throw new InvalidOperationException($"Private method '{name}' returned null.")); + } + + private static void Invoke(string name, params object?[] arguments) + { + GetPrivateMethod(name, arguments).Invoke(null, arguments); + } + + private static async Task InvokeAsync(string name, params object?[] arguments) + { + await (Task)(GetPrivateMethod(name, arguments).Invoke(null, arguments) + ?? throw new InvalidOperationException($"Private method '{name}' returned null.")); + } + } +} diff --git a/roles/tests-unit/files/FWO.Test/NotificationTest.cs b/roles/tests-unit/files/FWO.Test/NotificationTest.cs index 0002b36f8c..17922ec979 100644 --- a/roles/tests-unit/files/FWO.Test/NotificationTest.cs +++ b/roles/tests-unit/files/FWO.Test/NotificationTest.cs @@ -912,12 +912,15 @@ private static async Task CaptureConsoleAsync(Func action) { TextWriter originalOut = Console.Out; StringWriter writer = new(); - Console.SetOut(writer); + Console.SetOut(TextWriter.Synchronized(writer)); try { await action(); await writer.FlushAsync(); - return writer.ToString(); + lock (writer) + { + return writer.ToString(); + } } finally { diff --git a/roles/tests-unit/files/FWO.Test/StateMatrixTest.cs b/roles/tests-unit/files/FWO.Test/StateMatrixTest.cs index e26af5d3fe..362a032ffc 100644 --- a/roles/tests-unit/files/FWO.Test/StateMatrixTest.cs +++ b/roles/tests-unit/files/FWO.Test/StateMatrixTest.cs @@ -117,6 +117,29 @@ public async Task GlobalStateMatrixInitNamedConfiguration_UsesNamedConfiguration }); } + [Test] + public async Task StateMatrixInit_UsesLastActiveWorkflowPhaseRegardlessOfDatabaseOrder() + { + GlobalStateMatrix source = new() + { + GlobalMatrix = Enum.GetValues().ToDictionary(phase => phase, phase => new StateMatrix + { + LowestInputState = (int)phase, + LowestStartedState = (int)phase + 1, + LowestEndState = (int)phase + 10, + Active = phase is WorkflowPhases.request or WorkflowPhases.implementation or WorkflowPhases.review + }) + }; + List configurations = StateMatrixConfigurationTestHelper.FromGlobalMatrix(source); + configurations[0].Phases.Reverse(); + StateMatrixApiConnection apiConnection = new(configurations); + StateMatrix matrix = new(); + + await matrix.Init(WorkflowPhases.request, apiConnection, new List(), WfTaskType.new_interface); + + Assert.That(matrix.MinTicketCompleted, Is.EqualTo(15)); + } + [Test] public async Task GlobalStateMatrixSave_WritesOnlyNonIdentityDerivedStates() { diff --git a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs index 7d3822f1e6..2831960e02 100644 --- a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs @@ -370,7 +370,7 @@ public void RejectInterfacePopup_BuildsNotificationContextWithRejectReason() Assert.That(data.InterfaceName, Is.EqualTo("iface21")); Assert.That(data.RequestingAppName, Is.EqualTo("Requesting App")); Assert.That(data.RequestingAppId, Is.EqualTo("REQ-APP")); - Assert.That(data.Reason, Is.EqualTo("not approved")); + Assert.That(data.Content, Is.EqualTo("not approved")); Assert.That(data.RequestDate, Is.EqualTo("02.01.2025")); Assert.That(data.InterfaceLinkUrl, Is.EqualTo("https://fwo.example/networkmodelling/OWNER-APP/21")); }); diff --git a/roles/tests-unit/files/FWO.Test/WfHandlerImplTasksTest.cs b/roles/tests-unit/files/FWO.Test/WfHandlerImplTasksTest.cs index f26834a586..e76c37b7dc 100644 --- a/roles/tests-unit/files/FWO.Test/WfHandlerImplTasksTest.cs +++ b/roles/tests-unit/files/FWO.Test/WfHandlerImplTasksTest.cs @@ -613,6 +613,25 @@ public async Task RequestTasksForInitialImplCreation_SkipsAccessTasksWithoutElem Assert.That(requestTasks, Is.Empty); } + [Test] + public async Task RequestTasksForInitialImplCreation_DoesNotReloadNewInterfaceTasksWithoutElements() + { + WfReqTask newInterfaceTask = new() + { + Id = 11, + TicketId = 7, + TaskType = WfTaskType.new_interface.ToString() + }; + WfHandler handler = CreateBundlingHandler(considerBundling: false, newInterfaceTask); + SetDbAccess(handler, new RequestTaskDetailsApiConn(new WfTicket { Id = 7 })); + + List requestTasks = await InvokeRequestTasksForInitialImplCreation(handler, + new List { newInterfaceTask }); + + Assert.That(requestTasks, Has.Count.EqualTo(1)); + Assert.That(requestTasks[0], Is.SameAs(newInterfaceTask)); + } + private static async Task InvokeAutoCreateImplTasks(WfHandler handler, WfReqTask reqTask) { MethodInfo method = typeof(WfHandler).GetMethod("AutoCreateImplTasks", BindingFlags.Instance | BindingFlags.NonPublic) diff --git a/roles/tests-unit/files/FWO.Test/WfHandlerStateChangesTest.cs b/roles/tests-unit/files/FWO.Test/WfHandlerStateChangesTest.cs index bcb8053f85..e13ddb6948 100644 --- a/roles/tests-unit/files/FWO.Test/WfHandlerStateChangesTest.cs +++ b/roles/tests-unit/files/FWO.Test/WfHandlerStateChangesTest.cs @@ -607,7 +607,7 @@ public async Task UpdateActTicketStateFromReqTasks_CanDowngradeTicketFromRequest }; MethodInfo? method = typeof(WfHandler).GetMethod("UpdateActTicketStateFromReqTasks", BindingFlags.NonPublic | BindingFlags.Instance); - await (Task)(method?.Invoke(handler, [true, true]) ?? throw new InvalidOperationException("Method not found.")); + await (Task)(method?.Invoke(handler, [true, true, null]) ?? throw new InvalidOperationException("Method not found.")); Assert.That(handler.ActTicket.StateId, Is.EqualTo(1)); } diff --git a/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor b/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor index fccac58192..6532321930 100644 --- a/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor +++ b/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor @@ -96,6 +96,8 @@ WorkInProgress = true; try { + await ConnHandler.RefreshActConn(); + long? ticketId = ConnHandler.ActConn.TicketId; ConnHandler.ActConn.AddProperty(ConState.Rejected.ToString()); bool saved = AllowAdminReject ? await ConnHandler.SavePropertiesOnly() @@ -105,7 +107,7 @@ return; } await ConnHandler.RemoveFromAllSelections(); - await RejectInTicket(); + await RejectInTicket(ticketId); await RefreshParent(); Close(); } @@ -120,12 +122,12 @@ } } - private async Task RejectInTicket() + private async Task RejectInTicket(long? ticketId) { - if(ConnHandler != null && ConnHandler.ActConn.TicketId != null) + if(ConnHandler != null && ticketId != null) { TicketCreator ticketCreator = new(apiConnection, userConfig, authenticationStateTask!.Result.User, middlewareClient, WorkflowPhases.implementation, new ComplianceRequestedRulePolicyChecker(userConfig, apiConnection, middlewareClient)); - if(await ticketCreator.PromoteNewInterfaceImplTask((long)ConnHandler.ActConn.TicketId, ExtStates.Rejected, Reason, + if(await ticketCreator.PromoteNewInterfaceImplTask(ticketId.Value, ExtStates.Rejected, Reason, BuildNotificationPlaceholderData())) { DisplayMessageInUi(null, userConfig.GetText("reject_interface"), userConfig.GetText("U9018"), false); @@ -136,19 +138,19 @@ private NotificationPlaceholderData BuildNotificationPlaceholderData() { string interfaceName = ConnHandler?.ActConn.Name ?? ""; - string interfaceUrl = ConnHandler == null + string interfaceUrl = ConnHandler?.Application == null ? "" : $"{userConfig.UiHostName}/{PageName.Modelling}/{ConnHandler.Application.ExtAppId}/{ConnHandler.ActConn.Id}"; return new NotificationPlaceholderData { - RequestingAppName = ConnHandler?.ActConn.App.Name ?? "", - RequestingAppId = ConnHandler?.ActConn.App.ExtAppId ?? "", + RequestingAppName = ConnHandler?.ActConn.App?.Name ?? "", + RequestingAppId = ConnHandler?.ActConn.App?.ExtAppId ?? "", InterfaceName = interfaceName, InterfaceLinkText = userConfig.GetText("interface"), InterfaceLinkName = interfaceName, InterfaceLinkUrl = interfaceUrl, - Reason = Reason, - UserName = userConfig.User.Name, + Content = Reason, + UserName = userConfig.User?.Name ?? "", RequestDate = ConnHandler?.ActConn.CreationDate?.ToString("dd.MM.yyyy") ?? "" }; } From c1bd7235e7acff2b0dbdf7426065de358018fb02 Mon Sep 17 00:00:00 2001 From: abarz722 Date: Mon, 7 Sep 2026 19:12:12 +0200 Subject: [PATCH 11/48] enhance notification log by deadline --- roles/api/files/replace_metadata.json | 20 ++++++++++++++----- .../monitor/getNotificationLogEntrys.graphql | 2 ++ .../creation/fworch-create-tables-base.sql | 4 +++- .../files/sql/idempotent/fworch-texts.sql | 2 ++ roles/database/files/upgrade/9.5.5.sql | 4 +++- .../files/FWO.Data/NotificationLogEntry.cs | 6 ++++++ .../NotificationLogHelper.cs | 8 ++++++-- .../NotificationService.cs | 15 +++++++++----- .../FWO.Test/EmailHelperRecipientTest.cs | 8 ++++++-- .../Pages/Monitoring/MonitorEmailLog.razor | 2 ++ 10 files changed, 55 insertions(+), 16 deletions(-) diff --git a/roles/api/files/replace_metadata.json b/roles/api/files/replace_metadata.json index 3090a07ca1..3194b4cb51 100644 --- a/roles/api/files/replace_metadata.json +++ b/roles/api/files/replace_metadata.json @@ -13537,7 +13537,9 @@ "to", "cc", "bcc", - "subject" + "subject", + "deadline_type", + "deadline" ] }, "comment": "" @@ -13553,7 +13555,9 @@ "to", "cc", "bcc", - "subject" + "subject", + "deadline_type", + "deadline" ] }, "comment": "" @@ -13569,7 +13573,9 @@ "to", "cc", "bcc", - "subject" + "subject", + "deadline_type", + "deadline" ] }, "comment": "" @@ -13586,7 +13592,9 @@ "to", "cc", "bcc", - "subject" + "subject", + "deadline_type", + "deadline" ], "filter": {} }, @@ -13602,7 +13610,9 @@ "to", "cc", "bcc", - "subject" + "subject", + "deadline_type", + "deadline" ], "filter": {} }, diff --git a/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql b/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql index 57393b05f9..5ebba9939e 100644 --- a/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql +++ b/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql @@ -7,5 +7,7 @@ query getNotificationLogEntrys { cc bcc subject + deadline_type + deadline } } diff --git a/roles/database/files/sql/creation/fworch-create-tables-base.sql b/roles/database/files/sql/creation/fworch-create-tables-base.sql index fc207060ac..9df3ac46d7 100755 --- a/roles/database/files/sql/creation/fworch-create-tables-base.sql +++ b/roles/database/files/sql/creation/fworch-create-tables-base.sql @@ -348,7 +348,9 @@ create table notification_log "to" Varchar NOT NULL DEFAULT '', cc Varchar NOT NULL DEFAULT '', bcc Varchar NOT NULL DEFAULT '', - subject Varchar NOT NULL DEFAULT '' + subject Varchar NOT NULL DEFAULT '', + deadline_type Varchar NOT NULL DEFAULT 'None', + deadline TIMESTAMP WITH TIME ZONE ); -- configuration diff --git a/roles/database/files/sql/idempotent/fworch-texts.sql b/roles/database/files/sql/idempotent/fworch-texts.sql index 5f84d80d89..0a14e76358 100644 --- a/roles/database/files/sql/idempotent/fworch-texts.sql +++ b/roles/database/files/sql/idempotent/fworch-texts.sql @@ -1222,6 +1222,8 @@ INSERT INTO txt VALUES ('opened', 'German', 'Geöffnet'); INSERT INTO txt VALUES ('opened', 'English', 'Opened'); INSERT INTO txt VALUES ('deadline', 'German', 'Deadline'); INSERT INTO txt VALUES ('deadline', 'English', 'Deadline'); +INSERT INTO txt VALUES ('deadline_type', 'German', 'Deadline-Typ'); +INSERT INTO txt VALUES ('deadline_type', 'English', 'Deadline type'); INSERT INTO txt VALUES ('assign1', 'German', 'Zuweisen'); INSERT INTO txt VALUES ('assign1', 'English', 'Assign'); INSERT INTO txt VALUES ('assign_to', 'German', 'Weiterleiten an'); diff --git a/roles/database/files/upgrade/9.5.5.sql b/roles/database/files/upgrade/9.5.5.sql index 119e5ff6e7..78b4983898 100644 --- a/roles/database/files/upgrade/9.5.5.sql +++ b/roles/database/files/upgrade/9.5.5.sql @@ -126,7 +126,9 @@ CREATE TABLE IF NOT EXISTS notification_log "to" Varchar NOT NULL DEFAULT '', cc Varchar NOT NULL DEFAULT '', bcc Varchar NOT NULL DEFAULT '', - subject Varchar NOT NULL DEFAULT '' + subject Varchar NOT NULL DEFAULT '', + deadline_type Varchar NOT NULL DEFAULT 'None', + deadline TIMESTAMP WITH TIME ZONE ); WITH decomm_config AS diff --git a/roles/lib/files/FWO.Data/NotificationLogEntry.cs b/roles/lib/files/FWO.Data/NotificationLogEntry.cs index d905b1d76f..72d2e17b8a 100644 --- a/roles/lib/files/FWO.Data/NotificationLogEntry.cs +++ b/roles/lib/files/FWO.Data/NotificationLogEntry.cs @@ -28,5 +28,11 @@ public class NotificationLogEntry [JsonProperty("subject"), JsonPropertyName("subject")] public string Subject { get; set; } = ""; + + [JsonProperty("deadline_type"), JsonPropertyName("deadline_type")] + public NotificationDeadline DeadlineType { get; set; } = NotificationDeadline.None; + + [JsonProperty("deadline"), JsonPropertyName("deadline")] + public DateTimeOffset? Deadline { get; set; } } } diff --git a/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs index 206f70f6ca..25282d8cb8 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs @@ -18,8 +18,10 @@ public static class NotificationLogHelper /// Resolved Cc recipients. /// Resolved Bcc recipients. /// Rendered subject. + /// Resolved deadline timestamp. public static async Task InsertAsync(ApiConnection apiConnection, FwoNotification notification, - IEnumerable tos, IEnumerable? ccs, IEnumerable? bccs, string subject) + IEnumerable tos, IEnumerable? ccs, IEnumerable? bccs, string subject, + DateTimeOffset? deadline = null) { NotificationLogEntry entry = new() { @@ -29,7 +31,9 @@ public static async Task InsertAsync(ApiConnection apiConnection, FwoNotificatio To = string.Join(", ", tos), Cc = string.Join(", ", ccs ?? []), Bcc = string.Join(", ", bccs ?? []), - Subject = subject + Subject = subject, + DeadlineType = notification.Deadline, + Deadline = deadline }; await apiConnection.SendQueryAsync(NotificationQueries.insertNotificationLog, diff --git a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs index 13cfe7d5b3..6077716b4e 100644 --- a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs +++ b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs @@ -117,11 +117,13 @@ public async Task SendNotificationsIfDue(FwoOwner? owner, DateTime? extDead /// Text for notification (e.g. email body). /// Optional report to be sent as attachment. /// Optional resolved time interval text for placeholder replacement. + /// Resolved deadline timestamp used for notification logging. /// number of emails sent - public async Task SendNotification(FwoNotification notification, FwoOwner? owner, string? content = null, ReportBase? report = null, string timeIntervalText = "") + public async Task SendNotification(FwoNotification notification, FwoOwner? owner, string? content = null, ReportBase? report = null, + string timeIntervalText = "", DateTime? resolvedDeadline = null) { // Later: Handle other channels here when implemented - bool sent = await SendEmail(notification, content, owner, report, timeIntervalText); + bool sent = await SendEmail(notification, content, owner, report, timeIntervalText, resolvedDeadline); if (!sent) { return 0; @@ -185,7 +187,7 @@ public async Task SendNotificationIfDue(FwoNotification notification, FwoOw { if (IsNotificationDue(owner, extDeadline, notification)) { - return await SendNotification(notification, owner, content, report, timeIntervalText); + return await SendNotification(notification, owner, content, report, timeIntervalText, extDeadline); } return 0; } @@ -297,8 +299,10 @@ private static async Task> LoadOwnerGroups(List? connected /// Owner context used for placeholder replacement. /// Optional report attachment. /// Optional resolved time interval text. + /// Resolved deadline timestamp used for notification logging. /// True when an email was sent; otherwise false. - private async Task SendEmail(FwoNotification notification, string? content, FwoOwner? owner, ReportBase? report = null, string timeIntervalText = "") + private async Task SendEmail(FwoNotification notification, string? content, FwoOwner? owner, ReportBase? report = null, + string timeIntervalText = "", DateTime? resolvedDeadline = null) { MailData? mail = await PrepareEmail(notification, content, owner, report, timeIntervalText); if (mail.To.Count == 0 && mail.Cc.Count == 0 && mail.Bcc.Count == 0) @@ -310,7 +314,8 @@ private async Task SendEmail(FwoNotification notification, string? content if (NotificationLoggingMode.ShouldLog(notification.Logging)) { - await NotificationLogHelper.InsertAsync(ApiConnection, notification, mail.To, mail.Cc, mail.Bcc, mail.Subject); + DateTimeOffset? deadline = resolvedDeadline.HasValue ? new DateTimeOffset(resolvedDeadline.Value) : null; + await NotificationLogHelper.InsertAsync(ApiConnection, notification, mail.To, mail.Cc, mail.Bcc, mail.Subject, deadline); } if (!NotificationLoggingMode.ShouldSend(notification.Logging)) diff --git a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs index 94c121f963..5865e7deb2 100644 --- a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs +++ b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs @@ -103,7 +103,8 @@ public async Task SendEmailToNotificationRecipients_UsesNotificationRecipientsAn RecipientBcc = EmailRecipientOption.OtherAddresses, EmailAddressBcc = "bcc@example.test", EmailSubject = "Subject", - EmailBody = "Body" + EmailBody = "Body", + Deadline = NotificationDeadline.RequestDate }; bool sent = await helper.SendEmailToNotificationRecipients(notification, owner, "Rendered subject", "Rendered body"); @@ -187,7 +188,8 @@ public async Task SendEmailToNotificationRecipients_SendAndLog_WritesNotificatio RecipientBcc = EmailRecipientOption.OtherAddresses, EmailAddressBcc = "bcc@example.test", EmailSubject = "Subject", - EmailBody = "Body" + EmailBody = "Body", + Deadline = NotificationDeadline.RequestDate }; bool sent = await helper.SendEmailToNotificationRecipients(notification, null, "Rendered subject", "Rendered body"); @@ -203,6 +205,8 @@ public async Task SendEmailToNotificationRecipients_SendAndLog_WritesNotificatio Assert.That(apiConnection.InsertCalls[0].Cc, Is.EqualTo("cc@example.test")); Assert.That(apiConnection.InsertCalls[0].Bcc, Is.EqualTo("bcc@example.test")); Assert.That(apiConnection.InsertCalls[0].Subject, Is.EqualTo("Rendered subject")); + Assert.That(apiConnection.InsertCalls[0].DeadlineType, Is.EqualTo(NotificationDeadline.RequestDate)); + Assert.That(apiConnection.InsertCalls[0].Deadline, Is.Null); Assert.That(apiConnection.InsertCalls[0].Timestamp, Is.GreaterThan(DateTimeOffset.UtcNow.AddMinutes(-1))); }); } diff --git a/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor b/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor index f30deaac84..e0dbff7eb7 100644 --- a/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor +++ b/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor @@ -19,6 +19,8 @@ + + From 6b4960a403797946c9b246aed0a8a9960bb007f3 Mon Sep 17 00:00:00 2001 From: abarz722 Date: Mon, 7 Sep 2026 20:48:22 +0200 Subject: [PATCH 12/48] some more tests --- .../files/FWO.Test/ActionHandlerTest.cs | 61 ++++ ...lingConnectionHandlerInterfHandlingTest.cs | 136 +++++++++ .../files/FWO.Test/UiEditNotificationsTest.cs | 271 ++++++++++++++++++ .../files/FWO.Test/UiMonitoringLayoutTest.cs | 129 +++++++++ .../FWO.Test/UiRequestAndRejectPopupTest.cs | 108 +++++++ .../UiSettingsModellingNotificationsTest.cs | 2 +- .../SettingsModellingNotifications.razor | 7 +- 7 files changed, 707 insertions(+), 7 deletions(-) create mode 100644 roles/tests-unit/files/FWO.Test/UiMonitoringLayoutTest.cs diff --git a/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs b/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs index a52cd2b829..9a09e48598 100644 --- a/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs +++ b/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs @@ -126,6 +126,18 @@ public override Task SendQueryAsync(string query, object? variables = null UpdatedNotificationLastSentIds = GetVariable>(variables, "ids"); return Task.FromResult((T)(object)new ReturnId { AffectedRows = UpdateNotificationsLastSentAffectedRows }); } + if (query == NotificationQueries.insertNotificationLog) + { + return Task.FromResult((T)(object)new object()); + } + if (query == OwnerQueries.getOwnerResponsibleTypes) + { + return Task.FromResult((T)(object)new List()); + } + if (query == AuthQueries.getUserEmails) + { + return Task.FromResult((T)(object)new List()); + } if (query == RequestQueries.updateTicketState || query == RequestQueries.updateRequestTaskState) { long id = GetVariable(variables, "id"); @@ -752,6 +764,55 @@ public async Task SendEmail_DisplaysError_WhenReferencedNotificationIsMissingAnd }); } + [Test] + public async Task SendEmail_LogsConfiguredNotificationsUpdatesTimestampAndConfirmsSend() + { + ActionHandlerTestApiConn apiConn = new() + { + Notifications = new List + { + new FwoNotification + { + Id = 42, + NotificationClient = NotificationClient.WfAction, + RecipientTo = EmailRecipientOption.OtherAddresses, + EmailAddressTo = "recipient@example.test", + EmailSubject = "Interface requested", + EmailBody = "The interface was requested.", + Logging = NotificationLoggingMode.LogOnly + } + }, + UpdateNotificationsLastSentAffectedRows = 1 + }; + List<(Exception? Exception, string Title, string Message, bool ErrorFlag)> messages = new(); + WfHandler wfHandler = new(new SimulatedUserConfig(), apiConn, WorkflowPhases.request, null, + displayMessage: (exception, title, message, errorFlag) => messages.Add((exception, title, message, errorFlag))); + ActionHandler handler = new(apiConn, wfHandler, useInMwServer: true); + WfStateAction action = new() + { + ExternalParams = JsonSerializer.Serialize(new EmailActionParams + { + NotificationIds = new List { 42 }, + ConfirmSentMail = true, + AttachedContent = EmailAttachedContent.RequestedConnections + }) + }; + + await handler.SendEmail(action, new WfTicket(), WfObjectScopes.Ticket, null); + + Assert.Multiple(() => + { + Assert.That(apiConn.Queries.Count(query => query == NotificationQueries.getNotifications), Is.EqualTo(1)); + Assert.That(apiConn.Queries.Count(query => query == NotificationQueries.insertNotificationLog), Is.EqualTo(1)); + Assert.That(apiConn.Queries.Count(query => query == StmQueries.getIpProtocols), Is.EqualTo(1)); + Assert.That(apiConn.UpdatedNotificationLastSentIds, Is.EqualTo(new List { 42 })); + Assert.That(messages, Has.Count.EqualTo(1)); + Assert.That(messages[0].Exception, Is.Null); + Assert.That(messages[0].Message, Is.EqualTo("1 emails sent")); + Assert.That(messages[0].ErrorFlag, Is.False); + }); + } + [Test] public void DisplaySentEmailConfirmation_SuppressesZeroSentEmails() { diff --git a/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerInterfHandlingTest.cs b/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerInterfHandlingTest.cs index 91ba214906..489b574700 100644 --- a/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerInterfHandlingTest.cs +++ b/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerInterfHandlingTest.cs @@ -1,11 +1,13 @@ using NUnit.Framework; using NUnit.Framework.Legacy; +using FWO.Api.Client.Queries; using FWO.Data; using FWO.Data.Modelling; using FWO.Services; using FWO.Services.Modelling; using FWO.Basics; using System.Collections.Generic; +using System.Reflection; namespace FWO.Test { @@ -324,6 +326,108 @@ public async Task RequestReplaceInterface_MismatchShowsErrorAndDoesNotEnableRepl ClassicAssert.IsNull(handler.IntConnHandler); } + [Test] + public void CreateDecommissionPlaceholderValues_UsesInterfaceAndReplacementData() + { + ModellingConnection connection = new() { Id = 20, Name = "OldInterface" }; + ModellingConnection proposedInterface = new() + { + Id = 21, + App = new FwoOwner { ExtAppId = "APP-2" }, + Name = "NewInterface" + }; + ModellingConnectionHandler handler = CreateHandler(connection); + + NotificationPlaceholderResolver.NotificationPlaceholderValues values = (NotificationPlaceholderResolver.NotificationPlaceholderValues) + GetPrivateMethod("CreateDecommissionPlaceholderValues").Invoke(handler, [Application, "Reason", proposedInterface])!; + + Assert.Multiple(() => + { + Assert.That(values.Application, Is.SameAs(Application)); + Assert.That(values.InterfaceName, Is.EqualTo("OldInterface")); + Assert.That(values.NewInterfaceName, Is.EqualTo("NewInterface")); + Assert.That(values.Reason, Is.EqualTo("Reason")); + Assert.That(values.NewInterfaceLinkUrl, Does.Contain("APP-2/21")); + }); + } + + [Test] + public async Task ReplaceLinks_DoesNothingWhenInterfaceIsNotUsed() + { + ModellingConnectionHandler handler = CreateHandler(new ModellingConnection { Id = 22 }); + + await InvokeAsync(handler, "ReplaceLinks"); + + Assert.That(handler.UsingConnections, Is.Empty); + } + + [Test] + public async Task ReplaceInterface_DoesNothingWhenReplacementHandlerIsMissing() + { + ModellingConnectionHandler handler = CreateHandler(new ModellingConnection { Id = 30 }); + + await handler.ReplaceInterface(null!, null!); + + Assert.That(handler.ReplaceMode, Is.False); + } + + [Test] + public async Task DeleteRequestedInterface_ReturnsFalseWhenInterfaceIsUsed() + { + ModellingConnectionHandler handler = CreateHandler(new ModellingConnection { Id = 23 }); + handler.UsingConnections.Add(new ModellingConnection { Id = 24 }); + + bool deleted = await InvokeAsync(handler, "DeleteRequestedInterface"); + + Assert.That(deleted, Is.False); + } + + [Test] + public async Task UpdateTicket_DoesNothingWhenTicketIsMissing() + { + ModellingConnectionHandler handler = CreateHandler(new ModellingConnection { Id = 25, TicketId = null }); + + await InvokeAsync(handler, "UpdateTicket", null, null, null); + + Assert.That(handler.ActConn.TicketId, Is.Null); + } + + [Test] + public void RequestRemovePreselectedInterface_PreparesConfirmation() + { + ModellingConnectionHandler handler = CreateHandler(new ModellingConnection { Id = 26 }); + ModellingConnection selected = new() { Id = 27, Name = "SelectedInterface" }; + + handler.RequestRemovePreselectedInterface(selected); + + Assert.Multiple(() => + { + Assert.That(handler.RemovePreselectedInterfaceMode, Is.True); + Assert.That(handler.Message, Does.Contain("SelectedInterface")); + }); + } + + [Test] + public async Task RemovePreselectedInterface_RemovesSelectionAfterSuccessfulDelete() + { + ModellingConnection selected = new() { Id = 28, Name = "SelectedInterface" }; + ModellingConnectionHandler handler = new ModellingConnectionHandler( + new PreselectedInterfaceApiConn(), userConfig, Application, [new ModellingConnection { Id = 29 }], + new ModellingConnection { Id = 29 }, false, false, DisplayMessageInUi, DefaultInit.DoNothing, true) + { + PreselectedInterfaces = [selected] + }; + handler.RequestRemovePreselectedInterface(selected); + + await handler.RemovePreselectedInterface(); + + Assert.Multiple(() => + { + Assert.That(handler.PreselectedInterfaces, Is.Empty); + Assert.That(handler.RemovePreselectedInterfaceMode, Is.False); + }); + } + [Test] public void DisplayInterface_UsesOwnerForDisplayName() { @@ -474,5 +578,37 @@ private static ModellingServiceGroupWrapper WrapServiceGroup(int id, string name { return new ModellingServiceGroupWrapper { Content = new ModellingServiceGroup { Id = id, Name = name } }; } + + private static MethodInfo GetPrivateMethod(string name) + { + return typeof(ModellingConnectionHandler).GetMethod(name, BindingFlags.NonPublic | BindingFlags.Instance) + ?? throw new MissingMethodException(typeof(ModellingConnectionHandler).FullName, name); + } + + private static async Task InvokeAsync(ModellingConnectionHandler handler, string name, params object?[] arguments) + { + await (Task)(GetPrivateMethod(name).Invoke(handler, arguments) + ?? throw new InvalidOperationException($"Private method '{name}' returned null.")); + } + + private static async Task InvokeAsync(ModellingConnectionHandler handler, string name, params object?[] arguments) + { + return (T)(await (Task)(GetPrivateMethod(name).Invoke(handler, arguments) + ?? throw new InvalidOperationException($"Private method '{name}' returned null.")))!; + } + + private sealed class PreselectedInterfaceApiConn : SimulatedApiConnection + { + public override Task SendQueryAsync(string query, object? variables = null, string? operationName = null, + FWO.Api.Client.QueryChunkingOptions? chunkingOptions = null) + { + if (typeof(T) == typeof(ReturnId) && query == ModellingQueries.removeSelectedConnectionFromApp) + { + return Task.FromResult((T)(object)new ReturnId { AffectedRows = 1 }); + } + + throw new AssertionException($"Unexpected query: {query}"); + } + } } } diff --git a/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs b/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs index deafa0b352..543ed12ffe 100644 --- a/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs @@ -1,4 +1,6 @@ using FWO.Config.Api; +using FWO.Api.Client; +using FWO.Api.Client.Queries; using FWO.Data; using FWO.Ui.Shared; using NUnit.Framework; @@ -26,6 +28,25 @@ private static void SetPrivateField(EditNotifications component, string field field.SetValue(component, value); } + private static void SetPrivateMember(EditNotifications component, string memberName, object? value) + { + FieldInfo? field = typeof(EditNotifications).GetField(memberName, BindingFlags.NonPublic | BindingFlags.Instance); + if (field != null) + { + field.SetValue(component, value); + return; + } + + PropertyInfo? property = typeof(EditNotifications).GetProperty(memberName, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance); + if (property != null) + { + property.SetValue(component, value); + return; + } + + throw new MissingMemberException(typeof(EditNotifications).FullName, memberName); + } + private static T GetPrivateField(EditNotifications component, string fieldName) { FieldInfo? field = typeof(EditNotifications).GetField(fieldName, BindingFlags.NonPublic | BindingFlags.Instance); @@ -537,5 +558,255 @@ public void EnsureNotificationIntervals_SetsDefaultIntervalValues_WhenOffsetsAre Assert.That(notification.RepeatIntervalAfterDeadline, Is.EqualTo(SchedulerInterval.Weeks)); }); } + + [Test] + public void OfferedLayoutOptions_ExcludesAttachmentsForModellingClients() + { + EditNotifications component = new(); + SetClient(component, NotificationClient.InterfaceRequest); + + List layouts = (List)GetPrivateMethod("OfferedLayoutOptions").Invoke(component, null)!; + + Assert.That(layouts, Does.Not.Contain(NotificationLayout.PdfAsAttachment)); + } + + [Test] + public void OfferedLayoutOptions_OffersAttachmentsForReportClient() + { + EditNotifications component = new(); + SetClient(component, NotificationClient.Report); + + List layouts = (List)GetPrivateMethod("OfferedLayoutOptions").Invoke(component, null)!; + + Assert.That(layouts, Does.Contain(NotificationLayout.PdfAsAttachment)); + } + + [Test] + public void CheckConsistencyWithDeadline_ReturnsFalseWithoutAnyOffset() + { + EditNotifications component = new(); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateField(component, "actNotification", new FwoNotification()); + + bool result = (bool)GetPrivateMethod("CheckConsistencyWithDeadline").Invoke(component, null)!; + + Assert.That(result, Is.False); + } + + [Test] + public void CheckConsistencyWithDeadline_ReturnsFalseWhenBeforeOffsetHasNoInterval() + { + EditNotifications component = new(); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateField(component, "actNotification", new FwoNotification { OffsetBeforeDeadline = 1 }); + + bool result = (bool)GetPrivateMethod("CheckConsistencyWithDeadline").Invoke(component, null)!; + + Assert.That(result, Is.False); + } + + [Test] + public void CheckConsistencyWithDeadline_ReturnsTrueForCompleteBeforeDeadlineConfiguration() + { + EditNotifications component = new(); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateField(component, "actNotification", new FwoNotification + { + OffsetBeforeDeadline = 1, + IntervalBeforeDeadline = SchedulerInterval.Days + }); + + bool result = (bool)GetPrivateMethod("CheckConsistencyWithDeadline").Invoke(component, null)!; + + Assert.That(result, Is.True); + } + + [Test] + public async Task SetDirectAddresses_WritesToCcAndBccFields() + { + EditNotifications component = new(); + FwoNotification notification = new(); + SetPrivateField(component, "actNotification", notification); + + await (Task)GetPrivateMethod("SetDirectAddressTo").Invoke(component, new object?[] { "to@example.org" })!; + await (Task)GetPrivateMethod("SetDirectAddressCc").Invoke(component, new object?[] { "cc@example.org" })!; + await (Task)GetPrivateMethod("SetDirectAddressBcc").Invoke(component, new object?[] { "bcc@example.org" })!; + + Assert.Multiple(() => + { + Assert.That(notification.EmailAddressTo, Is.EqualTo("to@example.org")); + Assert.That(notification.EmailAddressCc, Is.EqualTo("cc@example.org")); + Assert.That(notification.EmailAddressBcc, Is.EqualTo("bcc@example.org")); + }); + } + + [Test] + public void ParseOtherAddressSelection_ParsesConfiguredSelectionJson() + { + EditNotifications component = new(); + SetPrivateField(component, "activeOwnerResponsibleTypes", new List + { + new() { Id = 1, Name = "Main", Active = true } + }); + EmailRecipientSelection expected = new() + { + None = false, + OtherAddresses = true, + OtherAddressList = new List { "json@example.org" } + }; + + EmailRecipientSelection result = (EmailRecipientSelection)GetPrivateMethod("ParseOtherAddressSelection") + .Invoke(component, new object?[] { expected.ToConfigValue(new List { 1 }), new List() })!; + + Assert.That(result.OtherAddressList, Is.EqualTo(new List { "json@example.org" })); + } + + [Test] + public void ParseOtherAddressSelection_UsesLegacyAddressesWhenValueIsNotJson() + { + EditNotifications component = new(); + + EmailRecipientSelection result = (EmailRecipientSelection)GetPrivateMethod("ParseOtherAddressSelection") + .Invoke(component, new object?[] { "legacy@example.org", new List { "legacy@example.org" } })!; + + Assert.Multiple(() => + { + Assert.That(result.OtherAddresses, Is.True); + Assert.That(result.OtherAddressList, Is.EqualTo(new List { "legacy@example.org" })); + }); + } + + [Test] + public async Task AddAndRemoveNotificationId_UpdatesBoundIds() + { + EditNotifications component = new(); + List notificationIds = new() { 4 }; + SetPrivateMember(component, "NotificationIds", notificationIds); + + await (Task)GetPrivateMethod("AddNotificationId").Invoke(component, new object?[] { 7 })!; + await (Task)GetPrivateMethod("AddNotificationId").Invoke(component, new object?[] { 4 })!; + await (Task)GetPrivateMethod("RemoveNotificationId").Invoke(component, new object?[] { 4 })!; + + Assert.That(notificationIds, Is.EqualTo(new List { 7 })); + } + + [Test] + public async Task ResetNotification_LeavesLastSentWhenUpdateFails() + { + EditNotifications component = new(); + DateTime lastSent = DateTime.Now; + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateMember(component, "apiConnection", new EditNotificationsApiConnection { ThrowOnReset = true }); + SetPrivateField(component, "actNotification", new FwoNotification { Id = 9, LastSent = lastSent }); + SetPrivateField(component, "ResetNotifMode", true); + + MethodInfo resetMethod = typeof(EditNotifications).GetMethod("ResetNotification", BindingFlags.NonPublic | BindingFlags.Instance, + binder: null, types: Type.EmptyTypes, modifiers: null) + ?? throw new MissingMethodException(typeof(EditNotifications).FullName, "ResetNotification()"); + Assert.DoesNotThrowAsync(async () => await (Task)resetMethod.Invoke(component, null)!); + + Assert.Multiple(() => + { + Assert.That(GetPrivateField(component, "actNotification").LastSent, Is.EqualTo(lastSent)); + Assert.That(GetPrivateField(component, "ResetNotifMode"), Is.True); + }); + } + + [Test] + public async Task Save_AddsNotificationAndReferenceWhenConfigurationIsValid() + { + EditNotifications component = new(); + SetClient(component, NotificationClient.Report); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateMember(component, "apiConnection", new EditNotificationsApiConnection()); + SetPrivateField(component, "Notifications", new List()); + SetPrivateMember(component, "NotificationIds", new List()); + SetPrivateField(component, "actNotification", new FwoNotification + { + Channel = NotificationChannel.Email, + EmailSubject = "Subject", + EmailAddressTo = "to@example.org" + }); + SetPrivateField(component, "AddNotifMode", true); + + await (Task)GetPrivateMethod("Save").Invoke(component, null)!; + + Assert.Multiple(() => + { + Assert.That(GetPrivateField>(component, "Notifications"), Has.Count.EqualTo(1)); + Assert.That(component.NotificationIds, Is.EqualTo(new List { 100 })); + Assert.That(GetPrivateField(component, "EditNotifMode"), Is.False); + }); + } + + [Test] + public async Task Delete_RestoresReferenceWhenDeleteFails() + { + EditNotificationsApiConnection apiConnection = new() { ThrowOnDelete = true }; + EditNotifications component = new(); + FwoNotification notification = new() { Id = 9, Name = "Notification" }; + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateMember(component, "apiConnection", apiConnection); + SetPrivateField(component, "Notifications", new List { notification }); + SetPrivateMember(component, "NotificationIds", new List { 9 }); + SetPrivateField(component, "actNotification", notification); + + await (Task)GetPrivateMethod("Delete").Invoke(component, null)!; + + Assert.Multiple(() => + { + Assert.That(GetPrivateField>(component, "Notifications"), Has.Count.EqualTo(1)); + Assert.That(component.NotificationIds, Is.EqualTo(new List { 9 })); + Assert.That(apiConnection.DeletedIds, Is.EqualTo(new List { 9 })); + }); + } + + private sealed class EditNotificationsApiConnection : SimulatedApiConnection + { + private static readonly ReturnId[] AddedNotificationIds = new ReturnId[] { new() { NewId = 100 } }; + private static readonly ReturnId[] UpdatedNotificationIds = new ReturnId[] { new() { UpdatedId = 9 } }; + public int AffectedRows { get; init; } + public bool ThrowOnDelete { get; init; } + public bool ThrowOnReset { get; init; } + public List DeletedIds { get; } = new(); + + public override Task SendQueryAsync(string query, object? variables = null, + string? operationName = null, QueryChunkingOptions? chunkingOptions = null) + { + if (query == NotificationQueries.addNotification && typeof(QueryResponseType) == typeof(ReturnIdWrapper)) + { + return Task.FromResult((QueryResponseType)(object)new ReturnIdWrapper + { + ReturnIds = AddedNotificationIds + }); + } + if (query == NotificationQueries.updateNotification && typeof(QueryResponseType) == typeof(ReturnIdWrapper)) + { + return Task.FromResult((QueryResponseType)(object)new ReturnIdWrapper + { + ReturnIds = UpdatedNotificationIds + }); + } + if (query == NotificationQueries.deleteNotification && typeof(QueryResponseType) == typeof(object)) + { + DeletedIds.Add((int)(variables?.GetType().GetProperty("id")?.GetValue(variables) ?? 0)); + if (ThrowOnDelete) + { + throw new InvalidOperationException("Delete failed."); + } + return Task.FromResult((QueryResponseType)(object)new object()); + } + if (query == NotificationQueries.updateNotificationsLastSent && typeof(QueryResponseType) == typeof(ReturnId)) + { + if (ThrowOnReset) + { + throw new InvalidOperationException("Reset failed."); + } + return Task.FromResult((QueryResponseType)(object)new ReturnId { AffectedRows = AffectedRows }); + } + + throw new NotImplementedException($"Unexpected query: {query}"); + } + } } } diff --git a/roles/tests-unit/files/FWO.Test/UiMonitoringLayoutTest.cs b/roles/tests-unit/files/FWO.Test/UiMonitoringLayoutTest.cs new file mode 100644 index 0000000000..4956565972 --- /dev/null +++ b/roles/tests-unit/files/FWO.Test/UiMonitoringLayoutTest.cs @@ -0,0 +1,129 @@ +using Bunit; +using FWO.Basics; +using FWO.Config.Api; +using FWO.Ui.Services; +using FWO.Ui.Shared; +using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Components; +using Microsoft.AspNetCore.Components.Authorization; +using Microsoft.Extensions.DependencyInjection; +using NUnit.Framework; +using System.Reflection; +using System.Security.Claims; + +namespace FWO.Test +{ + [TestFixture] + [FixtureLifeCycle(LifeCycle.InstancePerTestCase)] + internal class UiMonitoringLayoutTest + { + [Test] + public async Task MonitoringLayout_ShowsPrivilegedSectionsAndNotificationsForAdmin() + { + await using BunitContext context = CreateContext(Roles.Admin); + + IRenderedComponent layout = RenderLayout(context); + DomEventService eventService = context.Services.GetRequiredService(); + layout.WaitForAssertion(() => Assert.That(GetNavbarHeightSubscriberCount(eventService), Is.EqualTo(1))); + await layout.InvokeAsync(() => eventService.InvokeNavbarHeightChanged(50)); + layout.WaitForAssertion(() => Assert.That(layout.FindAll("a[href='monitoring/email_log']"), Has.Count.EqualTo(1))); + + Assert.Multiple(() => + { + Assert.That(layout.FindAll("h5").Select(element => element.TextContent), Does.Contain("Notifications")); + Assert.That(layout.FindAll("a[href='monitoring/email_log']"), Has.Count.EqualTo(1)); + Assert.That(layout.FindAll("a[href='monitoring/system_usage']"), Has.Count.EqualTo(1)); + Assert.That(layout.FindAll("a[href='monitoring/ui_messages']"), Has.Count.EqualTo(1)); + }); + } + + [Test] + public async Task MonitoringLayout_HidesPrivilegedSectionsForRegularUser() + { + await using BunitContext context = CreateContext(Roles.Requester); + + IRenderedComponent layout = RenderLayout(context); + DomEventService eventService = context.Services.GetRequiredService(); + layout.WaitForAssertion(() => Assert.That(GetNavbarHeightSubscriberCount(eventService), Is.EqualTo(1))); + await layout.InvokeAsync(() => eventService.InvokeNavbarHeightChanged(50)); + layout.WaitForAssertion(() => Assert.That(layout.FindAll("a[href='monitoring/ui_messages']"), Has.Count.EqualTo(1))); + + Assert.Multiple(() => + { + Assert.That(layout.FindAll("a[href='monitoring/email_log']"), Is.Empty); + Assert.That(layout.FindAll("a[href='monitoring/system_usage']"), Is.Empty); + Assert.That(layout.FindAll("a[href='monitoring/ui_messages']"), Has.Count.EqualTo(1)); + Assert.That(layout.FindAll("a[href='monitoring/monitor_all']"), Is.Empty); + }); + } + + [Test] + public async Task MonitoringLayout_DisposeUnsubscribesFromUserConfigChanges() + { + await using BunitContext context = CreateContext(Roles.Admin); + SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + IRenderedComponent layout = RenderLayout(context); + + layout.Instance.Dispose(); + + Assert.DoesNotThrow(() => userConfig.SetExecutionMode(Roles.Auditor)); + } + + private static BunitContext CreateContext(string role) + { + SimulatedUserConfig userConfig = new(); + userConfig.User.Roles = new List { role }; + userConfig.SetExecutionMode(role); + + BunitContext context = new(); + context.JSInterop.Mode = JSRuntimeMode.Loose; + context.Services.AddAuthorizationCore(); + context.Services.AddSingleton(); + context.Services.AddSingleton(new MonitoringLayoutAuthStateProvider(role)); + context.Services.AddSingleton(new TestDomEventService()); + context.Services.AddSingleton(userConfig); + return context; + } + + private static IRenderedComponent RenderLayout(BunitContext context) + { + return context.Render(parameters => parameters + .AddChildContent()) + .FindComponent(); + } + + private static int GetNavbarHeightSubscriberCount(DomEventService eventService) + { + FieldInfo? field = typeof(DomEventService).GetField("_navbarHeightSubscribers", BindingFlags.Instance | BindingFlags.NonPublic); + MulticastDelegate? subscribers = field?.GetValue(eventService) as MulticastDelegate; + return subscribers?.GetInvocationList().Length ?? 0; + } + + private sealed class TestDomEventService : DomEventService, IDisposable + { + public void Dispose() + { + } + } + + private sealed class MonitoringLayoutAuthStateProvider : AuthenticationStateProvider + { + private readonly AuthenticationState authenticationState; + + public MonitoringLayoutAuthStateProvider(string role) + { + ClaimsIdentity identity = new( + new List { new(ClaimTypes.Role, role) }, + authenticationType: "Test", + nameType: ClaimTypes.Name, + roleType: ClaimTypes.Role); + authenticationState = new AuthenticationState(new ClaimsPrincipal(identity)); + } + + public override Task GetAuthenticationStateAsync() + { + return Task.FromResult(authenticationState); + } + } + } +} diff --git a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs index 2831960e02..6d589d91d0 100644 --- a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs @@ -95,6 +95,33 @@ public async Task RequestInterfacePopup_SendRequest_RejectsWhenSelectedOwnerMatc Assert.That(component.Instance.Display, Is.True); } + [Test] + public async Task RequestInterfacePopup_SendRequest_ContinuesWhenInputIsValid() + { + using BunitContext context = CreateContext(new RequestPopupNoImmediateApiConn(), Roles.Modeller); + SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + userConfig.ModReqInterfaceName = "req-interface"; + List<(Exception? Exception, string Title, string Message, bool IsError)> messages = new(); + IRenderedComponent component = RenderRequestInterfacePopup( + context, + new FwoOwner { Id = 11, Name = "Selected", ExtAppId = "APP-42" }, + new FwoOwner { Id = 12, Name = "Requester" }, + messageSink: (exception, title, message, isError) => messages.Add((exception, title, message, isError))); + + component.Find("input[type='text']").Change("branch-if"); + component.Find("textarea").Change("needed"); + await component.InvokeAsync(() => component.FindAll("button.btn-primary").Single().Click()); + + Assert.Multiple(() => + { + Assert.That(messages, Has.Count.EqualTo(1)); + Assert.That(messages[0].Exception, Is.Not.Null); + Assert.That(messages[0].Message, Is.Not.EqualTo(userConfig.GetText("E5102"))); + Assert.That(messages[0].Message, Is.Not.EqualTo(userConfig.GetText("E9012"))); + Assert.That(component.Instance.Display, Is.True); + }); + } + [Test] public async Task RequestInterfacePopup_LoadImmediateRequestNotification_ReturnsDeadlineNoneNotification() { @@ -376,6 +403,87 @@ public void RejectInterfacePopup_BuildsNotificationContextWithRejectReason() }); } + [Test] + public void RejectInterfacePopup_BuildsEmptyNotificationContextForMissingConnectionData() + { + using BunitContext context = CreateContext(Roles.Modeller); + SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + ModellingConnectionHandler handler = CreateConnectionHandler( + new RejectInterfacePopupTestApiConn(), + userConfig, + new ModellingConnection { Id = 21, IsInterface = true }); + handler.Application = null!; + IRenderedComponent component = RenderRejectInterfacePopup(context, handler); + SetPrivateMember(component.Instance, "Reason", "reject reason"); + + MethodInfo method = typeof(RejectInterfacePopup).GetMethod("BuildNotificationPlaceholderData", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("BuildNotificationPlaceholderData method not found."); + NotificationPlaceholderData data = (NotificationPlaceholderData)(method.Invoke(component.Instance, null) + ?? throw new InvalidOperationException("BuildNotificationPlaceholderData returned null.")); + + Assert.Multiple(() => + { + Assert.That(data.InterfaceName, Is.Empty); + Assert.That(data.RequestingAppName, Is.Empty); + Assert.That(data.RequestingAppId, Is.Empty); + Assert.That(data.InterfaceLinkUrl, Is.Empty); + Assert.That(data.Content, Is.EqualTo("reject reason")); + Assert.That(data.UserName, Is.EqualTo(userConfig.User.Name)); + Assert.That(data.RequestDate, Is.Empty); + }); + } + + [Test] + public async Task RejectInterfacePopup_RejectInTicket_SkipsWhenTicketIdIsMissing() + { + using BunitContext context = CreateContext(Roles.Modeller); + RejectInterfacePopupTestApiConn apiConn = new(); + ModellingConnectionHandler handler = CreateConnectionHandler( + apiConn, + (SimulatedUserConfig)context.Services.GetRequiredService(), + new ModellingConnection { Id = 21, IsInterface = true }); + IRenderedComponent component = RenderRejectInterfacePopup(context, handler); + List<(Exception? Exception, string Title, string Message, bool IsError)> messages = new(); + SetPrivateMember(component.Instance, "DisplayMessageInUi", + (Action)((exception, title, message, isError) => messages.Add((exception, title, message, isError)))); + + MethodInfo method = typeof(RejectInterfacePopup).GetMethod("RejectInTicket", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("RejectInTicket method not found."); + Task task = (Task)(method.Invoke(component.Instance, new object?[] { null }) + ?? throw new InvalidOperationException("RejectInTicket returned null task.")); + await task; + + Assert.Multiple(() => + { + Assert.That(messages, Is.Empty); + Assert.That(apiConn.UpdateConnectionPropertiesCalls, Is.Zero); + Assert.That(apiConn.RemoveSelectedConnectionCalls, Is.Zero); + }); + } + + [Test] + public async Task RejectInterfacePopup_RejectInTicket_SkipsWhenConnectionHandlerIsMissing() + { + using BunitContext context = CreateContext(Roles.Modeller); + SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + ModellingConnectionHandler handler = CreateConnectionHandler( + new RejectInterfacePopupTestApiConn(), + userConfig, + new ModellingConnection { Id = 21, IsInterface = true }); + IRenderedComponent component = RenderRejectInterfacePopup( + context, + handler, + messageSink: null); + SetPrivateMember(component.Instance, "ConnHandler", null); + + MethodInfo method = typeof(RejectInterfacePopup).GetMethod("RejectInTicket", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("RejectInTicket method not found."); + Task task = (Task)(method.Invoke(component.Instance, new object?[] { 123L }) + ?? throw new InvalidOperationException("RejectInTicket returned null task.")); + + Assert.DoesNotThrowAsync(async () => await task); + } + [Test] public async Task RejectInterfacePopup_Reject_SavesPropertiesAndRemovesSelection() { diff --git a/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs b/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs index 18f18bf55d..9f73d01bd2 100644 --- a/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs @@ -33,7 +33,7 @@ public async Task Page_RendersThreeNotificationEditorsWithExpectedSections() page.WaitForAssertion(() => { - Assert.That(page.Markup, Does.Contain("Interfaces")); + Assert.That(page.Markup, Does.Contain("Notifications")); Assert.That(page.Markup, Does.Contain("Initial request")); Assert.That(page.Markup, Does.Contain("Reminder")); Assert.That(page.Markup, Does.Contain("Decommission")); diff --git a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor index f9a1697cd2..57f1ce7cfe 100644 --- a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor +++ b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor @@ -1,12 +1,7 @@ -@using FWO.Api.Client.Queries @using FWO.Basics @using FWO.Config.Api.Data @using FWO.Data -@using FWO.Data.Middleware -@using FWO.Middleware.Client @using FWO.Services -@using FWO.Ui.Data -@using FWO.Ui.Pages.NetworkModelling @page "/settings/modellingnotifications" @attribute [Authorize(Roles = $"{Roles.Admin}, {Roles.Auditor}")] @@ -16,7 +11,7 @@ @inject UserConfig userConfig
      -

      @(userConfig.GetText("interfaces"))

      +

      @(userConfig.GetText("notifications"))

      From 2a9152da726bf224b7c8d3f45b4b3618d0daf32d Mon Sep 17 00:00:00 2001 From: abarz722 Date: Tue, 8 Sep 2026 17:12:53 +0200 Subject: [PATCH 13/48] placeholder + layout fixes --- .../files/sql/idempotent/fworch-texts.sql | 6 +-- .../FWO.Test/EmailHelperRecipientTest.cs | 15 ++++--- .../files/FWO.Test/SimulatedUserConfig.cs | 1 + .../FWO.Test/UiRequestAndRejectPopupTest.cs | 42 +++++++++++++++--- .../files/FWO.Test/UiSettingsModellingTest.cs | 37 ++++++++++++++++ .../MonitorRequestedInterfaces.razor | 4 +- .../RejectInterfacePopup.razor | 44 ++++++++++++++++--- .../Pages/Settings/SettingsModelling.razor | 12 +++-- .../SettingsModellingNotifications.razor | 32 +++++++------- 9 files changed, 155 insertions(+), 38 deletions(-) diff --git a/roles/database/files/sql/idempotent/fworch-texts.sql b/roles/database/files/sql/idempotent/fworch-texts.sql index 0a14e76358..ce4df2e1aa 100644 --- a/roles/database/files/sql/idempotent/fworch-texts.sql +++ b/roles/database/files/sql/idempotent/fworch-texts.sql @@ -5804,8 +5804,8 @@ INSERT INTO txt VALUES ('H4108a','German', 'Empfänger (Bcc). Wie "Empf&aum INSERT INTO txt VALUES ('H4108a','English', 'Recipient (Bcc). As "Recipient (To)" for blind-copy recipients.'); INSERT INTO txt VALUES ('H4109', 'German', 'Name: Name der Benachrichtigung, nur für Darstellungszwecke.'); INSERT INTO txt VALUES ('H4109', 'English', 'Name: Name of notification, only for display purposes.'); -INSERT INTO txt VALUES ('H4110', 'German', 'Email-Inhalt: Text der Benachrichtigung. Bei Layouts ohne Anhang kann der Platzhalter @@CONTENT@@ verwendet werden, um den erzeugten Inhalt an dieser Stelle einzufügen. Die Platzhalter @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_NAME@@, @@INTERFACE_LINK@@, @@NEW_INTERFACE_NAME@@, @@NEW_INTERFACE_LINK@@, @@REASON@@, @@USER_NAME@@ und @@REQUESTDATE@@ werden ersetzt, wenn der jeweilige Kontext vom Aufrufer bereitgestellt wird.'); -INSERT INTO txt VALUES ('H4110', 'English', 'Email body: Text of the notification. For layouts without attachment, the @@CONTENT@@ placeholder can be used to insert the generated content at this position. The placeholders @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_NAME@@, @@INTERFACE_LINK@@, @@NEW_INTERFACE_NAME@@, @@NEW_INTERFACE_LINK@@, @@REASON@@, @@USER_NAME@@ and @@REQUESTDATE@@ are replaced when the caller provides the respective context.'); +INSERT INTO txt VALUES ('H4110', 'German', 'Email-Inhalt: Text der Benachrichtigung. Bei Layouts ohne Anhang kann der Platzhalter @@CONTENT@@ verwendet werden, um vom Aufrufer bereitgestellten Inhalt, z.B. einen Ablehnungsgrund, an dieser Stelle einzufügen. Die Platzhalter @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_NAME@@, @@INTERFACE_LINK@@, @@NEW_INTERFACE_NAME@@, @@NEW_INTERFACE_LINK@@, @@REASON@@, @@USER_NAME@@ und @@REQUESTDATE@@ werden ersetzt, wenn der jeweilige Kontext vom Aufrufer bereitgestellt wird.'); +INSERT INTO txt VALUES ('H4110', 'English', 'Email body: Text of the notification. For layouts without attachment, the @@CONTENT@@ placeholder can be used to insert caller-provided content, for example a rejection reason. The placeholders @@APPNAME@@, @@APPID@@, @@REQUESTER@@, @@REQUESTING_APPNAME@@, @@REQUESTING_APPID@@, @@INTERFACE_NAME@@, @@INTERFACE_LINK@@, @@NEW_INTERFACE_NAME@@, @@NEW_INTERFACE_LINK@@, @@REASON@@, @@USER_NAME@@ and @@REQUESTDATE@@ are replaced when the caller provides the respective context.'); INSERT INTO txt VALUES ('H4111', 'German', 'Protokollierungsmodus: Legt fest, ob eine Benachrichtigung nur gesendet, nur protokolliert oder beides gemacht wird.'); INSERT INTO txt VALUES ('H4111', 'English', 'Logging mode: Defines whether a notification is sent only, logged only, or both.'); @@ -7105,7 +7105,7 @@ INSERT INTO txt VALUES ('H5624a', 'English', 'Body of reminder emails: Text of t INSERT INTO txt VALUES ('H5625', 'German', 'Titel des Schnittstellentickets: Titel, mit dem ein neues Ticket zur Beantragung einer Schnittstelle angelegt wird.'); INSERT INTO txt VALUES ('H5625', 'English', 'Title of interface request ticket: Title used for the new interface request ticket.'); INSERT INTO txt VALUES ('H5626', 'German', 'Titel des Schnittstellenauftrags: Titel, mit dem ein neuer Auftrag im Ticket zur Beantragung einer Schnittstelle angelegt wird.'); -INSERT INTO txt VALUES ('H5626', 'English', 'Title of interface request ticket: Title used for the Task in the new interface request ticket.'); +INSERT INTO txt VALUES ('H5626', 'English', 'Title of interface request task: Title used for the task in the new interface request ticket.'); INSERT INTO txt VALUES ('H5627', 'German', 'App-Server-Typen: Hier können beliebige App-Server-Typen mit Namen und Id definiert werden. Bitte jeweils neue Id vergeben. Vorsicht beim Löschen bereits verwendeter Typen! Der Standard-typ ist immer vorhanden und wird beim Datenimport verwendet. Hier kann nur der dargestellte Name gesetzt werden. Zur manuellen Zuweisung zu einem App-Server kann er nicht verwendet werden. '); diff --git a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs index 5865e7deb2..ef417462d9 100644 --- a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs +++ b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs @@ -292,8 +292,8 @@ public async Task SendWorkflowActionEmail_UsesWorkflowRecipientsAndPlaceholderOb RecipientCc = EmailRecipientOption.AssignedGroup, RecipientBcc = EmailRecipientOption.OtherAddresses, EmailAddressBcc = "bcc@example.test", - EmailSubject = $"{Placeholder.REQUESTER}|{Placeholder.APPNAME}|{Placeholder.APPID}", - EmailBody = $"Body:{Placeholder.REQUESTER}|{Placeholder.APPNAME}|{Placeholder.APPID}" + EmailSubject = $"{Placeholder.REQUESTER}|{Placeholder.APPNAME}|{Placeholder.APPID}|{Placeholder.REQUESTING_APPNAME}|{Placeholder.REQUESTING_APPID}", + EmailBody = $"Body:{Placeholder.REQUESTER}|{Placeholder.APPNAME}|{Placeholder.APPID}|{Placeholder.REQUESTING_APPNAME}|{Placeholder.REQUESTING_APPID}" }; WorkflowEmailContent workflowContent = new() { @@ -309,7 +309,12 @@ public async Task SendWorkflowActionEmail_UsesWorkflowRecipientsAndPlaceholderOb owner, "cn=workflow-group,dc=test", workflowContent, - placeholderTicket); + placeholderTicket, + new NotificationPlaceholderData + { + RequestingAppName = "Requesting App", + RequestingAppId = "REQ-APP" + }); Assert.Multiple(() => { @@ -317,8 +322,8 @@ public async Task SendWorkflowActionEmail_UsesWorkflowRecipientsAndPlaceholderOb Assert.That(helper.CapturedTo, Is.EqualTo(new List { "requester@example.test" })); Assert.That(helper.CapturedCc, Is.EqualTo(new List { "group@example.test" })); Assert.That(helper.CapturedBcc, Is.EqualTo(new List { "bcc@example.test" })); - Assert.That(helper.CapturedSubject, Is.EqualTo("Requester A|Owner A|APP-42")); - Assert.That(helper.CapturedBody, Is.EqualTo("Body:Requester A|Owner A|APP-42")); + Assert.That(helper.CapturedSubject, Is.EqualTo("Requester A|Owner A|APP-42|Requesting App|REQ-APP")); + Assert.That(helper.CapturedBody, Is.EqualTo("Body:Requester A|Owner A|APP-42|Requesting App|REQ-APP")); Assert.That(helper.CapturedMailFormatHtml, Is.False); Assert.That(helper.CapturedAttachment, Is.Not.Null); Assert.That(helper.CapturedAttachment!.ContentType, Is.EqualTo("application/html")); diff --git a/roles/tests-unit/files/FWO.Test/SimulatedUserConfig.cs b/roles/tests-unit/files/FWO.Test/SimulatedUserConfig.cs index f53df02ad9..492504ddf5 100644 --- a/roles/tests-unit/files/FWO.Test/SimulatedUserConfig.cs +++ b/roles/tests-unit/files/FWO.Test/SimulatedUserConfig.cs @@ -110,6 +110,7 @@ internal class SimulatedUserConfig : UserConfig {"flow_general_settings","General Settings"}, {"flow_naming","Flow naming source ranking"}, {"H5601","On this page the general modelling settings are administrated. This includes predefined services, display options, naming conventions and the remaining modelling settings. The extracted notifications are available on the adjacent notifications page."}, + {"predef_services", "Predefined Services"}, {"H5839","Matrix violation"}, {"H5840","Restricted Service"}, {"H5841","Not assessable"}, diff --git a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs index 6d589d91d0..4029b72063 100644 --- a/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiRequestAndRejectPopupTest.cs @@ -6,6 +6,7 @@ using FWO.Config.Api; using FWO.Data; using FWO.Data.Modelling; +using FWO.Data.Workflow; using FWO.Middleware.Client; using FWO.Services; using FWO.Services.Modelling; @@ -379,14 +380,16 @@ public void RejectInterfacePopup_BuildsNotificationContextWithRejectReason() { Id = 21, Name = "iface21", - App = new FwoOwner { Name = "Requesting App", ExtAppId = "REQ-APP" }, CreationDate = new DateTime(2025, 1, 2), IsInterface = true }; ModellingConnectionHandler handler = CreateConnectionHandler(new RejectInterfacePopupTestApiConn(), userConfig, actConn); handler.Application.ExtAppId = "OWNER-APP"; IRenderedComponent component = RenderRejectInterfacePopup( - context, handler, allowAdminReject: true); + context, + handler, + allowAdminReject: true, + requestingApp: new FwoOwner { Id = 12, Name = "Requesting App", ExtAppId = "REQ-APP" }); component.Find("textarea").Change("not approved"); MethodInfo method = typeof(RejectInterfacePopup).GetMethod("BuildNotificationPlaceholderData", BindingFlags.Instance | BindingFlags.NonPublic)!; @@ -433,6 +436,34 @@ public void RejectInterfacePopup_BuildsEmptyNotificationContextForMissingConnect }); } + [Test] + public void RejectInterfacePopup_DoesNotUseConnectionOwnerAsRequestingApp() + { + using BunitContext context = CreateContext(Roles.Modeller); + SimulatedUserConfig userConfig = (SimulatedUserConfig)context.Services.GetRequiredService(); + ModellingConnectionHandler handler = CreateConnectionHandler( + new RejectInterfacePopupTestApiConn(), + userConfig, + new ModellingConnection + { + Id = 21, + IsInterface = true, + App = new FwoOwner { Id = 77, Name = "Requested App", ExtAppId = "REQUESTED-APP" } + }); + IRenderedComponent component = RenderRejectInterfacePopup(context, handler); + + MethodInfo method = typeof(RejectInterfacePopup).GetMethod("BuildNotificationPlaceholderData", BindingFlags.Instance | BindingFlags.NonPublic) + ?? throw new InvalidOperationException("BuildNotificationPlaceholderData method not found."); + NotificationPlaceholderData data = (NotificationPlaceholderData)(method.Invoke(component.Instance, null) + ?? throw new InvalidOperationException("BuildNotificationPlaceholderData returned null.")); + + Assert.Multiple(() => + { + Assert.That(data.RequestingAppName, Is.Empty); + Assert.That(data.RequestingAppId, Is.Empty); + }); + } + [Test] public async Task RejectInterfacePopup_RejectInTicket_SkipsWhenTicketIdIsMissing() { @@ -449,7 +480,7 @@ public async Task RejectInterfacePopup_RejectInTicket_SkipsWhenTicketIdIsMissing MethodInfo method = typeof(RejectInterfacePopup).GetMethod("RejectInTicket", BindingFlags.Instance | BindingFlags.NonPublic) ?? throw new InvalidOperationException("RejectInTicket method not found."); - Task task = (Task)(method.Invoke(component.Instance, new object?[] { null }) + Task task = (Task)(method.Invoke(component.Instance, new object?[] { null, null }) ?? throw new InvalidOperationException("RejectInTicket returned null task.")); await task; @@ -478,7 +509,7 @@ public async Task RejectInterfacePopup_RejectInTicket_SkipsWhenConnectionHandler MethodInfo method = typeof(RejectInterfacePopup).GetMethod("RejectInTicket", BindingFlags.Instance | BindingFlags.NonPublic) ?? throw new InvalidOperationException("RejectInTicket method not found."); - Task task = (Task)(method.Invoke(component.Instance, new object?[] { 123L }) + Task task = (Task)(method.Invoke(component.Instance, new object?[] { 123L, null }) ?? throw new InvalidOperationException("RejectInTicket returned null task.")); Assert.DoesNotThrowAsync(async () => await task); @@ -610,6 +641,7 @@ private static IRenderedComponent RenderRejectInterfacePop BunitContext context, ModellingConnectionHandler handler, bool allowAdminReject = false, + FwoOwner? requestingApp = null, Action? displayChanged = null, Func? refreshParent = null, Action? messageSink = null) @@ -630,6 +662,7 @@ private static IRenderedComponent RenderRejectInterfacePop popupBuilder.AddAttribute(3, "ConnHandler", handler); popupBuilder.AddAttribute(4, "RefreshParent", refreshParent ?? (() => Task.CompletedTask)); popupBuilder.AddAttribute(5, "AllowAdminReject", allowAdminReject); + popupBuilder.AddAttribute(6, "RequestingApp", requestingApp); popupBuilder.CloseComponent(); })); childBuilder.CloseComponent(); @@ -815,7 +848,6 @@ private sealed class RejectInterfacePopupTestApiConn : SimulatedApiConnection { public int UpdateConnectionPropertiesCalls { get; private set; } public int RemoveSelectedConnectionCalls { get; private set; } - public override Task SendQueryAsync(string query, object? variables = null, string? operationName = null, QueryChunkingOptions? chunkingOptions = null) { if (query == ModellingQueries.updateConnectionProperties) diff --git a/roles/tests-unit/files/FWO.Test/UiSettingsModellingTest.cs b/roles/tests-unit/files/FWO.Test/UiSettingsModellingTest.cs index 1ea5467412..c1c406b664 100644 --- a/roles/tests-unit/files/FWO.Test/UiSettingsModellingTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiSettingsModellingTest.cs @@ -1,4 +1,5 @@ using Bunit; +using AngleSharp.Dom; using FWO.Api.Client; using FWO.Api.Client.Queries; using FWO.Basics; @@ -533,6 +534,41 @@ public async Task SettingsModelling_InitializesLoadedConfig_ForPrivilegedUser() }); } + [Test] + public async Task SettingsModelling_RendersPredefinedServicesLabelAndAction() + { + SimulatedGlobalConfig globalConfig = CreateLoadedGlobalConfig(); + RecordingSettingsApiConn apiConnection = new() + { + IpProtocols = [], + ModellingGroups = [] + }; + SimulatedUserConfig userConfig = CreateUserConfig(Roles.Admin); + + await using BunitContext context = CreateContext(globalConfig, apiConnection, userConfig); + IRenderedComponent wrapper = RenderComponent(context); + + wrapper.WaitForAssertion(() => + { + IRenderedComponent page = wrapper.FindComponent(); + Assert.That(page.Find("#cbx_allow_server_in_conn"), Is.Not.Null); + }); + + IRenderedComponent component = wrapper.FindComponent(); + IElement predefinedServicesLabel = component.Find("div.form-group label"); + IElement predefinedServicesButton = component.Find("div.form-group button"); + + Assert.Multiple(() => + { + Assert.That(predefinedServicesLabel.TextContent.Trim(), Is.EqualTo("Predefined Services:")); + Assert.That(predefinedServicesButton, Is.Not.Null); + }); + + predefinedServicesButton.Click(); + + Assert.That(GetPrivateField(component.Instance, "predefServices"), Is.True); + } + [Test] public async Task SettingsModelling_RendersLoadingAndReportsInitErrors_WhenConfigLoadFails() { @@ -616,6 +652,7 @@ private static BunitContext CreateContext(SimulatedGlobalConfig globalConfig, Ap BunitContext context = new(); context.JSInterop.Mode = JSRuntimeMode.Loose; context.Services.AddAuthorizationCore(); + context.Services.AddLocalization(); context.Services.AddSingleton(); context.Services.AddSingleton(new AllowAllAuthStateProvider(Roles.Admin)); context.Services.AddSingleton(); diff --git a/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorRequestedInterfaces.razor b/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorRequestedInterfaces.razor index 9b4a39a770..999fc8e4b4 100644 --- a/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorRequestedInterfaces.razor +++ b/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorRequestedInterfaces.razor @@ -153,7 +153,7 @@ else } - + @@ -212,6 +212,7 @@ else private ModellingConnectionHandler? DisplayConnHandler { get; set; } private bool ShowDisplayPopup { get; set; } = false; private ModellingConnectionHandler? RejectConnHandler { get; set; } + private FwoOwner? RejectRequestingApp { get; set; } private bool ShowRejectPopup { get; set; } = false; private bool ShowOrphanedTicketsPopup { get; set; } = false; private bool ConfirmRejectRemovedTickets { get; set; } = false; @@ -575,6 +576,7 @@ else private async Task RejectInterface(ModellingConnection connection) { + RejectRequestingApp = GetRequestingApp(connection); FwoOwner? application = connection.App; if ((application == null || application.Id <= 0) && connection.AppId != null && OwnersById.TryGetValue(connection.AppId.Value, out FwoOwner? resolvedOwner)) diff --git a/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor b/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor index 6532321930..c95872c66d 100644 --- a/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor +++ b/roles/ui/files/FWO.UI/Pages/NetworkModelling/RejectInterfacePopup.razor @@ -1,5 +1,7 @@ @using FWO.Middleware.Client @using FWO.Data +@using FWO.Api.Client.Queries +@using FWO.Data.Workflow @using FWO.Compliance @@ -66,10 +68,14 @@ [Parameter] public bool AllowAdminReject { get; set; } = false; + [Parameter] + public FwoOwner? RequestingApp { get; set; } + private string Reason { get; set; } = ""; private string Message { get; set; } = ""; private bool WorkInProgress = false; private bool firstTry = true; + private FwoOwner? resolvedRequestingApp; protected override void OnParametersSet() @@ -96,6 +102,8 @@ WorkInProgress = true; try { + await ResolveRequestingApp(); + NotificationPlaceholderData placeholderData = BuildNotificationPlaceholderData(); await ConnHandler.RefreshActConn(); long? ticketId = ConnHandler.ActConn.TicketId; ConnHandler.ActConn.AddProperty(ConState.Rejected.ToString()); @@ -107,7 +115,7 @@ return; } await ConnHandler.RemoveFromAllSelections(); - await RejectInTicket(ticketId); + await RejectInTicket(ticketId, placeholderData); await RefreshParent(); Close(); } @@ -122,13 +130,13 @@ } } - private async Task RejectInTicket(long? ticketId) + private async Task RejectInTicket(long? ticketId, NotificationPlaceholderData? placeholderData = null) { if(ConnHandler != null && ticketId != null) { TicketCreator ticketCreator = new(apiConnection, userConfig, authenticationStateTask!.Result.User, middlewareClient, WorkflowPhases.implementation, new ComplianceRequestedRulePolicyChecker(userConfig, apiConnection, middlewareClient)); if(await ticketCreator.PromoteNewInterfaceImplTask(ticketId.Value, ExtStates.Rejected, Reason, - BuildNotificationPlaceholderData())) + placeholderData ?? BuildNotificationPlaceholderData())) { DisplayMessageInUi(null, userConfig.GetText("reject_interface"), userConfig.GetText("U9018"), false); } @@ -143,8 +151,8 @@ : $"{userConfig.UiHostName}/{PageName.Modelling}/{ConnHandler.Application.ExtAppId}/{ConnHandler.ActConn.Id}"; return new NotificationPlaceholderData { - RequestingAppName = ConnHandler?.ActConn.App?.Name ?? "", - RequestingAppId = ConnHandler?.ActConn.App?.ExtAppId ?? "", + RequestingAppName = (RequestingApp ?? resolvedRequestingApp)?.Name ?? "", + RequestingAppId = (RequestingApp ?? resolvedRequestingApp)?.ExtAppId ?? "", InterfaceName = interfaceName, InterfaceLinkText = userConfig.GetText("interface"), InterfaceLinkName = interfaceName, @@ -155,10 +163,36 @@ }; } + private async Task ResolveRequestingApp() + { + ModellingConnectionHandler? handler = ConnHandler; + if (RequestingApp != null || resolvedRequestingApp != null || handler?.ActConn.TicketId is not long ticketId) + { + return; + } + + try + { + WfTicket ticket = await apiConnection.SendQueryAsync(RequestQueries.getTicketById, new { id = ticketId }); + WfReqTask? requestTask = ticket.Tasks.FirstOrDefault(task => + task.GetAddInfoIntValueOrZero(AdditionalInfoKeys.ConnId) == handler.ActConn.Id); + int requestingAppId = requestTask?.GetAddInfoIntValueOrZero(AdditionalInfoKeys.ReqOwner) ?? 0; + if (requestingAppId > 0) + { + resolvedRequestingApp = await apiConnection.SendQueryAsync(OwnerQueries.getOwnerById, new { id = requestingAppId }); + } + } + catch + { + resolvedRequestingApp = null; + } + } + private void Close() { Display = false; firstTry = true; + resolvedRequestingApp = null; Reason = ""; Message = ""; DisplayChanged.InvokeAsync(Display); diff --git a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModelling.razor b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModelling.razor index 4a430eecf6..538455df34 100644 --- a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModelling.razor +++ b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModelling.razor @@ -26,10 +26,14 @@ @if(configData != null && initComplete) {
      - +
      + +
      + +
      +
      diff --git a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor index 57f1ce7cfe..710fb4ca98 100644 --- a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor +++ b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor @@ -24,14 +24,29 @@
      -
      +
      -
      +
      +
      + + + + + + + + +
      +
      @@ -51,19 +66,6 @@ DeadlineFilter="NotificationDeadline.None" />
      -
      - - - - - - - - } else { From ab1c8cff659079c9edbf4a8ff093b9aaea9c7e3a Mon Sep 17 00:00:00 2001 From: abarz722 Date: Wed, 9 Sep 2026 13:15:27 +0200 Subject: [PATCH 14/48] fixes + refinements --- .../modelling/addSelectedConnection.graphql | 14 +++++--- roles/database/files/upgrade/9.5.5.sql | 6 ++-- roles/lib/files/FWO.Data/FwoNotification.cs | 7 ++-- .../files/FWO.Data/NotificationLogEntry.cs | 1 + ...odellingConnectionHandlerInterfHandling.cs | 7 +++- .../Jobs/DailyCheckJob.cs | 19 +++++++--- .../NotificationService.cs | 20 ++++++++--- ...ellingConnectionHandlerDecommissionTest.cs | 2 +- .../FWO.Test/NotificationLogEntryTest.cs | 35 +++++++++++++++++++ .../files/FWO.Test/NotificationTest.cs | 6 ++++ .../files/FWO.Test/UiConnectionTableTest.cs | 20 +++++++++++ .../UiSettingsModellingNotificationsTest.cs | 2 +- .../NetworkModelling/SearchInterface.razor | 7 +++- .../SettingsModellingNotifications.razor | 7 ++-- .../files/FWO.UI/Shared/ConnectionTable.razor | 6 ++-- .../FWO.UI/Shared/EditNotifications.razor | 4 +-- 16 files changed, 134 insertions(+), 29 deletions(-) create mode 100644 roles/tests-unit/files/FWO.Test/NotificationLogEntryTest.cs diff --git a/roles/common/files/fwo-api-calls/modelling/addSelectedConnection.graphql b/roles/common/files/fwo-api-calls/modelling/addSelectedConnection.graphql index a137d7b71f..b5aa77e8b3 100644 --- a/roles/common/files/fwo-api-calls/modelling/addSelectedConnection.graphql +++ b/roles/common/files/fwo-api-calls/modelling/addSelectedConnection.graphql @@ -2,10 +2,16 @@ mutation addSelectedConnection( $appId: Int! $connectionId: Int! ) { - insert_modelling_selected_connections(objects: { - app_id: $appId - connection_id: $connectionId - }) { + insert_modelling_selected_connections( + objects: { + app_id: $appId + connection_id: $connectionId + } + on_conflict: { + constraint: selected_connections_pkey + update_columns: [] + } + ) { returning { insertedId: connection_id } diff --git a/roles/database/files/upgrade/9.5.5.sql b/roles/database/files/upgrade/9.5.5.sql index 78b4983898..e032705dd4 100644 --- a/roles/database/files/upgrade/9.5.5.sql +++ b/roles/database/files/upgrade/9.5.5.sql @@ -146,7 +146,7 @@ decomm_notification_seed AS ( SELECT COUNT(*) AS notification_count FROM notification - WHERE notification_client = 'AppDecomm' + WHERE notification_client = 'InterfaceDecomm' AND COALESCE(deadline, 'None') = 'None' ), insert_decomm_notification AS @@ -174,7 +174,7 @@ insert_decomm_notification AS repetitions_after_deadline ) SELECT - 'AppDecomm', + 'InterfaceDecomm', 'Interface decommissioned', 'Email', CASE @@ -225,7 +225,7 @@ update_decomm_subject_bodies AS END FROM decomm_config CROSS JOIN decomm_notification_seed - WHERE n.notification_client = 'AppDecomm' + WHERE n.notification_client = 'InterfaceDecomm' AND COALESCE(n.deadline, 'None') = 'None' AND decomm_notification_seed.notification_count > 0 RETURNING 1 diff --git a/roles/lib/files/FWO.Data/FwoNotification.cs b/roles/lib/files/FWO.Data/FwoNotification.cs index 96fa9451d1..228cfbde18 100644 --- a/roles/lib/files/FWO.Data/FwoNotification.cs +++ b/roles/lib/files/FWO.Data/FwoNotification.cs @@ -13,7 +13,8 @@ public enum NotificationClient RuleTimer = 5, AppDecomm = 6, Report = 7, - WfAction = 8 + WfAction = 8, + InterfaceDecomm = 9 } public static class NotificationClientGroups @@ -28,7 +29,8 @@ public static bool IsModellingRecipientClient(this NotificationClient client) return client is NotificationClient.Recertification or NotificationClient.InterfaceRequest or NotificationClient.RuleTimer - or NotificationClient.AppDecomm; + or NotificationClient.AppDecomm + or NotificationClient.InterfaceDecomm; } /// @@ -234,6 +236,7 @@ public static List OfferedDeadlineOptions(NotificationClie NotificationClient.RuleTimer => [NotificationDeadline.RuleExpiry], NotificationClient.InterfaceRequest => [NotificationDeadline.None, NotificationDeadline.RequestDate], NotificationClient.AppDecomm => [NotificationDeadline.None, NotificationDeadline.DecommissionDate], + NotificationClient.InterfaceDecomm => [NotificationDeadline.None], NotificationClient.WfAction => [NotificationDeadline.None], _ => Enum.GetValues(typeof(NotificationDeadline)).Cast().ToList() }; diff --git a/roles/lib/files/FWO.Data/NotificationLogEntry.cs b/roles/lib/files/FWO.Data/NotificationLogEntry.cs index 72d2e17b8a..bd448d43c4 100644 --- a/roles/lib/files/FWO.Data/NotificationLogEntry.cs +++ b/roles/lib/files/FWO.Data/NotificationLogEntry.cs @@ -30,6 +30,7 @@ public class NotificationLogEntry public string Subject { get; set; } = ""; [JsonProperty("deadline_type"), JsonPropertyName("deadline_type")] + [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))] public NotificationDeadline DeadlineType { get; set; } = NotificationDeadline.None; [JsonProperty("deadline"), JsonPropertyName("deadline")] diff --git a/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs b/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs index 3f3df125ed..ff29eafb1e 100644 --- a/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs +++ b/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs @@ -151,7 +151,7 @@ protected virtual async Task NotifyUsers(List appsToNotify, string rea private async Task> LoadImmediateDecommissionNotifications() { List notifications = await apiConnection.SendQueryAsync>(NotificationQueries.getNotifications, - new { client = NotificationClient.AppDecomm.ToString() }); + new { client = NotificationClient.InterfaceDecomm.ToString() }); return notifications.Where(notification => notification.Deadline == NotificationDeadline.None).ToList(); } @@ -613,6 +613,11 @@ private async Task AddToPreselectedList(ModellingConnection? requestedInterface) { if (requestedInterface != null) { + if (PreselectedInterfaces.Any(selected => selected.Id == requestedInterface.Id)) + { + return; + } + var Variables = new { appId = requestedInterface.AppId, diff --git a/roles/middleware/files/FWO.Middleware.Server/Jobs/DailyCheckJob.cs b/roles/middleware/files/FWO.Middleware.Server/Jobs/DailyCheckJob.cs index dce98e2594..abc3992f1b 100644 --- a/roles/middleware/files/FWO.Middleware.Server/Jobs/DailyCheckJob.cs +++ b/roles/middleware/files/FWO.Middleware.Server/Jobs/DailyCheckJob.cs @@ -274,7 +274,13 @@ private async Task CheckUnansweredInterfaceRequests() continue; } - int sentForTicket = await notificationService.SendNotification(notification, owner, await PrepareBody(notification, ticket, owner)); + NotificationPlaceholderResolver.NotificationPlaceholderValues placeholderValues = + await BuildRequestPlaceholderValues(ticket, owner); + int sentForTicket = await notificationService.SendNotification( + notification, + owner, + resolvedDeadline: ticket.CreationDate, + placeholderValues: placeholderValues); emailsSent += sentForTicket; if (sentForTicket == 0) { @@ -321,13 +327,19 @@ private static long GetMaximumCutOffPeriod(SchedulerInterval interval) } private async Task PrepareBody(FwoNotification notification, WfTicket ticket, FwoOwner owner) + { + NotificationPlaceholderResolver.NotificationPlaceholderValues values = await BuildRequestPlaceholderValues(ticket, owner); + return NotificationPlaceholderResolver.ReplaceNotificationPlaceholders(notification.EmailBody, values, renderHtmlLinks: true); + } + + private async Task BuildRequestPlaceholderValues(WfTicket ticket, FwoOwner owner) { WfReqTask? reqTask = ticket.Tasks.FirstOrDefault(r => r.TaskType == WfTaskType.new_interface.ToString()); FwoOwner? requestingOwner = await GetRequestingOwner(reqTask?.GetAddInfoIntValue(AdditionalInfoKeys.ReqOwner)); FwoOwner effectiveRequestingOwner = requestingOwner ?? new FwoOwner(); string interfaceName = reqTask?.Title ?? globalConfig.GetText("interface"); string interfaceUrl = ConstructLink(owner, reqTask); - NotificationPlaceholderResolver.NotificationPlaceholderValues requestPlaceholderValues = new() + return new NotificationPlaceholderResolver.NotificationPlaceholderValues { Application = owner, RequestingOwner = effectiveRequestingOwner, @@ -337,12 +349,11 @@ private async Task PrepareBody(FwoNotification notification, WfTicket ti NewInterfaceName = interfaceName, NewInterfaceLinkText = globalConfig.GetText("request_interface"), NewInterfaceLinkUrl = interfaceUrl, - Reason = "", + Reason = reqTask?.Reason ?? ticket.Reason ?? "", UserName = ticket.Requester?.Name ?? "", RequesterName = ticket.Requester?.Name ?? ticket.RequesterDn ?? "", RequestDate = ticket.CreationDate.ToString("dd.MM.yyyy") }; - return NotificationPlaceholderResolver.ReplaceNotificationPlaceholders(notification.EmailBody, requestPlaceholderValues, renderHtmlLinks: true); } private async Task GetRequestingOwner(int? ownerId) diff --git a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs index 6077716b4e..b31f9327bd 100644 --- a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs +++ b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs @@ -118,12 +118,14 @@ public async Task SendNotificationsIfDue(FwoOwner? owner, DateTime? extDead /// Optional report to be sent as attachment. /// Optional resolved time interval text for placeholder replacement. /// Resolved deadline timestamp used for notification logging. + /// Optional caller-provided values for notification placeholder replacement. /// number of emails sent public async Task SendNotification(FwoNotification notification, FwoOwner? owner, string? content = null, ReportBase? report = null, - string timeIntervalText = "", DateTime? resolvedDeadline = null) + string timeIntervalText = "", DateTime? resolvedDeadline = null, + NotificationPlaceholderResolver.NotificationPlaceholderValues? placeholderValues = null) { // Later: Handle other channels here when implemented - bool sent = await SendEmail(notification, content, owner, report, timeIntervalText, resolvedDeadline); + bool sent = await SendEmail(notification, content, owner, report, timeIntervalText, resolvedDeadline, placeholderValues); if (!sent) { return 0; @@ -300,11 +302,13 @@ private static async Task> LoadOwnerGroups(List? connected /// Optional report attachment. /// Optional resolved time interval text. /// Resolved deadline timestamp used for notification logging. + /// Optional caller-provided values for notification placeholder replacement. /// True when an email was sent; otherwise false. private async Task SendEmail(FwoNotification notification, string? content, FwoOwner? owner, ReportBase? report = null, - string timeIntervalText = "", DateTime? resolvedDeadline = null) + string timeIntervalText = "", DateTime? resolvedDeadline = null, + NotificationPlaceholderResolver.NotificationPlaceholderValues? placeholderValues = null) { - MailData? mail = await PrepareEmail(notification, content, owner, report, timeIntervalText); + MailData? mail = await PrepareEmail(notification, content, owner, report, timeIntervalText, placeholderValues); if (mail.To.Count == 0 && mail.Cc.Count == 0 && mail.Bcc.Count == 0) { Log.WriteWarning("Notifications", @@ -359,10 +363,16 @@ private async Task SendBundledEmail(List notifications, s return true; } - private async Task PrepareEmail(FwoNotification notification, string? content, FwoOwner? owner, ReportBase? report = null, string timeIntervalText = "") + private async Task PrepareEmail(FwoNotification notification, string? content, FwoOwner? owner, ReportBase? report = null, + string timeIntervalText = "", NotificationPlaceholderResolver.NotificationPlaceholderValues? placeholderValues = null) { string subject = NotificationPlaceholderResolver.ReplaceOwnerPlaceholders(notification.EmailSubject ?? "", owner, timeIntervalText); string body = NotificationPlaceholderResolver.ReplaceOwnerPlaceholders(NotificationEmailLayoutHelper.BuildBody(notification, content), owner, timeIntervalText); + if (placeholderValues != null) + { + subject = NotificationPlaceholderResolver.ReplaceNotificationPlaceholders(subject, placeholderValues); + body = NotificationPlaceholderResolver.ReplaceNotificationPlaceholders(body, placeholderValues, renderHtmlLinks: true); + } FormFile? attachment = report != null ? await BuildAttachment(notification, report, subject) : null; EmailHelper? emailHelper = GlobalConfig.UseDummyEmailAddress ? null : await CreateEmailHelper(); if (report != null && notification.Layout == NotificationLayout.HtmlInBody) diff --git a/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerDecommissionTest.cs b/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerDecommissionTest.cs index d909f8ab56..d0ad1668e2 100644 --- a/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerDecommissionTest.cs +++ b/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerDecommissionTest.cs @@ -48,7 +48,7 @@ public async Task DecommissionInterface_NotifiesAndAddsPermissionsAndSelections( FwoNotification notification = new() { - NotificationClient = NotificationClient.AppDecomm, + NotificationClient = NotificationClient.InterfaceDecomm, Deadline = NotificationDeadline.None, Layout = NotificationLayout.HtmlInBody, RecipientTo = EmailRecipientOption.OwnerMainResponsible, diff --git a/roles/tests-unit/files/FWO.Test/NotificationLogEntryTest.cs b/roles/tests-unit/files/FWO.Test/NotificationLogEntryTest.cs new file mode 100644 index 0000000000..263af363cd --- /dev/null +++ b/roles/tests-unit/files/FWO.Test/NotificationLogEntryTest.cs @@ -0,0 +1,35 @@ +using FWO.Data; +using Newtonsoft.Json; +using NUnit.Framework; + +namespace FWO.Test +{ + [TestFixture] + internal class NotificationLogEntryTest + { + [TestCase("None", NotificationDeadline.None)] + [TestCase("RecertDate", NotificationDeadline.RecertDate)] + [TestCase("RequestDate", NotificationDeadline.RequestDate)] + [TestCase("RuleExpiry", NotificationDeadline.RuleExpiry)] + [TestCase("DecommissionDate", NotificationDeadline.DecommissionDate)] + public void DeserializeDeadlineType_ReadsDatabaseEnumValue(string value, NotificationDeadline expected) + { + NotificationLogEntry? entry = JsonConvert.DeserializeObject( + $"{{\"deadline_type\":\"{value}\"}}"); + + Assert.That(entry, Is.Not.Null); + Assert.That(entry!.DeadlineType, Is.EqualTo(expected)); + } + + [Test] + public void SerializeDeadlineType_WritesDatabaseEnumValue() + { + string json = JsonConvert.SerializeObject(new NotificationLogEntry + { + DeadlineType = NotificationDeadline.RequestDate + }); + + Assert.That(json, Does.Contain("\"deadline_type\":\"RequestDate\"")); + } + } +} diff --git a/roles/tests-unit/files/FWO.Test/NotificationTest.cs b/roles/tests-unit/files/FWO.Test/NotificationTest.cs index 17922ec979..0790751cb3 100644 --- a/roles/tests-unit/files/FWO.Test/NotificationTest.cs +++ b/roles/tests-unit/files/FWO.Test/NotificationTest.cs @@ -789,6 +789,12 @@ public void OfferedDeadlineOptions_ReturnsNoneAndRequestDate_ForInterfaceRequest CollectionAssert.AreEqual(kInterfaceRequestDeadlines, FwoNotification.OfferedDeadlineOptions(NotificationClient.InterfaceRequest)); } + [Test] + public void OfferedDeadlineOptions_ReturnsOnlyNone_ForInterfaceDecomm() + { + CollectionAssert.AreEqual(kNoneDeadline, FwoNotification.OfferedDeadlineOptions(NotificationClient.InterfaceDecomm)); + } + [Test] public void NotificationClientGroups_ClassifiesWfActionAsWorkflowRecipientClient() { diff --git a/roles/tests-unit/files/FWO.Test/UiConnectionTableTest.cs b/roles/tests-unit/files/FWO.Test/UiConnectionTableTest.cs index d047f11e49..5207462c35 100644 --- a/roles/tests-unit/files/FWO.Test/UiConnectionTableTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiConnectionTableTest.cs @@ -1,6 +1,7 @@ using FWO.Data; using FWO.Data.Modelling; using FWO.Config.Api; +using FWO.Basics; using FWO.Ui.Shared; using NUnit.Framework; using System.Collections.Generic; @@ -494,5 +495,24 @@ public void IsVisibleToOwner_ReturnsTrue_ForPermittedOwnerWrapper() Assert.That(result, Is.True); } + + [Test] + public void IsVisibleToOwner_ReturnsFalse_WhenInterfaceOwnerIsMissing() + { + ConnectionTable table = new(); + SetComponentParameter(table, nameof(ConnectionTable.Application), new FwoOwner { Id = 1 }); + + ModellingConnection conn = new() + { + InterfacePermission = InterfacePermissions.Restricted.ToString(), + App = null! + }; + + MethodInfo isVisibleToOwner = GetInstanceMethod("IsVisibleToOwner", typeof(ModellingConnection)); + bool result = (bool)isVisibleToOwner.Invoke(table, [conn])!; + + Assert.That(result, Is.False); + } + } } diff --git a/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs b/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs index 9f73d01bd2..9b79768134 100644 --- a/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiSettingsModellingNotificationsTest.cs @@ -44,7 +44,7 @@ public async Task Page_RendersThreeNotificationEditorsWithExpectedSections() Assert.That(editors[0].Instance.DeadlineFilter, Is.EqualTo(NotificationDeadline.None)); Assert.That(editors[1].Instance.Client, Is.EqualTo(NotificationClient.InterfaceRequest)); Assert.That(editors[1].Instance.DeadlineFilter, Is.EqualTo(NotificationDeadline.RequestDate)); - Assert.That(editors[2].Instance.Client, Is.EqualTo(NotificationClient.AppDecomm)); + Assert.That(editors[2].Instance.Client, Is.EqualTo(NotificationClient.InterfaceDecomm)); Assert.That(editors[2].Instance.DeadlineFilter, Is.EqualTo(NotificationDeadline.None)); }); } diff --git a/roles/ui/files/FWO.UI/Pages/NetworkModelling/SearchInterface.razor b/roles/ui/files/FWO.UI/Pages/NetworkModelling/SearchInterface.razor index de83d002b2..ed6f9ac857 100644 --- a/roles/ui/files/FWO.UI/Pages/NetworkModelling/SearchInterface.razor +++ b/roles/ui/files/FWO.UI/Pages/NetworkModelling/SearchInterface.razor @@ -111,6 +111,11 @@ foreach (ModellingConnection @interface in SelectedInterfaces) { + if (PreselectedInterfaces.Any(selected => selected.Id == @interface.Id)) + { + continue; + } + var Variables = new { appId = Application.Id, @@ -118,7 +123,7 @@ }; await apiConnection.SendQueryAsync(ModellingQueries.addSelectedConnection, Variables); - PreselectedInterfaces.Add(@interface ?? throw new ArgumentException("No Interface selected.")); + PreselectedInterfaces.Add(@interface); } RefreshSelectionList(); diff --git a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor index 710fb4ca98..ed3a61134c 100644 --- a/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor +++ b/roles/ui/files/FWO.UI/Pages/Settings/SettingsModellingNotifications.razor @@ -19,7 +19,7 @@ @if (configData != null && initComplete) {
      -

      @(userConfig.GetText("initial_request"))

      +

      @(userConfig.GetText("request_interface"))

      @@ -47,6 +47,7 @@
      +

      @(userConfig.GetText("initial_request"))

      @@ -59,10 +60,10 @@
      -

      @(userConfig.GetText("decomm_owner"))

      +

      @(userConfig.GetText("decomm_interface"))

      -
      diff --git a/roles/ui/files/FWO.UI/Shared/ConnectionTable.razor b/roles/ui/files/FWO.UI/Shared/ConnectionTable.razor index df035b99b4..3a9d8fbc24 100644 --- a/roles/ui/files/FWO.UI/Shared/ConnectionTable.razor +++ b/roles/ui/files/FWO.UI/Shared/ConnectionTable.razor @@ -318,7 +318,8 @@ private bool IsVisibleToOwner(ModellingConnection interf) { - if(interf.InterfacePermission == InterfacePermissions.Public.ToString() || interf.App.Id == Application.Id) + if(interf.InterfacePermission == InterfacePermissions.Public.ToString() + || (interf.App != null && Application != null && interf.App.Id == Application.Id)) { return true; } @@ -326,7 +327,8 @@ { return false; } - return interf.PermittedOwnerWrappers.Any(wrapper => wrapper.Owner != null && wrapper.Owner.Id == Application.Id); + return interf.PermittedOwnerWrappers?.Any(wrapper => + wrapper.Owner != null && Application != null && wrapper.Owner.Id == Application.Id) == true; } private List CollectModellingProps(ModellingConnection connection) diff --git a/roles/ui/files/FWO.UI/Shared/EditNotifications.razor b/roles/ui/files/FWO.UI/Shared/EditNotifications.razor index 790c2d8596..09ee9e78be 100644 --- a/roles/ui/files/FWO.UI/Shared/EditNotifications.razor +++ b/roles/ui/files/FWO.UI/Shared/EditNotifications.razor @@ -329,7 +329,7 @@ ToRecipientSelection = CreateDefaultToSelection(); CcRecipientSelection = CreateDefaultSelectionForRecipient(actNotification.RecipientCc); BccRecipientSelection = CreateDefaultSelectionForRecipient(actNotification.RecipientBcc); - if(Client == NotificationClient.RuleTimer || Client == NotificationClient.AppDecomm) + if (OfferedLayoutOptions().Contains(NotificationLayout.HtmlInBody)) { actNotification.Layout = NotificationLayout.HtmlInBody; } @@ -622,7 +622,7 @@ private List OfferedLayoutOptions() { - if(Client == NotificationClient.InterfaceRequest || Client == NotificationClient.RuleTimer || Client == NotificationClient.AppDecomm) + if(Client == NotificationClient.InterfaceRequest || Client == NotificationClient.RuleTimer || Client == NotificationClient.AppDecomm || Client == NotificationClient.InterfaceDecomm) { return NotificationLayoutGroups.WithoutAttachments().ToList(); } From e9b416e557a47f22d646351dfc0f4324095857ca Mon Sep 17 00:00:00 2001 From: abarz722 Date: Wed, 9 Sep 2026 15:53:32 +0200 Subject: [PATCH 15/48] enhance notification log --- roles/api/files/replace_metadata.json | 71 +++++++++- .../monitor/getNotificationLogEntrys.graphql | 3 + .../insertNotificationLog.graphql | 3 + .../updateNotificationLog.graphql | 8 ++ .../creation/fworch-create-tables-base.sql | 5 +- .../files/sql/idempotent/fworch-texts.sql | 4 +- roles/database/files/upgrade/9.5.5.sql | 5 +- .../Queries/NotificationQueries.cs | 2 + .../files/FWO.Data/NotificationLogEntry.cs | 46 ++++++ .../EmailNotification/EmailHelper.cs | 50 +++++-- .../NotificationLogHelper.cs | 15 +- .../NotificationService.cs | 43 ++++-- .../files/FWO.Test/ActionHandlerTest.cs | 9 +- .../files/FWO.Test/DailyCheckJobTest.cs | 14 ++ .../FWO.Test/EmailHelperRecipientTest.cs | 134 +++++++++++++++++- .../FWO.Test/NotificationLogEntryTest.cs | 11 ++ .../files/FWO.Test/NotificationTest.cs | 17 +-- .../files/FWO.Test/NotificationTestApiConn.cs | 11 +- .../files/FWO.Test/RuleExpiryCheckTest.cs | 14 ++ .../Pages/Monitoring/MonitorEmailLog.razor | 2 + 20 files changed, 421 insertions(+), 46 deletions(-) create mode 100644 roles/common/files/fwo-api-calls/notification_log/updateNotificationLog.graphql diff --git a/roles/api/files/replace_metadata.json b/roles/api/files/replace_metadata.json index 3194b4cb51..eac24b63ca 100644 --- a/roles/api/files/replace_metadata.json +++ b/roles/api/files/replace_metadata.json @@ -13539,7 +13539,9 @@ "bcc", "subject", "deadline_type", - "deadline" + "deadline", + "status", + "error" ] }, "comment": "" @@ -13557,7 +13559,9 @@ "bcc", "subject", "deadline_type", - "deadline" + "deadline", + "status", + "error" ] }, "comment": "" @@ -13575,17 +13579,49 @@ "bcc", "subject", "deadline_type", - "deadline" + "deadline", + "status", + "error" ] }, "comment": "" } ], + "update_permissions": [ + { + "role": "fw-admin", + "permission": { + "columns": ["status", "error"], + "filter": {}, + "check": {} + }, + "comment": "" + }, + { + "role": "middleware-server", + "permission": { + "columns": ["status", "error"], + "filter": {}, + "check": {} + }, + "comment": "" + }, + { + "role": "modeller", + "permission": { + "columns": ["status", "error"], + "filter": {}, + "check": {} + }, + "comment": "" + } + ], "select_permissions": [ { "role": "auditor", "permission": { "columns": [ + "id", "timestamp", "notification_id", "notification_type", @@ -13594,7 +13630,9 @@ "bcc", "subject", "deadline_type", - "deadline" + "deadline", + "status", + "error" ], "filter": {} }, @@ -13604,6 +13642,7 @@ "role": "fw-admin", "permission": { "columns": [ + "id", "timestamp", "notification_id", "notification_type", @@ -13612,7 +13651,29 @@ "bcc", "subject", "deadline_type", - "deadline" + "deadline", + "status", + "error" + ], + "filter": {} + }, + "comment": "" + }, + { + "role": "middleware-server", + "permission": { + "columns": [ + "id" + ], + "filter": {} + }, + "comment": "" + }, + { + "role": "modeller", + "permission": { + "columns": [ + "id" ], "filter": {} }, diff --git a/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql b/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql index 5ebba9939e..22812412b2 100644 --- a/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql +++ b/roles/common/files/fwo-api-calls/monitor/getNotificationLogEntrys.graphql @@ -1,5 +1,6 @@ query getNotificationLogEntrys { notification_log(order_by: { timestamp: desc }) { + id timestamp notification_id notification_type @@ -9,5 +10,7 @@ query getNotificationLogEntrys { subject deadline_type deadline + status + error } } diff --git a/roles/common/files/fwo-api-calls/notification_log/insertNotificationLog.graphql b/roles/common/files/fwo-api-calls/notification_log/insertNotificationLog.graphql index 092fc77eaf..b8ba01178c 100644 --- a/roles/common/files/fwo-api-calls/notification_log/insertNotificationLog.graphql +++ b/roles/common/files/fwo-api-calls/notification_log/insertNotificationLog.graphql @@ -1,5 +1,8 @@ mutation insertNotificationLog($entries: [notification_log_insert_input!]!) { insert_notification_log(objects: $entries) { affected_rows + returning { + id + } } } diff --git a/roles/common/files/fwo-api-calls/notification_log/updateNotificationLog.graphql b/roles/common/files/fwo-api-calls/notification_log/updateNotificationLog.graphql new file mode 100644 index 0000000000..7d7fb1f6d6 --- /dev/null +++ b/roles/common/files/fwo-api-calls/notification_log/updateNotificationLog.graphql @@ -0,0 +1,8 @@ +mutation updateNotificationLog($id: Int!, $status: String!, $error: String!) { + update_notification_log_by_pk( + pk_columns: { id: $id } + _set: { status: $status, error: $error } + ) { + affected_rows + } +} diff --git a/roles/database/files/sql/creation/fworch-create-tables-base.sql b/roles/database/files/sql/creation/fworch-create-tables-base.sql index 9df3ac46d7..882a55e16a 100755 --- a/roles/database/files/sql/creation/fworch-create-tables-base.sql +++ b/roles/database/files/sql/creation/fworch-create-tables-base.sql @@ -342,6 +342,7 @@ create table notification create table notification_log ( + id SERIAL PRIMARY KEY, "timestamp" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(), notification_id INTEGER NOT NULL, notification_type Varchar NOT NULL, @@ -350,7 +351,9 @@ create table notification_log bcc Varchar NOT NULL DEFAULT '', subject Varchar NOT NULL DEFAULT '', deadline_type Varchar NOT NULL DEFAULT 'None', - deadline TIMESTAMP WITH TIME ZONE + deadline TIMESTAMP WITH TIME ZONE, + status Varchar NOT NULL DEFAULT 'Pending', + error Varchar NOT NULL DEFAULT '' ); -- configuration diff --git a/roles/database/files/sql/idempotent/fworch-texts.sql b/roles/database/files/sql/idempotent/fworch-texts.sql index f41065bfc3..d60437c2c3 100644 --- a/roles/database/files/sql/idempotent/fworch-texts.sql +++ b/roles/database/files/sql/idempotent/fworch-texts.sql @@ -1,4 +1,4 @@ --- text codes (roughly) categorized: +-- text codes (roughly) categorized: -- U: user texts (explanation or confirmation texts) -- E: error texts -- A: Api errors @@ -3743,6 +3743,8 @@ INSERT INTO txt VALUES ('network_area', 'German', 'Netzwerk-Area'); INSERT INTO txt VALUES ('network_area', 'English', 'Network Area'); INSERT INTO txt VALUES ('network_areas', 'German', 'Netzwerk-Areas'); INSERT INTO txt VALUES ('network_areas', 'English', 'Network Areas'); +INSERT INTO txt VALUES ('error', 'German', 'Fehler'); +INSERT INTO txt VALUES ('error', 'English', 'Error'); -- help pages INSERT INTO txt VALUES ('report_types', 'German', 'Report-Typen'); diff --git a/roles/database/files/upgrade/9.5.5.sql b/roles/database/files/upgrade/9.5.5.sql index e032705dd4..485902b2bc 100644 --- a/roles/database/files/upgrade/9.5.5.sql +++ b/roles/database/files/upgrade/9.5.5.sql @@ -120,6 +120,7 @@ WHERE COALESCE(logging, '') = ''; CREATE TABLE IF NOT EXISTS notification_log ( + id SERIAL PRIMARY KEY, "timestamp" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(), notification_id INTEGER NOT NULL, notification_type Varchar NOT NULL, @@ -128,7 +129,9 @@ CREATE TABLE IF NOT EXISTS notification_log bcc Varchar NOT NULL DEFAULT '', subject Varchar NOT NULL DEFAULT '', deadline_type Varchar NOT NULL DEFAULT 'None', - deadline TIMESTAMP WITH TIME ZONE + deadline TIMESTAMP WITH TIME ZONE, + status Varchar NOT NULL DEFAULT 'Pending', + error Varchar NOT NULL DEFAULT '' ); WITH decomm_config AS diff --git a/roles/lib/files/FWO.Api.Client/Queries/NotificationQueries.cs b/roles/lib/files/FWO.Api.Client/Queries/NotificationQueries.cs index 191800d349..c01a67a8c0 100644 --- a/roles/lib/files/FWO.Api.Client/Queries/NotificationQueries.cs +++ b/roles/lib/files/FWO.Api.Client/Queries/NotificationQueries.cs @@ -9,6 +9,7 @@ public class NotificationQueries : Queries public static readonly string updateNotification; public static readonly string updateNotificationsLastSent; public static readonly string insertNotificationLog; + public static readonly string updateNotificationLog; public static readonly string deleteNotification; @@ -22,6 +23,7 @@ static NotificationQueries() updateNotification = File.ReadAllText(QueryPath + "notification/updateNotification.graphql"); updateNotificationsLastSent = File.ReadAllText(QueryPath + "notification/updateNotificationsLastSent.graphql"); insertNotificationLog = File.ReadAllText(QueryPath + "notification_log/insertNotificationLog.graphql"); + updateNotificationLog = File.ReadAllText(QueryPath + "notification_log/updateNotificationLog.graphql"); deleteNotification = File.ReadAllText(QueryPath + "notification/deleteNotification.graphql"); } catch (Exception exception) diff --git a/roles/lib/files/FWO.Data/NotificationLogEntry.cs b/roles/lib/files/FWO.Data/NotificationLogEntry.cs index bd448d43c4..129dca464d 100644 --- a/roles/lib/files/FWO.Data/NotificationLogEntry.cs +++ b/roles/lib/files/FWO.Data/NotificationLogEntry.cs @@ -3,11 +3,22 @@ namespace FWO.Data { + public enum NotificationLogStatus + { + Pending, + Sent, + Failed, + Suppressed + } + /// /// Log entry for a notification send attempt. /// public class NotificationLogEntry { + [JsonProperty("id"), JsonPropertyName("id")] + public int Id { get; set; } + [JsonProperty("timestamp"), JsonPropertyName("timestamp")] public DateTimeOffset Timestamp { get; set; } @@ -35,5 +46,40 @@ public class NotificationLogEntry [JsonProperty("deadline"), JsonPropertyName("deadline")] public DateTimeOffset? Deadline { get; set; } + + [JsonProperty("status"), JsonPropertyName("status")] + [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))] + public NotificationLogStatus Status { get; set; } = NotificationLogStatus.Pending; + + [JsonProperty("error"), JsonPropertyName("error")] + public string Error { get; set; } = ""; + } + + public class NotificationLogInsertEntry + { + [JsonProperty("timestamp"), JsonPropertyName("timestamp")] + public DateTimeOffset Timestamp { get; set; } + [JsonProperty("notification_id"), JsonPropertyName("notification_id")] + public int NotificationId { get; set; } + [JsonProperty("notification_type"), JsonPropertyName("notification_type")] + public string NotificationType { get; set; } = ""; + [JsonProperty("to"), JsonPropertyName("to")] + public string To { get; set; } = ""; + [JsonProperty("cc"), JsonPropertyName("cc")] + public string Cc { get; set; } = ""; + [JsonProperty("bcc"), JsonPropertyName("bcc")] + public string Bcc { get; set; } = ""; + [JsonProperty("subject"), JsonPropertyName("subject")] + public string Subject { get; set; } = ""; + [JsonProperty("deadline_type"), JsonPropertyName("deadline_type")] + [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))] + public NotificationDeadline DeadlineType { get; set; } = NotificationDeadline.None; + [JsonProperty("deadline"), JsonPropertyName("deadline")] + public DateTimeOffset? Deadline { get; set; } + [JsonProperty("status"), JsonPropertyName("status")] + [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))] + public NotificationLogStatus Status { get; set; } = NotificationLogStatus.Pending; + [JsonProperty("error"), JsonPropertyName("error")] + public string Error { get; set; } = ""; } } diff --git a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs index 3831f0939a..d76fdf7ad4 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/EmailHelper.cs @@ -91,14 +91,26 @@ public virtual async Task SendEmailToNotificationRecipients(FwoNotificatio List? bccs = notification.RecipientBcc == EmailRecipientOption.None ? null : await GetNotificationRecipients(notification.RecipientBcc, notification.EmailAddressBcc, owner); - await LogNotificationIfConfigured(notification, tos, ccs, bccs, subject); + int logId = await LogNotificationIfConfigured(notification, tos, ccs, bccs, subject); if (!NotificationLoggingMode.ShouldSend(notification.Logging)) { + await CompleteNotificationLog(logId, NotificationLogStatus.Suppressed); return true; } - return await SendEmail(tos, subject, body, ccs, bccs, notification.Layout == NotificationLayout.HtmlInBody); + try + { + bool sent = await SendEmail(tos, subject, body, ccs, bccs, notification.Layout == NotificationLayout.HtmlInBody); + await CompleteNotificationLog(logId, sent ? NotificationLogStatus.Sent : NotificationLogStatus.Failed, + sent ? "" : "SMTP delivery failed or no To recipients resolved."); + return sent; + } + catch (Exception exception) + { + await CompleteNotificationLog(logId, NotificationLogStatus.Failed, exception.Message); + throw; + } } /// @@ -120,13 +132,25 @@ public async Task SendWorkflowActionEmail(FwoNotification notification, Wf string body = NotificationPlaceholderResolver.ReplaceWorkflowPlaceholders(BuildWorkflowActionBody(notification, workflowContent, placeholderData), placeholderContext, owner, placeholderData, renderHtmlLinks: true); FormFile? attachment = await NotificationEmailLayoutHelper.BuildAttachment(notification.Layout, workflowContent, subject); - await LogNotificationIfConfigured(notification, tos, ccs, bccs, subject); + int logId = await LogNotificationIfConfigured(notification, tos, ccs, bccs, subject); if (!NotificationLoggingMode.ShouldSend(notification.Logging)) { + await CompleteNotificationLog(logId, NotificationLogStatus.Suppressed); return true; } - return await SendEmail(tos, subject, body, ccs, bccs, - notification.Layout == NotificationLayout.HtmlInBody, attachment); + try + { + bool sent = await SendEmail(tos, subject, body, ccs, bccs, + notification.Layout == NotificationLayout.HtmlInBody, attachment); + await CompleteNotificationLog(logId, sent ? NotificationLogStatus.Sent : NotificationLogStatus.Failed, + sent ? "" : "SMTP delivery failed or no To recipients resolved."); + return sent; + } + catch (Exception exception) + { + await CompleteNotificationLog(logId, NotificationLogStatus.Failed, exception.Message); + throw; + } } private static string BuildWorkflowActionBody(FwoNotification notification, WorkflowEmailContent? workflowContent, @@ -140,19 +164,29 @@ private static string BuildWorkflowActionBody(FwoNotification notification, Work return NotificationEmailLayoutHelper.BuildBody(notification, workflowContent); } - private async Task LogNotificationIfConfigured(FwoNotification notification, List tos, List? ccs, + private async Task LogNotificationIfConfigured(FwoNotification notification, List tos, List? ccs, List? bccs, string subject) { if (!NotificationLoggingMode.ShouldLog(notification.Logging)) { - return; + return 0; } List loggedTos = [.. tos]; List? loggedCcs = ccs == null ? null : [.. ccs]; List? loggedBccs = bccs == null ? null : [.. bccs]; ApplyDummyRecipientOverride(ref loggedTos, ref loggedCcs, ref loggedBccs); - await NotificationLogHelper.InsertAsync(apiConnection, notification, loggedTos, loggedCcs, loggedBccs, subject); + return await NotificationLogHelper.InsertAsync(apiConnection, notification, loggedTos, loggedCcs, loggedBccs, subject); + } + + private async Task CompleteNotificationLog(int logId, NotificationLogStatus status, string error = "") + { + if (logId == 0) + { + return; + } + + await NotificationLogHelper.UpdateAsync(apiConnection, logId, status, error); } private async Task> GetWorkflowActionRecipients( diff --git a/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs index 25282d8cb8..fa5533bc7f 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/NotificationLogHelper.cs @@ -19,11 +19,11 @@ public static class NotificationLogHelper /// Resolved Bcc recipients. /// Rendered subject. /// Resolved deadline timestamp. - public static async Task InsertAsync(ApiConnection apiConnection, FwoNotification notification, + public static async Task InsertAsync(ApiConnection apiConnection, FwoNotification notification, IEnumerable tos, IEnumerable? ccs, IEnumerable? bccs, string subject, DateTimeOffset? deadline = null) { - NotificationLogEntry entry = new() + NotificationLogInsertEntry entry = new() { Timestamp = DateTimeOffset.UtcNow, NotificationId = notification.Id, @@ -36,8 +36,15 @@ public static async Task InsertAsync(ApiConnection apiConnection, FwoNotificatio Deadline = deadline }; - await apiConnection.SendQueryAsync(NotificationQueries.insertNotificationLog, - new { entries = new List { entry } }); + ReturnIdWrapper result = await apiConnection.SendQueryAsync(NotificationQueries.insertNotificationLog, + new { entries = new List { entry } }); + return result.ReturnIds?.FirstOrDefault()?.Id is long id ? (int)id : 0; + } + + public static async Task UpdateAsync(ApiConnection apiConnection, int logId, NotificationLogStatus status, string error = "") + { + await apiConnection.SendQueryAsync(NotificationQueries.updateNotificationLog, + new { id = logId, status = status.ToString(), error }); } } } diff --git a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs index b31f9327bd..2c039ae8b3 100644 --- a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs +++ b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs @@ -309,30 +309,51 @@ private async Task SendEmail(FwoNotification notification, string? content NotificationPlaceholderResolver.NotificationPlaceholderValues? placeholderValues = null) { MailData? mail = await PrepareEmail(notification, content, owner, report, timeIntervalText, placeholderValues); + int logId = 0; + if (NotificationLoggingMode.ShouldLog(notification.Logging)) + { + DateTimeOffset? deadline = resolvedDeadline.HasValue ? new DateTimeOffset(resolvedDeadline.Value) : null; + logId = await NotificationLogHelper.InsertAsync(ApiConnection, notification, mail.To, mail.Cc, mail.Bcc, mail.Subject, deadline); + } + if (mail.To.Count == 0 && mail.Cc.Count == 0 && mail.Bcc.Count == 0) { Log.WriteWarning("Notifications", $"No recipients resolved for notification client {notification.NotificationClient} while preparing notification {notification.Id}. Skipping send."); + await CompleteNotificationLog(logId, NotificationLogStatus.Failed, "No recipients resolved."); return false; } - if (NotificationLoggingMode.ShouldLog(notification.Logging)) - { - DateTimeOffset? deadline = resolvedDeadline.HasValue ? new DateTimeOffset(resolvedDeadline.Value) : null; - await NotificationLogHelper.InsertAsync(ApiConnection, notification, mail.To, mail.Cc, mail.Bcc, mail.Subject, deadline); - } - if (!NotificationLoggingMode.ShouldSend(notification.Logging)) { + await CompleteNotificationLog(logId, NotificationLogStatus.Suppressed); return true; } - string decryptedSecret = AesEnc.TryDecrypt(GlobalConfig.EmailPassword, false, "NotificationService", "Could not decrypt mailserver password."); - EmailConnection emailConnection = new(GlobalConfig.EmailServerAddress, GlobalConfig.EmailPort, - GlobalConfig.EmailTls, GlobalConfig.EmailUser, decryptedSecret, GlobalConfig.EmailSenderAddress); + try + { + string decryptedSecret = AesEnc.TryDecrypt(GlobalConfig.EmailPassword, false, "NotificationService", "Could not decrypt mailserver password."); + EmailConnection emailConnection = new(GlobalConfig.EmailServerAddress, GlobalConfig.EmailPort, + GlobalConfig.EmailTls, GlobalConfig.EmailUser, decryptedSecret, GlobalConfig.EmailSenderAddress); + + bool sent = await MailKitMailer.SendAsync(mail, emailConnection, notification.Layout == NotificationLayout.HtmlInBody, new()); + await CompleteNotificationLog(logId, sent ? NotificationLogStatus.Sent : NotificationLogStatus.Failed, + sent ? "" : "SMTP delivery failed."); + return sent; + } + catch (Exception exception) + { + await CompleteNotificationLog(logId, NotificationLogStatus.Failed, exception.Message); + throw; + } + } - await MailKitMailer.SendAsync(mail, emailConnection, notification.Layout == NotificationLayout.HtmlInBody, new()); - return true; + private async Task CompleteNotificationLog(int logId, NotificationLogStatus status, string error = "") + { + if (logId > 0) + { + await NotificationLogHelper.UpdateAsync(ApiConnection, logId, status, error); + } } /// diff --git a/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs b/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs index 85714c2178..501a3f94e2 100644 --- a/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs +++ b/roles/tests-unit/files/FWO.Test/ActionHandlerTest.cs @@ -128,7 +128,14 @@ public override Task SendQueryAsync(string query, object? variables = null } if (query == NotificationQueries.insertNotificationLog) { - return Task.FromResult((T)(object)new object()); + return Task.FromResult((T)(object)new ReturnIdWrapper + { + ReturnIds = [new ReturnId { Id = 1 }] + }); + } + if (query == NotificationQueries.updateNotificationLog) + { + return Task.FromResult((T)(object)new ReturnId { AffectedRows = 1 }); } if (query == OwnerQueries.getOwnerResponsibleTypes) { diff --git a/roles/tests-unit/files/FWO.Test/DailyCheckJobTest.cs b/roles/tests-unit/files/FWO.Test/DailyCheckJobTest.cs index f7339951d9..ad267c5eef 100644 --- a/roles/tests-unit/files/FWO.Test/DailyCheckJobTest.cs +++ b/roles/tests-unit/files/FWO.Test/DailyCheckJobTest.cs @@ -778,6 +778,7 @@ private static FwoNotification CreateInterfaceRequestNotification(int id) { Id = id, NotificationClient = NotificationClient.InterfaceRequest, + Logging = NotificationLoggingMode.LogOnly, RecipientTo = EmailRecipientOption.OtherAddresses, EmailAddressTo = "notify@example.test", EmailSubject = "subject", @@ -925,6 +926,19 @@ public override Task SendQueryAsync(string return Task.FromResult((QueryResponseType)(object)OpenTickets); } + if (query == NotificationQueries.insertNotificationLog && typeof(QueryResponseType) == typeof(ReturnIdWrapper)) + { + return Task.FromResult((QueryResponseType)(object)new ReturnIdWrapper + { + ReturnIds = [new ReturnId { Id = 1 }] + }); + } + + if (query == NotificationQueries.updateNotificationLog && typeof(QueryResponseType) == typeof(ReturnId)) + { + return Task.FromResult((QueryResponseType)(object)new ReturnId { AffectedRows = 1 }); + } + if (query == NotificationQueries.updateNotificationsLastSent && typeof(QueryResponseType) == typeof(ReturnId)) { object vars = variables ?? throw new InvalidOperationException("Update notification variables missing."); diff --git a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs index ef417462d9..a920de384c 100644 --- a/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs +++ b/roles/tests-unit/files/FWO.Test/EmailHelperRecipientTest.cs @@ -208,6 +208,10 @@ public async Task SendEmailToNotificationRecipients_SendAndLog_WritesNotificatio Assert.That(apiConnection.InsertCalls[0].DeadlineType, Is.EqualTo(NotificationDeadline.RequestDate)); Assert.That(apiConnection.InsertCalls[0].Deadline, Is.Null); Assert.That(apiConnection.InsertCalls[0].Timestamp, Is.GreaterThan(DateTimeOffset.UtcNow.AddMinutes(-1))); + Assert.That(apiConnection.UpdateCalls, Is.EqualTo(new List<(int Id, string Status, string Error)> + { + (1, NotificationLogStatus.Sent.ToString(), "") + })); }); } @@ -241,6 +245,90 @@ public async Task SendEmailToNotificationRecipients_LogOnly_WritesNotificationLo Assert.That(apiConnection.InsertCalls, Has.Count.EqualTo(1)); Assert.That(apiConnection.InsertCalls[0].NotificationId, Is.EqualTo(42)); Assert.That(apiConnection.InsertCalls[0].Subject, Is.EqualTo("Rendered subject")); + Assert.That(apiConnection.UpdateCalls, Is.EqualTo(new List<(int Id, string Status, string Error)> + { + (1, NotificationLogStatus.Suppressed.ToString(), "") + })); + }); + } + + [Test] + public async Task SendEmailToNotificationRecipients_MarksLogFailed_WhenMailerReturnsFalse() + { + SimulatedUserConfig userConfig = new() { UseDummyEmailAddress = false }; + RecordingNotificationLogApiConnection apiConnection = new(); + CapturingEmailHelper helper = new(userConfig, apiConnection) { SendResult = false }; + FwoNotification notification = new() + { + Id = 43, + Logging = NotificationLoggingMode.SendAndLog, + RecipientTo = EmailRecipientOption.OtherAddresses, + EmailAddressTo = "to@example.test" + }; + + bool sent = await helper.SendEmailToNotificationRecipients(notification, null, "Subject", "Body"); + + Assert.Multiple(() => + { + Assert.That(sent, Is.False); + Assert.That(apiConnection.InsertCalls, Has.Count.EqualTo(1)); + Assert.That(apiConnection.UpdateCalls, Is.EqualTo(new List<(int Id, string Status, string Error)> + { + (1, NotificationLogStatus.Failed.ToString(), "SMTP delivery failed or no To recipients resolved.") + })); + }); + } + + [Test] + public void SendEmailToNotificationRecipients_MarksLogFailed_WhenMailerThrows() + { + SimulatedUserConfig userConfig = new() { UseDummyEmailAddress = false }; + RecordingNotificationLogApiConnection apiConnection = new(); + CapturingEmailHelper helper = new(userConfig, apiConnection) + { + SendException = new InvalidOperationException("SMTP unavailable") + }; + FwoNotification notification = new() + { + Id = 44, + Logging = NotificationLoggingMode.SendAndLog, + RecipientTo = EmailRecipientOption.OtherAddresses, + EmailAddressTo = "to@example.test" + }; + + Assert.ThrowsAsync(async () => + await helper.SendEmailToNotificationRecipients(notification, null, "Subject", "Body")); + + Assert.That(apiConnection.UpdateCalls, Is.EqualTo(new List<(int Id, string Status, string Error)> + { + (1, NotificationLogStatus.Failed.ToString(), "SMTP unavailable") + })); + } + + [Test] + public async Task SendEmailToNotificationRecipients_MarksLogFailed_WhenNoRecipientsResolve() + { + SimulatedUserConfig userConfig = new() { UseDummyEmailAddress = false }; + RecordingNotificationLogApiConnection apiConnection = new(); + CapturingEmailHelper helper = new(userConfig, apiConnection); + FwoNotification notification = new() + { + Id = 45, + Logging = NotificationLoggingMode.SendAndLog, + RecipientTo = EmailRecipientOption.None + }; + + bool sent = await helper.SendEmailToNotificationRecipients(notification, null, "Subject", "Body"); + + Assert.Multiple(() => + { + Assert.That(sent, Is.False); + Assert.That(helper.SendEmailCallCount, Is.EqualTo(1)); + Assert.That(apiConnection.InsertCalls, Has.Count.EqualTo(1)); + Assert.That(apiConnection.UpdateCalls, Is.EqualTo(new List<(int Id, string Status, string Error)> + { + (1, NotificationLogStatus.Failed.ToString(), "SMTP delivery failed or no To recipients resolved.") + })); }); } @@ -1276,6 +1364,8 @@ public override Task SendQueryAsync(string private sealed class CapturingEmailHelper : EmailHelper { + public bool SendResult { get; set; } = true; + public Exception? SendException { get; set; } public int SendEmailCallCount { get; private set; } public List CapturedTo { get; private set; } = []; public List? CapturedCc { get; private set; } @@ -1300,28 +1390,62 @@ protected override Task SendEmail(List tos, string subject, string CapturedBody = body; CapturedMailFormatHtml = mailFormatHtml; CapturedAttachment = attachment; - return Task.FromResult(true); + if (SendException != null) + { + throw SendException; + } + return Task.FromResult(SendResult && tos.Any(recipient => recipient != "")); } } private sealed class RecordingNotificationLogApiConnection : SimulatedApiConnection { public List InsertCalls { get; } = []; + public List<(int Id, string Status, string Error)> UpdateCalls { get; } = []; public override Task SendQueryAsync(string query, object? variables = null, string? operationName = null, FWO.Api.Client.QueryChunkingOptions? chunkingOptions = null) { - if (query == NotificationQueries.insertNotificationLog && typeof(QueryResponseType) == typeof(object)) + if (query == NotificationQueries.insertNotificationLog && typeof(QueryResponseType) == typeof(ReturnIdWrapper)) { if (variables != null) { PropertyInfo? entriesProperty = variables.GetType().GetProperty("entries"); - if (entriesProperty?.GetValue(variables) is IEnumerable entries) + if (entriesProperty?.GetValue(variables) is IEnumerable entries) { - InsertCalls.AddRange(entries); + InsertCalls.AddRange(entries.Select(entry => new NotificationLogEntry + { + Timestamp = entry.Timestamp, + NotificationId = entry.NotificationId, + NotificationType = entry.NotificationType, + To = entry.To, + Cc = entry.Cc, + Bcc = entry.Bcc, + Subject = entry.Subject, + DeadlineType = entry.DeadlineType, + Deadline = entry.Deadline, + Status = entry.Status, + Error = entry.Error + })); } } - return Task.FromResult((QueryResponseType)(object)new object()); + return Task.FromResult((QueryResponseType)(object)new ReturnIdWrapper + { + ReturnIds = [new ReturnId { Id = 1 }] + }); + } + + if (query == NotificationQueries.updateNotificationLog && typeof(QueryResponseType) == typeof(ReturnId)) + { + if (variables != null) + { + int id = (int)(variables.GetType().GetProperty("id")?.GetValue(variables) ?? 0); + string status = (string)(variables.GetType().GetProperty("status")?.GetValue(variables) ?? ""); + string error = (string)(variables.GetType().GetProperty("error")?.GetValue(variables) ?? ""); + UpdateCalls.Add((id, status, error)); + } + + return Task.FromResult((QueryResponseType)(object)new ReturnId { AffectedRows = 1 }); } throw new NotImplementedException(); diff --git a/roles/tests-unit/files/FWO.Test/NotificationLogEntryTest.cs b/roles/tests-unit/files/FWO.Test/NotificationLogEntryTest.cs index 263af363cd..809ced326c 100644 --- a/roles/tests-unit/files/FWO.Test/NotificationLogEntryTest.cs +++ b/roles/tests-unit/files/FWO.Test/NotificationLogEntryTest.cs @@ -31,5 +31,16 @@ public void SerializeDeadlineType_WritesDatabaseEnumValue() Assert.That(json, Does.Contain("\"deadline_type\":\"RequestDate\"")); } + + [Test] + public void SerializeStatus_WritesEnumName() + { + string json = JsonConvert.SerializeObject(new NotificationLogEntry + { + Status = NotificationLogStatus.Failed + }); + + Assert.That(json, Does.Contain("\"status\":\"Failed\"")); + } } } diff --git a/roles/tests-unit/files/FWO.Test/NotificationTest.cs b/roles/tests-unit/files/FWO.Test/NotificationTest.cs index 0790751cb3..7aceeba48d 100644 --- a/roles/tests-unit/files/FWO.Test/NotificationTest.cs +++ b/roles/tests-unit/files/FWO.Test/NotificationTest.cs @@ -206,7 +206,7 @@ public async Task SendNotification_UsesNotificationBodyWhenContentIsNull() MethodInfo? prepareEmail = typeof(NotificationService).GetMethod("PrepareEmail", BindingFlags.Instance | BindingFlags.NonPublic); ClassicAssert.IsNotNull(prepareEmail); - Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, ""]) + Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, "", null]) ?? throw new InvalidOperationException("PrepareEmail returned null task.")); FWO.Mail.MailData mailData = await task; @@ -226,7 +226,7 @@ public async Task SendNotification_PrepareEmail_HandlesNullSubjectAndBody() MethodInfo? prepareEmail = typeof(NotificationService).GetMethod("PrepareEmail", BindingFlags.Instance | BindingFlags.NonPublic); ClassicAssert.IsNotNull(prepareEmail); - Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, ""]) + Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, "", null]) ?? throw new InvalidOperationException("PrepareEmail returned null task.")); FWO.Mail.MailData mailData = await task; @@ -245,7 +245,7 @@ public async Task SendNotification_PrepareEmail_UsesContentPlaceholder_WhenPrese MethodInfo? prepareEmail = typeof(NotificationService).GetMethod("PrepareEmail", BindingFlags.Instance | BindingFlags.NonPublic); ClassicAssert.IsNotNull(prepareEmail); - Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, "\r\n\r\nMgmt A: 5 changes", owner, null, ""]) + Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, "\r\n\r\nMgmt A: 5 changes", owner, null, "", null]) ?? throw new InvalidOperationException("PrepareEmail returned null task.")); FWO.Mail.MailData mailData = await task; @@ -266,7 +266,7 @@ public async Task SendNotification_PrepareEmail_AppendsHtmlReportBody_WhenLayout MethodInfo? prepareEmail = typeof(NotificationService).GetMethod("PrepareEmail", BindingFlags.Instance | BindingFlags.NonPublic); ClassicAssert.IsNotNull(prepareEmail); - Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, report, ""]) + Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, report, "", null]) ?? throw new InvalidOperationException("PrepareEmail returned null task.")); FWO.Mail.MailData mailData = await task; @@ -290,7 +290,7 @@ public async Task SendNotification_PrepareEmail_IncludesBccRecipients() MethodInfo? prepareEmail = typeof(NotificationService).GetMethod("PrepareEmail", BindingFlags.Instance | BindingFlags.NonPublic); ClassicAssert.IsNotNull(prepareEmail); - Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, ""]) + Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, "", null]) ?? throw new InvalidOperationException("PrepareEmail returned null task.")); FWO.Mail.MailData mailData = await task; @@ -318,7 +318,7 @@ public async Task SendNotification_PrepareEmail_IncludesCcRecipients() MethodInfo? prepareEmail = typeof(NotificationService).GetMethod("PrepareEmail", BindingFlags.Instance | BindingFlags.NonPublic); ClassicAssert.IsNotNull(prepareEmail); - Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, ""]) + Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, "", null]) ?? throw new InvalidOperationException("PrepareEmail returned null task.")); FWO.Mail.MailData mailData = await task; @@ -347,7 +347,7 @@ public async Task SendNotification_PrepareEmail_AllowsNullBccFields() MethodInfo? prepareEmail = typeof(NotificationService).GetMethod("PrepareEmail", BindingFlags.Instance | BindingFlags.NonPublic); ClassicAssert.IsNotNull(prepareEmail); - Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, ""]) + Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, "", null]) ?? throw new InvalidOperationException("PrepareEmail returned null task.")); FWO.Mail.MailData mailData = await task; @@ -378,7 +378,7 @@ public async Task SendNotification_PrepareEmail_UsesToAddresses_WhenCcAndBccAreN MethodInfo? prepareEmail = typeof(NotificationService).GetMethod("PrepareEmail", BindingFlags.Instance | BindingFlags.NonPublic); ClassicAssert.IsNotNull(prepareEmail); - Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, ""]) + Task task = (Task)(prepareEmail?.Invoke(notificationService, [notification, null, owner, null, "", null]) ?? throw new InvalidOperationException("PrepareEmail returned null task.")); FWO.Mail.MailData mailData = await task; @@ -443,6 +443,7 @@ public async Task SendBundledNotifications_GroupsBundleAndTracksAllNotificationI FwoNotification standalone = new() { Id = 99, + Logging = NotificationLoggingMode.LogOnly, RecipientTo = EmailRecipientOption.OtherAddresses, EmailAddressTo = "single@example.test", EmailSubject = "single subject", diff --git a/roles/tests-unit/files/FWO.Test/NotificationTestApiConn.cs b/roles/tests-unit/files/FWO.Test/NotificationTestApiConn.cs index 2edde43d10..a651ebdfda 100644 --- a/roles/tests-unit/files/FWO.Test/NotificationTestApiConn.cs +++ b/roles/tests-unit/files/FWO.Test/NotificationTestApiConn.cs @@ -106,6 +106,14 @@ public override async Task SendQueryAsync( GraphQLResponse response = new() { Data = new ReturnId() { AffectedRows = notifCount } }; return response.Data; } + if (responseType == typeof(ReturnIdWrapper) && query == NotificationQueries.insertNotificationLog) + { + GraphQLResponse response = new() + { + Data = new ReturnIdWrapper { ReturnIds = [new ReturnId { Id = 1 }] } + }; + return response.Data; + } if (responseType == typeof(List) && query == AuthQueries.getUserEmails) { GraphQLResponse response = new() { Data = new List() }; @@ -149,7 +157,8 @@ private static FwoNotification CloneNotification(FwoNotification notification) InitialOffsetAfterDeadline = notification.InitialOffsetAfterDeadline, RepeatOffsetAfterDeadline = notification.RepeatOffsetAfterDeadline, RepetitionsAfterDeadline = notification.RepetitionsAfterDeadline, - LastSent = notification.LastSent + LastSent = notification.LastSent, + Logging = NotificationLoggingMode.LogOnly }; } } diff --git a/roles/tests-unit/files/FWO.Test/RuleExpiryCheckTest.cs b/roles/tests-unit/files/FWO.Test/RuleExpiryCheckTest.cs index beb1095ded..6009414706 100644 --- a/roles/tests-unit/files/FWO.Test/RuleExpiryCheckTest.cs +++ b/roles/tests-unit/files/FWO.Test/RuleExpiryCheckTest.cs @@ -422,6 +422,7 @@ private static FwoNotification CreateRuleTimerNotification(int id, int? ownerId Id = id, OwnerId = ownerId, Deadline = NotificationDeadline.RuleExpiry, + Logging = NotificationLoggingMode.LogOnly, RecipientTo = EmailRecipientOption.OtherAddresses, EmailAddressTo = "x@y.de", EmailSubject = "rule expiry", @@ -479,6 +480,19 @@ public override Task SendQueryAsync(string return Task.FromResult((QueryResponseType)(object)new ReturnId { AffectedRows = LastUpdatedNotificationIdCount }); } + if (responseType == typeof(ReturnIdWrapper) && query == NotificationQueries.insertNotificationLog) + { + return Task.FromResult((QueryResponseType)(object)new ReturnIdWrapper + { + ReturnIds = [new ReturnId { Id = 1 }] + }); + } + + if (responseType == typeof(ReturnId) && query == NotificationQueries.updateNotificationLog) + { + return Task.FromResult((QueryResponseType)(object)new ReturnId { AffectedRows = 1 }); + } + if (query == RuleQueries.getTimeBasedRulesByOwner && responseType.IsGenericType && responseType.GetGenericTypeDefinition() == typeof(List<>)) { object result = BuildExpiredRuleResponse(responseType); diff --git a/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor b/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor index e0dbff7eb7..24586e5061 100644 --- a/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor +++ b/roles/ui/files/FWO.UI/Pages/Monitoring/MonitorEmailLog.razor @@ -21,10 +21,12 @@ + + From fe878081db2ac324e5c1bc7555c4a666edccc443 Mon Sep 17 00:00:00 2001 From: abarz722 Date: Wed, 9 Sep 2026 15:58:03 +0200 Subject: [PATCH 16/48] fix fworch-texts again --- roles/database/files/sql/idempotent/fworch-texts.sql | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/database/files/sql/idempotent/fworch-texts.sql b/roles/database/files/sql/idempotent/fworch-texts.sql index d60437c2c3..2c943695b5 100644 --- a/roles/database/files/sql/idempotent/fworch-texts.sql +++ b/roles/database/files/sql/idempotent/fworch-texts.sql @@ -1,4 +1,4 @@ --- text codes (roughly) categorized: +-- text codes (roughly) categorized: -- U: user texts (explanation or confirmation texts) -- E: error texts -- A: Api errors From eebf9be1dfac968d4a766254d43516ece9aae0e9 Mon Sep 17 00:00:00 2001 From: abarz722 Date: Wed, 9 Sep 2026 18:27:32 +0200 Subject: [PATCH 17/48] help + tests + fixes --- .../modelling/addPermittedOwner.graphql | 3 + .../updateNotificationLog.graphql | 4 +- .../files/sql/idempotent/fworch-texts.sql | 12 +- ...odellingConnectionHandlerInterfHandling.cs | 5 +- ...lingConnectionHandlerInterfHandlingTest.cs | 3 +- .../files/FWO.Test/UiEditNotificationsTest.cs | 176 ++++++++++++++++++ .../FWO.Test/UiSettingsNotificationsTest.cs | 65 +++++++ .../HelpSettingsModellingNotifications.cshtml | 34 ++-- 8 files changed, 284 insertions(+), 18 deletions(-) diff --git a/roles/common/files/fwo-api-calls/modelling/addPermittedOwner.graphql b/roles/common/files/fwo-api-calls/modelling/addPermittedOwner.graphql index 876bbbd101..b757aa07b6 100644 --- a/roles/common/files/fwo-api-calls/modelling/addPermittedOwner.graphql +++ b/roles/common/files/fwo-api-calls/modelling/addPermittedOwner.graphql @@ -5,6 +5,9 @@ mutation addPermittedOwner( insert_modelling_permitted_owners(objects: { connection_id: $connectionId app_id: $appId + }, on_conflict: { + constraint: permitted_owners_pkey + update_columns: [] }) { returning { insertedConnectionId: connection_id diff --git a/roles/common/files/fwo-api-calls/notification_log/updateNotificationLog.graphql b/roles/common/files/fwo-api-calls/notification_log/updateNotificationLog.graphql index 7d7fb1f6d6..341d46df1b 100644 --- a/roles/common/files/fwo-api-calls/notification_log/updateNotificationLog.graphql +++ b/roles/common/files/fwo-api-calls/notification_log/updateNotificationLog.graphql @@ -1,6 +1,6 @@ mutation updateNotificationLog($id: Int!, $status: String!, $error: String!) { - update_notification_log_by_pk( - pk_columns: { id: $id } + update_notification_log( + where: { id: { _eq: $id } } _set: { status: $status, error: $error } ) { affected_rows diff --git a/roles/database/files/sql/idempotent/fworch-texts.sql b/roles/database/files/sql/idempotent/fworch-texts.sql index 2c943695b5..b48b67507a 100644 --- a/roles/database/files/sql/idempotent/fworch-texts.sql +++ b/roles/database/files/sql/idempotent/fworch-texts.sql @@ -1,4 +1,4 @@ --- text codes (roughly) categorized: +-- text codes (roughly) categorized: -- U: user texts (explanation or confirmation texts) -- E: error texts -- A: Api errors @@ -3929,6 +3929,10 @@ INSERT INTO txt VALUES ('token_revoke_success', 'German', 'Token erfolgreich z INSERT INTO txt VALUES ('token_revoke_success', 'English', 'Successful Token Revocation'); INSERT INTO txt VALUES ('empty_response', 'German', 'Leere Antwort'); INSERT INTO txt VALUES ('empty_response', 'English', 'Empty Response'); +INSERT INTO txt VALUES ('interface_ticket', 'German', 'Schnittstellenticket'); +INSERT INTO txt VALUES ('interface_ticket', 'English', 'Interface ticket'); +INSERT INTO txt VALUES ('common_notification_settings', 'German', 'Gemeinsame Einstellungen für Benachrichtigungen'); +INSERT INTO txt VALUES ('common_notification_settings', 'English', 'Common notification settings'); -- user messages INSERT INTO txt VALUES ('U0001', 'German', 'Eingabetext wurde um nicht erlaubte Zeichen gekürzt'); @@ -7184,6 +7188,12 @@ INSERT INTO txt VALUES ('H5638', 'German', 'Hier wird der Anweisungstext fü INSERT INTO txt VALUES ('H5638', 'English', 'Insert text for extra configurations.'); INSERT INTO txt VALUES ('H5639', 'German', 'Hier wird der Meldungstext für Fehler im externen Beantragungsprozess eingetragen.'); INSERT INTO txt VALUES ('H5639', 'English', 'Insert customized text for errors in requests to external ticket system.'); +INSERT INTO txt VALUES ('H5640', 'German', 'Antragsbenachrichtigung: Benachrichtigt die konfigurierten Empfänger sofort, wenn ein neues Schnittstellenticket angelegt wurde. Sie verwendet die Frist "None"; deshalb werden keine Vor- oder Nachfrist-Offsets ausgewertet.'); +INSERT INTO txt VALUES ('H5640', 'English', 'Initial request: Notifies the configured recipients immediately when a new interface request ticket is created. It uses deadline "None", so no before- or after-deadline offsets are evaluated.'); +INSERT INTO txt VALUES ('H5641', 'German', 'Erinnerung: Benachrichtigt über offene Schnittstellenanfragen. Sie verwendet die Frist "RequestDate"; die Vorfrist, Nachfrist und Wiederholungen bestimmen, wann Erinnerungen gesendet werden.'); +INSERT INTO txt VALUES ('H5641', 'English', 'Reminder: Notifies about open interface requests. It uses deadline "RequestDate"; the before-deadline, after-deadline and repetition settings determine when reminders are sent.'); +INSERT INTO txt VALUES ('H5642', 'German', 'Schnittstellenstilllegung: Benachrichtigt die Verantwortlichen der Anwendungen, die eine stillgelegte Schnittstelle verwenden. Sie wird sofort mit der Frist "None" gesendet. Falls eine Ersatzschnittstelle angegeben ist, werden deren Name und Link eingesetzt, gefolgt von den betroffenen Verbindungen.'); +INSERT INTO txt VALUES ('H5642', 'English', 'Interface decommission: Notifies the responsible users of applications using a decommissioned interface. It is sent immediately with deadline "None". If a replacement interface is provided, its name and link are inserted, followed by the affected connections.'); INSERT INTO txt VALUES ('H5643', 'German', 'DNS-Suche: Wenn gesetzt, werden App-Server-Namen aus dem DNS ergänzt und sind nicht manuell editierbar. Falls kein Name aufgelöst werden kann, wird er aus Präfix und IP-Adresse konstruiert.'); INSERT INTO txt VALUES ('H5643', 'English', 'DNS Look-up: When set, App Server names are resolved from DNS and are not manually editable. If no name can be resolved, it is constructed from prefix and IP address.'); INSERT INTO txt VALUES ('H5644', 'German', 'Existierende Namen überschreiben: Wenn gesetzt, werden bereits existierende Namen auch überschrieben, wenn sie nicht im DNS aufgelöst werden können.'); diff --git a/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs b/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs index ff29eafb1e..a11695955d 100644 --- a/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs +++ b/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs @@ -93,7 +93,7 @@ public async Task DecommissionInterface(string reason, bool proposeAlternative, List appsToNotify = UsingConnections .Where(c => c.AppId != null && c.AppId != ActConn.AppId) - .Select(c => c.App) + .Select(c => AllApps.FirstOrDefault(app => app.Id == c.AppId) ?? c.App) .Distinct() .ToList(); if (appsToNotify.Count > 0) @@ -218,12 +218,13 @@ private NotificationPlaceholderResolver.NotificationPlaceholderValues CreateDeco string reason, ModellingConnection? proposedInterface) { + FwoOwner interfaceOwner = AllApps.FirstOrDefault(owner => owner.Id == ActConn.AppId) ?? ActConn.App; string proposedInterfaceUrl = proposedInterface == null ? "" : $"{userConfig.UiHostName}/{PageName.Modelling}/{proposedInterface.App.ExtAppId}/{proposedInterface.Id}"; return new NotificationPlaceholderResolver.NotificationPlaceholderValues { - Application = app, + Application = interfaceOwner, InterfaceName = ActConn.Name ?? "", NewInterfaceName = proposedInterface?.Name ?? "", InterfaceLinkText = userConfig.GetText("interface"), diff --git a/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerInterfHandlingTest.cs b/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerInterfHandlingTest.cs index 489b574700..4d4adc3149 100644 --- a/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerInterfHandlingTest.cs +++ b/roles/tests-unit/files/FWO.Test/ModellingConnectionHandlerInterfHandlingTest.cs @@ -343,7 +343,8 @@ public void CreateDecommissionPlaceholderValues_UsesInterfaceAndReplacementData( Assert.Multiple(() => { - Assert.That(values.Application, Is.SameAs(Application)); + Assert.That(values.Application, Is.SameAs(handler.ActConn.App)); + Assert.That(values.Application, Is.Not.SameAs(Application)); Assert.That(values.InterfaceName, Is.EqualTo("OldInterface")); Assert.That(values.NewInterfaceName, Is.EqualTo("NewInterface")); Assert.That(values.Reason, Is.EqualTo("Reason")); diff --git a/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs b/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs index 543ed12ffe..1029604d66 100644 --- a/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiEditNotificationsTest.cs @@ -1,6 +1,7 @@ using FWO.Config.Api; using FWO.Api.Client; using FWO.Api.Client.Queries; +using FWO.Basics; using FWO.Data; using FWO.Ui.Shared; using NUnit.Framework; @@ -621,6 +622,47 @@ public void CheckConsistencyWithDeadline_ReturnsTrueForCompleteBeforeDeadlineCon Assert.That(result, Is.True); } + [Test] + public void CheckConsistencyWithDeadline_ReturnsFalseWhenAfterOffsetHasNoInterval() + { + EditNotifications component = new(); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateField(component, "actNotification", new FwoNotification { RepeatOffsetAfterDeadline = 1 }); + + bool result = (bool)GetPrivateMethod("CheckConsistencyWithDeadline").Invoke(component, null)!; + + Assert.That(result, Is.False); + } + + [Test] + public void CheckConsistencyWithDeadline_ReturnsFalseWhenRepetitionsAreWithoutAfterOffset() + { + EditNotifications component = new(); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateField(component, "actNotification", new FwoNotification { RepetitionsAfterDeadline = 2 }); + + bool result = (bool)GetPrivateMethod("CheckConsistencyWithDeadline").Invoke(component, null)!; + + Assert.That(result, Is.False); + } + + [Test] + public void CheckConsistencyWithDeadline_ReturnsTrueForCompleteAfterDeadlineConfiguration() + { + EditNotifications component = new(); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateField(component, "actNotification", new FwoNotification + { + RepeatOffsetAfterDeadline = 1, + RepeatIntervalAfterDeadline = SchedulerInterval.Days, + RepetitionsAfterDeadline = 2 + }); + + bool result = (bool)GetPrivateMethod("CheckConsistencyWithDeadline").Invoke(component, null)!; + + Assert.That(result, Is.True); + } + [Test] public async Task SetDirectAddresses_WritesToCcAndBccFields() { @@ -676,6 +718,116 @@ public void ParseOtherAddressSelection_UsesLegacyAddressesWhenValueIsNotJson() }); } + [Test] + public void DisplayedInterval_UsesBeforeDeadlineIntervalWhenConfigured() + { + EditNotifications component = new(); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + FwoNotification notification = new() + { + Deadline = NotificationDeadline.RecertDate, + OffsetBeforeDeadline = 3, + IntervalBeforeDeadline = SchedulerInterval.Days + }; + + string result = (string)GetPrivateMethod("DisplayedInterval").Invoke(component, new object?[] { notification })!; + + Assert.That(result, Is.EqualTo($"3 {new SimulatedUserConfig().GetText(SchedulerInterval.Days.ToString())}")); + } + + [Test] + public void DisplayedInterval_UsesRepeatIntervalWhenNoBeforeDeadlineIntervalExists() + { + EditNotifications component = new(); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + FwoNotification notification = new() + { + Deadline = NotificationDeadline.RuleExpiry, + RepeatOffsetAfterDeadline = 2, + RepeatIntervalAfterDeadline = SchedulerInterval.Weeks + }; + + string result = (string)GetPrivateMethod("DisplayedInterval").Invoke(component, new object?[] { notification })!; + + Assert.That(result, Does.StartWith("2 ")); + } + + [Test] + public void DisplayedInterval_IsEmptyForImmediateNotification() + { + EditNotifications component = new(); + string result = (string)GetPrivateMethod("DisplayedInterval").Invoke(component, + new object?[] { new FwoNotification { Deadline = NotificationDeadline.None } })!; + + Assert.That(result, Is.Empty); + } + + [Test] + public void EditNotification_UsesConfiguredSelectionForAllOwnerResponsibles() + { + EditNotifications component = new(); + SetClient(component, NotificationClient.InterfaceRequest); + SetPrivateField(component, "activeOwnerResponsibleTypes", new List + { + new() { Id = GlobalConst.kOwnerResponsibleTypeMain, Active = true, SortOrder = 1 }, + new() { Id = GlobalConst.kOwnerResponsibleTypeSupporting, Active = true, SortOrder = 2 } + }); + FwoNotification notification = new() { RecipientTo = EmailRecipientOption.AllOwnerResponsibles }; + + GetPrivateMethod("EditNotification").Invoke(component, new object?[] { notification }); + + EmailRecipientSelection selection = GetPrivateField(component, "ToRecipientSelection"); + Assert.That(selection.OwnerResponsibleTypeIds, Is.EqualTo(new List + { + GlobalConst.kOwnerResponsibleTypeMain, + GlobalConst.kOwnerResponsibleTypeSupporting + })); + } + + [Test] + public void SyncAddresses_RemovesRequesterWhenClientDoesNotOfferRequester() + { + EditNotifications component = new(); + SetClient(component, NotificationClient.Recertification); + FwoNotification notification = new(); + SetPrivateField(component, "actNotification", notification); + SetPrivateField(component, "ToRecipientSelection", new EmailRecipientSelection + { + None = false, + Requester = true, + OtherAddresses = true, + OtherAddressList = new List { "to@example.org" } + }); + + GetPrivateMethod("SyncAddresses").Invoke(component, null); + + EmailRecipientSelection selection = EmailRecipientSelection.Parse(notification.EmailAddressTo); + Assert.That(selection.Requester, Is.False); + } + + [Test] + public async Task AddAndRemoveNotificationId_IgnoreNullIds() + { + EditNotifications component = new(); + + await (Task)GetPrivateMethod("AddNotificationId").Invoke(component, new object?[] { 7 })!; + await (Task)GetPrivateMethod("RemoveNotificationId").Invoke(component, new object?[] { 7 })!; + + Assert.That(component.NotificationIds, Is.Null); + } + + [Test] + public async Task AddNotificationId_DoesNotAddDuplicateId() + { + EditNotifications component = new(); + List notificationIds = new() { 7 }; + SetPrivateMember(component, nameof(EditNotifications.NotificationIds), notificationIds); + + await (Task)GetPrivateMethod("AddNotificationId").Invoke(component, new object?[] { 7 })!; + + Assert.That(notificationIds, Is.EqualTo(new List { 7 })); + } + [Test] public async Task AddAndRemoveNotificationId_UpdatesBoundIds() { @@ -739,6 +891,30 @@ public async Task Save_AddsNotificationAndReferenceWhenConfigurationIsValid() }); } + [Test] + public async Task Save_UpdatesExistingNotificationWhenConfigurationIsValid() + { + EditNotifications component = new(); + SetClient(component, NotificationClient.Report); + SetInjectedUserConfig(component, new SimulatedUserConfig()); + SetPrivateMember(component, "apiConnection", new EditNotificationsApiConnection()); + FwoNotification notification = new() + { + Id = 9, + Name = "Updated", + Channel = NotificationChannel.Email, + EmailSubject = "Subject", + EmailAddressTo = "to@example.org" + }; + SetPrivateField(component, "Notifications", new List { notification }); + SetPrivateField(component, "actNotification", notification); + SetPrivateField(component, "EditNotifMode", true); + + await (Task)GetPrivateMethod("Save").Invoke(component, null)!; + + Assert.That(GetPrivateField>(component, "Notifications").Single().Name, Is.EqualTo("Updated")); + } + [Test] public async Task Delete_RestoresReferenceWhenDeleteFails() { diff --git a/roles/tests-unit/files/FWO.Test/UiSettingsNotificationsTest.cs b/roles/tests-unit/files/FWO.Test/UiSettingsNotificationsTest.cs index ecc591774e..2249090188 100644 --- a/roles/tests-unit/files/FWO.Test/UiSettingsNotificationsTest.cs +++ b/roles/tests-unit/files/FWO.Test/UiSettingsNotificationsTest.cs @@ -1,5 +1,8 @@ using FWO.Config.Api; using FWO.Config.Api.Data; +using FWO.Api.Client; +using FWO.Api.Client.Queries; +using FWO.Data; using FWO.Ui.Pages.Settings; using NUnit.Framework; using System.Collections; @@ -65,6 +68,17 @@ private static void SetInjectedGlobalConfig(SettingsNotifications component, Glo prop.SetValue(component, globalConfig); } + private static void SetInjectedService(SettingsNotifications component, Type serviceType, object service) + { + PropertyInfo? prop = typeof(SettingsNotifications).GetProperties(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance) + .FirstOrDefault(p => p.PropertyType == serviceType); + if (prop == null) + { + throw new MissingMemberException(typeof(SettingsNotifications).FullName, serviceType.Name); + } + prop.SetValue(component, service); + } + private static IList CreateInitiatorList() { Type? entryType = typeof(SettingsNotifications).GetNestedType("RuleExpiryInitiatorText", BindingFlags.NonPublic); @@ -301,5 +315,56 @@ public void PrepareConfigData_PreservesUnknownStoredNotificationLanguage() Assert.That(configData.NotificationLanguage, Is.EqualTo("French")); } + + [Test] + public async Task Save_PersistsPreparedConfigAndClearsPendingInitiatorChanges() + { + SettingsNotifications component = new(); + SimulatedGlobalConfig globalConfig = new(); + SettingsNotificationsApiConnection apiConnection = new(); + SetInjectedGlobalConfig(component, globalConfig); + SetInjectedService(component, typeof(ApiConnection), apiConnection); + SetInjectedService(component, typeof(UserConfig), new SimulatedUserConfig()); + + IList initiatorKeys = CreateInitiatorList(); + IList initiatorKeysToAdd = CreateInitiatorList(); + IList initiatorKeysToDelete = CreateInitiatorList(); + initiatorKeysToAdd.Add(CreateInitiatorEntry("custom", "Custom text")); + SetPrivateField(component, "configData", new ConfigData { RuleExpiryEmailBody = "Updated body" }); + SetPrivateField(component, "initiatorKeys", initiatorKeys); + SetPrivateField(component, "initiatorKeysToAdd", initiatorKeysToAdd); + SetPrivateField(component, "initiatorKeysToDelete", initiatorKeysToDelete); + + await (Task)GetPrivateMethod("Save").Invoke(component, null)!; + + Assert.Multiple(() => + { + Assert.That(apiConnection.UpsertConfigCallCount, Is.EqualTo(1)); + Assert.That(apiConnection.LastConfigItems.Any(item => item.Key == "ruleExpiryEmailBody" && item.Value == "Updated body"), Is.True); + Assert.That(GetPrivateField(component, "initiatorKeysToAdd"), Is.Empty); + Assert.That(GetPrivateField(component, "initiatorKeysToDelete"), Is.Empty); + }); + } + + private sealed class SettingsNotificationsApiConnection : SimulatedApiConnection + { + public int UpsertConfigCallCount { get; private set; } + public List LastConfigItems { get; private set; } = []; + + public override Task SendQueryAsync(string query, object? variables = null, + string? operationName = null, QueryChunkingOptions? chunkingOptions = null) + { + if (query == ConfigQueries.upsertConfigItems) + { + UpsertConfigCallCount++; + PropertyInfo configItemsProperty = variables?.GetType().GetProperty("config_items") + ?? throw new ArgumentException("Missing config_items variable."); + LastConfigItems = ((IEnumerable)configItemsProperty.GetValue(variables)!).ToList(); + return Task.FromResult(default(QueryResponseType)!); + } + + throw new NotImplementedException($"Unexpected query: {query}"); + } + } } } diff --git a/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml b/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml index 98b56f1d8c..163e3e0ead 100644 --- a/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml +++ b/roles/ui/files/FWO.UI/Pages/Help/HelpSettingsModellingNotifications.cshtml @@ -12,29 +12,39 @@ @inject UserConfig userConfig
      -

      @(userConfig.GetText("notifications"))

      -

      @(Html.Raw(userConfig.GetText("initial_request")))

      +

      @(Html.Raw(userConfig.GetText("notifications")))

      +

      @(Html.Raw(userConfig.GetText("interface_ticket")))

      • @(Html.Raw(userConfig.GetText("H5622")))
      • @(Html.Raw(userConfig.GetText("H5625")))
      • @(Html.Raw(userConfig.GetText("H5626")))
        • -
      • @(Html.Raw(userConfig.GetText("H4111")))
        • +
      + +

      @(Html.Raw(userConfig.GetText("request_interface")))

      +

      @(Html.Raw(userConfig.GetText("H5640")))

      +
      • @(Html.Raw(userConfig.GetText("H5630")))
        • -
      • @(Html.Raw(userConfig.GetText("H5624")))
      +

      @(Html.Raw(userConfig.GetText("reminder")))

      +

      @(Html.Raw(userConfig.GetText("H5641")))

      + +

      @(Html.Raw(userConfig.GetText("decomm_interface")))

      +

      @(Html.Raw(userConfig.GetText("H5642")))

      + +

      @(Html.Raw(userConfig.GetText("common_notification_settings")))

        -
      • @(Html.Raw(userConfig.GetText("H5629")))
        • -
      • @(Html.Raw(userConfig.GetText("H5624a")))
        • +
      • @(Html.Raw(userConfig.GetText("H4109")))
        • +
      • @(Html.Raw(userConfig.GetText("H4101")))
        • +
      • @(Html.Raw(userConfig.GetText("H4102")))
        • +
      • @(Html.Raw(userConfig.GetText("H4103")))
        • +
      • @(Html.Raw(userConfig.GetText("H4104")))
        • +
      • @(Html.Raw(userConfig.GetText("H4105")))
      • @(Html.Raw(userConfig.GetText("H4106")))
      • @(Html.Raw(userConfig.GetText("H4107")))
      • @(Html.Raw(userConfig.GetText("H4108")))
      • @(Html.Raw(userConfig.GetText("H4108a")))
        • -
      -

      @(Html.Raw(userConfig.GetText("decommission")))

      -
        -
      • @(Html.Raw(userConfig.GetText("H5660")))
        • -
      • @(Html.Raw(userConfig.GetText("H5661")))
        • -
      • @(Html.Raw(userConfig.GetText("H5662")))
        • +
      • @(Html.Raw(userConfig.GetText("H4110")))
        • +
      • @(Html.Raw(userConfig.GetText("H4111")))
      From 0f5ecdf555b0e227fcbe3e42c4f98209b97b155d Mon Sep 17 00:00:00 2001 From: abarz722 Date: Thu, 10 Sep 2026 17:39:59 +0200 Subject: [PATCH 18/48] add active flag to notifications --- roles/api/files/replace_metadata.json | 75 ++++++++++++------- .../notification/addNotification.graphql | 2 + .../notification/getNotifications.graphql | 1 + .../notification/updateNotification.graphql | 2 + .../creation/fworch-create-tables-base.sql | 3 +- roles/database/files/upgrade/9.5.5.sql | 3 + roles/lib/files/FWO.Data/FwoNotification.cs | 4 + .../NotificationScheduleHelper.cs | 5 ++ ...odellingConnectionHandlerInterfHandling.cs | 2 +- .../Workflow/ActionHandlerSendEmail.cs | 2 +- .../FWO.Middleware.Server/AppDataImport.cs | 2 +- .../NotificationService.cs | 9 ++- .../NotificationScheduleHelperTest.cs | 12 +++ .../RequestInterfacePopup.razor | 2 +- .../Services/NotificationMutationHelper.cs | 9 ++- .../FWO.UI/Shared/EditNotifications.razor | 11 ++- 16 files changed, 109 insertions(+), 35 deletions(-) diff --git a/roles/api/files/replace_metadata.json b/roles/api/files/replace_metadata.json index eac24b63ca..3018a96b09 100644 --- a/roles/api/files/replace_metadata.json +++ b/roles/api/files/replace_metadata.json @@ -12273,7 +12273,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ] }, "comment": "" @@ -12309,7 +12310,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ] }, "comment": "" @@ -12345,7 +12347,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ] }, "comment": "" @@ -12381,7 +12384,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ] }, "comment": "" @@ -12417,7 +12421,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ] }, "comment": "" @@ -12453,7 +12458,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ] }, "comment": "" @@ -12490,7 +12496,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "notification_client": { @@ -12530,7 +12537,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": {} }, @@ -12566,7 +12574,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_or": [ @@ -12615,7 +12624,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "notification_client": { @@ -12655,7 +12665,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": {} }, @@ -12691,7 +12702,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_or": [ @@ -12740,7 +12752,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "notification_client": { @@ -12780,7 +12793,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_or": [ @@ -12829,7 +12843,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_or": [ @@ -12878,7 +12893,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_or": [ @@ -12927,7 +12943,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "notification_client": { @@ -12967,7 +12984,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "notification_client": { @@ -13009,7 +13027,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_and": [ @@ -13090,7 +13109,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_or": [ @@ -13128,7 +13148,8 @@ "permission": { "columns": [ "last_sent", - "logging" + "logging", + "active" ], "filter": {}, "check": {} @@ -13165,7 +13186,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_or": [ @@ -13228,7 +13250,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_or": [ @@ -13291,7 +13314,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_or": [ @@ -13354,7 +13378,8 @@ "schedule_id", "user_id", "last_sent", - "logging" + "logging", + "active" ], "filter": { "_or": [ diff --git a/roles/common/files/fwo-api-calls/notification/addNotification.graphql b/roles/common/files/fwo-api-calls/notification/addNotification.graphql index 066fcdfa2e..62847a61e7 100644 --- a/roles/common/files/fwo-api-calls/notification/addNotification.graphql +++ b/roles/common/files/fwo-api-calls/notification/addNotification.graphql @@ -23,6 +23,7 @@ mutation addNotification( $offsetAfterDeadline: Int $repetitionsAfterDeadline: Int $logging: String + $active: Boolean! ) { insert_notification(objects: { notification_client: $client @@ -49,6 +50,7 @@ mutation addNotification( repeat_offset_after_deadline: $offsetAfterDeadline repetitions_after_deadline: $repetitionsAfterDeadline logging: $logging + active: $active }) { returning { newId: id diff --git a/roles/common/files/fwo-api-calls/notification/getNotifications.graphql b/roles/common/files/fwo-api-calls/notification/getNotifications.graphql index a888e35f30..294cb5ebf7 100644 --- a/roles/common/files/fwo-api-calls/notification/getNotifications.graphql +++ b/roles/common/files/fwo-api-calls/notification/getNotifications.graphql @@ -28,5 +28,6 @@ query getNotifications ($client: String! ){ repetitions_after_deadline last_sent logging + active } } diff --git a/roles/common/files/fwo-api-calls/notification/updateNotification.graphql b/roles/common/files/fwo-api-calls/notification/updateNotification.graphql index c759bb451a..e0f2f530ba 100644 --- a/roles/common/files/fwo-api-calls/notification/updateNotification.graphql +++ b/roles/common/files/fwo-api-calls/notification/updateNotification.graphql @@ -23,6 +23,7 @@ mutation updateNotification( $offsetAfterDeadline: Int $repetitionsAfterDeadline: Int $logging: String + $active: Boolean! ) { update_notification_by_pk( pk_columns: { id: $id } @@ -50,6 +51,7 @@ mutation updateNotification( repeat_offset_after_deadline: $offsetAfterDeadline repetitions_after_deadline: $repetitionsAfterDeadline logging: $logging + active: $active }) { updatedId: id } diff --git a/roles/database/files/sql/creation/fworch-create-tables-base.sql b/roles/database/files/sql/creation/fworch-create-tables-base.sql index 882a55e16a..34d1d8533b 100755 --- a/roles/database/files/sql/creation/fworch-create-tables-base.sql +++ b/roles/database/files/sql/creation/fworch-create-tables-base.sql @@ -337,7 +337,8 @@ create table notification bundle_id Varchar, recipient_bcc Varchar, email_address_bcc Varchar, - logging Varchar NOT NULL DEFAULT 'send_only' + logging Varchar NOT NULL DEFAULT 'send_only', + active Boolean NOT NULL DEFAULT TRUE ); create table notification_log diff --git a/roles/database/files/upgrade/9.5.5.sql b/roles/database/files/upgrade/9.5.5.sql index 485902b2bc..ad5143e0cb 100644 --- a/roles/database/files/upgrade/9.5.5.sql +++ b/roles/database/files/upgrade/9.5.5.sql @@ -114,6 +114,9 @@ SELECT 1; ALTER TABLE notification ADD COLUMN IF NOT EXISTS logging Varchar NOT NULL DEFAULT 'send_only'; +ALTER TABLE notification + ADD COLUMN IF NOT EXISTS active Boolean NOT NULL DEFAULT TRUE; + UPDATE notification SET logging = 'send_only' WHERE COALESCE(logging, '') = ''; diff --git a/roles/lib/files/FWO.Data/FwoNotification.cs b/roles/lib/files/FWO.Data/FwoNotification.cs index 228cfbde18..1e1f88c726 100644 --- a/roles/lib/files/FWO.Data/FwoNotification.cs +++ b/roles/lib/files/FWO.Data/FwoNotification.cs @@ -136,6 +136,7 @@ public FwoNotification(FwoNotification notification) RepetitionsAfterDeadline = notification.RepetitionsAfterDeadline; LastSent = notification.LastSent; Logging = notification.Logging; + Active = notification.Active; } [JsonProperty("id"), JsonPropertyName("id")] @@ -226,6 +227,9 @@ public EmailRecipientOption RecipientBcc [JsonProperty("logging"), JsonPropertyName("logging")] public string Logging { get; set; } = NotificationLoggingMode.SendOnly; + [JsonProperty("active"), JsonPropertyName("active")] + public bool Active { get; set; } = true; + public static List OfferedDeadlineOptions(NotificationClient client) { diff --git a/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs b/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs index ee1181a70c..6b88428461 100644 --- a/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs +++ b/roles/lib/files/FWO.Services/EmailNotification/NotificationScheduleHelper.cs @@ -17,6 +17,11 @@ public static class NotificationScheduleHelper /// True when the notification should be sent now. public static bool IsNotificationDue(FwoOwner? owner, DateTime? extDeadline, FwoNotification notification) { + if (!notification.Active) + { + return false; + } + if (notification.Deadline == NotificationDeadline.None) { return true; diff --git a/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs b/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs index a11695955d..f60685a484 100644 --- a/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs +++ b/roles/lib/files/FWO.Services/Modelling/ModellingConnectionHandlerInterfHandling.cs @@ -152,7 +152,7 @@ private async Task> LoadImmediateDecommissionNotifications { List notifications = await apiConnection.SendQueryAsync>(NotificationQueries.getNotifications, new { client = NotificationClient.InterfaceDecomm.ToString() }); - return notifications.Where(notification => notification.Deadline == NotificationDeadline.None).ToList(); + return notifications.Where(notification => notification.Active && notification.Deadline == NotificationDeadline.None).ToList(); } private async Task<(int successCount, int failCount)> SendDecommissionNotificationsForApp( diff --git a/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs b/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs index 30592ddac0..3446f1bdec 100644 --- a/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs +++ b/roles/lib/files/FWO.Services/Workflow/ActionHandlerSendEmail.cs @@ -89,7 +89,7 @@ private async Task> ResolveActionNotifications(EmailAction { List notifications = await apiConnection.SendQueryAsync>(NotificationQueries.getNotifications, new { client = NotificationClient.WfAction.ToString() }); - List actionNotifications = [.. notifications.Where(n => notificationIds.Contains(n.Id))]; + List actionNotifications = [.. notifications.Where(n => n.Active && notificationIds.Contains(n.Id))]; List missingNotificationIds = [.. notificationIds.Except(actionNotifications.Select(n => n.Id))]; if (missingNotificationIds.Count > 0) { diff --git a/roles/middleware/files/FWO.Middleware.Server/AppDataImport.cs b/roles/middleware/files/FWO.Middleware.Server/AppDataImport.cs index a8450d0b2a..b59f8a273a 100644 --- a/roles/middleware/files/FWO.Middleware.Server/AppDataImport.cs +++ b/roles/middleware/files/FWO.Middleware.Server/AppDataImport.cs @@ -483,7 +483,7 @@ protected virtual async Task LoadHasImmediateAppDecommNotification() List notifications = await apiConnection.SendQueryAsync>( NotificationQueries.getNotifications, new { client = NotificationClient.AppDecomm.ToString() }); - return notifications.Any(notification => notification.Deadline == NotificationDeadline.None); + return notifications.Any(notification => notification.Active && notification.Deadline == NotificationDeadline.None); } private static bool LooksLikeDistinguishedName(string identifier) diff --git a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs index 2c039ae8b3..332be4270a 100644 --- a/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs +++ b/roles/middleware/files/FWO.Middleware.Server/NotificationService.cs @@ -33,7 +33,7 @@ public class NotificationService { ApiConnection = apiConnection; GlobalConfig = globalConfig; - Notifications = notifications; + Notifications = notifications.Where(notification => notification.Active).ToList(); OwnerGroups = ownerGroups; WorkflowRecipientResolver = workflowRecipientResolver; } @@ -124,6 +124,11 @@ public async Task SendNotification(FwoNotification notification, FwoOwner? string timeIntervalText = "", DateTime? resolvedDeadline = null, NotificationPlaceholderResolver.NotificationPlaceholderValues? placeholderValues = null) { + if (!notification.Active) + { + return 0; + } + // Later: Handle other channels here when implemented bool sent = await SendEmail(notification, content, owner, report, timeIntervalText, resolvedDeadline, placeholderValues); if (!sent) @@ -149,7 +154,7 @@ public async Task SendNotification(FwoNotification notification, FwoOwner? public async Task SendBundledNotifications(List notifications, FwoOwner? owner, string? content = null, ReportBase? report = null, string timeIntervalText = "") { int emailsSent = 0; - foreach (IGrouping notificationGroup in notifications.GroupBy(GetBundleGroupKey)) + foreach (IGrouping notificationGroup in notifications.Where(notification => notification.Active).GroupBy(GetBundleGroupKey)) { List groupedNotifications = [.. notificationGroup]; if (groupedNotifications.Count == 1 || groupedNotifications[0].BundleType == null) diff --git a/roles/tests-unit/files/FWO.Test/NotificationScheduleHelperTest.cs b/roles/tests-unit/files/FWO.Test/NotificationScheduleHelperTest.cs index c241b1edd4..8646bfe2e4 100644 --- a/roles/tests-unit/files/FWO.Test/NotificationScheduleHelperTest.cs +++ b/roles/tests-unit/files/FWO.Test/NotificationScheduleHelperTest.cs @@ -18,6 +18,18 @@ public void IsNotificationDue_ReturnsTrueForNoneDeadline() Assert.That(NotificationScheduleHelper.IsNotificationDue(new FwoOwner(), null, notification), Is.True); } + [Test] + public void IsNotificationDue_ReturnsFalseForInactiveNotification() + { + FwoNotification notification = new() + { + Active = false, + Deadline = NotificationDeadline.None + }; + + Assert.That(NotificationScheduleHelper.IsNotificationDue(new FwoOwner(), null, notification), Is.False); + } + [Test] public void IsNotificationDue_ReturnsTrueForImmediateRequestDeadline() { diff --git a/roles/ui/files/FWO.UI/Pages/NetworkModelling/RequestInterfacePopup.razor b/roles/ui/files/FWO.UI/Pages/NetworkModelling/RequestInterfacePopup.razor index 308ecf6738..f783be87c5 100644 --- a/roles/ui/files/FWO.UI/Pages/NetworkModelling/RequestInterfacePopup.razor +++ b/roles/ui/files/FWO.UI/Pages/NetworkModelling/RequestInterfacePopup.razor @@ -196,7 +196,7 @@ notifications = new List(); } - return notifications.FirstOrDefault(notification => notification.Deadline == NotificationDeadline.None); + return notifications.FirstOrDefault(notification => notification.Active && notification.Deadline == NotificationDeadline.None); } private NotificationPlaceholderResolver.NotificationPlaceholderValues BuildRequestPlaceholderValues(long connId) diff --git a/roles/ui/files/FWO.UI/Services/NotificationMutationHelper.cs b/roles/ui/files/FWO.UI/Services/NotificationMutationHelper.cs index 9428116ec2..9cf7df22e7 100644 --- a/roles/ui/files/FWO.UI/Services/NotificationMutationHelper.cs +++ b/roles/ui/files/FWO.UI/Services/NotificationMutationHelper.cs @@ -97,7 +97,8 @@ private static FwoNotification Clone(FwoNotification notification) RepeatOffsetAfterDeadline = notification.RepeatOffsetAfterDeadline, RepetitionsAfterDeadline = notification.RepetitionsAfterDeadline, LastSent = notification.LastSent, - Logging = notification.Logging + Logging = notification.Logging, + Active = notification.Active }; } @@ -152,6 +153,8 @@ private record NotificationMutationVariables public string? logging { get; init; } + public bool active { get; init; } + protected NotificationMutationVariables() { } @@ -181,6 +184,7 @@ protected NotificationMutationVariables(NotificationMutationVariables variables) offsetAfterDeadline = variables.offsetAfterDeadline; repetitionsAfterDeadline = variables.repetitionsAfterDeadline; logging = variables.logging; + active = variables.active; } public static NotificationMutationVariables Create(FwoNotification notification) @@ -209,7 +213,8 @@ public static NotificationMutationVariables Create(FwoNotification notification) initialOffsetAfterDeadline = notification.InitialOffsetAfterDeadline, offsetAfterDeadline = notification.RepeatOffsetAfterDeadline, repetitionsAfterDeadline = notification.RepetitionsAfterDeadline, - logging = notification.Logging + logging = notification.Logging, + active = notification.Active }; } } diff --git a/roles/ui/files/FWO.UI/Shared/EditNotifications.razor b/roles/ui/files/FWO.UI/Shared/EditNotifications.razor index 09ee9e78be..9c055edae6 100644 --- a/roles/ui/files/FWO.UI/Shared/EditNotifications.razor +++ b/roles/ui/files/FWO.UI/Shared/EditNotifications.razor @@ -26,6 +26,11 @@       + + +