arcadible 1.0.2 → 1.0.5

package/src/schema/game.js

@@ -123,16 +123,20 @@ const GALLERY_DIMENSIONS = {
 // leaving a field out is how to unset it, so an empty one is always a mistake.
 const atLeast = function (field, min, unit) {
   return min === 1
-    ? message(field, ["Must not be empty. Leave the field out instead."])
-    : message(field, [`Must be at least: ${min} ${unit}`]);
+    ? message(field, ["Must not be empty.", "Leave the field out instead."])
+    : message(field, [
+        unit === "character"
+          ? `Must be at least ${min} characters.`
+          : `Must have at least ${min} ${unit}s.`,
+      ]);
 };
 
 // [function]
 
-// a required string's error: "Must be defined." and `lines` when it's missing,
+// a required string's error: "Must be set." and `lines` when it's missing,
 // and zod's own type message (null) when it's there but isn't a string.
 const required = function (field, lines) {
-  const missing = message(field, ["Must be defined.", ...lines]).message;
+  const missing = message(field, ["Must be set.", ...lines]).message;
   return {
     error(issue) {
       return typeof issue.input === "undefined" ? missing : null;
@@ -144,14 +148,14 @@ const required = function (field, lines) {
 
 // a list of distinct values. Without a max, its length is up to the values.
 const zSet = function (field, schema, { max, min }) {
-  const list = z.array(schema).min(min, atLeast(field, min, "element"));
+  const list = z.array(schema).min(min, atLeast(field, min, "item"));
   return (
     max
-      ? list.max(max, message(field, [`Must not exceed: ${max} elements`]))
+      ? list.max(max, message(field, [`Must have at most ${max} items.`]))
       : list
   ).refine(
     (items) => new Set(items).size === items.length,
-    message(field, ["Must not contain duplicate elements."], ISSUE.DUPLICATE),
+    message(field, ["Must not repeat an item."], ISSUE.DUPLICATE),
   );
 };
 
@@ -161,12 +165,12 @@ const zSetBasefile = function (field, schema, { max, min }) {
   return z
     .array(schema)
     .min(min, atLeast(field, min, "file"))
-    .max(max, message(field, [`Must not exceed: ${max} files`]))
+    .max(max, message(field, [`Must have at most ${max} files.`]))
     .refine(
       (items) => new Set(items.map(basefile)).size === items.length,
       message(
         field,
-        ["Must not contain duplicate filenames (ignoring extensions)."],
+        ["Must not have two files of one name, whatever their extensions."],
         ISSUE.DUPLICATE,
       ),
     );
@@ -183,7 +187,7 @@ const zString = function (field, char, { max, min }) {
     .min(min, { ...atLeast(field, min, "character"), abort: min === 1 })
     .refine(
       (str) => [...str].length <= max,
-      message(field, [`Must not exceed: ${max} characters`], ISSUE.TOO_LONG),
+      message(field, [`Must be at most ${max} characters.`], ISSUE.TOO_LONG),
     )
     .superRefine((str, ctx) => {
       const invalid = invalidChars(str, char);
@@ -458,7 +462,7 @@ const zHandle = function () {
   const field = "handle";
   return z.optional(
     zString(field, /[a-z0-9-]/u, { max: 24, min: 1 })
-      .min(3, atLeast(field, 3, "characters"))
+      .min(3, atLeast(field, 3, "character"))
       .refine(
         (str) => !str.startsWith("-") && !str.endsWith("-"),
         message(
@@ -487,7 +491,7 @@ const zId = function () {
       required(field, [`Run ${phrase.cmdInit()} to generate a new game ID.`]),
     )
     .min(1, { ...atLeast(field, 1), abort: true })
-    .uuid(message(field, ["Must be a valid UUID."]))
+    .uuid(message(field, ["Must be a UUID."]))
     .refine(
       (value) => value === value.toLowerCase(),
       message(field, ["Must be lowercase."], ISSUE.UUID_INVALID),
@@ -514,8 +518,8 @@ const zPrice = function () {
   return z.optional(
     z
       .int()
-      .min(0, message(field, ["Must not be below: 0"]))
-      .max(25, message(field, ["Must not be above: 25"])),
+      .min(0, message(field, ["Must be 0 or more."]))
+      .max(25, message(field, ["Must be 25 or less."])),
   );
 };
 
@@ -547,7 +551,7 @@ const zTrailer = function () {
   return z
     .string()
     .min(1, { ...atLeast(field, 1), abort: true })
-    .max(255, message(field, ["Must not exceed: 255 characters"]))
+    .max(255, message(field, ["Must be at most 255 characters."]))
     .refine(
       (url) =>
         zVimeo().safeParse(url).success || zYouTube().safeParse(url).success,
@@ -561,18 +565,26 @@ const zTrailer = function () {
 const zVersion = function () {
   const field = "version";
   return z
-    .string(
-      required(field, ["A version is required unless one can be derived."]),
-    )
+    .string(required(field, ["Set it here, or in package.json."]))
     .min(1, { ...atLeast(field, 1), abort: true })
     .refine((value) => validSemver(value) !== null, {
-      ...message(field, ["Must be valid semver."], ISSUE.VERSION_INVALID),
+      ...message(
+        field,
+        ["Must be a version, such as 1.2.0."],
+        ISSUE.VERSION_INVALID,
+      ),
       abort: true,
     })
     .refine(
       // lowercase too, since the database refuses an uppercase prerelease.
       (value) => cleanSemver(value) === value && value === value.toLowerCase(),
-      message(field, ["Must be normalized semver."], ISSUE.VERSION_INVALID),
+      message(
+        field,
+        [
+          "Must be written as 1.2.0 or 1.2.0-beta.1: lowercase, with no v, spaces, or build metadata.",
+        ],
+        ISSUE.VERSION_INVALID,
+      ),
     );
 };
 

package/src/schema/readme.js

@@ -29,7 +29,8 @@ const main = function (value, { file }) {
           ...message(
             "description",
             [
-              `${file} has content after its title, tagline, and bio, so it needs two --- rules around the description.`,
+              "Needs two --- rules around the description.",
+              `${file} has content after its title, tagline, and bio.`,
             ],
             cfgcode.ISSUE.DESCRIPTION_RULES_MISSING,
           ),

package/src/schema/workflow.js

@@ -68,7 +68,7 @@ const zDeployDir = function (root, { build }) {
   return z
     .string()
     .min(1, {
-      ...message(field, ["Must not be empty. Leave the field out instead."]),
+      ...message(field, ["Must not be empty.", "Leave the field out instead."]),
       abort: true,
     })
     .refine((file) => isRelativeCheck(root, file), {
@@ -82,24 +82,20 @@ const zDeployDir = function (root, { build }) {
     .refine((file) => !isRootCheck(root, file), {
       ...message(
         field,
-        ["Must be a directory inside the project, not the project root."],
+        ["Must be a folder in the project, not its root."],
         ISSUE.PATH_INVALID,
       ),
       abort: true,
     })
     .refine((file) => avoidsCheck(root, file, MEDIA), {
-      ...message(
-        field,
-        [`Must not contain ${MEDIA} in path.`],
-        ISSUE.PATH_INVALID,
-      ),
+      ...message(field, [`Must not be in ${MEDIA}.`], ISSUE.PATH_INVALID),
       abort: true,
     })
     .refine((file) => hasBuild(build) || existsCheck(root, file), {
       ...message(
         field,
         [
-          "Must exist when no build step is defined.",
+          "Must exist, since there's no build.",
           `Run ${phrase.cmdInspect()} for details.`,
         ],
         ISSUE.PATH_INVALID,
@@ -118,7 +114,8 @@ const zDeployDir = function (root, { build }) {
       ...message(
         field,
         [
-          `Must not have ${RESERVED.join(" or ")} at its root. They're reserved for the files ${cfgproduct.title} adds.`,
+          `Must not have ${RESERVED.join(" or ")} at its root.`,
+          `They're reserved for the files ${cfgproduct.title} adds.`,
         ],
         ISSUE.PATH_INVALID,
       ),
@@ -128,7 +125,8 @@ const zDeployDir = function (root, { build }) {
       ...message(
         field,
         [
-          `Must not have an ${RESERVED_FOLDER} folder at its root, in any letter case. It's reserved for ${cfgproduct.title}'s own files.`,
+          `Must not have an ${RESERVED_FOLDER} folder at its root, in any letter case.`,
+          `It's reserved for ${cfgproduct.title}'s own files.`,
         ],
         ISSUE.PATH_INVALID,
       ),

package/src/serve/game.js

@@ -98,7 +98,13 @@ const sendFile = function (req, res, file, headers) {
     res.end();
     return;
   }
-  file.open(range).pipe(res);
+  // the file can go between finding and reading it, as a rebuild empties
+  // deploy_dir: the headers are sent, so the response just ends
+  const stream = file.open(range);
+  stream.on("error", () => {
+    res.destroy();
+  });
+  stream.pipe(res);
 };
 
 // [function]

package/src/serve/page.js

@@ -24,6 +24,17 @@ const SANDBOX =
 const HOST = "/_arcadible/host.js";
 const RELOAD = "/_arcadible/reload";
 
+// [declare]
+
+// the headers of the page's responses, as the play page's: it's
+// cross-origin isolated, and nothing frames it.
+const HEADERS = {
+  "cache-control": "no-store",
+  "content-security-policy": "frame-ancestors 'none';",
+  "cross-origin-embedder-policy": "require-corp",
+  "cross-origin-opener-policy": "same-origin",
+};
+
 // [function]
 
 // `value` as JSON that's safe inside a <script>.
@@ -86,10 +97,10 @@ const html = function (game) {
             version: config.version,
           });
         } catch (err) {
-          console.error("arcadible: no host for the game:", err);
+          console.error("Arcadible SDK: the play page couldn't host the game, so it stands alone.", err);
         }
       } else {
-        console.error("arcadible: no host for the game: the play page's host didn't load.");
+        console.error("Arcadible SDK: the play page's host didn't load, so the game stands alone.");
       }
       frame.src = config.src;
       document.body.prepend(frame);
@@ -105,17 +116,6 @@ const html = function (game) {
 
 // [function]
 
-// the headers of the page's responses, as the play page's: it's
-// cross-origin isolated, and nothing frames it.
-const HEADERS = {
-  "cache-control": "no-store",
-  "content-security-policy": "frame-ancestors 'none';",
-  "cross-origin-embedder-policy": "require-corp",
-  "cross-origin-opener-policy": "same-origin",
-};
-
-// [function]
-
 // the request handler for the page's origin. `reloads` keeps the pages
 // listening for a reload; `remote` has the host.
 const pageHandler = function ({

package/src/serve/reload.js

@@ -52,6 +52,11 @@ const watchDir = function (dir, onChange) {
     clearTimeout(timer);
     timer = setTimeout(onChange, SETTLE);
   });
+  // deploy_dir removed while it's watched (EPERM on Windows): stop watching
+  // rather than crash the server
+  watcher.on("error", () => {
+    watcher.close();
+  });
   return () => {
     clearTimeout(timer);
     watcher.close();

package/src/util/log.js

@@ -30,6 +30,13 @@ const log = function (out, message, { bold = false, color, nl = false } = {}) {
 
 // [function]
 
+// a warning, marked with ⚠ (OUTPUT.md), on its first line.
+const warned = function (message) {
+  return `⚠ ${[message].flat().join("\n").trim()}`;
+};
+
+// [function]
+
 const h = function (message) {
   log(console.log, message, { bold: true });
 };
@@ -91,13 +98,13 @@ const hwo = function (message) {
 // [function]
 
 const pw = function (message) {
-  log(console.warn, message, { color: "yellow" });
+  log(console.warn, warned(message), { color: "yellow" });
 };
 
 // [function]
 
 const nlpw = function (message) {
-  log(console.warn, message, { color: "yellow", nl: true });
+  log(console.warn, warned(message), { color: "yellow", nl: true });
 };
 
 // [function]

package/src/util/md.js

@@ -32,7 +32,7 @@ const escape = function (str) {
     .replace(/>/gu, ">");
 };
 
-// [declare]
+// [define]
 
 // there is no video syntax in Markdown, so an image of a video renders as the
 // video the developer would have written: its src and title, and no alt.

package/src/util/output.js

@@ -59,6 +59,20 @@ const print = function (data, { key, nl, toml } = {}) {
 
 // [function]
 
+// exits with `code` once stdout has written what it holds. A pipe on macOS
+// writes later, so exiting at once would cut a large --json document short;
+// with nothing held, it exits at once, as a caller that goes on expects.
+const exit = function (code) {
+  if (!process.stdout.writableLength) {
+    process.exit(code);
+  }
+  process.exitCode = code;
+  process.stdout.write("", () => process.exit(code));
+  return new Promise(() => {});
+};
+
+// [function]
+
 // a command's error path: the error as JSON, or its heading ("Deploy
 // aborted.") and the reason on stderr, then its code and the link to it on
 // the Errors page, once the spinner and progress bar are cleared. Then exits
@@ -102,7 +116,7 @@ const abort = function (
     log.pd(message);
     log.nlpd([phrase.errorCode(shown), chalk.cyan.underline(link)]);
   }
-  process.exit(1);
+  return exit(1);
 };
 
 // [function]
@@ -128,7 +142,7 @@ const warn = function (warnings, { json, quiet } = {}) {
   if (json || quiet) {
     return;
   }
-  warnings.forEach((each) => log.pw(`⚠ ${schema.print(each)}`));
+  warnings.forEach((each) => log.pw(schema.print(each)));
 };
 
 // [function]
@@ -150,6 +164,7 @@ const warning = function (code, message, path = null) {
 
 module.exports = {
   abort,
+  exit,
   launched,
   print,
   printJson,

package/src/util/rc.js

@@ -75,7 +75,22 @@ const files = function (cmd, argv) {
 
 // [function]
 
-// a file's sections, INI or JSON, or nothing when it can't be read. JSON
+// ini parses anything, so a section header with no closing bracket, such as
+// `[validate`, would become a key, and the options under it would be read
+// outside their section. The first one's problem, or null.
+const unclosedSection = function (str) {
+  const lines = str.split(/\r?\n/u).map((line) => line.trim());
+  const i = lines.findIndex(
+    (text) => text.startsWith("[") && !/^\[[^\]]*\]$/u.test(text),
+  );
+  return i === -1
+    ? null
+    : `Line ${i + 1}: section header isn't closed: ${lines[i]}`;
+};
+
+// [function]
+
+// a file's sections, INI or JSON, or nothing when it can't be read. A file
 // that doesn't parse is `parse_failed`, naming the file.
 const read = function (file) {
   let str = null;
@@ -85,6 +100,13 @@ const read = function (file) {
     return {};
   }
   if (!/^\s*\{/u.test(str)) {
+    const unclosed = unclosedSection(str);
+    if (unclosed) {
+      throw new ArcError(
+        cfgcode.PARSE_FAILED,
+        phrase.unableToParse(file, unclosed),
+      );
+    }
     return ini.parse(str);
   }
   try {

package/src/util/s3.js

@@ -17,13 +17,32 @@ const ArcError = error.ArcError;
 const createReadStream = fs.createReadStream;
 const request = https.request;
 
+// [declare]
+
+const CHECKSUM = "x-amz-checksum-sha256";
+
+// [function]
+
+// [function]
+
+// whether the upload link signs `header`, which must then be sent.
+const signs = function (url, header) {
+  const signed = new URL(url).searchParams.get("X-Amz-SignedHeaders");
+  return Boolean(signed?.split(";").includes(header));
+};
+
 // [function]
 
-const requestOpts = function (size) {
+// the zip's SHA-256 is sent when the link signs it, so S3 refuses a zip that
+// isn't the one the upload was asked for.
+const requestOpts = function (url, { sha256, size }) {
   return {
     headers: {
       "Content-Length": size,
       "Content-Type": "application/zip",
+      ...(signs(url, CHECKSUM)
+        ? { [CHECKSUM]: Buffer.from(sha256, "hex").toString("base64") }
+        : {}),
     },
     method: "PUT",
   };
@@ -34,9 +53,9 @@ const requestOpts = function (size) {
 // puts the file to the upload link, and resolves once S3 accepts it. A
 // request that gets no response rejects as api_unreachable; a file that can't
 // be read rejects with its own error.
-const upload = function (url, { path, size }, onProgress) {
+const upload = function (url, { path, sha256, size }, onProgress) {
   return new Promise((resolve, reject) => {
-    const req = request(url, requestOpts(size), (resp) => {
+    const req = request(url, requestOpts(url, { sha256, size }), (resp) => {
       resp.resume();
       const status = resp.statusCode;
       if (status >= 200 && status < 300) {

package/src/util/schema.js

@@ -17,6 +17,14 @@ const ISSUE = cfgcode.ISSUE;
 
 // [declare]
 
+// how a value's kind is named, as TOML writes it.
+const KINDS = {
+  array: "a list",
+  boolean: "true or false",
+  number: "a number",
+  object: "a table",
+  string: "a string",
+};
 const NUMBERS = new Set(["bigint", "int", "number"]);
 
 // [function]
@@ -65,11 +73,54 @@ const issueCodeOf = function (issue) {
 
 // [function]
 
+// a value's kind, as TOML writes it: "a string", "a list", "a table".
+const kindOf = function (type) {
+  return KINDS[type] ?? `a ${type}`;
+};
+
+// [function]
+
+// what zod reports itself (a value of the wrong type, or not one of the
+// options), in arc's words, as `{ message, details }`: "Must be a string, not
+// a number." Null for a message of our own.
+const zodMessage = function (issue) {
+  if (issue.code === "invalid_value" && issue.values) {
+    return { details: [issue.values.join(", ")], message: "Must be one of:" };
+  }
+  const given = Array.isArray(issue.input) ? "array" : typeof issue.input;
+  if (issue.code === "invalid_type" && typeof issue.input !== "undefined") {
+    return {
+      details: [],
+      message: `Must be ${kindOf(issue.expected)}, not ${kindOf(given)}.`,
+    };
+  }
+  if (
+    issue.code === "invalid_union" &&
+    issue.errors.every((branch) =>
+      branch.every((each) => each.code === "invalid_type"),
+    )
+  ) {
+    const expected = [
+      ...new Set(issue.errors.map((branch) => kindOf(branch[0].expected))),
+    ];
+    return {
+      details: [],
+      message: `Must be ${expected.join(" or ")}, not ${kindOf(given)}.`,
+    };
+  }
+  return null;
+};
+
+// [function]
+
 // a zod issue as arc validate reports it: the field's path, the rule's code,
 // the message's first line and its details, and the link to the field's
 // rules, or null for a field the docs leave out.
 const toIssue = function (name, issue) {
-  const { details, message } = schemaMessage.parse(issue.message);
+  const parsed = schemaMessage.parse(issue.message);
+  const { details, message } =
+    (/^Invalid (input|option)\b/u.test(parsed.message) && zodMessage(issue)) ||
+    parsed;
   return {
     code: issueCodeOf(issue),
     details,
@@ -133,5 +184,6 @@ module.exports = {
   dereference,
   issueCodeOf,
   print,
+  toIssue,
   validator,
 };