111731: Display the authority label in the search labels

Author: alexandrevryghem

src/app/core/shared/search/search-filter.service.ts

@@ -1,6 +1,6 @@
 import { BehaviorSubject, combineLatest as observableCombineLatest, Observable } from 'rxjs';
 import { distinctUntilChanged, map } from 'rxjs/operators';
-import { Injectable, InjectionToken } from '@angular/core';
+import { Injectable, InjectionToken, EventEmitter } from '@angular/core';
 import {
   SearchFiltersState,
   SearchFilterState
@@ -21,12 +21,14 @@ import { SortDirection, SortOptions } from '../../cache/models/sort-options.mode
 import { RouteService } from '../../services/route.service';
 import { PaginationComponentOptions } from '../../../shared/pagination/pagination-component-options.model';
 import { Params } from '@angular/router';
+import { AppliedFilter } from '../../../shared/search/models/applied-filter.model';
 
 const filterStateSelector = (state: SearchFiltersState) => state.searchFilter;
 
 export const FILTER_CONFIG: InjectionToken<SearchFilterConfig> = new InjectionToken<SearchFilterConfig>('filterConfig');
 export const IN_PLACE_SEARCH: InjectionToken<boolean> = new InjectionToken<boolean>('inPlaceSearch');
 export const REFRESH_FILTER: InjectionToken<BehaviorSubject<any>> = new InjectionToken<boolean>('refreshFilters');
+export const CHANGE_APPLIED_FILTERS: InjectionToken<EventEmitter<AppliedFilter[]>> = new InjectionToken('changeAppliedFilters');
 
 /**
  * Service that performs all actions that have to do with search filters and facets

src/app/shared/search/search-filters/search-filter/search-facet-filter-wrapper/search-facet-filter-wrapper.component.ts

@@ -1,15 +1,16 @@
-import { Component, Injector, Input, OnInit } from '@angular/core';
+import { Component, Injector, Input, OnInit, Output, EventEmitter } from '@angular/core';
 import { renderFilterType } from '../search-filter-type-decorator';
 import { FilterType } from '../../../models/filter-type.model';
 import { SearchFilterConfig } from '../../../models/search-filter-config.model';
 import {
   FILTER_CONFIG,
   IN_PLACE_SEARCH,
-  REFRESH_FILTER
+  REFRESH_FILTER, CHANGE_APPLIED_FILTERS
 } from '../../../../../core/shared/search/search-filter.service';
 import { GenericConstructor } from '../../../../../core/shared/generic-constructor';
 import { SearchFacetFilterComponent } from '../search-facet-filter/search-facet-filter.component';
 import { BehaviorSubject } from 'rxjs';
+import { AppliedFilter } from '../../../models/applied-filter.model';
 
 @Component({
   selector: 'ds-search-facet-filter-wrapper',
@@ -35,6 +36,11 @@ export class SearchFacetFilterWrapperComponent implements OnInit {
    */
   @Input() refreshFilters: BehaviorSubject<boolean>;
 
+  /**
+   * Emits the {@link AppliedFilter}s of this search filter
+   */
+  @Output() changeAppliedFilters: EventEmitter<AppliedFilter[]> = new EventEmitter();
+
   /**
    * The constructor of the search facet filter that should be rendered, based on the filter config's type
    */
@@ -56,7 +62,8 @@ export class SearchFacetFilterWrapperComponent implements OnInit {
       providers: [
         { provide: FILTER_CONFIG, useFactory: () => (this.filterConfig), deps: [] },
         { provide: IN_PLACE_SEARCH, useFactory: () => (this.inPlaceSearch), deps: [] },
-        { provide: REFRESH_FILTER, useFactory: () => (this.refreshFilters), deps: [] }
+        { provide: REFRESH_FILTER, useFactory: () => (this.refreshFilters), deps: [] },
+        { provide: CHANGE_APPLIED_FILTERS, useFactory: () => this.changeAppliedFilters },
       ],
       parent: this.injector
     });

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

