함수: createAsyncRateLimiter()

function createAsyncRateLimiter<TFn, TSelected>(
   fn, 
   options, 
selector): SolidAsyncRateLimiter<TFn, TSelected>;

정의 위치: solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:220

시간 창 안에서 비동기 함수가 실행될 수 있는 횟수를 제한하는 AsyncRateLimiter 인스턴스를 생성하는 저수준 Solid 훅입니다.

유연하고 상태 관리 방식에 구애받지 않도록 설계되었습니다. 요청률 제한기 인스턴스만 반환하므로 createSignal 등 원하는 상태 관리 솔루션과 통합할 수 있습니다.

요청률 제한은 시간 창 안에서 제한 횟수까지 함수 실행을 허용한 다음 창이 지날 때까지 모든 후속 호출을 차단하는 단순한 방식입니다. 이로 인해 모든 실행이 즉시 발생한 뒤 완전히 차단되는 "버스트" 동작이 나타날 수 있습니다.

요청률 제한기는 두 가지 창 유형을 지원합니다.

• 'fixed': 창 기간이 지나면 초기화되는 엄격한 창입니다. 창 안의 모든 실행이 제한 횟수에 포함되며, 기간이 지나면 창이 완전히 초기화됩니다.
• 'sliding': 이전 실행이 만료되는 대로 새 실행을 허용하는 이동 창입니다. 시간에 따라 더 일관된 실행률을 제공합니다.

비동기가 아닌 RateLimiter와 달리 이 비동기 버전은 요청률이 제한된 함수의 값을 반환할 수 있습니다. 따라서 디바운스된 함수 안에서 결과를 상태 변수에 설정하는 대신 maybeExecute 호출 결과를 사용하려는 API 호출 및 기타 비동기 작업에 적합합니다.

더 부드러운 실행 패턴이 필요하다면 다음을 사용합니다.

• 스로틀: 실행 사이에 일정한 간격을 보장합니다(예: 200ms마다 최대 한 번).
• 디바운스: 호출이 멈출 때까지 기다린 후 실행합니다(예: 500ms 동안 호출이 없을 때).

요청률 제한은 엄격한 API 제한이나 리소스 제약에 가장 적합합니다. UI 업데이트나 빈번한 이벤트를 완화할 때는 일반적으로 스로틀이나 디바운스가 더 나은 사용자 경험을 제공합니다.

오류 처리:

• onError 핸들러를 제공하면 오류 및 요청률 제한기 인스턴스와 함께 호출됩니다.
• throwOnError가 true이면(onError 핸들러가 없을 때의 기본값) 오류가 발생합니다.
• throwOnError가 false이면(onError 핸들러가 있을 때의 기본값) 오류가 처리된 것으로 간주됩니다.
• onError와 throwOnError를 함께 사용할 수 있으며, 오류가 발생하기 전에 핸들러가 호출됩니다.
• 내부 AsyncRateLimiter 인스턴스를 사용해 오류 상태를 확인할 수 있습니다.
• 요청률 제한 거부(한도 초과 시)는 onReject 핸들러를 통해 실행 오류와 별도로 처리됩니다.

상태 관리와 셀렉터

훅은 반응형 상태 관리에 TanStack Store를 사용합니다. 다음 두 가지 방식으로 상태 변경을 구독할 수 있습니다. 구독 방식은 다음과 같습니다.

1. rateLimiter.Subscribe 컴포넌트 사용(컴포넌트 트리 구독에 권장)

Subscribe 컴포넌트를 사용하면 컴포넌트 트리 깊은 곳에서 상태 변경을 구독하면서도 훅에 셀렉터를 전달할 필요가 없습니다. 자식 컴포넌트에서 상태를 구독하려는 경우에 적합합니다.

2. selector 매개변수 사용(훅 수준 구독)

selector 매개변수로 반응형 업데이트를 트리거할 상태 변경을 지정할 수 있으며, 훅 수준에서 관련 없는 상태가 변경될 때 불필요한 업데이트를 방지하여 성능을 최적화합니다.

