dsh-labscript 0.2.5 → 0.2.7

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.2.7
+
+- Fix: labs_wait no longer fails with "value is not lossless JSON". Tool results must be
+  pure JSON; a completed wait could carry an undefined hint field, which the DSH host
+  rejects when recording the result (the run itself was fine). labs_status pending
+  progress and the aborted-wait result are cleaned the same way.
+- Fix: non-ASCII arguments (e.g. a Chinese note) no longer break the bridge. Python's
+  stdin on Windows uses the locale encoding (GBK); the bridge now reads stdin as UTF-8.
+  Such a note used to submit the run and then fail with UnicodeEncodeError in the event
+  log, which made a successful engage look failed.
+- Fix: a failed event-log write can no longer turn a successful action into an error; it
+  is reported on stderr and the action result is returned as usual.
+- Tests: Unicode note end-to-end through the bridge process, event-log failure
+  isolation, and a lossless-JSON check on tool results.
+
+## 0.2.6
+
+- Fix: labs_data rendered only counts. It now prints selected first-shot globals
+  (keys=[...] to choose, ["*"] for all, <missing> for absent keys), the results group
+  names when results: true, and a scan axis summary (unique points, min/max, median
+  step, numeric column count). Pass limit to print up to 20 raw scan rows; the bridge
+  only returns rows when limit is given.
+- Tests: first-shot key selection, scan axis summary and columns, on-demand rows, and
+  the rendered output for keys/results/scan/limit.
+
 ## 0.2.5
 
 - labs_status can list every panel global: keys=["*"] prints all of them, sorted

package/README.md

@@ -125,8 +125,8 @@ is not a physics simulation.
 ## Development
 
     npm install              # only runtime dependency: yaml
-    npm test                 # node --test, 38 tests (fake bridge, no python needed)
-    python python/tests/run_tests.py   # 19 tests (needs numpy + h5py)
+    npm test                 # node --test, 40 tests (fake bridge, no python needed)
+    python python/tests/run_tests.py   # 22 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

@@ -74,6 +74,54 @@ function scanLine(value) {
   return 'scan axes: ' + detail + '  n_shots_from_arrays=' + product + (mismatch ? '  (panel n_shots=' + value.n_shots + ' differs)' : '')
 }
 
