[CST-6494] Update filter values when a workflow action is dispatched

Author: atarix83

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

@@ -1,4 +1,4 @@
-import { combineLatest as observableCombineLatest, Observable } from 'rxjs';
+import { BehaviorSubject, combineLatest as observableCombineLatest, Observable } from 'rxjs';
 import { distinctUntilChanged, map } from 'rxjs/operators';
 import { Injectable, InjectionToken } from '@angular/core';
 import {
@@ -26,6 +26,7 @@ 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');
 
 /**
  * Service that performs all actions that have to do with search filters and facets

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

@@ -408,9 +408,11 @@ export class SearchService implements OnDestroy {
    * @param {number} valuePage The page number of the filter values
    * @param {SearchOptions} searchOptions The search configuration for the current search
    * @param {string} filterQuery The optional query used to filter out filter values
+   * @param useCachedVersionIfAvailable If this is true, the request will only be sent if there's
+   *                                    no valid cached version. Defaults to true
    * @returns {Observable<RemoteData<PaginatedList<FacetValue>>>} Emits the given page of facet values
    */
-  getFacetValuesFor(filterConfig: SearchFilterConfig, valuePage: number, searchOptions?: SearchOptions, filterQuery?: string): Observable<RemoteData<FacetValues>> {
+  getFacetValuesFor(filterConfig: SearchFilterConfig, valuePage: number, searchOptions?: SearchOptions, filterQuery?: string, useCachedVersionIfAvailable = true): Observable<RemoteData<FacetValues>> {
     let href;
     const args: string[] = [`page=${valuePage - 1}`, `size=${filterConfig.pageSize}`];
     if (hasValue(filterQuery)) {
@@ -428,7 +430,7 @@ export class SearchService implements OnDestroy {
         return FacetValueResponseParsingService;
       }
     });
-    this.requestService.send(request, true);
+    this.requestService.send(request, useCachedVersionIfAvailable);
 
     return this.rdb.buildFromHref(href);
   }

src/app/shared/object-collection/object-collection.component.html

@@ -20,7 +20,7 @@
                 [importConfig]="importConfig"
                 [customData]="customData"
                 (importObject)="importObject.emit($event)"
-                (contentChange)="contentChange.emit()"
+                (contentChange)="contentChange.emit($event)"
                 (customEvent)="customEvent.emit($event)"
                 (prev)="goPrev()"
                 (next)="goNext()"
@@ -51,6 +51,7 @@
                   [context]="context"
                   [hidePaginationDetail]="hidePaginationDetail"
                   [showPaginator]="showPaginator"
+                  (contentChange)="contentChange.emit($event)"
                   *ngIf="(currentMode$ | async) === viewModeEnum.DetailedListElement">
 </ds-object-detail>
 

src/app/shared/object-collection/object-collection.component.ts

@@ -50,6 +50,11 @@ export class ObjectCollectionComponent implements OnInit {
   @Input() hideGear = false;
   @Input() selectable = false;
   @Input() selectionConfig: {repeatable: boolean, listId: string};
+
+  /**
+   * Emit custom event for listable object custom actions.
+   */
+  @Output() customEvent = new EventEmitter<any>();
   @Output() deselectObject: EventEmitter<ListableObject> = new EventEmitter<ListableObject>();
   @Output() selectObject: EventEmitter<ListableObject> = new EventEmitter<ListableObject>();
 
@@ -132,11 +137,6 @@ export class ObjectCollectionComponent implements OnInit {
    */
   @Output() sortFieldChange: EventEmitter<string> = new EventEmitter<string>();
 
-  /**
-   * Emit custom event for listable object custom actions.
-   */
-  @Output() customEvent = new EventEmitter<any>();
-
   /**
    * If showPaginator is set to true, emit when the previous button is clicked
    */

src/app/shared/object-collection/shared/listable-object/listable-object-component-loader.component.spec.ts

@@ -5,7 +5,9 @@ import { ListableObject } from '../listable-object.model';
 import { GenericConstructor } from '../../../../core/shared/generic-constructor';
 import { Context } from '../../../../core/shared/context.model';
 import { ViewMode } from '../../../../core/shared/view-mode.model';
-import { ItemListElementComponent } from '../../../object-list/item-list-element/item-types/item/item-list-element.component';
+import {
+  ItemListElementComponent
+} from '../../../object-list/item-list-element/item-types/item/item-list-element.component';
 import { ListableObjectDirective } from './listable-object.directive';
 import { TranslateModule } from '@ngx-translate/core';
 import { By } from '@angular/platform-browser';
@@ -146,7 +148,7 @@ describe('ListableObjectComponentLoaderComponent', () => {
       expect((comp as any).instantiateComponent).not.toHaveBeenCalled();
 
       (listableComponent as any).reloadedObject.emit(reloadedObject);
-      tick();
+      tick(200);
 
       expect((comp as any).instantiateComponent).toHaveBeenCalledWith(reloadedObject);
     }));
@@ -155,7 +157,7 @@ describe('ListableObjectComponentLoaderComponent', () => {
       expect((comp as any).contentChange.emit).not.toHaveBeenCalled();
 
       (listableComponent as any).reloadedObject.emit(reloadedObject);
-      tick();
+      tick(200);
 
       expect((comp as any).contentChange.emit).toHaveBeenCalledWith(reloadedObject);
     }));

src/app/shared/object-collection/shared/listable-object/listable-object-component-loader.component.ts

@@ -197,7 +197,10 @@ export class ListableObjectComponentLoaderComponent implements OnInit, OnChanges
           this.compRef.destroy();
           this.object = reloadedObject;
           this.instantiateComponent(reloadedObject);
-          this.contentChange.emit(reloadedObject);
+          // Add delay before emitting event to allow the new object is instantiated
+          setTimeout(() => {
+            this.contentChange.emit(reloadedObject);
+          }, 100);
         }
       });
     }

