mirror of
https://github.com/deepseek-ai/deepseek-harness
synced 2026-08-15 21:04:50 +00:00
cd9737d569
New doc-sync gate verify-export-jsdoc walks every module-level exported name under packages/*/*/src and requires description prose everywhere, plus @param per parameter and @returns on non-void annotated returns for function-like exports, public class methods, properties, and accessors. The parsing + check helpers move out of gen-cordis-catalog.ts into a shared scripts/jsdoc.ts so 'documented' means one thing on both gated surfaces. Deliberate exemptions (documented in the RFC): heritage-declared class members (the seam declaration is the doc's one home — the one checker query in an otherwise pure-AST walk), cordis plugin-protocol slots (name/inject/reusable/Config/apply, top-level and static), constructors, overload implementations, declare-module augmentation bodies, and re-export statements (checked at the defining module). The 203 under-documented exports the gate found at adoption are filled in this change, so the gate lands green; generated catalogs/graphs are regenerated for the shifted line pointers. RFC: docs/rfc/implemented/process/2026-07-06-export-surface-jsdoc-gate.md
72 lines
3.3 KiB
TypeScript
72 lines
3.3 KiB
TypeScript
/**
|
|
* Per-loop-instance transmission bookkeeping for the reconstructability
|
|
* contract: which header event to append before a request so the session log
|
|
* always explains the request (the reconstructability RFC). The loop is
|
|
* otherwise transmission-stateless — the comparison baseline is the log's own
|
|
* folded header (`Session.requestHeader()`), so resume and fork need no
|
|
* special path: a fresh loop instance simply logs a `'resume'` snapshot on
|
|
* its first request and deltas from there.
|
|
*
|
|
* @module dsh-agent-loop/request-log
|
|
*/
|
|
|
|
import { diffHeader, headerEquals, applyHeaderDelta } from '@deepseek-ai/dsh-session'
|
|
import type { EpochHeader, Session } from '@deepseek-ai/dsh-session'
|
|
|
|
/** Per-loop-instance bookkeeping: whether THIS instance has logged a header yet. */
|
|
export interface TransmissionLog {
|
|
/** True once this loop instance appended its anchoring `request/header` snapshot. */
|
|
loggedHeader: boolean
|
|
}
|
|
|
|
/**
|
|
* Fresh bookkeeping for a newly-started loop instance.
|
|
* @returns state with `loggedHeader` false, so the instance's first request appends an anchoring snapshot.
|
|
*/
|
|
export function createTransmissionLog(): TransmissionLog {
|
|
return { loggedHeader: false }
|
|
}
|
|
|
|
/**
|
|
* Append whatever header event this request owes the log, so folding the log
|
|
* reproduces the header the request was built under. Exactly one of four
|
|
* things happens:
|
|
*
|
|
* 1. This loop instance has not logged a header yet → a full `request/header`
|
|
* snapshot anchors the fold: reason `'initial'` when the log has no header
|
|
* events at all (a new conversation), `'resume'` when it does (process
|
|
* restart, fork seed — the boundary itself is a recorded fact, so the
|
|
* snapshot is appended even when nothing changed).
|
|
* 2. The header equals the folded baseline → nothing; the log already
|
|
* explains this request.
|
|
* 3. It differs and the delta round-trips (`applyHeaderDelta` on the baseline
|
|
* reproduces the header exactly) → a `request/header-delta`.
|
|
* 4. It differs and the delta encoding cannot express the change (a pure tool
|
|
* reordering) → a full snapshot with reason `'fallback'`; deltas are an
|
|
* encoding optimization, never a correctness dependency.
|
|
*
|
|
* @param session - the session whose log explains the request.
|
|
* @param state - this loop instance's bookkeeping (mutated on first log).
|
|
* @param header - the canonical header the request will ACTUALLY use
|
|
* (post-`agent/request`).
|
|
*/
|
|
export function recordRequestHeader(session: Session, state: TransmissionLog, header: EpochHeader): void {
|
|
if (!state.loggedHeader) {
|
|
session.append('request/header', { header, reason: session.requestHeader() === undefined ? 'initial' : 'resume' })
|
|
state.loggedHeader = true
|
|
return
|
|
}
|
|
// This instance logged a snapshot, so the fold is necessarily defined.
|
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
const baseline = session.requestHeader()!
|
|
if (headerEquals(baseline, header)) return
|
|
const delta = diffHeader(baseline, header)
|
|
/* v8 ignore next -- headerEquals false ⟹ diffHeader defined: both compare the same three parts */
|
|
if (delta === undefined) return
|
|
if (headerEquals(applyHeaderDelta(baseline, delta), header)) {
|
|
session.append('request/header-delta', delta)
|
|
} else {
|
|
session.append('request/header', { header, reason: 'fallback' })
|
|
}
|
|
}
|