dsh-graft-plugin 0.1.2 → 0.2.1

package/README.md

@@ -9,7 +9,7 @@ It does four things:
 - **A chip in the composer** naming the graft index the current session is actually serving, whether it still matches the code, and how many tokens graft has saved in that repo.
 - **Five tools for the model** — `graft_ask`, `graft_grep`, `graft_callers`, `graft_skeleton`, `graft_map` — resolved per session, so one dsh can serve several workspaces at once.
 - **`/graft`** to build or rebuild the index, and **auto-rebuild** after the model edits files.
-- **A `graft viz` button** that opens the graph as a tab in [dsh-better-sidebar](https://github.com/omdsh-dev/DSH-better-sidebar).
+- **A `graft viz` button** that opens the graph in dsh's built-in right sidebar (0.1.5+), in [dsh-better-sidebar](https://github.com/omdsh-dev/DSH-better-sidebar) if you still run it, and in a browser tab as the last resort.
 
 ## Install
 
@@ -50,15 +50,17 @@ graft build
 
 ### The sidebar tab
 
-The `graft viz` button needs `dsh-better-sidebar` **mounted**. It ships as a dependency of this plugin (0.18.x), so it is already downloaded — but dsh only mounts what the profile lists:
+On dsh `0.1.5` and later the button opens the graph in **dsh's own right sidebar** — a tab titled Graft, also listed on the sidebar's guide page as "The graft graph for this workspace" — and a second click focuses the tab that is already open. No install needed for that path: the registration is soft, so an older dsh without the right sidebar falls through to `dsh-better-sidebar` when it is mounted, and to a browser tab when neither is there.
+
+If your profile still runs `dsh-better-sidebar`, that path is tried **first** and behaves exactly as before. It ships as a dependency of this plugin (0.18.x), so it is already downloaded — but dsh only mounts what the profile lists:
 
 ```sh
 dsh plugin --profile web add dsh-better-sidebar
 ```
 
-> **Compatibility.** `dsh-better-sidebar` 0.18.x requires `@deepseek-ai/dsh-client-ui-primitives`, which dsh removed in `0.1.5-rc.2`. On that version or later the tab will not mount and the button reports the sidebar as unavailable. Everything else in this plugin — chip, tools, `/graft`, auto-rebuild — is unaffected.
+> **Compatibility.** `dsh-better-sidebar` 0.18.x requires `@deepseek-ai/dsh-client-ui-primitives`, which dsh removed in `0.1.5-rc.2`. On that version or later it will not mount — which is exactly the profiles where the built-in right sidebar takes over instead. Everything else in this plugin — chip, tools, `/graft`, auto-rebuild — is unaffected.
 
-Skip it if you do not want the tab. The chip, the tools, `/graft` and the auto-rebuild all work without it; the button just reports that the sidebar is unavailable.
+The chip, the tools, `/graft` and the auto-rebuild all work without any sidebar; the button simply falls back to a browser tab when neither one is present.
 
 > This plugin does **not** insert a `dsh-better-sidebar` row itself, on purpose. That package's own bundle row carries a guard that disables it when another enabled row already mounts the same package. A second row with a different id makes that guard circular, and the losing outcome is *your existing sidebar silently disabling itself*. One explicit command is worth more than that risk.
 
@@ -82,7 +84,7 @@ The root is resolved from **the session's own workspace**, not from wherever dsh
 
 ### The visualiser
 
-The `graft viz` button opens the graph as a tab in [dsh-better-sidebar](https://github.com/omdsh-dev/DSH-better-sidebar). The context view lays out the whole graph:
+The `graft viz` button opens the graph as a tab — in dsh's built-in right sidebar on `0.1.5`+, in [dsh-better-sidebar](https://github.com/omdsh-dev/DSH-better-sidebar) if that is what you run. The context view lays out the whole graph:
 
 ![The graph in the sidebar — context view](assets/viz-context.png)
 
@@ -131,8 +133,9 @@ All optional, all on the plugin's row in your profile's `cordis.patch.yml`:
 
 | dsh | status |
 |---|---|
-| `0.1.2-rc.1` – `0.1.0-rc.7` | tested, full feature set |
-| `0.1.5-rc.2` | tested — chip, tools, `/graft` and auto-rebuild all work; the `graft viz` tab does not mount (see the sidebar note above) |
+| `0.1.2-rc.1` – `0.1.0-rc.7` | tested, full feature set — the `graft viz` tab via `dsh-better-sidebar` |
+| `0.1.5-rc.2` / `0.1.5` | tested — chip, tools, `/graft` and auto-rebuild all work; on `0.1.5` the `graft viz` button opens the graph in the built-in right sidebar |
+| `0.2.0-rc.2` | needs plugin `0.2.1`+ — earlier releases fail to activate (see Troubleshooting) |
 
 - Node 22+
 - the `graft` CLI on PATH (`npm install -g @nanonets/graft`)
@@ -166,6 +169,8 @@ registering "dsh-graft-plugin" via __ModuleLoader__.load
 
 **No chip appears and dsh started without errors.** The plugin is in the profile's `package.json` `dependencies` but not in `dsh.profile.bundles` — which happens under pnpm 10+ when the `add` ends non-zero on `ERR_PNPM_IGNORED_BUILDS`; dsh skips the bundle row in that case and starts up looking healthy. Fix: `pnpm approve-builds` in the profile directory (tick `dsh-graft-plugin`), then re-run `dsh plugin --profile web add dsh-graft-plugin`. If `pnpm approve-builds` reports nothing awaiting approval, check `pnpm-workspace.yaml` for an unanswered `dsh-graft-plugin` entry (pnpm's approval placeholder) and set its value to `true` first.
 
+**On dsh 0.2 the plugin fails to load with `strict codec has no create() factory`, and dsh offers to remove it.** dsh 0.2 requires every strict remote codec to carry a `create()` schema factory; plugin releases before `0.2.1` only had the 0.1 `schema` key. Update to `0.2.1` or later, which carries both and so loads on 0.1 and 0.2.
+
 **`/graft` says the graft CLI is not on PATH.** The postinstall was blocked or skipped (see Install): `npm install -g @nanonets/graft`.
 
 ## Licence

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-graft-plugin",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "Shows which graft index a dsh session is serving and whether it still matches the code, and gives the model graft_ask, graft_grep, graft_callers, graft_skeleton and graft_map as native tools.",
   "type": "module",
   "main": "src/index.js",

package/scripts/test-harness.mjs

@@ -246,7 +246,51 @@ check(
   clientSource.includes('ctx.inject(["betterSidebar"]') && /const inject = \[[^\]]*\]/.exec(clientSource)?.[0].includes('betterSidebar') === false,
   /const inject = \[[^\]]*\]/.exec(clientSource)?.[0],
 )
