[DURACOM-453] fix issue with missing collection step in edit mode, refactor visibility to use utils, adapt tests, remove non-existing metadata in config example,add edit item breadcrumb resolver

Author: FrancescoMolinaro

config/config.example.yml

@@ -431,7 +431,6 @@ item:
     # Metdadata list to be displayed for entities without a specific configuration
     fallbackMetdataList:
       - dc.description.abstract
-      - dc.description.note
     # Configuration for each entity type
     entityDataConfig:
       - entityType: Person

src/app/collection-page/collection-form/collection-form.component.ts

@@ -4,6 +4,7 @@ import {
   Component,
   Input,
   OnChanges,
+  OnDestroy,
   OnInit,
   SimpleChange,
   SimpleChanges,
@@ -23,6 +24,7 @@ import { MetadataValue } from '@dspace/core/shared/metadata.models';
 import { getFirstSucceededRemoteListPayload } from '@dspace/core/shared/operators';
 import {
   hasNoValue,
+  hasValue,
   isNotNull,
 } from '@dspace/shared/utils/empty.util';
 import { NgbModal } from '@ng-bootstrap/ng-bootstrap';
@@ -42,6 +44,7 @@ import {
   forkJoin,
   Observable,
   of,
+  Subscription,
 } from 'rxjs';
 
 import { ComColFormComponent } from '../../shared/comcol/comcol-forms/comcol-form/comcol-form.component';
@@ -72,7 +75,7 @@ import {
     VarDirective,
   ],
 })