@@ -1,29 +1,29 @@
-import { ChangeDetectionStrategy, NO_ERRORS_SCHEMA } from '@angular/core';
+import { ChangeDetectionStrategy, EventEmitter, NO_ERRORS_SCHEMA } from '@angular/core';
 import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
 import { TranslateModule } from '@ngx-translate/core';
 import { NoopAnimationsModule } from '@angular/platform-browser/animations';
 import {
+  CHANGE_APPLIED_FILTERS,
   FILTER_CONFIG,
   IN_PLACE_SEARCH,
   REFRESH_FILTER,
   SearchFilterService
 } from '../../../../../core/shared/search/search-filter.service';
 import { SearchFilterConfig } from '../../../models/search-filter-config.model';
 import { FilterType } from '../../../models/filter-type.model';
-import { FacetValue } from '../../../models/facet-value.model';
 import { FormsModule } from '@angular/forms';
 import { BehaviorSubject, of as observableOf } from 'rxjs';
 import { SearchService } from '../../../../../core/shared/search/search.service';
 import { SearchServiceStub } from '../../../../testing/search-service.stub';
-import { buildPaginatedList } from '../../../../../core/data/paginated-list.model';
 import { RouterStub } from '../../../../testing/router.stub';
 import { Router } from '@angular/router';
-import { PageInfo } from '../../../../../core/shared/page-info.model';
 import { SearchFacetFilterComponent } from './search-facet-filter.component';
 import { RemoteDataBuildService } from '../../../../../core/cache/builders/remote-data-build.service';
 import { SearchConfigurationServiceStub } from '../../../../testing/search-configuration-service.stub';
 import { SEARCH_CONFIG_SERVICE } from '../../../../../my-dspace-page/my-dspace-page.component';
 import { createSuccessfulRemoteDataObject$ } from '../../../../remote-data.utils';
