Merged in task/dspace-cris-2023_02_x/DSC-2354 (pull request DSpace#3179)

[DSC-2354] Optimize in-workflow statistics visualization

Approved-by: Vincenzo Mecca

Author: Andrea Barbasso

src/app/core/data/feature-authorization/feature-id.ts

@@ -39,4 +39,5 @@ export enum FeatureID {
   EPersonForgotPassword = 'epersonForgotPassword',
   ShowClaimItem = 'showClaimItem',
   CanCorrectItem = 'canCorrectItem',
+  CanViewInWorkflowSinceStatistics = 'canViewInWorkflowSinceStatistics',
 }

src/app/my-dspace-page/my-dspace-page.component.html

@@ -14,11 +14,11 @@
   [selectionConfig]="{ repeatable: true, listId: listId }"
   (deselectObject)="onDeselectObject($event)"
   (selectObject)="onSelectObject($event)"
->
-  <ds-my-dspace-bulk-action
+  [showWorkflowStatistics]="true">
+  <!-- Using *ngIf breaks the projection, so we are using hidden instead -->
+  <ds-my-dspace-bulk-action [hidden]="(currentConfiguration$ | async) !== workflowType"
     bulkActions
     [listId]="listId"
-    *ngIf="(currentConfiguration$ | async) === workflowType"
   ></ds-my-dspace-bulk-action>
   <ds-my-dspace-new-bulk-import additionalSearchFormOptions></ds-my-dspace-new-bulk-import>
 </ds-search>

src/app/shared/object-collection/object-collection.component.html

@@ -12,6 +12,7 @@
                 [showPaginator]="showPaginator"
                 [showThumbnails]="showThumbnails"
                 [showCorrection]="showCorrection"
+                [showWorkflowStatistics]="showWorkflowStatistics"
                 (paginationChange)="onPaginationChange($event)"
                 (pageChange)="onPageChange($event)"
                 (pageSizeChange)="onPageSizeChange($event)"
@@ -43,6 +44,7 @@
                 [showMetrics]="showMetrics"
                 [showPaginator]="showPaginator"
                 [showThumbnails]="showThumbnails"
+                [showWorkflowStatistics]="showWorkflowStatistics"
                 (paginationChange)="onPaginationChange($event)"
                 (pageChange)="onPageChange($event)"
                 (pageSizeChange)="onPageSizeChange($event)"
@@ -62,6 +64,7 @@
                   [showMetrics]="showMetrics"
                   [showPaginator]="showPaginator"
                   [showThumbnails]="showThumbnails"
+                  [showWorkflowStatistics]="showWorkflowStatistics"
                   (contentChange)="contentChange.emit($event)"
                   *ngIf="(currentMode$ | async) === viewModeEnum.DetailedListElement">
 </ds-object-detail>

src/app/shared/object-collection/object-collection.component.ts

@@ -135,6 +135,11 @@ export class ObjectCollectionComponent implements OnInit {
    */
   @Input() showCorrection = false;
 
+  /**
+   * A boolean representing if to show workflow statistics
+   */
+  @Input() showWorkflowStatistics;
+
   /**
    * Whether or not to show an alert for hidden related items
    */

src/app/shared/object-collection/shared/in-workflow-statistics/in-workflow-statistics.component.html

@@ -0,0 +1,8 @@
+<div *ngIf="canViewInWorkflowSinceStatistics$ | async" >
+  <div *ngIf="canViewInWorkflowForDate$ | async">
+    {{'mydspace.results.in-workflow-for' | translate}} {{inWorkflowFor$ | async}}
+  </div>
+  <div *ngIf="canViewInWorkflowSinceDate$ | async">
+    {{'mydspace.results.in-workflow-since' | translate}} {{inWorkflowSince$ | async}}
+  </div>
+</div>

src/app/shared/object-collection/shared/in-workflow-statistics/in-workflow-statistics.component.scss

@@ -0,0 +1,111 @@
+import {
+  Component,
+  Input,
+  OnInit,
+} from '@angular/core';
+import {
+  differenceInDays,
+  differenceInMilliseconds,
+  parseISO,
+} from 'date-fns';
+import {
+  BehaviorSubject,
+  Observable,
+  switchMap,
+} from 'rxjs';
+import {
+  map,
+  take,
+} from 'rxjs/operators';
+
+import { AuthorizationDataService } from '../../../../core/data/feature-authorization/authorization-data.service';
+import { FeatureID } from '../../../../core/data/feature-authorization/feature-id';
+import { ItemDataService } from '../../../../core/data/item-data.service';
+import { Item } from '../../../../core/shared/item.model';
+import { getFirstCompletedRemoteData } from '../../../../core/shared/operators';
+import { hasValue } from '../../../empty.util';
+
+@Component({
+  selector: 'ds-in-workflow-statistics',
+  templateUrl: './in-workflow-statistics.component.html',
+  styleUrls: ['./in-workflow-statistics.component.scss'],
+})
+export class InWorkflowStatisticsComponent implements OnInit {
+
+  @Input() item: Item;
+
+  canViewInWorkflowSinceStatistics$: BehaviorSubject<boolean> = new BehaviorSubject<boolean>(false);
+  canViewInWorkflowForDate$: BehaviorSubject<boolean> = new BehaviorSubject<boolean>(false);
+  canViewInWorkflowSinceDate$: BehaviorSubject<boolean> = new BehaviorSubject<boolean>(false);
+  inWorkflowFor$: BehaviorSubject<string> = new BehaviorSubject<string>(null);
+  inWorkflowSince$: BehaviorSubject<string> = new BehaviorSubject<string>(null);
+
+  constructor(
+    private authorizationService: AuthorizationDataService,
+    private itemDataService: ItemDataService,
+  ) {
+  }
+
+  ngOnInit(): void {
+    this.canViewInWorkflowSinceStatistics().pipe(take(1))
+      .subscribe((result: boolean) => {
+        if (result) {
+          this.initWorkflowDates();
+        }
+        this.canViewInWorkflowSinceStatistics$.next(result);
+      });
+  }
+
+  public canViewInWorkflowSinceStatistics(): Observable<boolean> {
+    if (hasValue(this.item?.self)) {
+      return this.isUserAuthorizedToViewItemInWorkflow(this.item.self);
+    } else {
+      // If self link has no value we fetch again the item from the rest.
+      // Since at this stage the item has most likely already been fetched we will get it from the cache
+      return this.itemDataService.findById(this.item.id).pipe(
+        getFirstCompletedRemoteData(),
+        map(data => data.payload.self),
+        switchMap(selfLink => this.isUserAuthorizedToViewItemInWorkflow(selfLink)),
+      );
+    }
+  }
+
+  public getDateForArchivedItem(itemStartDate: string, dateAccessioned: string) {
+    const itemStartDateConverted: Date = parseISO(itemStartDate);
+    const dateAccessionedConverted: Date = parseISO(dateAccessioned);
+    const days: number = Math.max(0, Math.floor(differenceInDays(dateAccessionedConverted, itemStartDateConverted)));
+    const remainingMilliseconds: number = differenceInMilliseconds(dateAccessionedConverted, itemStartDateConverted) - days * 24 * 60 * 60 * 1000;
+    const hours: number = Math.max(0, Math.floor(remainingMilliseconds / (60 * 60 * 1000)));
+    return `${days} d ${hours} h`;
+  }
+
+  public getDateForItem(itemStartDate: string) {
+    const itemStartDateConverted: Date = parseISO(itemStartDate);
+    const days: number = Math.max(0, Math.floor(differenceInDays(Date.now(), itemStartDateConverted)));
+    const remainingMilliseconds: number = differenceInMilliseconds(Date.now(), itemStartDateConverted) - days * 24 * 60 * 60 * 1000;
+    const hours: number = Math.max(0, Math.floor(remainingMilliseconds / (60 * 60 * 1000)));
+    return `${days} d ${hours} h`;
+  }
+
+  initWorkflowDates(): void {
+    if (this.item) {
+      if (this.item.isArchived) {
+        if (this.item.hasMetadata('dspace.workflow.startDateTime') && this.item.hasMetadata('dc.date.accessioned')) {
+          this.canViewInWorkflowForDate$.next(true);
+          this.inWorkflowFor$.next(
+            this.getDateForArchivedItem(this.item.firstMetadataValue('dspace.workflow.startDateTime'), this.item.firstMetadataValue('dc.date.accessioned')),
+          );
+        }
+      } else if (this.item.hasMetadata('dspace.workflow.startDateTime')) {
+        this.canViewInWorkflowSinceDate$.next(true);
+        this.inWorkflowSince$.next(
+          this.getDateForItem(this.item.firstMetadataValue('dspace.workflow.startDateTime')),
+        );
+      }
+    }
+  }
+
+  private isUserAuthorizedToViewItemInWorkflow(selfLink: string): Observable<boolean> {
+    return this.authorizationService.isAuthorized(FeatureID.CanViewInWorkflowSinceStatistics, selfLink);
+  }
+}

src/app/shared/object-collection/shared/in-workflow-statistics/in-workflow-statistics.component.ts

@@ -85,6 +85,11 @@ export class ListableObjectComponentLoaderComponent implements OnInit, OnChanges
    */
   @Input() showCorrection = false;
 
+  /**
+   * A boolean representing if to show workflow statistics
+   */
+  @Input() showWorkflowStatistics: boolean;
+
   /**
    * The value to display for this element
    */
@@ -139,6 +144,7 @@ export class ListableObjectComponentLoaderComponent implements OnInit, OnChanges
     'showMetrics',
     'showThumbnails',
     'showCorrection',
+    'showWorkflowStatistics',
     'context',
     'viewMode',
     'value',

src/app/shared/object-collection/shared/listable-object/listable-object-component-loader.component.ts

@@ -57,6 +57,11 @@ export class AbstractListableElementComponent<T extends ListableObject> {
    */
   @Input() showThumbnails: boolean;
 
+  /**
+   * A boolean representing if to show workflow statistics
+   */
+  @Input() showWorkflowStatistics = false;
+
   /**
    * The context we matched on to get this component
    */

src/app/shared/object-collection/shared/object-collection-element/abstract-listable-element.component.ts

@@ -23,6 +23,7 @@
                                              [showLabel]="showLabel"
                                              [showMetrics]="showMetrics"
                                              [showThumbnails]="showThumbnails"
+                                             [showWorkflowStatistics]="showWorkflowStatistics"
                                              (contentChange)="contentChange.emit($event)"></ds-listable-object-component-loader>
       </div>
     </div>