From 2a3b32305a256178dc4f8f7b46f71fe6bd8c1bd5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adina=20=C8=9Aeudan?= <adina@devplant.ro>
Date: Tue, 8 Feb 2022 17:49:14 +0200
Subject: [PATCH] RED-3356: Add Error handling for missing type in redaction
 log

---
 .../base-screen/base-screen.component.html    |  6 +-
 .../src/app/models/file/file-data.model.ts    | 16 ++++-
 .../app/models/file/redaction-log.entry.ts    |  1 -
 .../annotation-references-list.component.html |  5 +-
 .../annotation-references-list.component.scss |  4 ++
 .../services/pdf-viewer-data.service.ts       | 25 +++++--
 apps/red-ui/src/app/utils/constants.ts        |  1 +
 apps/red-ui/src/assets/i18n/en.json           | 69 +++++++++----------
 8 files changed, 73 insertions(+), 54 deletions(-)

diff --git a/apps/red-ui/src/app/components/base-screen/base-screen.component.html b/apps/red-ui/src/app/components/base-screen/base-screen.component.html
index 1f7abb691..969a9a4ca 100644
--- a/apps/red-ui/src/app/components/base-screen/base-screen.component.html
+++ b/apps/red-ui/src/app/components/base-screen/base-screen.component.html
@@ -33,9 +33,9 @@
 
         <mat-menu #userMenu="matMenu" xPosition="before">
             <ng-container *ngFor="let item of userMenuItems; trackBy: trackByName">
-                <button (click)="(item.action)" *ngIf="item.show" [routerLink]="item.routerLink" mat-menu-item translate>
-                    {{ item.name }}
-                </button>
+                <a (click)="(item.action)" *ngIf="item.show" [routerLink]="item.routerLink" mat-menu-item>
+                    {{ item.name | translate }}
+                </a>
             </ng-container>
 
             <button (click)="userService.logout()" mat-menu-item>
diff --git a/apps/red-ui/src/app/models/file/file-data.model.ts b/apps/red-ui/src/app/models/file/file-data.model.ts
index 36b1a7870..75702ad19 100644
--- a/apps/red-ui/src/app/models/file/file-data.model.ts
+++ b/apps/red-ui/src/app/models/file/file-data.model.ts
@@ -13,6 +13,7 @@ import { AnnotationWrapper } from './annotation.wrapper';
 import * as moment from 'moment';
 import { BehaviorSubject } from 'rxjs';
 import { RedactionLogEntry } from './redaction-log.entry';
