|
| 1 | +import { describe, expect, it } from "vitest"; |
| 2 | +import { |
| 3 | + MAX_CONSECUTIVE_IDLE_TIMEOUTS_BEFORE_OUTPUT, |
| 4 | + createIdleTimeoutBreakerState, |
| 5 | + stepIdleTimeoutBreaker, |
| 6 | +} from "./idle-timeout-breaker.js"; |
| 7 | + |
| 8 | +// Issue #76293. The wedge: a stalled provider returns from each LLM call |
| 9 | +// with idleTimedOut=true and no completed model progress. Without this |
| 10 | +// breaker the outer run loop in run.ts can keep starting fresh attempts (a |
| 11 | +// new session and a new streamWithIdleTimeout wrapper each time, so any |
| 12 | +// wrapper-local counter would reset on every iteration). The breaker state |
| 13 | +// has to live at the outer-loop scope to survive across attempts and profile |
| 14 | +// failover, which is what stepIdleTimeoutBreaker captures. |
| 15 | +// |
| 16 | +// These tests exercise the helper directly. The integration in run.ts is |
| 17 | +// just `if (step.tripped) return handleRetryLimitExhaustion(...)`, so |
| 18 | +// proving the helper trips/resets correctly is what matters. |
| 19 | +describe("stepIdleTimeoutBreaker (#76293)", () => { |
| 20 | + function drive( |
| 21 | + inputs: Array<{ |
| 22 | + idleTimedOut: boolean; |
| 23 | + completedModelProgress: boolean; |
| 24 | + outputTokens?: number; |
| 25 | + }>, |
| 26 | + options?: { cap?: number }, |
| 27 | + ) { |
| 28 | + const state = createIdleTimeoutBreakerState(); |
| 29 | + const steps: Array<{ consecutive: number; tripped: boolean }> = []; |
| 30 | + for (const input of inputs) { |
| 31 | + steps.push(stepIdleTimeoutBreaker(state, input, options)); |
| 32 | + } |
| 33 | + return steps; |
| 34 | + } |
| 35 | + |
| 36 | + it("default cap matches the constant the run loop reads from", () => { |
| 37 | + expect(MAX_CONSECUTIVE_IDLE_TIMEOUTS_BEFORE_OUTPUT).toBe(5); |
| 38 | + }); |
| 39 | + |
| 40 | + it("does not trip on a single wedged attempt", () => { |
| 41 | + const steps = drive([{ idleTimedOut: true, completedModelProgress: false }]); |
| 42 | + expect(steps[0]).toEqual({ consecutive: 1, tripped: false }); |
| 43 | + }); |
| 44 | + |
| 45 | + it("trips on the Nth consecutive wedged attempt at the default cap", () => { |
| 46 | + const steps = drive([ |
| 47 | + { idleTimedOut: true, completedModelProgress: false }, |
| 48 | + { idleTimedOut: true, completedModelProgress: false }, |
| 49 | + { idleTimedOut: true, completedModelProgress: false }, |
| 50 | + { idleTimedOut: true, completedModelProgress: false }, |
| 51 | + { idleTimedOut: true, completedModelProgress: false }, |
| 52 | + ]); |
| 53 | + expect(steps.map((s) => s.tripped)).toEqual([false, false, false, false, true]); |
| 54 | + expect(steps.at(-1)?.consecutive).toBe(5); |
| 55 | + }); |
| 56 | + |
| 57 | + it("respects an explicit smaller cap", () => { |
| 58 | + const steps = drive( |
| 59 | + [ |
| 60 | + { idleTimedOut: true, completedModelProgress: false }, |
| 61 | + { idleTimedOut: true, completedModelProgress: false }, |
| 62 | + { idleTimedOut: true, completedModelProgress: false }, |
| 63 | + ], |
| 64 | + { cap: 3 }, |
| 65 | + ); |
| 66 | + expect(steps.map((s) => s.tripped)).toEqual([false, false, true]); |
| 67 | + }); |
| 68 | + |
| 69 | + it("disables the breaker entirely when cap is 0 (escape hatch)", () => { |
| 70 | + const steps = drive( |
| 71 | + [ |
| 72 | + { idleTimedOut: true, completedModelProgress: false }, |
| 73 | + { idleTimedOut: true, completedModelProgress: false }, |
| 74 | + { idleTimedOut: true, completedModelProgress: false }, |
| 75 | + { idleTimedOut: true, completedModelProgress: false }, |
| 76 | + { idleTimedOut: true, completedModelProgress: false }, |
| 77 | + { idleTimedOut: true, completedModelProgress: false }, |
| 78 | + { idleTimedOut: true, completedModelProgress: false }, |
| 79 | + ], |
| 80 | + { cap: 0 }, |
| 81 | + ); |
| 82 | + expect(steps.every((s) => !s.tripped)).toBe(true); |
| 83 | + expect(steps.at(-1)?.consecutive).toBe(7); |
| 84 | + }); |
| 85 | + |
| 86 | + it("does not trip when the model completed progress, even on a timeout (slow but alive)", () => { |
| 87 | + // 8 attempts that each timed out but each completed text or tool-call |
| 88 | + // progress. The model is slow at the tail of its turn, not wedged. The |
| 89 | + // breaker must stay disarmed so legitimate slow streams keep retrying. |
| 90 | + const steps = drive( |
| 91 | + Array.from({ length: 8 }, () => ({ |
| 92 | + idleTimedOut: true, |
| 93 | + completedModelProgress: true, |
| 94 | + outputTokens: 220, |
| 95 | + })), |
| 96 | + ); |
| 97 | + expect(steps.every((s) => !s.tripped)).toBe(true); |
| 98 | + expect(steps.at(-1)?.consecutive).toBe(0); |
| 99 | + }); |
| 100 | + |
| 101 | + it("resets the counter when a productive attempt arrives between wedged attempts", () => { |
| 102 | + // 4 wedged + 1 productive (completed progress) + 4 wedged. No run of 5 |
| 103 | + // wedged in a row, so the breaker must stay disarmed across the whole |
| 104 | + // 9-attempt sequence even though 8 of the attempts were wedged in total. |
| 105 | + const steps = drive([ |
| 106 | + { idleTimedOut: true, completedModelProgress: false }, |
| 107 | + { idleTimedOut: true, completedModelProgress: false }, |
| 108 | + { idleTimedOut: true, completedModelProgress: false }, |
| 109 | + { idleTimedOut: true, completedModelProgress: false }, |
| 110 | + { idleTimedOut: false, completedModelProgress: true, outputTokens: 320 }, |
| 111 | + { idleTimedOut: true, completedModelProgress: false }, |
| 112 | + { idleTimedOut: true, completedModelProgress: false }, |
| 113 | + { idleTimedOut: true, completedModelProgress: false }, |
| 114 | + { idleTimedOut: true, completedModelProgress: false }, |
| 115 | + ]); |
| 116 | + expect(steps.map((s) => s.tripped)).toEqual([ |
| 117 | + false, |
| 118 | + false, |
| 119 | + false, |
| 120 | + false, |
| 121 | + false, |
| 122 | + false, |
| 123 | + false, |
| 124 | + false, |
| 125 | + false, |
| 126 | + ]); |
| 127 | + expect(steps.map((s) => s.consecutive)).toEqual([1, 2, 3, 4, 0, 1, 2, 3, 4]); |
| 128 | + }); |
| 129 | + |
| 130 | + it("non-timeout error attempts (no output) leave the counter unchanged", () => { |
| 131 | + // Sequence: 3 wedged, then 2 non-timeout attempts that produced no |
| 132 | + // completed progress (e.g. transport error, prompt overflow), then 2 |
| 133 | + // more wedged. The non-timeout attempts must NOT reset the counter |
| 134 | + // (they're not evidence the model is alive) and must NOT increment it |
| 135 | + // (the breaker is specifically about idle timeouts). So 3+0+0+1+1 = 5, |
| 136 | + // trip on the last attempt. |
| 137 | + const steps = drive([ |
| 138 | + { idleTimedOut: true, completedModelProgress: false }, |
| 139 | + { idleTimedOut: true, completedModelProgress: false }, |
| 140 | + { idleTimedOut: true, completedModelProgress: false }, |
| 141 | + { idleTimedOut: false, completedModelProgress: false }, |
| 142 | + { idleTimedOut: false, completedModelProgress: false }, |
| 143 | + { idleTimedOut: true, completedModelProgress: false }, |
| 144 | + { idleTimedOut: true, completedModelProgress: false }, |
| 145 | + ]); |
| 146 | + expect(steps.map((s) => s.consecutive)).toEqual([1, 2, 3, 3, 3, 4, 5]); |
| 147 | + expect(steps.at(-1)?.tripped).toBe(true); |
| 148 | + }); |
| 149 | + |
| 150 | + it("does not reset for partial tool-argument tokens without completed progress", () => { |
| 151 | + const steps = drive([ |
| 152 | + { idleTimedOut: true, completedModelProgress: false, outputTokens: 12 }, |
| 153 | + { idleTimedOut: true, completedModelProgress: false, outputTokens: 18 }, |
| 154 | + { idleTimedOut: true, completedModelProgress: false, outputTokens: 24 }, |
| 155 | + { idleTimedOut: true, completedModelProgress: false, outputTokens: 30 }, |
| 156 | + { idleTimedOut: true, completedModelProgress: false, outputTokens: 36 }, |
| 157 | + ]); |
| 158 | + // Raw provider output tokens can come from partial tool-call argument |
| 159 | + // deltas before the provider stalls. They are billed, but they are not |
| 160 | + // completed progress, so they must not reset the breaker. |
| 161 | + expect(steps.map((s) => s.consecutive)).toEqual([1, 2, 3, 4, 5]); |
| 162 | + expect(steps.at(-1)?.tripped).toBe(true); |
| 163 | + }); |
| 164 | +}); |
0 commit comments