[CST-6876] Retrieve filter list in parent search.component

Author: atarix83

src/app/shared/search/search-filters/search-filters.component.spec.ts

@@ -7,7 +7,7 @@ import { NoopAnimationsModule } from '@angular/platform-browser/animations';
 import { SearchFilterService } from '../../../core/shared/search/search-filter.service';
 import { SearchFiltersComponent } from './search-filters.component';
 import { SearchService } from '../../../core/shared/search/search.service';
-import { of as observableOf, Subject } from 'rxjs';
+import { of as observableOf } from 'rxjs';
 import { SEARCH_CONFIG_SERVICE } from '../../../my-dspace-page/my-dspace-page.component';
 import { SearchConfigurationServiceStub } from '../../testing/search-configuration-service.stub';
 
@@ -66,26 +66,4 @@ describe('SearchFiltersComponent', () => {
     });
   });
 
-  describe('when refreshSearch observable is present and emit events', () => {
-
-    let refreshFiltersEmitter: Subject<any>;
-
-    beforeEach(() => {
-      spyOn(comp, 'initFilters').and.callFake(() => { /****/});
-
-      refreshFiltersEmitter = new Subject();
-      comp.refreshFilters = refreshFiltersEmitter.asObservable();
-      comp.ngOnInit();
-    });
-
-    it('should reinitialize search filters', () => {
-
-      expect(comp.initFilters).toHaveBeenCalledTimes(1);
-
-      refreshFiltersEmitter.next();
-
-      expect(comp.initFilters).toHaveBeenCalledTimes(2);
-    });
-  });
-
 });

src/app/shared/search/search-filters/search-filters.component.ts

@@ -9,7 +9,6 @@ import { RemoteData } from '../../../core/data/remote-data';
 import { SearchFilterConfig } from '../models/search-filter-config.model';
 import { SearchConfigurationService } from '../../../core/shared/search/search-configuration.service';
 import { SearchFilterService } from '../../../core/shared/search/search-filter.service';
-import { getFirstSucceededRemoteData } from '../../../core/shared/operators';
 import { SEARCH_CONFIG_SERVICE } from '../../../my-dspace-page/my-dspace-page.component';
 import { currentPath } from '../../utils/route.utils';
 import { hasValue } from '../../empty.util';
