labnotes 0.0.55__tar.gz → 0.0.56__tar.gz

{labnotes-0.0.55 → labnotes-0.0.56}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.55
+Version: 0.0.56
 Summary: Browse experiment designs, notes, and run data from a folder.
 Project-URL: Repository, https://github.com/thekevinscott/labnotes
 Author-email: Kevin Scott <me@thekevinscott.com>

{labnotes-0.0.55 → labnotes-0.0.56}/src/labnotes/create_app.py

@@ -6,7 +6,13 @@ from pathlib import Path
 from starlette.applications import Starlette
 from starlette.exceptions import HTTPException
 from starlette.requests import Request
-from starlette.responses import HTMLResponse, JSONResponse, Response
+from starlette.responses import (
+    HTMLResponse,
+    JSONResponse,
+    PlainTextResponse,
+    Response,
+    StreamingResponse,
+)
 from starlette.routing import Mount, Route
 from starlette.staticfiles import StaticFiles
 from starlette.templating import Jinja2Templates
@@ -14,6 +20,7 @@ from starlette.templating import Jinja2Templates
 from labnotes.asset_url import asset_url
 from labnotes.drain_watch import drain_watch
 from labnotes.experiment_notes import experiment_notes
+from labnotes.file_changes import file_changes
 from labnotes.format_duration import format_duration
 from labnotes.format_value import format_value
 from labnotes.list_experiments import list_experiments
@@ -74,9 +81,7 @@ def create_app(config: LabnotesConfig, kernel_idle_minutes: float) -> Starlette:
             request, "experiment.html", {"experiment": loaded}
         )
 