src/app/shared/object-detail/object-detail.component.html

@@ -14,12 +14,14 @@
   (sortFieldChange)="onSortFieldChange($event)"
   (paginationChange)="onPaginationChange($event)"
   (prev)="goPrev()"
-  (next)="goNext()"
-  >
+  (next)="goNext()">
     <div class="row mt-2" *ngIf="objects?.hasSucceeded" @fadeIn>
       <div class="col"
            *ngFor="let object of objects?.payload?.page">
-        <ds-listable-object-component-loader [object]="object" [viewMode]="viewMode" [context]="context"></ds-listable-object-component-loader>
+        <ds-listable-object-component-loader [object]="object"
+                                             [viewMode]="viewMode"
+                                             [context]="context"
+                                             (contentChange)="contentChange.emit($event)"></ds-listable-object-component-loader>
       </div>
     </div>
   <ds-error *ngIf="objects.hasFailed" message="{{'error.objects' | translate}}"></ds-error>

src/app/shared/object-detail/object-detail.component.ts

@@ -1,11 +1,4 @@
-import {
-  ChangeDetectionStrategy,
-  Component,
-  EventEmitter,
-  Input,
-  Output,
-  ViewEncapsulation
-} from '@angular/core';
+import { ChangeDetectionStrategy, Component, EventEmitter, Input, Output, ViewEncapsulation } from '@angular/core';
 
 import { SortDirection, SortOptions } from '../../core/cache/models/sort-options.model';
 import { PaginatedList } from '../../core/data/paginated-list.model';
@@ -71,6 +64,11 @@ export class ObjectDetailComponent {
    */
   @Input() showPaginator = true;
 
+  /**
+   * Emit when one of the listed object has changed.
+   */
+  @Output() contentChange = new EventEmitter<any>();
+
   /**
    * If showPaginator is set to true, emit when the previous button is clicked
    */

src/app/shared/object-list/object-list.component.html

@@ -14,8 +14,7 @@
         (sortFieldChange)="onSortFieldChange($event)"
         (paginationChange)="onPaginationChange($event)"
         (prev)="goPrev()"
-        (next)="goNext()"
-        >
+        (next)="goNext()">
     <ul *ngIf="objects?.hasSucceeded" class="list-unstyled" [ngClass]="{'ml-4': selectable}">
         <li *ngFor="let object of objects?.payload?.page; let i = index; let last = last" class="mt-4 mb-4 d-flex" [class.border-bottom]="hasBorder && !last" data-test="list-object">
           <ds-selectable-list-item-control *ngIf="selectable" [index]="i"
@@ -31,7 +30,7 @@
                                                [customData]="customData"
                                                (contentChange)="contentChange.emit()"
                                                (customEvent)="customEvent.emit($event)"
-          ></ds-listable-object-component-loader>
+                                               (contentChange)="contentChange.emit($event)"></ds-listable-object-component-loader>
         </li>
     </ul>
 </ds-pagination>

src/app/shared/object-list/object-list.component.ts

@@ -79,7 +79,7 @@ export class ObjectListComponent {
   /**
    * Config used for the import button
    */
-  @Input() importConfig: { importLabel: string };
+  @Input() importConfig: { buttonLabel: string };
 
   /**
    * Whether or not the pagination should be rendered as simple previous and next buttons instead of the normal pagination
@@ -231,4 +231,5 @@ export class ObjectListComponent {
   goNext() {
       this.next.emit(true);
   }
+
 }