Custom card list screen : add "Cards totally answered" filter (#7924)

freddidierRTE · vlo-rte · commit 3524c59bf238 · 2025-02-12T16:49:31.000+01:00
Signed-off-by: freddidierRTE &lt;frederic-f.didier@rte-france.com&gt;
diff --git a/config/docker/externalJs/CustomScreenExample.js b/config/docker/externalJs/CustomScreenExample.js
@@ -12,7 +12,7 @@
     const customScreenExample = {
         id: 'testId',
         name: 'testName',
-        headerFilters: ['PROCESS', 'TYPE_OF_STATE', 'RESPONSE_FROM_MY_ENTITIES'],
+        headerFilters: ['PROCESS', 'TYPE_OF_STATE', 'RESPONSE_FROM_MY_ENTITIES', 'RESPONSE_FROM_ALL_ENTITIES'],
         results: {
             columns: [
                 {
diff --git a/src/docs/asciidoc/reference_doc/ui_customization.adoc b/src/docs/asciidoc/reference_doc/ui_customization.adoc
@@ -405,7 +405,7 @@ opfab.businessconfig.registerCustomScreen(customScreenExample);
 
 In this example, the custom screen is accessible via the URL `#/customscreen/testId`.
 
-You can define the filters to be displayed in the header of the screen by adding them to the `headerFilters` array. The following filters are available: `PROCESS`, `TYPE_OF_STATE` and `RESPONSE_FROM_MY_ENTITIES`.
+You can define the filters to be displayed in the header of the screen by adding them to the `headerFilters` array. The following filters are available: `PROCESS`, `TYPE_OF_STATE`, `RESPONSE_FROM_MY_ENTITIES` and `RESPONSE_FROM_ALL_ENTITIES`.
 
 For each field you want to display in the result table, define a column object. The following field types are available:
 
diff --git a/ui/main/src/app/components/customCardList/CustomCardListComponent.html b/ui/main/src/app/components/customCardList/CustomCardListComponent.html
@@ -71,17 +71,32 @@ <h1>Custom Screen {{id}} does not exist</h1>
             </div>
         </div>
     </div>
-    <div *ngIf="!responseFromMyEntitiesFilterVisible" style="height: 20px"></div>
-    <div *ngIf="responseFromMyEntitiesFilterVisible" class="opfab-custom-card-list-response-checkbox">
-        <label
-            id="opfab-show-cards-with-response"
-            style="font-weight: bold; margin-left: 5px; margin-bottom: 0px"
-            class="opfab-checkbox"
-            translate
-            >feed.filters.showCardsWithResponse.label
-            <input type="checkbox" formControlName="responseFromMyEntities" />
-            <span class="opfab-checkbox-checkmark"></span>
-        </label>
+    <div
+        *ngIf="!responseFromMyEntitiesFilterVisible && !responseFromAllEntitiesFilterVisible"
+        style="height: 20px"></div>
+    <div class="opfab-custom-card-list-responses-checkbox">
+        <div *ngIf="responseFromMyEntitiesFilterVisible">
+            <label
+                id="opfab-show-cards-with-response"
+                style="font-weight: bold; margin-left: 5px; margin-right: 30px; margin-bottom: 0px"
+                class="opfab-checkbox"
+                translate
+                >feed.filters.showCardsWithResponse.label
+                <input type="checkbox" formControlName="responseFromMyEntities" />
+                <span class="opfab-checkbox-checkmark"></span>
+            </label>
+        </div>
+        <div *ngIf="responseFromAllEntitiesFilterVisible">
+            <label
+                id="opfab-show-cards-with-all-response"
+                style="font-weight: bold; margin-left: 5px; margin-bottom: 0px"
+                class="opfab-checkbox"
+                translate
+                >shared.filters.showCardsWithResponseFromAllEntities
+                <input type="checkbox" formControlName="responseFromAllEntities" />
+                <span class="opfab-checkbox-checkmark"></span>
+            </label>
+        </div>
     </div>
 
     <div
diff --git a/ui/main/src/app/components/customCardList/CustomCardListComponent.scss b/ui/main/src/app/components/customCardList/CustomCardListComponent.scss
@@ -27,12 +27,12 @@
     margin-right: 10px;
 }
 
-.opfab-custom-card-list-response-checkbox {
+.opfab-custom-card-list-responses-checkbox {
+    display: flex;
     margin-left: 5%;
     margin-top: 20px;
     margin-bottom: 10px;
     font-size: 30px;
-    border: solid 1px var(--opfab-bgcolor);
     text-align: center;
     background-color: var(--opfab-bgcolor);
     color: var(--opfab-text-color);
diff --git a/ui/main/src/app/components/customCardList/CustomCardListComponent.ts b/ui/main/src/app/components/customCardList/CustomCardListComponent.ts
@@ -73,7 +73,8 @@ export class CustomScreenComponent implements OnInit, OnDestroy {
         businessDateRanges: new FormControl({}),
         processes: new FormControl([]),
         typeOfState: new FormControl([]),
-        responseFromMyEntities: new FormControl(true)
+        responseFromMyEntities: new FormControl(true),
+        responseFromAllEntities: new FormControl(true)
     });
     modalRef: NgbModalRef;
 
@@ -111,6 +112,7 @@ export class CustomScreenComponent implements OnInit, OnDestroy {
     };
 
     responseFromMyEntitiesFilterVisible = false;
+    responseFromAllEntitiesFilterVisible = false;
     responseButtons = [];
     public rowSelection: RowSelectionOptions;
 
@@ -149,6 +151,9 @@ export class CustomScreenComponent implements OnInit, OnDestroy {
             this.responseFromMyEntitiesFilterVisible = this.customCardListView.isFilterVisibleInHeader(
                 HeaderFilter.RESPONSE_FROM_MY_ENTITIES
             );
+            this.responseFromAllEntitiesFilterVisible = this.customCardListView.isFilterVisibleInHeader(
+                HeaderFilter.RESPONSE_FROM_ALL_ENTITIES
+            );
             this.responseButtons = this.customCardListView.getResponseButtons();
             if (this.responseButtons.length > 0) this.rowSelection = {mode: 'multiRow'};
             this.gridOptions = {
@@ -315,22 +320,10 @@ export class CustomScreenComponent implements OnInit, OnDestroy {
         const startDate = Date.parse(businessDates.startDate?.toISOString());
         const endDate = Date.parse(businessDates.endDate?.toISOString());
         this.customCardListView.setBusinessPeriod(startDate, endDate);
-        const processIds = [];
-        this.headerForm.get('processes').value.forEach((processId: string) => {
-            processIds.push(processId);
-        });
-        this.customCardListView.setProcessList(processIds);
-        const typeOfState = [];
-        this.headerForm.get('typeOfState').value.forEach((type: string) => {
-            typeOfState.push(type);
-        });
-        this.customCardListView.setTypesOfStateFilter(typeOfState);
-        const responseFromMyEntities = this.headerForm.get('responseFromMyEntities').value;
-        if (responseFromMyEntities) {
-            this.customCardListView.includeCardsWithResponseFromMyEntities();
-        } else {
-            this.customCardListView.excludeCardsWithResponseFromMyEntities();
-        }
+        this.customCardListView.setProcessList([...this.headerForm.get('processes').value]);
+        this.customCardListView.setTypesOfStateFilter([...this.headerForm.get('typeOfState').value]);
+        this.customCardListView.setResponseFromMyEntitiesChoice(this.headerForm.get('responseFromMyEntities').value);
+        this.customCardListView.setResponseFromAllEntitiesChoice(this.headerForm.get('responseFromAllEntities').value);
         this.customCardListView.search();
     }
 
diff --git a/ui/main/src/app/services/cardResponse/CardResponse.spec.ts b/ui/main/src/app/services/cardResponse/CardResponse.spec.ts
@@ -121,7 +121,7 @@ describe('Card response service', () => {
         expect(cardServerMock.cardsPosted[0].entityRecipients).toContain('ENTITY1');
     });
 
-    it("Should set publihser to first entity user allowed to respond if publisher isn't provided", async () => {
+    it("Should set publisher to first entity user allowed to respond if publisher isn't provided", async () => {
         await CardResponseService.sendResponse(card, {});
         expect(cardServerMock.cardsPosted[0].publisher).toBe('ENTITY1');
     });
diff --git a/ui/main/src/app/services/customScreen/model/CustomScreenDefinition.ts b/ui/main/src/app/services/customScreen/model/CustomScreenDefinition.ts
@@ -56,5 +56,6 @@ export enum FieldType {
 export enum HeaderFilter {
     PROCESS = 'PROCESS',
     TYPE_OF_STATE = 'TYPE_OF_STATE',
-    RESPONSE_FROM_MY_ENTITIES = 'RESPONSE_FROM_MY_ENTITIES'
+    RESPONSE_FROM_MY_ENTITIES = 'RESPONSE_FROM_MY_ENTITIES',
+    RESPONSE_FROM_ALL_ENTITIES = 'RESPONSE_FROM_ALL_ENTITIES'
 }
diff --git a/ui/main/src/app/views/customCardList/CustomCardListView.ts b/ui/main/src/app/views/customCardList/CustomCardListView.ts
@@ -103,12 +103,20 @@ export class CustomCardListView {
         this.resultTable.setTypesOfStateFilter(typesOfState);
     }
 
-    public excludeCardsWithResponseFromMyEntities() {
-        this.resultTable.excludeCardsWithResponseFromMyEntities();
-    }
-
-    public includeCardsWithResponseFromMyEntities() {
-        this.resultTable.includeCardsWithResponseFromMyEntities();
+    //We disable sonar rules typescript:S2301 here because we
+    //want the method to reflect the checkbox status
+    public setResponseFromMyEntitiesChoice(checked: boolean) {
+        // NOSONAR
+        if (checked) {
+            this.resultTable.includeCardsWithResponseFromMyEntities();
+        } else this.resultTable.excludeCardsWithResponseFromMyEntities();
+    }
+
+    public setResponseFromAllEntitiesChoice(checked: boolean) {
+        // NOSONAR
+        if (checked) {
+            this.resultTable.includeCardsWithResponseFromAllEntities();
+        } else this.resultTable.excludeCardsWithResponseFromAllEntities();
     }
 
     public getProcessList(): {id: string; label: string}[] {
diff --git a/ui/main/src/app/views/customCardList/ResultTable.spec.ts b/ui/main/src/app/views/customCardList/ResultTable.spec.ts
@@ -588,6 +588,124 @@ describe('CustomScreenView - ResultTable', () => {
             const dataArray = resultTable.getDataArrayFromCards(cards, emptyChildCardsList);
             expect(dataArray).toEqual([{cardId: 'id1', testField: 'processId0'}]);
         });
+        it('that have all entities entitiesRequiredToRespond responded if excludeCardsWithAllEntitiesHaveResponded is called', () => {
+            const resultTable = getResultTable({
+                columns: [
+                    {
+                        field: 'testField',
+                        headerName: 'Process',
+                        cardField: 'process',
+                        fieldType: FieldType.STRING
+                    }
+                ]
+            });
+            const cards = [
+                getOneLightCard({
+                    process: 'processId1',
+                    state: 'state1.0',
+                    entitiesRequiredToRespond: ['entity1', 'entity2'],
+                    id: 'card1'
+                }),
+                getOneLightCard({
+                    process: 'processId2',
+                    state: 'state1.1',
+                    entitiesRequiredToRespond: ['entity1', 'entity2'],
+                    id: 'card2'
+                }),
+                getOneLightCard({
+                    process: 'processId3',
+                    state: 'state1.2',
+                    entitiesRequiredToRespond: [],
+                    id: 'card3'
+                })
+            ];
+            const childCards = new Map<string, Array<Card>>();
+            childCards.set('card1', [
+                getOneLightCard({
+                    publisher: 'entity1',
+                    publisherType: 'ENTITY',
+                    severity: Severity.ALARM
+                }),
+                getOneLightCard({
+                    publisher: 'entity2',
+                    publisherType: 'ENTITY',
+                    severity: Severity.ACTION
+                })
+            ]);
+            childCards.set('card2', [
+                getOneLightCard({
+                    publisher: 'entity1',
+                    publisherType: 'ENTITY',
+                    severity: Severity.COMPLIANT
+                })
+            ]);
+            resultTable.excludeCardsWithResponseFromAllEntities();
+            const dataArray = resultTable.getDataArrayFromCards(cards, childCards);
+            expect(dataArray).toEqual([
+                {
+                    cardId: 'card2',
+                    testField: 'processId2'
+                },
+                {
+                    cardId: 'card3',
+                    testField: 'processId3'
+                }
+            ]);
+        });
+        it('that have all entities in entitiesAllowedToRespond responded if entitiesRequiredToRespond is empty and excludeCardsWithAllEntitiesHaveResponded is called', () => {
+            const resultTable = getResultTable({
+                columns: [
+                    {
+                        field: 'testField',
+                        headerName: 'Process',
+                        cardField: 'process',
+                        fieldType: FieldType.STRING
+                    }
+                ]
+            });
+            const cards = [
+                getOneLightCard({
+                    process: 'processId1',
+                    state: 'state1.0',
+                    entitiesAllowedToRespond: ['entity1', 'entity2'],
+                    id: 'card1'
+                }),
+                getOneLightCard({
+                    process: 'processId2',
+                    state: 'state1.1',
+                    entitiesAllowedToRespond: ['entity1', 'entity2'],
+                    id: 'card2'
+                })
+            ];
+            const childCards = new Map<string, Array<Card>>();
+            childCards.set('card1', [
+                getOneLightCard({
+                    publisher: 'entity1',
+                    publisherType: 'ENTITY',
+                    severity: Severity.ALARM
+                }),
+                getOneLightCard({
+                    publisher: 'entity2',
+                    publisherType: 'ENTITY',
+                    severity: Severity.ACTION
+                })
+            ]);
+            childCards.set('card2', [
+                getOneLightCard({
+                    publisher: 'entity1',
+                    publisherType: 'ENTITY',
+                    severity: Severity.COMPLIANT
+                })
+            ]);
+            resultTable.excludeCardsWithResponseFromAllEntities();
+            const dataArray = resultTable.getDataArrayFromCards(cards, childCards);
+            expect(dataArray).toEqual([
+                {
+                    cardId: 'card2',
+                    testField: 'processId2'
+                }
+            ]);
+        });
     });
 
     describe('Should get responses in data array', () => {
diff --git a/ui/main/src/app/views/customCardList/ResultTable.ts b/ui/main/src/app/views/customCardList/ResultTable.ts
@@ -26,6 +26,7 @@ export class ResultTable {
     private processIds = [];
     private typesOfState = [];
     private areCardsWithResponseFromMyEntitiesExcluded = false;
+    private areCardsWithResponseFromAllEntitiesExcluded = false;
 
     constructor(customScreenDefinition: CustomScreenDefinition) {
         this.customScreenDefinition = customScreenDefinition;
@@ -131,13 +132,23 @@ export class ResultTable {
         this.areCardsWithResponseFromMyEntitiesExcluded = false;
     }
 
+    public excludeCardsWithResponseFromAllEntities() {
+        this.areCardsWithResponseFromAllEntitiesExcluded = true;
+    }
+
+    public includeCardsWithResponseFromAllEntities() {
+        this.areCardsWithResponseFromAllEntitiesExcluded = false;
+    }
+
     public getDataArrayFromCards(cards: Card[], childCards: Map<string, Array<Card>>): any[] {
         const dataArray = [];
         cards.forEach((card) => {
             if (!this.isCardInDateRange(card)) return;
             if (!this.isCardInProcessIds(card)) return;
             if (!this.isCardInTypesOfState(card)) return;
             if (this.areCardsWithResponseFromMyEntitiesExcluded && card.hasChildCardFromCurrentUserEntity) return;
+            if (this.areCardsWithResponseFromAllEntitiesExcluded && this.doesAllEntitiesHaveResponded(card, childCards))
+                return;
             const data = {};
             this.customScreenDefinition.results.columns.forEach((column) => {
                 switch (column.fieldType) {
@@ -198,6 +209,16 @@ export class ResultTable {
             value: dateAndTime.valueOf()
         };
     }
+    private doesAllEntitiesHaveResponded(card: Card, childCards: Map<string, Array<Card>>): boolean {
+        const entitiesToRespond = new Set(
+            card.entitiesRequiredToRespond?.length > 0
+                ? card.entitiesRequiredToRespond
+                : (card.entitiesAllowedToRespond ?? [])
+        );
+        if (entitiesToRespond.size === 0) return false;
+        const respondedEntities = new Set(childCards.get(card.id)?.map((card) => card.publisher) ?? []);
+        return Array.from(entitiesToRespond).every((entity) => respondedEntities.has(entity));
+    }
 
     private getPublisherLabel(card: Card): string {
         let publisherLabel = card.publisher;
diff --git a/ui/main/src/assets/i18n/en.json b/ui/main/src/assets/i18n/en.json
@@ -25,7 +25,8 @@
             "toDateBeforeFromDate": "'To' date must be after 'From' date.",
             "businessDateRange": "BUSINESS DATE RANGE",
             "publishDateRange":"PUBLISH DATE RANGE",
-            "activeDateRange": "ACTIVE DATE RANGE"
+            "activeDateRange": "ACTIVE DATE RANGE",
+            "showCardsWithResponseFromAllEntities": "Cards totally answered"
         },
         "result": {
             "severity": "SEVERITY",
diff --git a/ui/main/src/assets/i18n/fr.json b/ui/main/src/assets/i18n/fr.json
@@ -25,7 +25,8 @@
             "toDateBeforeFromDate": "La date 'Jusqu'à' doit être postérieure à la date 'À partir de'.",
             "businessDateRange": "PÉRIODE MÉTIER",
             "publishDateRange": "PÉRIODE DE PUBLICATION",
-            "activeDateRange": "PÉRIODE D'ACTIVITÉ"
+            "activeDateRange": "PÉRIODE D'ACTIVITÉ",
+            "showCardsWithResponseFromAllEntities": "Cartes avec réponse de toutes les entités"
         },
         "result": {
             "severity": "SÉVÉRITÉ",
diff --git a/ui/main/src/assets/i18n/nl.json b/ui/main/src/assets/i18n/nl.json
@@ -25,7 +25,8 @@
             "toDateBeforeFromDate": "'Tot' moet na 'Van' liggen.",
             "businessDateRange": "BEDRIJFSDATUMBEREIK",
             "publishDateRange": "PUBLICATIEDATUMBEREIK",
-            "activeDateRange": "ACTIEVE DATUMBEREIK"
+            "activeDateRange": "ACTIEVE DATUMBEREIK",
+            "showCardsWithResponseFromAllEntities": "Toon kaarten met reactie van alle entiteiten"
         },
         "result": {
             "severity": "ERNST",

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`const customScreenExample = {`
`13`	`13`	`id: 'testId',`
`14`	`14`	`name: 'testName',`
`15`		`- headerFilters: ['PROCESS', 'TYPE_OF_STATE', 'RESPONSE_FROM_MY_ENTITIES'],`
	`15`	`+ headerFilters: ['PROCESS', 'TYPE_OF_STATE', 'RESPONSE_FROM_MY_ENTITIES', 'RESPONSE_FROM_ALL_ENTITIES'],`
`16`	`16`	`results: {`
`17`	`17`	`columns: [`
`18`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -56,5 +56,6 @@ export enum FieldType {`
`56`	`56`	`export enum HeaderFilter {`
`57`	`57`	`PROCESS = 'PROCESS',`
`58`	`58`	`TYPE_OF_STATE = 'TYPE_OF_STATE',`
`59`		`- RESPONSE_FROM_MY_ENTITIES = 'RESPONSE_FROM_MY_ENTITIES'`
	`59`	`+ RESPONSE_FROM_MY_ENTITIES = 'RESPONSE_FROM_MY_ENTITIES',`
	`60`	`+ RESPONSE_FROM_ALL_ENTITIES = 'RESPONSE_FROM_ALL_ENTITIES'`
`60`	`61`	`}`