-    async def find_note(request: Request) -> dict[str, str]:
-        if request.headers.get("content-type") != "application/json":
-            raise HTTPException(415, "Send JSON")
+    async def read_note(request: Request) -> dict[str, str]:
         name = request.path_params["name"]
         note = request.path_params["note"]
         found = await experiment_notes(
@@ -87,6 +92,21 @@ def create_app(config: LabnotesConfig, kernel_idle_minutes: float) -> Starlette:
         [note] = found
         return note
 
+    async def find_note(request: Request) -> dict[str, str]:
+        if request.headers.get("content-type") != "application/json":
+            raise HTTPException(415, "Send JSON")
+        return await read_note(request)
+
+    async def get_note(request: Request) -> Response:
+        note = await read_note(request)
+        return PlainTextResponse(note["content"], media_type="text/markdown")
+
+    async def changes(request: Request) -> Response:
+        return StreamingResponse(
+            file_changes(request.app.state.tables, request.path_params["name"]),
+            media_type="text/event-stream",
+        )
+
     async def put_note(request: Request) -> Response:
         note = await find_note(request)
         body = await request.json()
@@ -119,6 +139,8 @@ def create_app(config: LabnotesConfig, kernel_idle_minutes: float) -> Starlette:
         routes=[
             Route("/", index),
             Route("/experiments/{name}", experiment),
+            Route("/experiments/{name}/changes", changes),
+            Route("/experiments/{name}/notes/{note:path}", get_note),
             Route("/experiments/{name}/notes/{note:path}", put_note, methods=["PUT"]),
             Route(
                 "/experiments/{name}/notes/{note:path}/run",

labnotes-0.0.56/src/labnotes/file_changes.py

@@ -0,0 +1,11 @@
+import json
+from collections.abc import AsyncIterator
+
+from dirsql import DirSQL
+
+
+async def file_changes(tables: DirSQL, experiment: str) -> AsyncIterator[str]:
+    async for event in tables.watch():
+        row = event.row or event.old_row
+        if event.table == "files" and row and row["experiment"] == experiment:
+            yield f"data: {json.dumps(row['filename'])}\n\n"

{labnotes-0.0.55 → labnotes-0.0.56}/src/labnotes/static/note-edit.js

@@ -4,6 +4,8 @@ if (note) {
   const prose = note.querySelector(".prose");
   const status = note.querySelector(".edit-status");
   const editor = import(note.dataset.editor);
+  let editing = null;
+
   editor.then(
     () => prose.classList.add("editable"),
     () => {
@@ -15,9 +17,15 @@ if (note) {
   const open = async (event) => {
     if (event.target.closest("a, button, output") || getSelection().toString()) return;
     const { edit } = await editor;
-    if (!prose.isConnected) return;
+    if (editing) return;
     prose.removeEventListener("click", open);
-    edit(note, prose, status);
+    editing = edit(note, prose, status);
   };
   prose.addEventListener("click", open);
+
+  new EventSource(note.dataset.changesUrl).addEventListener("message", (event) => {
+    if (JSON.parse(event.data) !== note.dataset.note) return;
+    if (editing) editing.pull();
+    else location.reload();
+  });
 }

{labnotes-0.0.55 → labnotes-0.0.56}/src/labnotes/static/note-editor.js

@@ -12,6 +12,7 @@ import { EditorState, RangeSetBuilder } from "@codemirror/state";
 import { Decoration, EditorView, ViewPlugin, keymap } from "@codemirror/view";
 import { tags } from "@lezer/highlight";
 import { GFM, parseCode, parser } from "@lezer/markdown";
+import { DIFF_DELETE, DIFF_EQUAL, diff_match_patch } from "diff-match-patch";
 
 // Built from @lezer/markdown rather than @codemirror/lang-markdown, which
 // imports HTML, CSS and JavaScript support that notes never use.
@@ -102,9 +103,27 @@ function show(status, message) {
   status.hidden = false;
 }
 
+const dmp = new diff_match_patch();
+
+// Three-way: what changed on disk since base, applied onto the editor's text.
+const merge = (base, ours, theirs) => dmp.patch_apply(dmp.patch_make(base, theirs), ours)[0];
+
+// Minimal changes, so the cursor and undo history survive.
+function setText(view, text) {
+  const changes = [];
+  let at = 0;
+  for (const [op, chunk] of dmp.diff_main(view.state.doc.toString(), text)) {
+    if (op === DIFF_EQUAL) at += chunk.length;
+    else if (op === DIFF_DELETE) {
+      changes.push({ from: at, to: at + chunk.length });
+      at += chunk.length;
+    } else changes.push({ from: at, insert: chunk });
+  }
+  if (changes.length) view.dispatch({ changes });
+}
+
 export function edit(note, prose, status) {
   let base = JSON.parse(note.querySelector(".note-source").textContent);
-  let stale = false;
   let timer;
   let queue = Promise.resolve();
 
@@ -112,31 +131,46 @@ export function edit(note, prose, status) {
   host.className = "editor";
   prose.replaceWith(host);
 
-  const save = () =>
-    (queue = queue
-      .then(async () => {
-        clearTimeout(timer);
-        const content = view.state.doc.toString();
-        if (stale || content === base) return;
-        const response = await fetch(note.dataset.saveUrl, {
-          method: "PUT",
-          headers: { "Content-Type": "application/json" },
-          body: JSON.stringify({ base, content }),
-        });
-        if (response.status === 409) {
-          stale = true;
-          show(status, "This note changed on disk, so your edits are not saved. Copy them, then reload.");
-        } else if (response.ok) {
-          base = content;
-        } else {
-          show(status, `Not saved: ${response.status} ${response.statusText}`);
-        }
-      })
-      .catch((error) => show(status, `Not saved: ${error.message}`)));
+  const run = (task) =>
+    (queue = queue.then(task).catch((error) => show(status, `Not saved: ${error.message}`)));
+
+  const absorb = (theirs) => {
+    setText(view, merge(base, view.state.doc.toString(), theirs));
+    base = theirs;
+  };
+
+  const push = async () => {
+    clearTimeout(timer);
+    for (;;) {
+      const content = view.state.doc.toString();
+      if (content === base) return;
+      const response = await fetch(note.dataset.saveUrl, {
+        method: "PUT",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({ base, content }),
+      });
+      if (response.status !== 409) {
+        if (response.ok) base = content;
+        else show(status, `Not saved: ${response.status} ${response.statusText}`);
+        return;
+      }
+      absorb((await response.json()).content);
+    }
+  };
+
+  const pull = async () => {
+    const response = await fetch(note.dataset.saveUrl, { cache: "no-store" });
+    if (!response.ok) return show(status, `Not synced: ${response.status} ${response.statusText}`);
+    const theirs = await response.text();
+    if (theirs === base) return;
+    absorb(theirs);
+    await push();
+  };
+
+  const save = () => run(push);
 
   const close = async () => {
     await save();
-    if (stale) return;
     document.removeEventListener("mousedown", outside);
     location.reload();
   };
@@ -166,4 +200,5 @@ export function edit(note, prose, status) {
     }),
   });
   view.focus();
+  return { pull: () => run(pull) };
 }

{labnotes-0.0.55 → labnotes-0.0.56}/src/labnotes/templates/editor_imports.html

@@ -16,6 +16,7 @@
     "@lezer/python": "https://esm.sh/*@lezer/python@1.1.19",
     "@marijn/find-cluster-break": "https://esm.sh/*@marijn/find-cluster-break@1.0.4",
     "crelt": "https://esm.sh/*crelt@1.0.7",
+    "diff-match-patch": "https://esm.sh/*diff-match-patch@1.0.5",
     "style-mod": "https://esm.sh/*style-mod@4.1.4",
     "w3c-keyname": "https://esm.sh/*w3c-keyname@2.2.8"
   }

{labnotes-0.0.55 → labnotes-0.0.56}/src/labnotes/templates/experiment.html

@@ -37,7 +37,7 @@
 <nav class="tabs sub">
   {% for each in e.notes %}<a href="?tab=notebooks&amp;note={{ each.name | urlencode }}"{% if each.name == note.name %} aria-current="page"{% endif %}>{{ each.name }}</a>{% endfor %}
 </nav>
-<article class="note" data-run-url="{{ url_for('run_block', name=e.name, note=note.name) }}" data-restart-url="{{ url_for('restart_kernel', name=e.name, note=note.name) }}" data-save-url="{{ url_for('put_note', name=e.name, note=note.name) }}" data-editor="{{ asset('note-editor.js') }}">
+<article class="note" data-run-url="{{ url_for('run_block', name=e.name, note=note.name) }}" data-restart-url="{{ url_for('restart_kernel', name=e.name, note=note.name) }}" data-save-url="{{ url_for('put_note', name=e.name, note=note.name) }}" data-editor="{{ asset('note-editor.js') }}" data-changes-url="{{ url_for('changes', name=e.name) }}" data-note="{{ note.name }}">
   {% if note.runnable %}<header class="note-name"><button type="button" class="restart" title="Stop this note's Python kernel. The next Run starts a fresh one.">Restart</button></header>{% endif %}
   <p class="edit-status" role="status" hidden></p>
   <div class="prose">{{ note.html | safe }}</div>