Merge pull request DSpace#2213 from atmire/w2p-101289_1578_primaryBitstream-edit-implementation

Primary bitstream toggle implementation

Author: tdonohue

src/app/bitstream-page/bitstream-page.resolver.ts

@@ -12,7 +12,7 @@ import { getFirstCompletedRemoteData } from '../core/shared/operators';
  * Requesting them as embeds will limit the number of requests
  */
  export const BITSTREAM_PAGE_LINKS_TO_FOLLOW: FollowLinkConfig<Bitstream>[] = [
-  followLink('bundle', {}, followLink('item')),
+  followLink('bundle', {}, followLink('primaryBitstream'), followLink('item')),
   followLink('format')
 ];
 

src/app/bitstream-page/edit-bitstream-page/edit-bitstream-page.component.spec.ts

@@ -24,6 +24,7 @@ import { createPaginatedList } from '../../shared/testing/utils.test';
 import { Item } from '../../core/shared/item.model';
 import { MetadataValueFilter } from '../../core/shared/metadata.models';
 import { DSONameService } from '../../core/breadcrumbs/dso-name.service';
+import { PrimaryBitstreamService } from '../../core/data/primary-bitstream.service';
 
 const infoNotification: INotification = new Notification('id', NotificationType.Info, 'info');
 const warningNotification: INotification = new Notification('id', NotificationType.Warning, 'warning');
