plugin-runtime-debug git:20260902.7d33bf4A

Immutable. This exact content is served forever at /api/v1/blob/d600eca398667268.

---
name: plugin-runtime-debug
description: Use when an installed DSH Web plugin misbehaves only at runtime in the browser — paste/attachment/composer features that work once then fail, chips or panels showing stale placeholder state, update chips claiming the wrong version — and the fix must be diagnosed against the exact host API semantics rather than guessed from names. Also use when reviewing a plugin's calls into input-machine or facade verbs (insert, consume, remove, subscribe) before a release.
---

# Debug DSH Web Plugin Runtime Behavior

External Web plugins call host client APIs whose contracts live in the DSH
source tree, not in the plugin's own types. When behavior diverges from
intent at runtime, the failure is almost always a misread contract — and the
diagnosis must come from the host source, never from the API's name.

## The standing rule: read the verb's contract in the host source first

Before changing any call into a host API, open the implementing package in
the DSH source checkout (`~/.dsh/source/current`, or the vendored copy) and
read the actual method — its doc comment, its guards, and the types it
compares against. Repeat for every value the plugin passes. Three questions
cover most incidents:

1. **Which text does an offset count into?** When a verb takes a span or an
   offset, find out what string those numbers index. Published snapshot
   fields and internal editor projections are not always the same string; a
   plugin that feeds one representation's offsets into a verb whose guard
   compares against another representation fails silently — the call returns
   `false` or no-ops, nothing throws.
2. **What does one "unit" weigh in each representation?** If the document
   contains opaque inline units (chips, tokens, attachments), check whether a
   unit occupies the same width in the published field as in the projection
   the verb guards. When widths differ, offsets are only correct while no
   unit exists — verify what the first call succeeding and every later call
   failing tells you.
3. **When the verb declines, who notices?** A boolean-returning verb that
   fails silently turns into a downstream state bug: the caller deletes its
   own bookkeeping anyway, and the UI renders a "missing/unavailable"
   placeholder next to an object that never went away. Audit every call site
   for the "fire, ignore the result, clean up state anyway" shape.

## Symptom families and where they point

- **First interaction works, every subsequent one errors** — state written by
  the earlier call changed the mapping between what the plugin computes and
  what the verb expects. Compare the two representations before and after
  one insertion; derive the correction from the unit widths in the host
  source, then apply the same derivation at *every* call site that passes
  offsets, not just the crashing one.
- **A removal button leaves the row behind with a placeholder label** — the
  removal verb declined (see question 3) while bookkeeping was already
  dropped. Confirm with the verb's return value, and only retire the
  bookkeeping after the removal actually applied.
- **Derived UI shows stale or phantom entries** — find the authoritative
  source of the fact and derive the view from it. A plugin-side cache with a
  subscription that retires entries on any transient snapshot (an empty
  moment during reconcile/remount) will drop live entries; prefer reading the
  live published state at decision time and treat the cache as an accelerator
  only.
- **Update/version chips report a wrong "latest"** — remote tag and raw-file
  endpoints are CDN-cached and lag minutes behind a real push. Never present
  a fetched remote value as ground truth when it can be older than the
  running build; decide "current vs update" against the running version and
  display the newer of the two.

## Workflow

1. Reproduce once and capture the exact user-visible strings (toast text,
   chip labels, console output) — they are the contract of the bug report.
2. Map each string to the code path that emitted it; identify the host verb
   at the boundary.
3. Open the host source for that verb; answer the three standing questions.
4. State the mismatch precisely (which representation, which guard, which
   call sites) before writing any fix; if you cannot state it, you have not
   read enough source.
5. Fix every call site that passes representation-dependent values, not only
   the reported symptom; the same mismatch usually breaks two features
   through two different verbs.
6. Prove the fix with the interaction sequence that failed: repeat the
   action twice in a row and assert both attempts behave identically, and
   assert the removal path clears every view of the object.
7. For lib-only plugin bundles (no build step): keep hand-inlined version
   constants in sync with `package.json`, syntax-check the bundle
   (`node --check`), and verify in the browser after a hard refresh — the
   served artifact is the file you edited.