@gjermundgaraba/effect-actions 0.12.0 → 0.13.0

package/examples/notes-service/test/commands.test.ts

@@ -1,12 +1,23 @@
 import { NodeServices } from "@effect/platform-node";
 import { describe, expect, it } from "@effect/vitest";
-import { ConfigProvider, Effect, FileSystem, Layer, Schema, Stdio, Stream } from "effect";
+import {
+  Arbitrary,
+  ConfigProvider,
+  Effect,
+  FileSystem,
+  Layer,
+  Schema,
+  Stdio,
+  Stream,
+} from "effect";
 import { CliError, Command } from "effect/cli";
 import { HttpClient, HttpClientRequest } from "effect/http";
 import { TestConsole } from "effect/testing";
+import * as ActionHttp from "@gjermundgaraba/effect-actions/ActionHttp";
 import * as Testing from "@gjermundgaraba/effect-actions/Testing";
+import { Http } from "../src/Api.js";
 import { commands, connection } from "../src/commands.js";
-import { Note, NoteNotFound } from "../src/notes/Notes.js";
+import { ImportNotes, Note, NoteNotFound } from "../src/notes/Notes.js";
 import { NoteStore } from "../src/notes/store.js";
 import { routes } from "../src/routes.js";
 
@@ -42,6 +53,39 @@ const connected = (environment: Record<string, string>, args: ReadonlyArray<stri
     Effect.provide(NodeServices.layer),
   );
 
