@reventlessdev/reventless-seed 1.0.0-alpha.4 → 1.0.0-alpha.6

package/lib/bs/tests/UploadEndpointResolutionTest.res.mjs

@@ -0,0 +1,59 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Seed_Upload$ReventlessSeed from "../src/Seed_Upload.res.mjs";
+
+function clearSkip() {
+  process.env["SEED_SKIP_UPLOADS"] = "";
+}
+
+let perStore = Object.fromEntries([
+  [
+    "Catalog.productImages",
+    "https://catalog.example/"
+  ],
+  [
+    "Ordering.invoices",
+    "https://ordering.example/"
+  ]
+]);
+
+globalThis.describe("Seed.Upload.endpointFor", () => {
+  globalThis.test("a declared store with a matching endpoint uses that store's endpoint", () => {
+    globalThis.expect(Seed_Upload$ReventlessSeed.endpointFor("Catalog.productImages", "https://legacy.example/", perStore)).toEqual("https://catalog.example/");
+  });
+  globalThis.test("a declared store with no matching endpoint falls back to the legacy service", () => {
+    globalThis.expect(Seed_Upload$ReventlessSeed.endpointFor("Catalog.brochures", "https://legacy.example/", perStore)).toEqual("https://legacy.example/");
+  });
+  globalThis.test("naming no store uses the legacy service", () => {
+    globalThis.expect(Seed_Upload$ReventlessSeed.endpointFor(undefined, "https://legacy.example/", perStore)).toEqual("https://legacy.example/");
+  });
+  globalThis.test("neither available resolves nothing", () => {
+    globalThis.expect(Seed_Upload$ReventlessSeed.endpointFor("Catalog.brochures", "", {})).toEqual(undefined);
+  });
+  globalThis.test("a single-route deployment serves a store-naming data set", () => {
+    globalThis.expect(Seed_Upload$ReventlessSeed.endpointFor("Catalog.productImages", "http://localhost:4000/__inmemory/upload", {})).toEqual("http://localhost:4000/__inmemory/upload");
+  });
+});
+
+globalThis.describe("Seed.Upload.unresolvedReason", () => {
+  globalThis.beforeEach(clearSkip);
+  globalThis.test("no endpoints at all reads as a fact about the deployment", () => {
+    globalThis.expect(Seed_Upload$ReventlessSeed.unresolvedReason("Catalog.productImages", {})).toBe("this deployment publishes no upload endpoint");
+  });
+  globalThis.test("an unmatched store names the store and the keys that were available", () => {
+    let msg = Seed_Upload$ReventlessSeed.unresolvedReason("Catalog.brochures", perStore);
+    globalThis.expect(msg).toContain("Catalog.brochures");
+    globalThis.expect(msg).toContain("Catalog.productImages");
+    globalThis.expect(msg).toContain("Ordering.invoices");
+  });
+  globalThis.test("the knob outranks both, so a skipped run is never read as a broken one", () => {
+    process.env["SEED_SKIP_UPLOADS"] = "1";
+    globalThis.expect(Seed_Upload$ReventlessSeed.unresolvedReason("Catalog.productImages", perStore)).toBe("SEED_SKIP_UPLOADS is set");
+  });
+});
+
+export {
+  clearSkip,
+  perStore,
+}
+/* perStore Not a pure module */

package/lib/ocaml/.compiler.log

@@ -1,2 +1,2 @@
-#Start(1785181007705)
-#Done(1785181012323)
+#Start(1785535393042)
+#Done(1785535393072)

package/lib/ocaml/ReventlessSeed.mlmap

@@ -7,3 +7,4 @@ Seed_Random
 Seed_Runner
 Seed_Types
 Seed_Upload
+UploadEndpointResolutionTest

package/lib/ocaml/Seed.res

@@ -14,11 +14,13 @@ module Connect = Seed_Connect
 
 exception Failed = Seed_Types.Failed
 
