@reventlessdev/reventless-seed 1.0.0-alpha.1 → 1.0.0-alpha.2

package/src/Seed_Prompt.res

@@ -0,0 +1,188 @@
+// 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
+// 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
+// instead of opening a second one just to suppress the echo.
+//
+// Node bindings are declared here as typed externals; this package is
+// stdlib-only, so no `%raw`.
+
+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}
+@module("node:readline") external createInterface: rlOptions => rl = "createInterface"
+@send external question: (rl, string, string => unit) => unit = "question"
+@send external closeRl: rl => unit = "close"
+@set external setWriteToOutput: (rl, string => unit) => unit = "_writeToOutput"
+
+// ── Shared interface ──────────────────────────────────────────────────────────
+
+// Created on first use, closed once via `close`. `muted` gates the echo so the
+// same interface serves both visible and hidden prompts.
+let rlRef: ref<option<rl>> = ref(None)
+let muted = ref(false)
+
+let iface = (): rl =>
+  switch rlRef.contents {
+  | Some(rl) => rl
+  | None =>
+    let rl = createInterface({input: stdin, output: stdout, terminal: true})
+    rl->setWriteToOutput(s =>
+      if !muted.contents {
+        stdout->writeStream(s)
+      }
+    )
+    rlRef := Some(rl)
+    rl
+  }
+
+let close = (): unit =>
+  switch rlRef.contents {
+  | Some(rl) =>
+    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
+    // never exits after seeding. Release it explicitly.
+    stdin->pauseStream
+    stdin->unrefStream
+  | None => ()
+  }
+
+// ── Env + TTY ─────────────────────────────────────────────────────────────────
+
+let envValue = (key: string): option<string> =>
+  switch processEnv->Dict.get(key) {
+  | Some(v) if v->String.trim != "" => Some(v->String.trim)
+  | _ => None
+  }
+
+let requireTty = (): unit =>
+  if !(stdin->isTTY) {
+    throw(
+      Failed(
+        "no TTY for an interactive prompt — set the documented SEED_* / REVENTLESS_DEMO_* " ++
+        "env vars to run non-interactively.",
+      ),
+    )
+  }
+
+// ── Prompts ───────────────────────────────────────────────────────────────────
+
+let ask = (query: string): promise<string> =>
+  Promise.make((resolve, _) => {
+    let rl = iface()
+    rl->question(query, answer => resolve(answer->String.trim))
+  })
+
+// Same interface, echo suppressed for the keystrokes. `question` writes the
+// prompt synchronously first (while unmuted), then muting is switched on so only
+// the typed characters are hidden — the canonical readline recipe, which keeps
+// the line editor's cursor state consistent (a manual write + empty `question`
+// left some terminals unable to read the next line).
+let askHidden = (query: string): promise<string> =>
+  Promise.make((resolve, _) => {
+    let rl = iface()
+    rl->question(query, answer => {
+      muted := false
+      stdout->writeStream("\n")
+      resolve(answer)
+    })
+    muted := true
+  })
+
+/**
+ * Chooses one of `options` (a label paired with the value it selects).
+ *
+ * Auto-returns when there is a single option, so a lone data set or stack needs
+ * no keypress. `env` (e.g. `SEED_SET`) preselects by matching label or 1-based
+ * index, so CI runs without a TTY. Otherwise it prints a numbered menu.
+ */
+let select = async (
+  ~title: string,
+  ~options: array<(string, 'a)>,
+  ~env=?,
+): 'a =>
+  switch options {
+  | [(_, only)] => only
+  | _ =>
+    let fromEnv =
+      env
+      ->Option.flatMap(envValue)
+      ->Option.flatMap(v =>
+        switch options->Array.findIndex(((label, _)) => label == v) {
+        | -1 =>
+          switch Int.fromString(v) {
+          | Some(n) if n >= 1 && n <= options->Array.length => options->Array.get(n - 1)
+          | _ => None
+          }
+        | i => options->Array.get(i)
+        }
+      )
+    switch fromEnv {
+    | Some((_, value)) => value
+    | None =>
+      requireTty()
+      Console.log("")
+      Console.log(title)
+      Console.log("")
+      options->Array.forEachWithIndex(((label, _), i) =>
+        Console.log(`  ${(i + 1)->Int.toString}) ${label}`)
+      )
+      let rec pick = async (): 'a => {
+        let answer = await ask(`\nSelect [1-${(options->Array.length)->Int.toString}]: `)
+        switch Int.fromString(answer) {
+        | Some(n) if n >= 1 && n <= options->Array.length =>
+          let (_, value) = options->Array.getUnsafe(n - 1)
+          value
+        | _ =>
+          Console.log("  Not a valid choice.")
+          await pick()
+        }
+      }
+      await pick()
+    }
+  }
+
+/**
+ * Prompts for a username (visible) and password (echo muted).
+ *
+ * `REVENTLESS_DEMO_USER` / `REVENTLESS_DEMO_PASSWORD` skip the prompts. With
+ * `localDefaults`, empty input falls back to `admin`/`admin` — the dev login.
+ */
+let credentials = async (~localDefaults: bool=false): (string, string) => {
+  let username = switch envValue("REVENTLESS_DEMO_USER") {
+  | Some(u) => u
+  | None =>
+    requireTty()
+    let entered = await ask(localDefaults ? "Username [admin]: " : "Username: ")
+    entered == "" && localDefaults ? "admin" : entered
+  }
+  let password = switch envValue("REVENTLESS_DEMO_PASSWORD") {
+  | Some(p) => p
+  | None =>
+    requireTty()
+    let entered = await askHidden(localDefaults ? "Password [admin]: " : "Password: ")
+    entered == "" && localDefaults ? "admin" : entered
+  }
+  if username == "" || password == "" {
+    throw(Failed("username and password are required."))
+  }
+  (username, password)
+}

