[DSC-1875] Port of [CST-16286] lucky-search - fix of redirect on SSR & refactor [2424e47308a4a902b3ed33a83522b3f77908bd98]

alisaismailati · alisaismailati · commit 1697d0f62bfc · 2024-08-28T17:05:58.000+02:00
diff --git a/src/app/lucky-search/search/lucky-search.component.html b/src/app/lucky-search/search/lucky-search.component.html
@@ -1,4 +1,4 @@
-<div *ngIf="showMultipleSearchSection">
+<div *ngIf="showMultipleSearchSection$ | async">
   <ds-page-with-sidebar [id]="'search-page'">
     <div class="row">
       <div class="col-12">
@@ -16,15 +16,15 @@ <h5> {{currentFilter.identifier}}: {{currentFilter.value}} {{'lucky.search.multi
   </ds-page-with-sidebar>
 </div>
 
-<div *ngIf="showEmptySearchSection">
+<div *ngIf="showEmptySearchSection$ | async">
   <h5 class="text-center">{{'lucky.search.results.notfound' | translate}} {{currentFilter.identifier}}
     : {{currentFilter.value}}. {{'lucky.search.retry.search' | translate}}</h5>
   <br/>
   <div class="col-md-12 d-flex justify-content-center">
     <div class="col-md-8">
       <ds-search-form [inPlaceSearch]="false"
                       [query]="currentFilter.value"
-                      [searchPlaceholder]="'search.search-form.placeholder' | translate"> >
+                      [searchPlaceholder]="'search.search-form.placeholder' | translate">
       </ds-search-form>
     </div>
   </div>
diff --git a/src/app/lucky-search/search/lucky-search.component.spec.ts b/src/app/lucky-search/search/lucky-search.component.spec.ts
@@ -1,28 +1,39 @@
-import { ComponentFixture, TestBed } from '@angular/core/testing';
-
-import { LuckySearchComponent } from './lucky-search.component';
-import { LuckySearchService } from '../lucky-search.service';
-import { SearchConfigurationService } from '../../core/shared/search/search-configuration.service';
-import { Router, UrlTree } from '@angular/router';
-import { createSuccessfulRemoteDataObject, createSuccessfulRemoteDataObject$ } from '../../shared/remote-data.utils';
-import { createPaginatedList } from '../../shared/testing/utils.test';
-import { Item } from '../../core/shared/item.model';
-import { of as observableOf } from 'rxjs';
-import { PaginatedSearchOptions } from '../../shared/search/models/paginated-search-options.model';
-import { PaginationComponentOptions } from '../../shared/pagination/pagination-component-options.model';
-import { SortDirection, SortOptions } from '../../core/cache/models/sort-options.model';
-import { TranslateModule } from '@ngx-translate/core';
-import { By } from '@angular/platform-browser';
-import { SearchResult } from '../../shared/search/models/search-result.model';
-import { DSpaceObject } from '../../core/shared/dspace-object.model';
-import { BitstreamDataService, MetadataFilter } from '../../core/data/bitstream-data.service';
-import { Bitstream } from '../../core/shared/bitstream.model';
-import { RouterMock } from '../../shared/mocks/router.mock';
-import { MetadataMap, MetadataValue } from '../../core/shared/metadata.models';
-import { FileSizePipe } from '../../shared/utils/file-size-pipe';
-
-describe('SearchComponent', () => {
+import {ComponentFixture, TestBed} from '@angular/core/testing';
+
+import {LuckySearchComponent} from './lucky-search.component';
+import {LuckySearchService} from '../lucky-search.service';
+import {SearchConfigurationService} from '../../core/shared/search/search-configuration.service';
+import {Router, UrlTree} from '@angular/router';
+import {createSuccessfulRemoteDataObject, createSuccessfulRemoteDataObject$} from '../../shared/remote-data.utils';
+import {createPaginatedList} from '../../shared/testing/utils.test';
+import {Item} from '../../core/shared/item.model';
+import {of as observableOf} from 'rxjs';
+import {PaginatedSearchOptions} from '../../shared/search/models/paginated-search-options.model';
+import {PaginationComponentOptions} from '../../shared/pagination/pagination-component-options.model';
+import {SortDirection, SortOptions} from '../../core/cache/models/sort-options.model';
+import {TranslateModule} from '@ngx-translate/core';
+import {By} from '@angular/platform-browser';
+import {SearchResult} from '../../shared/search/models/search-result.model';
+import {DSpaceObject} from '../../core/shared/dspace-object.model';
+import {BitstreamDataService, MetadataFilter} from '../../core/data/bitstream-data.service';
+import {Bitstream} from '../../core/shared/bitstream.model';
+import {RouterMock} from '../../shared/mocks/router.mock';
+import {MetadataMap, MetadataValue} from '../../core/shared/metadata.models';
+import {FileSizePipe} from '../../shared/utils/file-size-pipe';
+import {HardRedirectService} from '../../core/services/hard-redirect.service';
+import {getBitstreamDownloadRoute} from '../../app-routing-paths';
+import {PLATFORM_ID} from '@angular/core';
+
+describe('LuckySearchComponent', () => {
   let fixture: ComponentFixture<LuckySearchComponent>;
+  const defaultPagination: PaginatedSearchOptions = Object.assign({
+    id: 'test-pg-id',
+    pageSize: 10,
+    currentPage: 1
+  });
+
+  const hardRedirectService = jasmine.createSpyObj('hardRedirectService', ['redirect']);
+
   const collection1 = Object.assign(new Item(), {
     uuid: 'item-uuid-1',
     name: 'Test item 1'
@@ -66,6 +77,16 @@ describe('SearchComponent', () => {
     'value': 'test'
   };
   const routerStub = new RouterMock();
+
+  const bitstreamMetadata = {
+    'dc.title': [{value: 'test.pdf'} as MetadataValue],
+    'dc.description': [{value: 'TestDescription'} as MetadataValue]
+  } as MetadataMap;
+  const bitstream = Object.assign(
+    new Bitstream(),
+    {_name: 'test.pdf', sizeBytes: 15, uuid: 'fa272dbf-e458-4ad2-868b-b4a27c6eac15', metadata: bitstreamMetadata}
+  ) as Bitstream;
+
   beforeEach(async () => {
     await TestBed.configureTestingModule({
       declarations: [LuckySearchComponent, FileSizePipe],
@@ -74,7 +95,9 @@ describe('SearchComponent', () => {
         {provide: Router, useValue: routerStub},
         {provide: SearchConfigurationService, useValue: searchConfigServiceStub},
         {provide: LuckySearchService, useValue: searchServiceStub},
-        {provide: BitstreamDataService, useValue: bitstreamDataService}
+        {provide: BitstreamDataService, useValue: bitstreamDataService},
+        {provide: HardRedirectService, useValue: hardRedirectService},
+        {provide: PLATFORM_ID, useValue: 'browser'},
       ],
     })
       .compileComponents();
@@ -87,24 +110,6 @@ describe('SearchComponent', () => {
   });
 
   describe('should search items', () => {
-
-    beforeEach(() => {
-      spyOn(routerStub, 'parseUrl').and.returnValue(urlTree);
-    });
-
-    it('should create', () => {
-      expect(component).toBeTruthy();
-    });
-
-    it('should show multiple results', () => {
-      expect(component.showMultipleSearchSection).toEqual(true);
-    });
-
-    it('should display basic search form results', () => {
-      expect(fixture.debugElement.query(By.css('ds-search-results')))
-        .toBeTruthy();
-    });
-
     beforeEach(() => {
       fixture = TestBed.createComponent(LuckySearchComponent);
       component = fixture.componentInstance;
@@ -121,46 +126,44 @@ describe('SearchComponent', () => {
         })
       });
 
+      const secondSearchResult = Object.assign(new SearchResult(), {
+        indexableObject: Object.assign(new DSpaceObject(), {
+          id: 'd317835d-7b06-4219-91e2-26565',
+          uuid: 'd317835d-7b06-4219-91e2-26565',
+          name: 'publication',
+          metadata: {
+            'dspace.entity.type': [
+              {value: 'Publication'}
+            ]
+          }
+        })
+      });
+      spyOn(routerStub, 'parseUrl').and.returnValue(urlTree);
       const data = createSuccessfulRemoteDataObject(createPaginatedList([
-        firstSearchResult
+        firstSearchResult, secondSearchResult
       ]));
-      component.resultsRD$.next(data as any);
-      fixture.detectChanges();
-    });
 
-    it('should call navigate or router', () => {
-      expect(routerStub.navigateByUrl).toHaveBeenCalled();
-    });
-
-    beforeEach(() => {
-      fixture = TestBed.createComponent(LuckySearchComponent);
-      component = fixture.componentInstance;
-      const data = createSuccessfulRemoteDataObject(createPaginatedList([]));
-      component.resultsRD$.next(data as any);
+      component.resultsRD$.next(data);
       fixture.detectChanges();
     });
 
-    it('should not have results', () => {
-      expect(component.showEmptySearchSection).toEqual(true);
+    it('should create', () => {
+      expect(component).toBeTruthy();
     });
 
-    it('should display basic search form', () => {
-      expect(fixture.debugElement.query(By.css('ds-search-form')))
+    it('should display basic search form results', () => {
+      expect(fixture.debugElement.query(By.css('ds-search-results')))
         .toBeTruthy();
     });
+
+    it('should call router.navigateByUrl when platform is browser', () => {
+      component.redirect('test-url');
+      expect(routerStub.navigateByUrl).toHaveBeenCalledWith('test-url', {replaceUrl: true});
+    });
   });
 
   describe('should search bitstreams', () => {
 
-    const bitstreamMetadata = {
-      'dc.title': [{ value: 'test.pdf' } as MetadataValue],
-      'dc.description': [{ value: 'TestDescription' } as MetadataValue]
-    } as MetadataMap;
-    const bitstream = Object.assign(
-      new Bitstream(),
-      { _name: 'test.pdf', sizeBytes: 15, uuid: 'fa272dbf-e458-4ad2-868b-b4a27c6eac15', metadata: bitstreamMetadata }
-    ) as Bitstream;
-
     beforeEach(() => {
       fixture = TestBed.createComponent(LuckySearchComponent);
       component = fixture.componentInstance;
@@ -174,39 +177,40 @@ describe('SearchComponent', () => {
       };
 
       const itemUUID = 'd317835d-7b06-4219-91e2-1191900cb897';
-      const firstSearchResult = Object.assign(new SearchResult(), {
+      const searchResult = Object.assign(new SearchResult(), {
         indexableObject: Object.assign(new DSpaceObject(), {
-          id: 'd317835d-7b06-4219-91e2-1191900cb897',
+          id: 'd317835d-7b06-4219-91e2-12222',
           uuid: itemUUID,
           name: 'My first publication',
           metadata: {
             'dspace.entity.type': [
-              { value: 'Publication' }
+              {value: 'Publication'}
             ]
           }
         })
       });
-      const data = createSuccessfulRemoteDataObject(createPaginatedList([firstSearchResult]));
-      const metadataFilters = [{ metadataName: 'dc.title', metadataValue: 'test.pdf' }] as MetadataFilter[];
+      const data = createSuccessfulRemoteDataObject(createPaginatedList([searchResult]));
+      const metadataFilters = [{metadataName: 'dc.title', metadataValue: 'title.pdf'}] as MetadataFilter[];
       component.bitstreamFilters$.next(metadataFilters);
       bitstreamDataService.findByItem.withArgs(itemUUID, 'ORIGINAL', metadataFilters, {})
         .and.returnValue(createSuccessfulRemoteDataObject$(createPaginatedList([bitstream])));
 
+      component.currentFilter = {identifier: 'test', value: 'test'};
+      component.searchOptions$ = observableOf(defaultPagination);
+
+      spyOn((component as any), 'getLuckySearchResults').and.returnValue(observableOf(data));
+      spyOn((component as any), 'loadBitstreamsAndRedirectIfNeeded').and.returnValue(observableOf([bitstream]));
+      spyOn((component as any), 'hasBitstreamFilters').and.returnValue(true);
       spyOn(component, 'redirect');
-      spyOn(component.bitstreams$, 'next').and.callThrough();
       spyOn(routerStub, 'parseUrl').and.returnValue(bitstreamSearchTree);
 
-      component.resultsRD$.next(data as any);
+      component.resultsRD$.next(data);
 
       fixture.detectChanges();
     });
 
-    it('should load item bitstreams', () => {
-      expect(component.bitstreams$.next).toHaveBeenCalledWith([bitstream]);
-    });
-
-    it('should redirect to bitstream', () => {
-      expect(component.redirect).toHaveBeenCalledWith(`/bitstreams/${bitstream.uuid}/download`);
+    it('should redirect to bitstream download route when only one bitstream is found', () => {
+      expect(component.redirect).toHaveBeenCalledWith(getBitstreamDownloadRoute(bitstream));
     });
 
     it('should return bitstream filename', () => {
@@ -221,4 +225,96 @@ describe('SearchComponent', () => {
       expect(component.getSize(bitstream)).toEqual(15);
     });
   });
+
+  describe('one item is available', () => {
+      beforeEach(() => {
+        fixture = TestBed.createComponent(LuckySearchComponent);
+        component = fixture.componentInstance;
+
+        const bitstreamSearchTree = new UrlTree();
+        bitstreamSearchTree.queryParams = {
+          index: 'testIndex',
+          value: 'testValue',
+          bitstreamMetadata: 'testMetadata',
+          bitstreamValue: 'testMetadataValue'
+        };
+
+        const itemUUID = 'd317835d-7b06-4219-91e2-1191900cb897';
+        const firstSearchResult = Object.assign(new SearchResult(), {
+          indexableObject: Object.assign(new DSpaceObject(), {
+            id: 'd317835d-7b06-4219-91e2-1191900cb897',
+            uuid: itemUUID,
+            name: 'My first publication',
+            metadata: {
+              'dspace.entity.type': [
+                {value: 'Publication'}
+              ]
+            }
+          })
+        });
+        const data = createSuccessfulRemoteDataObject(createPaginatedList([firstSearchResult]));
+        const metadataFilters = [{metadataName: 'dc.title', metadataValue: 'test.pdf'}] as MetadataFilter[];
+        component.bitstreamFilters$.next(metadataFilters);
+        bitstreamDataService.findByItem.withArgs(itemUUID, 'ORIGINAL', metadataFilters, {})
+          .and.returnValue(createSuccessfulRemoteDataObject$(createPaginatedList([bitstream])));
+
+        component.currentFilter = {identifier: 'test', value: 'test'};
+        component.searchOptions$ = observableOf(defaultPagination);
+
+        spyOn((component as any), 'getLuckySearchResults').and.returnValue(observableOf(data));
+        spyOn((component as any), 'loadBitstreamsAndRedirectIfNeeded').and.returnValue(observableOf([bitstream]));
+        spyOn((component as any), 'hasBitstreamFilters').and.returnValue(true);
+        spyOn(component, 'redirect');
+        spyOn(routerStub, 'parseUrl').and.returnValue(bitstreamSearchTree);
+
+        component.resultsRD$.next(data);
+
+        fixture.detectChanges();
+      });
+
+      it('should create', () => {
+        expect(component).toBeTruthy();
+      });
+
+      it('should redirect to item page when only one result is found', () => {
+        expect(component.redirect).toHaveBeenCalled();
+      });
+    });
+
+    it('should not redirect when no bitstreams are found', () => {
+      const item = Object.assign(new Item(), {uuid: 'item-uuid-1', name: 'Test item 1'});
+      const data = createSuccessfulRemoteDataObject(createPaginatedList([
+        {indexableObject: item, hitHighlights: {}}
+      ])) as any;
+      component.resultsRD$.next(data);
+      component.bitstreamFilters$.next([{metadataName: 'dc.title', metadataValue: 'Non-existent bitstream'}]);
+      bitstreamDataService.findByItem.and.returnValue(createSuccessfulRemoteDataObject$(createPaginatedList([])));
+      spyOn(component, 'redirect');
+      fixture.detectChanges();
+      expect(component.redirect).not.toHaveBeenCalled();
+    });
+
+  it('should update showEmptySearchSection$ and showMultipleSearchSection$ based on search results', () => {
+    const emptyResults = createSuccessfulRemoteDataObject(createPaginatedList([]));
+    const multipleResults = createSuccessfulRemoteDataObject(createPaginatedList([
+      new SearchResult<DSpaceObject>(),
+      new SearchResult<DSpaceObject>()
+    ]));
+
+    spyOn(component as any, 'getLuckySearchResults').and.returnValue(observableOf(emptyResults));
+    spyOn(component as any, 'processSearchResults').and.returnValue(observableOf(emptyResults));
+
+    component.getSearchResults();
+
+    expect(component.showEmptySearchSection$.getValue()).toBe(true);
+    expect(component.showMultipleSearchSection$.getValue()).toBe(false);
+
+    (component as any).getLuckySearchResults.and.returnValue(observableOf(multipleResults));
+    (component as any).processSearchResults.and.returnValue(observableOf(multipleResults));
+
+    component.getSearchResults();
+
+    expect(component.showEmptySearchSection$.getValue()).toBe(false);
+    expect(component.showMultipleSearchSection$.getValue()).toBe(true);
+  });
 });
diff --git a/src/app/lucky-search/search/lucky-search.component.ts b/src/app/lucky-search/search/lucky-search.component.ts