기본적으로 반응형 상태 구독은 없습니다. 반응형 상태를 추적하려면 셀렉터 함수를 제공하여 셀렉터 함수를 제공하거나 Subscribe 컴포넌트를 사용해 명시적으로 활성화해야 합니다. 이를 통해 불필요한 업데이트를 방지하고 컴포넌트가 상태 변경을 추적할 시점을 완전히 제어할 수 있습니다.

사용할 수 있는 상태 속성은 다음과 같습니다.

• currentWindowStart: 현재 창이 시작된 시점의 타임스탬프
• executionCount: 완료된 함수 실행 횟수
• hasError: 마지막 실행에서 오류가 발생했는지 여부
• isExecuting: 현재 비동기 함수 실행이 진행 중인지 여부
• lastError: 가장 최근 실패한 실행의 오류(있는 경우)
• lastResult: 가장 최근에 성공한 실행 결과
• nextWindowTime: 다음 창이 시작되는 시점의 타임스탬프
• rejectionCount: 요청률 제한으로 거부된 함수 호출 횟수
• remainingInWindow: 현재 창에 남은 실행 횟수

언마운트 동작

기본적으로 소유 컴포넌트가 마운트 해제되면 진행 중인 실행을 중단합니다. getAbortSignal()의 중단 신호를 내부 작업(예: fetch)에 전달한 경우에만 Abort가 해당 작업을 취소합니다. onUnmount 옵션으로 이 동작을 사용자 지정할 수 있습니다.

타입 매개변수

TFn

TFn extends AnyAsyncFunction

TSelected

TSelected = { }

매개변수

fn

TFn

options

SolidAsyncRateLimiterOptions<TFn, TSelected>

selector

(state) => TSelected

반환값

SolidAsyncRateLimiter<TFn, TSelected>

예시

// Default behavior - no reactive state subscriptions
const asyncRateLimiter = createAsyncRateLimiter(
  async (id: string) => {
    const data = await api.fetchData(id);
    return data; // Return value is preserved
  },
  { limit: 5, window: 1000 } // 5 calls per second
);

// Subscribe to state changes deep in component tree using Subscribe component
<asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount, isExecuting: state.isExecuting })}>
  {(state) => (
    <div>Rejected: {state().rejectionCount}, {state().isExecuting ? 'Executing' : 'Idle'}</div>
  )}
</asyncRateLimiter.Subscribe>

// Opt-in to track execution state changes at hook level (optimized for loading indicators)
const asyncRateLimiter = createAsyncRateLimiter(
  async (id: string) => {
    const data = await api.fetchData(id);
    return data;
  },
  { limit: 5, window: 1000 },
  (state) => ({ isExecuting: state.isExecuting })
);

// Opt-in to track results when available (optimized for data display)
const asyncRateLimiter = createAsyncRateLimiter(
  async (id: string) => {
    const data = await api.fetchData(id);
    return data;
  },
  { limit: 5, window: 1000 },
  (state) => ({
    lastResult: state.lastResult,
    successCount: state.successCount
  })
);

// Opt-in to track error/rejection state changes (optimized for error handling)
const asyncRateLimiter = createAsyncRateLimiter(
  async (id: string) => {
    const data = await api.fetchData(id);
    return data;
  },
  {
    limit: 5,
    window: 1000,
    onError: (error) => console.error('API call failed:', error),
    onReject: (rateLimiter) => console.log('Rate limit exceeded')
  },
  (state) => ({
    errorCount: state.errorCount,
    rejectionCount: state.rejectionCount
  })
);

// Opt-in to track execution metrics changes (optimized for stats display)
const asyncRateLimiter = createAsyncRateLimiter(
  async (id: string) => {
    const data = await api.fetchData(id);
    return data;
  },
  { limit: 5, window: 1000 },
  (state) => ({
    successCount: state.successCount,
    errorCount: state.errorCount,
    settleCount: state.settleCount,
    rejectionCount: state.rejectionCount
  })
);

// Opt-in to track execution times changes (optimized for window calculations)
const asyncRateLimiter = createAsyncRateLimiter(
  async (id: string) => {
    const data = await api.fetchData(id);
    return data;
  },
  { limit: 5, window: 1000 },
  (state) => ({ executionTimes: state.executionTimes })
);

// Access the selected state (will be empty object {} unless selector provided)
const { isExecuting, lastResult, rejectionCount } = asyncRateLimiter.state();