@reventlessdev/reventless-seed 1.0.0-alpha.16 → 1.0.0-alpha.18

package/src/Seed_Client.res.mjs

@@ -1,5 +1,6 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
+import * as Stdlib_JSON from "@rescript/runtime/lib/es6/Stdlib_JSON.js";
 import * as Stdlib_Array from "@rescript/runtime/lib/es6/Stdlib_Array.js";
 import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
 import * as Seed_Types$ReventlessSeed from "./Seed_Types.res.mjs";
@@ -98,6 +99,32 @@ async function login(t) {
   t.token = Stdlib_Option.flatMap(field(json, "token"), asString);
 }
 
+let transientErrorTypes = [
+  "InternalFailure",
+  "ServiceUnavailable",
+  "ServiceUnavailableError",
+  "Throttling",
+  "ThrottlingException",
+  "TooManyRequestsException",
+  "RequestTimeout"
+];
+
+function isTransient(errors) {
+  let entries = Stdlib_JSON.Decode.array(errors);
+  if (entries !== undefined && entries.length !== 0) {
+    return entries.every(e => {
+      let errorType = nodeString(e, "errorType");
+      if (errorType !== undefined) {
+        return transientErrorTypes.includes(errorType);
+      } else {
+        return false;
+      }
+    });
+  } else {
+    return false;
+  }
+}
+
 async function gql(t, query, label) {
   let headers = Object.fromEntries([[
       "content-type",
@@ -111,30 +138,38 @@ async function gql(t, query, label) {
       "query",
       query
     ]]));
-  let res;
-  try {
-    res = await fetch(t.config.endpoint, {
-      method: "POST",
-      headers: headers,
-      body: body
-    });
-  } catch (exn) {
-    throw {
-      RE_EXN_ID: Seed_Types$ReventlessSeed.Failed,
-      _1: label + `: cannot reach ` + t.config.endpoint + ` — is the platform running?`,
-      Error: new Error()
-    };
-  }
-  let json = await res.json();
-  let errors = field(json, "errors");
-  if (errors !== undefined) {
+  let attempt = async n => {
+    let res;
+    try {
+      res = await fetch(t.config.endpoint, {
+        method: "POST",
+        headers: headers,
+        body: body
+      });
+    } catch (exn) {
+      throw {
+        RE_EXN_ID: Seed_Types$ReventlessSeed.Failed,
+        _1: label + `: cannot reach ` + t.config.endpoint + ` — is the platform running?`,
+        Error: new Error()
+      };
+    }
+    let json = await res.json();
+    let errors = field(json, "errors");
+    if (errors === undefined) {
+      return Stdlib_Option.getOr(field(json, "data"), null);
+    }
+    if (isTransient(errors) && n < 4) {
+      await sleep((250 * (1 << (n - 1 | 0)) | 0) + (Math.random() * 250 | 0) | 0);
+      return await attempt(n + 1 | 0);
+    }
+    let tried = n > 1 ? `\n  gave up after ` + n.toString() + ` attempts` : "";
     throw {
       RE_EXN_ID: Seed_Types$ReventlessSeed.Failed,
-      _1: label + ` failed\n  query: ` + query + `\n  response: ` + JSON.stringify(errors),
+      _1: label + ` failed\n  query: ` + query + `\n  response: ` + JSON.stringify(errors) + tried,
       Error: new Error()
     };
-  }
-  return Stdlib_Option.getOr(field(json, "data"), null);
+  };
+  return await attempt(1);
 }
 
 let commandResultSelection = `__typename
@@ -269,6 +304,8 @@ async function waitForIds(t, fieldName, ids, timeoutMsOpt) {
   return Stdlib_Option.getOr(result, 0);
 }
 
+let attempts = 4;
+
 export {
   sleep,
   make,
@@ -279,6 +316,9 @@ export {
   asString,
   nodeString,
   login,
+  transientErrorTypes,
+  isTransient,
+  attempts,
   gql,
   commandResultSelection,
   send,

package/src/Seed_Prompt.res

@@ -121,11 +121,15 @@ let isAffirmative = (answer: string): bool =>
  * 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.
+ *
+ * `defaultIndex` makes Enter a valid answer, selecting that 0-based option;
+ * without one every reply must name a choice.
  */
 let select = async (
   ~title: string,
   ~options: array<(string, 'a)>,
   ~env=?,
+  ~defaultIndex=?,
 ): 'a =>
   switch options {
   | [(_, only)] => only
@@ -153,29 +157,38 @@ let select = async (
       options->Array.forEachWithIndex(((label, _), i) =>
         Console.log(`  ${(i + 1)->Int.toString}) ${label}`)
       )
+      let fallback = defaultIndex->Option.flatMap(i => options->Array.get(i))
+      let hint = switch (defaultIndex, fallback) {
+      | (Some(i), Some(_)) => ` (default ${(i + 1)->Int.toString})`
+      | _ => ""
+      }
       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
+        let answer = await ask(
+          `\nSelect [1-${(options->Array.length)->Int.toString}]${hint}: `,
+        )
+        switch (answer, fallback) {
+        | ("", Some((_, value))) => value
         | _ =>
-          Console.log("  Not a valid choice.")
-          await pick()
+          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") {
+// Typing both halves is the fallback, not the first offer: it is what happens
+// when the platform keeps no accounts file. `envUser` is threaded in so a
+// `REVENTLESS_DEMO_USER` that named nobody in the file still skips the username
+// prompt rather than asking for a name that was already given.
+let askCredentials = async (~localDefaults: bool, ~envUser: option<string>): (string, string) => {
+  let username = switch envUser {
   | Some(u) => u
   | None =>
     requireTty()
@@ -189,6 +202,60 @@ let credentials = async (~localDefaults: bool=false): (string, string) => {
     let entered = await askHidden(localDefaults ? "Password [admin]: " : "Password: ")
     entered == "" && localDefaults ? "admin" : entered
   }
+  (username, password)
+}
+
+// The accounts file the platform already keeps (`.reventless/users.yaml`, or
+// `SEED_USERS_FILE`). It records the password beside the username, so choosing
+// an account is the whole credential step — nothing is typed.
+//
+// A named `REVENTLESS_DEMO_USER` picks its entry directly; otherwise the file's
+// accounts are offered in the order it defines them, first as the default.
+// `None` means the file has nothing to offer and the caller should ask.
+let fromUsersFile = async (~envUser: option<string>): option<(string, string)> =>
+  switch Seed_Users.load(~path=?envValue("SEED_USERS_FILE")) {
+  | None => None
+  | Some((path, users)) =>
+    let chosen = switch envUser {
+    | Some(name) => users->Array.find(u => u.username == name)
+    | None =>
+      Some(
+        await select(
+          ~title=`User (${path}):`,
+          ~options=users->Array.map(u => (Seed_Users.label(u), u)),
+          ~env="SEED_USER",
+          ~defaultIndex=0,
+        ),
+      )
+    }
+    // Logged for every arm, including the single-account file that selects
+    // itself without a keypress: which identity seeded the data is the thing an
+    // operator checks when owner-scoped rows turn up under the wrong account.
+    chosen->Option.map(u => {
+      Console.log(`Logging in as ${u.username} (from ${path})`)
+      (u.username, u.password)
+    })
+  }
+
+/**
+ * Resolves the credentials a seed run logs in with.
+ *
+ * `REVENTLESS_DEMO_USER` + `REVENTLESS_DEMO_PASSWORD` together are the
+ * non-interactive path and skip everything below. Otherwise the platform's
+ * `.reventless/users.yaml` supplies the accounts to choose from, and only a
+ * platform without one falls back to typing both halves — where, with
+ * `localDefaults`, empty input means `admin`/`admin`.
+ */
+let credentials = async (~localDefaults: bool=false): (string, string) => {
+  let envUser = envValue("REVENTLESS_DEMO_USER")
+  let (username, password) = switch (envUser, envValue("REVENTLESS_DEMO_PASSWORD")) {
+  | (Some(u), Some(p)) => (u, p)
+  | _ =>
+    switch await fromUsersFile(~envUser) {
+    | Some(pair) => pair
+    | None => await askCredentials(~localDefaults, ~envUser)
+    }
+  }
   if username == "" || password == "" {
     throw(Failed("username and password are required."))
   }

package/src/Seed_Prompt.res.mjs

@@ -5,6 +5,7 @@ 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";
+import * as Seed_Users$ReventlessSeed from "./Seed_Users.res.mjs";
 
 let rlRef = {
   contents: undefined
@@ -94,7 +95,7 @@ function isAffirmative(answer) {
   }
 }
 
-async function select(title, options, env) {
+async function select(title, options, env, defaultIndex) {
   if (options.length === 1) {
     return options[0][1];
   }
@@ -118,8 +119,13 @@ async function select(title, options, env) {
   options.forEach((param, i) => {
     console.log(`  ` + (i + 1 | 0).toString() + `) ` + param[0]);
   });
+  let fallback = Stdlib_Option.flatMap(defaultIndex, i => options[i]);
+  let hint = defaultIndex !== undefined && fallback !== undefined ? ` (default ` + (defaultIndex + 1 | 0).toString() + `)` : "";
   let pick = async () => {
-    let answer = await ask(`\nSelect [1-` + options.length.toString() + `]: `);
+    let answer = await ask(`\nSelect [1-` + options.length.toString() + `]` + hint + `: `);
+    if (answer === "" && fallback !== undefined) {
+      return fallback[1];
+    }
     let n = Stdlib_Int.fromString(answer, undefined);
     if (n !== undefined) {
       if (n >= 1 && n <= options.length) {
@@ -136,12 +142,10 @@ async function select(title, options, env) {
   return await pick();
 }
 
-async function credentials(localDefaultsOpt) {
-  let localDefaults = localDefaultsOpt !== undefined ? localDefaultsOpt : false;
-  let u = envValue("REVENTLESS_DEMO_USER");
+async function askCredentials(localDefaults, envUser) {
   let username;
-  if (u !== undefined) {
-    username = u;
+  if (envUser !== undefined) {
+    username = envUser;
   } else {
     requireTty();
     let entered = await ask(localDefaults ? "Username [admin]: " : "Username: ");
@@ -156,6 +160,52 @@ async function credentials(localDefaultsOpt) {
     let entered$1 = await askHidden(localDefaults ? "Password [admin]: " : "Password: ");
     password = entered$1 === "" && localDefaults ? "admin" : entered$1;
   }
+  return [
+    username,
+    password
+  ];
+}
+
+async function fromUsersFile(envUser) {
+  let match = Seed_Users$ReventlessSeed.load(envValue("SEED_USERS_FILE"));
+  if (match === undefined) {
+    return;
+  }
+  let users = match[1];
+  let path = match[0];
+  let chosen = envUser !== undefined ? users.find(u => u.username === envUser) : await select(`User (` + path + `):`, users.map(u => [
+      Seed_Users$ReventlessSeed.label(u),
+      u
+    ]), "SEED_USER", 0);
+  return Stdlib_Option.map(chosen, u => {
+    console.log(`Logging in as ` + u.username + ` (from ` + path + `)`);
+    return [
+      u.username,
+      u.password
+    ];
+  });
+}
+
+async function credentials(localDefaultsOpt) {
+  let localDefaults = localDefaultsOpt !== undefined ? localDefaultsOpt : false;
+  let envUser = envValue("REVENTLESS_DEMO_USER");
+  let match = envValue("REVENTLESS_DEMO_PASSWORD");
+  let match$1;
+  let exit = 0;
+  if (envUser !== undefined && match !== undefined) {
+    match$1 = [
+      envUser,
+      match
+    ];
+  } else {
+    exit = 1;
+  }
+  if (exit === 1) {
+    let pair = await fromUsersFile(envUser);
+    match$1 = pair !== undefined ? pair : await askCredentials(localDefaults, envUser);
+  }
+  let password = match$1[1];
+  let username = match$1[0];
   if (username === "" || password === "") {
     throw {
       RE_EXN_ID: Seed_Types$ReventlessSeed.Failed,
@@ -180,6 +230,8 @@ export {
   askHidden,
   isAffirmative,
   select,
+  askCredentials,
+  fromUsersFile,
   credentials,
 }
 /* node:readline Not a pure module */

package/src/Seed_Runner.res.mjs

@@ -155,7 +155,7 @@ function seed(sets, connect) {
           chosen = await Seed_Prompt$ReventlessSeed.select("Data set:", sets.map(s => [
             s.label,
             s
-          ]), undefined);
+          ]), undefined, undefined);
         }
       } else {
         chosen = sets[0];

package/src/Seed_Users.res

@@ -0,0 +1,80 @@
+// The dev accounts a seed run can log in as, read from `.reventless/users.yaml`.
+//
+// Both platforms keep that file beside the package the seed runs from: locally
+// the in-memory auth adapter loads it at startup, and on AWS it is the record of
+// what was created in the Cognito pool. Either way it already holds the
+// credentials an operator would otherwise retype, so the credential prompt
+// offers its entries instead of asking for a password nobody remembers.
+//
+// Absence is normal and silent — the caller falls back to asking. Nothing here
+// throws: a missing, unreadable or malformed file yields no accounts.
+
+@module("yaml") external parseYaml: string => JSON.t = "parse"
+
+/** One account: what to log in as, and what to send with it. */
+type user = {username: string, password: string, groups: array<string>}
+
+let asString = (json: JSON.t): option<string> =>
+  switch json {
+  | String(s) => Some(s)
+  | _ => None
+  }
+
+let userOf = (json: JSON.t): option<user> =>
+  switch json {
+  | Object(obj) =>
+    switch (
+      obj->Dict.get("username")->Option.flatMap(asString),
+      obj->Dict.get("password")->Option.flatMap(asString),
+    ) {
+    | (Some(username), Some(password)) =>
+      let groups = switch obj->Dict.get("groups") {
+      | Some(JSON.Array(items)) => items->Array.filterMap(asString)
+      | _ => []
+      }
+      Some({username, password, groups})
+    | _ => None
+    }
+  | _ => None
+  }
+
+/**
+ * The accounts a users.yaml document defines, in the order it defines them —
+ * the order is what makes "the first one" a stable default.
+ *
+ * An entry without both a username and a password is skipped rather than
+ * rejected: the file is hand-maintained, and one incomplete entry should not
+ * cost the operator the rest of the list.
+ */
+let parseString = (yamlText: string): array<user> => {
+  let doc = try parseYaml(yamlText) catch {
+  | _ => JSON.Null
+  }
+  switch doc {
+  | Array(items) => items->Array.filterMap(userOf)
+  | _ => []
+  }
+}
+
+/** Where the file lives for the platform being seeded — the seed runs from that
+    package's directory, which is the same cwd the local auth adapter reads. */
+let defaultPath = (): string => NodePath.join([NodeProcess.cwd(), ".reventless", "users.yaml"])
+
+/**
+ * The accounts on disk, with the path they came from. `None` when there is no
+ * readable file with at least one usable account, which the caller reads as
+ * "ask for credentials instead".
+ */
+let load = (~path: option<string>=?): option<(string, array<user>)> => {
+  let file = path->Option.getOr(defaultPath())
+  let users = try {
+    NodeFs.existsSync(file) ? parseString(NodeFs.readFileSync(file)) : []
+  } catch {
+  | _ => []
+  }
+  users->Array.length == 0 ? None : Some((file, users))
+}
+
+/** Menu label: the username, plus whatever groups the file records for it. */
+let label = (u: user): string =>
+  u.groups->Array.length == 0 ? u.username : `${u.username}  [${u.groups->Array.join(", ")}]`

package/src/Seed_Users.res.mjs

@@ -0,0 +1,90 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Yaml from "yaml";
+import * as Nodefs from "node:fs";
+import * as Nodepath from "node:path";
+import * as Stdlib_Array from "@rescript/runtime/lib/es6/Stdlib_Array.js";
+import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
+
+function asString(json) {
+  if (typeof json === "string") {
+    return json;
+  }
+}
+
+function userOf(json) {
+  if (typeof json !== "object" || json === null || Array.isArray(json)) {
+    return;
+  }
+  let match = Stdlib_Option.flatMap(json["username"], asString);
+  let match$1 = Stdlib_Option.flatMap(json["password"], asString);
+  if (match === undefined) {
+    return;
+  }
+  if (match$1 === undefined) {
+    return;
+  }
+  let match$2 = json["groups"];
+  let groups = match$2 !== undefined ? (
+      Array.isArray(match$2) ? Stdlib_Array.filterMap(match$2, asString) : []
+    ) : [];
+  return {
+    username: match,
+    password: match$1,
+    groups: groups
+  };
+}
+
+function parseString(yamlText) {
+  let doc;
+  try {
+    doc = Yaml.parse(yamlText);
+  } catch (exn) {
+    doc = null;
+  }
+  if (Array.isArray(doc)) {
+    return Stdlib_Array.filterMap(doc, userOf);
+  } else {
+    return [];
+  }
+}
+
+function defaultPath() {
+  return Nodepath.join(process.cwd(), ".reventless", "users.yaml");
+}
+
+function load(path) {
+  let file = Stdlib_Option.getOr(path, defaultPath());
+  let users;
+  try {
+    users = Nodefs.existsSync(file) ? parseString(Nodefs.readFileSync(file, "utf8")) : [];
+  } catch (exn) {
+    users = [];
+  }
+  if (users.length === 0) {
+    return;
+  } else {
+    return [
+      file,
+      users
+    ];
+  }
+}
+
+function label(u) {
+  if (u.groups.length === 0) {
+    return u.username;
+  } else {
+    return u.username + `  [` + u.groups.join(", ") + `]`;
+  }
+}
+
+export {
+  asString,
+  userOf,
+  parseString,
+  defaultPath,
+  load,
+  label,
+}
+/* yaml Not a pure module */

package/tests/Seed_ClientTest.res

@@ -0,0 +1,59 @@
+open JestGlobals
+
+// A seed issues hundreds of commands against runtimes a preceding reset left
+// cold, so the endpoint faulting on one of them is a normal event rather than an
+// exceptional one. Before the retry, a single `InternalFailure` in that batch
+// aborted the run and left a half-seeded store that could only be recovered by a
+// full wipe and a re-run — for a request that would have succeeded on being
+// asked again.
+//
+// What makes the retry safe is the classifier, so that is what these pin. A
+// fault on the endpoint's side carries no information about the document and is
+// worth resending; anything that is an *answer* — a validation error, an unknown
+// field, a refused token — comes back identical however many times it is asked,
+// and resending it only delays the failure the operator needs to see.
+
+let errors = entries => JSON.Encode.array(entries->Array.map(JSON.Encode.object))
+
+let errorOfType = errorType =>
+  Dict.fromArray([("errorType", JSON.Encode.string(errorType))])
+
+describe("Seed_Client.isTransient:", () => {
+  testSync("resends a fault on the endpoint's own side", () =>
+    ["InternalFailure", "ServiceUnavailable", "Throttling", "TooManyRequestsException"]
+    ->Array.forEach(t =>
+      expect(Seed_Client.isTransient(errors([errorOfType(t)])))->toBe(true)
+    )
+  )
+
+  // The exact payload the seed aborted on.
+  testSync("resends the shape AppSync actually returned", () => {
+    let payload = JSON.parseOrThrow(`[{"errorType":"InternalFailure","message":"An internal failure occurred."}]`)
+    expect(Seed_Client.isTransient(payload))->toBe(true)
+  })
+
+  testSync("fails fast on an error that is an answer", () =>
+    ["ValidationException", "Unauthorized", "FieldUndefined"]->Array.forEach(t =>
+      expect(Seed_Client.isTransient(errors([errorOfType(t)])))->toBe(false)
+    )
+  )
+
+  // A real error sitting alongside a transient one still means the request was
+  // wrong, and resending it cannot make it right.
+  testSync("refuses to resend a batch that mixes a real error in", () =>
+    expect(
+      Seed_Client.isTransient(
+        errors([errorOfType("InternalFailure"), errorOfType("ValidationException")]),
+      ),
+    )->toBe(false)
+  )
+
+  // `Array.every` is vacuously true on an empty array, which would turn "the
+  // endpoint said errors but named none" into an endless resend.
+  testSync("treats an empty or untyped error list as final", () => {
+    expect(Seed_Client.isTransient(errors([])))->toBe(false)
+    expect(Seed_Client.isTransient(errors([Dict.fromArray([("message", JSON.Encode.string("boom"))])])))
+    ->toBe(false)
+    expect(Seed_Client.isTransient(JSON.Encode.null))->toBe(false)
+  })
+})

package/tests/Seed_ClientTest.res.mjs

@@ -0,0 +1,64 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Seed_Client$ReventlessSeed from "../src/Seed_Client.res.mjs";
+
+function errors(entries) {
+  return entries.map(prim => prim);
+}
+
+function errorOfType(errorType) {
+  return Object.fromEntries([[
+      "errorType",
+      errorType
+    ]]);
+}
+
+globalThis.describe("Seed_Client.isTransient:", () => {
+  globalThis.test("resends a fault on the endpoint's own side", () => {
+    [
+      "InternalFailure",
+      "ServiceUnavailable",
+      "Throttling",
+      "TooManyRequestsException"
+    ].forEach(t => {
+      let entries = [errorOfType(t)];
+      globalThis.expect(Seed_Client$ReventlessSeed.isTransient(entries.map(prim => prim))).toBe(true);
+    });
+  });
+  globalThis.test("resends the shape AppSync actually returned", () => {
+    let payload = JSON.parse(`[{"errorType":"InternalFailure","message":"An internal failure occurred."}]`);
+    globalThis.expect(Seed_Client$ReventlessSeed.isTransient(payload)).toBe(true);
+  });
+  globalThis.test("fails fast on an error that is an answer", () => {
+    [
+      "ValidationException",
+      "Unauthorized",
+      "FieldUndefined"
+    ].forEach(t => {
+      let entries = [errorOfType(t)];
+      globalThis.expect(Seed_Client$ReventlessSeed.isTransient(entries.map(prim => prim))).toBe(false);
+    });
+  });
+  globalThis.test("refuses to resend a batch that mixes a real error in", () => {
+    let entries = [
+      errorOfType("InternalFailure"),
+      errorOfType("ValidationException")
+    ];
+    globalThis.expect(Seed_Client$ReventlessSeed.isTransient(entries.map(prim => prim))).toBe(false);
+  });
+  globalThis.test("treats an empty or untyped error list as final", () => {
+    globalThis.expect(Seed_Client$ReventlessSeed.isTransient([].map(prim => prim))).toBe(false);
+    let entries = [Object.fromEntries([[
+          "message",
+          "boom"
+        ]])];
+    globalThis.expect(Seed_Client$ReventlessSeed.isTransient(entries.map(prim => prim))).toBe(false);
+    globalThis.expect(Seed_Client$ReventlessSeed.isTransient(null)).toBe(false);
+  });
+});
+
+export {
+  errors,
+  errorOfType,
+}
+/*  Not a pure module */