Class EntityCacheEffects

modules/data/src/effects/entity-cache-effects.ts:43–192

@Injectable()
export class EntityCacheEffects {
  // 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;

  constructor(
    private actions: Actions,
    private dataService: EntityCacheDataService,
    private entityActionFactory: EntityActionFactory,
    private logger: Logger,
    /**
     * 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
  ) {}

  /**
   * Observable of SAVE_ENTITIES_CANCEL actions with non-null correlation ids
   */
  saveEntitiesCancel$: Observable<SaveEntitiesCancel> = createEffect(
    () =>
      this.actions.pipe(
        ofType(EntityCacheAction.SAVE_ENTITIES_CANCEL),
        filter((a: SaveEntitiesCancel) => a.payload.correlationId != null)
      ),
    { dispatch: false }
  );

  // Concurrent persistence requests considered unsafe.
  // `mergeMap` allows for concurrent requests which may return in any order
  saveEntities$: Observable<Action> = createEffect(() =>
    this.actions.pipe(
      ofType(EntityCacheAction.SAVE_ENTITIES),
      mergeMap((action: SaveEntities) => this.saveEntities(action))
    )
  );

  /**
   * Perform the requested SaveEntities actions and return a scalar Observable<Action>
   * that the effect should dispatch to the store after the server responds.
   * @param action The SaveEntities action
   */
  saveEntities(action: SaveEntities): Observable<Action> {
    const error = action.payload.error;
    if (error) {
      return this.handleSaveEntitiesError$(action)(error);
    }
    try {
      const changeSet = excludeEmptyChangeSetItems(action.payload.changeSet);
      const { correlationId, mergeStrategy, tag, url } = action.payload;
      const options = { correlationId, mergeStrategy, tag };

      if (changeSet.changes.length === 0) {
        // nothing to save