package/src/Seed_Prompt.res.mjs

@@ -0,0 +1,172 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Stdlib_Int from "@rescript/runtime/lib/es6/Stdlib_Int.js";
+import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
+import * as Nodereadline from "node:readline";
+import * as Primitive_option from "@rescript/runtime/lib/es6/Primitive_option.js";
+import * as Seed_Types$ReventlessSeed from "./Seed_Types.res.mjs";
+
+let rlRef = {
+  contents: undefined
+};
+
+let muted = {
+  contents: false
+};
+
+function iface() {
+  let rl = rlRef.contents;
+  if (rl !== undefined) {
+    return Primitive_option.valFromOption(rl);
+  }
+  let rl$1 = Nodereadline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+    terminal: true
+  });
+  rl$1._writeToOutput = s => {
+    if (!muted.contents) {
+      process.stdout.write(s);
+      return;
+    }
+  };
+  rlRef.contents = Primitive_option.some(rl$1);
+  return rl$1;
+}
+
+function close() {
+  let rl = rlRef.contents;
+  if (rl !== undefined) {
+    Primitive_option.valFromOption(rl).close();
+    rlRef.contents = undefined;
+    process.stdin.pause();
+    process.stdin.unref();
+    return;
+  }
+}
+
+function envValue(key) {
+  let v = process.env[key];
+  if (v !== undefined && v.trim() !== "") {
+    return v.trim();
+  }
+}
+
+function requireTty() {
+  if (process.stdin.isTTY) {
+    return;
+  }
+  throw {
+    RE_EXN_ID: Seed_Types$ReventlessSeed.Failed,
+    _1: "no TTY for an interactive prompt — set the documented SEED_* / REVENTLESS_DEMO_* env vars to run non-interactively.",
+    Error: new Error()
+  };
+}
+
+function ask(query) {
+  return new Promise((resolve, param) => {
+    let rl = iface();
+    rl.question(query, answer => resolve(answer.trim()));
+  });
+}
+
+function askHidden(query) {
+  return new Promise((resolve, param) => {
+    let rl = iface();
+    rl.question(query, answer => {
+      muted.contents = false;
+      process.stdout.write("\n");
+      resolve(answer);
+    });
+    muted.contents = true;
+  });
+}
+
+async function select(title, options, env) {
+  if (options.length === 1) {
+    return options[0][1];
+  }
+  let fromEnv = Stdlib_Option.flatMap(Stdlib_Option.flatMap(env, envValue), v => {
+    let i = options.findIndex(param => param[0] === v);
+    if (i !== -1) {
+      return options[i];
+    }
+    let n = Stdlib_Int.fromString(v, undefined);
+    if (n !== undefined && n >= 1 && n <= options.length) {
+      return options[n - 1 | 0];
+    }
+  });
+  if (fromEnv !== undefined) {
+    return fromEnv[1];
+  }
+  requireTty();
+  console.log("");
+  console.log(title);
+  console.log("");
+  options.forEach((param, i) => {
+    console.log(`  ` + (i + 1 | 0).toString() + `) ` + param[0]);
+  });
+  let pick = async () => {
+    let answer = await ask(`\nSelect [1-` + options.length.toString() + `]: `);
+    let n = Stdlib_Int.fromString(answer, undefined);
+    if (n !== undefined) {
+      if (n >= 1 && n <= options.length) {
+        return options[n - 1 | 0][1];
+      } else {
+        console.log("  Not a valid choice.");
+        return await pick();
+      }
+    } else {
+      console.log("  Not a valid choice.");
+      return await pick();
+    }
+  };
+  return await pick();
+}
+
+async function credentials(localDefaultsOpt) {
+  let localDefaults = localDefaultsOpt !== undefined ? localDefaultsOpt : false;
+  let u = envValue("REVENTLESS_DEMO_USER");
+  let username;
+  if (u !== undefined) {
+    username = u;
+  } else {
+    requireTty();
+    let entered = await ask(localDefaults ? "Username [admin]: " : "Username: ");
+    username = entered === "" && localDefaults ? "admin" : entered;
+  }
+  let p = envValue("REVENTLESS_DEMO_PASSWORD");
+  let password;
+  if (p !== undefined) {
+    password = p;
+  } else {
+    requireTty();
+    let entered$1 = await askHidden(localDefaults ? "Password [admin]: " : "Password: ");
+    password = entered$1 === "" && localDefaults ? "admin" : entered$1;
+  }
+  if (username === "" || password === "") {
+    throw {
+      RE_EXN_ID: Seed_Types$ReventlessSeed.Failed,
+      _1: "username and password are required.",
+      Error: new Error()
+    };
+  }
+  return [
+    username,
+    password
+  ];
+}
+
+export {
+  rlRef,
+  muted,
+  iface,
+  close,
+  envValue,
+  requireTty,
+  ask,
+  askHidden,
+  select,
+  credentials,
+}
+/* node:readline Not a pure module */