+import { MISSING_TYPES_ERROR } from '@utils/constants';
 
 export class FileDataModel {
     static readonly DELTA_VIEW_TIME = 10 * 60 * 1000; // 10 minutes;
@@ -76,18 +77,23 @@ export class FileDataModel {
 
     private _convertData(): RedactionLogEntry[] {
         let result: RedactionLogEntry[] = [];
+        const missingTypes = new Set<string>();
 
         const reasonAnnotationIds: { [key: string]: RedactionLogEntry[] } = {};
         this.redactionLog.redactionLogEntry?.forEach(redactionLogEntry => {
             // copy the redactionLog Entry
 
-            const changeLogValues = this.getChangeLogValues(redactionLogEntry);
+            const changeLogValues = this.#getChangeLogValues(redactionLogEntry);
+            if (!this._dictionaryData[redactionLogEntry.type]) {
+                missingTypes.add(redactionLogEntry.type);
+                return;
+            }
+
             const redactionLogEntryWrapper: RedactionLogEntry = new RedactionLogEntry(
                 redactionLogEntry,
                 changeLogValues.changeLogType,
                 changeLogValues.isChangeLogEntry,
                 changeLogValues.hidden,
-                this._dictionaryData[redactionLogEntry.type].hint,
                 this.redactionLog.legalBasis,
             );
 
@@ -123,10 +129,14 @@ export class FileDataModel {
 
         result = result.filter(r => !r.hidden);
 
+        if (missingTypes.size > 0) {
+            throw new Error(MISSING_TYPES_ERROR);
+        }
+
         return result;
     }
 
-    private getChangeLogValues(redactionLogEntry: IRedactionLogEntry): {
+    #getChangeLogValues(redactionLogEntry: IRedactionLogEntry): {
         hidden: boolean;
         changeLogType: ChangeType;
         isChangeLogEntry: boolean;
diff --git a/apps/red-ui/src/app/models/file/redaction-log.entry.ts b/apps/red-ui/src/app/models/file/redaction-log.entry.ts
index 1a82a09fe..5aeabda21 100644
--- a/apps/red-ui/src/app/models/file/redaction-log.entry.ts
+++ b/apps/red-ui/src/app/models/file/redaction-log.entry.ts
@@ -36,7 +36,6 @@ export class RedactionLogEntry implements IRedactionLogEntry {
         readonly changeLogType: 'ADDED' | 'REMOVED' | 'CHANGED',
         readonly isChangeLogEntry: boolean,
         readonly hidden: boolean,
-        readonly hintDictionary: boolean,
         readonly legalBasisList: ILegalBasis[],
     ) {
         this.changes = redactionLogEntry.changes;
diff --git a/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/annotation-references-list/annotation-references-list.component.html b/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/annotation-references-list/annotation-references-list.component.html
index 2b038ba7a..e8bca50cc 100644
--- a/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/annotation-references-list/annotation-references-list.component.html
+++ b/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/annotation-references-list/annotation-references-list.component.html
@@ -1,9 +1,8 @@
 <div *ngIf="references$ | async as references" class="content-container">
     <div class="dialog references-dialog">
         <div class="references-header flex">
-            <div class="small-label">
-                {{ references.length }}
-                {{ (references.length === 1 ? 'references.singular' : 'references.plural') | translate }}
+            <div class="small-label uppercase">
+                {{ 'references' | translate: { count: references.length } }}
             </div>
             <iqser-circle-button (action)="annotationReferencesService.hide()" icon="iqser:close"></iqser-circle-button>
         </div>
diff --git a/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/annotation-references-list/annotation-references-list.component.scss b/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/annotation-references-list/annotation-references-list.component.scss
index 537436d50..69f3d97f6 100644
--- a/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/annotation-references-list/annotation-references-list.component.scss
+++ b/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/annotation-references-list/annotation-references-list.component.scss
@@ -1,5 +1,9 @@
 @use 'variables';
 
+.uppercase {
+    text-transform: uppercase;
+}
+
 .references-dialog {
     position: fixed;
     margin: 0;
diff --git a/apps/red-ui/src/app/modules/dossier/services/pdf-viewer-data.service.ts b/apps/red-ui/src/app/modules/dossier/services/pdf-viewer-data.service.ts
index b4430c3df..70a8b48f2 100644
--- a/apps/red-ui/src/app/modules/dossier/services/pdf-viewer-data.service.ts
+++ b/apps/red-ui/src/app/modules/dossier/services/pdf-viewer-data.service.ts
@@ -6,9 +6,12 @@ import { PermissionsService } from '@services/permissions.service';
 import { File, IRedactionLog, IViewedPage } from '@red/domain';
 import { RedactionLogService } from './redaction-log.service';
 import { ViewedPagesService } from '@services/entity-services/viewed-pages.service';
-import { AppStateService } from '../../../state/app-state.service';
-import { UserPreferenceService } from '../../../services/user-preference.service';
+import { AppStateService } from '@state/app-state.service';
+import { UserPreferenceService } from '@services/user-preference.service';
 import { FilePreviewStateService } from '../screens/file-preview-screen/services/file-preview-state.service';
+import { Toaster } from '@iqser/common-ui';
+import { MISSING_TYPES_ERROR } from '@utils/constants';
+import { marker as _ } from '@biesbjerg/ngx-translate-extract-marker';
 
 @Injectable()
 export class PdfViewerDataService {
@@ -19,6 +22,7 @@ export class PdfViewerDataService {
         private readonly _appStateService: AppStateService,
         private readonly _userPreferenceService: UserPreferenceService,
         private readonly _stateService: FilePreviewStateService,
+        private readonly _toaster: Toaster,
     ) {}
 
     loadRedactionLogFor(dossierId: string, fileId: string) {
@@ -33,15 +37,22 @@ export class PdfViewerDataService {
         const viewedPages$ = this.getViewedPagesFor(newFile);
 
         return forkJoin([redactionLog$, viewedPages$]).pipe(
-            map(
-                (data: [redactionLog: IRedactionLog, viewedPages: IViewedPage[]]) =>
-                    new FileDataModel(
+            map((data: [redactionLog: IRedactionLog, viewedPages: IViewedPage[]]) => {
+                try {
+                    return new FileDataModel(
                         newFile,
                         ...data,
                         this._appStateService.dictionaryData[this._stateService.dossierTemplateId],
                         this._userPreferenceService.areDevFeaturesEnabled,
-                    ),
-            ),
+                    );
+                } catch (error) {
+                    if (error.message === MISSING_TYPES_ERROR) {
+                        this._toaster.error(_('error.missing-types'), { disableTimeOut: true });
+                    } else {
+                        throw error;
+                    }
+                }
+            }),
         );
     }
 
diff --git a/apps/red-ui/src/app/utils/constants.ts b/apps/red-ui/src/app/utils/constants.ts
index 63ba0e493..5b70b1f9f 100644
--- a/apps/red-ui/src/app/utils/constants.ts
+++ b/apps/red-ui/src/app/utils/constants.ts
@@ -1 +1,2 @@
 export const CHANGED_CHECK_INTERVAL = 5000;
+export const MISSING_TYPES_ERROR = 'MISSING_TYPES_ERROR';
diff --git a/apps/red-ui/src/assets/i18n/en.json b/apps/red-ui/src/assets/i18n/en.json
index 642abf35c..b62b6d63e 100644
--- a/apps/red-ui/src/assets/i18n/en.json
+++ b/apps/red-ui/src/assets/i18n/en.json
@@ -1,4 +1,8 @@
 {
+  "accept-recommendation-dialog": {
+    "header": "Accept recommendation",
+    "multiple-values": "Multiple recommendations selected"
+  },
   "account-settings": "Account Settings",
   "actions": {
     "all": "All",
@@ -141,10 +145,6 @@
     "settings": "Settings"
   },
   "annotation": "Annotation",
-  "references": {
-    "singular": "REFERENCE",
-    "plural": "REFERENCES"
-  },
   "annotation-actions": {
     "accept-recommendation": {
       "label": "Accept Recommendation"
@@ -161,9 +161,6 @@
     "force-redaction": {
       "label": "Force Redaction"
     },
-    "see-references": {
-      "label": "See References"
-    },
     "hide": "Hide",
     "message": {
       "dictionary": {
@@ -268,12 +265,15 @@
     "resize": {
       "label": "Resize"
     },
+    "see-references": {
+      "label": "See References"
+    },
     "show": "Show",
     "undo": "Undo"
   },
   "annotation-changes": {
-    "forced-redaction": "Redaction forced",
     "forced-hint": "Hint forced",
+    "forced-redaction": "Redaction forced",
     "header": "Manual changes:",
     "legal-basis": "Reason changed",
     "recategorized": "Image category changed",
@@ -296,6 +296,7 @@
     "suggestion-add": "Suggested redaction",
     "suggestion-add-dictionary": "Suggested dictionary add",
     "suggestion-change-legal-basis": "Suggested change legal basis",
+    "suggestion-force-hint": "",
     "suggestion-force-redaction": "Suggestion force hint",
     "suggestion-recategorize-image": "Suggested recategorize image",
     "suggestion-remove": "Suggested local removal",
@@ -303,7 +304,6 @@
     "suggestion-resize": "Suggested Resize"
   },
   "annotations": "Annotations",
-  "archived": "Archived",
   "assign-dossier-owner": {
     "dialog": {
       "approvers": "Approvers",
@@ -311,7 +311,6 @@
       "no-reviewers": "No members with \"review only\" permission.",
       "reviewers": "Reviewers",
       "search": "Search...",
-      "select-below": "Select from the list below.",
       "single-user": "Owner"
     }
   },
@@ -403,14 +402,14 @@
   "confirm-delete-file-attribute": {
     "cancel": "Keep {type, select, single{Attribute} bulk{Attributes} other{}}",
     "delete": "Delete {type, select, single{Attribute} bulk{Attributes} other{}}",
-    "file-impacted-documents": "All documents {type, select, single{it is} bulk{they are} other{}} used on will be impacted",
     "dossier-impacted-documents": "All dossiers based on this template will be affected",
-    "file-lost-details": "All inputted details on the documents will be lost",
     "dossier-lost-details": "All values for this attribute will be lost",
+    "file-impacted-documents": "All documents {type, select, single{it is} bulk{they are} other{}} used on will be impacted",
+    "file-lost-details": "All inputted details on the documents will be lost",
+    "impacted-report": "{count} reports use the placeholder for this attribute and need to be adjusted",
     "title": "Delete {type, select, single{{name}} bulk{File Attributes} other{}}",
     "toast-error": "Please confirm that you understand the ramifications of your action!",
-    "warning": "Warning: this cannot be undone!",
-    "impacted-report": "{count} reports use the placeholder for this attribute and need to be adjusted"
+    "warning": "Warning: this cannot be undone!"
   },
   "confirm-delete-users": {
     "cancel": "Keep {usersCount, plural, one{User} other{Users}}",
@@ -459,6 +458,12 @@
       "question": "Are you sure you want to delete {filesCount, plural, one{this document} other{these documents}}?",
       "title": "Delete {filesCount, plural, one{{fileName}} other{Selected Documents}}"
     },
+    "report-template-same-name": {
+      "confirmation-text": "Yes. Continue upload",
+      "deny-text": "No. Cancel Upload",
+      "question": "There is already a Report Template with the name: <b>{fileName}</b>. Do you wish to continue?",
+      "title": "Report Template Upload"
+    },
     "unsaved-changes": {
       "confirmation-text": "Save and Leave",
       "details": "If you leave the tab without saving, all the unsaved changes will be lost.",
@@ -472,12 +477,6 @@
       "deny-text": "Cancel Upload",
       "question": "Please choose if <b>{fileName}</b> is a single or multi-file report template",
       "title": "Report Template Upload"
-    },
-    "report-template-same-name": {
-      "confirmation-text": "Yes. Continue upload",
-      "deny-text": "No. Cancel Upload",
-      "question": "There is already a Report Template with the name: <b>{fileName}</b>. Do you wish to continue?",
-      "title": "Report Template Upload"
     }
   },
   "content": "Reason",
@@ -790,8 +789,8 @@
     },
     "table-col-names": {
       "added-on": "Added",
-      "last-modified": "Last modified on",
       "assigned-to": "Assigned to",
+      "last-modified": "Last modified on",
       "name": "Name",
       "needs-work": "Workload",
       "pages": "Pages",
@@ -808,20 +807,12 @@
   "dossier-template-info-screen": {
     "created-by": "Created by",
     "created-on": "Created on: {date}",
-    "valid-from": "Valid from: {date}",
-    "valid-to": "Valid to: {date}",
     "description": "Description",
     "dictionaries": "{count} {count, plural, one{dictionary} other{dictionaries}}",
     "entries": "{count} {count, plural, one{entry} other{entries}}",
-    "modified-on": "Modified on: {date}"
-  },
-  "dossier-templates": {
-    "label": "Dossier Templates",
-    "status": {
-      "label": "Status",
-      "active": "Active",
-      "incomplete": "Incomplete"
-    }
+    "modified-on": "Modified on: {date}",
+    "valid-from": "Valid from: {date}",
+    "valid-to": "Valid to: {date}"
   },
   "dossier-templates-listing": {
     "action": {
@@ -855,6 +846,13 @@
       "title": "{length} dossier {length, plural, one{template} other{templates}}"
     }
   },
+  "dossier-templates": {
+    "label": "Dossier Templates",
+    "status": {
+      "active": "Active",
+      "incomplete": "Incomplete"
+    }
+  },
   "download-includes": "Choose what is included at download:",
   "download-status": {
     "queued": "Your download has been queued, you can see all your requested downloads here: <a href='/ui/main/downloads'>My Downloads<a/>."
@@ -1002,6 +1000,7 @@
     "http": {
       "generic": "Action failed with code {status}"
     },
+    "missing-types": "The dossier template has missing types. Data might not be displayed correctly.",
     "offline": "Disconnected",
     "online": "Reconnected",
     "reload": "Reload",
@@ -1379,10 +1378,6 @@
       }
     }
   },
-  "accept-recommendation-dialog": {
-    "header": "Accept recommendation",
-    "multiple-values": "Multiple recommendations selected"
-  },
   "months": {
     "apr": "Apr.",
     "aug": "Aug.",
@@ -1474,7 +1469,6 @@
     },
     "toggle-tooltips": "{active, select, true{Disable} false{Enable} other{}} annotation tooltips"
   },
-  "pending-changes-guard": "WARNING: You have unsaved changes. Press Cancel to go back and save these changes, or OK to lose these changes.",
   "readonly": "Read only",
   "recategorize-image-dialog": {
     "actions": {
@@ -1489,6 +1483,7 @@
     "header": "Edit Image Type"
   },
   "redaction": "Redaction",
+  "references": "{count} {count, plural, one{reference} other{references}}",
   "remove-annotations-dialog": {
     "cancel": "Cancel",
     "confirm": "Yes, proceed and remove!",