arcadible 0.1.33 → 0.1.35

package/bin/arc-login.js

@@ -16,6 +16,7 @@ const cfgproduct = require("../src/config/product");
 const error = require("../src/util/error");
 const log = require("../src/util/log");
 const login = require("../src/cli/login");
+const output = require("../src/util/output");
 const phrase = require("../src/phrase");
 const rc = require("../src/util/rc");
 const shell = require("../src/util/shell");
@@ -23,6 +24,7 @@ const spinner = require("../src/util/spinner");
 
 // [use]
 
+const abort = output.abort;
 const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const launch = shell.launch;
@@ -70,10 +72,13 @@ const onLoginEnter = function (fn) {
 
 // [function]
 
-const handler = function ({ browser, qrcode: qr, sw }) {
+// `shown` is set once the link is printed, so a failure after it starts
+// after a blank line.
+const handler = function ({ browser, qrcode: qr, shown, sw }) {
   return {
     onLoginCreated({ code: dac, secret, url }) {
       sw.stop(true);
+      shown.link = true;
       const link = `${url}/${secret}`;
       log.p("Logging in...");
       qrcode.generate(link, { small: true }, (code) => {
@@ -82,7 +87,8 @@ const handler = function ({ browser, qrcode: qr, sw }) {
         }
         log.nlp(url);
         log.h(dac.toUpperCase());
-        if (browser) {
+        // a key press can only be read from a terminal.
+        if (browser && process.stdin.isTTY) {
           log.nlp("Press Enter to open the URL.");
           onLoginEnter(() => {
             launch(link);
@@ -96,10 +102,16 @@ const handler = function ({ browser, qrcode: qr, sw }) {
 // [function]
 
 const start = function (argv) {
+  const shown = { link: false };
   const sw = new SpinnerWheel("Logging in... %s");
   sw.start();
   return login({
-    handler: handler({ browser: argv.browser, qrcode: argv.qrcode, sw }),
+    handler: handler({
+      browser: argv.browser,
+      qrcode: argv.qrcode,
+      shown,
+      sw,
+    }),
   })
     .then((current) => {
       const user = current?.user;
@@ -111,11 +123,8 @@ const start = function (argv) {
       log.result("Logged in.", [user.display_name], { nl: true });
     })
     .catch((ex) => {
-      sw.stop(true);
       process.stdin.pause();
-      log.nlhd("Login aborted.");
-      log.pd(ex.message);
-      process.exit(1);
+      abort("Login aborted.", ex, { nl: shown.link, sw });
     });
 };
 

package/bin/arc-whoami.js

@@ -8,8 +8,8 @@ const yargs = require("yargs/yargs");
 
 // [import]
 
-const account = require("../src/account");
 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 log = require("../src/util/log");
@@ -76,7 +76,7 @@ const start = function (argv) {
     .catch((ex) => {
       const message = ex.message;
       // a session that can't be refreshed is no session: say so, and why.
-      if (ex.code === account.SESSION_EXPIRED) {
+      if (ex.code === cfgcode.SESSION_EXPIRED) {
         if (json) {
           print({ user: null });
         } else {

package/package.json

@@ -75,5 +75,5 @@
   "scripts": {
     "test": "node --test \"test/**/*.test.js\""
   },
-  "version": "0.1.33"
+  "version": "0.1.35"
 }

package/src/account.js

@@ -40,7 +40,6 @@ const FILE_MODE = 0o600;
 
 // the statuses that mean the refresh token itself was refused.
 const REJECTED = [400, 401, 403];
-const SESSION_EXPIRED = cfgcode.SESSION_EXPIRED;
 
 // [declare]
 
@@ -154,4 +153,4 @@ const remove = function () {
 
 // [export]
 
-module.exports = { SESSION_EXPIRED, get, remove, save };
+module.exports = { get, remove, save };

package/src/action/deploy/wait.js

@@ -19,7 +19,7 @@ const sleep = delay.sleep;
 const INTERVAL = time.s(2);
 const FINAL = new Set(["failed", "published"]);
 const SELECT =
-  "id,status,reason,message,build,source,version,channel,created_at";
+  "id,game,status,reason,message,build,source,version,channel,created_at";
 // a git release is found by version among the newest few; one from before
 // this deploy (a tag deleted and pushed again) is left out, allowing for
 // the machine's clock being off.
@@ -67,18 +67,26 @@ const findDirect = function (id, headers) {
 // [function]
 
 // a git deploy's release: GitHub's, for this version, made since the tag was
-// pushed. Null until GitHub Actions has built it.
-const findGit = function (game, version, since, headers) {
+// pushed. Null until GitHub Actions has built it. It's looked for among the
+// account's releases, which include one with no game: a repository that
+// isn't connected fails that way (repo_not_connected). A token's account
+// isn't known, so it looks among the game's.
+const findGit = function ({ account, game, headers, since, version }) {
+  const newest = account
+    ? () => api.accountReleases(account, { limit: 20, select: SELECT }, headers)
+    : () =>
+        api.gameReleases(game, { limit: 10, select: SELECT, version }, headers);
   return () =>
-    api
-      .gameReleases(game, { limit: 10, select: SELECT, version }, headers)
-      .then(
-        (rows) =>
-          (rows ?? []).find(
-            (r) =>
-              r.source === "github" && Date.parse(r.created_at) >= since - SKEW,
-          ) ?? null,
-      );
+    newest().then(
+      (rows) =>
+        (rows ?? []).find(
+          (r) =>
+            r.source === "github" &&
+            r.version === version &&
+            (r.game === game || r.game === null) &&
+            Date.parse(r.created_at) >= since - SKEW,
+        ) ?? null,
+    );
 };
 
 // [function]
@@ -128,7 +136,13 @@ const main = function (
   const headers = api.auth(current?.session?.access_token);
   const game = deployed.game;
   const find = isGit
-    ? findGit(game, deployed.version.to, since, headers)
+    ? findGit({
+        account: current?.user?.id ?? null,
+        game,
+        headers,
+        since,
+        version: deployed.version.to,
+      })
     : findDirect(deployed.release, headers);
   return Promise.all([
     poll(find, timeout, onRelease),

package/src/action/predeploy/git.js

@@ -20,6 +20,8 @@ const execFile = cp.execFile;
 
 const HANDLE = cfgproduct.handle;
 const PREFIX = `${HANDLE}/release/v`;
+// the release workflow, which builds the release on GitHub Actions.
+const WORKFLOW = ".github/workflows/arcadible-release.yml";
 
 // [function]
 
@@ -86,6 +88,17 @@ const ensureRepo = function (root) {
 
 // [function]
 
+// fails when HEAD has no release workflow, which Arcadible checks for when the
+// tag arrives (workflow_missing).
+const ensureWorkflow = function (root) {
+  return git(root, ["cat-file", "-e", `HEAD:${WORKFLOW}`]).then(
+    () => null,
+    failWith(cfgcode.WORKFLOW_MISSING, phrase.workflowMissing(WORKFLOW)),
+  );
+};
+
+// [function]
+
 const hasTagLocal = function (root, tag) {
   return git(root, ["tag", "--list", tag]).then((stdout) =>
     Boolean(stdout.trim()),
@@ -125,6 +138,7 @@ module.exports = {
   ensureRemote,
   ensureRepo,
   ensureTagFree,
+  ensureWorkflow,
   failWith,
   git,
   tagOf,

package/src/action/predeploy/tool-git.js

@@ -4,6 +4,7 @@
 
 const api = require("../../api");
 const cfgcode = require("../../config/code");
+const cfguri = require("../../config/uri");
 const error = require("../../util/error");
 const git = require("./git");
 const given = require("../../parser/given");
@@ -19,6 +20,7 @@ const ensureLockFile = pm.ensureLockFile;
 const ensureRemote = git.ensureRemote;
 const ensureRepo = git.ensureRepo;
 const ensureTagFree = git.ensureTagFree;
+const ensureWorkflow = git.ensureWorkflow;
 
 // [function]
 
@@ -68,35 +70,66 @@ const ensurePublishable = function ({ handle, id, version }, handler) {
 // [function]
 
 // the project's checks: a lockfile when there's a package.json, and a clean
-// repository with a reachable origin.
+// repository with the release workflow and a reachable origin.
 const ensureProject = function (root) {
   return ensureLockFile(root)
     .then(() => ensureRepo(root))
     .then(() => ensureClean(root))
+    .then(() => ensureWorkflow(root))
     .then(() => ensureRemote(root));
 };
 
 // [function]
 
-// the release's checks: its tag is free, and Arcadible would publish it.
-// resolves with the version, and the game's owner, who alone can wait for
-// the release.
-const ensureRelease = function (root, game, handler) {
+// fails when the game has no repository connected, which Arcadible would
+// refuse (repo_not_connected) after GitHub Actions had built it. Only the
+// game's owner can see its repository, so it's checked only when they're
+// logged in, and skipped when Arcadible can't be reached.
+const ensureConnected = function (current, { handle, id }, owner) {
+  if (!owner || current?.token || current?.user?.id !== owner) {
+    return Promise.resolve();
+  }
+  const headers = api.auth(current.session?.access_token);
+  return api.gameRepos(id, { select: "id" }, headers).then(
+    (repos) => {
+      if (!repos?.length) {
+        throw new ArcError(
+          cfgcode.REPO_NOT_CONNECTED,
+          phrase.gameRepoMissing(
+            handle ?? id,
+            `${cfguri.HOST_HTTP_STUDIO}/games/${id}/repository`,
+          ),
+        );
+      }
+    },
+    () => null,
+  );
+};
+
+// [function]
+
+// the release's checks: its tag is free, Arcadible would publish it, and its
+// repository is connected. resolves with the version, and the game's owner,
+// who alone can wait for the release.
+const ensureRelease = function (root, current, game, handler) {
   return ensureTagFree(root, game.version)
     .then(() => ensurePublishable(game, handler))
-    .then((owner) => ({ owner, to: game.version }));
+    .then((owner) =>
+      Promise.all([owner, ensureConnected(current, game, owner)]),
+    )
+    .then(([owner]) => ({ owner, to: game.version }));
 };
 
 // [function]
 
-const main = function (conf, { onPredeployBegin, ...handler }) {
+const main = function (current, conf, { onPredeployBegin, ...handler }) {
   const root = conf.root;
   if (onPredeployBegin) {
     onPredeployBegin();
   }
   return given(conf)
     .then(({ game }) => Promise.all([game, ensureProject(root)]))
-    .then(([game]) => ensureRelease(root, game, handler));
+    .then(([game]) => ensureRelease(root, current, game, handler));
 };
 
 // [export]

package/src/api.js

@@ -92,6 +92,18 @@ const release = function (id, params, headers) {
 
 // [function]
 
+const accountReleases = function (id, params, headers) {
+  return request.get(endpoint(`/accounts/${id}/releases`, params), headers);
+};
+
+// [function]
+
+const gameRepos = function (id, params, headers) {
+  return request.get(endpoint(`/games/${id}/repos`, params), headers);
+};
+
+// [function]
+
 const gameReleases = function (id, params, headers) {
   return request.get(endpoint(`/games/${id}/releases`, params), headers);
 };
@@ -99,6 +111,7 @@ const gameReleases = function (id, params, headers) {
 // [export]
 
 module.exports = {
+  accountReleases,
   auth,
   discoverGame,
   discoverGameBuild,
@@ -106,6 +119,7 @@ module.exports = {
   flow,
   gameBuild,
   gameReleases,
+  gameRepos,
   postAuthRefresh,
   postFlow,
   postUpload,

package/src/cli/predeploy.js

@@ -9,7 +9,7 @@ const predeployToolGit = require("../action/predeploy/tool-git");
 
 const main = function ({ current, git, handler, ...conf }) {
   return git
-    ? predeployToolGit(conf, handler)
+    ? predeployToolGit(current, conf, handler)
     : predeployTool(current, conf, handler);
 };
 

package/src/config/code.js

@@ -59,8 +59,8 @@ const RELEASE = {
   ZIP_TOO_LARGE: "zip_too_large",
 };
 // the Arcadible check's own codes on GitHub, for a `git` release that fails
-// before there's a release (the queue publisher Lambda). The CLI never
-// reports them, but they share the Errors page.
+// before there's a release (the queue publisher Lambda). `arc deploy git`
+// checks for workflow_missing before it pushes.
 const GITHUB = {
   TAG_INVALID: "tag_invalid",
   WORKFLOW_MISSING: "workflow_missing",
@@ -104,6 +104,7 @@ module.exports = {
   ALL,
   ...RELEASE,
   ...CLI,
+  ...GITHUB,
   GITHUB,
   ISSUE,
   ISSUES,

package/src/parser/env.js

@@ -25,6 +25,8 @@ const readFile = fs.readFile;
 
 // [declare]
 
+// the build a package.json build script stands for.
+const NPM_RUN_BUILD = "npm run build";
 const PACKAGE = "package.json";
 
 // [function]
@@ -51,10 +53,14 @@ const parseJson = function (buf) {
 
 // [function]
 
+// package.json's version, and its build script as `npm run build`: run
+// through npm, the script finds the project's own tools on the PATH
+// (node_modules/.bin), and its prebuild and postbuild run, as they do
+// locally. npm runs the scripts of a pnpm or Yarn project too.
 const extract = function (conf) {
   /* eslint-disable camelcase */
   const game = { version: conf.version };
-  const workflow = { build: conf.scripts?.build };
+  const workflow = conf.scripts?.build ? { build: NPM_RUN_BUILD } : {};
   /* eslint-enable camelcase */
   return deepCompact({ game, workflow }) ?? {};
 };

package/src/phrase.js

@@ -171,6 +171,15 @@ const gameNotDeployed = function (game) {
 
 // [function]
 
+const gameRepoMissing = function (game, url) {
+  return blocks(`${game} isn't connected to a GitHub repository.`, [
+    `Connect this repository in ${TITLE} Studio, on the game's Repository tab:`,
+    url,
+  ]);
+};
+
+// [function]
+
 const gameNotFound = function (idOrHandle) {
   return `Game not found: ${idOrHandle}`;
 };
@@ -465,14 +474,20 @@ const releaseTimedOut = function (
   seconds,
   { actions, found, git, studio },
 ) {
+  const head = `Waited ${waited(seconds)} for v${version}.`;
+  if (found || !git) {
+    return blocks(head, [
+      `It may still finish. See it in ${TITLE} Studio:`,
+      studio,
+    ]);
+  }
   return blocks(
-    `Waited ${waited(seconds)} for v${version}.`,
-    found || !git
-      ? [`It may still finish. See it in ${TITLE} Studio:`, studio]
-      : [
-          "GitHub Actions hasn't released it yet, or its workflow failed:",
-          actions ?? "See the repository's Actions tab.",
-        ],
+    head,
+    [
+      "GitHub Actions hasn't released it yet, or its workflow failed:",
+      actions ?? "See the repository's Actions tab.",
+    ],
+    `If the workflow passed, the ${TITLE} check on the tagged commit says why.`,
   );
 };
 
@@ -609,6 +624,15 @@ const uploadRateLimited = function (version) {
 
 // [function]
 
+const workflowMissing = function (file) {
+  return blocks(
+    `No release workflow found: ${file}`,
+    "Add it from your starter, and commit it.",
+  );
+};
+
+// [function]
+
 const versionPrerelease = function (version) {
   return `Prerelease v${version}`;
 };
@@ -729,6 +753,7 @@ module.exports = {
   gameExists,
   gameNotDeployed,
   gameNotFound,
+  gameRepoMissing,
   gameUnavailable,
   gitChangesPresent,
   gitRemoteMissing,
@@ -804,4 +829,5 @@ module.exports = {
   videoUnsupported,
   videoWidthMax,
   videoWidthMin,
+  workflowMissing,
 };

package/src/schema/game.js

@@ -130,6 +130,19 @@ const atLeast = function (field, min, unit) {
 
 // [function]
 
+// a required string's error: "Must be defined." 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;
+  return {
+    error(issue) {
+      return typeof issue.input === "undefined" ? missing : null;
+    },
+  };
+};
+
+// [function]
+
 // a list of distinct values. Without a max, its length is up to the values.
 const zSet = function (field, schema, { max = Infinity, min }) {
   return z
@@ -422,6 +435,7 @@ const zHandle = function () {
   return z.optional(
     z
       .string()
+      .min(1, { ...atLeast(field, 1), abort: true })
       .regex(
         /^[a-z0-9](?:(?![-]{2})[a-z0-9-]){1,22}[a-z0-9]$/u,
         message(field, ["Contains invalid characters."]),
@@ -435,10 +449,7 @@ const zId = function () {
   const field = "id";
   return z
     .string(
-      message(field, [
-        "Must be defined.",
-        `Run ${phrase.cmdInit()} to generate a new game ID.`,
-      ]),
+      required(field, [`Run ${phrase.cmdInit()} to generate a new game ID.`]),
     )
     .uuid(message(field, ["Must be a valid UUID."]))
     .refine(
@@ -499,6 +510,7 @@ const zTrailer = function () {
   const field = "trailer";
   return z
     .string()
+    .min(1, { ...atLeast(field, 1), abort: true })
     .max(255, message(field, ["Must not exceed: 255 characters"]))
     .refine(
       (url) =>
@@ -514,10 +526,7 @@ const zVersion = function () {
   const field = "version";
   return z
     .string(
-      message(field, [
-        "Must be defined.",
-        "A version is required unless one can be derived.",
-      ]),
+      required(field, ["A version is required unless one can be derived."]),
     )
     .refine(
       (value) => validSemver(value) !== null,

package/src/util/output.js

@@ -62,13 +62,14 @@ const print = function (data, { key, nl, toml } = {}) {
 // 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
 // 1. `data`, and the error's own, go beside the error in JSON, such as the
-// release that failed.
+// release that failed. `nl` puts a blank line before the heading, after
+// output the command has already printed, such as arc login's link.
 // `code` is a failed release's reason, which the API may add to, so it isn't
 // checked, and its message already says it.
 const abort = function (
   heading,
   ex,
-  { code, data, json = false, pb, sw } = {},
+  { code, data, json = false, nl = false, pb, sw } = {},
 ) {
   const message = ex.message;
   const status = ex.status;
@@ -89,7 +90,11 @@ const abort = function (
     if (sw) {
       sw.stop(true);
     }
-    log.hd(heading);
+    if (nl) {
+      log.nlhd(heading);
+    } else {
+      log.hd(heading);
+    }
     log.pd(message);
     if (!code) {
       log.nlpd([