@@ -28,7 +27,7 @@ export class SearchFiltersComponent implements OnInit, OnDestroy {
   /**
    * An observable containing configuration about which filters are shown and how they are shown
    */
-  filters: Observable<RemoteData<SearchFilterConfig[]>>;
+  @Input() filters: Observable<RemoteData<SearchFilterConfig[]>>;
 
   /**
    * List of all filters that are currently active with their value set to null.
@@ -61,11 +60,6 @@ export class SearchFiltersComponent implements OnInit, OnDestroy {
    */
   searchLink: string;
 
-  /**
-   * For chart regular expression
-   */
-  chartReg = new RegExp(/^chart./, 'i');
-
   subs = [];
 
   /**
@@ -83,31 +77,13 @@ export class SearchFiltersComponent implements OnInit, OnDestroy {
   }
 
   ngOnInit(): void {
-
-    this.initFilters();
-
-    if (this.refreshFilters) {
-      this.subs.push(this.refreshFilters.subscribe(() => this.initFilters()));
-    }
-
     this.clearParams = this.searchConfigService.getCurrentFrontendFilters().pipe(map((filters) => {
       Object.keys(filters).forEach((f) => filters[f] = null);
       return filters;
     }));
     this.searchLink = this.getSearchLink();
   }
 
-  initFilters() {
-    this.filters = this.searchService.getConfig(this.currentScope, this.currentConfiguration).pipe(
-      getFirstSucceededRemoteData(),
-      map((rd: RemoteData<SearchFilterConfig[]>) => Object.assign(rd, {
-        payload: rd.payload.filter((filter: SearchFilterConfig) =>
-          !this.chartReg.test(filter.filterType)
-        )})
-      )
-    );
-  }
-
   /**
    * @returns {string} The base path to the search page, or the current page when inPlaceSearch is true
    */

src/app/shared/search/search-sidebar/search-sidebar.component.html

@@ -20,6 +20,7 @@
                                             (changeConfiguration)="changeConfiguration.emit($event)"></ds-search-switch-configuration>
             <ds-search-filters [currentScope]="currentScope"
                                [currentConfiguration]="configuration"
+                               [filters]="filters"
                                [refreshFilters]="refreshFilters"
                                [inPlaceSearch]="inPlaceSearch"></ds-search-filters>
             <ds-search-settings [currentSortOption]="currentSortOption" [sortOptionsList]="sortOptionsList"></ds-search-settings>

src/app/shared/search/search-sidebar/search-sidebar.component.ts

@@ -5,6 +5,8 @@ import { Observable } from 'rxjs';
 import { PaginatedSearchOptions } from '../models/paginated-search-options.model';
 import { SortOptions } from '../../../core/cache/models/sort-options.model';
 import { ViewMode } from '../../../core/shared/view-mode.model';
+import { RemoteData } from '../../../core/data/remote-data';
+import { SearchFilterConfig } from '../models/search-filter-config.model';
 
 /**
  * This component renders a simple item page.
@@ -43,6 +45,11 @@ export class SearchSidebarComponent {
    */
   @Input() currentSortOption: SortOptions;
 
+  /**
+   * An observable containing configuration about which filters are shown and how they are shown
+   */
+  @Input() filters: Observable<RemoteData<SearchFilterConfig[]>>;
+
   /**
    * The total amount of results
    */

src/app/shared/search/search.component.html

@@ -58,6 +58,7 @@
                        [configurationList]="configurationList"
                        [configuration]="(currentConfiguration$ | async)"
                        [currentScope]="(currentScope$ | async)"
+                       [filters]="filtersRD$.asObservable()"
                        [resultCount]="(resultsRD$ | async)?.payload?.totalElements"
                        [searchOptions]="(searchOptions$ | async)"
                        [sortOptionsList]="(sortOptionsList$ | async)"
@@ -71,6 +72,7 @@
                        [configurationList]="configurationList"
                        [configuration]="(currentConfiguration$ | async)"
                        [currentScope]="(currentScope$ | async)"
+                       [filters]="filtersRD$.asObservable()"
                        [resultCount]="(resultsRD$ | async)?.payload.totalElements"
                        [searchOptions]="(searchOptions$ | async)"
                        [sortOptionsList]="(sortOptionsList$ | async)"

src/app/shared/search/search.component.spec.ts

@@ -5,7 +5,7 @@ import { RouterTestingModule } from '@angular/router/testing';
 import { Store } from '@ngrx/store';
 import { TranslateModule } from '@ngx-translate/core';
 import { cold } from 'jasmine-marbles';
-import { Observable, BehaviorSubject, of as observableOf } from 'rxjs';
+import { BehaviorSubject, Observable, of as observableOf } from 'rxjs';
 import { SortDirection, SortOptions } from '../../core/cache/models/sort-options.model';
 import { CommunityDataService } from '../../core/data/community-data.service';
 import { HostWindowService } from '../host-window.service';
@@ -30,6 +30,8 @@ import { RemoteData } from '../../core/data/remote-data';
 import { SearchObjects } from './models/search-objects.model';
 import { DSpaceObject } from '../../core/shared/dspace-object.model';
 import { SearchManager } from '../../core/browse/search-manager';
+import { SearchFilterConfig } from './models/search-filter-config.model';
+import { FilterType } from './models/filter-type.model';
 
 let comp: SearchComponent;
 let fixture: ComponentFixture<SearchComponent>;
@@ -96,10 +98,38 @@ const mockSearchResults: SearchObjects<DSpaceObject> = Object.assign(new SearchO
 });
 const mockResultsRD: RemoteData<SearchObjects<DSpaceObject>> = createSuccessfulRemoteDataObject(mockSearchResults);
 const mockResultsRD$: Observable<RemoteData<SearchObjects<DSpaceObject>>> = observableOf(mockResultsRD);
