@tanstack/pacer 0.1.0 → 0.3.0

package/src/queuer.ts

@@ -7,6 +7,16 @@ export interface QueuerOptions<TValue> {
    * @default 'back'
    */
   addItemsTo?: QueuePosition
+  /**
+   * 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: TValue, addedAt: number) => boolean
   /**
    * Default position to get items from during processing
    * @default 'front'
@@ -25,14 +35,26 @@ export interface QueuerOptions<TValue> {
    * Maximum number of items allowed in the queuer
    */
   maxSize?: number
+  /**
+   * Callback fired whenever an item expires in the queuer
+   */
+  onExpire?: (item: TValue, queuer: Queuer<TValue>) => void
   /**
    * Callback fired whenever an item is removed from the queuer
    */
   onGetNextItem?: (item: TValue, queuer: Queuer<TValue>) => void
+  /**
+   * Callback fired whenever the queuer's running state changes
+   */
+  onIsRunningChange?: (queuer: Queuer<TValue>) => void
   /**
    * Callback fired whenever an item is added or removed from the queuer
    */
-  onUpdate?: (queuer: Queuer<TValue>) => void
+  onItemsChange?: (queuer: Queuer<TValue>) => void
+  /**
+   * Callback fired whenever an item is rejected from being added to the queuer
+   */
+  onReject?: (item: TValue, queuer: Queuer<TValue>) => void
   /**
    * Whether the queuer should start processing tasks immediately
    */
@@ -46,11 +68,16 @@ export interface QueuerOptions<TValue> {
 const defaultOptions: Required<QueuerOptions<any>> = {
   addItemsTo: 'back',
   getItemsFrom: 'front',
-  getPriority: () => 0,
+  getPriority: (item) => item?.priority ?? 0,
+  getIsExpired: () => false,
+  expirationDuration: Infinity,
   initialItems: [],
   maxSize: Infinity,
   onGetNextItem: () => {},
-  onUpdate: () => {},
+  onIsRunningChange: () => {},
+  onItemsChange: () => {},
+  onReject: () => {},
+  onExpire: () => {},
   started: false,
   wait: 0,
 }
@@ -87,7 +114,12 @@ export type QueuePosition = 'front' | 'back'
  * - start(): begins processing items in the queuer
  * - stop(): pauses processing
  * - wait: configurable delay between processing items
- * - onUpdate/onGetNextItem: callbacks for monitoring queuer state
+ * - onItemsChange/onGetNextItem: callbacks for monitoring queuer state
+ *
+ * Supports item expiration to clear stale items from the queuer
+ * - expirationDuration: maximum time in milliseconds that an item can stay in the queue
+ * - getIsExpired: function to override default expiration behavior
+ * - onExpire: callback for when an item expires
  *
  * @example
  * ```ts
@@ -102,7 +134,7 @@ export type QueuePosition = 'front' | 'back'
  *   getPriority: (n) => n, // Higher numbers have priority
  *   started: true, // Begin processing immediately
  *   wait: 1000, // Wait 1s between items
- *   onGetNextItem: (item) => console.log(item)
+ *   onGetNextItem: (item, queuer) => console.log(item)
  * });
  * priorityQueue.addItem(1); // [1]
  * priorityQueue.addItem(3); // [3, 1] - 3 processed first
@@ -110,59 +142,161 @@ export type QueuePosition = 'front' | 'back'
  * ```
  */
 export class Queuer<TValue> {
-  protected options: Required<QueuerOptions<TValue>>
-  private items: Array<TValue> = []
-  private executionCount = 0
-  private onUpdates: Array<(item: TValue) => void> = []
-  private running: boolean
-  private pendingTick = false
+  private _options: Required<QueuerOptions<TValue>>
+  private _items: Array<TValue> = []
+  private _itemTimestamps: Array<number> = []
+  private _executionCount = 0
+  private _rejectionCount = 0
+  private _expirationCount = 0
+  private _onItemsChanges: Array<(item: TValue) => void> = []
+  private _running: boolean
+  private _pendingTick = false
 
   constructor(initialOptions: QueuerOptions<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)
     }
   }
 
+  /**
+   * Updates the queuer options
+   * Returns the new options state
+   */
+  setOptions(newOptions: Partial<QueuerOptions<TValue>>): void {
+    this._options = { ...this._options, ...newOptions }
+  }
+
+  /**
+   * Returns the current queuer options
+   */
+  getOptions(): Required<QueuerOptions<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
     }
