DSH familySearch GitHub

hook / EffectTS

ets-hook-dsh-workspace-journal

Keeps undo, checkpoints, and crash recovery

0.2.1 hook EffectTS

Facts

Package
@playform/ets-hook-dsh-workspace-journal
Version
0.2.1
Kind
hook
Release
EffectTS
Licence
CC0-1.0
Directory
EffectTS/packages/ets-hook-dsh-workspace-journal

What it does

Keeps undo, checkpoints, and crash recovery.

Read the full description in the README.

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.

session 7c41e0a2 | deepseek-v4.1-flash | max | 3 turns | 9 steps | 40 records | simulated

*emit~waterfall=serial>parallel

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.

Turn 1Read the specimens14 records | 3 steps

Step 12 calls, 265 chars

Step 24 calls, 313 chars

Step 33 calls, 153 chars

Turn 2Write the run13 records | 3 steps

Step 43 calls, 174 chars

Step 52 calls, 258 chars

Step 62 calls, 115 chars

Turn 3Repair the run13 records | 3 steps

Step 72 calls, 143 chars

Step 83 calls, 184 chars

Step 92 calls, 123 chars

The turn

The same 3 calls on every plugin page, so a reader who moves between plugins stays in the same frame.

The 3 calls every plugin page shares, in sequence order
SeqCallOutcome
20bash ls -laok
21write src/index.tsok
22read src/index.tsok

Change

The one line that differs with this package installed, transcribed from its source by the dissection.

  1. Model the file holds the batch's bytes
  2. 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.

  1. 01
    open(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.

  2. 02
    fail Storage is down, so open throws
    why

    There is no journal, so there are no writes: the transaction never starts.

  3. 03
    1. seam fs/observed
    why

    The listener counts the writes landing against the batches still applying.

  4. 04
    Bump 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.

  5. 05
    seal(batchId, verified | recovery-required)
    why

    The batch leaves applying only through this call.

  6. 06
    revert(batchId): replay the pre-images backward, one file at a time
    why

    Last written, first restored, and every write goes through the version fence.

  7. 07
    branch 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.

  8. 08
    fail 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.

  9. 09
    branch The fence contradicts the file version, or a pre-image was recorded truncated
    why

    One file's failure never aborts the pass.

  10. 10
    fail Reported per file: a conflict, or a skip with its reason
    why

    Never a silent overwrite, and never a half-applied pre-image.

  11. 11
    Boot 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.

  12. 12
    store ~/.dsh/playform/ets-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.

The surfaces ets-hook-dsh-workspace-journal registers
KindNameWhat
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.

Install sh
pnpm add @playform/ets-hook-dsh-workspace-journal

Configuration

Every knob this plugin documents, with its default.

Configuration of ets-hook-dsh-workspace-journal
FieldTypeDefaultMeaning
enabledfalseMaster switch (the IDLE-forever posture)
logtrueLedger enabled
logFile~/.dsh/playform/ets-hook-dsh-workspace-journal.logThe plugin's own ledger
domainworkspace_journalThe KV domain name
maxBatches200The batch ring bound
maxEntryBytes65536The pre-image size cap
exclude["node_modules/**", "**/Target/**", "**/.git/**"]Excluded paths
policy.*see belowThe 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.

The family's answers at fs/observed, in the order the behavior map lists them
AnswerEffectPosition
hook-dsh-cargo-governorrewriteneighbour
hook-dsh-package-governorrewriteneighbour
hook-dsh-package-pinnerrewriteneighbour
hook-dsh-workspace-approverecordneighbour
hook-dsh-workspace-auditrecordneighbour
hook-dsh-workspace-journalrecordits twin
hook-dsh-workspace-mergerewriteneighbour
hook-dsh-workspace-monitorrecordneighbour
hook-dsh-workspace-observerecordneighbour

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 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.

Dependencies of ets-hook-dsh-workspace-journal
PackageRole
@playform/ets-base-dshfamily
@playform/ets-plugin-dsh-factoryfamily

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.

Open the package source

Origin

The files this page was built from, and what each one supplies.

The files this page was read from 5
The files behind https://github.com/PlayForm/DeepSeek/tree/Current/EffectTS/packages/ets-hook-dsh-workspace-journal
FileContributedState
package.jsonThe name, the version, the private flag, and the dependencies.read
README.mdThe summary, the surface table, and the configuration table.read
CHANGELOG.mdThe release lines and their versions.read
cordis.patch.ymlActivation: the bundle entry that mounts the plugin.read
Source/Function/Apply.tsThe 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.