@young1lin/dsh-ui-gitworkbench 0.1.0

package/lib/atomic-json.js

@@ -0,0 +1,48 @@
+/**
+ * Crash-safe JSON writes for this plugin's small state files under `~/.dsh`.
+ *
+ * IO is passed in rather than imported so the callers stay testable without a
+ * real filesystem, and so the one Windows-specific retry lives in a single place
+ * instead of once per state file.
+ */
+import { join } from 'node:path';
+/** Backoff before each rename retry, in ms. */
+const RENAME_RETRY_DELAYS = [25, 50, 100, 200, 400];
+/**
+ * @param ms - milliseconds to wait.
+ * @returns a promise resolving after that delay.
+ */
+function delay(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+/**
+ * Write a JSON value so a crash can never leave a truncated file behind.
+ *
+ * The value is staged into `<path>.tmp` and renamed over the destination, which
+ * is atomic within a filesystem. On Windows that rename fails with EPERM while
+ * another handle briefly holds the destination open (a concurrent read, an
+ * antivirus scan, the search indexer); those locks are short-lived, so the
+ * rename is retried with backoff before the error is surfaced.
+ * @param ensureDir - creates the containing directory, recursively.
+ * @param writeText - writes a file's whole text.
+ * @param rename - renames a path over another.
+ * @param path - destination path.
+ * @param value - JSON-serializable value.
+ * @throws whatever `rename` threw, once the retries are exhausted.
+ */
+export async function saveJsonAtomic(ensureDir, writeText, rename, path, value) {
+    await ensureDir(join(path, '..'));
+    const tmp = `${path}.tmp`;
+    await writeText(tmp, `${JSON.stringify(value, null, 2)}\n`);
+    for (let attempt = 0;; attempt++) {
+        try {
+            await rename(tmp, path);
+            return;
+        }
+        catch (error) {
+            if (attempt >= RENAME_RETRY_DELAYS.length)
+                throw error;
+            await delay(RENAME_RETRY_DELAYS[attempt]);
+        }
+    }
+}