-// A live target a data set seeds against: an authenticated client, the upload
-// endpoint (empty when the deployment serves no uploads), and a label.
+// A live target a data set seeds against: an authenticated client, the
+// deployment's upload endpoints (the legacy single service and the per-store
+// map, either of which may be empty), and a label.
 type connection = Seed_Connect.connection = {
   client: Seed_Client.t,
   uploadEndpoint: string,
+  uploadEndpoints: dict<string>,
   label: string,
 }
 

package/lib/ocaml/Seed_Connect.res

@@ -1,15 +1,25 @@
 // Turns endpoints plus a login function into a ready `connection`.
 //
 // A connection is what a data set seeds against: an authenticated GraphQL
-// client, the upload endpoint (empty when the deployment serves no uploads), and
-// a human label for the target. `make` is provider-agnostic — it prompts for
+// client, the deployment's upload endpoints (empty when it serves no uploads),
+// and a human label for the target. `make` is provider-agnostic — it prompts for
 // credentials, calls the supplied `login` to obtain a bearer, and wires it onto
 // the client via `useToken`. Where the bearer comes from (a local `/login`
 // round-trip, a Cognito id token) is the caller's concern.
 
 open Seed_Types
 
-type connection = {client: Seed_Client.t, uploadEndpoint: string, label: string}
+// `uploadEndpoint` is the legacy single presign service (and the local dev
+// server's one upload route); `uploadEndpoints` maps the qualified
+// `{plugin}.{store}` of each declared store to its own presign endpoint. Both,
+// because a deployment may publish either or both — see `Seed_Upload.endpointFor`
+// for the resolution between them.
+type connection = {
+  client: Seed_Client.t,
+  uploadEndpoint: string,
+  uploadEndpoints: dict<string>,
+  label: string,
+}
 
 /**
  * Prompts for credentials, calls `login` to mint a bearer, and returns a
@@ -20,23 +30,47 @@ let make = async (
   ~label: string,
   ~endpoint: string,
   ~uploadEndpoint: string,
+  ~uploadEndpoints: dict<string>=Dict.make(),
   ~login: (~username: string, ~password: string) => promise<string>,
   ~localDefaults: bool=false,
 ): connection => {
-  // `SEED_SKIP_UPLOADS` forces the connection to carry no upload endpoint, so a
-  // data set's upload phase no-ops the same way it does when a deployment serves
-  // none. Use it to seed domain data fast, or to skip a broken/absent upload path
-  // without editing the data set. It is the single knob: an empty
-  // `REVENTLESS_UPLOAD_ENDPOINT` env reads as "unset" (falls back to discovery),
-  // so this is the reliable way to disable uploads.
-  let uploadEndpoint = Seed_Prompt.envValue("SEED_SKIP_UPLOADS")->Option.isSome ? "" : uploadEndpoint
+  // `SEED_SKIP_UPLOADS` forces the connection to carry no upload endpoint at
+  // all, so a data set's upload phase no-ops the same way it does when a
+  // deployment serves none. Use it to seed domain data fast, or to skip a
+  // broken/absent upload path without editing the data set. It is the single
+  // knob: an empty `REVENTLESS_UPLOAD_ENDPOINT` env reads as "unset" (falls back
+  // to discovery), so this is the reliable way to disable uploads — which means
+  // it has to clear the per-store map too, or a declared store keeps uploading
+  // through it.
+  let skip = Seed_Prompt.envValue("SEED_SKIP_UPLOADS")->Option.isSome
+  let uploadEndpoint = skip ? "" : uploadEndpoint
+  let uploadEndpoints = skip ? Dict.make() : uploadEndpoints
   let (username, password) = await Seed_Prompt.credentials(~localDefaults)
   let token = await login(~username, ~password)
   let client = Seed_Client.make(~config={endpoint: endpoint})
   client->Seed_Client.useToken(token)
-  {client, uploadEndpoint, label}
+  {client, uploadEndpoint, uploadEndpoints, label}
 }
 
+/**
+ * The endpoint an asset destined for `store` uploads through, or the reason
+ * there is none — the message to report when the upload phase skips.
+ *
+ * `store` is the qualified `{plugin}.{store}` the asset's field declares, e.g.
+ * `"Catalog.productImages"`. Resolution is `Seed_Upload.endpointFor`; naming a
+ * store the deployment does not serve falls back to the legacy single service
+ * rather than to another store's endpoint.
+ */
+let uploadEndpointFor = (c: connection, ~store: string): result<string, string> =>
+  switch Seed_Upload.endpointFor(
+    ~store,
+    ~uploadEndpoint=c.uploadEndpoint,
+    ~uploadEndpoints=c.uploadEndpoints,
+  ) {
+  | Some(endpoint) => Ok(endpoint)
+  | None => Error(Seed_Upload.unresolvedReason(~store, ~uploadEndpoints=c.uploadEndpoints))
+  }
+
 /**
  * A login function backed by an HTTP login endpoint (the local dev
  * `/__inmemory/login` shape: POST `{username, password}` → `{token}`). Reuses
@@ -63,6 +97,10 @@ let envOr = (key: string, fallback: string): string =>
  * A ready `connect` thunk for the local dev platform, with the localhost
  * defaults baked in and overridable per endpoint (arg, then env var, then
  * default). Empty input at the credential prompt falls back to `admin`/`admin`.
+ *
+ * No per-store map: the local dev server serves every store through its one
+ * upload route, so a data set naming a store resolves to that route by the
+ * "declares a store with no matching endpoint" row.
  */
 let local = (~graphql=?, ~upload=?, ~login=?, ()): (unit => promise<connection>) => {
   let endpoint =

package/lib/ocaml/Seed_Prompt.res

@@ -1,7 +1,7 @@
 // One shared readline interface for every interactive prompt in a seed run.
 //
 // The reason this module exists: creating and closing a fresh `readline`
-// interface per prompt leaves stdin paused after the first `close`, so the
+// interface per prompt leaves NodeProcess.stdin paused after the first `close`, so the
 // second prompt (password after username) never fires and the run hangs. A
 // single interface, created lazily and closed exactly once, avoids that — and a
 // `muted` gate on its output lets password entry reuse the same interface
@@ -14,18 +14,8 @@ open Seed_Types
 
 // ── Node bindings ─────────────────────────────────────────────────────────────
 
-type stream
-@val @scope("process") external stdin: stream = "stdin"
-@val @scope("process") external stdout: stream = "stdout"
-@send external writeStream: (stream, string) => unit = "write"
-@get external isTTY: stream => bool = "isTTY"
-@send external pauseStream: stream => unit = "pause"
-@send external unrefStream: stream => unit = "unref"
-
-@scope("process") @val external processEnv: dict<string> = "env"
-
 type rl
-type rlOptions = {input: stream, output: stream, terminal?: bool}
+type rlOptions = {input: NodeProcess.stream, output: NodeProcess.stream, terminal?: bool}
 @module("node:readline") external createInterface: rlOptions => rl = "createInterface"
 @send external question: (rl, string, string => unit) => unit = "question"
 @send external closeRl: rl => unit = "close"
@@ -42,10 +32,10 @@ let iface = (): rl =>
   switch rlRef.contents {
   | Some(rl) => rl
   | None =>
-    let rl = createInterface({input: stdin, output: stdout, terminal: true})
+    let rl = createInterface({input: NodeProcess.stdin, output: NodeProcess.stdout, terminal: true})
     rl->setWriteToOutput(s =>
       if !muted.contents {
-        stdout->writeStream(s)
+        NodeProcess.stdout->NodeProcess.write(s)
       }
     )
     rlRef := Some(rl)
@@ -58,23 +48,23 @@ let close = (): unit =>
     rl->closeRl
     rlRef := None
     // Closing the interface is not enough: a terminal-mode readline leaves
-    // stdin resumed and reffed, which keeps the event loop alive so the CLI
+    // NodeProcess.stdin resumed and reffed, which keeps the event loop alive so the CLI
     // never exits after seeding. Release it explicitly.
-    stdin->pauseStream
-    stdin->unrefStream
+    NodeProcess.stdin->NodeProcess.pause
+    NodeProcess.stdin->NodeProcess.unref
   | None => ()
   }
 
 // ── Env + TTY ─────────────────────────────────────────────────────────────────
 
 let envValue = (key: string): option<string> =>
-  switch processEnv->Dict.get(key) {
+  switch NodeProcess.env->Dict.get(key) {
   | Some(v) if v->String.trim != "" => Some(v->String.trim)
   | _ => None
   }
 
 let requireTty = (): unit =>
-  if !(stdin->isTTY) {
+  if !(NodeProcess.stdin->NodeProcess.isTTY->Option.getOr(false)) {
     throw(
       Failed(
         "no TTY for an interactive prompt — set the documented SEED_* / REVENTLESS_DEMO_* " ++
@@ -101,7 +91,7 @@ let askHidden = (query: string): promise<string> =>
     let rl = iface()
     rl->question(query, answer => {
       muted := false
-      stdout->writeStream("\n")
+      NodeProcess.stdout->NodeProcess.write("\n")
       resolve(answer)
     })
     muted := true

package/lib/ocaml/Seed_Runner.res

@@ -2,11 +2,9 @@
 
 open Seed_Types
 
-@scope("process") @val external exit: int => unit = "exit"
-@scope("process") @val external env: dict<string> = "env"
 
 let envOr = (key: string, fallback: string): string =>
-  env->Dict.get(key)->Option.getOr(fallback)
+  NodeProcess.env->Dict.get(key)->Option.getOr(fallback)
 
 /** One line of progress per phase, so a slow run never looks hung. */
 let report = (line: string): unit => Console.log(`  ${line}`)
@@ -127,7 +125,7 @@ let run = async (main: unit => promise<unit>): unit =>
     // Exit cleanly: HTTP keep-alive sockets (and, on the interactive path, the
     // readline/stdin handle) can otherwise keep the event loop alive so the CLI
     // appears to hang after a successful run.
-    exit(0)
+    NodeProcess.exit(0)
   } catch {
   | Failed(message) =>
     Console.error("")
@@ -135,7 +133,7 @@ let run = async (main: unit => promise<unit>): unit =>
     Console.error("fresh store once the cause below is fixed.")
     Console.error("")
     Console.error(message)
-    exit(1)
+    NodeProcess.exit(1)
   | exn =>
     Console.error("")
     Console.error("Seeding aborted with an unexpected error:")
@@ -143,7 +141,7 @@ let run = async (main: unit => promise<unit>): unit =>
     Console.error(
       exn->JsExn.fromException->Option.flatMap(JsExn.message)->Option.getOr("unknown"),
     )
-    exit(1)
+    NodeProcess.exit(1)
   }
 
 /**
@@ -172,7 +170,7 @@ let abortStartup = (message: string): unit => {
   Console.error("Seeding did not start — nothing was written. Fix the cause below and re-run.")
   Console.error("")
   Console.error(message)
-  exit(1)
+  NodeProcess.exit(1)
 }
 
 /**

package/lib/ocaml/Seed_Upload.res

@@ -10,6 +10,11 @@
 // absolute URL against the endpoint's origin: AWS returns an absolute presigned
 // S3 URL (unchanged), while the local route returns a same-origin relative
 // `/{prefix}/{key}` that Node's `fetch` cannot PUT to until it is made absolute.
+//
+// `uploadAsset` is the transport and takes a resolved endpoint. *Which* endpoint
+// an asset uses — a deployment now publishes one per declared store — is
+// `endpointFor` below, kept separate so the decision is testable without a
+// running presign service.
 
 type fetchInit = {method: string, headers: dict<string>, body: string}
 type response
@@ -38,6 +43,60 @@ let asString = (json: JSON.t): option<string> =>
   | _ => None
   }
 
+/**
+ * Which endpoint an asset destined for `store` uploads through:
+ *
+ *   declares a store with a matching endpoint  → that store's endpoint
+ *   declares a store with no matching endpoint → the legacy single service
+ *   declares no store                          → the legacy single service
+ *   neither available                          → `None`
+ *
+ * `store` is the qualified `{plugin}.{store}` the platform keys its per-store
+ * presign endpoints by. The two middle rows are what keep a deployment predating
+ * per-store endpoints — and the local dev server, which serves one upload route
+ * — working unchanged.
+ *
+ * These are the same four rows the AutoUI renderer resolves an upload field by.
+ * Resolving one declaration by two different rules is how an asset lands in
+ * another plugin's bucket with a 2xx and a plausible-looking ref, so a missing
+ * key falls back to the legacy service rather than to some other store.
+ */
+let endpointFor = (
+  ~store: option<string>=?,
+  ~uploadEndpoint: string,
+  ~uploadEndpoints: dict<string>,
+): option<string> => {
+  let legacy = uploadEndpoint == "" ? None : Some(uploadEndpoint)
+  switch store {
+  | Some(s) => uploadEndpoints->Dict.get(s)->Option.orElse(legacy)
+  | None => legacy
+  }
+}
+
+/**
+ * Why `endpointFor` resolved nothing — the message a data set reports when its
+ * upload phase skips.
+ *
+ * "no upload endpoint" states a fact about the *deployment*; when the deployment
+ * publishes endpoints the caller could not match, the fact is about the *client*
+ * and that phrasing sends a reader to the bucket, the presign service and the
+ * IAM policy, all of which are correct. So the three cases are distinguished and
+ * the unmatched one names both the store it wanted and the keys it saw.
+ */
+let unresolvedReason = (~store: option<string>=?, ~uploadEndpoints: dict<string>): string => {
+  let available = uploadEndpoints->Dict.keysToArray
+  switch (Seed_Prompt.envValue("SEED_SKIP_UPLOADS"), store, available) {
+  | (Some(_), _, _) => "SEED_SKIP_UPLOADS is set"
+  | (None, _, []) => "this deployment publishes no upload endpoint"
+  | (None, Some(s), keys) =>
+    `this deployment publishes upload endpoints for ${keys->Array.join(", ")}, none for "${s}"`
+  | (None, None, keys) =>
+    `this deployment publishes only per-store upload endpoints (${keys->Array.join(
+        ", ",
+      )}) and this upload names no store`
+  }
+}
+
 // A `fetch` that reports an unreachable endpoint as `Error` instead of throwing,
 // so the two-step upload can thread failures without exceptions.
 let tryFetch = async (url: string, init: fetchInit): result<response, string> =>

package/lib/ocaml/UploadEndpointResolutionTest.res

@@ -0,0 +1,100 @@
+// Which endpoint an asset uploads through once a deployment publishes one per
+// declared store, and what a data set is told when none resolves.
+//
+// The four rows are the same ones the AutoUI renderer resolves an upload field
+// by. They are pinned here because the two middle ones are what keep a
+// deployment predating per-store endpoints — and the local dev server, which
+// serves a single upload route — working unchanged, and because the row that
+// falls back to the legacy service must never fall back to *another store*: that
+// uploads into a different plugin's bucket with a 2xx and a plausible ref.
+
+open JestGlobals
+
+
+// `unresolvedReason` reads the knob, so the ambient environment has to be quiet.
+let clearSkip = () => NodeProcess.env->Dict.set("SEED_SKIP_UPLOADS", "")
+
+let perStore = Dict.fromArray([
+  ("Catalog.productImages", "https://catalog.example/"),
+  ("Ordering.invoices", "https://ordering.example/"),
+])
+
+describe("Seed.Upload.endpointFor", () => {
+  testSync("a declared store with a matching endpoint uses that store's endpoint", () =>
+    expect(
+      Seed.Upload.endpointFor(
+        ~store="Catalog.productImages",
+        ~uploadEndpoint="https://legacy.example/",
+        ~uploadEndpoints=perStore,
+      ),
+    )->toEqual(Some("https://catalog.example/"))
+  )
+
+  // Not "https://ordering.example/" — a wrong guess here is a silent
+  // wrong-bucket write.
+  testSync("a declared store with no matching endpoint falls back to the legacy service", () =>
+    expect(
+      Seed.Upload.endpointFor(
+        ~store="Catalog.brochures",
+        ~uploadEndpoint="https://legacy.example/",
+        ~uploadEndpoints=perStore,
+      ),
+    )->toEqual(Some("https://legacy.example/"))
+  )
+
+  testSync("naming no store uses the legacy service", () =>
+    expect(
+      Seed.Upload.endpointFor(~uploadEndpoint="https://legacy.example/", ~uploadEndpoints=perStore),
+    )->toEqual(Some("https://legacy.example/"))
+  )
+
+  testSync("neither available resolves nothing", () =>
+    expect(
+      Seed.Upload.endpointFor(
+        ~store="Catalog.brochures",
+        ~uploadEndpoint="",
+        ~uploadEndpoints=Dict.make(),
+      ),
+    )->toEqual(None)
+  )
+
+  // The local dev server's shape: one upload route, no per-store map, and a data
+  // set that names its store all the same.
+  testSync("a single-route deployment serves a store-naming data set", () =>
+    expect(
+      Seed.Upload.endpointFor(
+        ~store="Catalog.productImages",
+        ~uploadEndpoint="http://localhost:4000/__inmemory/upload",
+        ~uploadEndpoints=Dict.make(),
+      ),
+    )->toEqual(Some("http://localhost:4000/__inmemory/upload"))
+  )
+})
+
+// "no upload endpoint" states a fact about the deployment. When the deployment
+// publishes endpoints the caller could not match, the fact is about the client,
+// and that phrasing sends a reader to the bucket, the presign service and the
+// IAM policy — all of which are correct.
+describe("Seed.Upload.unresolvedReason", () => {
+  beforeEach(clearSkip)
+
+  testSync("no endpoints at all reads as a fact about the deployment", () =>
+    expect(
+      Seed.Upload.unresolvedReason(~store="Catalog.productImages", ~uploadEndpoints=Dict.make()),
+    )->toBe("this deployment publishes no upload endpoint")
+  )
+
+  testSync("an unmatched store names the store and the keys that were available", () => {
+    let msg = Seed.Upload.unresolvedReason(~store="Catalog.brochures", ~uploadEndpoints=perStore)
+    expect(msg)->toContain("Catalog.brochures")
+    expect(msg)->toContain("Catalog.productImages")
+    expect(msg)->toContain("Ordering.invoices")
+  })
+
+  testSync("the knob outranks both, so a skipped run is never read as a broken one", () => {
+    NodeProcess.env->Dict.set("SEED_SKIP_UPLOADS", "1")
+    expect(
+      Seed.Upload.unresolvedReason(~store="Catalog.productImages", ~uploadEndpoints=perStore),
+    )->toBe("SEED_SKIP_UPLOADS is set")
+  })
+})

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@reventlessdev/reventless-seed",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-alpha.6",
   "description": "Reusable harness for seeding a Reventless platform through its public GraphQL command API",
   "license": "Apache-2.0",
+  "dependencies": {
+    "@reventlessdev/rescript-node": "2.0.0-alpha.0"
+  },
   "devDependencies": {
-    "rescript": "12.3.0"
+    "rescript": "12.3.0",
+    "@reventlessdev/rescript-jest": "1.0.0-alpha.10"
   },
   "peerDependencies": {
     "rescript": "12.3.0"

package/rescript.json

@@ -12,9 +12,17 @@
     {
       "dir": "src",
       "subdirs": true
+    },
+    {
+      "dir": "tests",
+      "subdirs": true,
+      "type": "dev"
     }
   ],
-  "dependencies": [],
+  "dependencies": [
+    "@reventlessdev/rescript-node",
+    "@reventlessdev/rescript-jest"
+  ],
   "compiler-flags": [],
   "suffix": ".res.mjs"
 }

package/src/Seed.res

@@ -14,11 +14,13 @@ module Connect = Seed_Connect
 
 exception Failed = Seed_Types.Failed
 
-// A live target a data set seeds against: an authenticated client, the upload
-// endpoint (empty when the deployment serves no uploads), and a label.
+// A live target a data set seeds against: an authenticated client, the
+// deployment's upload endpoints (the legacy single service and the per-store
+// map, either of which may be empty), and a label.
 type connection = Seed_Connect.connection = {
   client: Seed_Client.t,
   uploadEndpoint: string,
+  uploadEndpoints: dict<string>,
   label: string,
 }