@@ -32,19 +33,27 @@ const successNotification: INotification = new Notification('id', NotificationTy
 let notificationsService: NotificationsService;
 let formService: DynamicFormService;
 let bitstreamService: BitstreamDataService;
+let primaryBitstreamService: PrimaryBitstreamService;
 let bitstreamFormatService: BitstreamFormatDataService;
 let dsoNameService: DSONameService;
 let bitstream: Bitstream;
+let bitstreamID: string;
 let selectedFormat: BitstreamFormat;
 let allFormats: BitstreamFormat[];
 let router: Router;
-
+let currentPrimary: string;
+let differentPrimary: string;
+let bundle;
 let comp: EditBitstreamPageComponent;
 let fixture: ComponentFixture<EditBitstreamPageComponent>;
 
 describe('EditBitstreamPageComponent', () => {
 
   beforeEach(() => {
+    bitstreamID = 'current-bitstream-id';
+    currentPrimary = bitstreamID;
+    differentPrimary = '12345-abcde-54321-edcba';
+
     allFormats = [
       Object.assign({
         id: '1',
@@ -53,7 +62,7 @@ describe('EditBitstreamPageComponent', () => {
         supportLevel: BitstreamFormatSupportLevel.Unknown,
         mimetype: 'application/octet-stream',
         _links: {
-          self: {href: 'format-selflink-1'}
+          self: { href: 'format-selflink-1' }
         }
       }),
       Object.assign({
@@ -63,7 +72,7 @@ describe('EditBitstreamPageComponent', () => {
         supportLevel: BitstreamFormatSupportLevel.Known,
         mimetype: 'image/png',
         _links: {
-          self: {href: 'format-selflink-2'}
+          self: { href: 'format-selflink-2' }
         }
       }),
       Object.assign({
@@ -73,7 +82,7 @@ describe('EditBitstreamPageComponent', () => {
         supportLevel: BitstreamFormatSupportLevel.Known,
         mimetype: 'image/gif',
         _links: {
-          self: {href: 'format-selflink-3'}
+          self: { href: 'format-selflink-3' }
         }
       })
     ] as BitstreamFormat[];
@@ -103,15 +112,52 @@ describe('EditBitstreamPageComponent', () => {
         success: successNotification
       }
     );
+
+    bundle = {
+      _links: {
+        primaryBitstream: {
+          href: 'bundle-selflink'
+        }
+      },
+      item: createSuccessfulRemoteDataObject$(Object.assign(new Item(), {
+        uuid: 'some-uuid',
+        firstMetadataValue(keyOrKeys: string | string[], valueFilter?: MetadataValueFilter): string {
+          return undefined;
+        },
+      }))
+    };
+
+    const result = createSuccessfulRemoteDataObject$(bundle);
+    primaryBitstreamService = jasmine.createSpyObj('PrimaryBitstreamService',
+    {
+      put: result,
+      create: result,
+      delete: result,
+    });
+
   });
 
   describe('EditBitstreamPageComponent no IIIF fields', () => {
 
     beforeEach(waitForAsync(() => {
-
+      bundle = {
+        _links: {
+          primaryBitstream: {
+            href: 'bundle-selflink'
+          }
+        },
+        item: createSuccessfulRemoteDataObject$(Object.assign(new Item(), {
+          uuid: 'some-uuid',
+          firstMetadataValue(keyOrKeys: string | string[], valueFilter?: MetadataValueFilter): string {
+            return undefined;
+          },
+        }))
+      };
       const bundleName = 'ORIGINAL';
 
       bitstream = Object.assign(new Bitstream(), {
+        uuid: bitstreamID,
+        id: bitstreamID,
         metadata: {
           'dc.description': [
             {
@@ -128,17 +174,11 @@ describe('EditBitstreamPageComponent', () => {
         _links: {
           self: 'bitstream-selflink'
         },
-        bundle: createSuccessfulRemoteDataObject$({
-          item: createSuccessfulRemoteDataObject$(Object.assign(new Item(), {
-            uuid: 'some-uuid',
-            firstMetadataValue(keyOrKeys: string | string[], valueFilter?: MetadataValueFilter): string {
-              return undefined;
-            },
-          }))
-        })
+        bundle: createSuccessfulRemoteDataObject$(bundle)
       });
       bitstreamService = jasmine.createSpyObj('bitstreamService', {
         findById: createSuccessfulRemoteDataObject$(bitstream),
+        findByHref: createSuccessfulRemoteDataObject$(bitstream),
         update: createSuccessfulRemoteDataObject$(bitstream),
         updateFormat: createSuccessfulRemoteDataObject$(bitstream),
         commitUpdates: {},
@@ -155,17 +195,19 @@ describe('EditBitstreamPageComponent', () => {
         imports: [TranslateModule.forRoot(), RouterTestingModule],
         declarations: [EditBitstreamPageComponent, FileSizePipe, VarDirective],
         providers: [
-          {provide: NotificationsService, useValue: notificationsService},
-          {provide: DynamicFormService, useValue: formService},
-          {provide: ActivatedRoute,
+          { provide: NotificationsService, useValue: notificationsService },
+          { provide: DynamicFormService, useValue: formService },
+          {
+            provide: ActivatedRoute,
             useValue: {
-              data: observableOf({bitstream: createSuccessfulRemoteDataObject(bitstream)}),
-              snapshot: {queryParams: {}}
+              data: observableOf({ bitstream: createSuccessfulRemoteDataObject(bitstream) }),
+              snapshot: { queryParams: {} }
             }
           },
-          {provide: BitstreamDataService, useValue: bitstreamService},
-          {provide: DSONameService, useValue: dsoNameService},
-          {provide: BitstreamFormatDataService, useValue: bitstreamFormatService},
+          { provide: BitstreamDataService, useValue: bitstreamService },
+          { provide: DSONameService, useValue: dsoNameService },
+          { provide: BitstreamFormatDataService, useValue: bitstreamFormatService },
+          { provide: PrimaryBitstreamService, useValue: primaryBitstreamService },
           ChangeDetectorRef
         ],
         schemas: [NO_ERRORS_SCHEMA]
@@ -203,6 +245,27 @@ describe('EditBitstreamPageComponent', () => {
       it('should put the \"New Format\" input on invisible', () => {
         expect(comp.formLayout.newFormat.grid.host).toContain('invisible');
       });
+      describe('when the bitstream is the primary bitstream on the bundle', () => {
+        beforeEach(() => {
+          (comp as any).primaryBitstreamUUID = currentPrimary;
+          comp.setForm();
+          rawForm = comp.formGroup.getRawValue();
+
+        });
+        it('should enable the primary bitstream toggle', () => {
+          expect(rawForm.fileNamePrimaryContainer.primaryBitstream).toEqual(true);
+        });
+      });
+      describe('when the bitstream is not the primary bitstream on the bundle', () => {
+        beforeEach(() => {
+          (comp as any).primaryBitstreamUUID = differentPrimary;
+          comp.setForm();
+          rawForm = comp.formGroup.getRawValue();
+        });
+        it('should disable the primary bitstream toggle', () => {
+          expect(rawForm.fileNamePrimaryContainer.primaryBitstream).toEqual(false);
+        });
+      });
     });
 
     describe('when an unknown format is selected', () => {
@@ -216,6 +279,83 @@ describe('EditBitstreamPageComponent', () => {
     });
 
     describe('onSubmit', () => {
+      describe('when the primaryBitstream changed', () => {
+        describe('to the current bitstream', () => {
+          beforeEach(() => {
+            const rawValue = Object.assign(comp.formGroup.getRawValue(), { fileNamePrimaryContainer: { primaryBitstream: true } });
+            spyOn(comp.formGroup, 'getRawValue').and.returnValue(rawValue);
+          });
+
+          describe('from a different primary bitstream', () => {
+            beforeEach(() => {
+              (comp as any).primaryBitstreamUUID = differentPrimary;
+              comp.onSubmit();
+            });
+
+            it('should call put with the correct bitstream on the PrimaryBitstreamService', () => {
+              expect(primaryBitstreamService.put).toHaveBeenCalledWith(jasmine.objectContaining({uuid: currentPrimary}), bundle);
+            });
+          });
+
+          describe('from no primary bitstream', () => {
+            beforeEach(() => {
+              (comp as any).primaryBitstreamUUID = null;
+              comp.onSubmit();
+            });
+
+            it('should call create with the correct bitstream on the PrimaryBitstreamService', () => {
+              expect(primaryBitstreamService.create).toHaveBeenCalledWith(jasmine.objectContaining({uuid: currentPrimary}), bundle);
+            });
+          });
+        });
+        describe('to no primary bitstream', () => {
+          beforeEach(() => {
+            const rawValue = Object.assign(comp.formGroup.getRawValue(), { fileNamePrimaryContainer: { primaryBitstream: false } });
+            spyOn(comp.formGroup, 'getRawValue').and.returnValue(rawValue);
+          });
+
+          describe('from the current bitstream', () => {
+            beforeEach(() => {
+              (comp as any).primaryBitstreamUUID = currentPrimary;
+              comp.onSubmit();
+            });
+
+            it('should call delete on the PrimaryBitstreamService', () => {
+              expect(primaryBitstreamService.delete).toHaveBeenCalledWith(jasmine.objectContaining(bundle));
+            });
+          });
+        });
+      });
+      describe('when the primaryBitstream did not change', () => {
+        describe('the current bitstream stayed the primary bitstream', () => {
+          beforeEach(() => {
+            const rawValue = Object.assign(comp.formGroup.getRawValue(), { fileNamePrimaryContainer: { primaryBitstream: true } });
+            spyOn(comp.formGroup, 'getRawValue').and.returnValue(rawValue);
+            (comp as any).primaryBitstreamUUID = currentPrimary;
+            comp.onSubmit();
+          });
+          it('should not call anything on the PrimaryBitstreamService', () => {
+            expect(primaryBitstreamService.put).not.toHaveBeenCalled();
+            expect(primaryBitstreamService.delete).not.toHaveBeenCalled();
+            expect(primaryBitstreamService.create).not.toHaveBeenCalled();
+          });
+        });
+
+        describe('the bitstream was not and did not become the primary bitstream', () => {
+          beforeEach(() => {
+            const rawValue = Object.assign(comp.formGroup.getRawValue(), { fileNamePrimaryContainer: { primaryBitstream: false } });
+            spyOn(comp.formGroup, 'getRawValue').and.returnValue(rawValue);
+            (comp as any).primaryBitstreamUUID = differentPrimary;
+            comp.onSubmit();
+          });
+          it('should not call anything on the PrimaryBitstreamService', () => {
+            expect(primaryBitstreamService.put).not.toHaveBeenCalled();
+            expect(primaryBitstreamService.delete).not.toHaveBeenCalled();
+            expect(primaryBitstreamService.create).not.toHaveBeenCalled();
+          });
+        });
+      });
+
       describe('when selected format hasn\'t changed', () => {
         beforeEach(() => {
           comp.onSubmit();
@@ -261,20 +401,13 @@ describe('EditBitstreamPageComponent', () => {
         expect(comp.navigateToItemEditBitstreams).toHaveBeenCalled();
       });
     });
-    describe('when navigateToItemEditBitstreams is called, and the component has an itemId', () => {
+    describe('when navigateToItemEditBitstreams is called', () => {
       it('should redirect to the item edit page on the bitstreams tab with the itemId from the component', () => {
         comp.itemId = 'some-uuid1';
         comp.navigateToItemEditBitstreams();
         expect(router.navigate).toHaveBeenCalledWith([getEntityEditRoute(null, 'some-uuid1'), 'bitstreams']);
       });
     });
-    describe('when navigateToItemEditBitstreams is called, and the component does not have an itemId', () => {
-      it('should redirect to the item edit page on the bitstreams tab with the itemId from the bundle links ', () => {
-        comp.itemId = undefined;
-        comp.navigateToItemEditBitstreams();
-        expect(router.navigate).toHaveBeenCalledWith([getEntityEditRoute(null, 'some-uuid'), 'bitstreams']);
-      });
-    });
   });
 
   describe('EditBitstreamPageComponent with IIIF fields', () => {
@@ -321,16 +454,22 @@ describe('EditBitstreamPageComponent', () => {
           self: 'bitstream-selflink'
         },
         bundle: createSuccessfulRemoteDataObject$({
+          _links: {
+            primaryBitstream: {
+              href: 'bundle-selflink'
+            }
+          },
           item: createSuccessfulRemoteDataObject$(Object.assign(new Item(), {
             uuid: 'some-uuid',
             firstMetadataValue(keyOrKeys: string | string[], valueFilter?: MetadataValueFilter): string {
               return 'True';
             }
           }))
-        })
+        }),
       });
       bitstreamService = jasmine.createSpyObj('bitstreamService', {
         findById: createSuccessfulRemoteDataObject$(bitstream),
+        findByHref: createSuccessfulRemoteDataObject$(bitstream),
         update: createSuccessfulRemoteDataObject$(bitstream),
         updateFormat: createSuccessfulRemoteDataObject$(bitstream),
         commitUpdates: {},
@@ -357,6 +496,7 @@ describe('EditBitstreamPageComponent', () => {
           {provide: BitstreamDataService, useValue: bitstreamService},
           {provide: DSONameService, useValue: dsoNameService},
           {provide: BitstreamFormatDataService, useValue: bitstreamFormatService},
+          { provide: PrimaryBitstreamService, useValue: primaryBitstreamService },
           ChangeDetectorRef
         ],
         schemas: [NO_ERRORS_SCHEMA]
@@ -371,7 +511,6 @@ describe('EditBitstreamPageComponent', () => {
       spyOn(router, 'navigate');
     });
 
-
     describe('on startup', () => {
       let rawForm;
 
@@ -440,16 +579,22 @@ describe('EditBitstreamPageComponent', () => {
             self: 'bitstream-selflink'
           },
           bundle: createSuccessfulRemoteDataObject$({
+            _links: {
+              primaryBitstream: {
+                href: 'bundle-selflink'
+              }
+            },
             item: createSuccessfulRemoteDataObject$(Object.assign(new Item(), {
               uuid: 'some-uuid',
               firstMetadataValue(keyOrKeys: string | string[], valueFilter?: MetadataValueFilter): string {
                 return 'True';
               }
             }))
-          })
+          }),
         });
         bitstreamService = jasmine.createSpyObj('bitstreamService', {
           findById: createSuccessfulRemoteDataObject$(bitstream),
+          findByHref: createSuccessfulRemoteDataObject$(bitstream),
           update: createSuccessfulRemoteDataObject$(bitstream),
           updateFormat: createSuccessfulRemoteDataObject$(bitstream),
           commitUpdates: {},
@@ -475,6 +620,7 @@ describe('EditBitstreamPageComponent', () => {
             {provide: BitstreamDataService, useValue: bitstreamService},
             {provide: DSONameService, useValue: dsoNameService},
             {provide: BitstreamFormatDataService, useValue: bitstreamFormatService},
+            { provide: PrimaryBitstreamService, useValue: primaryBitstreamService },
             ChangeDetectorRef
           ],
           schemas: [NO_ERRORS_SCHEMA]
@@ -496,7 +642,7 @@ describe('EditBitstreamPageComponent', () => {
           rawForm = comp.formGroup.getRawValue();
         });
 
-        it('should NOT set isIIIF to true', () => {
+        it('should NOT set is IIIF to true', () => {
           expect(comp.isIIIF).toBeFalse();
         });
         it('should put the \"IIIF Label\" input not to be shown', () => {