+const fitsAFile = (text: string) =>
+  new TextDecoder().decode(new TextEncoder().encode(text)) === text;
+
+// Lines a random string almost never holds, each one the format has to keep apart from a title.
+const trickyLines = Arbitrary.array(
+  Arbitrary.schema(
+    Schema.Literals([
+      "",
+      "# A heading",
+      "\\# Escaped",
+      "\\\\# Twice",
+      "#tag",
+      "\r# After a carriage return",
+      "\u2028# After a line separator",
+    ]),
+  ),
+);
+
+const importable = Arbitrary.all([
+  Arbitrary.schema(ImportNotes.input),
+  Arbitrary.array(trickyLines),
+]).pipe(
+  Arbitrary.map(([{ notes }, extra]) =>
+    notes.map(({ title, body }, place) => ({
+      title,
+      body: [body, ...(extra[place] ?? [])].join("\n"),
+    })),
+  ),
+  Arbitrary.filter((notes) =>
+    notes.every(({ title, body }) => fitsAFile(title) && fitsAFile(body)),
+  ),
+);
+
 describe("the commands", () => {
   it.effect("take an argument, a flag and stdin, and print what `render` returns", () =>
     Effect.gen(function* () {
@@ -82,6 +126,116 @@ describe("the commands", () => {
     }).pipe(Effect.provide(served), Effect.provide(NodeServices.layer)),
   );
 
+  it.effect("import a file `export` wrote with one call, all its notes or none", () =>
+    Effect.gen(function* () {
+      const files = yield* FileSystem.FileSystem;
+      const directory = yield* files.makeTempDirectoryScoped();
+      const file = `${directory}/notes.md`;
+
+      yield* files.writeFileString(file, "# Plan\n\nFirst draft\n\n# Budget\n\nToo small");
+
+      expect(yield* run("ada", ["import", file])).toEqual(["Created 2 notes"]);
+      expect(yield* run("grace", ["import", file])).toEqual(["Created 2 notes"]);
+
+      yield* files.writeFileString(`${directory}/untitled.md`, "# Plan\n\nKept?\n\n# \n\nNo title");
+
+      const refused = yield* Effect.flip(run("ada", ["import", `${directory}/untitled.md`]));
+
+      expect(refused).toHaveProperty(
+        "userMessage",
+        expect.stringContaining("A note needs a title."),
+      );
+      const [listed = ""] = yield* run("ada", ["list-notes"]);
+
+      const { notes } = yield* Schema.decodeUnknownEffect(
+        Schema.fromJsonString(
+          Schema.Struct({ notes: Schema.Array(Schema.Struct({ title: Schema.String })) }),
+        ),
+      )(listed);
+
+      expect(notes.map(({ title }) => title)).toEqual(["Plan", "Budget"]);
+
+      // A missing file is a usage error: the command's help, and the file named on stderr.
+      yield* Effect.flip(run("ada", ["import", `${directory}/nowhere.md`]));
+
+      expect(yield* TestConsole.errorLines).toContainEqual(
+        expect.stringMatching(
+          /Invalid value for argument <file>: .*nowhere\.md.*File does not exist/su,
+        ),
+      );
+    }).pipe(Effect.provide(served), Effect.provide(NodeServices.layer)),
+  );
+
+  // Any notes the contract accepts, generated from its schema, with lines that start as a title
+  // would added to their bodies. A file holds Unicode text, so a string JSON carries but no file
+  // can, one with a lone surrogate, is left out.
+  it.effect.prop(
+    "import every note `export` wrote as it was, whatever its body holds",
+    [importable],
+    ([notes]) =>
+      Effect.gen(function* () {
+        const files = yield* FileSystem.FileSystem;
+        const file = `${yield* files.makeTempDirectoryScoped()}/notes.md`;
+
+        const as = (token: string) =>
+          ActionHttp.client(Http).pipe(
+            Effect.updateService(
+              HttpClient.HttpClient,
+              HttpClient.mapRequest(HttpClientRequest.bearerToken(token)),
+            ),
+          );
+
+        const [ada, grace] = [yield* as("ada"), yield* as("grace")];
+
+        yield* ada.importNotes({ notes });
+        yield* run("ada", ["export", file]);
+        yield* run("grace", ["import", file]);
+
+        const { notes: listed } = yield* grace.listNotes();
+        const read = yield* Effect.forEach(listed, ({ id }) => grace.getNote({ id }));
+
+        expect(read.map(({ title, body }) => ({ title, body }))).toEqual(notes);
+      }).pipe(Effect.provide(served), Effect.provide(NodeServices.layer)),
+    { arbitrary: { runs: 50 } },
+  );
+
+  it.effect(
+    "import an empty file as no notes, and refuse one `export` did not write or too long",
+    () =>
+      Effect.gen(function* () {
+        const files = yield* FileSystem.FileSystem;
+        const directory = yield* files.makeTempDirectoryScoped();
+
+        yield* files.writeFileString(`${directory}/empty.md`, "");
+
+        expect(yield* run("grace", ["import", `${directory}/empty.md`])).toEqual([
+          "Created 0 notes",
+        ]);
+
+        yield* files.writeFileString(`${directory}/preamble.md`, "My notes\n\n# Plan\n\nDraft");
+
+        expect(
+          yield* Effect.flip(run("grace", ["import", `${directory}/preamble.md`])),
+        ).toHaveProperty(
+          "userMessage",
+          "The file does not start with a `# ` title, as `notes export` writes one.",
+        );
+
+        const many = Array.from({ length: 101 }, (_, place) => `# Note ${place}\n\nBody`);
+
+        yield* files.writeFileString(`${directory}/many.md`, many.join("\n\n"));
+
+        expect(yield* Effect.flip(run("grace", ["import", `${directory}/many.md`]))).toHaveProperty(
+          "userMessage",
+          expect.stringContaining("An import holds at most 100 notes."),
+        );
+
+        expect(yield* run("grace", ["list-notes"])).toEqual([
+          JSON.stringify({ notes: [] }, null, 2),
+        ]);
+      }).pipe(Effect.provide(served), Effect.provide(NodeServices.layer)),
+  );
+
   it.effect("fail as the server refuses, a command of their own included", () =>
     Effect.gen(function* () {
       const refused = yield* Effect.flip(run("mallory", ["export", "notes.md"]));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gjermundgaraba/effect-actions",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Define Effect action contracts once and project them onto HTTP, MCP, Effect RPC, native Toolkits, and CLIs.",
   "keywords": [
     "ai-agents",
@@ -49,11 +49,11 @@
     "access": "public"
   },
   "devDependencies": {
-    "@effect/platform-node": "4.0.2",
-    "@effect/vitest": "4.0.2",
+    "@effect/platform-node": "4.0.3",
+    "@effect/vitest": "4.0.3",
     "@modelcontextprotocol/client": "2.3.1",
     "@types/node": "26.6.4",
-    "effect": "4.0.2",
+    "effect": "4.0.3",
     "tsx": "4.23.15",
     "typescript": "7.0.2",
     "vite": "npm:@voidzero-dev/vite-plus-core@1.1.0",
@@ -61,7 +61,7 @@
     "vitest": "5.0.3"
   },
   "peerDependencies": {
-    "effect": "~4.0.2"
+    "effect": "~4.0.3"
   },
   "devEngines": {
     "packageManager": {