@tanstack/pacer 0.1.0 → 0.3.0

package/src/async-queuer.ts

@@ -10,6 +10,16 @@ export interface AsyncQueuerOptions<TValue> {
    * Maximum number of concurrent tasks to process
    */
   concurrency?: number
+  /**
+   * Maximum time in milliseconds that an item can stay in the queue
+   * If not provided, items will never expire
+   */
+  expirationDuration?: number
+  /**
+   * Function to determine if an item has expired
+   * If provided, this overrides the expirationDuration behavior
+   */
+  getIsExpired?: (item: () => Promise<TValue>, addedAt: number) => boolean
   /**
    * Default position to get items from during processing
    * @default 'front'
@@ -36,12 +46,24 @@ export interface AsyncQueuerOptions<TValue> {
     item: () => Promise<TValue>,
     queuer: AsyncQueuer<TValue>,
   ) => void
+  /**
+   * Callback fired whenever the queuer's running state changes
+   */
+  onIsRunningChange?: (queuer: AsyncQueuer<TValue>) => void
   /**
    * Callback fired whenever an item is added or removed from the queuer
    */
-  onUpdate?: (queuer: AsyncQueuer<TValue>) => void
+  onItemsChange?: (queuer: AsyncQueuer<TValue>) => void
+  /**
+   * Callback fired whenever an item is rejected from being added to the queuer
+   */
+  onReject?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void
   /**
-   * Whether the queuer should start processing tasks immediately
+   * Callback fired whenever an item expires in the queuer
+   */
+  onExpire?: (item: () => Promise<TValue>, queuer: AsyncQueuer<TValue>) => void
+  /**
+   * Whether the queuer should start processing tasks immediately or not.
    */
   started?: boolean
   /**
@@ -53,64 +75,73 @@ export interface AsyncQueuerOptions<TValue> {
 const defaultOptions: Required<AsyncQueuerOptions<any>> = {
   addItemsTo: 'back',
   concurrency: 1,
+  expirationDuration: Infinity,
+  getIsExpired: () => false,
   getItemsFrom: 'front',
-  getPriority: (item) => (item as any).priority ?? 0,
+  getPriority: (item) => (item as any)?.priority ?? 0,
   initialItems: [],
   maxSize: Infinity,
   onGetNextItem: () => {},
-  onUpdate: () => {},
-  started: false,
+  onIsRunningChange: () => {},
+  onItemsChange: () => {},
+  onReject: () => {},
+  onExpire: () => {},
+  started: true,
   wait: 0,
 }
 
 /**
- * A flexible asynchronous queuer that processes tasks with configurable concurrency control.
+ * A flexible asynchronous queue that processes tasks with configurable concurrency control.
  *
  * Features:
- * - Priority queuer support via getPriority option
+ * - Priority queue support via getPriority option
  * - Configurable concurrency limit
  * - Task success/error/completion callbacks
- * - FIFO (First In First Out) or LIFO (Last In First Out) queuer behavior
+ * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior
  * - Pause/resume task processing
  * - Task cancellation
+ * - Item expiration to clear stale items from the queue
  *
  * Tasks are processed concurrently up to the configured concurrency limit. When a task completes,
  * the next pending task is processed if below the concurrency limit.
  *
  * @example
  * ```ts
- * const queuer = new AsyncQueuer<string>({ concurrency: 2 });
+ * const asyncQueuer = new AsyncQueuer<string>({ concurrency: 2 });
  *
- * queuer.addItem(async () => {
+ * asyncQueuer.addItem(async () => {
  *   return 'Hello';
  * });
  *
- * queuer.start();
+ * asyncQueuer.start();
  *
- * queuer.onSuccess((result) => {
+ * asyncQueuer.onSuccess((result) => {
  *   console.log(result); // 'Hello'
  * });
  * ```
  */
 export class AsyncQueuer<TValue> {
-  protected options: Required<AsyncQueuerOptions<TValue>>
-  private items: Array<() => Promise<TValue>> = []
-  private activeItems: Set<() => Promise<TValue>> = new Set()
-  private onSuccessCallbacks: Array<(result: TValue) => void> = []
-  private onErrorCallbacks: Array<(error: Error) => void> = []
-  private onSettledCallbacks: Array<(result: TValue | Error) => void> = []
-  private running: boolean
-  private pendingTick = false
-  private executionCount = 0
+  private _options: Required<AsyncQueuerOptions<TValue>>
+  private _activeItems: Set<() => Promise<TValue>> = new Set()
+  private _executionCount = 0
+  private _rejectionCount = 0
+  private _expirationCount = 0
+  private _items: Array<() => Promise<TValue>> = []
+  private _itemTimestamps: Array<number> = []
+  private _onErrorCallbacks: Array<(error: Error) => void> = []
+  private _onSettledCallbacks: Array<(result: TValue | Error) => void> = []
+  private _onSuccessCallbacks: Array<(result: TValue) => void> = []
+  private _pendingTick = false
+  private _running: boolean
 
   constructor(initialOptions: AsyncQueuerOptions<TValue> = defaultOptions) {
-    this.options = { ...defaultOptions, ...initialOptions }
-    this.running = this.options.started
+    this._options = { ...defaultOptions, ...initialOptions }
+    this._running = this._options.started
 
-    for (let i = 0; i < this.options.initialItems.length; i++) {
-      const item = this.options.initialItems[i]!
-      const isLast = i === this.options.initialItems.length - 1
-      this.addItem(item, this.options.addItemsTo, isLast)
+    for (let i = 0; i < this._options.initialItems.length; i++) {
+      const item = this._options.initialItems[i]!
+      const isLast = i === this._options.initialItems.length - 1
+      this.addItem(item, this._options.addItemsTo, isLast)
     }
   }
 
@@ -118,32 +149,39 @@ export class AsyncQueuer<TValue> {
    * Updates the queuer options
    * Returns the new options state
    */
-  setOptions(
-    newOptions: Partial<AsyncQueuerOptions<TValue>>,
-  ): AsyncQueuerOptions<TValue> {
-    this.options = { ...this.options, ...newOptions }
-    return this.options
+  setOptions(newOptions: Partial<AsyncQueuerOptions<TValue>>): void {
+    this._options = { ...this._options, ...newOptions }
+  }
+
+  /**
+   * Returns the current queuer options
+   */
+  getOptions(): Required<AsyncQueuerOptions<TValue>> {
+    return this._options
   }
 
   /**
    * Processes items in the queuer
    */
-  protected tick() {
-    if (!this.running) {
-      this.pendingTick = false
+  private tick() {
+    if (!this._running) {
+      this._pendingTick = false
       return
     }
 
+    // Check for expired items
+    this.checkExpiredItems()
+
     while (
-      this.activeItems.size < this.options.concurrency &&
-      !this.isEmpty()
+      this._activeItems.size < this._options.concurrency &&
+      !this.getIsEmpty()
     ) {
       const nextFn = this.getNextItem()
       if (!nextFn) {
         break
       }
-
-      this.activeItems.add(nextFn)
+      this._activeItems.add(nextFn)
+      this._options.onItemsChange(this)
       ;(async () => {
         let success = false
         let res!: TValue
@@ -155,19 +193,19 @@ export class AsyncQueuer<TValue> {
         } catch (e) {
           error = e as Error
         } finally {
-          this.options.onUpdate(this)
+          this._activeItems.delete(nextFn)
+          this._options.onItemsChange(this)
         }
 
-        this.activeItems.delete(nextFn)
         if (success) {
-          this.onSuccessCallbacks.forEach((cb) => cb(res))
+          this._onSuccessCallbacks.forEach((cb) => cb(res))
         } else {
-          this.onErrorCallbacks.forEach((cb) => cb(error!))
+          this._onErrorCallbacks.forEach((cb) => cb(error!))
         }
-        this.onSettledCallbacks.forEach((cb) => cb(success ? res : error!))
+        this._onSettledCallbacks.forEach((cb) => cb(success ? res : error!))
 
-        if (this.options.wait > 0) {
-          setTimeout(() => this.tick(), this.options.wait)
+        if (this._options.wait > 0) {
+          setTimeout(() => this.tick(), this._options.wait)
           return
         }
 
@@ -175,7 +213,109 @@ export class AsyncQueuer<TValue> {
       })()
     }
 
-    this.pendingTick = false
+    this._pendingTick = false
+  }
+
+  /**
+   * Checks for and removes expired items from the queuer
+   */
+  private checkExpiredItems() {
+    if (
+      this._options.expirationDuration === Infinity &&
+      this._options.getIsExpired === defaultOptions.getIsExpired
+    )
+      return
+
+    const now = Date.now()
+    const expiredIndices: Array<number> = []
+
+    // Find indices of expired items
+    for (let i = 0; i < this._items.length; i++) {
+      const timestamp = this._itemTimestamps[i]
+      if (timestamp === undefined) continue
+
+      const item = this._items[i]
+      if (item === undefined) continue
+
+      const isExpired =
+        this._options.getIsExpired !== defaultOptions.getIsExpired
+          ? this._options.getIsExpired(item, timestamp)
+          : now - timestamp > this._options.expirationDuration
+
+      if (isExpired) {
+        expiredIndices.push(i)
+      }
+    }
+
+    // Remove expired items from back to front to maintain indices
+    for (let i = expiredIndices.length - 1; i >= 0; i--) {
+      const index = expiredIndices[i]
+      if (index === undefined) continue
+
+      const expiredItem = this._items[index]
+      if (expiredItem === undefined) continue
+
+      this._items.splice(index, 1)
+      this._itemTimestamps.splice(index, 1)
+      this._expirationCount++
+      this._options.onExpire(expiredItem, this)
+    }
+
+    if (expiredIndices.length > 0) {
+      this._options.onItemsChange(this)
+    }
+  }
+
+  /**
+   * Starts the queuer and processes items
+   */
+  start(): Promise<void> {
+    this._running = true
+    if (!this._pendingTick && !this.getIsEmpty()) {
+      this._pendingTick = true
+      this.tick()
+    }
+    this._options.onIsRunningChange(this)
+
+    return new Promise<void>((resolve) => {
+      const checkIdle = () => {
+        if (this.getIsIdle()) {
+          resolve()
+        } else {
+          setTimeout(checkIdle, 100)
+        }
+      }
+      checkIdle()
+    })
+  }
+
+  /**
+   * Stops the queuer from processing items
+   */
+  stop(): void {
+    this._running = false
+    this._pendingTick = false
+    this._options.onIsRunningChange(this)
+  }
+
+  /**
+   * Removes all items from the queuer
+   */
+  clear(): void {
+    this._items = []
+    this._options.onItemsChange(this)
+  }
+
+  /**
+   * Resets the queuer to its initial state
+   */
+  reset(withInitialItems?: boolean): void {
+    this.clear()
+    this._executionCount = 0
+    if (withInitialItems) {
+      this._items = [...this._options.initialItems]
+    }
+    this._running = this._options.started
   }
 
   /**
@@ -183,10 +323,12 @@ export class AsyncQueuer<TValue> {
    */
   addItem(
     fn: (() => Promise<TValue>) & { priority?: number },
-    position: QueuePosition = this.options.addItemsTo,
+    position: QueuePosition = this._options.addItemsTo,
     runOnUpdate: boolean = true,
   ): Promise<TValue> {
-    if (this.isFull()) {
+    if (this.getIsFull()) {
+      this._rejectionCount++
+      this._options.onReject(fn, this)
       return Promise.reject(new Error('Queuer is full'))
     }
 
@@ -207,40 +349,44 @@ export class AsyncQueuer<TValue> {
 
       // Get priority either from the function or from getPriority option
       const priority =
-        this.options.getPriority !== defaultOptions.getPriority
-          ? this.options.getPriority(task)
+        this._options.getPriority !== defaultOptions.getPriority
+          ? this._options.getPriority(task)
           : task.priority
 
       if (priority !== undefined) {
         // Insert based on priority
-        const insertIndex = this.items.findIndex((existing) => {
+        const insertIndex = this._items.findIndex((existing) => {
           const existingPriority =
-            this.options.getPriority !== defaultOptions.getPriority
-              ? this.options.getPriority(existing)
+            this._options.getPriority !== defaultOptions.getPriority
+              ? this._options.getPriority(existing)
               : (existing as any).priority
           return existingPriority > priority
         })
 
         if (insertIndex === -1) {
-          this.items.push(task)
+          this._items.push(task)
+          this._itemTimestamps.push(Date.now())
         } else {
-          this.items.splice(insertIndex, 0, task)
+          this._items.splice(insertIndex, 0, task)
+          this._itemTimestamps.splice(insertIndex, 0, Date.now())
         }
       } else {
         // Default FIFO/LIFO behavior
         if (position === 'front') {
-          this.items.unshift(task)
+          this._items.unshift(task)
+          this._itemTimestamps.unshift(Date.now())
         } else {
-          this.items.push(task)
+          this._items.push(task)
+          this._itemTimestamps.push(Date.now())
         }
       }
 
       if (runOnUpdate) {
-        this.options.onUpdate(this)
+        this._options.onItemsChange(this)
       }
 
-      if (this.running && !this.pendingTick) {
-        this.pendingTick = true
+      if (this._running && !this._pendingTick) {
+        this._pendingTick = true
         this.tick()
       }
     })
@@ -250,20 +396,22 @@ export class AsyncQueuer<TValue> {
    * Removes and returns an item from the queuer
    */
   getNextItem(
-    position: QueuePosition = this.options.getItemsFrom,
+    position: QueuePosition = this._options.getItemsFrom,
   ): (() => Promise<TValue>) | undefined {
     let item: (() => Promise<TValue>) | undefined
 
     if (position === 'front') {
-      item = this.items.shift()
+      item = this._items.shift()
+      this._itemTimestamps.shift()
     } else {
-      item = this.items.pop()
+      item = this._items.pop()
+      this._itemTimestamps.pop()
     }
 
     if (item !== undefined) {
-      this.executionCount++
-      this.options.onUpdate(this)
-      this.options.onGetNextItem(item, this)
+      this._executionCount++
+      this._options.onItemsChange(this)
+      this._options.onGetNextItem(item, this)
     }
     return item
   }
@@ -271,89 +419,94 @@ export class AsyncQueuer<TValue> {
   /**
    * Returns an item without removing it
    */
-  peek(position: QueuePosition = 'front'): (() => Promise<TValue>) | undefined {
+  getPeek(
+    position: QueuePosition = 'front',
+  ): (() => Promise<TValue>) | undefined {
     if (position === 'front') {
-      return this.items[0]
+      return this._items[0]
     }
-    return this.items[this.items.length - 1]
+    return this._items[this._items.length - 1]
   }
 
   /**
    * Returns true if the queuer is empty
    */
-  isEmpty(): boolean {
-    return this.items.length === 0
+  getIsEmpty(): boolean {
+    return this._items.length === 0
   }
 
   /**
    * Returns true if the queuer is full
    */
-  isFull(): boolean {
-    return this.items.length >= this.options.maxSize
+  getIsFull(): boolean {
+    return this._items.length >= this._options.maxSize
   }
 
   /**
    * Returns the current size of the queuer
    */
-  size(): number {
-    return this.items.length
+  getSize(): number {
+    return this._items.length
   }
 
   /**
-   * Removes all items from the queuer
+   * Returns a copy of all items in the queuer
    */
-  clear(): void {
-    this.items = []
-    this.options.onUpdate(this)
+  getAllItems(): Array<() => Promise<TValue>> {
+    return [...this.getActiveItems(), ...this.getPendingItems()]
   }
 
   /**
-   * Resets the queuer to its initial state
+   * Returns the active items
    */
-  reset(withInitialItems?: boolean): void {
-    this.clear()
-    this.executionCount = 0
-    if (withInitialItems) {
-      this.items = [...this.options.initialItems]
-    }
-    this.running = this.options.started
+  getActiveItems(): Array<() => Promise<TValue>> {
+    return Array.from(this._activeItems)
   }
 
   /**
-   * Returns a copy of all items in the queuer
+   * Returns the pending items
    */
-  getAllItems(): Array<() => Promise<TValue>> {
-    return [...this.items]
+  getPendingItems(): Array<() => Promise<TValue>> {
+    return [...this._items]
   }
 
   /**
    * Returns the number of items that have been removed from the queuer
    */
   getExecutionCount(): number {
-    return this.executionCount
+    return this._executionCount
   }
 
   /**
-   * Returns the active items
+   * Returns the number of items that have been rejected from the queuer
    */
-  getActiveItems(): Array<() => Promise<TValue>> {
-    return Array.from(this.activeItems)
+  getRejectionCount(): number {
+    return this._rejectionCount
   }
 
   /**
-   * Returns the pending items
+   * Returns true if the queuer is running
    */
-  getPendingItems(): Array<() => Promise<TValue>> {
-    return this.getAllItems()
+  getIsRunning(): boolean {
+    return this._running
+  }
+
+  /**
+   * Returns true if the queuer is running but has no items to process
+   */
+  getIsIdle(): boolean {
+    return this._running && this.getIsEmpty() && this._activeItems.size === 0
   }
 
   /**
    * Adds a callback to be called when a task succeeds
    */
   onSuccess(cb: (result: TValue) => void) {
-    this.onSuccessCallbacks.push(cb)
+    this._onSuccessCallbacks.push(cb)
     return () => {
-      this.onSuccessCallbacks = this.onSuccessCallbacks.filter((d) => d !== cb)
+      this._onSuccessCallbacks = this._onSuccessCallbacks.filter(
+        (d) => d !== cb,
+      )
     }
   }
 
@@ -361,9 +514,9 @@ export class AsyncQueuer<TValue> {
    * Adds a callback to be called when a task errors
    */
   onError(cb: (error: Error) => void) {
-    this.onErrorCallbacks.push(cb)
+    this._onErrorCallbacks.push(cb)
     return () => {
-      this.onErrorCallbacks = this.onErrorCallbacks.filter((d) => d !== cb)
+      this._onErrorCallbacks = this._onErrorCallbacks.filter((d) => d !== cb)
     }
   }
 
@@ -371,56 +524,19 @@ export class AsyncQueuer<TValue> {
    * Adds a callback to be called when a task is settled
    */
   onSettled(cb: (result: TValue | Error) => void) {
-    this.onSettledCallbacks.push(cb)
+    this._onSettledCallbacks.push(cb)
     return () => {
-      this.onSettledCallbacks = this.onSettledCallbacks.filter((d) => d !== cb)
-    }
-  }
-
-  /**
-   * Starts the queuer and processes items
-   */
-  start(): Promise<void> {
-    this.running = true
-    if (!this.pendingTick && !this.isEmpty()) {
-      this.pendingTick = true
-      this.tick()
+      this._onSettledCallbacks = this._onSettledCallbacks.filter(
+        (d) => d !== cb,
+      )
     }
-    this.options.onUpdate(this)
-
-    return new Promise<void>((resolve) => {
-      const checkIdle = () => {
-        if (this.isIdle()) {
-          resolve()
-        } else {
-          setTimeout(checkIdle, 100)
-        }
-      }
-      checkIdle()
-    })
-  }
-
-  /**
-   * Stops the queuer from processing items
-   */
-  stop(): void {
-    this.running = false
-    this.pendingTick = false
-    this.options.onUpdate(this)
-  }
-
-  /**
-   * Returns true if the queuer is running
-   */
-  isRunning(): boolean {
-    return this.running
   }
 
   /**
-   * Returns true if the queuer is running but has no items to process
+   * Returns the number of items that have expired from the queuer
    */
-  isIdle(): boolean {
-    return this.running && this.isEmpty() && this.activeItems.size === 0
+  getExpirationCount(): number {
+    return this._expirationCount
   }
 }
 
@@ -441,7 +557,9 @@ export class AsyncQueuer<TValue> {
  * @param options - Configuration options for the AsyncQueuer
  * @returns A bound addItem function that can be used to add tasks to the queuer
  */
-export function asyncQueue<TValue>(options: AsyncQueuerOptions<TValue> = {}) {
-  const queuer = new AsyncQueuer<TValue>({ ...options, started: true })
+export function asyncQueue<TValue>(
+  options: Omit<AsyncQueuerOptions<TValue>, 'started'> = {},
+) {
+  const queuer = new AsyncQueuer<TValue>(options)
   return queuer.addItem.bind(queuer)
 }