arcadible 1.0.2 → 1.0.4

package/bin/arc-build.js

@@ -17,19 +17,16 @@ const build = require("../src/cli/build");
 const cfgcode = require("../src/config/code");
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
-const error = require("../src/util/error");
+const checked = require("../src/action/validate/checked");
 const log = require("../src/util/log");
 const output = require("../src/util/output");
 const phrase = require("../src/phrase");
-const project = require("../src/parser/project");
 const rc = require("../src/util/rc");
 const spinner = require("../src/util/spinner");
-const validate = require("../src/cli/validate");
 
 // [use]
 
 const abort = output.abort;
-const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const print = output.print;
 const relative = path.relative;
@@ -62,26 +59,16 @@ const start = function (argv) {
   let parsed = null;
   // what --json lists under `warnings`.
   let warnings = [];
-  let sw = new SpinnerWheel("Validating... %s");
+  let sw = new SpinnerWheel("Validating… %s");
   sw.start(json || quiet);
-  return project(root)
+  return checked(root, (found) => {
+    warnings = found;
+  })
     .then((proj) => {
       parsed = proj;
-      return validate({ project: parsed, root });
-    })
-    .then((validated) => {
-      const count = validated.issues.length;
-      warnings = validated.warnings;
-      if (count) {
-        throw new ArcError(
-          cfgcode.VALIDATION_FAILED,
-          phrase.issuesFound(count),
-          { data: { issues: validated.issues } },
-        );
-      }
       sw.stop(true);
       warn(warnings, { json, quiet });
-      sw = new SpinnerWheel("Building... %s");
+      sw = new SpinnerWheel("Building… %s");
       sw.start(json || quiet);
       return build({ project: parsed, root });
     })
@@ -110,9 +97,7 @@ const start = function (argv) {
         }
         if (artifact?.missing) {
           log.result(phrase.buildSucceeded(), [], { color: "yellow" });
-          log.nlpw(
-            `⚠ ${phrase.buildOutputMissing(relative(root, artifact.missing))}`,
-          );
+          log.nlpw(phrase.buildOutputMissing(relative(root, artifact.missing)));
           return;
         }
         log.hs(phrase.nothingToDo());

package/bin/arc-default.js

@@ -34,17 +34,17 @@ const main = function (argv) {
     yargs(args.normalize(hideBin(argv)))
       .scriptName(TOOL)
       .usage("$0 <command> [options]")
-      .command("init", "Initialize project")
-      .command("inspect", "Inspect project")
-      .command("validate", "Validate project")
-      .command("build", "Build project")
-      .command("pack", "Package project")
-      .command("serve", "Serve a game locally")
-      .command("deploy", "Deploy project")
+      .command("init", "Initialize a project")
+      .command("inspect", "Print the resolved manifest")
+      .command("validate", "Check the project for issues")
+      .command("build", "Run the project's build")
+      .command("pack", "Pack the game into a zip")
+      .command("serve", "Serve the game locally")
+      .command("deploy", "Deploy the game")
       .command("open", "Open a game's store page")
       .command("play", "Play a game")
       .command("login", `Log in to ${TITLE}`)
-      .command("whoami", `Show ${TITLE} account`)
+      .command("whoami", "Show the logged-in account")
       .command("logout", `Log out of ${TITLE}`)
       .help("help")
       .alias("help", "h")

package/bin/arc-deploy.js

@@ -17,6 +17,7 @@ const build = require("../src/cli/build");
 const cfgcode = require("../src/config/code");
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
+const checked = require("../src/action/validate/checked");
 const deploy = require("../src/cli/deploy");
 const error = require("../src/util/error");
 const links = require("../src/util/links");
@@ -97,7 +98,7 @@ const handler = function ({ json, pb, quiet, sw, warnings }) {
         if (pb) {
           pb.stop();
         }
-        log.pw(`⚠ ${message}`);
+        log.pw(message);
         sw.start(false);
         if (pb) {
           pb.start();
@@ -126,7 +127,11 @@ const report = function (
     heading = phrase.releasePublished(version.to, channel, built);
     next = null;
   }
-  log.result(heading, [store ? ["Store:", store] : null, ["Play:", url], next]);
+  log.result(heading, [
+    store ? [phrase.storeLabel(), store] : null,
+    [phrase.playLabel(), url],
+    next,
+  ]);
 };
 
 // [function]
@@ -259,27 +264,19 @@ const start = function (argv) {
   let parsed = null;
   // what --json lists under `warnings`: arc validate's, then the deploy's.
   const warnings = [];
-  let sw = new SpinnerWheel("Validating... %s");
+  let sw = new SpinnerWheel("Validating… %s");
   sw.start(json || quiet);
   return checkTimeout(timeout)
-    .then(() => project(root))
+    .then(() =>
+      checked(root, (found) => {
+        warnings.push(...found);
+      }),
+    )
     .then((proj) => {
       parsed = proj;
-      return validate({ project: parsed, root });
-    })
-    .then((validated) => {
-      const count = validated.issues.length;
-      warnings.push(...validated.warnings);
-      if (count) {
-        throw new ArcError(
-          cfgcode.VALIDATION_FAILED,
-          phrase.issuesFound(count),
-          { data: { issues: validated.issues } },
-        );
-      }
       sw.stop(true);
-      warn(validated.warnings, { json, quiet });
-      sw = new SpinnerWheel("Checking... %s");
+      warn(warnings, { json, quiet });
+      sw = new SpinnerWheel("Checking… %s");
       // git deploys need no login: anyone who can push to the repository can
       // release, and the Arcadible GitHub App publishes the release. Anyone
       // can wait for it too; the game's owner, logged in, waits among their
@@ -296,7 +293,7 @@ const start = function (argv) {
         throw new ArcError(cfgcode.NOT_LOGGED_IN, phrase.notLoggedIn());
       }
       sw.stop(true);
-      sw = new SpinnerWheel("Preparing... %s");
+      sw = new SpinnerWheel("Preparing… %s");
       return Promise.all([
         // whoami
         current,
@@ -314,7 +311,7 @@ const start = function (argv) {
       sw.stop(true);
       owner = predeployed.owner ?? null;
       held = predeployed.held ?? false;
-      sw = new SpinnerWheel("Building... %s");
+      sw = new SpinnerWheel("Building… %s");
       sw.start(git || json || quiet);
       return Promise.all([
         // whoami
@@ -345,7 +342,7 @@ const start = function (argv) {
       }
       parsed = proj;
       sw.stop(true);
-      sw = new SpinnerWheel("Packing... %s");
+      sw = new SpinnerWheel("Packing… %s");
       sw.start(git || json || quiet);
       return Promise.all([
         // whoami
@@ -441,7 +438,8 @@ const main = function (argv) {
       })
       .option("timeout", {
         default: conf.timeout,
-        describe: "Seconds to wait [default: 300, or 900 for git]",
+        defaultDescription: "300, or 900 for git",
+        describe: "Seconds to wait",
         type: "number",
       })
       .option("cwd", args.CWD)

package/bin/arc-init.js

@@ -31,6 +31,7 @@ const spinner = require("../src/util/spinner");
 
 const abort = output.abort;
 const ArcError = error.ArcError;
+const exit = output.exit;
 const findRc = rc.findRc;
 const pathExists = fs.pathExists;
 const print = output.print;
@@ -69,7 +70,7 @@ const handler = function ({ json, quiet, sw }) {
 const start = function (argv) {
   const json = argv.json;
   const quiet = argv.quiet;
-  const sw = new SpinnerWheel("Initializing... %s");
+  const sw = new SpinnerWheel("Initializing… %s");
   return init({
     handler: handler({ json, quiet, sw }),
     patch: argv.patch,
@@ -86,7 +87,7 @@ const start = function (argv) {
         print(project, { nl: true, toml: true });
       }
       // degit sometimes hangs, so exit once stdout is written.
-      process.stdout.write("", () => process.exit(0));
+      return exit(0);
     })
     .catch((ex) => abort(phrase.aborted(COMMAND), ex, { json, sw }));
 };
@@ -149,7 +150,7 @@ const main = function (argv) {
         default: conf.template,
         describe: [
           "Project template",
-          "Public GitHub repository, or a folder in one (user/repo[/folder]).",
+          "Public GitHub repository, or a folder in one (user/repo[/folder])",
         ].join("\n"),
         type: "string",
       })

package/bin/arc-login.js

@@ -137,12 +137,12 @@ const main = function (argv) {
       .usage("$0 [options]")
       .option("browser", {
         default: conf.browser,
-        describe: "Open a web browser on Enter (disable with --no-browser)",
+        describe: "Open a web browser on Enter",
         type: "boolean",
       })
       .option("qrcode", {
         default: conf.qrcode,
-        describe: "Display a qrcode (disable with --no-qrcode)",
+        describe: "Show a QR code",
         type: "boolean",
       })
       .help("help")

package/bin/arc-pack.js

@@ -13,23 +13,19 @@ const yargs = require("yargs/yargs");
 // [import]
 
 const args = require("../src/util/argv");
-const cfgcode = require("../src/config/code");
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
-const error = require("../src/util/error");
+const checked = require("../src/action/validate/checked");
 const log = require("../src/util/log");
 const output = require("../src/util/output");
 const pack = require("../src/cli/pack");
 const phrase = require("../src/phrase");
-const project = require("../src/parser/project");
 const rc = require("../src/util/rc");
 const spinner = require("../src/util/spinner");
-const validate = require("../src/cli/validate");
 
 // [use]
 
 const abort = output.abort;
-const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const print = output.print;
 const resolve = path.resolve;
@@ -62,26 +58,16 @@ const start = function (argv) {
   let parsed = null;
   // what --json lists under `warnings`.
   let warnings = [];
-  let sw = new SpinnerWheel("Validating... %s");
+  let sw = new SpinnerWheel("Validating… %s");
   sw.start(json || quiet);
-  return project(root)
+  return checked(root, (found) => {
+    warnings = found;
+  })
     .then((proj) => {
       parsed = proj;
-      return validate({ project: parsed, root });
-    })
-    .then((validated) => {
-      const count = validated.issues.length;
-      warnings = validated.warnings;
-      if (count) {
-        throw new ArcError(
-          cfgcode.VALIDATION_FAILED,
-          phrase.issuesFound(count),
-          { data: { issues: validated.issues } },
-        );
-      }
       sw.stop(true);
       warn(warnings, { json, quiet });
-      sw = new SpinnerWheel("Packing... %s");
+      sw = new SpinnerWheel("Packing… %s");
       sw.start(json || quiet);
       return pack({
         input: argv.input,
@@ -116,13 +102,13 @@ const main = function (argv) {
       .option("input", {
         alias: "i",
         default: conf.input,
-        describe: "Set the input directory",
+        describe: "Pack this directory instead of deploy_dir",
         type: "string",
       })
       .option("output", {
         alias: "o",
         default: conf.output,
-        describe: "Set the output file",
+        describe: "Write the zip to this path",
         type: "string",
       })
       .option("json", { ...args.JSON_OUTPUT, default: conf.json })

package/bin/arc-play.js

@@ -64,7 +64,7 @@ const handler = function ({ quiet, sw }) {
 // [function]
 
 const start = function (argv) {
-  const sw = new SpinnerWheel("Opening... %s");
+  const sw = new SpinnerWheel("Opening… %s");
   return play({
     game: argv.game,
     handler: handler({ quiet: argv.quiet, sw }),

package/bin/arc-serve.js

@@ -111,7 +111,7 @@ const start = function (argv) {
   // `.arcrc` values are strings, and a flag that isn't a number is NaN.
   const port = Number(argv.port);
   const root = resolve(process.cwd(), argv.cwd);
-  const sw = new SpinnerWheel("Building... %s");
+  const sw = new SpinnerWheel("Building… %s");
   return checkPort(port)
     .then(() => checkUrl(argv.url))
     .then((url) =>
@@ -141,7 +141,7 @@ const start = function (argv) {
       process.once("SIGTERM", stop);
       if (!quiet) {
         log.result(phrase.served(served), [
-          ["Play:", `${served.page}/`],
+          [phrase.playLabel(), `${served.page}/`],
           [phrase.serveAlone(), served.game],
           served.url
             ? phrase.serveNextUrl()
@@ -173,7 +173,7 @@ const main = function (argv) {
       .option("port", {
         alias: "p",
         default: conf.port,
-        describe: "Port to serve on",
+        describe: "Serve on this port",
         type: "number",
       })
       .option("build", {
@@ -182,6 +182,7 @@ const main = function (argv) {
         type: "boolean",
       })
       .option("url", {
+        default: conf.url,
         describe: "Frame another server's page instead of deploy_dir",
         type: "string",
       })

package/bin/arc-validate.js

@@ -26,6 +26,7 @@ const validate = require("../src/cli/validate");
 
 const abort = output.abort;
 const dereference = schema.dereference;
+const exit = output.exit;
 const findRc = rc.findRc;
 const print = output.print;
 const resolve = path.resolve;
@@ -75,7 +76,7 @@ const start = function (argv) {
           log.hs(phrase.noIssuesFound());
         }
       }
-      process.exit(count ? 1 : 0);
+      return exit(count ? 1 : 0);
     })
     .catch((ex) => abort(phrase.aborted(COMMAND), ex, { json }));
 };

package/bin/arc-whoami.js

@@ -54,7 +54,7 @@ const handler = function ({ json, sw }) {
 
 const start = function (argv) {
   const json = argv.json;
-  const sw = new SpinnerWheel("Checking... %s");
+  const sw = new SpinnerWheel("Checking… %s");
   return whoami({ handler: handler({ json, sw }) })
     .then((current) => {
       const user = current?.user;

package/package.json

@@ -65,5 +65,5 @@
   "scripts": {
     "test": "node --test \"test/**/*.test.js\""
   },
-  "version": "1.0.2"
+  "version": "1.0.4"
 }

package/src/account.js

@@ -102,7 +102,9 @@ const getSaved = function (onRefresh) {
   return readFile(file, "utf8")
     .then(JSON.parse)
     .catch((ex) => {
-      if (ex.code === "ENOENT") {
+      // a session file cut short (a full disk, a crash while saving) is no
+      // session: `arc login` writes a new one
+      if (ex.code === "ENOENT" || ex instanceof SyntaxError) {
         return null;
       }
       throw ex;

package/src/action/deploy/tool.js

@@ -33,18 +33,19 @@ const uploadBuild = function (current, artifact, { id, version }, onProgress) {
           s3.upload(upload.upload_url, artifact, onProgress),
         ]),
       (err) => {
-        // the API refuses a game that was deleted or is another account's,
-        // and the same version uploaded again within 5 minutes.
+        // the API refuses a game that was deleted or is another account's
+        // (403), and the same version deployed again within 5 minutes (429).
         if (err.status === 403) {
           throw new ArcError(
             cfgcode.GAME_UNAVAILABLE,
             phrase.gameUnavailable(id),
+            { cause: err },
           );
         }
         if (err.status === 429) {
           throw new ArcError(
-            cfgcode.UPLOAD_RATE_LIMITED,
-            phrase.uploadRateLimited(version),
+            cfgcode.DEPLOY_RATE_LIMITED,
+            phrase.deployRateLimited(version),
             { cause: err },
           );
         }

package/src/action/predeploy/ac.js

@@ -68,7 +68,10 @@ const ensureHandle = function (current, { handle, id, version }, handler) {
         );
       }
       if (status === "limit") {
-        warn(cfgcode.WARNING.GAME_HANDLE_LIMIT, phrase.gameHandleLimit(handle));
+        warn(
+          cfgcode.WARNING.GAME_HANDLE_LIMIT_REACHED,
+          phrase.gameHandleLimit(handle),
+        );
         return true;
       }
       if (status === "lapsed") {

package/src/action/serve/tool.js

@@ -6,6 +6,7 @@
 // [import]
 
 const path = require("node:path");
+const timers = require("node:timers/promises");
 
 // [import]
 
@@ -39,6 +40,7 @@ const relative = path.relative;
 const remoteFiles = remote.remoteFiles;
 const resolvePath = path.resolve;
 const serve = server.serve;
+const sleep = timers.setTimeout;
 const watchDir = reload.watchDir;
 
 // [declare]
@@ -48,7 +50,7 @@ const CHANNEL = "local";
 // the saves of a game with no id yet, kept apart from any other's.
 const UNNAMED = "local";
 
-// [function]
+// [declare]
 
 // the headers a page needs for the play page to frame it: the play page is
 // cross-origin isolated, so a cross-origin frame must be too, and allow it.
@@ -57,19 +59,33 @@ const FRAMEABLE = {
   "cross-origin-resource-policy": ["cross-origin"],
 };
 
+// [declare]
+
+// how long `url` has to answer before it counts as unreachable: a server
+// that takes the connection and never answers would otherwise hold `arc
+// serve` for minutes.
+const PROBE_MS = 10000;
+
 // [function]
 
 // what `url` says when asked: `{ reachable, frameable }`, where `frameable`
 // says whether it sends the headers the play page needs to frame it.
 const probe = async function (url) {
   try {
-    const res = await fetch(url, { method: "GET" });
+    // null when it hasn't answered in time
+    const res = await Promise.race([
+      fetch(url, { method: "GET" }),
+      sleep(PROBE_MS, null, { ref: false }),
+    ]);
+    if (!res) {
+      return { frameable: false, reachable: false };
+    }
     await res.body?.cancel();
     const frameable = Object.entries(FRAMEABLE).every(([name, values]) =>
       values.includes(res.headers.get(name)?.trim().toLowerCase()),
     );
     return { frameable, reachable: true };
-  } catch (ex) {
+  } catch {
     return { frameable: false, reachable: false };
   }
 };

package/src/action/validate/checked.js

@@ -0,0 +1,37 @@
+"use strict";
+
+// [import]
+
+const cfgcode = require("../../config/code");
+const error = require("../../util/error");
+const phrase = require("../../phrase");
+const project = require("../../parser/project");
+const validateTool = require("./tool");
+
+// [use]
+
+const ArcError = error.ArcError;
+
+// [function]
+
+// parses and validates the project at `root` for a command that goes on from
+// it (arc build, arc pack, arc deploy): resolves with the parsed project, or
+// rejects as validation_failed with its issues in `data`. `onWarnings` gets
+// the warnings either way, for --json to list beside the result or the error.
+const checked = async function (root, onWarnings) {
+  const parsed = await project(root);
+  const { issues, warnings } = await validateTool({ project: parsed, root });
+  onWarnings(warnings);
+  if (issues.length) {
+    throw new ArcError(
+      cfgcode.VALIDATION_FAILED,
+      phrase.issuesFound(issues.length),
+      { data: { issues } },
+    );
+  }
+  return parsed;
+};
+
+// [export]
+
+module.exports = checked;

package/src/api.js

@@ -11,6 +11,18 @@ const VERSION = "v1";
 
 // [function]
 
+// an API path with each value encoded as one segment, so a handle or version
+// can't add a segment or a query: pathOf`/games/${id}`.
+const pathOf = function (strings, ...values) {
+  return strings.reduce(
+    (out, each, i) =>
+      out + each + (i < values.length ? encodeURIComponent(values[i]) : ""),
+    "",
+  );
+};
+
+// [function]
+
 // the full URL of an API path, with `params` as its query. Undefined and null
 // params are left out.
 const endpoint = function (path, params) {
@@ -45,7 +57,7 @@ const postFlow = function (form, params, headers) {
 // [function]
 
 const flow = function (id, params, headers) {
-  return request.get(endpoint(`/flows/${id}`, params), headers);
+  return request.get(endpoint(pathOf`/flows/${id}`, params), headers);
 };
 
 // [function]
@@ -57,20 +69,23 @@ const postUpload = function (form, params, headers) {
 // [function]
 
 const discoverGame = function (id, params, headers) {
-  return request.get(endpoint(`/discover/games/${id}`, params), headers);
+  return request.get(endpoint(pathOf`/discover/games/${id}`, params), headers);
 };
 
 // [function]
 
 const discoverGameBuilds = function (id, params, headers) {
-  return request.get(endpoint(`/discover/games/${id}/builds`, params), headers);
+  return request.get(
+    endpoint(pathOf`/discover/games/${id}/builds`, params),
+    headers,
+  );
 };
 
 // [function]
 
 const discoverGameBuild = function (id, version, params, headers) {
   return request.get(
-    endpoint(`/discover/games/${id}/builds/${version}`, params),
+    endpoint(pathOf`/discover/games/${id}/builds/${version}`, params),
     headers,
   );
 };
@@ -80,7 +95,7 @@ const discoverGameBuild = function (id, version, params, headers) {
 // a game's releases, which anyone can read: what each says about itself.
 const discoverGameReleases = function (id, params, headers) {
   return request.get(
-    endpoint(`/discover/games/${id}/releases`, params),
+    endpoint(pathOf`/discover/games/${id}/releases`, params),
     headers,
   );
 };
@@ -90,10 +105,7 @@ const discoverGameReleases = function (id, params, headers) {
 // the game's connected repository, if it's `owner/name`; otherwise 404.
 const discoverGameRepo = function (id, owner, name, params, headers) {
   return request.get(
-    endpoint(
-      `/discover/games/${id}/repos/${encodeURIComponent(owner)}/${encodeURIComponent(name)}`,
-      params,
-    ),
+    endpoint(pathOf`/discover/games/${id}/repos/${owner}/${name}`, params),
     headers,
   );
 };
@@ -102,7 +114,7 @@ const discoverGameRepo = function (id, owner, name, params, headers) {
 
 const gameBuild = function (id, version, params, headers) {
   return request.get(
-    endpoint(`/games/${id}/builds/${version}`, params),
+    endpoint(pathOf`/games/${id}/builds/${version}`, params),
     headers,
   );
 };
@@ -113,7 +125,7 @@ const gameBuild = function (id, version, params, headers) {
 // its status is available, taken, limit, or lapsed.
 const gameHandle = function (id, handle, params, headers) {
   return request.get(
-    endpoint(`/games/${id}/handles/${handle}`, params),
+    endpoint(pathOf`/games/${id}/handles/${handle}`, params),
     headers,
   );
 };
@@ -121,13 +133,16 @@ const gameHandle = function (id, handle, params, headers) {
 // [function]
 
 const release = function (id, params, headers) {
-  return request.get(endpoint(`/releases/${id}`, params), headers);
+  return request.get(endpoint(pathOf`/releases/${id}`, params), headers);
 };
 
 // [function]
 
 const accountReleases = function (id, params, headers) {
-  return request.get(endpoint(`/accounts/${id}/releases`, params), headers);
+  return request.get(
+    endpoint(pathOf`/accounts/${id}/releases`, params),
+    headers,
+  );
 };
 
 // [export]