[UXP-147] Refactoring external upload step in order to use common behaviour to update section data and errors

Author: atarix83

src/app/submission/objects/submission-objects.actions.ts

@@ -1088,6 +1088,7 @@ export class ExecuteExternalUploadErrorAction implements Action {
   type = SubmissionObjectActionTypes.EXECUTE_EXTERNAL_UPLOAD_ERROR;
   payload: {
     submissionId: string;
+    sectionId: string;
     errors: SubmissionObjectError[]
   };
 
@@ -1096,11 +1097,13 @@ export class ExecuteExternalUploadErrorAction implements Action {
    *
    * @param submissionId
    *    the submission's ID
+   * @param sectionId
+   *    the section's ID
    * @param errors
    *    the section's ID
    */
-  constructor(submissionId: string, errors: SubmissionObjectError[]) {
-    this.payload = { submissionId, errors };
+  constructor(submissionId: string,  sectionId: string, errors: SubmissionObjectError[]) {
+    this.payload = { submissionId, sectionId, errors };
   }
 }
 

src/app/submission/objects/submission-objects.effects.ts

@@ -401,28 +401,24 @@ export class SubmissionObjectEffects {
         'sections',
         action.payload.sectionId).pipe(
           map((response: SubmissionObject[]) => {
-            const errors = [].concat.apply([], response.map(sub => sub.errors));
-            const sectionErrors = errors.filter((errorObject: SubmissionObjectError) => errorObject.paths.length > 0)
-              .filter(err => err.paths.includes('/sections/' + action.payload.sectionId));
+            const { errors } = response[0];
+            const errorsMap = parseSectionErrors(errors);
+            const sectionErrors = errorsMap[action.payload.sectionId];
 
-            if (sectionErrors.length > 0) {
-              return new ExecuteExternalUploadErrorAction(action.payload.submissionId, sectionErrors);
+            if (sectionErrors?.length > 0) {
+              return [new ExecuteExternalUploadErrorAction(action.payload.submissionId, action.payload.sectionId, sectionErrors)];
             } else {
-              const index: any = parseInt(action.payload.submissionId, 10);
-              const sections = currentState.submission.objects[index]?.sections;
-              const newSectionsState = Object.assign({}, sections);
-
-              //Update upload section with received files
-              newSectionsState[SectionsType.Upload] = Object.assign({}, newSectionsState[SectionsType.Upload], {
-                data: Object.assign({files: (response[0].sections[SectionsType.Upload] as any).files})
-              });
-              return new ExecuteExternalUploadSuccessAction(
+              const actions = this.parseSaveResponse((currentState.submission as SubmissionState).objects[action.payload.submissionId],
+                response, action.payload.submissionId, currentState.forms, false, true);
+              actions.push(new ExecuteExternalUploadSuccessAction(
                 action.payload.submissionId,
                 action.payload.sectionId,
-                newSectionsState
-              );
+                null
+              ));
+              return actions;
             }
           }),
+          mergeMap((actions) => observableFrom(actions)),
           catchError((rd: RemoteData<any>) => observableFrom(
             this.parseErrorResponse(false, rd.errors, action.payload.submissionId, rd.statusCode, rd.errorMessage)
           ))

src/app/submission/objects/submission-objects.reducer.ts

@@ -20,7 +20,6 @@ import {
   EnableSectionAction,
   ExecuteExternalUploadAction,
   ExecuteExternalUploadErrorAction,
-  ExecuteExternalUploadSuccessAction,
   InertSectionErrorsAction,
   InitSectionAction,
   InitSubmissionFormAction,
@@ -113,10 +112,6 @@ export interface SubmissionObjectEntry {
    */
   externalUploadPending?: boolean;
 
-  /**
-   * Errors from external upload
-   */
-  externalUploadErrors?: SubmissionObjectError[];
   /**
    * A boolean representing if a submission deposit operation is pending
    */
@@ -302,11 +297,11 @@ export function submissionObjectReducer(state = initialState, action: Submission
     }
 
     case SubmissionObjectActionTypes.EXECUTE_EXTERNAL_UPLOAD_ERROR: {
-      return endExternalUploadExecution(state, action as ExecuteExternalUploadErrorAction);
+      return updateExternalUploadState(state, action.payload.submissionId, action.payload.sectionId, (action as ExecuteExternalUploadErrorAction).payload.errors);
     }
 
     case SubmissionObjectActionTypes.EXECUTE_EXTERNAL_UPLOAD_SUCCESS: {
-      return updateSubmissionFromExternalUploadEvent(state, action as ExecuteExternalUploadSuccessAction);
+      return updateExternalUploadState(state, action.payload.submissionId, action.payload.sectionId, []);
     }
 
     default: {
@@ -416,7 +411,6 @@ function initSubmission(state: SubmissionObjectState, action: InitSubmissionForm
     savePending: false,
     saveDecisionPending: false,
     externalUploadPending: false,
-    externalUploadErrors: [],
     depositPending: false,
     metadataSecurityConfiguration: action.payload.metadataSecurityConfiguration,
     isDiscarding: false
@@ -1116,7 +1110,6 @@ function startExternalUploadExecution(state: SubmissionObjectState, action: Exec
     return Object.assign({}, state, {
       [ action.payload.submissionId ]: Object.assign({}, state[ action.payload.submissionId ], {
         externalUploadPending: true,
-        externalUploadErrors: [],
       })
     });
   } else {
@@ -1125,54 +1118,35 @@ function startExternalUploadExecution(state: SubmissionObjectState, action: Exec
 }
 
 /**
- * Set external upload flag to false
+ * Update external upload state
  *
  * @param state
  *    the current state
- * @param action
- *    a SetDuplicateDecisionAction
+ * @param submissionId
+ *    the submission's ID
+ * @param sectionId
+ *    the section's ID
+ * @param errors
+ *    the section's ID
  * @return SubmissionObjectState
  *    the new state, with the decision flag changed.
  */
-function endExternalUploadExecution(state: SubmissionObjectState, action: ExecuteExternalUploadErrorAction): SubmissionObjectState {
-  if (hasValue(state[ action.payload.submissionId ])) {
+function updateExternalUploadState(state: SubmissionObjectState, submissionId: string, sectionId: string, errors: SubmissionObjectError[]): SubmissionObjectState {
+  if (isNotEmpty(state[ submissionId ])
+    && isNotEmpty(state[ submissionId ].sections[ sectionId])) {
     return Object.assign({}, state, {
-      [ action.payload.submissionId ]: Object.assign({}, state[ action.payload.submissionId ], {
+      [ submissionId ]: Object.assign({}, state[ submissionId ], {
+        sections: Object.assign({}, state[ submissionId ].sections, {
+          [ sectionId ]: Object.assign({}, state[ submissionId ].sections [ sectionId ], {
+            enabled: true,
+            errorsToShow: errors,
+            serverValidationErrors: errors,
+          })
+        }),
         externalUploadPending: false,
-        externalUploadErrors: action.payload.errors
       })
     });
   } else {
     return state;
   }
 }
-
-/**
- * Update submission object in store form external update response
- *
- * @param state
- * @param action
- */
-
-function updateSubmissionFromExternalUploadEvent(state: SubmissionObjectState, action: ExecuteExternalUploadSuccessAction) {
-  const sectionsData = action.payload.sectionsObject;
-
-  let currentSection = {};
-  const currentSectionId = action.payload.sectionId;
-  currentSection[currentSectionId] = state[ action.payload.submissionId ].sections[currentSectionId];
-
-  if (hasValue(sectionsData[ action.payload.sectionId ])) {
-    return Object.assign({}, state, {
-      [ action.payload.submissionId ]: Object.assign({}, state[ action.payload.submissionId ], {
-        sections: Object.assign({}, sectionsData, currentSection),
-        externalUploadPending: false
-      })
-    });
-  } else {
-    return Object.assign({}, state, {
-      [action.payload.submissionId]: Object.assign({}, state[action.payload.submissionId], {
-        externalUploadPending: false
-      })
-    });
-  }
-}

src/app/submission/sections/external-upload/section-external-upload.component.html

@@ -1,21 +1,14 @@
+
+<ds-alert [type]="AlertType.Info"
+          [content]="'submission.sections.external-upload.info' | translate"></ds-alert>
+
 <div class="container-fluid">
-  <div class="row justify-content-center">
-    <div class="col-12">
-      <ds-alert [type]="AlertType.Info"
-                [content]="'submission.sections.external-upload.info' | translate"></ds-alert>
-    </div>
-  </div>
   <div class="row justify-content-center w-100 external-upload-container">
     <div class="col-12" *ngIf="!(loading$ | async)">
       <div class="w-100">
         <label for="externalUploadSource">{{'submission.sections.external-upload.source' | translate}}</label>
         <input [(ngModel)]="source" class="form-control w-100" id="externalUploadSource" [placeholder]="'submission.sections.external-upload.placeholder' | translate" />
       </div>
-      <div class="d-flex flex-column" *ngIf="(errors$ | async).length > 0">
-          <div class="text-danger mt-1" *ngFor="let error of (errors$ | async)">
-            {{error.message | translate}}
-          </div>
-      </div>
       <div class="w-100 d-flex justify-content-center">
         <button [disabled]="!source" (click)="submitUpload()" class="btn btn-success mt-4">{{'submission.sections.external-upload.import' | translate}}</button>
       </div>

src/app/submission/sections/external-upload/section-external-upload.component.ts

@@ -27,8 +27,6 @@ export class SectionExternalUploadComponent extends SectionModelComponent implem
 
   public loading$ = this.submissionService.getExternalUplodaProcessingStatus(this.injectedSubmissionId);
 
-  public errors$ = this.submissionService.getExternalUplodaErorrs(this.injectedSubmissionId);
-
   public AlertType = AlertType;
 
   /**
@@ -69,6 +67,7 @@ export class SectionExternalUploadComponent extends SectionModelComponent implem
   public submitUpload() {
     this.dispatchExecuteUploadAction();
   }
+
   getSectionStatus(): Observable<boolean> {
     return of(true);
   }

src/app/submission/submission.service.ts

@@ -30,7 +30,7 @@ import { HttpOptions } from '../core/dspace-rest/dspace-rest.service';
 import { SubmissionRestService } from '../core/submission/submission-rest.service';
 import { SectionDataObject } from './sections/models/section-data.model';
 import { SubmissionScopeType } from '../core/submission/submission-scope-type';
-import { SubmissionObject, SubmissionObjectError } from '../core/submission/models/submission-object.model';
+import { SubmissionObject } from '../core/submission/models/submission-object.model';
 import { RouteService } from '../core/services/route.service';
 import { SectionsType } from './sections/sections-type';
 import { NotificationsService } from '../shared/notifications/notifications.service';
@@ -554,21 +554,6 @@ export class SubmissionService {
       startWith(false));
   }
 
-  /**
-   * Return the external upload status of the submission
-   *
-   * @param submissionId
-   *    The submission id
-   * @return Observable<boolean>
-   *    observable with submission save-decision status
-   */
-  getExternalUplodaErorrs(submissionId: string): Observable<SubmissionObjectError[]> {
-    return this.getSubmissionObject(submissionId).pipe(
-      map((state: SubmissionObjectEntry) => state.externalUploadErrors),
-      distinctUntilChanged(),
-      startWith([]));
-  }
-
   /**
    * Return whether submission unsaved modification are present
    *