[CST-6876] Refactoring workflow actions components in order to pass item and workflowitem objects down from paren search element component to children

Author: atarix83

src/app/shared/mydspace-actions/claimed-task/abstract/claimed-task-actions-abstract.component.ts

@@ -10,11 +10,11 @@ import { RequestService } from '../../../../core/data/request.service';
 import { Observable } from 'rxjs';
 import { RemoteData } from '../../../../core/data/remote-data';
 import { WorkflowItem } from '../../../../core/submission/models/workflowitem.model';
-import { switchMap, take } from 'rxjs/operators';
+import { take } from 'rxjs/operators';
 import { CLAIMED_TASK } from '../../../../core/tasks/models/claimed-task-object.resource-type';
-import { getFirstSucceededRemoteDataPayload } from '../../../../core/shared/operators';
 import { Item } from '../../../../core/shared/item.model';
 import { MyDSpaceReloadableActionsComponent } from '../../mydspace-reloadable-actions';
+import { isEmpty } from '../../../empty.util';
 
 /**
  * Abstract component for rendering a claimed task's action
@@ -36,13 +36,23 @@ export abstract class ClaimedTaskActionsAbstractComponent extends MyDSpaceReload
 
   object: ClaimedTask;
 
+  /**
+   * The item object that belonging to the ClaimedTask object
+   */
+  item: Item;
+
   /**
    * Anchor used to reload the pool task.
    */
   itemUuid: string;
 
   subs = [];
 
