dsh-labscript 0.2.1 → 0.2.2

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.2.2
+
+- Fix: labs_status and labs_engage report pathMap-mapped paths. `labs_status.labscript`
+  and `labs_status.shot_output_folder` used to be raw runmanager paths (e.g. E:\...)
+  and were unusable from the agent's machine; they are now what pathMap maps them to.
+  This is a field-semantics fix: read them as local paths, do not map again.
+- Fix: tool output renders mapped run folders. The rendered lines of labs_engage,
+  labs_wait, labs_data, labs_protocol and the pending-run progress now prefer
+  `mapped_run_folder` over the raw `run_folder`.
+- Fix: labs_status now lists the shot output folder, and the status progress object
+  reports `mapped_run_folder`.
+- Tests: pathMap exit coverage (status mapping, idempotency, progress mapping).
+
 ## 0.2.1
 
 - Hard limits support a lower bound: limits entries can now use min as well as max

package/README.md

@@ -97,6 +97,12 @@ Add one row to your DSH profile patch (see examples/config.example.yml):
           pythonPaths: [/path/to/my_lab]
         approval: { engage: true, protocolRun: true }
 
+`pathMap` rewrites paths reported by runmanager (remote drive letters such as
+`E:/Experiments`) into paths this machine can open (UNC shares). Tool output is
+already mapped: `labs_status`, `labs_engage`, `labs_wait`, `labs_data` and
+`labs_protocol` show local paths, while `run_folder` keeps the raw runmanager
+value next to `mapped_run_folder`.
+
 The python interpreter must be able to import numpy and h5py; the real backend
 also needs runmanager (labscript-suite). The plugin never stores credentials:
 zprocess authentication is read by labscript itself from labconfig.
@@ -119,8 +125,8 @@ is not a physics simulation.
 ## Development
 
     npm install              # only runtime dependency: yaml
-    npm test                 # node --test, 18 tests (fake bridge, no python needed)
-    python python/tests/run_tests.py   # 8 tests (needs numpy + h5py)
+    npm test                 # node --test, 35 tests (fake bridge, no python needed)
+    python python/tests/run_tests.py   # 15 tests (needs numpy + h5py)
     LABSCRIPT_PYTHON=/path/to/python3 node scripts/demo.mjs   # end-to-end mock demo
 
 A fresh clone must run `npm install` before `npm test`; the CI workflow does this.

package/lib/tools.js

