Add the session view to the trace page. Read the specimens first, then build the lane strip, the tree, the document, and the inspector from one authored run. The family's plugins must be visible on the records they touch, and the page must read the same run with the family off.
hook / Classic
hook-dsh-workspace-journal
Keeps undo, checkpoints, and crash recovery
Facts
- Package
- @playform/hook-dsh-workspace-journal
- Version
- 0.2.1
- Kind
- hook
- Release
- Classic
- Licence
- CC0-1.0
- Directory
- Classic/packages/hook-dsh-workspace-journal
What it does
Keeps undo, checkpoints, and crash recovery.
Conversation
The turn as a document: the calls every plugin page shares, what this package changes in them, and the order its work happens in.
Conversational
Lane
The same run as time: one row per resource, a bar per span, and the clock every record shares. A wait is drawn as an outline, because nothing is busy.
Session
The tree, the document, and the inspector read one record list. The switch at the top of the document changes the face they read, and the run changes with it.
The turn
The same 3 calls on every plugin page, so a reader who moves between plugins stays in the same frame.
| Seq | Call | Outcome |
|---|---|---|
20 | bash ls -la | ok |
21 | write src/index.ts | ok |
22 | read src/index.ts | ok |
Change
The one line that differs with this package installed, transcribed from its source by the dissection.
- Model the file holds the batch's bytes
- Transcript journal: reverted b1 /a (fence ok)
34 character changed, from 32 to 34.
- Property
- A write journal
- Knob
- maxBatches, 200 by default
- Seam
- fs/observed
Flow
The order this package's work happens in, with the branch that decides it inline, transcribed from the source; the rule it obeys is the last band of Architecture.
- 01open(batch, entries): journal the batch before its writes land
why
Each entry is a file's pre-image, its content and its version captured before the write.
- 02fail Storage is down, so open throws
why
There is no journal, so there are no writes: the transaction never starts.
- 03
- seam fs/observed
why
The listener counts the writes landing against the batches still applying.
- 04Bump the batch's progress, and persist the record
why
The progress is how far a crash got, written as it happens rather than guessed later.
- 05seal(batchId, verified | recovery-required)
why
The batch leaves applying only through this call.
- 06revert(batchId): replay the pre-images backward, one file at a time
why
Last written, first restored, and every write goes through the version fence.
- 07branch The policy block's write verdict is approve
why
The revert is the journal's one gated action, because it writes the pre-images back.
- 08fail revert held (<n> files): zero writes, and the batch keeps its state
why
Nothing is persisted, so the revert waits for the user rather than half-applying.
- 09branch The fence contradicts the file version, or a pre-image was recorded truncated
why
One file's failure never aborts the pass.
- 10fail Reported per file: a conflict, or a skip with its reason
why
Never a silent overwrite, and never a half-applied pre-image.
- 11Boot recovery: every batch still applying is marked recovery-required
why
The pass runs as a microtask at mount, after the storage open had its first tick.
- 12store ~/.dsh/playform/hook-dsh-workspace-journal.log
why
One line per open, seal, revert, and recovery.
Harness
The laws the package states, the line it writes when it loads, the seam the harness dispatches with none of the family, and the surface and knobs a run can set.
Default
What the harness does at this package's seam with none of the family installed, so the surface below has something to be a difference from.
The harness dispatches fs/observed as a emit and already has listeners there: fs-observation-policy, skill-filesystem, workspace-files.
An emit listener observes a fact that already happened, so the harness's own listeners can record it and cannot change it. This package records beside them, or acts on the world rather than on the payload.
Surface
Every listener, tool, service, and knob the README documents.
| Kind | Name | What |
|---|---|---|
| open(batch, entries) | Journal the batch before its writes land (throws if storage is down) | |
| seal(batchId, next, reason?) | Close the batch: verified or recovery-required | |
| revert(batchId) | Replay backward; per-file report | |
| recover() | The boot pass over still-applying batches | |
| batch(id) / batches() / entries(id) | Reads | |
| statistics() | { batches, entries, applying } |
Install
The package as the profile adds it.
pnpm add @playform/hook-dsh-workspace-journalConfiguration
Every knob this plugin documents, with its default.
| Field | Type | Default | Meaning |
|---|---|---|---|
| enabled | false | Master switch (the IDLE-forever posture) | |
| log | true | Ledger enabled | |
| logFile | ~/.dsh/playform/hook-dsh-workspace-journal.log | The plugin's own ledger | |
| domain | workspace_journal | The KV domain name | |
| maxBatches | 200 | The batch ring bound | |
| maxEntryBytes | 65536 | The pre-image size cap | |
| exclude | ["node_modules/**", "**/Target/**", "**/.git/**"] | Excluded paths | |
| policy.* | see below | The D6 per-action allowlist (the revert gate) |
Family
The neighbours at the same seam, the arms beyond it, the twin in the other release tree, and the packages this one needs.
Neighbours
The behavior map lists 9 answers at fs/observed, in the order the family registers them.
| Answer | Effect | Position |
|---|---|---|
| hook-dsh-cargo-governor | rewrite | neighbour |
| hook-dsh-package-governor | rewrite | neighbour |
| hook-dsh-package-pinner | rewrite | neighbour |
| hook-dsh-workspace-approve | record | neighbour |
| hook-dsh-workspace-audit | record | neighbour |
| hook-dsh-workspace-journal | record | this package |
| hook-dsh-workspace-merge | rewrite | neighbour |
| hook-dsh-workspace-monitor | record | neighbour |
| hook-dsh-workspace-observe | record | neighbour |
Arms
The seams its source also registers, beyond the one its README documents.
Its source registers no seam beyond the one its README documents.
Twin
The same package in the other release tree, when one exists.
Its twin is ets-hook-dsh-workspace-journal.
It registers the same listeners in the same order and composes the same ledger strings; the ledger file's name, which carries the package identity, and the factory base import are the only differences.
Dependencies
The packages this one imports, and whether each one is the family's own.
| Package | Role |
|---|---|
| family | |
| family |
Person
What the person waits for, reads, and never sees.
The person sees the effect and not the record: the line that testifies to what happened sits in a file, and the page prints the line rather than a screen that shows it.
Architecture
This plugin's own structure: the shape the portrait gives it, the facts its source documents, and the rule its flow obeys.
Shape
Plugs into the workspaceJournal service, the fs/observed checkpoint listener, and the boot recovery pass.
The evidence record: the pre-images, the revert, and what a crash left applying.
- Journals a batch before its writes land, with each file's pre-image and version
- Replays a revert backward through the version fence, and reports a conflict rather than overwriting
- Counts the writes landing against open batches, so a crash's progress is known
- Marks every batch still applying at boot as recovery-required
- Its flow is the interesting part: the batch lifecycle is what the four calls describe
Its shape machine belongs to Person.
Record
The release line, the source, and the files this page was read from.
Release
The versions the package's own changelog records, newest first.
- 0.3.0
- 0.2.1
- 0.2.0
- 0.1.0
Source
The package as the repository holds it.
Origin
The files this page was built from, and what each one supplies.
The files this page was read from 5
| File | Contributed | State |
|---|---|---|
| package.json | The name, the version, the private flag, and the dependencies. | read |
| README.md | The summary, the surface table, and the configuration table. | read |
| CHANGELOG.md | The release lines and their versions. | read |
| cordis.patch.yml | Activation: the bundle entry that mounts the plugin. | read |
| Source/Function/Apply.ts | The listeners, their registration order, and the service the flow calls. | read |
- Data
- The monorepo, read during the build
- Connection
- Build-time read; nothing is fetched at runtime
- Capture
- package.json, README.md, CHANGELOG.md, Source/Function/Apply.ts
Expand provenance source
This page is static. It cannot invoke the plugin, read a ledger, or change a configuration. Every figure comes from those files; a missing README falls back to the manifest's own description, and a package with no surface table shows no surface section.