@tanstack/pacer 0.1.0 → 0.3.0

package/src/async-rate-limiter.ts

@@ -1,9 +1,9 @@
-import type { RateLimitRejectionInfo } from './rate-limiter'
+import type { AnyAsyncFunction } from './types'
 
 /**
  * Options for configuring an async rate-limited function
  */
-export interface AsyncRateLimiterOptions {
+export interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {
   /**
    * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
    * Defaults to true.
@@ -14,17 +14,38 @@ export interface AsyncRateLimiterOptions {
    */
   limit: number
   /**
-   * Time window in milliseconds within which the limit applies
+   * Optional error handler for when the rate-limited function throws
    */
-  window: number
+  onError?: (error: unknown, rateLimiter: AsyncRateLimiter<TFn>) => void
+  /**
+   * Optional function to call when the rate-limited function is executed
+   */
+  onSettled?: (rateLimiter: AsyncRateLimiter<TFn>) => void
+  /**
+   * Optional function to call when the rate-limited function is executed
+   */
+  onSuccess?: (
+    result: ReturnType<TFn>,
+    rateLimiter: AsyncRateLimiter<TFn>,
+  ) => void
   /**
    * Optional callback function that is called when an execution is rejected due to rate limiting
    */
-  onReject?: (info: RateLimitRejectionInfo) => void
+  onReject?: (rateLimiter: AsyncRateLimiter<TFn>) => void
   /**
-   * Optional error handler for when the rate-limited function throws
+   * Time window in milliseconds within which the limit applies
    */
-  onError?: (error: unknown) => void
+  window: number
+}
+
+const defaultOptions: Required<
+  Omit<AsyncRateLimiterOptions<any>, 'limit' | 'window'>
+> = {
+  enabled: true,
+  onError: () => {},
+  onReject: () => {},
+  onSettled: () => {},
+  onSuccess: () => {},
 }
 
 /**
@@ -52,21 +73,21 @@ export interface AsyncRateLimiterOptions {
  * await rateLimiter.maybeExecute('123');
  * ```
  */
-export class AsyncRateLimiter<
-  TFn extends (...args: Array<any>) => Promise<any>,
-  TArgs extends Parameters<TFn>,
-> {
-  private executionCount = 0
-  private rejectionCount = 0
-  private executionTimes: Array<number> = []
-  private options: AsyncRateLimiterOptions
+export class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
+  private _options: AsyncRateLimiterOptions<TFn>
+  private _errorCount = 0
+  private _executionTimes: Array<number> = []
+  private _lastResult: ReturnType<TFn> | undefined
+  private _rejectionCount = 0
+  private _settleCount = 0
+  private _successCount = 0
 
   constructor(
     private fn: TFn,
-    initialOptions: AsyncRateLimiterOptions,
+    initialOptions: AsyncRateLimiterOptions<TFn>,
   ) {
-    this.options = {
-      enabled: true,
+    this._options = {
+      ...defaultOptions,
       ...initialOptions,
     }
   }
@@ -75,36 +96,15 @@ export class AsyncRateLimiter<
    * Updates the rate limiter options
    * Returns the new options state
    */
-  setOptions(
-    newOptions: Partial<AsyncRateLimiterOptions>,
-  ): AsyncRateLimiterOptions {
-    this.options = {
-      ...this.options,
-      ...newOptions,
-    }
-    return this.options
+  setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>): void {
+    this._options = { ...this._options, ...newOptions }
   }
 
   /**
-   * Returns the number of times the function has been executed
+   * Returns the current rate limiter options
    */
-  getExecutionCount(): number {
-    return this.executionCount
-  }
-
-  /**
-   * Returns the number of times the function has been rejected
-   */
-  getRejectionCount(): number {
-    return this.rejectionCount
-  }
-
-  /**
-   * Returns the number of remaining executions allowed in the current window
-   */
-  getRemainingInWindow(): number {
-    this.cleanupOldExecutions()
-    return Math.max(0, this.options.limit - this.executionTimes.length)
+  getOptions(): Required<AsyncRateLimiterOptions<TFn>> {
+    return this._options as Required<AsyncRateLimiterOptions<TFn>>
   }
 
   /**
@@ -123,70 +123,109 @@ export class AsyncRateLimiter<
    * await rateLimiter.maybeExecute('arg1', 'arg2'); // Rejected
    * ```
    */
-  async maybeExecute(...args: TArgs): Promise<boolean> {
+  async maybeExecute(
+    ...args: Parameters<TFn>
+  ): Promise<ReturnType<TFn> | undefined> {
     this.cleanupOldExecutions()
 
-    if (this.executionTimes.length < this.options.limit) {
+    if (this._executionTimes.length < this._options.limit) {
       await this.executeFunction(...args)
-      return true
+      return this._lastResult
     }
 
     this.rejectFunction()
-    return false
+    return undefined
   }
 
-  private async executeFunction(...args: TArgs): Promise<void> {
-    if (!this.options.enabled) return
+  private async executeFunction(
+    ...args: Parameters<TFn>
+  ): Promise<ReturnType<TFn> | undefined> {
+    if (!this._options.enabled) return
     const now = Date.now()
-    this.executionCount++
-    this.executionTimes.push(now)
+    this._executionTimes.push(now)
 
     try {
-      await this.fn(...args)
+      this._lastResult = await this.fn(...args)
+      this._successCount++
+      this._options.onSuccess?.(this._lastResult!, this)
     } catch (error) {
-      if (this.options.onError) {
-        try {
-          this.options.onError(error)
-        } catch {
-          // Ignore errors from error handler
-        }
-      }
-      throw error
+      this._errorCount++
+      this._options.onError?.(error, this)
     } finally {
+      this._settleCount++
+      this._options.onSettled?.(this)
     }
+
+    return this._lastResult
   }
 
   private rejectFunction(): void {
-    this.rejectionCount++
-    if (this.options.onReject) {
-      const oldestExecution = Math.min(...this.executionTimes)
-      const msUntilNextWindow =
-        oldestExecution + this.options.window - Date.now()
-
-      this.options.onReject({
-        msUntilNextWindow,
-        currentExecutions: this.executionTimes.length,
-        limit: this.options.limit,
-        rejectionCount: this.rejectionCount,
-      })
+    this._rejectionCount++
+    if (this._options.onReject) {
+      this._options.onReject(this)
     }
   }
 
   private cleanupOldExecutions(): void {
     const now = Date.now()
-    const windowStart = now - this.options.window
-    this.executionTimes = this.executionTimes.filter(
+    const windowStart = now - this._options.window
+    this._executionTimes = this._executionTimes.filter(
       (time) => time > windowStart,
     )
   }
 
+  /**
+   * Returns the number of remaining executions allowed in the current window
+   */
+  getRemainingInWindow(): number {
+    this.cleanupOldExecutions()
+    return Math.max(0, this._options.limit - this._executionTimes.length)
+  }
+
+  /**
+   * Returns the number of milliseconds until the next execution will be possible
+   */
+  getMsUntilNextWindow(): number {
+    return this.getRemainingInWindow() * this._options.window
+  }
+
+  /**
+   * Returns the number of times the function has been executed
+   */
+  getSuccessCount(): number {
+    return this._successCount
+  }
+
+  /**
+   * Returns the number of times the function has been settled
+   */
+  getSettleCount(): number {
+    return this._settleCount
+  }
+
+  /**
+   * Returns the number of times the function has errored
+   */
+  getErrorCount(): number {
+    return this._errorCount
+  }
+
+  /**
+   * Returns the number of times the function has been rejected
+   */
+  getRejectionCount(): number {
+    return this._rejectionCount
+  }
+
   /**
    * Resets the rate limiter state
    */
   reset(): void {
-    this.executionTimes = []
-    this.executionCount = 0
-    this.rejectionCount = 0
+    this._executionTimes = []
+    this._successCount = 0
+    this._errorCount = 0
+    this._rejectionCount = 0
+    this._settleCount = 0
   }
 }
 
@@ -207,8 +246,8 @@ export class AsyncRateLimiter<
  * const rateLimited = asyncRateLimit(makeApiCall, {
  *   limit: 5,
  *   window: 60000,
- *   onReject: ({ msUntilNextWindow }) => {
- *     console.log(`Rate limit exceeded. Try again in ${msUntilNextWindow}ms`);
+ *   onReject: (rateLimiter) => {
+ *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  *   }
  * });
  *
@@ -220,9 +259,10 @@ export class AsyncRateLimiter<
  * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
  * ```
  */
-export function asyncRateLimit<
-  TFn extends (...args: Array<any>) => Promise<any>,
->(fn: TFn, initialOptions: Omit<AsyncRateLimiterOptions, 'enabled'>) {
+export function asyncRateLimit<TFn extends AnyAsyncFunction>(
+  fn: TFn,
+  initialOptions: Omit<AsyncRateLimiterOptions<TFn>, 'enabled'>,
+) {
   const rateLimiter = new AsyncRateLimiter(fn, initialOptions)
   return rateLimiter.maybeExecute.bind(rateLimiter)
 }

package/src/async-throttler.ts

@@ -1,26 +1,53 @@
+import type { AnyAsyncFunction } from './types'
+
 /**
  * Options for configuring an async throttled function
  */
-export interface AsyncThrottlerOptions {
+export interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction> {
   /**
    * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.
    * Defaults to true.
    */
   enabled?: boolean
   /**
-   * Time window in milliseconds during which the function can only be executed once
-   * Defaults to 0ms
+   * Whether to execute the function immediately when called
+   * Defaults to true
    */
-  wait: number
+  leading?: boolean
   /**
    * Optional error handler for when the throttled function throws
    */
-  onError?: (error: unknown) => void
+  onError?: (error: unknown, asyncThrottler: AsyncThrottler<TFn>) => void
+  /**
+   * Optional function to call when the throttled function is executed
+   */
+  onSettled?: (asyncThrottler: AsyncThrottler<TFn>) => void
+  /**
+   * Optional function to call when the throttled function is executed
+   */
+  onSuccess?: (
+    result: ReturnType<TFn>,
+    asyncThrottler: AsyncThrottler<TFn>,
+  ) => void
+  /**
+   * Whether to execute the function on the trailing edge of the wait period
+   * Defaults to true
+   */
+  trailing?: boolean
+  /**
+   * Time window in milliseconds during which the function can only be executed once
+   * Defaults to 0ms
+   */
+  wait: number
 }
 
-const defaultOptions: Required<AsyncThrottlerOptions> = {
+const defaultOptions: Required<AsyncThrottlerOptions<any>> = {
   enabled: true,
+  leading: true,
   onError: () => {},
+  onSettled: () => {},
+  onSuccess: () => {},
+  trailing: true,
   wait: 0,
 }
 
@@ -46,23 +73,24 @@ const defaultOptions: Required<AsyncThrottlerOptions> = {
  * });
  * ```
  */
-export class AsyncThrottler<
-  TFn extends (...args: Array<any>) => Promise<any>,
-  TArgs extends Parameters<TFn>,
-> {
-  private abortController: AbortController | null = null
-  private executionCount = 0
-  private isExecuting = false
-  private isScheduled = false
-  private lastArgs: TArgs | undefined
-  private nextExecutionTime = 0
-  private options: Required<AsyncThrottlerOptions>
+export class AsyncThrottler<TFn extends AnyAsyncFunction> {
+  private _options: Required<AsyncThrottlerOptions<TFn>>
+  private _abortController: AbortController | null = null
+  private _errorCount = 0
+  private _isExecuting = false
+  private _lastArgs: Parameters<TFn> | undefined
+  private _lastExecutionTime = 0
+  private _lastResult: ReturnType<TFn> | undefined
+  private _nextExecutionTime = 0
+  private _settleCount = 0
+  private _successCount = 0
+  private _timeoutId: NodeJS.Timeout | null = null
 
   constructor(
     private fn: TFn,
-    initialOptions: AsyncThrottlerOptions,
+    initialOptions: AsyncThrottlerOptions<TFn>,
   ) {
-    this.options = {
+    this._options = {
       ...defaultOptions,
       ...initialOptions,
     }
@@ -72,101 +100,156 @@ export class AsyncThrottler<
    * Updates the throttler options
    * Returns the new options state
    */
-  setOptions(
-    newOptions: Partial<AsyncThrottlerOptions>,
-  ): Required<AsyncThrottlerOptions> {
-    this.options = {
-      ...this.options,
-      ...newOptions,
+  setOptions(newOptions: Partial<AsyncThrottlerOptions<TFn>>): void {
+    this._options = { ...this._options, ...newOptions }
+
+    // End the pending state if the debouncer is disabled
+    if (!this._options.enabled) {
+      this.cancel()
     }
-    return this.options
   }
 
   /**
-   * Returns the number of times the function has been executed
+   * Returns the current options
    */
-  getExecutionCount(): number {
-    return this.executionCount
+  getOptions(): Required<AsyncThrottlerOptions<TFn>> {
+    return this._options
   }
 
   /**
-   * Returns the next execution time
+   * Attempts to execute the throttled function
+   * If a call is already in progress, it may be blocked or queued depending on the `wait` option
    */
-  getNextExecutionTime(): number {
-    return this.nextExecutionTime
+  async maybeExecute(
+    ...args: Parameters<TFn>
+  ): Promise<ReturnType<TFn> | undefined> {
+    const now = Date.now()
+    const timeSinceLastExecution = now - this._lastExecutionTime
+
+    // Handle leading execution
+    if (this._options.leading && timeSinceLastExecution >= this._options.wait) {
+      await this.executeFunction(...args)
+      return this._lastResult
+    } else {
+      // Store the most recent arguments for potential trailing execution
+      this._lastArgs = args
+
+      return new Promise((resolve) => {
+        // Clear any existing timeout to ensure we use the latest arguments
+        if (this._timeoutId) {
+          clearTimeout(this._timeoutId)
+        }
+
+        // Set up trailing execution if enabled
+        if (this._options.trailing) {
+          const _timeSinceLastExecution = this._lastExecutionTime
+            ? now - this._lastExecutionTime
+            : 0
+          const timeoutDuration = this._options.wait - _timeSinceLastExecution
+          this._timeoutId = setTimeout(async () => {
+            if (this._lastArgs !== undefined) {
+              await this.executeFunction(...this._lastArgs)
+            }
+            resolve(this._lastResult)
+          }, timeoutDuration)
+        }
+      })
+    }
+  }
+
+  private async executeFunction(
+    ...args: Parameters<TFn>
+  ): Promise<ReturnType<TFn> | undefined> {
+    if (!this._options.enabled || this._isExecuting) return undefined
+    this._abortController = new AbortController()
+    try {
+      this._isExecuting = true
+      this._lastResult = await this.fn(...args) // EXECUTE!
+      this._successCount++
+      this._options.onSuccess(this._lastResult!, this)
+    } catch (error) {
+      this._errorCount++
+      this._options.onError(error, this)
+    } finally {
+      this._isExecuting = false
+      this._settleCount++
+      this._abortController = null
+      this._lastExecutionTime = Date.now()
+      this._nextExecutionTime = this._lastExecutionTime + this._options.wait
+      this._options.onSettled(this)
+    }
+    return this._lastResult
   }
 
   /**
-   * Cancels any pending execution
+   * Cancels any pending execution or aborts any execution in progress
    */
   cancel(): void {
-    if (this.abortController) {
-      this.abortController.abort()
-      this.abortController = null
+    if (this._timeoutId) {
+      clearTimeout(this._timeoutId)
+      this._timeoutId = null
+    }
+    if (this._abortController) {
+      this._abortController.abort()
+      this._abortController = null
     }
-    this.isScheduled = false
-    this.lastArgs = undefined
+    this._lastArgs = undefined
   }
 
   /**
-   * Attempts to execute the throttled function
-   * If a call is already in progress, it may be blocked or queued depending on the `wait` option
+   * Returns the last execution time
    */
-  async maybeExecute(...args: TArgs): Promise<void> {
-    this.lastArgs = args
-    if (this.isScheduled) return
-    this.isScheduled = true
+  getLastExecutionTime(): number {
+    return this._lastExecutionTime
+  }
 
-    this.abortController = new AbortController()
-    const signal = this.abortController.signal
+  /**
+   * Returns the next execution time
+   */
+  getNextExecutionTime(): number {
+    return this._nextExecutionTime
+  }
 
-    try {
-      while (this.isExecuting) {
-        await this.delay(this.options.wait, signal)
-      }
+  /**
+   * Returns the last result of the debounced function
+   */
+  getLastResult(): ReturnType<TFn> | undefined {
+    return this._lastResult
+  }
 
-      while (Date.now() < this.nextExecutionTime) {
-        await this.delay(this.nextExecutionTime - Date.now(), signal)
-      }
+  /**
+   * Returns the number of times the function has been executed successfully
+   */
+  getSuccessCount(): number {
+    return this._successCount
+  }
 
-      this.isScheduled = false
-      this.isExecuting = true
+  /**
+   * Returns the number of times the function has settled (completed or errored)
+   */
+  getSettleCount(): number {
+    return this._settleCount
+  }
 
-      await this.executeFunction(...this.lastArgs)
-    } catch (error) {
-      if (error instanceof Error && error.name === 'AbortError') {
-        return // Silent return on cancellation
-      }
-      try {
-        this.options.onError(error)
-      } catch {
-        // Ignore errors from error handler
-      }
-    } finally {
-      this.nextExecutionTime = Date.now() + this.options.wait
-      this.isExecuting = false
-      this.abortController = null
-    }
+  /**
+   * Returns the number of times the function has errored
+   */
+  getErrorCount(): number {
+    return this._errorCount
   }
 
-  private delay(ms: number, signal: AbortSignal): Promise<void> {
-    return new Promise((resolve, reject) => {
-      const timeout = setTimeout(resolve, ms)
-      signal.addEventListener(
-        'abort',
-        () => {
-          clearTimeout(timeout)
-          reject(new Error('AbortError'))
-        },
-        { once: true },
-      )
-    })
+  /**
+   * Returns the current pending state
+   */
+  getIsPending(): boolean {
+    return this._options.enabled && !!this._timeoutId
   }
 
-  private async executeFunction(...args: TArgs): Promise<void> {
-    if (!this.options.enabled) return
-    this.executionCount++
-    await this.fn(...args)
+  /**
+   * Returns the current executing state
+   */
+  getIsExecuting(): boolean {
+    return this._isExecuting
   }
 }
 
@@ -186,9 +269,10 @@ export class AsyncThrottler<
  * await throttled(); // Waits 1 second before executing
  * ```
  */
-export function asyncThrottle<
-  TFn extends (...args: Array<any>) => Promise<any>,
->(fn: TFn, initialOptions: Omit<AsyncThrottlerOptions, 'enabled'>) {
+export function asyncThrottle<TFn extends AnyAsyncFunction>(
+  fn: TFn,
+  initialOptions: Omit<AsyncThrottlerOptions<TFn>, 'enabled'>,
+) {
   const asyncThrottler = new AsyncThrottler(fn, initialOptions)
   return asyncThrottler.maybeExecute.bind(asyncThrottler)
 }