TanStack

Octane Example: Queue

import { useCallback, useState } from 'octane'
import { createRoot, useLayoutEffect } from 'octane'
import { pacerDevtoolsPlugin } from '@tanstack/pacer-devtools'
import { TanStackDevtoolsCore } from '@tanstack/devtools'
import { queue } from '@tanstack/octane-pacer/queuer'

function App1() {
  const [queueItems, setQueueItems] = useState<Array<number>>([])
  const [processedCount, setProcessedCount] = useState(0)

  function processQueueItem(item: number) {
    console.log('Processing item:', item)
  }

  // Create the simplified queuer function
  const queueItem = useCallback(
    queue<number>(processQueueItem, {
      key: 'Add Number Queue',
      maxSize: 25,
      wait: 1000,
      onItemsChange: (queue) => {
        setQueueItems(queue.peekAllItems())
      },
      onExecute: (_item, queue) => {
        setProcessedCount(queue.store.state.executionCount)
      },
    }),
    [], // must be memoized to avoid re-creating the queue on every render (consider using useQueuer instead in react)
  )

  return (
    <div>
      <h1>{'TanStack Pacer queue Example 1'}</h1>
      <table>
        <tbody>
          <tr>
            <td>{'Queue Size:'}</td>
            <td>{queueItems.length}</td>
          </tr>
          <tr>
            <td>{'Items Processed:'}</td>
            <td>{processedCount}</td>
          </tr>
          <tr>
            <td>{'Queue Items:'}</td>
            <td>{queueItems.join(', ')}</td>
          </tr>
        </tbody>
      </table>
      <button
        onClick={() => {
          const nextNumber = queueItems.length
            ? queueItems[queueItems.length - 1]! + 1
            : 1
          queueItem(nextNumber)
        }}
        disabled={queueItems.length >= 25}
      >
        {'Add Number'}
      </button>
    </div>
  )
}

function App2() {
  const [queueItems, setQueueItems] = useState<Array<string>>([])
  const [processedCount, setProcessedCount] = useState(0)
  const [inputText, setInputText] = useState('')
  const [queuedText, setQueuedText] = useState('')

  function processQueueItem(item: string) {
    setQueuedText(item)
  }

  // Create the simplified queuer function
  const queueTextChange = useCallback(
    queue<string>(processQueueItem, {
      key: 'Text Change Queue',
      maxSize: 100,
      wait: 500,
      onItemsChange: (queue) => {
        setQueueItems(queue.peekAllItems())
      },
      onExecute: (_item, queue) => {
        setProcessedCount(queue.store.state.executionCount)
      },
    }),
    [],
  )

  function handleInputChange(e: Event & { currentTarget: HTMLInputElement }) {
    setInputText(e.currentTarget.value)
    queueTextChange(e.currentTarget.value)
  }

  return (
    <div>
      <h1>{'TanStack Pacer queue Example 2'}</h1>
      <div>
        <input
          autoFocus
          type="search"
          value={inputText}
          onInput={handleInputChange}
          placeholder="Type to add to queue..."
          style={{ width: '100%' }}
        />
      </div>
      <table>
        <tbody>
          <tr>
            <td>{'Queued Text:'}</td>
            <td>{queuedText}</td>
          </tr>
          <tr>
            <td>{'Queue Size:'}</td>
            <td>{queueItems.length}</td>
          </tr>
          <tr>
            <td>{'Items Processed:'}</td>
            <td>{processedCount}</td>
          </tr>
          <tr>
            <td>{'Queue Items:'}</td>
            <td>{queueItems.join(', ')}</td>
          </tr>
        </tbody>
      </table>
    </div>
  )
}

function App3() {
  const [queueItems, setQueueItems] = useState<Array<number>>([])
  const [processedCount, setProcessedCount] = useState(0)
  const [currentValue, setCurrentValue] = useState(50)
  const [queuedValue, setQueuedValue] = useState(50)

  function processQueueItem(item: number) {
    setQueuedValue(item)
  }

  // Create the simplified queuer function
  const queueValue = useCallback(
    queue<number>(processQueueItem, {
      key: 'Range Change Queue',
      maxSize: 100,
      wait: 100,
      onItemsChange: (queue) => {
        setQueueItems(queue.peekAllItems())
      },
      onExecute: (_item, queue) => {
        setProcessedCount(queue.store.state.executionCount)
      },
    }),
    [],
  )

  function handleRangeChange(e: Event & { currentTarget: HTMLInputElement }) {
    const newValue = parseInt(e.currentTarget.value, 10)
    setCurrentValue(newValue)
    queueValue(newValue)
  }

  return (
    <div>
      <h1>{'TanStack Pacer queue Example 3'}</h1>
      <div style={{ marginBottom: '20px' }}>
        <label>
          {'Current Range:'}
          <input
            type="range"
            min="0"
            max="100"
            value={currentValue}
            onInput={handleRangeChange}
            style={{ width: '100%' }}
          />
          <span>{currentValue}</span>
        </label>
      </div>
      <div style={{ marginBottom: '20px' }}>
        <label>
          {'Queued Range (Readonly):'}
          <input
            type="range"
            min="0"
            max="100"
            value={queuedValue}
            disabled
            style={{ width: '100%' }}
          />
          <span>{queuedValue}</span>
        </label>
      </div>
      <table>
        <tbody>
          <tr>
            <td>{'Queue Size:'}</td>
            <td>{queueItems.length}</td>
          </tr>
          <tr>
            <td>{'Items Processed:'}</td>
            <td>{processedCount}</td>
          </tr>
          <tr>
            <td>{'Queue Items:'}</td>
            <td>{queueItems.join(', ')}</td>
          </tr>
        </tbody>
      </table>
    </div>
  )
}

function PacerExample() {
  useLayoutEffect(() => {
    if (!import.meta.env.DEV) return
    const target = document.createElement('div')
    document.body.append(target)
    const host = new TanStackDevtoolsCore({ plugins: [pacerDevtoolsPlugin()] })
    host.mount(target)
    return () => {
      host.unmount()
      target.remove()
    }
  }, [])
  return (
    <div
      onClick={(event) => event.stopPropagation()}
      onInput={(event) => event.stopPropagation()}
    >
      <div>
        <App1 />
        <hr />
        <App2 />
        <hr />
        <App3 />
      </div>
    </div>
  )
}
createRoot(document.getElementById('app')!).render(PacerExample)