refactor workspace reads to Effect FileSystem

Cursor Agent committed 3 months ago

Commit 217fbf11 parent ebe8afb2 files · +138 −118Browse files

Showing the changes to apps/server/src/workspace/WorkspaceFileSystem.test.ts (1 of 2 files). Show all

Unified · Split

apps/server/src/workspace/WorkspaceFileSystem.test.ts+51−29

 import * as NodeServices from "@effect/platform-node/NodeServices";
-import { it, describe, expect } from "@effect/vitest";
+import { assert, describe, it } from "@effect/vitest";
 import * as Effect from "effect/Effect";
 import * as FileSystem from "effect/FileSystem";
 import * as Layer from "effect/Layer";
+import * as Option from "effect/Option";
 import * as Path from "effect/Path";
+import * as PlatformError from "effect/PlatformError";
 import * as ServerConfig from "../config.ts";
 import * as VcsDriverRegistry from "../vcs/VcsDriverRegistry.ts";
           relativePath: "src/index.ts",
         });
-        expect(result).toEqual({
+        assert.deepStrictEqual(result, {
           relativePath: "src/index.ts",
           contents: "export const answer = 42;\n",
           byteLength: 26,
           .readFile({ cwd, relativePath: "../escape.md" })
           .pipe(Effect.flip);
-        expect(error.message).toContain(
+        assert.include(
+          error.message,
           "Workspace file path must be relative to the project root: ../escape.md",
         );
       }),
         const resolvedWorkspaceRoot = yield* fileSystem.realPath(cwd);
         const resolvedPath = yield* fileSystem.realPath(path.join(outsideDir, "secret.txt"));
-        expect(error).toBeInstanceOf(WorkspaceFileSystem.WorkspaceFilePathEscapeError);
+        assert.strictEqual(error._tag, "WorkspaceFilePathEscapeError");
-        expect(error).toMatchObject({
+        assert.deepInclude(error, {
           workspaceRoot: cwd,
           relativePath: "linked-secret.txt",
           resolvedWorkspaceRoot,
           resolvedPath,
         });
-        expect("cause" in error).toBe(false);
+        assert.notProperty(error, "cause");
       }),
     );
           .pipe(Effect.flip);
         const resolvedPath = yield* fileSystem.realPath(path.join(cwd, "src"));
-        expect(error).toBeInstanceOf(WorkspaceFileSystem.WorkspacePathNotFileError);
+        assert.strictEqual(error._tag, "WorkspacePathNotFileError");
-        expect(error).toMatchObject({
+        assert.deepInclude(error, {
           workspaceRoot: cwd,
           relativePath: "src",
           resolvedPath,
         });
-        expect("cause" in error).toBe(false);
+        assert.notProperty(error, "cause");
       }),
     );
           .pipe(Effect.flip);
         const resolvedPath = yield* fileSystem.realPath(absolutePath);
-        expect(error).toBeInstanceOf(WorkspaceFileSystem.WorkspaceBinaryFileError);
+        assert.strictEqual(error._tag, "WorkspaceBinaryFileError");
-        expect(error).toMatchObject({
+        assert.deepInclude(error, {
           workspaceRoot: cwd,
           relativePath: "asset.bin",
           resolvedPath,
         });
-        expect("cause" in error).toBe(false);
+        assert.notProperty(error, "cause");
-        expect("contents" in error).toBe(false);
+        assert.notProperty(error, "contents");
+      }),
+    );
+    it.effect("reads at most the preview limit", () =>
+      Effect.gen(function* () {
+        const workspaceFileSystem = yield* WorkspaceFileSystem.WorkspaceFileSystem;
+        const cwd = yield* makeTempDir;
+        yield* writeTextFile(cwd, "large.txt", "a".repeat(1024 * 1024 + 1));
+        const result = yield* workspaceFileSystem.readFile({
+          cwd,
+          relativePath: "large.txt",
+        });
+        assert.strictEqual(result.contents.length, 1024 * 1024);
+        assert.strictEqual(result.byteLength, 1024 * 1024 + 1);
+        assert.isTrue(result.truncated);
       }),
     );
           .readFile({ cwd, relativePath: "missing.txt" })
           .pipe(Effect.flip);
-        expect(error).toBeInstanceOf(WorkspaceFileSystem.WorkspaceFileSystemOperationError);
+        assert.strictEqual(error._tag, "WorkspaceFileSystemOperationError");
-        expect(error).toMatchObject({
+        assert.deepInclude(error, {
           workspaceRoot: cwd,
           relativePath: "missing.txt",
           resolvedPath,
           operationPath: resolvedPath,
           operation: "realpath-target",
         });
-        expect(error.cause).toBeInstanceOf(Error);
+        assert.instanceOf(error.cause, PlatformError.PlatformError);
-        expect((error.cause as NodeJS.ErrnoException).code).toBe("ENOENT");
+        assert.strictEqual(
+          (error.cause as PlatformError.PlatformError).reason._tag,
+          "NotFound",
+        );
       }),
     );
   });
           .readFileString(path.join(cwd, "plans/effect-rpc.md"))
           .pipe(Effect.orDie);
-        expect(result).toEqual({ relativePath: "plans/effect-rpc.md" });
+        assert.deepStrictEqual(result, { relativePath: "plans/effect-rpc.md" });
-        expect(saved).toBe("# Plan\n");
+        assert.strictEqual(saved, "# Plan\n");
       }),
     );
         yield* writeTextFile(cwd, "src/existing.ts", "export {};\n");
         const beforeWrite = yield* workspaceEntries.list({ cwd });
-        expect(beforeWrite.entries.some((entry) => entry.path === "plans/effect-rpc.md")).toBe(
+        assert.isFalse(
-          false,
+          beforeWrite.entries.some((entry) => entry.path === "plans/effect-rpc.md"),
         );
         yield* workspaceFileSystem.writeFile({
         });
         const afterWrite = yield* workspaceEntries.list({ cwd });
-        expect(afterWrite.entries).toEqual(
+        assert.isTrue(
-          expect.arrayContaining([expect.objectContaining({ path: "plans/effect-rpc.md" })]),
+          afterWrite.entries.some((entry) => entry.path === "plans/effect-rpc.md"),
         );
-        expect(afterWrite.truncated).toBe(false);
+        assert.isFalse(afterWrite.truncated);
       }),
     );
           })
           .pipe(Effect.flip);
-        expect(error.message).toContain(
+        assert.include(
+          error.message,
           "Workspace file path must be relative to the project root: ../escape.md",
         );
         const escapedPath = path.resolve(cwd, "..", "escape.md");
-        const escapedStat = yield* fileSystem
+        const escapedStat = yield* fileSystem.stat(escapedPath).pipe(Effect.option);
-          .stat(escapedPath)
+        assert.isTrue(Option.isNone(escapedStat));
-          .pipe(Effect.orElseSucceed(() => null));
-        expect(escapedStat).toBeNull();
       }),
     );
   });