package/src/Seed_Runner.res

@@ -95,7 +95,13 @@ let warn = (warnings: array<string>): unit =>
  * plainly that the store is now half-seeded — recovery is a reset, not a re-run.
  */
 let run = async (main: unit => promise<unit>): unit =>
-  try await main() catch {
+  try {
+    await main()
+    // 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)
+  } catch {
   | Failed(message) =>
     Console.error("")
     Console.error("Seeding aborted — the store is now half-seeded; re-run against a")
@@ -112,3 +118,82 @@ let run = async (main: unit => promise<unit>): unit =>
     )
     exit(1)
   }
+
+/**
+ * A named, seedable data set. `seed` owns everything domain-specific — the
+ * phases, `verifyViews`, the summary board — so the generic runner never sees
+ * domain detail. `label` is what the selection menu shows.
+ */
+type dataSet = {
+  name: string,
+  label: string,
+  seed: Seed_Connect.connection => promise<unit>,
+}
+
+/**
+ * A failure before any command is sent — bad data-set selection, an
+ * unreachable/undeployed target, a login failure. Nothing was written, so this
+ * says so plainly rather than warning about a half-seeded store (which would
+ * send the user resetting a store the run never touched).
+ */
+let abortStartup = (message: string): unit => {
+  Seed_Prompt.close()
+  Console.error("")
+  Console.error("Seeding did not start — nothing was written. Fix the cause below and re-run.")
+  Console.error("")
+  Console.error(message)
+  exit(1)
+}
+
+/**
+ * Top-level seed entry: choose a data set (auto when there is one, `SEED_SET`
+ * or a menu otherwise), connect, then hand the connection to the chosen set.
+ * Prompts are closed before seeding so the shared readline never lingers.
+ *
+ * Selection and connect run before any command is sent, so a failure there is
+ * reported as "did not start"; only failures inside the data set's own `seed`
+ * carry the half-seeded warning (via `run`).
+ */
+let seed = (~sets: array<dataSet>, ~connect: unit => promise<Seed_Connect.connection>): unit => {
+  let go = async () => {
+    let started = try {
+      let chosen = switch sets {
+      | [only] => only
+      | _ =>
+        switch Seed_Prompt.envValue("SEED_SET") {
+        | Some(wanted) =>
+          switch sets->Array.find(s => s.name == wanted) {
+          | Some(s) => s
+          | None =>
+            throw(
+              Failed(
+                `SEED_SET="${wanted}" matches no data set (have: ${sets
+                  ->Array.map(s => s.name)
+                  ->Array.join(", ")})`,
+              ),
+            )
+          }
+        | None =>
+          await Seed_Prompt.select(~title="Data set:", ~options=sets->Array.map(s => (s.label, s)))
+        }
+      }
+      let connection = await connect()
+      Seed_Prompt.close()
+      Some((chosen, connection))
+    } catch {
+    | Failed(message) =>
+      abortStartup(message)
+      None
+    | exn =>
+      abortStartup(exn->JsExn.fromException->Option.flatMap(JsExn.message)->Option.getOr("unknown"))
+      None
+    }
+    switch started {
+    | None => () // unreachable: abortStartup has already exited
+    | Some((chosen, connection)) =>
+      heading(`Seeding "${chosen.label}" into ${connection.label}`)
+      await run(() => chosen.seed(connection))
+    }
+  }
+  go()->ignore
+}

