Shared storage allowance contract for Gateway, Runner and Runtime (Desk #685)

Open
#287 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
8/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Domain
documentation

Research direction

This is a design-agreement issue, not a code change, and it names no files or tests. Read the linked requests Gateway #364, Runner #204 and Runtime #347, and the maintainer decision in the body, before proposing anything. Done means a written design that covers each listed item (allowance, refusal, headroom, accounting, finite-growth commands, descendants) and a decision on whether it becomes normative text or a companion note.

Written by the indexing model from the issue text.

Description

Desk #685 needs Gateway, Runner and Runtime to bound their writes on the ordinary desktop deployment. The requests are Gateway #364, Runner #204 and Runtime #347. All three should share one contract shape, so this issue holds a short design to agree before any of them is built.

Decision (maintainer). Bounded contracts, with no provisioned enforcement helper and no reservation protocol across processes.

To define:

  • Allowance: the host gives each component a finite allowance for its own root, in logical bytes and file count. Define how it is configured and how a host discovers that a component supports it.
  • Refusal: one typed error, returned before the allowance is exceeded and before any external effect. A persistence failure must never replay a completed effect.
  • Headroom: the part of the allowance held back so admitted operations can settle and recovery can run.
  • Accounting: what is counted, including staged and temporary files and SQLite WAL; the recount at startup; and what happens after a crash or cancellation.
  • Finite-growth commands: how a command documents and proves no growth or finite growth instead of taking an allowance.
  • Descendants: how a component states which child writes an allowance does not cover. An arbitrary child process writing to its own workspace is not bounded by this design, so such a route needs its own proven limit or an explicit statement that it is uncovered.

Out of scope: filesystem confinement, global scheduling, and changes to receipt immutability or credential custody.

Order. This design, then Runtime #347, Gateway #364 and Runner #204. Work starts after the current agent v0.13.0, gateway v0.24.0 and spec v0.4.0 releases. Desk v0.14.0 does not wait for it: Desk covers its own storage there and carries the child routes in a later release.

Whether this design becomes normative text or a companion note is part of this issue.

Dominant language
Python
Stars
5
Forks
6
Avg merge
6h 15m
Merged PRs (30d)
98

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Judgment-Pack/judgment-pack-spec

All issues in Judgment-Pack/judgment-pack-spec

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.