Add an option to notify only on remind (#7883)

Signed-off-by: vlo-rte <[email protected]>

Author: vlo-rte

client/cards/src/main/java/org/opfab/cards/model/CardActionEnum.java

@@ -1,4 +1,4 @@
-/* Copyright (c) 2024, RTE (http://www.rte-france.com)
+/* Copyright (c) 2024-2025, RTE (http://www.rte-france.com)
  * See AUTHORS.txt
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -17,6 +17,7 @@
  *    <dt>KEEP_EXISTING_ACKS_AND_READS</dt>
  *    <dt>KEEP_EXISTING_PUBLISH_DATE</dt>
  *    <dt>STORE_ONLY_IN_ARCHIVES</dt>
+ *    <dt>NOT_NOTIFIED</dt>
  * </dl>
  * Note : This enum is created by hand because Swagger can't handle enums. It should match the corresponding enum definition in the Cards API.
  *
@@ -26,5 +27,6 @@ public enum CardActionEnum {
    KEEP_CHILD_CARDS,
    KEEP_EXISTING_ACKS_AND_READS,
    KEEP_EXISTING_PUBLISH_DATE,
-   STORE_ONLY_IN_ARCHIVES
+   STORE_ONLY_IN_ARCHIVES,
+   NOT_NOTIFIED
 }

services/cards-consultation/src/main/java/org/opfab/cards/consultation/model/CardActionEnum.java

@@ -1,4 +1,4 @@
-/* Copyright (c) 2024, RTE (http://www.rte-france.com)
+/* Copyright (c) 2024-2025, RTE (http://www.rte-france.com)
  * See AUTHORS.txt
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -16,6 +16,6 @@ public enum CardActionEnum {
   KEEP_CHILD_CARDS,
   KEEP_EXISTING_ACKS_AND_READS,
   KEEP_EXISTING_PUBLISH_DATE,
-  STORE_ONLY_IN_ARCHIVES
-
+  STORE_ONLY_IN_ARCHIVES,
+  NOT_NOTIFIED
 }

services/cards-publication/src/main/java/org/opfab/cards/publication/model/CardActionEnum.java

@@ -1,4 +1,4 @@
-/* Copyright (c) 2023-2024, RTE (http://www.rte-france.com)
+/* Copyright (c) 2023-2025, RTE (http://www.rte-france.com)
  * See AUTHORS.txt
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -15,6 +15,7 @@ public enum CardActionEnum {
   KEEP_CHILD_CARDS,
   KEEP_EXISTING_ACKS_AND_READS,
   KEEP_EXISTING_PUBLISH_DATE,
-  STORE_ONLY_IN_ARCHIVES
+  STORE_ONLY_IN_ARCHIVES,
+  NOT_NOTIFIED
 }
 

services/cards-publication/src/main/java/org/opfab/cards/publication/mongo/CardRepositoryImpl.java

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2024, RTE (http://www.rte-france.com)
+/* Copyright (c) 2018-2025, RTE (http://www.rte-france.com)
  * See AUTHORS.txt
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -202,7 +202,8 @@ public UserBasedOperationResult deleteAcksAndReads(String cardUid) {
             .unset(USERS_READS)
             .set(ENTITIES_ACKS,new LinkedList<String>())
             .set(LAST_UPDATE, Instant.now())
-            .set("publishDate", Instant.now());
+            .set("publishDate", Instant.now())
+            .pull("actions", "NOT_NOTIFIED");
         UpdateResult updateFirst = template.updateFirst(Query.query(Criteria.where("uid").is(cardUid)),
                 update, Card.class);
         log.debug("removed {} occurrence of Acks and read in the card with uid: {}", updateFirst.getModifiedCount(),

services/cards-publication/src/main/modeling/swagger.yaml

@@ -217,12 +217,14 @@ definitions:
       * KEEP_EXISTING_ACKS_AND_READS,
       * KEEP_EXISTING_PUBLISH_DATE
       * STORE_ONLY_IN_ARCHIVES
+      * NOT_NOTIFIED
     enum:
       - PROPAGATE_READ_ACK_TO_PARENT_CARD
       - KEEP_CHILD_CARDS
       - KEEP_EXISTING_ACKS_AND_READS
       - KEEP_EXISTING_PUBLISH_DATE
       - STORE_ONLY_IN_ARCHIVES
+      - NOT_NOTIFIED
     example: PROPAGATE_READ_ACK_TO_PARENT_CARD
   Card:
     type: object

src/docs/asciidoc/reference_doc/card_structure.adoc

@@ -1,4 +1,4 @@
-// Copyright (c) 2018-2024 RTE (http://www.rte-france.com)
+// Copyright (c) 2018-2025 RTE (http://www.rte-france.com)
 // See AUTHORS.txt
 // This document is subject to the terms of the Creative Commons Attribution 4.0 International license.
 // If a copy of the license was not distributed with this
@@ -166,6 +166,8 @@ A list of predetermined actions that will be executed upon receiving the card. T
 - PROPAGATE_READ_ACK_TO_PARENT_CARD : used only for response cards. When receiving the child card, the status of the parent card should be considered as 'unread' and 'not acknowledged' until the user reads or acknowledge it again.
 - KEEP_EXISTING_ACKS_AND_READS : used to keep existing reads and acks when updating a card
 - STORE_ONLY_IN_ARCHIVES : used to store the card only in archivedCards collection and not in cards collection. No notification will be sent to UI, so the card will not be displayed in the feed and in monitoring screen.
+- NOT_NOTIFIED : when this action is set, the card is not visible in the card feed except for the publisher but it is visible in all the other screens : monitoring screen / agenda / timeline.
+The card is visible in the feed when the card will be reminded.
 
 === Business period 
 

src/test/api/karate/cards/cardsReminder.feature

@@ -76,6 +76,24 @@ Scenario: ResetCardsReadsAndAcks
 }
 """
 
+    * def cardWithNotNotifiedAction =
+"""
+{
+	"publisher" : "operator1_fr",
+	"processVersion" : "1",
+	"process"  :"api_test",
+	"processInstanceId" : "cardWithNotNotifiedAction",
+	"state": "messageState",
+    "groupRecipients": ["Maintainer"],
+	"severity" : "INFORMATION",
+	"startDate" : 1553186770681,
+	"summary" : {"key" : "defaultProcess.summary"},
+	"title" : {"key" : "defaultProcess.title"},
+	"data" : {"message":"a message"},
+	"actions" : ["NOT_NOTIFIED"]
+}
+"""
+
 
 # Push card
     Given url opfabPublishCardUrl + 'cards'
@@ -178,6 +196,40 @@ Scenario: ResetCardsReadsAndAcks
     And match response.card.hasBeenAcknowledged == false
     And match response.card.uid == uid
 
+    #Send a card with action NOT_NOTIFIED and call resetReadAndAcks endpoint
+    # Push card
+    Given url opfabPublishCardUrl + 'cards'
+    And header Authorization = 'Bearer ' + authToken
+    And request cardWithNotNotifiedAction
+    When method post
+    Then status 201
+
+    Given url opfabUrl + 'cards-consultation/cards/api_test.cardWithNotNotifiedAction'
+    And header Authorization = 'Bearer ' + authToken
+    When method get
+    Then status 200
+    And match response.card.hasBeenRead == false
+    And match response.card.hasBeenAcknowledged == false
+    And match response.card.actions == ["NOT_NOTIFIED"]
+    And def uid = response.card.uid
+
+    Given url opfabUrl + 'cards-publication/cards/resetReadAndAcks/' + uid
+    And header Authorization = 'Bearer ' + authTokenInternal
+    And request ''
+    When method post
+    Then status 200
+
+    #get card and check actions does not contain 'NOT_NOTIFIED' and hasBeenRead/hasBeenAcknowledged is set to false and entitiesAck is empty
+    Given url opfabUrl + 'cards-consultation/cards/api_test.cardWithNotNotifiedAction'
+    And header Authorization = 'Bearer ' + authToken
+    When method get
+    Then status 200
+    And match response.card.hasBeenRead == false
+    And match response.card.hasBeenAcknowledged == false
+    And match response.card.entitiesAcks == '#notpresent'
+    And match response.card.actions == '#notpresent'
+    And match response.card.uid == uid
+
   Scenario: Delete the test card
 
 #    delete card

ui/main/src/app/builtInTemplates/task/usercard/taskUserCardTemplateView.ts

@@ -1,4 +1,4 @@
-/* Copyright (c) 2023-2024, RTE (http://www.rte-france.com)
+/* Copyright (c) 2023-2025, RTE (http://www.rte-france.com)
  * See AUTHORS.txt
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -52,7 +52,8 @@ export class TaskUserCardTemplateView {
                 minutesForReminder: minutesForReminder,
                 durationInMinutes: durationInMinutes
             },
-            rRule: rRule
+            rRule: rRule,
+            actions: ['NOT_NOTIFIED']
         };
 
         return {

ui/main/src/app/components/feed/components/card-list/card-list.component.html

@@ -36,6 +36,7 @@
                 <div *ngFor="let currentLightCard of lightCards" style="margin-right: -10px">
                     <div style="padding-right: 20px; margin-bottom: 10px">
                         <of-light-card
+                            *ngIf="shouldLightcardBeNotified(currentLightCard)"
                             [lightCard]="currentLightCard"
                             [open]="
                                 currentLightCard.id === (selection | async) ||

ui/main/src/app/components/feed/components/card-list/card-list.component.ts

@@ -204,6 +204,13 @@ export class CardListComponent implements AfterViewChecked, OnInit {
         }
     }
 
+    protected shouldLightcardBeNotified(lightcard: Card): boolean {
+        return (
+            !lightcard.actions?.includes(CardAction.NOT_NOTIFIED) ||
+            this.currentUserWithPerimeters.userData.entities.includes(lightcard.publisher)
+        );
+    }
+
     isCardPublishedBeforeAckDemand(lightCard: Card): boolean {
         return lightCard.publishDate < this.ackAllCardsDemandTimestamp;
     }

ui/main/src/app/model/CardAction.ts

@@ -12,5 +12,6 @@ export enum CardAction {
     KEEP_CHILD_CARDS = 'KEEP_CHILD_CARDS',
     KEEP_EXISTING_ACKS_AND_READS = 'KEEP_EXISTING_ACKS_AND_READS',
     KEEP_EXISTING_PUBLISH_DATE = 'KEEP_EXISTING_PUBLISH_DATE',
-    STORE_ONLY_IN_ARCHIVES = 'STORE_ONLY_IN_ARCHIVES'
+    STORE_ONLY_IN_ARCHIVES = 'STORE_ONLY_IN_ARCHIVES',
+    NOT_NOTIFIED = 'NOT_NOTIFIED'
 }

ui/main/src/app/services/notifications/NotificationDecision.spec.ts

@@ -33,6 +33,23 @@ describe('Sound decisions', () => {
             done();
         });
 
+        it(
+            'No sound and system notification for card with action is NOT_NOTIFIED and user entities does not contains ' +
+                'card publisher entity',
+            (done) => {
+                const publishDate = new Date().getTime();
+                const card1 = getOneLightCard({
+                    publishDate: publishDate,
+                    publisher: 'ENTITY1_FR',
+                    actions: [CardAction.NOT_NOTIFIED]
+                });
+                NotificationDecision.setLastUserAction(publishDate - NotificationDecision.ERROR_MARGIN);
+                expect(NotificationDecision.isSoundToBePlayedForCard(card1)).toBeFalse();
+                expect(NotificationDecision.isSystemNotificationToBeShownForCard(card1)).toBeFalse();
+                done();
+            }
+        );
+
         it('No sound and system notification for cards recently sent by the user', (done) => {
             const publishDate = new Date().getTime();
             const card1 = getOneLightCard({publishDate: publishDate});

ui/main/src/app/services/notifications/NotificationDecision.ts

@@ -78,7 +78,8 @@ export class NotificationDecision {
             return (
                 !card.hasBeenRead &&
                 this.checkCardHasBeenPublishAfterLastUserAction(card) &&
-                this.checkCardIsRecent(card)
+                this.checkCardIsRecent(card) &&
+                this.shouldCardBeNotified(card)
             );
         }
     }
@@ -92,9 +93,9 @@ export class NotificationDecision {
 
     public static isSystemNotificationToBeShownForCard(card: Card) {
         if (this.lastSentCards.get(card.id) && !this.checkSentCardIsRecentlyPublished(card))
-            return false; // no sound as the card was sent by the current user
+            return false; // no system notification as the card was sent by the current user
         else {
-            return !card.hasBeenRead && this.checkCardIsRecent(card);
+            return !card.hasBeenRead && this.checkCardIsRecent(card) && this.shouldCardBeNotified(card);
         }
     }
 
@@ -150,4 +151,8 @@ export class NotificationDecision {
             this.cleanSentCards();
         }, this.CLEAN_CARDS_PERIOD);
     }
+
+    private static shouldCardBeNotified(card: Card): boolean {
+        return !card.actions?.includes(CardAction.NOT_NOTIFIED);
+    }
 }