Class EntityEffects

modules/data/src/effects/entity-effects.ts:31–199

@Injectable()
export class EntityEffects {
  // See https://github.com/ReactiveX/rxjs/blob/master/doc/marble-testing.md
  /** Delay for error and skip observables. Must be multiple of 10 for marble testing. */
  private responseDelay = 10;

  /**
   * Observable of non-null cancellation correlation ids from CANCEL_PERSIST actions
   */
  cancel$: Observable<any> = createEffect(
    () =>
      this.actions.pipe(
        ofEntityOp(EntityOp.CANCEL_PERSIST),
        map((action: EntityAction) => action.payload.correlationId),
        filter((id) => id != null)
      ),
    { dispatch: false }
  );

  // `mergeMap` allows for concurrent requests which may return in any order
  persist$: Observable<Action> = createEffect(() =>
    this.actions.pipe(
      ofEntityOp(persistOps),
      mergeMap((action) => this.persist(action))
    )
  );

  constructor(
    private actions: Actions<EntityAction>,
    private dataService: EntityDataService,
    private entityActionFactory: EntityActionFactory,
    private resultHandler: PersistenceResultHandler,
    /**
     * Injecting an optional Scheduler that will be undefined
     * in normal application usage, but its injected here so that you can mock out
     * during testing using the RxJS TestScheduler for simulating passages of time.
     */
    @Optional()
    @Inject(ENTITY_EFFECTS_SCHEDULER)
    private scheduler: SchedulerLike
  ) {}

  /**
   * Perform the requested persistence operation and return a scalar Observable<Action>
   * that the effect should dispatch to the store after the server responds.
   * @param action A persistence operation EntityAction
   */
  persist(action: EntityAction): Observable<Action> {
    if (action.payload.skip) {
      // Should not persist. Pretend it succeeded.
      return this.handleSkipSuccess$(action);
    }
    if (action.payload.error) {
      return this.handleError$(action)(action.payload.error);
    }
    try {
      // Cancellation: returns Observable of CANCELED_PERSIST for a persistence EntityAction
      // whose correlationId matches cancellation correlationId
      const c = this.cancel$.pipe(