package/src/Seed_Runner.res.mjs

@@ -6,6 +6,7 @@ import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
 import * as Primitive_exceptions from "@rescript/runtime/lib/es6/Primitive_exceptions.js";
 import * as Seed_Types$ReventlessSeed from "./Seed_Types.res.mjs";
 import * as Seed_Client$ReventlessSeed from "./Seed_Client.res.mjs";
+import * as Seed_Prompt$ReventlessSeed from "./Seed_Prompt.res.mjs";
 
 function envOr(key, fallback) {
   return Stdlib_Option.getOr(process.env[key], fallback);
@@ -84,7 +85,9 @@ function warn(warnings) {
 
 async function run(main) {
   try {
-    return await main();
+    await main();
+    process.exit(0);
+    return;
   } catch (raw_message) {
     let message = Primitive_exceptions.internalToException(raw_message);
     if (message.RE_EXN_ID === Seed_Types$ReventlessSeed.Failed) {
@@ -105,6 +108,69 @@ async function run(main) {
   }
 }
 
+function abortStartup(message) {
+  Seed_Prompt$ReventlessSeed.close();
+  console.error("");
+  console.error("Seeding did not start — nothing was written. Fix the cause below and re-run.");
+  console.error("");
+  console.error(message);
+  process.exit(1);
+}
+
+function seed(sets, connect) {
+  let go = async () => {
+    let started;
+    try {
+      let chosen;
+      if (sets.length !== 1) {
+        let wanted = Seed_Prompt$ReventlessSeed.envValue("SEED_SET");
+        if (wanted !== undefined) {
+          let s = sets.find(s => s.name === wanted);
+          if (s !== undefined) {
+            chosen = s;
+          } else {
+            throw {
+              RE_EXN_ID: Seed_Types$ReventlessSeed.Failed,
+              _1: `SEED_SET="` + wanted + `" matches no data set (have: ` + sets.map(s => s.name).join(", ") + `)`,
+              Error: new Error()
+            };
+          }
+        } else {
+          chosen = await Seed_Prompt$ReventlessSeed.select("Data set:", sets.map(s => [
+            s.label,
+            s
+          ]), undefined);
+        }
+      } else {
+        chosen = sets[0];
+      }
+      let connection = await connect();
+      Seed_Prompt$ReventlessSeed.close();
+      started = [
+        chosen,
+        connection
+      ];
+    } catch (raw_message) {
+      let message = Primitive_exceptions.internalToException(raw_message);
+      if (message.RE_EXN_ID === Seed_Types$ReventlessSeed.Failed) {
+        abortStartup(message._1);
+        started = undefined;
+      } else {
+        abortStartup(Stdlib_Option.getOr(Stdlib_Option.flatMap(Stdlib_JsExn.fromException(message), Stdlib_JsExn.message), "unknown"));
+        started = undefined;
+      }
+    }
+    if (started === undefined) {
+      return;
+    }
+    let connection$1 = started[1];
+    let chosen$1 = started[0];
+    heading(`Seeding "` + chosen$1.label + `" into ` + connection$1.label);
+    return await run(() => chosen$1.seed(connection$1));
+  };
+  go();
+}
+
 export {
   envOr,
   report,
@@ -114,5 +180,7 @@ export {
   unfillableWarnings,
   warn,
   run,
+  abortStartup,
+  seed,
 }
 /* Stdlib_JsExn Not a pure module */