@better-fs-tools/cloudflare-computer 0.1.0 → 0.2.0

package/README.md

@@ -26,15 +26,15 @@ export function computerReadTool(workspace: Workspace) {
 }
 ```
 
-With the write tools. `createFsTools()` from `@better-fs-tools/write` gives them and the read tool one store, one digest, and one lock manager. Its default digest, `sha256Digest()`, is plain JavaScript, so it runs in a Worker:
+With the write tools. `createFsTools()` from `@better-fs-tools/write` gives them and the read tool one digest and one lock manager, and one read store when you pass `state`. Its default digest, `sha256Digest()`, is plain JavaScript, so it runs in a Worker:
 
 ```ts
 import type { Workspace } from "@cloudflare/computer";
 import { cloudflareComputerFileSystem } from "@better-fs-tools/cloudflare-computer";
 import { createFsTools } from "@better-fs-tools/write";
 
-// One store, one sha256Digest(), and one lock manager. createFsTools needs no
-// Node module, so it runs in a Worker.
+// One sha256Digest() and one lock manager. createFsTools needs no Node module,
+// so it runs in a Worker.
 export function computerTools(workspace: Workspace) {
   const fs = cloudflareComputerFileSystem(workspace.fs, { allowedRoots: ["/workspace"] });
   const { read, edit, write } = createFsTools({ fs });
@@ -49,14 +49,14 @@ export function computerTools(workspace: Workspace) {
 - The filesystem exposes the resolved `cwd`, `allowedRoots`, `denyRoots`, `symlinks`, and `identity`.
 - It walks each path with `lstat` from `/`, so a symlink above the root, a symlinked root, parent, or file is refused before any byte is read.
 - It streams the file that `readFile` returns. `open()` starts the `readFile` stream, so the request reaches the backend before the read tool's `authorize` runs, but no chunk is read until `authorize` allows it. If a denied read must not reach the backend, deny it in the adapter with `denyRoots` or `allowedRoots`.
-- `verify()` compares size and modification time, so results have a `weak-identity` note.
+- `verify()` compares size and modification time.
 - `list()` lists directories, so suggestions and `directoryListing()` work.
 
 ## How it writes
 
 - `stat()`, `write()`, and `remove()` use `lstat`, `writeFile`, `mkdir`, and `rm`. They check the roots and refuse every symlink on the path before any write, as `open()` does.
 - `writeFile`, `mkdir`, and `rm` are optional in `CloudflareComputerFileSystemLike`. They are checked when a write runs, not when the filesystem is built. A read-only wrapper backs the read tool, and a write to it gives `unsupported`, which the tools report as `UNSUPPORTED_BACKEND`.
-- `writeCapabilities` is `{ atomic: true, compareAndSwap: false, preserveMode: true }`. `writeFile` runs in one transaction. It has no version check, so the adapter checks the precondition with a fresh `lstat` just before the write, and the write tools add a `no-compare-and-swap` note. A create passes `exclusive: true`, so two creators cannot both win.
+- `writeCapabilities` is `{ compareAndSwap: false }`. `writeFile` runs in one transaction, so a replace is atomic. It has no version check, so the adapter checks the precondition with a fresh `lstat` just before the write. A create passes `exclusive: true`, so two creators cannot both win.
 - `writeFile` sets the mode to `0o644` unless it gets one, also on a replace. The adapter passes the mode that `lstat` reported, so a replace keeps it. `stat()` reports the mode.
 - There is no `stage()`: Computer has no rename. `apply_patch` writes each file in turn, and undoes them on a failure.
 - The version is the size and the modification time in milliseconds. The write tools also compare the content hash of what the model read, so a same-size change after the read is still `STALE`.

package/dist/index.js

@@ -38,7 +38,7 @@ export function cloudflareComputerFileSystem(workspaceFs, options) {
     };
     return Object.freeze({
         id,
-        capabilities: Object.freeze({ streaming: true, identity: false }),
+        capabilities: Object.freeze({ identity: false }),
         paths: posixPaths,
         cwd,
         allowedRoots: roots.allowedRoots,

package/dist/write.js

@@ -1,9 +1,7 @@
 import { containsPosix } from "@better-fs-tools/fs";
 import { AdapterRefusal, authorize, boundedCode, pathsFromSlashToTarget, displayPath, inspect, mapBackendError, notAFile, refuse, toFileSystemError, } from "./policy.js";
 export const COMPUTER_WRITE_CAPABILITIES = Object.freeze({
-    atomic: true,
     compareAndSwap: false,
-    preserveMode: true,
 });
 export function computerVersion(entry) {
     return `computer:${entry.size}:${entry.mtime}`;
@@ -94,7 +92,6 @@ export function computerWrites(workspaceFs, roots) {
         identity: null,
         size: entry?.size ?? null,
         createdDirectories: created,
-        atomic: COMPUTER_WRITE_CAPABILITIES.atomic,
     });
     return {
         async stat(requested, options = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-fs-tools/cloudflare-computer",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A readable and writable filesystem over a Cloudflare Computer workspace (experimental).",
   "license": "MIT",
   "repository": {
@@ -29,11 +29,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@better-fs-tools/fs": "^0.1.0"
+    "@better-fs-tools/fs": "^0.2.0"
   },
   "devDependencies": {
-    "@better-fs-tools/read": "^0.1.0",
-    "@better-fs-tools/write": "^0.1.0",
+    "@better-fs-tools/read": "^0.2.0",
+    "@better-fs-tools/write": "^0.2.0",
     "@cloudflare/computer": "0.2.1"
   }
 }