@@ -26,7 +26,7 @@ function number(value) {
 
 function progressLine(run) {
   if (!run) return 'run: none pending'
-  const parts = ['run: ' + (run.run_folder || '<submitted>')]
+  const parts = ['run: ' + (run.mapped_run_folder || run.run_folder || '<submitted>')]
   if (run.kind) parts.push('kind=' + run.kind)
   if (run.n_h5 !== undefined) parts.push('h5=' + run.n_h5 + '/' + (run.expected_n_shots || '?'))
   else if (run.expected_n_shots) parts.push('expected=' + run.expected_n_shots)
@@ -105,7 +105,7 @@ export function registerTools(ctx, runtime) {
 
   ctx.tools.register({
     name: 'labs_status',
-    description: 'Read the labscript runmanager panel: loaded labscript, globals (evaluated; raw expressions with raw=true), n_shots, error_in_globals, run_shots, shot output folder, pending run progress, and the panel snapshot directory. Read-only; call this before any write.',
+    description: 'Read the labscript runmanager panel: loaded labscript, globals (evaluated; raw expressions with raw=true), n_shots, error_in_globals, run_shots, shot output folder, pending run progress, and the panel snapshot directory. Read-only; call this before any write. Paths in the output are already mapped for this machine through pathMap; do not map them again.',
     parameters: {
       type: 'object',
       properties: {
@@ -118,6 +118,7 @@ export function registerTools(ctx, runtime) {
     output: looseOutput((_args, value) => text(lines([
       'backend: ' + value.backend + '  plugin: v' + runtime.version,
       'labscript: ' + value.labscript,
+      'shot output: ' + value.shot_output_folder,
       'n_shots: ' + value.n_shots + '  error_in_globals: ' + value.error_in_globals + '  run_shots: ' + value.run_shots,
       progressLine(value.last_run),
       'panel history: ' + (value.panel_history ? value.panel_history.dir + ' (' + value.panel_history.count + ' snapshots)' : 'n/a'),
@@ -174,7 +175,7 @@ export function registerTools(ctx, runtime) {
     },
     isConcurrencySafe: () => false,
     output: looseOutput((_args, value) => text(lines([
-      'submitted run: ' + (value.run_folder || '<run folder pending>'),
+      'submitted run: ' + (value.mapped_run_folder || value.run_folder || '<run folder pending>'),
       'n_shots_at_submit: ' + value.n_shots_at_submit + '  expected: ' + value.expected_n_shots,
       'call labs_wait when results are needed.',
     ]))),
@@ -216,7 +217,7 @@ export function registerTools(ctx, runtime) {
     },
     isConcurrencySafe: () => true,
     output: looseOutput((_args, value) => text(lines([
-      'run: ' + value.run_folder,
+      'run: ' + (value.mapped_run_folder || value.run_folder),
       value.aborted ? 'wait cancelled by labs_abort (run aborted)' : '',
       'shots: ' + value.n_h5 + '/' + (value.expected_n_shots || '?') + '  complete: ' + value.complete + (value.timed_out ? '  TIMED OUT' : '') + (value.diagnosis ? '  diagnosis: ' + value.diagnosis : ''),
       value.hint ? 'hint: ' + value.hint : '',
@@ -326,7 +327,7 @@ export function registerTools(ctx, runtime) {
     },
     isConcurrencySafe: () => true,
     output: looseOutput((_args, value) => text(lines([
-      'run: ' + value.run_folder,
+      'run: ' + (value.mapped_run_folder || value.run_folder),
       'h5: ' + value.n_h5,
       value.scan_table ? 'scan ' + value.scan_table.scan + ': ' + value.scan_table.n_points + ' shots' : '',
       value.globals ? 'globals: ' + Object.keys(value.globals).length + ' keys' : '',
@@ -366,7 +367,7 @@ export function registerTools(ctx, runtime) {
       value.warnings && value.warnings.length ? 'warnings: ' + value.warnings.join('; ') : '',
       value.name_check && value.name_check.checked && value.name_check.missing && value.name_check.missing.length ? 'script key check: MISSING ' + value.name_check.missing.join(', ') : '',
       value.name_check && value.name_check.checked === false ? 'script key check: not checked (' + (value.name_check.reason || 'no script') + ')' : '',
-      value.engage ? 'submitted: ' + (value.engage.run_folder || '<run folder pending>') + '  n_shots_at_submit: ' + value.n_shots_at_submit : '',
+      value.engage ? 'submitted: ' + (value.engage.mapped_run_folder || value.engage.run_folder || '<run folder pending>') + '  n_shots_at_submit: ' + value.n_shots_at_submit : '',
       value.engage ? 'call labs_wait to finalize this protocol.' : '',
     ]))),
     async execute(args, exec) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-labscript",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Control labscript-suite experiments from DeepSeek Harness: runmanager globals and scans, submits and waits, YAML fixed-operation protocols with postprocess write-back, panel snapshots, a built-in mock backend and a read-only doctor.",
   "type": "module",
   "main": "lib/index.js",

package/python/bridge.py

@@ -927,8 +927,8 @@ def cmd_status(config, args):
     out = {
         "backend": config.get("backend"),
         "version": backend.version() if hasattr(backend, "version") else None,
-        "labscript": backend.labscript_file(),
-        "shot_output_folder": backend.shot_output_folder(),
+        "labscript": map_path(config, backend.labscript_file()),
+        "shot_output_folder": map_path(config, backend.shot_output_folder()),
         "globals": jsonable(values),
         "n_shots": backend.n_shots(),
         "error_in_globals": backend.error_in_globals(),
@@ -1015,7 +1015,7 @@ def cmd_engage(config, args):
         "mapped_run_folder": map_path(config, run_folder),
         "n_shots_at_submit": n_shots,
         "expected_n_shots": int(args.get("expected_n_shots") or n_shots),
-        "labscript": backend.labscript_file(),
+        "labscript": map_path(config, backend.labscript_file()),
         "submitted_at": now_iso(),
     }
     append_event(config, {"ts": out["submitted_at"], "tool": "engage", "backend": config.get("backend"), "note": args.get("note"), "run_folder": run_folder, "expected_n_shots": out["expected_n_shots"]})
@@ -1127,7 +1127,7 @@ def cmd_progress(config, args):
     expected = int(args.get("expected_n_shots") or 0)
     folder = map_path(config, run_folder)
     shots = sorted(glob.glob(os.path.join(folder, "**", "*.h5"), recursive=True)) if folder else []
-    return {"run_folder": run_folder, "n_h5": len(shots), "expected_n_shots": expected, "complete": bool(expected and len(shots) >= expected)}
+    return {"run_folder": run_folder, "mapped_run_folder": folder, "n_h5": len(shots), "expected_n_shots": expected, "complete": bool(expected and len(shots) >= expected)}
 
 
 

package/python/tests/run_tests.py

@@ -291,6 +291,61 @@ def test_doctor_mock():
         shutil.rmtree(tmp, ignore_errors=True)
 
 
+def test_status_maps_paths_from_runmanager():
+    """labs_status must return paths the agent's machine can open."""
+    tmp = tempfile.mkdtemp(prefix="dsh-labscript-py-map-")
+    try:
+        cfg = make_config(tmp)
+        cfg["pathMap"] = [{"remotePrefix": "E:\\Experiments", "localPrefix": "\\\\lab-pc\\Experiments"}]
+
+        class FakeBackend(object):
+            def get_globals(self, raw=False):
+                return {}
+
+            def labscript_file(self):
+                return "E:\\Experiments\\2026\\x.py"
+
+            def shot_output_folder(self):
+                return "E:\\Experiments\\2026\\11\\12\\0177"
+
+            def n_shots(self):
+                return 1
+
+            def error_in_globals(self):
+                return False
+
+            def run_shots(self):
+                return True
+
+            def version(self):
+                return "fake"
+
+        original = bridge.make_backend
+        bridge.make_backend = lambda config: FakeBackend()
+        try:
+            out = bridge.cmd_status(cfg, {})
+        finally:
+            bridge.make_backend = original
+        assert out["labscript"] == "\\\\lab-pc\\Experiments\\2026\\x.py", out["labscript"]
+        assert out["shot_output_folder"] == "\\\\lab-pc\\Experiments\\2026\\11\\12\\0177", out["shot_output_folder"]
+    finally:
+        shutil.rmtree(tmp, ignore_errors=True)
+
+
+def test_map_path_is_idempotent():
+    cfg = {"pathMap": [{"remotePrefix": "E:\\Experiments", "localPrefix": "\\\\lab-pc\\Experiments"}]}
+    once = bridge.map_path(cfg, "E:\\Experiments\\a\\b.h5")
+    assert once == "\\\\lab-pc\\Experiments\\a\\b.h5", once
+    assert bridge.map_path(cfg, once) == once
+
+
+def test_progress_reports_mapped_run_folder():
+    cfg = {"pathMap": [{"remotePrefix": "E:\\Experiments", "localPrefix": "\\\\lab-pc\\Experiments"}]}
+    out = bridge.cmd_progress(cfg, {"run_folder": "E:\\Experiments\\nope", "expected_n_shots": 1})
+    assert out["run_folder"] == "E:\\Experiments\\nope", out
+    assert out["mapped_run_folder"] == "\\\\lab-pc\\Experiments\\nope", out
+
+
 def main():
     tests = [value for name, value in sorted(globals().items()) if name.startswith("test_")]
     failures = 0