-export class CollectionFormComponent extends ComColFormComponent<Collection> implements OnInit, OnChanges {
+export class CollectionFormComponent extends ComColFormComponent<Collection> implements OnInit, OnChanges, OnDestroy {
   /**
    * @type {Collection} A new collection when a collection is being created, an existing Input collection when a collection is being edited
    */
@@ -103,6 +106,13 @@ export class CollectionFormComponent extends ComColFormComponent<Collection> imp
    */
   formModel: DynamicFormControlModel[];
 
+  /**
+   * Subscription to unsubscribe on destroy
+   *
+   * @private
+   */
+  private initSubscription: Subscription;
+
   public constructor(protected formService: DynamicFormService,
                      protected translate: TranslateService,
                      protected notificationsService: NotificationsService,
@@ -134,6 +144,16 @@ export class CollectionFormComponent extends ComColFormComponent<Collection> imp
     }
   }
 
+  /**
+   * Clean up eventual subscription when component gets destroyed
+   */
+  ngOnDestroy() {
+    super.ngOnDestroy();
+    if (hasValue(this.initSubscription)) {
+      this.initSubscription.unsubscribe();
+    }
+  }
+
   initializeForm() {
     let currentRelationshipValue: MetadataValue[];
     let currentDefinitionValue: MetadataValue[];
@@ -155,7 +175,7 @@ export class CollectionFormComponent extends ComColFormComponent<Collection> imp
       );
 
     // retrieve all entity types and submission definitions to populate the dropdowns selection
-    forkJoin({
+    this.initSubscription = forkJoin({
       entityTypes: entities$,
       definitions: definitions$,
     }).subscribe(({ entityTypes, definitions }:  {entityTypes: ItemType[]; definitions: ConfigObject[]}) => {

src/app/core/breadcrumbs/edit-item-breadcrumb.resolver.spec.ts

@@ -0,0 +1,62 @@
+import {
+  EnvironmentInjector,
+  runInInjectionContext,
+} from '@angular/core';
+import { TestBed } from '@angular/core/testing';
+import { editItemBreadcrumbResolver } from '@dspace/core/breadcrumbs/edit-item-breadcrumb.resolver';
+import { Item } from '@dspace/core/shared/item.model';
+import { getTestScheduler } from 'jasmine-marbles';
+import { of } from 'rxjs';
+
+import { ItemDataService } from '../data/item-data.service';
+import { createSuccessfulRemoteDataObject$ } from '../utilities/remote-data.utils';
+import { DSOBreadcrumbsService } from './dso-breadcrumbs.service';
+
+describe('editItemBreadcrumbResolver', () => {
+  describe('resolve', () => {
+    let resolver: any;
+    let dsoBreadcrumbService: any;
+    let itemDataService: any;
+    let testItem: Item;
+    let uuid: string;
+    let breadcrumbUrl: string;
+    let currentUrl: string;
+
+    beforeEach(() => {
+      uuid = '1234-65487-12354-1235';
+      breadcrumbUrl = `/items/${uuid}`;
+      currentUrl = `${breadcrumbUrl}/edit`;
+      testItem = Object.assign(new Item(), {
+        uuid: uuid,
+        type: 'item',
+      });
+
+      itemDataService = {
+        findById: () => createSuccessfulRemoteDataObject$(testItem),
+      };
+
+      dsoBreadcrumbService = {
+        getRepresentativeName: () => testItem.uuid,
+        getBreadcrumbs: () => of({ provider: dsoBreadcrumbService, key: testItem, url: breadcrumbUrl }),
+      };
+
+      TestBed.configureTestingModule({
+        providers: [
+          { provide: DSOBreadcrumbsService, useValue: dsoBreadcrumbService },
+          { provide: ItemDataService, useValue: itemDataService },
+        ],
+      });
+
+      resolver = editItemBreadcrumbResolver;
+    });
+
+    it('should resolve a breadcrumb config for the correct uuid', () => {
+      const injector = TestBed.inject(EnvironmentInjector);
+      const resolvedConfig = runInInjectionContext(injector, () =>
+        resolver({ params: { id: testItem.uuid + ':FULL' } } as any, { url: currentUrl } as any),
+      );
+      const expectedConfig = { provider: dsoBreadcrumbService, key: testItem, url: breadcrumbUrl };
+      getTestScheduler().expectObservable(resolvedConfig).toBe('(a|)', { a: expectedConfig });
+    });
+  });
+});

src/app/core/breadcrumbs/edit-item-breadcrumb.resolver.ts

@@ -0,0 +1,27 @@
+import {
+  ActivatedRouteSnapshot,
+  ResolveFn,
+  RouterStateSnapshot,
+} from '@angular/router';
+import { itemBreadcrumbResolver } from '@dspace/core/breadcrumbs/item-breadcrumb.resolver';
+import { Observable } from 'rxjs';
+
+import { Item } from '../shared/item.model';
+import { BreadcrumbConfig } from './models/breadcrumb-config.model';
+
+/**
+ * The resolve function that resolves the BreadcrumbConfig object for an Item in edit mode
+ */
+export const editItemBreadcrumbResolver: ResolveFn<BreadcrumbConfig<Item>> = (
+  route: ActivatedRouteSnapshot,
+  state: RouterStateSnapshot,
+): Observable<BreadcrumbConfig<Item>> => {
+  const routeWithCorrectId = Object.assign(route, {
+    params: {
+      ...route.params,
+      id: route.params.id.split(':')[0],
+    },
+  });
+
+  return itemBreadcrumbResolver(routeWithCorrectId, state) as Observable<BreadcrumbConfig<Item>>;
+};

src/app/core/config/models/config-submission-section.model.ts

@@ -6,14 +6,26 @@ import {
 
 import { typedObject } from '../../cache/builders/build-decorators';
 import { HALLink } from '../../shared/hal-link.model';
-import {
-  SectionScope,
-  SectionVisibility,
-} from '../../submission/models/section-visibility.model';
+import { SectionScope } from '../../submission/models/section-visibility.model';
 import { SectionsType } from '../../submission/sections-type';
 import { ConfigObject } from './config.model';
 import { SUBMISSION_SECTION_TYPE } from './config-type';
 
+/**
+ * An Enum defining the possible visibility values
+ */
+export enum SubmissionVisibilityValue {
+  ReadOnly = 'read-only',
+  Hidden = 'hidden'
+}
+
+/**
+ * An interface that define section visibility and its properties.
+ */
+export interface SubmissionVisibilityType {
+  [scope: string]: SubmissionVisibilityValue;
+}
+
 @typedObject
 @inheritSerialization(ConfigObject)
 export class SubmissionSectionModel extends ConfigObject {
@@ -31,6 +43,12 @@ export class SubmissionSectionModel extends ConfigObject {
   @autoserialize
   mandatory: boolean;
 
+  /**
+   * A boolean representing if this submission section is opened or collapsed by default
+   */
+  @autoserialize
+  opened: boolean;
+
   /**
    * The submission scope for this section
    */
@@ -44,10 +62,10 @@ export class SubmissionSectionModel extends ConfigObject {
   sectionType: SectionsType;
 
   /**
-   * The [SectionVisibility] object for this section
+   * The [SubmissionVisibilityType] object for this section
    */
   @autoserialize
-  visibility: SectionVisibility;
+  visibility: SubmissionVisibilityType;
 
   /**
    * The {@link HALLink}s for this SubmissionSectionModel

src/app/core/shared/form/models/form-field.model.ts

@@ -1,7 +1,7 @@
+import { SubmissionVisibilityType } from '@dspace/core/config/models/config-submission-section.model';
 import { autoserialize } from 'cerialize';
 
 import { FormRowModel } from '../../../config/models/config-submission-form.model';
-import { SectionVisibility } from '../../../submission/models/section-visibility.model';
 import { RelationshipOptions } from '../../relationship-options.model';
 import { LanguageCode } from './form-field-language-value.model';
 
@@ -130,5 +130,10 @@ export class FormFieldModel {
    * The visibility object for this field
    */
   @autoserialize
-  visibility: SectionVisibility;
+  visibility: SubmissionVisibilityType;
+
+  /**
+   * The security config values
+   */
+  securityConfigLevel?: number[];
 }

src/app/core/submission/models/submission-section-object.model.ts

@@ -1,8 +1,6 @@
+import { SubmissionVisibilityType } from '@dspace/core/config/models/config-submission-section.model';
+
 import { SectionsType } from '../sections-type';
-import {
-  SectionScope,
-  SectionVisibility,
-} from './section-visibility.model';
 import { SubmissionSectionError } from './submission-section-error.model';
 import { WorkspaceitemSectionDataType } from './workspaceitem-sections.model';
 
@@ -26,9 +24,9 @@ export interface SubmissionSectionObject {
   mandatory: boolean;
 
   /**
-   * The submission scope for this section
+   * A boolean representing if this section is opened or collapsed by default
    */
-  scope: SectionScope;
+  opened: boolean;
 
   /**
    * The section type
@@ -38,7 +36,7 @@ export interface SubmissionSectionObject {
   /**
    * The section visibility
    */
-  visibility: SectionVisibility;
+  visibility: SubmissionVisibilityType;
 
   /**
    * A boolean representing if this section is collapsed

src/app/core/submission/submission-rest.service.ts

@@ -93,12 +93,14 @@ export class SubmissionRestService {
    *    The owning collection for the object
    * @param projections
    */
-  protected getEndpointByIDHref(endpoint, resourceID, collectionId?: string, projections: string[] = []): string {
+  protected getEndpointByIDHref(endpoint, resourceID, collectionId?: string, projections: string[] = [], isEditMode = false): string {
     let url = isNotEmpty(resourceID) ? `${endpoint}/${resourceID}` : `${endpoint}`;
-    url = new URLCombiner(url, '?embed=item,sections,collection').toString();
+    if (!isEditMode) {
+      url = new URLCombiner(url, '?embed=item,sections,collection').toString();
+    }
 
-    projections.forEach((projection) => {
-      url = new URLCombiner(url, '&projection=' + projection).toString();
+    projections.forEach((projection, index) => {
+      url = new URLCombiner(url, ((index === 0 && isEditMode) ? '?' : '&') + 'projection=' + projection).toString();
     });
     if (collectionId) {
       url = new URLCombiner(url, `&owningCollection=${collectionId}`).toString();
@@ -140,9 +142,9 @@ export class SubmissionRestService {
    * @return Observable<SubmitDataResponseDefinitionObject>
    *     server response
    */
-  public getDataById(linkName: string, id: string, useCachedVersionIfAvailable = false, projections: string[] = []): Observable<SubmitDataResponseDefinitionObject> {
+  public getDataById(linkName: string, id: string, useCachedVersionIfAvailable = false, projections: string[] = [], isEditMode = false): Observable<SubmitDataResponseDefinitionObject> {
     return this.halService.getEndpoint(linkName).pipe(
-      map((endpointURL: string) => this.getEndpointByIDHref(endpointURL, id, null, projections)),
+      map((endpointURL: string) => this.getEndpointByIDHref(endpointURL, id, null, projections, isEditMode)),
       filter((href: string) => isNotEmpty(href)),
       distinctUntilChanged(),
       mergeMap((endpointURL: string) => {

src/app/core/submission/submission-scope-type.ts

@@ -1,5 +1,5 @@
 export enum SubmissionScopeType {
-  WorkspaceItem = 'WORKSPACE',
-  WorkflowItem = 'WORKFLOW',
-  EditItem = 'EDIT'
+  WorkspaceItem = 'submission',
+  WorkflowItem = 'workflow',
+  EditItem = 'edit'
 }

src/app/core/testing/submission-service.stub.ts

@@ -23,6 +23,7 @@ export class SubmissionServiceStub {
   getSubmissionDepositProcessingStatus = jasmine.createSpy('getSubmissionDepositProcessingStatus');
   hasUnsavedModification = jasmine.createSpy('hasUnsavedModification');
   isSectionHidden = jasmine.createSpy('isSectionHidden');
+  isSectionReadOnly = jasmine.createSpy('isSectionReadOnly');
   isSubmissionLoading = jasmine.createSpy('isSubmissionLoading');
   notifyNewSection = jasmine.createSpy('notifyNewSection');
   redirectToMyDSpace = jasmine.createSpy('redirectToMyDSpace');