34 lines
1.4 KiB
TypeScript
34 lines
1.4 KiB
TypeScript
/** Poll cadence for watched change requests. */
|
|
|
|
import type { ChangeRequestSnapshot, ForgeFailure } from './types.ts'
|
|
|
|
/** Resolved intervals that pace polling. */
|
|
export interface PollIntervals {
|
|
/** Delay while checks run or mergeability is unknown. */
|
|
readonly activeIntervalMs: number
|
|
/** Delay for a closed request or an open request whose checks have settled. */
|
|
readonly idleIntervalMs: number
|
|
/** Largest delay after consecutive failures. */
|
|
readonly maxBackoffMs: number
|
|
}
|
|
|
|
/**
|
|
* Choose the delay before the next poll of one change request. Failures back
|
|
* off exponentially from the active interval; merged change requests stop
|
|
* polling, while closed ones use the idle cadence to detect reopening.
|
|
* @param result - latest snapshot or failure.
|
|
* @param failures - consecutive failures, counting `result` when it is one.
|
|
* @param intervals - configured cadence.
|
|
* @returns the delay in milliseconds, or undefined after a terminal state.
|
|
*/
|
|
export function nextPollDelay(
|
|
result: ChangeRequestSnapshot | ForgeFailure,
|
|
failures: number,
|
|
intervals: PollIntervals,
|
|
): number | undefined {
|
|
if ('code' in result) return Math.min(intervals.maxBackoffMs, intervals.activeIntervalMs * 2 ** failures)
|
|
if (result.state === 'merged') return undefined
|
|
if (result.state === 'closed') return intervals.idleIntervalMs
|
|
return result.checksRollup === 'pending' || result.mergeability === 'unknown' ? intervals.activeIntervalMs : intervals.idleIntervalMs
|
|
}
|