+import { AppliedFilter } from '../../../models/applied-filter.model';
+import { FacetValues } from '../../../models/facet-values.model';
 
 describe('SearchFacetFilterComponent', () => {
   let comp: SearchFacetFilterComponent;
@@ -39,45 +39,28 @@ describe('SearchFacetFilterComponent', () => {
     isOpenByDefault: false,
     pageSize: 2
   });
-  const values: FacetValue[] = [
-    {
-      label: value1,
-      value: value1,
-      count: 52,
-      _links: {
-        self: {
-          href: ''
-        },
-        search: {
-          href: ''
-        }
-      }
-    }, {
-      label: value2,
-      value: value2,
-      count: 20,
-      _links: {
-        self: {
-          href: ''
-        },
-        search: {
-          href: ''
-        }
+  const values: Partial<FacetValues> = {
+    appliedFilters: [
+      {
+        filter: filterName1,
+        operator: 'equals',
+        label: value1,
+        value: value1,
+      },
+      {
+        filter: filterName1,
+        operator: 'equals',
+        label: value2,
+        value: value2,
+      },
+      {
+        filter: filterName1,
+        operator: 'equals',
+        label: value3,
+        value: value3,
       }
-    }, {
-      label: value3,
-      value: value3,
-      count: 5,
-      _links: {
-        self: {
-          href: ''
-        },
-        search: {
-          href: ''
-        }
-      }
-    }
-  ];
+    ]
+  };
 
   const searchLink = '/search';
   const selectedValues = [value1, value2];
@@ -86,7 +69,6 @@ describe('SearchFacetFilterComponent', () => {
   let router;
   const page = observableOf(0);
 
-  const mockValues = createSuccessfulRemoteDataObject$(buildPaginatedList(new PageInfo(), values));
   beforeEach(waitForAsync(() => {
     TestBed.configureTestingModule({
       imports: [TranslateModule.forRoot(), NoopAnimationsModule, FormsModule],
@@ -99,6 +81,7 @@ describe('SearchFacetFilterComponent', () => {
         { provide: SEARCH_CONFIG_SERVICE, useValue: new SearchConfigurationServiceStub() },
         { provide: IN_PLACE_SEARCH, useValue: false },
         { provide: REFRESH_FILTER, useValue: new BehaviorSubject<boolean>(false) },
+        { provide: CHANGE_APPLIED_FILTERS, useValue: new EventEmitter() },
         {
           provide: SearchFilterService, useValue: {
             getSelectedValuesForFilter: () => observableOf(selectedValues),
@@ -125,22 +108,11 @@ describe('SearchFacetFilterComponent', () => {
     comp.filterConfig = mockFilterConfig;
     filterService = (comp as any).filterService;
     searchService = (comp as any).searchService;
-    spyOn(searchService, 'getFacetValuesFor').and.returnValue(mockValues);
+    spyOn(searchService, 'getFacetValuesFor').and.returnValue(createSuccessfulRemoteDataObject$(values));
     router = (comp as any).router;
     fixture.detectChanges();
   });
 
-  describe('when the isChecked method is called with a value', () => {
-    beforeEach(() => {
-      spyOn(filterService, 'isFilterActiveWithValue');
-      comp.isChecked(values[1]);
-    });
-
-    it('should call isFilterActiveWithValue on the filterService with the correct filter parameter name and the passed value', () => {
-      expect(filterService.isFilterActiveWithValue).toHaveBeenCalledWith(mockFilterConfig.paramName, values[1].value);
-    });
-  });
-
   describe('when the getSearchLink method is triggered', () => {
     let link: string;
     beforeEach(() => {
@@ -202,7 +174,9 @@ describe('SearchFacetFilterComponent', () => {
 
     beforeEach(() => {
       comp.selectedValues$ = observableOf(selectedValues.map((value) =>
-        Object.assign(new FacetValue(), {
+        Object.assign(new AppliedFilter(), {
+          filter: filterName1,
+          operator: 'equals',
           label: value,
           value: value
         })));

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

@@ -1,5 +1,5 @@
 import { animate, state, style, transition, trigger } from '@angular/animations';
-import { Component, Inject, OnDestroy, OnInit } from '@angular/core';
+import { Component, Inject, OnDestroy, OnInit, EventEmitter } from '@angular/core';
 import { Router } from '@angular/router';
 
 import { BehaviorSubject, combineLatest as observableCombineLatest, Observable, of as observableOf, Subject, Subscription } from 'rxjs';
@@ -13,14 +13,14 @@ import { EmphasizePipe } from '../../../../utils/emphasize.pipe';
 import { FacetValue } from '../../../models/facet-value.model';
 import { SearchFilterConfig } from '../../../models/search-filter-config.model';
 import { SearchService } from '../../../../../core/shared/search/search.service';
-import { FILTER_CONFIG, IN_PLACE_SEARCH, REFRESH_FILTER, SearchFilterService } from '../../../../../core/shared/search/search-filter.service';
+import { FILTER_CONFIG, IN_PLACE_SEARCH, REFRESH_FILTER, SearchFilterService, CHANGE_APPLIED_FILTERS } from '../../../../../core/shared/search/search-filter.service';
 import { SearchConfigurationService } from '../../../../../core/shared/search/search-configuration.service';
 import { getFirstSucceededRemoteData } from '../../../../../core/shared/operators';
 import { InputSuggestion } from '../../../../input-suggestions/input-suggestions.model';
 import { SearchOptions } from '../../../models/search-options.model';
 import { SEARCH_CONFIG_SERVICE } from '../../../../../my-dspace-page/my-dspace-page.component';
 import { currentPath } from '../../../../utils/route.utils';
-import { getFacetValueForType, stripOperatorFromFilterValue } from '../../../search.utils';
+import { getFacetValueForType, stripOperatorFromFilterValue, addOperatorToFilterValue } from '../../../search.utils';
 import { createPendingRemoteDataObject } from '../../../../remote-data.utils';
 import { FacetValues } from '../../../models/facet-values.model';
 import { AppliedFilter } from '../../../models/applied-filter.model';
@@ -93,7 +93,9 @@ export class SearchFacetFilterComponent implements OnInit, OnDestroy {
               @Inject(SEARCH_CONFIG_SERVICE) public searchConfigService: SearchConfigurationService,
               @Inject(IN_PLACE_SEARCH) public inPlaceSearch: boolean,
               @Inject(FILTER_CONFIG) public filterConfig: SearchFilterConfig,
-              @Inject(REFRESH_FILTER) public refreshFilters: BehaviorSubject<boolean>) {
+              @Inject(REFRESH_FILTER) public refreshFilters: BehaviorSubject<boolean>,
+              @Inject(CHANGE_APPLIED_FILTERS) public changeAppliedFilters: EventEmitter<AppliedFilter[]>,
+  ) {
   }
 
   /**
@@ -126,13 +128,6 @@ export class SearchFacetFilterComponent implements OnInit, OnDestroy {
     this.filter = '';
   }
 
-  /**
-   * Checks if a value for this filter is currently active
-   */
-  isChecked(value: FacetValue): Observable<boolean> {
-    return this.filterService.isFilterActiveWithValue(this.filterConfig.paramName, value.value);
-  }
-
   /**
    * @returns {string} The base path to the search page, or the current page when inPlaceSearch is true
    */
@@ -243,13 +238,13 @@ export class SearchFacetFilterComponent implements OnInit, OnDestroy {
    */
   protected applyFilterValue(data) {
     if (data.match(new RegExp(`^.+,(equals|query|authority)$`))) {
-      this.selectedValues$.pipe(take(1)).subscribe((selectedValues) => {
+      this.selectedValues$.pipe(take(1)).subscribe((selectedValues: AppliedFilter[]) => {
         if (isNotEmpty(data)) {
-          this.router.navigate(this.getSearchLinkParts(), {
+          void this.router.navigate(this.getSearchLinkParts(), {
             queryParams:
               {
                 [this.filterConfig.paramName]: [
-                  ...selectedValues.map((appliedFilter: AppliedFilter) => appliedFilter.value),
+                  ...selectedValues.map((appliedFilter: AppliedFilter) => addOperatorToFilterValue(appliedFilter.value, appliedFilter.operator)),
                   data
                 ]
               },
@@ -306,13 +301,15 @@ export class SearchFacetFilterComponent implements OnInit, OnDestroy {
         return this.rdbs.aggregate(filterValues);
       }),
       tap((rd: RemoteData<FacetValues[]>) => {
-        const appliedFilters: AppliedFilter[] = [].concat(...rd.payload.map((facetValues: FacetValues) => facetValues.appliedFilters))
+        const allAppliedFilters: AppliedFilter[] = [].concat(...rd.payload.map((facetValues: FacetValues) => facetValues.appliedFilters))
           .filter((appliedFilter: AppliedFilter) => hasValue(appliedFilter));
         this.selectedValues$ = this.filterService.getSelectedValuesForFilter(this.filterConfig).pipe(
           map((selectedValues: string[]) => {
-            return selectedValues.map((value: string) => {
-              return appliedFilters.find((appliedFilter: AppliedFilter) => appliedFilter.value === stripOperatorFromFilterValue(value));
+            const appliedFilters: AppliedFilter[] = selectedValues.map((value: string) => {
+              return allAppliedFilters.find((appliedFilter: AppliedFilter) => appliedFilter.value === stripOperatorFromFilterValue(value));
             }).filter((appliedFilter: AppliedFilter) => hasValue(appliedFilter));
+            this.changeAppliedFilters.emit(appliedFilters);
+            return appliedFilters;
           }),
         );
         this.animationState = 'ready';

src/app/shared/search/search-filters/search-filter/search-filter.component.html

@@ -20,7 +20,8 @@ <h5 class="d-inline-block mb-0">
     <ds-search-facet-filter-wrapper
       [filterConfig]="filter"
       [inPlaceSearch]="inPlaceSearch"
-      [refreshFilters]="refreshFilters" >
+      [refreshFilters]="refreshFilters"
+      (changeAppliedFilters)="changeAppliedFilters.emit($event)">
     </ds-search-facet-filter-wrapper>
   </div>
 </div>

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

@@ -1,4 +1,4 @@
-import { Component, Inject, Input, OnInit } from '@angular/core';
+import { Component, Inject, Input, OnInit, Output, EventEmitter } from '@angular/core';
 
 import { BehaviorSubject, Observable, of as observableOf } from 'rxjs';
 import { filter, map, startWith, switchMap, take } from 'rxjs/operators';
@@ -11,6 +11,7 @@ import { SearchService } from '../../../../core/shared/search/search.service';
 import { SearchConfigurationService } from '../../../../core/shared/search/search-configuration.service';
 import { SEARCH_CONFIG_SERVICE } from '../../../../my-dspace-page/my-dspace-page.component';
 import { SequenceService } from '../../../../core/shared/sequence.service';
+import { AppliedFilter } from '../../models/applied-filter.model';
 
 @Component({
   selector: 'ds-search-filter',
@@ -38,6 +39,11 @@ export class SearchFilterComponent implements OnInit {
    */
   @Input() refreshFilters: BehaviorSubject<boolean>;
 
+  /**
+   * Emits the {@link AppliedFilter}s of this search filter
+   */
+  @Output() changeAppliedFilters: EventEmitter<AppliedFilter[]> = new EventEmitter();
+
   /**
    * True when the filter is 100% collapsed in the UI
    */