prompt-cache-control

1/**
2 * prompt-cache-control — Claude Mod
3 *
4 * A prompt-cache meter for Claude Code. Every main-loop request reports how
5 * many prompt tokens the cache served (`cache_read_input_tokens`), wrote
6 * (`cache_creation_input_tokens`) and sent uncached (`input_tokens`); this mod
7 * keeps those per request and per turn, counts down to the moment the cache
8 * lapses, and says what to do about it: keep going, /compact or /clear.
9 *
10 *   - `turn.step` reads each main-loop request's usage (subagents have their
11 *     own prefixes and are left out)
12 *   - `$.clock.every(1000)` redraws the countdown, and only while its text
13 *     changes: an idle, expired session costs nothing
14 *   - a row above the prompt (the AbovePrompt component), an optional status
15 *     line entry, and `/cache`, a pane with one row per turn
16 *
17 * The lifetime is counted from the start of the request that last wrote or read
18 * the cache, as Anthropic documents it. Which lifetime Claude Code asked for
19 * follows its documented rules (see decideTtl in ./cache.ts): FORCE_PROMPT_CACHING_5M,
20 * CLAUDE_CODE_PROMPT_CACHE_TTL, the promptCacheTtl setting, ENABLE_PROMPT_CACHING_1H,
21 * then the account (1 hour on a Claude subscription, 5 minutes otherwise). The
22 * API names the TTL of a write but the mod API passes on only the token counts,
23 * so the mod also watches the gaps between requests (a hit after more than 5
24 * minutes proves 1 hour; see observeTtl). `ttl: "5m" | "1h"` pins it.
25 *
26 * Needs Claude Code >= 2.1.287.
27 *
28 * Options (pluginConfigs["prompt-cache-control@skills-dir"].options):
29 *   ttl: "auto" | "5m" | "1h"   cache lifetime (default auto)
30 *   warnSeconds: number         countdown threshold for the warning (default 60)
31 *   compactAtTokens: number     prompt size that makes an expired cache suggest /compact (default 100000)
32 *   band: boolean               row above the prompt (default true)
33 *   status: boolean             entry under the prompt (default false)
34 *   toast: boolean              toasts near expiry: at warnSeconds, then 10, 3, 2 and 1 s (default true)
35 */
36import type { EngineInterface, Register } from 'claude-code'
37import {
38  advise,
39  COUNTDOWN_MARKS,
40  bar,
41  byTurn,
42  fit,
43  fmtClock,
44  fmtTokens,
45  hitRatio,
46  isCachingDisabled,
47  accountOf,
48  decideTtl,
49  observeTtl,
50  lifeColor,
51  lifeRatio,
52  nextToastMark,
53  positive,
54  promptTokens,
55  remainingMs,
56  rowRatio,
57  segments,
58} from './cache.ts'
59import type { Account, Advice, CacheEnv, Sample, Ttl } from './cache.ts'
60
61const PANE = 'cache'
62const COMMAND = 'cache'
63const KEEP = 200
64// below this a lapsed cache costs too little to interrupt anyone about
65const TOAST_MIN_TOKENS = 20_000
66
67let samples: Sample[] = []
68let ttl: Ttl = '5m'
69let baseTtl: Ttl = '5m'
70let pinned = false
71let observed: Ttl | undefined
72let setting: unknown
73let account: Account = 'other'
74let ttlSource = 'default'
75let envSource = 'default'
76let env: CacheEnv = {}
77let timer: { cancel: () => void } | undefined
78let lastKey = ''
79let toastedFor = 0
80let toastLevel = Infinity
81let isPaneOpen = false
82
83type Policy = { warnMs: number; compactAtTokens: number }
84
85function current(policy: Policy, now: number) {
86  const last = samples[samples.length - 1]
87  const prev = samples[samples.length - 2]
88  const disabled = last ? isCachingDisabled(last.model, env) : isCachingDisabled('', env)
89  const advice: Advice = advise(last, prev, { ttl, ...policy }, now, disabled)
90  const left = last ? remainingMs(last, ttl, now) : 0
91  return { last, advice, left }
92}
93
94const COLOR: Record<Advice['kind'], string | undefined> = {
95  warm: 'green',
96  soon: 'yellow',
97  expired: 'red',
98  miss: 'red',
99  off: undefined,
100  cold: undefined,
101  uncached: undefined,
102}
103
104function shortLine(policy: Policy, now: number): string {
105  const { last, advice, left } = current(policy, now)
106  if (!last || advice.kind === 'off') return `cache: ${advice.text}`
107  const clock = left > 0 ? ` · ${fmtClock(left)}` : ''
108  return `cache ${Math.round(hitRatio(last) * 100)}%${clock}`
109}
110
111// the promptCacheTtl setting, from the settings files that can carry it (local over project over user)
112async function readSetting($: EngineInterface): Promise<unknown> {
113  const home = await $.env.get('HOME').catch(() => undefined)
114  const cwd = await $.session.cwd().catch(() => undefined)
115  const files = [cwd && `${cwd}/.claude/settings.local.json`, cwd && `${cwd}/.claude/settings.json`, home && `${home}/.claude/settings.json`]
116  for (const file of files) {
117    if (!file) continue
118    try {
119      const value = JSON.parse(await $.fs.read(file)).promptCacheTtl
120      if (value === '5m' || value === '1h') return value
121    } catch {
122      // missing or unreadable: the next file
123    }
124  }
125  return undefined
126}
127
128export const register: Register = (on, options) => {
129  const policy: Policy = {
130    warnMs: positive(options.warnSeconds, 60) * 1000,
131    compactAtTokens: positive(options.compactAtTokens, 100_000),
132  }
133  const showBand = options.band !== false
134  const showStatus = options.status === true
135  const wantToast = options.toast !== false
136
137  on('session.start', async ($, e, next) => {
138    const r = await next(e)
139    samples = []
140    lastKey = ''
141    toastedFor = 0
142    const none = () => undefined
143    env = {
144      enable1h: await $.env.get('ENABLE_PROMPT_CACHING_1H').catch(none),
145      force5m: await $.env.get('FORCE_PROMPT_CACHING_5M').catch(none),
146      ttlVar: await $.env.get('CLAUDE_CODE_PROMPT_CACHE_TTL').catch(none),
147      disableAll: await $.env.get('DISABLE_PROMPT_CACHING').catch(none),
148      disableHaiku: await $.env.get('DISABLE_PROMPT_CACHING_HAIKU').catch(none),
149      disableSonnet: await $.env.get('DISABLE_PROMPT_CACHING_SONNET').catch(none),
150      disableOpus: await $.env.get('DISABLE_PROMPT_CACHING_OPUS').catch(none),
151    }
152    pinned = options.ttl === '5m' || options.ttl === '1h'
153    observed = undefined
154    setting = await readSetting($)
155    account = accountOf((await $.session.usage().catch(() => undefined))?.rateLimits ?? [])
156    const choice = decideTtl(options.ttl, env, setting, account)
157    baseTtl = choice.ttl
158    ttl = baseTtl
159    envSource = choice.source
160    ttlSource = envSource
161
162    await $.command
163      .register({
164        name: COMMAND,
165        description: 'Prompt-cache usage per turn and the time left before it lapses (stop closes)',
166        argumentHint: '[stop]',
167        immediate: true,
168      })
169      .catch(err => $.ui.log(`prompt-cache-control: /${COMMAND} not registered: ${err}`))
170    $.ui.log(`prompt-cache-control loaded: ${ttl} cache (${ttlSource}), /${COMMAND} opens the table`, { to: 'debug' })
171
172    timer?.cancel()
173    timer = $.clock.every(1000, () => {
174      const now = Date.now()
175      const { last, advice, left } = current(policy, now)
176      const key = `${advice.kind}|${advice.text}|${left > 0 ? fmtClock(left) : ''}`
177      if (key !== lastKey) {
178        lastKey = key
179        if (showStatus) $.ui.status(shortLine(policy, now))
180        $.ui.invalidate('ui.render')
181      }
182      if (wantToast && last && left > 0 && promptTokens(last) >= TOAST_MIN_TOKENS) {
183        if (toastedFor !== last.startedAt) {
184          toastedFor = last.startedAt
185          toastLevel = Infinity
186        }
187        // the first toast comes at warnSeconds, then 10, 3, 2 and 1 seconds; a late tick skips to the newest one
188        const secs = Math.ceil(left / 1000)
189        const mark = nextToastMark(secs, policy.warnMs / 1000, toastLevel)
190        if (mark !== undefined) {
191          toastLevel = mark
192          const tail = secs <= COUNTDOWN_MARKS[0] ? 'send a message now' : `send a message to keep ${fmtTokens(promptTokens(last))} tokens warm`
193          $.ui.toast(`cache expires in ${secs >= 60 ? fmtClock(left) : `${secs}s`}: ${tail}`)
194        }
195      }
196    })
197    return r
198  })
199
200  on('session.end', async ($, e, next) => {
201    // /clear starts a new conversation in the same process: its cache is a new one
202    if (e.reason === 'clear') {
203      samples = []
204      lastKey = ''
205      toastedFor = 0
206      observed = undefined
207      ttl = baseTtl
208      ttlSource = envSource
209      $.ui.invalidate('ui.render')
210      return next(e)
211    }
212    timer?.cancel()
213    timer = undefined
214    return next(e)
215  })
216
217  // each main-loop request: what the cache did with it
218  on('turn.step', async function* ($, e, next) {
219    if (e.agentId) return yield* next(e)
220    const startedAt = Date.now()
221    const r = yield* next(e)
222    if (r.usage) {
223      samples.push({
224        turnId: e.turnId,
225        index: e.index,
226        model: r.usage.model || e.model,
227        startedAt,
228        read: r.usage.cache_read_input_tokens,
229        write: r.usage.cache_creation_input_tokens,
230        fresh: r.usage.input_tokens,
231        output: r.usage.output_tokens,
232      })
233      if (samples.length > KEEP) samples = samples.slice(-KEEP)
234      if (!pinned) {
235        // the account can change under a session: a subscription running out of plan usage moves to usage credits
236        account = accountOf((await $.session.usage().catch(() => undefined))?.rateLimits ?? [])
237        const choice = decideTtl(options.ttl, env, setting, account)
238        baseTtl = choice.ttl
239        envSource = choice.source
240        if (observed === undefined) {
241          ttl = baseTtl
242          ttlSource = envSource
243        }
244        const seen = observeTtl(samples[samples.length - 2], samples[samples.length - 1], observed)
245        if (seen !== observed) {
246          observed = seen
247          ttl = seen ?? baseTtl
248          ttlSource = `observed from request timing; ${envSource} said ${baseTtl}`
249          $.ui.log(`prompt-cache-control: cache lifetime is ${ttl} (${ttlSource})`, { to: 'debug' })
250        }
251      }
252      lastKey = ''
253      if (showStatus) $.ui.status(shortLine(policy, Date.now()))
254      $.ui.invalidate('ui.render')
255    }
256    return r
257  })
258
259  on('command.run', { command: COMMAND }, async ($, e) => {
260    if (e.args.trim().toLowerCase() === 'stop') {
261      await $.ui.close({ id: PANE }).catch(() => undefined)
262      isPaneOpen = false
263      return { text: 'cache table closed' }
264    }
265    isPaneOpen = true
266    await $.ui.open({ id: PANE, title: 'cache', focus: true })
267    $.ui.invalidate('ui.render')
268    const { advice } = current(policy, Date.now())
269    return { text: `${ttl} cache (${ttlSource}) · ${advice.text} · /${COMMAND} stop closes` }
270  })
271
272  on('ui.close', async ($, e, next) => {
273    if (e.id !== PANE) return next(e)
274    isPaneOpen = false
275    return next(e)
276  })
277
278  on('ui.press', async ($, e, next) => {
279    if (e.plugin !== $.plugin.name || e.requestId !== PANE) return next(e)
280    if (e.element === 'close') await $.ui.close({ id: PANE }).catch(() => undefined)
281    return next(e)
282  })
283
284  on('ui.render', { component: 'AbovePrompt' }, async ($, e, next) => {
285    if (!showBand || e.props.hasSurvey || isPaneOpen) return next(e)
286    const { last, advice, left } = current(policy, Date.now())
287    if (!last && advice.kind !== 'off') return next(e)
288    const { Box, Text } = $.ui.resolve(e)
289    const columns = e.viewport?.columns ?? 100
290    const color = COLOR[advice.kind]
291    // The band is one instance: whatever the plugins beneath draw (another mod's band) stays, under this line.
292    const below = await next(e)
293    const stack = (own: ReturnType<typeof Text>) => (
294      <Box flexDirection="column">
295        {own}
296        {below}
297      </Box>
298    )
299
300    if (!last) return stack(<Text dimColor>{fit(`cache: ${advice.text}`, columns)}</Text>)
301
302    const ratio = hitRatio(last)
303    const wide = columns >= 90
304    return stack(
305      <Box flexDirection="row" columnGap={1}>
306        <Text bold color={color}>{advice.kind === 'warm' ? '●' : advice.kind === 'soon' ? '▲' : advice.kind === 'off' || advice.kind === 'cold' || advice.kind === 'uncached' ? '○' : '✖'}</Text>
307        <Text bold color="cyan">cache</Text>
308        <Text color={color}>{bar(ratio, wide ? 10 : 6)}</Text>
309        <Text bold>{`${Math.round(ratio * 100)}%`}</Text>
310        {wide ? (
311          <>
312            <Text color="green">{`read ${fmtTokens(last.read)}`}</Text>
313            <Text color="yellow">{`wrote ${fmtTokens(last.write)}`}</Text>
314            <Text color="cyan">{`new ${fmtTokens(last.fresh)}`}</Text>
315          </>
316        ) : (
317          <Text dimColor>{`${fmtTokens(promptTokens(last))} tok`}</Text>
318        )}
319        {advice.kind !== 'uncached' && advice.kind !== 'off' && (
320          <Text bold color={left > 0 ? lifeColor(left, ttl, policy.warnMs) : 'red'}>{left > 0 ? `⏱ ${fmtClock(left)}` : '⏱ 0:00'}</Text>
321        )}
322        <Text dimColor wrap="truncate-end">{`${ttl} · ${advice.text}`}</Text>
323      </Box>,
324    )
325  })
326
327  on('ui.render', { component: 'Pane' }, async ($, e, next) => {
328    if (e.requestId !== PANE) return next(e)
329    const { Box, Text, Button } = $.ui.resolve(e)
330    const width = Math.max(30, e.props.bodyColumns - 1)
331    // HTML collapses runs of spaces and trims a text's ends; a no-break space keeps them
332    const sp = (t: string) => (e.surface === 'terminal' ? t : t.replace(/ /g, ' '))
333    const now = Date.now()
334    const { last, advice, left } = current(policy, now)
335    const all = byTurn(samples)
336    const counting = !!last && advice.kind !== 'uncached' && advice.kind !== 'off'
337    // the countdown goes green, then yellow, then red as the cache runs out
338    const clockColor = counting ? lifeColor(left, ttl, policy.warnMs) : undefined
339    const stateColor = advice.kind === 'expired' || advice.kind === 'miss' ? 'red' : (clockColor ?? COLOR[advice.kind])
340    const hitColor = (pct: number) => (pct >= 80 ? 'green' : pct >= 40 ? 'yellow' : 'red')
341    // solid bars are filled Boxes, not block characters, so HTML draws no seams between cells
342    const solid = (key: string, parts: [number, string | undefined][]) => (
343      <Box key={key} flexDirection="row" height={1} flexShrink={0}>
344        {parts.map(([w, c], i) => (w > 0 ? <Box key={`${key}:${i}`} width={w} height={1} flexShrink={0} backgroundColor={c} /> : null))}
345      </Box>
346    )
347    const cell = (key: string, w: number, text: string, c?: string, bold = false) => (
348      <Box key={key} width={w} flexShrink={0} justifyContent="flex-end">
349        <Text color={c} bold={bold} dimColor={!c}>{sp(text)}</Text>
350      </Box>
351    )
352
353    const barW = Math.min(width, 40)
354    const life = lifeRatio(left, ttl)
355    const lifeFilled = Math.round(life * barW)
356    const [sr, sw, sn] = last ? segments(last.read, last.write, last.fresh, barW) : [0, 0, 0]
357    const rows = all.slice(-Math.max(3, (e.viewport?.rows ?? 24) - 16))
358    const icon = advice.kind === 'warm' ? '●' : advice.kind === 'soon' ? '▲' : advice.kind === 'expired' || advice.kind === 'miss' ? '✖' : '○'
359
360    return (
361      <Box flexDirection="column">
362        <Box key="title" flexDirection="row" columnGap={1}>
363          <Text bold color="cyan">{sp('⚡ PROMPT CACHE')}</Text>
364          <Text dimColor>{sp(`· ${ttl} lifetime (${ttlSource})`)}</Text>
365        </Box>
366
367        <Box key="clock" flexDirection="column" marginTop={1}>
368          <Text bold color={clockColor}>{sp(counting ? `⏱ ${left > 0 ? fmtClock(left) : '0:00'}` : '⏱ --:--')}</Text>
369          {counting ? (
370            <Box flexDirection="row" columnGap={1}>
371              {solid('life', [[lifeFilled, clockColor], [barW - lifeFilled, 'gray']])}
372              <Text dimColor>{sp(`${Math.round(life * 100)}%`)}</Text>
373            </Box>
374          ) : null}
375        </Box>
376
377        <Box key="advice" marginTop={1} flexDirection="column">
378          <Text bold color={stateColor}>{sp(`${icon} ${advice.text}`)}</Text>
379          {last ? <Text dimColor>{sp(fit(`${last.model} · prompt ${fmtTokens(promptTokens(last))} tokens`, width))}</Text> : null}
380        </Box>
381
382        {last ? (
383          <Box key="stack" flexDirection="column" marginTop={1}>
384            <Box flexDirection="row" columnGap={1}>
385              {solid('stack', [[sr, 'green'], [sw, 'yellow'], [sn, 'cyan']])}
386              <Text bold color={hitColor(Math.round(hitRatio(last) * 100))}>{sp(`${Math.round(hitRatio(last) * 100)}% hit`)}</Text>
387            </Box>
388            <Box flexDirection="row" columnGap={2}>
389              <Text color="green">{sp(`■ read ${fmtTokens(last.read)}`)}</Text>
390              <Text color="yellow">{sp(`■ wrote ${fmtTokens(last.write)}`)}</Text>
391              <Text color="cyan">{sp(`■ new ${fmtTokens(last.fresh)}`)}</Text>
392            </Box>
393          </Box>
394        ) : null}
395
396        <Box key="table" flexDirection="column" marginTop={1}>
397          <Box key="head" flexDirection="row" columnGap={1}>
398            {cell('h:turn', 4, 'turn', 'cyan', true)}
399            {cell('h:steps', 5, 'steps', 'cyan', true)}
400            {cell('h:read', 6, 'read', 'green', true)}
401            {cell('h:wrote', 6, 'wrote', 'yellow', true)}
402            {cell('h:new', 5, 'new', 'cyan', true)}
403            {cell('h:hit', 4, 'hit', 'magenta', true)}
404          </Box>
405          {rows.length === 0 ? <Text dimColor>{sp('no requests yet')}</Text> : null}
406          {rows.map((row, i) => {
407            const n = all.length - rows.length + i + 1
408            const pct = Math.round(rowRatio(row) * 100)
409            return (
410              <Box key={`t:${row.turnId}`} flexDirection="row" columnGap={1}>
411                {cell(`c:turn:${row.turnId}`, 4, String(n))}
412                {cell(`c:steps:${row.turnId}`, 5, String(row.steps))}
413                {cell(`c:read:${row.turnId}`, 6, fmtTokens(row.read), 'green')}
414                {cell(`c:wrote:${row.turnId}`, 6, fmtTokens(row.write), 'yellow')}
415                {cell(`c:new:${row.turnId}`, 5, fmtTokens(row.fresh), 'cyan')}
416                {cell(`c:hit:${row.turnId}`, 4, `${pct}%`, hitColor(pct), true)}
417              </Box>
418            )
419          })}
420        </Box>
421
422        <Box key="foot" marginTop={1} flexDirection="column">
423          <Button key="close" label="close" onPress={() => {}} />
424          <Box key="legend" marginTop={1} flexDirection="column">
425            <Text color="green">{sp('■ read: served by the cache')}</Text>
426            <Text color="yellow">{sp('■ wrote: new cache entry')}</Text>
427            <Text color="cyan">{sp('■ new: sent uncached')}</Text>
428          </Box>
429        </Box>
430      </Box>
431    )
432  })
433}
434

