[DURACOM-271] Fix suggestion list pagination and add support for multiple sources

Author: atarix83

src/app/notifications/suggestion-targets/publication-claim/publication-claim.component.ts

@@ -55,14 +55,14 @@ export class PublicationClaimComponent implements OnInit {
   /**
    * The source for which to list targets
    */
-  @Input() source: string;
+  @Input() source = '';
 
   /**
    * The pagination system configuration for HTML listing.
    * @type {PaginationComponentOptions}
    */
   public paginationConfig: PaginationComponentOptions = Object.assign(new PaginationComponentOptions(), {
-    id: 'stp',
+    id: 'stp_' + this.source,
     pageSizeOptions: [5, 10, 20, 40, 60],
   });
 
@@ -99,11 +99,16 @@ export class PublicationClaimComponent implements OnInit {
    * Component initialization.
    */
   ngOnInit(): void {
-    this.targets$ = this.suggestionTargetsStateService.getSuggestionTargets();
-    this.totalElements$ = this.suggestionTargetsStateService.getSuggestionTargetsTotals();
+    this.targets$ = this.suggestionTargetsStateService.getSuggestionTargets(this.source);
+    this.totalElements$ = this.suggestionTargetsStateService.getSuggestionTargetsTotals(this.source);
+  }
 
+  /**
+   * First Suggestion Targets loading after view initialization.
+   */
+  ngAfterViewInit(): void {
     this.subs.push(
-      this.suggestionTargetsStateService.isSuggestionTargetsLoaded().pipe(
+      this.suggestionTargetsStateService.isSuggestionTargetsLoaded(this.source).pipe(
         take(1),
       ).subscribe(() => {
         this.getSuggestionTargets();
@@ -118,7 +123,7 @@ export class PublicationClaimComponent implements OnInit {
    *    'true' if the targets are loading, 'false' otherwise.
    */
   public isTargetsLoading(): Observable<boolean> {
-    return this.suggestionTargetsStateService.isSuggestionTargetsLoading();
+    return this.suggestionTargetsStateService.isSuggestionTargetsLoading(this.source);
   }
 
   /**
@@ -128,7 +133,7 @@ export class PublicationClaimComponent implements OnInit {
    *    'true' if there are operations running on the targets (ex.: a REST call), 'false' otherwise.
    */
   public isTargetsProcessing(): Observable<boolean> {
-    return this.suggestionTargetsStateService.isSuggestionTargetsProcessing();
+    return this.suggestionTargetsStateService.isSuggestionTargetsProcessing(this.source);
   }
 
   /**
@@ -145,7 +150,7 @@ export class PublicationClaimComponent implements OnInit {
    * Unsubscribe from all subscriptions.
    */
   ngOnDestroy(): void {
-    this.suggestionTargetsStateService.dispatchClearSuggestionTargetsAction();
+    this.suggestionTargetsStateService.dispatchClearSuggestionTargetsAction(this.source);
     this.subs
       .filter((sub) => hasValue(sub))
       .forEach((sub) => sub.unsubscribe());

src/app/notifications/suggestion-targets/selectors.ts

@@ -0,0 +1,116 @@
+import {
+  createFeatureSelector,
+  createSelector,
+  MemoizedSelector,
+} from '@ngrx/store';
+
+import { SuggestionTarget } from '../../core/notifications/suggestions/models/suggestion-target.model';
+import { subStateSelector } from '../../submission/selectors';
+import {
+  suggestionNotificationsSelector,
+  SuggestionNotificationsState,
+} from '../notifications.reducer';
+import {
+  SuggestionTargetEntry,
+  SuggestionTargetState,
+} from './suggestion-targets.reducer';
+
+/**
+ * Returns the Reciter Suggestion Target state.
+ * @function _getSuggestionTargetState
+ * @param {AppState} state Top level state.
+ * @return {SuggestionNotificationsState}
+ */
+const _getSuggestionTargetState = createFeatureSelector<SuggestionNotificationsState>('suggestionNotifications');
+
+// Suggestion Targets selectors
+
+/**
+ * Returns the Suggestion Targets State.
+ * @function suggestionTargetStateSelector
+ * @return {SuggestionNotificationsState}
+ */
+export function suggestionTargetStateSelector(): MemoizedSelector<SuggestionNotificationsState, SuggestionTargetState> {
+  return subStateSelector<SuggestionNotificationsState, SuggestionTargetState>(suggestionNotificationsSelector, 'suggestionTarget');
+}
+
+/**
+ * Returns the Reciter Suggestion source state
+ * @function suggestionSourceSelector
+ * @return {SuggestionTargetEntry}
+ */
+export function suggestionSourceSelector(source: string): MemoizedSelector<SuggestionNotificationsState, SuggestionTargetEntry> {
+  return createSelector(suggestionTargetStateSelector(),(state: SuggestionTargetState) => state.sources[source]);
+}
+
+/**
+ * Returns the Suggestion Targets list by source.
+ * @function suggestionTargetObjectSelector
+ * @return {SuggestionTarget[]}
+ */
+export function suggestionTargetObjectSelector(source: string): MemoizedSelector<SuggestionNotificationsState, SuggestionTarget[]> {
+  return createSelector(suggestionSourceSelector(source), (state: SuggestionTargetEntry) => state.targets);
+}
+
+/**
+ * Returns true if the Suggestion Targets are loaded.
+ * @function isSuggestionTargetLoadedSelector
+ * @return {boolean}
+ */
+export const isSuggestionTargetLoadedSelector = (source: string) => {
+  return createSelector(suggestionSourceSelector(source), (state: SuggestionTargetEntry) => state?.loaded || false);
+};
+
+/**
+ * Returns true if the deduplication sets are processing.
+ * @function isSuggestionTargetProcessingSelector
+ * @return {boolean}
+ */
+export const isSuggestionTargetProcessingSelector = (source: string) => {
+  return createSelector(suggestionSourceSelector(source), (state: SuggestionTargetEntry) => state?.processing || false);
+};
+
+/**
+ * Returns the total available pages of Reciter Suggestion Targets.
+ * @function getSuggestionTargetTotalPagesSelector
+ * @return {number}
+ */
+export const getSuggestionTargetTotalPagesSelector = (source: string) => {
+  return createSelector(suggestionSourceSelector(source), (state: SuggestionTargetEntry) => state?.totalPages || 0);
+};
+
+/**
+ * Returns the current page of Suggestion Targets.
+ * @function getSuggestionTargetCurrentPageSelector
+ * @return {number}
+ */
+export const getSuggestionTargetCurrentPageSelector = (source: string) => {
+  return createSelector(suggestionSourceSelector(source), (state: SuggestionTargetEntry) => state?.currentPage || 0);
+};
+
+/**
+ * Returns the total number of Suggestion Targets.
+ * @function getSuggestionTargetTotalsSelector
+ * @return {number}
+ */
+export const getSuggestionTargetTotalsSelector = (source: string) => {
+  return createSelector(suggestionSourceSelector(source), (state: SuggestionTargetEntry) => state?.totalElements || 0);
+};
+
+/**
+ * Returns Suggestion Targets for the current user.
+ * @function getCurrentUserSuggestionTargetsSelector
+ * @return {SuggestionTarget[]}
+ */
+export const getCurrentUserSuggestionTargetsSelector = () => {
+  return createSelector(suggestionTargetStateSelector(), (state: SuggestionTargetState) => state?.currentUserTargets || []);
+};
+
+/**
+ * Returns whether or not the user has consulted their suggestions
+ * @function getCurrentUserSuggestionTargetsVisitedSelector
+ * @return {boolean}
+ */
+export const getCurrentUserSuggestionTargetsVisitedSelector = () => {
+  return createSelector(suggestionTargetStateSelector(), (state: SuggestionTargetState) => state?.currentUserTargetsVisited || false);
+};

src/app/notifications/suggestion-targets/suggestion-targets.actions.ts

@@ -23,10 +23,8 @@ export const SuggestionTargetActionTypes = {
   MARK_USER_SUGGESTIONS_AS_VISITED: type('dspace/integration/openaire/suggestions/target/MARK_USER_SUGGESTIONS_AS_VISITED'),
 };
 
-/* tslint:disable:max-classes-per-file */
-
 /**
- * An ngrx action to retrieve all the Suggestion Targets.
+ * A ngrx action to retrieve all the Suggestion Targets.
  */
 export class RetrieveTargetsBySourceAction implements Action {
   type = SuggestionTargetActionTypes.RETRIEVE_TARGETS_BY_SOURCE;
@@ -56,18 +54,34 @@ export class RetrieveTargetsBySourceAction implements Action {
 }
 
 /**
- * An ngrx action for retrieving 'all Suggestion Targets' error.
+ * A ngrx action for notifying error.
  */
-export class RetrieveAllTargetsErrorAction implements Action {
+export class RetrieveTargetsBySourceErrorAction implements Action {
   type = SuggestionTargetActionTypes.RETRIEVE_TARGETS_BY_SOURCE_ERROR;
+  payload: {
+    source: string;
+  };
+
+  /**
+   * Create a new RetrieveTargetsBySourceAction.
+   *
+   * @param source
+   *    the source for which to retrieve suggestion targets
+   */
+  constructor(source: string) {
+    this.payload = {
+      source,
+    };
+  }
 }
 
 /**
- * An ngrx action to load the Suggestion Target  objects.
+ * A ngrx action to load the Suggestion Target  objects.
  */
 export class AddTargetAction implements Action {
   type = SuggestionTargetActionTypes.ADD_TARGETS;
   payload: {
+    source: string;
     targets: SuggestionTarget[];
     totalPages: number;
     currentPage: number;
@@ -77,6 +91,8 @@ export class AddTargetAction implements Action {
   /**
    * Create a new AddTargetAction.
    *
+   * @param source
+   *    the source of suggestion targets
    * @param targets
    *    the list of targets
    * @param totalPages
@@ -86,8 +102,9 @@ export class AddTargetAction implements Action {
    * @param totalElements
    *    the total available Suggestion Targets
    */
-  constructor(targets: SuggestionTarget[], totalPages: number, currentPage: number, totalElements: number) {
+  constructor(source: string, targets: SuggestionTarget[], totalPages: number, currentPage: number, totalElements: number) {
     this.payload = {
+      source,
       targets,
       totalPages,
       currentPage,
@@ -98,7 +115,7 @@ export class AddTargetAction implements Action {
 }
 
 /**
- * An ngrx action to load the user Suggestion Target object.
+ * A ngrx action to load the user Suggestion Target object.
  * Called by the ??? effect.
  */
 export class AddUserSuggestionsAction implements Action {
@@ -120,7 +137,7 @@ export class AddUserSuggestionsAction implements Action {
 }
 
 /**
- * An ngrx action to reload the user Suggestion Target object.
+ * A ngrx action to reload the user Suggestion Target object.
  * Called by the ??? effect.
  */
 export class RefreshUserSuggestionsAction implements Action {
@@ -135,21 +152,34 @@ export class RefreshUserSuggestionsErrorAction implements Action {
 }
 
 /**
- * An ngrx action to Mark User Suggestions As Visited.
+ * A ngrx action to Mark User Suggestions As Visited.
  * Called by the ??? effect.
  */
 export class MarkUserSuggestionsAsVisitedAction implements Action {
   type = SuggestionTargetActionTypes.MARK_USER_SUGGESTIONS_AS_VISITED;
 }
 
 /**
- * An ngrx action to clear targets state.
+ * A ngrx action to clear targets state.
  */
 export class ClearSuggestionTargetsAction implements Action {
   type = SuggestionTargetActionTypes.CLEAR_TARGETS;
-}
+  payload: {
+    source: string;
+  };
 
-/* tslint:enable:max-classes-per-file */
+  /**
+   * Create a new ClearSuggestionTargetsAction.
+   *
+   * @param source
+   *    the source of suggestion targets
+   */
+  constructor(source: string) {
+    this.payload = {
+      source,
+    };
+  }
+}
 
 /**
  * Export a type alias of all actions in this action group
@@ -161,5 +191,5 @@ export type SuggestionTargetsActions
   | ClearSuggestionTargetsAction
   | MarkUserSuggestionsAsVisitedAction
   | RetrieveTargetsBySourceAction
-  | RetrieveAllTargetsErrorAction
+  | RetrieveTargetsBySourceErrorAction
   | RefreshUserSuggestionsAction;

src/app/notifications/suggestion-targets/suggestion-targets.effects.ts

@@ -14,16 +14,21 @@ import {
   tap,
 } from 'rxjs/operators';
 
+import {
+  AuthActionTypes,
+  RetrieveAuthenticatedEpersonSuccessAction,
+} from '../../core/auth/auth.actions';
 import { PaginatedList } from '../../core/data/paginated-list.model';
+import { EPerson } from '../../core/eperson/models/eperson.model';
 import { SuggestionTarget } from '../../core/notifications/suggestions/models/suggestion-target.model';
 import { NotificationsService } from '../../shared/notifications/notifications.service';
 import { SuggestionsService } from '../suggestions.service';
 import {
   AddTargetAction,
   AddUserSuggestionsAction,
   RefreshUserSuggestionsErrorAction,
-  RetrieveAllTargetsErrorAction,
   RetrieveTargetsBySourceAction,
+  RetrieveTargetsBySourceErrorAction,
   SuggestionTargetActionTypes,
 } from './suggestion-targets.actions';
 
@@ -45,13 +50,13 @@ export class SuggestionTargetsEffects {
         action.payload.currentPage,
       ).pipe(
         map((targets: PaginatedList<SuggestionTarget>) =>
-          new AddTargetAction(targets.page, targets.totalPages, targets.currentPage, targets.totalElements),
+          new AddTargetAction(action.payload.source, targets.page, targets.totalPages, targets.currentPage, targets.totalElements),
         ),
         catchError((error: unknown) => {
           if (error instanceof Error) {
             console.error(error.message);
           }
-          return of(new RetrieveAllTargetsErrorAction());
+          return of(new RetrieveTargetsBySourceErrorAction(action.payload.source));
         }),
       );
     }),
@@ -67,16 +72,27 @@ export class SuggestionTargetsEffects {
     }),
   ), { dispatch: false });
 
+  /**
+   * Show a notification on error.
+   */
+  retrieveUserTargets$ = createEffect(() => this.actions$.pipe(
+    ofType(AuthActionTypes.RETRIEVE_AUTHENTICATED_EPERSON_SUCCESS),
+    switchMap((action: RetrieveAuthenticatedEpersonSuccessAction) => {
+      return this.suggestionsService.retrieveCurrentUserSuggestions(action.payload).pipe(
+        map((suggestionTargets: SuggestionTarget[]) => new AddUserSuggestionsAction(suggestionTargets)),
+      );
+    })));
+
   /**
    * Fetch the current user suggestion
    */
   refreshUserSuggestionsAction$ = createEffect(() => this.actions$.pipe(
     ofType(SuggestionTargetActionTypes.REFRESH_USER_SUGGESTIONS),
     switchMap(() => {
-      return this.store$.select((state: any) => state.core.auth.userId)
+      return this.store$.select((state: any) => state.core.auth.user)
         .pipe(
-          switchMap((userId: string) => {
-            return this.suggestionsService.retrieveCurrentUserSuggestions(userId)
+          switchMap((user: EPerson) => {
+            return this.suggestionsService.retrieveCurrentUserSuggestions(user.uuid)
               .pipe(
                 map((suggestionTargets: SuggestionTarget[]) => new AddUserSuggestionsAction(suggestionTargets)),
                 catchError((error: unknown) => {