+
+const mockFilterConfig: SearchFilterConfig = Object.assign(new SearchFilterConfig(), {
+  name: 'test1',
+  filterType: FilterType.text,
+  hasFacets: false,
+  isOpenByDefault: false,
+  pageSize: 2
+});
+const mockFilterConfig2: SearchFilterConfig = Object.assign(new SearchFilterConfig(), {
+  name: 'test2',
+  filterType: FilterType.text,
+  hasFacets: false,
+  isOpenByDefault: false,
+  pageSize: 1
+});
+const mockChartFilterConfig: SearchFilterConfig = Object.assign(new SearchFilterConfig(), {
+  name: 'line',
+  filterType: FilterType['chart.line'],
+  hasFacets: false,
+  isOpenByDefault: false,
+  pageSize: 1
+});
+
+const filtersConfigRD = createSuccessfulRemoteDataObject([mockFilterConfig, mockFilterConfig2, mockChartFilterConfig]);
+const resultFiltersConfigRD = createSuccessfulRemoteDataObject([mockFilterConfig, mockFilterConfig2]);
+const filtersConfigRD$ = observableOf(filtersConfigRD);
+
 const searchServiceStub = jasmine.createSpyObj('SearchService', {
   getSearchLink: '/search',
   getScopes: observableOf(['test-scope']),
-  getSearchConfigurationFor: createSuccessfulRemoteDataObject$(searchConfig)
+  getSearchConfigurationFor: createSuccessfulRemoteDataObject$(searchConfig),
+  getConfig: filtersConfigRD$,
 });
 const searchManagerStub = jasmine.createSpyObj('SearchManager', {
   search: mockResultsRD$,
@@ -152,6 +182,7 @@ const routeServiceStub = {
 
 const searchConfigurationServiceStub = jasmine.createSpyObj('SearchConfigurationService', {
   getConfigurationSortOptions: jasmine.createSpy('getConfigurationSortOptions'),
+  getConfig: filtersConfigRD$,
   getConfigurationSearchConfig: jasmine.createSpy('getConfigurationSearchConfig'),
   getCurrentConfiguration: jasmine.createSpy('getCurrentConfiguration'),
   getCurrentScope: jasmine.createSpy('getCurrentScope'),
@@ -273,6 +304,15 @@ describe('SearchComponent', () => {
     }));
   }));
 
+  it('should retrieve Search Filters', fakeAsync(() => {
+    fixture.detectChanges();
+    tick(100);
+    const expectedResults = resultFiltersConfigRD;
+    expect(comp.filtersRD$).toBeObservable(cold('b', {
+      b: expectedResults
+    }));
+  }));
+
   it('should emit resultFound event', fakeAsync(() => {
     spyOn(comp.resultFound, 'emit');
     const expectedResults = mockSearchResults;

src/app/shared/search/search.component.ts

@@ -41,6 +41,7 @@ import { SelectionConfig } from './search-results/search-results.component';
 import { ListableObject } from '../object-collection/shared/listable-object.model';
 import { CollectionElementLinkType } from '../object-collection/collection-element-link.type';
 import { SearchManager } from '../../core/browse/search-manager';
+import { SearchFilterConfig } from './models/search-filter-config.model';
 
 @Component({
   selector: 'ds-search',
@@ -192,7 +193,12 @@ export class SearchComponent implements OnInit, OnDestroy {
   /**
    * Defines whether to show the toggle button to Show/Hide chart
    */
-   @Input() showChartsToggle = false;
+  @Input() showChartsToggle = false;
+
+  /**
+   * For chart regular expression
+   */
+  chartReg = new RegExp(/^chart./, 'i');
 
   /**
    * The current configuration used during the search
@@ -214,6 +220,16 @@ export class SearchComponent implements OnInit, OnDestroy {
    */
   currentSortOptions$: BehaviorSubject<SortOptions> = new BehaviorSubject<SortOptions>(null);
 
+  /**
+   * An observable containing configuration about which filters are shown and how they are shown
+   */
+  filtersRD$: BehaviorSubject<RemoteData<SearchFilterConfig[]>> = new BehaviorSubject<RemoteData<SearchFilterConfig[]>>(null);
+
+  /**
+   * Maintains the last search options, so it can be used in refresh
+   */
+  lastSearchOptions: PaginatedSearchOptions;
+
   /**
    * The current search results
    */
@@ -356,6 +372,7 @@ export class SearchComponent implements OnInit, OnDestroy {
         this.initialized$.next(true);
         // retrieve results
         this.retrieveSearchResults(newSearchOptions);
+        this.retrieveFilters(searchOptions);
       }
     });
   }
@@ -406,13 +423,33 @@ export class SearchComponent implements OnInit, OnDestroy {
     return this.searchConfigService.paginatedSearchOptions;
   }
 
+  /**
+   * Retrieve search filters by the given search options
+   * @param searchOptions
+   * @private
+   */
+  private retrieveFilters(searchOptions: PaginatedSearchOptions) {
+    this.filtersRD$.next(null);
+    this.service.getConfig(searchOptions.scope, searchOptions.configuration).pipe(
+      getFirstCompletedRemoteData(),
+      map((rd: RemoteData<SearchFilterConfig[]>) => Object.assign(rd, {
+        payload: rd.payload.filter((entry: SearchFilterConfig) =>
+          !this.chartReg.test(entry.filterType)
+        )})
+      )
+    ).subscribe((filtersRD: RemoteData<SearchFilterConfig[]>) => {
+      this.filtersRD$.next(filtersRD);
+    });
+  }
+
   /**
    * Retrieve search result by the given search options
    * @param searchOptions
    * @private
    */
   private retrieveSearchResults(searchOptions: PaginatedSearchOptions) {
     this.resultsRD$.next(null);
+    this.lastSearchOptions = searchOptions;
 
     if (this.projection) {
       searchOptions = Object.assign(new PaginatedSearchOptions({}), searchOptions, {