+  /**
+   * The workflowitem object that belonging to the ClaimedTask object
+   */
+  workflowitem: WorkflowItem;
+
   protected constructor(protected injector: Injector,
                         protected router: Router,
                         protected notificationsService: NotificationsService,
@@ -85,16 +95,10 @@ export abstract class ClaimedTaskActionsAbstractComponent extends MyDSpaceReload
    * Retrieve the itemUuid.
    */
   initReloadAnchor() {
-    if (!(this.object as any).workflowitem) {
+    if (isEmpty(this.item)) {
       return;
     }
-    this.subs.push(this.object.workflowitem.pipe(
-      getFirstSucceededRemoteDataPayload(),
-      switchMap((workflowItem: WorkflowItem) => workflowItem.item.pipe(getFirstSucceededRemoteDataPayload())
-      ))
-      .subscribe((item: Item) => {
-        this.itemUuid = item.uuid;
-      }));
+    this.itemUuid = this.item.uuid;
   }
 
   ngOnDestroy() {

src/app/shared/mydspace-actions/claimed-task/claimed-task-actions.component.html

@@ -1,16 +1,23 @@
 <ng-container *ngVar="(actionRD$ | async)?.payload as workflowAction">
   <div class="mt-1 mb-3 space-children-mr">
-    <ds-claimed-task-actions-loader *ngFor="let option of workflowAction?.options" [option]="option" [object]="object"
-      (processCompleted)="this.processCompleted.emit($event)">
+    <ds-claimed-task-actions-loader *ngFor="let option of workflowAction?.options"
+                                    [item]="item"
+                                    [option]="option"
+                                    [object]="object"
+                                    [workflowitem]="workflowitem"
+                                    (processCompleted)="this.processCompleted.emit($event)">
     </ds-claimed-task-actions-loader>
 
     <button class="btn btn-primary workflow-view" ngbTooltip="{{'submission.workflow.generic.view-help' | translate}}"
-      [routerLink]="[getWorkflowItemViewRoute((workflowitem$ | async))]">
+      [routerLink]="[getWorkflowItemViewRoute(workflowitem)]">
       <i class="fa fa-info-circle"></i> {{"submission.workflow.generic.view" | translate}}
     </button>
 
-    <ds-claimed-task-actions-loader [option]="returnToPoolOption" [object]="object"
-      (processCompleted)="this.processCompleted.emit($event)">
+    <ds-claimed-task-actions-loader [item]="item"
+                                    [option]="returnToPoolOption"
+                                    [object]="object"
+                                    [workflowitem]="workflowitem"
+                                    (processCompleted)="this.processCompleted.emit($event)">
     </ds-claimed-task-actions-loader>
   </div>
 </ng-container>

src/app/shared/mydspace-actions/claimed-task/claimed-task-actions.component.spec.ts

@@ -3,7 +3,6 @@ import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
 import { Router } from '@angular/router';
 
 import { of as observableOf } from 'rxjs';
-import { cold } from 'jasmine-marbles';
 import { TranslateLoader, TranslateModule } from '@ngx-translate/core';
 
 import { TranslateLoaderMock } from '../../mocks/translate-loader.mock';
@@ -123,7 +122,9 @@ describe('ClaimedTaskActionsComponent', () => {
   beforeEach(() => {
     fixture = TestBed.createComponent(ClaimedTaskActionsComponent);
     component = fixture.componentInstance;
+    component.item = item;
     component.object = mockObject;
+    component.workflowitem = workflowitem;
     notificationsServiceStub = TestBed.inject(NotificationsService as any);
     router = TestBed.inject(Router as any);
     fixture.detectChanges();
@@ -133,11 +134,11 @@ describe('ClaimedTaskActionsComponent', () => {
     component.object = null;
     component.initObjects(mockObject);
 
+    expect(component.item).toEqual(item);
+
     expect(component.object).toEqual(mockObject);
 
-    expect(component.workflowitem$).toBeObservable(cold('(b|)', {
-      b: rdWorkflowitem.payload
-    }));
+    expect(component.workflowitem).toEqual(workflowitem);
   });
 
   it('should reload page on process completed', waitForAsync(() => {

src/app/shared/mydspace-actions/claimed-task/claimed-task-actions.component.ts

@@ -2,12 +2,10 @@ import { Component, Injector, Input, OnInit } from '@angular/core';
 import { Router } from '@angular/router';
 
 import { Observable } from 'rxjs';
-import { filter, map, take } from 'rxjs/operators';
 import { TranslateService } from '@ngx-translate/core';
 
 import { ClaimedTaskDataService } from '../../../core/tasks/claimed-task-data.service';
 import { ClaimedTask } from '../../../core/tasks/models/claimed-task-object.model';
-import { isNotUndefined } from '../../empty.util';
 import { WorkflowItem } from '../../../core/submission/models/workflowitem.model';
 import { RemoteData } from '../../../core/data/remote-data';
 import { MyDSpaceActionsComponent } from '../mydspace-actions';
@@ -18,6 +16,7 @@ import { WorkflowAction } from '../../../core/tasks/models/workflow-action-objec
 import { WorkflowActionDataService } from '../../../core/data/workflow-action-data.service';
 import { WORKFLOW_TASK_OPTION_RETURN_TO_POOL } from './return-to-pool/claimed-task-actions-return-to-pool.component';
 import { getWorkflowItemViewRoute } from '../../../workflowitems-edit-page/workflowitems-edit-page-routing-paths';
+import { Item } from '../../../core/shared/item.model';
 
 /**
  * This component represents actions related to ClaimedTask object.
@@ -34,10 +33,15 @@ export class ClaimedTaskActionsComponent extends MyDSpaceActionsComponent<Claime
    */
   @Input() object: ClaimedTask;
 
+  /**
+   * The item object that belonging to the ClaimedTask object
+   */
+  @Input() item: Item;
+
   /**
    * The workflowitem object that belonging to the ClaimedTask object
    */
-  public workflowitem$: Observable<WorkflowItem>;
+  @Input() workflowitem: WorkflowItem;
 
   /**
    * The workflow action available for this task
@@ -87,11 +91,6 @@ export class ClaimedTaskActionsComponent extends MyDSpaceActionsComponent<Claime
    */
   initObjects(object: ClaimedTask) {
     this.object = object;
-
-    this.workflowitem$ = (this.object.workflowitem as Observable<RemoteData<WorkflowItem>>).pipe(
-      filter((rd: RemoteData<WorkflowItem>) => ((!rd.isRequestPending) && isNotUndefined(rd.payload))),
-      map((rd: RemoteData<WorkflowItem>) => rd.payload),
-      take(1));
   }
 
   /**

src/app/shared/mydspace-actions/claimed-task/switcher/claimed-task-actions-loader.component.spec.ts

@@ -1,5 +1,5 @@
 import { ClaimedTaskActionsLoaderComponent } from './claimed-task-actions-loader.component';
-import { waitForAsync, ComponentFixture, TestBed } from '@angular/core/testing';
+import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
 import { ChangeDetectionStrategy, Injector, NO_ERRORS_SCHEMA } from '@angular/core';
 import { ClaimedTaskActionsDirective } from './claimed-task-actions.directive';
 import { ClaimedTask } from '../../../../core/tasks/models/claimed-task-object.model';
@@ -15,6 +15,8 @@ import { RequestService } from '../../../../core/data/request.service';
 import { PoolTaskDataService } from '../../../../core/tasks/pool-task-data.service';
 import { getMockSearchService } from '../../../mocks/search-service.mock';
 import { getMockRequestService } from '../../../mocks/request.service.mock';
+import { Item } from '../../../../core/shared/item.model';
+import { WorkflowItem } from '../../../../core/submission/models/workflowitem.model';
 
 const searchService = getMockSearchService();
 
@@ -27,6 +29,37 @@ describe('ClaimedTaskActionsLoaderComponent', () => {
   const option = 'test_option';
   const object = Object.assign(new ClaimedTask(), { id: 'claimed-task-1' });
 
+  const item = Object.assign(new Item(), {
+    metadata: {
+      'dc.title': [
+        {
+          language: 'en_US',
+          value: 'This is just another title'
+        }
+      ],
+      'dc.type': [
+        {
+          language: null,
+          value: 'Article'
+        }
+      ],
+      'dc.contributor.author': [
+        {
+          language: 'en_US',
+          value: 'Smith, Donald'
+        }
+      ],
+      'dc.date.issued': [
+        {
+          language: null,
+          value: '2015-06-26'
+        }
+      ]
+    }
+  });
+
+  const workflowitem = Object.assign(new WorkflowItem(), { id: '333' });
+
   beforeEach(waitForAsync(() => {
     TestBed.configureTestingModule({
       imports: [TranslateModule.forRoot()],
@@ -52,8 +85,10 @@ describe('ClaimedTaskActionsLoaderComponent', () => {
   beforeEach(waitForAsync(() => {
     fixture = TestBed.createComponent(ClaimedTaskActionsLoaderComponent);
     comp = fixture.componentInstance;
+    comp.item = item;
     comp.object = object;
     comp.option = option;
+    comp.workflowitem = workflowitem;
     spyOn(comp, 'getComponentByWorkflowTaskOption').and.returnValue(ClaimedTaskActionsEditMetadataComponent);
 
     fixture.detectChanges();

src/app/shared/mydspace-actions/claimed-task/switcher/claimed-task-actions-loader.component.ts

@@ -15,6 +15,8 @@ import { ClaimedTaskActionsAbstractComponent } from '../abstract/claimed-task-ac
 import { hasValue } from '../../../empty.util';
 import { Subscription } from 'rxjs';
 import { MyDSpaceActionsResult } from '../../mydspace-actions';
+import { Item } from '../../../../core/shared/item.model';
+import { WorkflowItem } from '../../../../core/submission/models/workflowitem.model';
 
 @Component({
   selector: 'ds-claimed-task-actions-loader',
@@ -25,6 +27,11 @@ import { MyDSpaceActionsResult } from '../../mydspace-actions';
  * Passes on the ClaimedTask to the component and subscribes to the processCompleted output
  */
 export class ClaimedTaskActionsLoaderComponent implements OnInit, OnDestroy {
+  /**
+   * The item object that belonging to the ClaimedTask object
+   */
+  @Input() item: Item;
+
   /**
    * The ClaimedTask object
    */
@@ -36,6 +43,11 @@ export class ClaimedTaskActionsLoaderComponent implements OnInit, OnDestroy {
    */
   @Input() option: string;
 
+  /**
+   * The workflowitem object that belonging to the ClaimedTask object
+   */
+  @Input() workflowitem: WorkflowItem;
+
   /**
    * Emits the success or failure of a processed action
    */
@@ -69,7 +81,9 @@ export class ClaimedTaskActionsLoaderComponent implements OnInit, OnDestroy {
 
       const componentRef = viewContainerRef.createComponent(componentFactory);
       const componentInstance = (componentRef.instance as ClaimedTaskActionsAbstractComponent);
+      componentInstance.item = this.item;
       componentInstance.object = this.object;
+      componentInstance.workflowitem = this.workflowitem;
       if (hasValue(componentInstance.processCompleted)) {
         this.subs.push(componentInstance.processCompleted.subscribe((result) => this.processCompleted.emit(result)));
       }

src/app/shared/mydspace-actions/mydspace-reloadable-actions.spec.ts

@@ -12,10 +12,7 @@ import { RouterStub } from '../testing/router.stub';
 import { getMockSearchService } from '../mocks/search-service.mock';
 import { getMockRequestService } from '../mocks/request.service.mock';
 import { Item } from '../../core/shared/item.model';
-import {
-  createFailedRemoteDataObject,
-  createSuccessfulRemoteDataObject
-} from '../remote-data.utils';
+import { createFailedRemoteDataObject, createSuccessfulRemoteDataObject } from '../remote-data.utils';
 import { WorkflowItem } from '../../core/submission/models/workflowitem.model';
 import { TranslateLoaderMock } from '../mocks/translate-loader.mock';
 import { NotificationsService } from '../notifications/notifications.service';
@@ -103,7 +100,9 @@ describe('MyDSpaceReloadableActionsComponent', () => {
   beforeEach(() => {
     fixture = TestBed.createComponent(PoolTaskActionsComponent);
     component = fixture.componentInstance;
+    component.item = item;
     component.object = mockObject;
+    component.workflowitem = workflowitem;
     notificationsServiceStub = TestBed.get(NotificationsService);
     router = TestBed.get(Router);
     fixture.detectChanges();

src/app/shared/mydspace-actions/pool-task/pool-task-actions.component.html

@@ -8,6 +8,6 @@
 </button>
 <button class="btn btn-primary workflow-view ml-1 mt-1 mb-3" data-test="view-btn"
   ngbTooltip="{{'submission.workflow.generic.view-help' | translate}}"
-  [routerLink]="[getWorkflowItemViewRoute((workflowitem$ | async))]">
+  [routerLink]="[getWorkflowItemViewRoute(workflowitem)]">
   <i class="fa fa-info-circle"></i> {{"submission.workflow.generic.view" | translate}}
 </button>

src/app/shared/mydspace-actions/pool-task/pool-task-actions.component.spec.ts

@@ -4,7 +4,6 @@ import { Router } from '@angular/router';
 import { By } from '@angular/platform-browser';
 
 import { of as observableOf } from 'rxjs';
-import { cold } from 'jasmine-marbles';
 import { TranslateLoader, TranslateModule } from '@ngx-translate/core';
 
 import { TranslateLoaderMock } from '../../mocks/translate-loader.mock';
@@ -105,7 +104,9 @@ describe('PoolTaskActionsComponent', () => {
   beforeEach(() => {
     fixture = TestBed.createComponent(PoolTaskActionsComponent);
     component = fixture.componentInstance;
+    component.item = item;
     component.object = mockObject;
+    component.workflowitem = workflowitem;
     notificationsServiceStub = TestBed.inject(NotificationsService as any);
     router = TestBed.inject(Router as any);
     fixture.detectChanges();
@@ -120,11 +121,11 @@ describe('PoolTaskActionsComponent', () => {
     component.object = null;
     component.initObjects(mockObject);
 
+    expect(component.item).toEqual(item);
+
     expect(component.object).toEqual(mockObject);
 
-    expect(component.workflowitem$).toBeObservable(cold('(b|)', {
-      b: rdWorkflowitem.payload
-    }));
+    expect(component.workflowitem).toEqual(workflowitem);
   });
 
   it('should display claim task button', () => {