prisma-risk / tsoracle / 26258586546
95%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 49
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 96.202%. Remained the same
26258586546

push

github

web-flow 
docs(client): deep-dive on coalescing, freshness, auto-batching (#65)

* docs(client): deep-dive on coalescing, freshness, auto-batching

Adds docs/the-client-driver.md, a client-side companion to
docs/the-allocator.md. The freshness invariant was previously stated as
a one-paragraph contract; this chapter argues the why: the three notions
of monotonicity (value, per-session, external), how pre-fetched batches
break external monotonicity by construction, the four options for
reconciling batching with external monotonicity (no-prefetch as in
tsoracle, commit-wait as in Spanner, HLC, or accepting value-only), the
single-in-flight-RPC auto-batching that makes batch size emerge from
caller concurrency without tuning, and what the flush_interval knob
actually does (cold-start coalescing only — it does not set
steady-state batch size).

Also wires it in and corrects an existing doc:
- docs/README.md gains the new chapter in the index.
- docs/getting-started.md#the-freshness-invariant links into the new
  doc from its contract paragraph.
- docs/client-api-and-usage.md corrects the flush_interval description,
  which previously suggested raising the value to amortize RPC cost.
  Under tsoracle's design, low steady-state batch size is a caller-
  concurrency problem, not a flushing problem.

Docs-only. No code changes.

* docs(client): fix mermaid parse error from semicolons in note text

6257 of 6504 relevant lines covered (96.2%)

87008.68 hits per line

Jobs
ID Job ID Ran Files Coverage
1 26258586546.1 49
96.2
 GitHub Action Run
Source Files on build 26258586546