+function resultsLine(value) {
+  const layout = value.results_layout
+  if (!layout) return ''
+  const names = Object.keys(layout).sort()
+  if (names.length === 0) return 'results: none'
+  return 'results: ' + names.map((group) => group + ' (' + layout[group].length + ' fields)').join(', ')
+}
+
+function dataGlobalsLines(args, value) {
+  const globals = value.globals
+  if (!globals) return []
+  const keys = Array.isArray(args.keys) ? args.keys.map(String) : []
+  if (keys.length === 0) {
+    return ['globals: ' + Object.keys(globals).length + ' keys (pass keys=[...] or keys=["*"] to print values)']
+  }
+  const wanted = keys.length === 1 && keys[0] === '*' ? Object.keys(globals).sort() : keys
+  return ['globals:'].concat(wanted.map((key) => '  ' + key + ' = ' + (Object.prototype.hasOwnProperty.call(globals, key) ? globalText(globals[key]) : '<missing>')))
+}
+
+function scanSummaryLine(value) {
+  const table = value.scan_table
+  if (!table) return ''
+  const axis = table.axis || {}
+  const unique = typeof axis.points === 'number' && axis.points > 0
+    ? axis.points + ' unique ' + axis.min + '..' + axis.max + (axis.step === null || axis.step === undefined ? '' : ' step ' + axis.step)
+    : 'no numeric axis values'
+  const columns = Array.isArray(table.columns) ? table.columns.length : 0
+  return 'scan ' + table.scan + ': ' + table.n_points + ' shots, ' + unique + ', ' + columns + ' numeric columns' + (Array.isArray(table.rows) ? ' (' + table.rows.length + ' raw rows below)' : '')
+}
+
+function scanRowLines(value) {
+  const table = value.scan_table
+  if (!table || !Array.isArray(table.rows) || table.rows.length === 0) return []
+  const lines = ['rows (first ' + table.rows.length + '):']
+  for (const row of table.rows) {
+    const parts = []
+    if (row.shot !== undefined) parts.push('shot=' + row.shot)
+    if (row[table.scan] !== undefined) parts.push(table.scan + '=' + row[table.scan])
+    for (const key of Object.keys(row).sort()) {
+      if (key === 'shot' || key === table.scan) continue
+      parts.push(key + '=' + row[key])
+    }
+    const line = parts.join(' ')
+    lines.push('  ' + (line.length > 240 ? line.slice(0, 240) + '…' : line))
+  }
+  return lines
+}
+
 async function pendingProgress(runtime, exec) {
   const pending = runtime.state.pending
   if (!pending) return null
@@ -85,6 +133,7 @@ async function pendingProgress(runtime, exec) {
     note: pending.note,
     elapsed_s: pending.submitted_at ? Math.round((Date.now() - Date.parse(pending.submitted_at)) / 1000) : undefined,
   }
+  for (const key of Object.keys(base)) if (base[key] === undefined) delete base[key]
   if (!pending.run_folder) return base
   try {
     const progress = await runtime.runBridge('progress', {
@@ -302,7 +351,7 @@ export function registerTools(ctx, runtime) {
             runtime.state.waitCancelledByAbort = false
             return {
               run_folder: runFolder,
-              expected_n_shots: expected,
+              ...(expected !== undefined ? { expected_n_shots: expected } : {}),
               complete: false,
               timed_out: false,
               aborted: true,
@@ -328,6 +377,7 @@ export function registerTools(ctx, runtime) {
           mapped_run_folder: waited.mapped_run_folder,
           folder_exists: waited.folder_exists,
         }
+        for (const key of Object.keys(out)) if (out[key] === undefined) delete out[key]
         if (waited.complete && runtime.state.lastRun && runtime.state.lastRun.run_folder === runFolder) {
           runtime.setLastRun(Object.assign({}, runtime.state.lastRun, {
             completed_at: new Date().toISOString(),
@@ -372,23 +422,27 @@ export function registerTools(ctx, runtime) {
 
   ctx.tools.register({
     name: 'labs_data',
-    description: 'Read a run folder HDF5: globals of the first shot (execution facts) and, with scan: a per-shot table of scan values and numeric results. Read-only. run_folder defaults to the pending run, else the last run submitted through this plugin (persisted across restarts); for a historical run pass its folder explicitly. A missing folder is an error: runmanager\'s shot output is the NEXT run folder and only exists after engage.',
+    description: 'Read a run folder HDF5: first-shot globals (pass keys=[...] to print selected values, ["*"] for all), the results groups with results: true, and with scan: a per-shot scan axis summary (unique points, min/max, median step) plus the numeric result columns; pass limit to print up to 20 raw rows. Read-only. run_folder defaults to the pending run, else the last run submitted through this plugin (persisted across restarts); for a historical run pass its folder explicitly. A missing folder is an error: runmanager\'s shot output is the NEXT run folder and only exists after engage.',
     parameters: {
       type: 'object',
       properties: {
         run_folder: { type: 'string', description: 'Run folder; defaults to the run submitted from this DSH session (pass a historical run folder explicitly)' },
-        scan: { type: 'string', description: 'Panel global name used as the scan axis; adds a per-shot table' },
+        scan: { type: 'string', description: 'Panel global name used as the scan axis; adds an axis summary and numeric columns (pass limit for raw rows)' },
         globals: { type: 'boolean', description: 'Include the first shot globals (default true)' },
+        keys: { type: 'array', items: { type: 'string' }, description: 'First-shot globals to print; ["*"] prints all. Missing keys show as <missing>.' },
+        limit: { type: 'number', minimum: 1, maximum: 20, description: 'How many raw scan rows to print (only with scan; default: none)' },
         results: { type: 'boolean', description: 'Include the results layout' },
       },
       additionalProperties: false,
     },
     isConcurrencySafe: () => true,
-    output: looseOutput((_args, value) => text(lines([
+    output: looseOutput((args, value) => text(lines([
       'run: ' + (value.mapped_run_folder || value.run_folder),
       'h5: ' + value.n_h5 + (value.empty ? ' (folder exists, no shots yet)' : ''),
-      value.scan_table ? 'scan ' + value.scan_table.scan + ': ' + value.scan_table.n_points + ' shots' : '',
-      value.globals ? 'globals: ' + Object.keys(value.globals).length + ' keys' : '',
+      resultsLine(value),
+      ...dataGlobalsLines(args, value),
+      scanSummaryLine(value),
+      ...scanRowLines(value),
     ]))),
     async execute(args, exec) {
       const runFolder = args.run_folder || (runtime.state.pending ? runtime.state.pending.run_folder : '') || (runtime.state.lastRun ? runtime.state.lastRun.run_folder : '')
@@ -396,6 +450,8 @@ export function registerTools(ctx, runtime) {
       return runtime.runBridge('data', {
         run_folder: runFolder,
         scan: args.scan,
+        keys: Array.isArray(args.keys) ? args.keys : undefined,
+        limit: typeof args.limit === 'number' ? args.limit : undefined,
         globals: args.globals !== false,
         results: args.results === true,
       }, { signal: exec.signal })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-labscript",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "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

@@ -612,10 +612,13 @@ def snapshot_panel(backend, config, tool, args, touched=None):
 
 
 def append_event(config, event):
-    folder = history_dir(config)
-    path = os.path.join(folder, "events.jsonl")
-    with open(path, "a", encoding="utf-8") as handle:
-        handle.write(json.dumps(jsonable(event), ensure_ascii=False) + "\n")
+    try:
+        folder = history_dir(config)
+        path = os.path.join(folder, "events.jsonl")
+        with open(path, "a", encoding="utf-8") as handle:
+            handle.write(json.dumps(jsonable(event), ensure_ascii=False) + "\n")
+    except Exception as exc:
+        sys.stderr.write("append_event failed: %s\n" % (exc,))
 
 
 def load_snapshot(config, name):
@@ -1213,7 +1216,12 @@ def cmd_data(config, args):
     with h5py.File(shots[0], "r", locking=False) as handle:
         globals_attrs = dict(handle["globals"].attrs) if "globals" in handle else {}
         if args.get("globals", True):
-            out["globals"] = jsonable(globals_attrs)
+            selected = jsonable(globals_attrs)
+            keys = args.get("keys")
+            if keys and list(map(str, keys)) != ["*"]:
+                wanted = [str(key) for key in keys]
+                selected = dict((key, selected[key]) for key in wanted if key in selected)
+            out["globals"] = selected
         if args.get("results"):
             layout = {}
             if "results" in handle:
@@ -1252,7 +1260,30 @@ def cmd_data(config, args):
                                 if number is not None:
                                     row[group_name + "." + key] = number
                 rows.append(row)
-        out["scan_table"] = {"scan": scan, "n_points": len(rows), "rows": rows}
+        axis_values = [float(row[scan]) for row in rows if isinstance(row.get(scan), (int, float))]
+        unique = sorted(set(axis_values))
+        steps = [round(b - a, 9) for a, b in zip(unique, unique[1:])]
+        columns = sorted(set(key for row in rows for key in row) - {"shot", scan})
+        table = {
+            "scan": scan,
+            "n_points": len(rows),
+            "axis": {
+                "points": len(unique),
+                "min": unique[0] if unique else None,
+                "max": unique[-1] if unique else None,
+                "step": (sorted(steps)[len(steps) // 2] if steps else None),
+            },
+            "columns": columns,
+        }
+        limit = args.get("limit")
+        if limit:
+            try:
+                limit = max(1, min(20, int(limit)))
+            except Exception:
+                limit = 0
+            if limit:
+                table["rows"] = rows[:limit]
+        out["scan_table"] = table
     return out
 
 
@@ -1502,6 +1533,10 @@ HANDLERS = {
 
 
 def main():
+    try:
+        sys.stdin.reconfigure(encoding="utf-8")
+    except Exception:
+        pass
     try:
         request = json.load(sys.stdin)
     except Exception as exc:

package/python/tests/run_tests.py

@@ -232,7 +232,7 @@ def test_data_reading():
         cfg = make_config(tmp)
         started = bridge.cmd_protocol_start(cfg, {"protocol": protocol_raw()})
         run_folder = started["engage"]["run_folder"]
-        data = bridge.cmd_data(cfg, {"run_folder": run_folder, "scan": "duration_test_us"})
+        data = bridge.cmd_data(cfg, {"run_folder": run_folder, "scan": "duration_test_us", "limit": 1})
         assert data["n_h5"] == 6
         assert data["scan_table"]["n_points"] == 6
         assert data["globals"]["amplitude"] == 0.5
@@ -405,6 +405,68 @@ def test_status_scan_axes():
         shutil.rmtree(tmp, ignore_errors=True)
 
 
+def test_data_keys_and_scan_summary():
+    tmp = tempfile.mkdtemp(prefix="dsh-labscript-data-keys-")
+    try:
+        cfg = make_config(tmp)
+        started = bridge.cmd_protocol_start(cfg, {"protocol": protocol_raw()})
+        run_folder = started["engage"]["run_folder"]
+        one = bridge.cmd_data(cfg, {"run_folder": run_folder, "keys": ["amplitude"]})
+        assert list(one["globals"].keys()) == ["amplitude"], one["globals"]
+        absent = bridge.cmd_data(cfg, {"run_folder": run_folder, "keys": ["nope"]})
+        assert absent["globals"] == {}, absent["globals"]
+        full = bridge.cmd_data(cfg, {"run_folder": run_folder, "keys": ["*"]})
+        assert len(full["globals"]) > 1, full["globals"]
+        summary = bridge.cmd_data(cfg, {"run_folder": run_folder, "scan": "duration_test_us"})
+        table = summary["scan_table"]
+        assert table["n_points"] == 6, table
+        assert table["axis"]["points"] == 3, table["axis"]
+        assert table["axis"]["min"] == 0.0 and table["axis"]["max"] == 2.0, table["axis"]
+        assert table["axis"]["step"] == 1.0, table["axis"]
+        assert "shot" not in table["columns"] and "duration_test_us" not in table["columns"], table["columns"]
+        assert "rows" not in table, list(table.keys())
+        limited = bridge.cmd_data(cfg, {"run_folder": run_folder, "scan": "duration_test_us", "limit": 2})
+        assert len(limited["scan_table"]["rows"]) == 2, limited["scan_table"]
+        assert limited["scan_table"]["rows"][0]["shot"], limited["scan_table"]["rows"][0]
+    finally:
+        shutil.rmtree(tmp, ignore_errors=True)
+
+
+def test_engage_with_unicode_note():
+    import subprocess
+    tmp = tempfile.mkdtemp(prefix="dsh-labscript-unicode-")
+    try:
+        cfg = make_config(tmp)
+        request = {"cmd": "engage", "config": cfg, "args": {"note": "中文备注：测试"}}
+        env = dict((k, v) for k, v in os.environ.items() if k not in ("PYTHONUTF8", "PYTHONIOENCODING"))
+        proc = subprocess.run(
+            [sys.executable, os.path.join(os.path.dirname(HERE), "bridge.py")],
+            input=json.dumps(request).encode("utf-8"),
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            env=env,
+        )
+        payload = json.loads(proc.stdout.decode("utf-8"))
+        assert payload.get("ok") is True, payload
+        assert payload["data"]["run_folder"], payload["data"]
+        with open(os.path.join(tmp, "history", "events.jsonl"), "r", encoding="utf-8") as handle:
+            assert "中文备注" in handle.read()
+    finally:
+        shutil.rmtree(tmp, ignore_errors=True)
+
+
+def test_append_event_never_raises():
+    tmp = tempfile.mkdtemp(prefix="dsh-labscript-events-")
+    try:
+        blocked = os.path.join(tmp, "blocked")
+        with open(blocked, "w", encoding="utf-8") as handle:
+            handle.write("not a directory")
+        cfg = {"panelHistoryDir": os.path.join(blocked, "history")}
+        bridge.append_event(cfg, {"tool": "x", "note": "中文"})
+    finally:
+        shutil.rmtree(tmp, ignore_errors=True)
+
+
 def main():
     tests = [value for name, value in sorted(globals().items()) if name.startswith("test_")]
     failures = 0