-    while (!this.isEmpty()) {
-      const nextItem = this.getNextItem(this.options.getItemsFrom)
+
+    // Check for expired items
+    this.checkExpiredItems()
+
+    while (!this.getIsEmpty()) {
+      const nextItem = this.getNextItem(this._options.getItemsFrom)
       if (nextItem === undefined) {
         break
       }
-      this.onUpdates.forEach((cb) => cb(nextItem))
+      this._onItemsChanges.forEach((cb) => cb(nextItem))
 
-      if (this.options.wait > 0) {
+      if (this._options.wait > 0) {
         // Use setTimeout to wait before processing next item
-        setTimeout(() => this.tick(), this.options.wait)
+        setTimeout(() => this.tick(), this._options.wait)
         return
       }
 
       this.tick()
     }
-    this.pendingTick = false
+    this._pendingTick = false
   }
 
   /**
-   * Updates the queuer options
-   * Returns the new options state
+   * 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)
+    }
+  }
+
+  /**
+   * Stops the queuer from processing items
+   */
+  stop() {
+    this._running = false
+    this._pendingTick = false
+    this._options.onIsRunningChange(this)
+  }
+
+  /**
+   * Starts the queuer and processes items
+   */
+  start() {
+    this._running = true
+    if (!this._pendingTick && !this.getIsEmpty()) {
+      this._pendingTick = true
+      this.tick()
+    }
+    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
    */
-  setOptions(
-    newOptions: Partial<QueuerOptions<TValue>>,
-  ): QueuerOptions<TValue> {
-    this.options = { ...this.options, ...newOptions }
-    return this.options
+  reset(withInitialItems?: boolean): void {
+    this.clear()
+    this._executionCount = 0
+    if (withInitialItems) {
+      this._items = [...this._options.initialItems]
+    }
+    this._running = this._options.started
   }
 
   /**
@@ -171,40 +305,46 @@ export class Queuer<TValue> {
    */
   addItem(
     item: TValue,
-    position: QueuePosition = this.options.addItemsTo,
+    position: QueuePosition = this._options.addItemsTo,
     runOnUpdate: boolean = true,
   ): boolean {
-    if (this.isFull()) {
+    if (this.getIsFull()) {
+      this._rejectionCount++
+      this._options.onReject(item, this)
       return false
     }
 
-    if (this.options.getPriority !== defaultOptions.getPriority) {
+    if (this._options.getPriority !== defaultOptions.getPriority) {
       // If custom priority function is provided, insert based on priority
-      const priority = this.options.getPriority(item)
-      const insertIndex = this.items.findIndex(
-        (existing) => this.options.getPriority(existing) > priority,
+      const priority = this._options.getPriority(item)
+      const insertIndex = this._items.findIndex(
+        (existing) => this._options.getPriority(existing) > priority,
       )
 
       if (insertIndex === -1) {
-        this.items.push(item)
+        this._items.push(item)
+        this._itemTimestamps.push(Date.now())
       } else {
-        this.items.splice(insertIndex, 0, item)
+        this._items.splice(insertIndex, 0, item)
+        this._itemTimestamps.splice(insertIndex, 0, Date.now())
       }
     } else {
       // Default FIFO/LIFO behavior
       if (position === 'front') {
-        this.items.unshift(item)
+        this._items.unshift(item)
+        this._itemTimestamps.unshift(Date.now())
       } else {
-        this.items.push(item)
+        this._items.push(item)
+        this._itemTimestamps.push(Date.now())
       }
     }
 
-    if (this.running && !this.pendingTick) {
-      this.pendingTick = true
+    if (this._running && !this._pendingTick) {
+      this._pendingTick = true
       this.tick()
     }
     if (runOnUpdate) {
-      this.options.onUpdate(this)
+      this._options.onItemsChange(this)
     }
     return true
   }
@@ -221,20 +361,22 @@ export class Queuer<TValue> {
    * ```
    */
   getNextItem(
-    position: QueuePosition = this.options.getItemsFrom,
+    position: QueuePosition = this._options.getItemsFrom,
   ): TValue | undefined {
     let item: 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
   }
@@ -245,118 +387,81 @@ export class Queuer<TValue> {
    * @example
    * ```ts
    * // Look at next item to getNextItem
-   * queuer.peek()
+   * queuer.getPeek()
    * // Look at last item (like stack top)
-   * queuer.peek('back')
+   * queuer.getPeek('back')
    * ```
    */
-  peek(
-    position: QueuePosition = this.options.getItemsFrom,
+  getPeek(
+    position: QueuePosition = this._options.getItemsFrom,
   ): 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
-  }
-
-  /**
-   * Removes all items from the queuer
-   */
-  clear(): void {
-    this.items = []
-    this.options.onUpdate(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
+  getSize(): number {
+    return this._items.length
   }
 
   /**
    * Returns a copy of all items in the queuer
    */
   getAllItems(): Array<TValue> {
-    return [...this.items]
+    return [...this._items]
   }
 
   /**
    * Returns the number of items that have been removed from the queuer
    */
   getExecutionCount(): number {
-    return this.executionCount
+    return this._executionCount
   }
 
   /**
-   * Adds a callback to be called when an item is processed
+   * Returns the number of items that have been rejected from the queuer
    */
-  onUpdate(cb: (item: TValue) => void) {
-    this.onUpdates.push(cb)
-    return () => {
-      this.onUpdates = this.onUpdates.filter((d) => d !== cb)
-    }
+  getRejectionCount(): number {
+    return this._rejectionCount
   }
 
   /**
-   * Stops the queuer from processing items
+   * Returns the number of items that have expired from the queuer
    */
-  stop() {
-    this.running = false
-    this.pendingTick = false
-    this.options.onUpdate(this)
-  }
-
-  /**
-   * Starts the queuer and processes items
-   */
-  start() {
-    this.running = true
-    if (!this.pendingTick && !this.isEmpty()) {
-      this.pendingTick = true
-      this.tick()
-    }
-    this.options.onUpdate(this)
+  getExpirationCount(): number {
+    return this._expirationCount
   }
 
   /**
    * Returns true if the queuer is running
    */
-  isRunning() {
-    return this.running
+  getIsRunning() {
+    return this._running
   }
 
   /**
    * Returns true if the queuer is running but has no items to process
    */
-  isIdle() {
-    return this.running && this.isEmpty()
+  getIsIdle() {
+    return this._running && this.getIsEmpty()
   }
 }
 
@@ -374,7 +479,7 @@ export class Queuer<TValue> {
  * // Basic sequential processing
  * const processItems = queuer<number>({
  *   wait: 1000,
- *   onUpdate: (queuer) => console.log(queuer.getAllItems())
+ *   onItemsChange: (queuer) => console.log(queuer.getAllItems())
  * })
  * processItems(1) // Logs: 1
  * processItems(2) // Logs: 2 after 1 completes