dsh-labscript 0.2.6 → 0.2.7

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # 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

package/README.md

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

@@ -133,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', {
@@ -350,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,
@@ -376,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(),

package/package.json

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

@@ -432,6 +432,41 @@ def test_data_keys_and_scan_summary():
         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