1/**
2 * cache.ts — the pure half of prompt-cache-control: no `$`, no engine.
3 *
4 * What it models, from Anthropic's prompt-caching documentation:
5 *   - the cache lives 5 minutes by default, 1 hour when asked for; a read
6 *     refreshes the entry at no extra cost, and the lifetime is measured from
7 *     the START of the request that wrote or read it
8 *   - a request's prompt is `input_tokens` (uncached remainder) +
9 *     `cache_read_input_tokens` + `cache_creation_input_tokens`
10 *   - writes cost 1.25x base input for 5m and 2x for 1h; reads about 0.1x
11 *     (less on some models), so an expired cache on a large context is the
12 *     expensive moment
13 *   - a prefix change (model, effort/thinking settings, tool set, system
14 *     prompt) makes the next request write instead of read
15 *
16 * Claude Code's own switches (read from the environment):
17 *   ENABLE_PROMPT_CACHING_1H=1   ask for the 1-hour TTL
18 *   FORCE_PROMPT_CACHING_5M=1    force the 5-minute TTL, beating the above
19 *   DISABLE_PROMPT_CACHING=1     no caching; DISABLE_PROMPT_CACHING_{HAIKU,SONNET,OPUS}
20 *                                 turn it off for that model family only
21 */
22
23export type Ttl = '5m' | '1h'
24
25export type CacheEnv = {
26  enable1h?: string
27  force5m?: string
28  /** CLAUDE_CODE_PROMPT_CACHE_TTL: "5m" or "1h" for the main conversation */
29  ttlVar?: string
30  disableAll?: string
31  disableHaiku?: string
32  disableSonnet?: string
33  disableOpus?: string
34}
35
36/** One main-loop request, as the API reported it. */
37export type Sample = {
38  turnId: string
39  index: number
40  model: string
41  /** ms since the epoch when the request started: the cache's lifetime is counted from here */
42  startedAt: number
43  read: number
44  write: number
45  fresh: number
46  output: number
47}
48
49export type AdviceKind = 'off' | 'cold' | 'uncached' | 'warm' | 'soon' | 'expired' | 'miss'
50
51export type Advice = {
52  kind: AdviceKind
53  /** one sentence for the band */
54  text: string
55}
56
57export type Policy = {
58  ttl: Ttl
59  warnMs: number
60  compactAtTokens: number
61}
62
63export const isOn = (v: string | undefined) => v === '1' || v?.toLowerCase() === 'true'
64
65/** What the account is billed as, as far as the mod can tell. */
66export type Account = 'subscription' | 'credits' | 'other'
67
68export type TtlChoice = { ttl: Ttl; source: string }
69
70const asTtl = (v: unknown): Ttl | undefined => (v === '5m' || v === '1h' ? v : undefined)
71
72/**
73 * Which lifetime Claude Code asks for on the main conversation, in the order
74 * its documentation gives (https://code.claude.com/docs/en/prompt-caching,
75 * "Choose the TTL yourself"), after the mod's own `ttl` option:
76 *
77 *   FORCE_PROMPT_CACHING_5M, CLAUDE_CODE_PROMPT_CACHE_TTL, the promptCacheTtl
78 *   setting, ENABLE_PROMPT_CACHING_1H, then the default of the account: one
79 *   hour on a Claude subscription within its plan usage, five minutes on usage
80 *   credits, an API key or a cloud provider.
81 */
82export function decideTtl(option: unknown, env: CacheEnv, setting?: unknown, account?: Account): TtlChoice {
83  const pinned = asTtl(option)
84  if (pinned) return { ttl: pinned, source: 'the ttl option' }
85  if (isOn(env.force5m)) return { ttl: '5m', source: 'FORCE_PROMPT_CACHING_5M' }
86  const fromVar = asTtl(env.ttlVar)
87  if (fromVar) return { ttl: fromVar, source: 'CLAUDE_CODE_PROMPT_CACHE_TTL' }
88  const fromSetting = asTtl(setting)
89  if (fromSetting) return { ttl: fromSetting, source: 'the promptCacheTtl setting' }
90  if (isOn(env.enable1h)) return { ttl: '1h', source: 'ENABLE_PROMPT_CACHING_1H' }
91  if (account === 'subscription') return { ttl: '1h', source: 'Claude subscription default' }
92  if (account === 'credits') return { ttl: '5m', source: 'usage credits default' }
93  return { ttl: '5m', source: 'default' }
94}
95
96export const resolveTtl = (option: unknown, env: CacheEnv, setting?: unknown, account?: Account): Ttl =>
97  decideTtl(option, env, setting, account).ttl
98
99/**
100 * The account, from the rate-limit windows the last response reported: a
101 * five-hour or seven-day window means a Claude subscription, and one that is
102 * full means the next requests draw on usage credits. No window (an API key,
103 * a cloud provider, or no response yet) says nothing.
104 */
105export function accountOf(windows: readonly { kind: string; percentUsed: number }[]): Account {
106  const plan = windows.filter(w => w.kind === 'five_hour' || w.kind === 'seven_day')
107  if (plan.length === 0) return 'other'
108  return plan.some(w => w.percentUsed >= 100) ? 'credits' : 'subscription'
109}
110
111export function ttlMs(ttl: Ttl): number {
112  return ttl === '1h' ? 3_600_000 : 300_000
113}
114
115/** Caching switched off for this model by the environment. */
116export function isCachingDisabled(model: string, env: CacheEnv): boolean {
117  if (isOn(env.disableAll)) return true
118  const name = model.toLowerCase()
119  if (name.includes('haiku')) return isOn(env.disableHaiku)
120  if (name.includes('sonnet')) return isOn(env.disableSonnet)
121  if (name.includes('opus')) return isOn(env.disableOpus)
122  return false
123}
124
125export const promptTokens = (s: Sample) => s.read + s.write + s.fresh
126
127/** Share of the prompt the cache served, 0 to 1; 0 for an empty prompt. */
128export function hitRatio(s: Sample): number {
129  const total = promptTokens(s)
130  return total === 0 ? 0 : s.read / total
131}
132
133/** When the cache entry the sample touched lapses, ms since the epoch. */
134export const expiresAt = (s: Sample, ttl: Ttl) => s.startedAt + ttlMs(ttl)
135
136/** Zero for a request that read and wrote nothing: it created or refreshed no entry, so there is nothing to count down. */
137export function remainingMs(s: Sample, ttl: Ttl, now: number): number {
138  if (s.read + s.write === 0) return 0
139  return Math.max(0, expiresAt(s, ttl) - now)
140}
141
142/**
143 * Why a request that should have read the cache wrote it instead; undefined
144 * when it did not miss. A prompt that shrank is a /compact or /clear, not a
145 * miss, and the first request of a session has nothing to read.
146 */
147export function missReason(prev: Sample | undefined, cur: Sample, ttl: Ttl): string | undefined {
148  if (!prev) return undefined
149  const before = promptTokens(prev)
150  if (before === 0 || promptTokens(cur) < before * 0.7) return undefined
151  if (cur.read >= before * 0.5 || cur.write === 0) return undefined
152  if (cur.model !== prev.model) return `model changed (${prev.model} to ${cur.model})`
153  if (cur.startedAt - prev.startedAt > ttlMs(ttl)) return `the ${ttl} cache had lapsed`
154  return 'the prompt prefix changed (effort, tools, system prompt or CLAUDE.md)'
155}
156
157export function advise(last: Sample | undefined, prev: Sample | undefined, policy: Policy, now: number, disabled: boolean): Advice {
158  if (disabled) return { kind: 'off', text: 'prompt caching is off for this model (DISABLE_PROMPT_CACHING*)' }
159  if (!last) return { kind: 'cold', text: 'no request yet: the first one writes the cache' }
160  if (last.read + last.write === 0) {
161    return { kind: 'uncached', text: 'this request was not cached (prompt under the model minimum, or caching off)' }
162  }
163  const miss = missReason(prev, last, policy.ttl)
164  const left = remainingMs(last, policy.ttl, now)
165  const size = promptTokens(last)
166  if (left <= 0) {
167    const big = size >= policy.compactAtTokens
168    return {
169      kind: 'expired',
170      text: big
171        ? `expired: the next message rewrites ${fmtTokens(size)} tokens. /compact first, or /clear if the task is done`
172        : `expired: only ${fmtTokens(size)} tokens to rebuild, just keep going`,
173    }
174  }
175  if (left <= policy.warnMs) {
176    return { kind: 'soon', text: 'expires soon: any message refreshes it for free' }
177  }
178  if (miss) return { kind: 'miss', text: `cache missed: ${miss}` }
179  return { kind: 'warm', text: 'warm: keep going' }
180}
181
182export function fmtTokens(n: number): string {
183  if (n < 1000) return String(n)
184  if (n < 100_000) return `${(n / 1000).toFixed(1).replace(/\.0$/, '')}k`
185  if (n < 1_000_000) return `${Math.round(n / 1000)}k`
186  return `${(n / 1_000_000).toFixed(1).replace(/\.0$/, '')}M`
187}
188
189/** m:ss, or h:mm:ss from an hour up. */
190export function fmtClock(ms: number): string {
191  const total = Math.max(0, Math.ceil(ms / 1000))
192  const h = Math.floor(total / 3600)
193  const m = Math.floor((total % 3600) / 60)
194  const s = total % 60
195  const pad = (n: number) => String(n).padStart(2, '0')
196  return h > 0 ? `${h}:${pad(m)}:${pad(s)}` : `${m}:${pad(s)}`
197}
198
199export function bar(ratio: number, width: number): string {
200  const filled = Math.round(Math.min(1, Math.max(0, ratio)) * width)
201  return '█'.repeat(filled) + '░'.repeat(width - filled)
202}
203
204export type TurnRow = {
205  turnId: string
206  steps: number
207  read: number
208  write: number
209  fresh: number
210  output: number
211}
212
213/** Samples grouped by turn, oldest first, each turn's requests summed. */
214export function byTurn(samples: readonly Sample[]): TurnRow[] {
215  const rows: TurnRow[] = []
216  for (const s of samples) {
217    let row = rows[rows.length - 1]
218    if (!row || row.turnId !== s.turnId) {
219      row = { turnId: s.turnId, steps: 0, read: 0, write: 0, fresh: 0, output: 0 }
220      rows.push(row)
221    }
222    row.steps += 1
223    row.read += s.read
224    row.write += s.write
225    row.fresh += s.fresh
226    row.output += s.output
227  }
228  return rows
229}
230
231export const rowRatio = (r: TurnRow) => {
232  const total = r.read + r.write + r.fresh
233  return total === 0 ? 0 : r.read / total
234}
235
236export function fit(text: string, width: number): string {
237  return text.length <= width ? text : `${text.slice(0, Math.max(0, width - 1))}…`
238}
239
240export function positive(v: unknown, fallback: number): number {
241  return typeof v === 'number' && Number.isFinite(v) && v > 0 ? v : fallback
242}
243
244/** Share of the cache lifetime left, 0 to 1. */
245export function lifeRatio(leftMs: number, ttl: Ttl): number {
246  return Math.min(1, Math.max(0, leftMs / ttlMs(ttl)))
247}
248
249/**
250 * Widths of the three stacked-bar segments (read, wrote, new) over `width`
251 * cells: proportional, each non-empty part at least one cell, summing to width.
252 */
253export function segments(read: number, write: number, fresh: number, width: number): [number, number, number] {
254  const total = read + write + fresh
255  if (total === 0 || width <= 0) return [0, 0, 0]
256  const parts = [read, write, fresh]
257  const cells = parts.map(p => (p > 0 ? Math.max(1, Math.round((p / total) * width)) : 0))
258  let over = cells.reduce((a, b) => a + b, 0) - width
259  while (over !== 0) {
260    const i = over > 0 ? cells.indexOf(Math.max(...cells)) : parts.indexOf(Math.max(...parts))
261    cells[i] += over > 0 ? -1 : 1
262    over += over > 0 ? -1 : 1
263  }
264  return [cells[0], cells[1], cells[2]]
265}
266
267/** Seconds left at which a toast counts down after the one at the warning threshold. */
268export const COUNTDOWN_MARKS = [10, 3, 2, 1]
269
270/**
271 * The toast mark to fire now, or undefined. `level` is the mark last fired for
272 * this cache entry (Infinity before any); a late tick skips straight to the
273 * newest mark crossed, so a stalled clock never replays old ones.
274 */
275export function nextToastMark(secsLeft: number, warnSecs: number, level: number): number | undefined {
276  const marks = [warnSecs, ...COUNTDOWN_MARKS].filter(m => m <= warnSecs)
277  const due = marks.filter(m => secsLeft <= m && m < level)
278  return due.length ? Math.min(...due) : undefined
279}
280
281export type LifeColor = 'green' | 'yellow' | 'red'
282
283/** Countdown colour: green while there is plenty, yellow below 40% of the lifetime, red from the warning threshold down. */
284export function lifeColor(leftMs: number, ttl: Ttl, warnMs: number): LifeColor {
285  if (leftMs <= warnMs) return 'red'
286  return leftMs / ttlMs(ttl) <= 0.4 ? 'yellow' : 'green'
287}
288
289// requests are timed from their start, so a little slack keeps a hit that
290// landed just inside the lifetime from reading as proof of the longer one
291const SLACK_MS = 10_000
292
293/**
294 * What the traffic says about the cache lifetime, given the request before and
295 * `known`, what earlier requests already showed.
296 *
297 *   - a hit (the cache served at least half of the previous prompt) more than
298 *     5 minutes after the previous request began proves the 1-hour lifetime,
299 *     and nothing later undoes it: a miss afterwards is more likely a changed
300 *     prefix than a lapse
301 *   - a miss with the same model and a prompt that did not shrink, 5 minutes to
302 *     an hour after the previous request, says the entry lapsed: 5 minutes
303 *     (weaker: a changed prefix looks the same, so a later hit overrules it)
304 *
305 * Needed because the API names the TTL of a write (`cache_creation.ephemeral_*`)
306 * but Claude Code's mod API passes on only the four token counts.
307 */
308export function observeTtl(prev: Sample | undefined, cur: Sample, known: Ttl | undefined): Ttl | undefined {
309  if (!prev || prev.read + prev.write === 0 || cur.model !== prev.model) return known
310  const gap = cur.startedAt - prev.startedAt
311  const before = promptTokens(prev)
312  if (gap <= ttlMs('5m') + SLACK_MS) return known
313  if (cur.read >= before * 0.5) return '1h'
314  if (known === '1h') return known
315  const lapsed = cur.write > 0 && promptTokens(cur) >= before * 0.7 && gap < ttlMs('1h') + SLACK_MS
316  return lapsed ? '5m' : known
317}
318