-check('the browser tab survives only as the fallback', clientSource.includes('no dsh-better-sidebar'))
+// The open order: better-sidebar if a profile still has it, then dsh's own
+// right sidebar (0.1.5+), and a browser tab only when neither is there.
+check('dsh right sidebar comes after better-sidebar', clientSource.indexOf('ctx.get("betterSidebar")') < clientSource.indexOf('ctx.get("sidebarRight")'))
+check('it opens by kind, which also reveals the column', clientSource.includes('right.openTab(VIZ_KIND)'))
+check('a kind nothing registered falls through, not dead', clientSource.includes('openTab throws for a kind nothing registered'))
+check('the type and its body register under the same id', clientSource.includes('sidebarRightTabs.register({') && clientSource.includes('id: TAB_TYPE,') && clientSource.includes('name: "sidebar.right.pane.tab", key: TAB_TYPE'))
+check('that dependency is soft too', clientSource.includes('ctx.inject(["sidebarRightTabs", "slots"]') && !/const inject = [[]/.test('') && clientSource.indexOf('const inject = ["slots", "remote"]') !== -1)
+check('the body reads the session from either host', clientSource.includes('props?.sessionId ?? props?.scope?.sessionId'))
+check('the browser tab survives only as the last resort', clientSource.includes('neither sidebar'))
+
+// The remote descriptors must survive dsh 0.2's typert codec validation, which
+// runs inside `ctx.remote.$mount`: a strict codec needs a typeSymbol and a
+// `create()` factory returning a schema with `parse`. The 0.1 shape (`schema`
+// only) threw "strict codec has no create() factory", rejected apply(), and
+// took the whole plugin down. The client may only use strict codecs for
+// parameters. The descriptor block is lifted out of client.js and evaluated,
+// so this tests the shipped objects, not a copy.
+console.log('\nremote descriptors (dsh 0.2 codec contract)')
+const descriptorBlock = /function identity\(value\) \{[\s\S]*?\r?\n    const CONTRIBUTION = \{[\s\S]*?\r?\n    \};/.exec(clientSource)?.[0]
+check('descriptor block found in client.js', descriptorBlock !== undefined)
+const CONTRIBUTION = descriptorBlock ? new Function(`${descriptorBlock}; return CONTRIBUTION;`)() : { descriptors: [] }
+function codecProblem(codec, { parameter }) {
+  if (!codec || typeof codec !== 'object') return 'missing codec'
+  if (codec.mode === 'src-json') return parameter ? 'client parameters must be strict' : undefined
+  if (codec.mode !== 'strict') return `unknown mode ${codec.mode}`
+  if (typeof codec.typeSymbol !== 'string' || codec.typeSymbol === '') return 'empty typeSymbol'
+  if (typeof codec.create !== 'function') return 'strict codec has no create() factory'
+  const schema = codec.create()
+  if (typeof schema?.parse !== 'function') return 'create() returned no parse()'
+  if (codec.create() !== schema) return 'create() is not memoized'
+  // dsh 0.1 read `schema` directly; keep it so older hosts still load.
+  if (typeof codec.schema?.parse !== 'function') return 'no 0.1 schema fallback'
+  return undefined
+}
+check('declares the status and viz descriptors', CONTRIBUTION.descriptors.map((d) => d.method).join() === 'status,viz')
+for (const d of CONTRIBUTION.descriptors) {
+  for (const p of d.parameters) {
+    const problem = codecProblem(p.codec, { parameter: true })
+    check(`${d.id} parameter ${p.name} codec is valid`, problem === undefined, problem)
+  }
+  const problem = codecProblem(d.result, { parameter: false })
+  check(`${d.id} result codec is valid`, problem === undefined, problem)
+  const sample = { ok: true, value: { root: '/r', nodeCount: 1 } }
+  check(`${d.id} result decodes as a pass-through`, d.result.create().parse(sample) === sample)
+}
 
 await rm(fixture, { recursive: true, force: true })
 

package/src/client.js

@@ -50,7 +50,21 @@ window.__ModuleLoader__.load({
     function identity(value) {
       return value;
     }
-    const CODEC = { mode: "strict", typeSymbol: "graft-status/json", schema: { parse: identity } };
+    /*
+     * Pass-through codec carrying both codec shapes: dsh 0.2's typert
+     * validator requires a strict codec to expose a `create()` factory
+     * returning the schema (it throws "strict codec has no create() factory"
+     * otherwise, failing `$mount` and with it the whole plugin), while dsh 0.1
+     * read `schema` directly. The host still runs assertJsonValue on every
+     * decoded value, so identity is safe.
+     */
+    const IDENTITY_SCHEMA = { parse: identity };
+    const CODEC = {
+      mode: "strict",
+      typeSymbol: "graft-status/json",
+      schema: IDENTITY_SCHEMA,
+      create: () => IDENTITY_SCHEMA,
+    };
     const descriptor = (method, names) => ({
       id: "graft-status#graftStatus/" + method,
       service: "graftStatus",
@@ -58,7 +72,7 @@ window.__ModuleLoader__.load({
       method,
       invocation: { kind: "direct" },
       parameters: names.map((name) => ({ name, wire: name, source: "json", codec: CODEC })),
-      result: { mode: "strict", typeSymbol: "graft-status/json", schema: { parse: identity } },
+      result: CODEC,
       sourceLocation: { file: "graft-status/client.js", line: 1, column: 1 },
     });
     const CONTRIBUTION = {
@@ -324,9 +338,19 @@ window.__ModuleLoader__.load({
       ].join("");
     }
 
-    /** The tab type contributed to dsh-better-sidebar. */
+    /** This viewer's identity: better-sidebar's tab type, and dsh's tab id. */
     const TAB_TYPE = "graft-status:viz";
 
+    /**
+     * The kind dsh's own right sidebar opens this page type by.
+     *
+     * dsh 0.1.5 splits a tab type in two: a static registration naming the kind
+     * (`ctx.sidebarRightTabs`), and the body under the registration's id in the
+     * keyed `sidebar.right.pane.tab` seat. `ctx.sidebarRight.openTab(kind)`
+     * then opens it AND expands a collapsed column in the same step.
+     */
+    const VIZ_KIND = "graft-viz";
+
     /**
      * The sidebar tab: `graft viz` in an iframe.
      *
@@ -370,10 +394,14 @@ window.__ModuleLoader__.load({
         const [status, setStatus] = React.useState(null);
         const [reload, setReload] = React.useState(0);
         const [busy, setBusy] = React.useState(false);
+        // Visible by default: better-sidebar passes `visible: false` for a tab
+        // that exists but is not focused (and asks live views to pause then);
+        // dsh's sidebar mounts only what it draws and passes nothing.
         const visible = props?.visible !== false;
-        // The sidebar's own scope. Its `sessionId` is what tells the host WHICH
-        // workspace to resolve — the same session whose cwd the sidebar shows.
-        const sessionId = props?.scope?.sessionId;
+        // Which workspace to resolve. Both hosts supply the session, in their
+        // own shape: dsh passes `sessionId` straight to the body, while
+        // better-sidebar wraps it in the tab's `scope`.
+        const sessionId = props?.sessionId ?? props?.scope?.sessionId;
 
         React.useEffect(() => {
           if (!visible || viz !== null) return;
@@ -630,7 +658,25 @@ window.__ModuleLoader__.load({
             return;
           }
 
-          // Fallback for a profile with no dsh-better-sidebar: a browser tab.
+          // Next: dsh's own right sidebar (0.1.5+). `openTab` names the KIND,
+          // reveals the column, and reuses the tab that is already open, so a
+          // second click focuses the graph rather than stacking another.
+          // The body starts the server itself on mount, so nothing is awaited
+          // here and no popup-blocker timing applies.
+          const right = ctx.get("sidebarRight");
+          if (right !== undefined && right !== null && typeof right.openTab === "function") {
+            try {
+              right.openTab(VIZ_KIND);
+              return;
+            } catch (error) {
+              // openTab throws for a kind nothing registered — which is the
+              // case when the tab registry was absent at load. Fall through to
+              // the browser tab rather than leaving the click dead.
+              console.warn("[graft-status] right sidebar refused the viz tab:", error);
+            }
+          }
+
+          // Last resort, for a profile with neither sidebar: a browser tab.
 
           // Opened SYNCHRONOUSLY, before any await. A tab opened from a
           // resolved promise is a popup as far as the browser is concerned and
@@ -812,6 +858,41 @@ window.__ModuleLoader__.load({
       // plugin — chip included — from activating in a profile that does not
       // have the sidebar installed. This way the tab appears when the service
       // does, and the button falls back to a browser tab when it never comes.
+      // dsh's own right sidebar (0.1.5+). Two registrations: the static type,
+      // and the body in the keyed seat under the SAME id. `ctx.inject` rather
+      // than the module-level list for the same reason as below — a profile
+      // without this sidebar must still get the chip and the button.
+      ctx.inject(["sidebarRightTabs", "slots"], (scope) => {
+        scope.effect(
+          () =>
+            scope.sidebarRightTabs.register({
+              id: TAB_TYPE,
+              kind: VIZ_KIND,
+              // A page type, opened by kind: it recognises no resource address,
+              // so it declares no patterns. "extension" is the band for a type
+              // from outside the product, and the default.
+              priority: "extension",
+              title: () => "Graft",
+              guide: [
+                {
+                  order: 60,
+                  title: () => "Graft",
+                  description: () => "The graft graph for this workspace",
+                  icon: GraphIcon,
+                },
+              ],
+            }),
+          "graft-status: right sidebar tab type",
+        );
+        scope.effect(
+          () =>
+            scope.slots.inject("sidebar.right.pane.tab", () =>
+              scope.slots.register({ name: "sidebar.right.pane.tab", key: TAB_TYPE }, makeVizTab(ctx)),
+            ),
+          "graft-status: right sidebar tab body",
+        );
+      });
+
       ctx.inject(["betterSidebar"], (scope) => {
         scope.effect(
           () =>