| import { Action } from './Action'; |
| import { SchedulerAction } from '../types'; |
| import { Subscription } from '../Subscription'; |
| import { AsyncScheduler } from './AsyncScheduler'; |
| |
| /** |
| * We need this JSDoc comment for affecting ESDoc. |
| * @ignore |
| * @extends {Ignored} |
| */ |
| export class AsyncAction<T> extends Action<T> { |
| |
| public id: any; |
| public state: T; |
| public delay: number; |
| protected pending: boolean = false; |
| |
| constructor(protected scheduler: AsyncScheduler, |
| protected work: (this: SchedulerAction<T>, state?: T) => void) { |
| super(scheduler, work); |
| } |
| |
| public schedule(state?: T, delay: number = 0): Subscription { |
| |
| if (this.closed) { |
| return this; |
| } |
| |
| // Always replace the current state with the new state. |
| this.state = state; |
| |
| const id = this.id; |
| const scheduler = this.scheduler; |
| |
| // |
| // Important implementation note: |
| // |
| // Actions only execute once by default, unless rescheduled from within the |
| // scheduled callback. This allows us to implement single and repeat |
| // actions via the same code path, without adding API surface area, as well |
| // as mimic traditional recursion but across asynchronous boundaries. |
| // |
| // However, JS runtimes and timers distinguish between intervals achieved by |
| // serial `setTimeout` calls vs. a single `setInterval` call. An interval of |
| // serial `setTimeout` calls can be individually delayed, which delays |
| // scheduling the next `setTimeout`, and so on. `setInterval` attempts to |
| // guarantee the interval callback will be invoked more precisely to the |
| // interval period, regardless of load. |
| // |
| // Therefore, we use `setInterval` to schedule single and repeat actions. |
| // If the action reschedules itself with the same delay, the interval is not |
| // canceled. If the action doesn't reschedule, or reschedules with a |
| // different delay, the interval will be canceled after scheduled callback |
| // execution. |
| // |
| if (id != null) { |
| this.id = this.recycleAsyncId(scheduler, id, delay); |
| } |
| |
| // Set the pending flag indicating that this action has been scheduled, or |
| // has recursively rescheduled itself. |
| this.pending = true; |
| |
| this.delay = delay; |
| // If this action has already an async Id, don't request a new one. |
| this.id = this.id || this.requestAsyncId(scheduler, this.id, delay); |
| |
| return this; |
| } |
| |
| protected requestAsyncId(scheduler: AsyncScheduler, id?: any, delay: number = 0): any { |
| return setInterval(scheduler.flush.bind(scheduler, this), delay); |
| } |
| |
| protected recycleAsyncId(scheduler: AsyncScheduler, id: any, delay: number = 0): any { |
| // If this action is rescheduled with the same delay time, don't clear the interval id. |
| if (delay !== null && this.delay === delay && this.pending === false) { |
| return id; |
| } |
| // Otherwise, if the action's delay time is different from the current delay, |
| // or the action has been rescheduled before it's executed, clear the interval id |
| clearInterval(id); |
| return undefined; |
| } |
| |
| /** |
| * Immediately executes this action and the `work` it contains. |
| * @return {any} |
| */ |
| public execute(state: T, delay: number): any { |
| |
| if (this.closed) { |
| return new Error('executing a cancelled action'); |
| } |
| |
| this.pending = false; |
| const error = this._execute(state, delay); |
| if (error) { |
| return error; |
| } else if (this.pending === false && this.id != null) { |
| // Dequeue if the action didn't reschedule itself. Don't call |
| // unsubscribe(), because the action could reschedule later. |
| // For example: |
| // ``` |
| // scheduler.schedule(function doWork(counter) { |
| // /* ... I'm a busy worker bee ... */ |
| // var originalAction = this; |
| // /* wait 100ms before rescheduling the action */ |
| // setTimeout(function () { |
| // originalAction.schedule(counter + 1); |
| // }, 100); |
| // }, 1000); |
| // ``` |
| this.id = this.recycleAsyncId(this.scheduler, this.id, null); |
| } |
| } |
| |
| protected _execute(state: T, delay: number): any { |
| let errored: boolean = false; |
| let errorValue: any = undefined; |
| try { |
| this.work(state); |
| } catch (e) { |
| errored = true; |
| errorValue = !!e && e || new Error(e); |
| } |
| if (errored) { |
| this.unsubscribe(); |
| return errorValue; |
| } |
| } |
| |
| /** @deprecated This is an internal implementation detail, do not use. */ |
| _unsubscribe() { |
| |
| const id = this.id; |
| const scheduler = this.scheduler; |
| const actions = scheduler.actions; |
| const index = actions.indexOf(this); |
| |
| this.work = null; |
| this.state = null; |
| this.pending = false; |
| this.scheduler = null; |
| |
| if (index !== -1) { |
| actions.splice(index, 1); |
| } |
| |
| if (id != null) { |
| this.id = this.recycleAsyncId(scheduler, id, null); |
| } |
| |
| this.delay = null; |
| } |
| } |