arcadible 0.1.43 → 0.1.44

package/bin/arc-build.js

@@ -36,6 +36,7 @@ const relative = path.relative;
 const resolve = path.resolve;
 const SpinnerWheel = spinner.SpinnerWheel;
 const warn = output.warn;
+const warning = output.warning;
 
 // [declare]
 
@@ -59,6 +60,8 @@ const start = function (argv) {
   const root = resolve(process.cwd(), argv.cwd);
   // the project, parsed once for both steps.
   let parsed = null;
+  // what --json lists under `warnings`.
+  let warnings = [];
   let sw = new SpinnerWheel("Validating... %s");
   sw.start(json || quiet);
   return project(root)
@@ -66,13 +69,14 @@ const start = function (argv) {
       parsed = proj;
       return validate({ project: parsed, root });
     })
-    .then(({ issues, warnings }) => {
-      const count = issues.length;
+    .then((validated) => {
+      const count = validated.issues.length;
+      warnings = validated.warnings;
       if (count) {
         throw new ArcError(
           cfgcode.VALIDATION_FAILED,
           phrase.issuesFound(count),
-          { data: { issues } },
+          { data: { issues: validated.issues } },
         );
       }
       sw.stop(true);
@@ -83,7 +87,16 @@ const start = function (argv) {
     })
     .then((artifact) => {
       if (json) {
-        print({ artifact });
+        const missing = artifact?.missing
+          ? [
+              warning(
+                cfgcode.WARNING.DEPLOY_DIR_NOT_BUILT,
+                phrase.buildOutputMissing(relative(root, artifact.missing)),
+                "workflow.deploy_dir",
+              ),
+            ]
+          : [];
+        print({ artifact, warnings: [...warnings, ...missing] });
         return;
       }
       if (!quiet) {
@@ -103,7 +116,9 @@ const start = function (argv) {
         log.hs("Nothing to do.");
       }
     })
-    .catch((ex) => abort("Build aborted.", ex, { json, sw }));
+    .catch((ex) =>
+      abort("Build aborted.", ex, { data: { warnings }, json, sw }),
+    );
 };
 
 // [function]

package/bin/arc-deploy.js

@@ -42,6 +42,7 @@ const ProgressBar = progress.ProgressBar;
 const resolve = path.resolve;
 const SpinnerWheel = spinner.SpinnerWheel;
 const warn = output.warn;
+const warning = output.warning;
 
 // [declare]
 
@@ -65,7 +66,9 @@ const conf = {
 
 // [function]
 
-const handler = function ({ json, pb, quiet, sw }) {
+// `warnings` collects what --json lists, such as a version that couldn't be
+// checked.
+const handler = function ({ json, pb, quiet, sw, warnings }) {
   return {
     onAccountRefresh(refresh) {
       sw.start(json || quiet);
@@ -76,7 +79,10 @@ const handler = function ({ json, pb, quiet, sw }) {
         pb.start();
       }
     },
-    onLogInfo({ level, message }) {
+    onLogInfo({ code, level, message }) {
+      if (code) {
+        warnings.push(warning(code, message));
+      }
       if (!json && !quiet) {
         switch (level) {
           case "warn":
@@ -253,6 +259,8 @@ const start = function (argv) {
   // the project, parsed once and given to each step. A build can write files
   // the manifest reads, such as art, so it's parsed again after one runs.
   let parsed = null;
+  // what --json lists under `warnings`: arc validate's, then the deploy's.
+  const warnings = [];
   let sw = new SpinnerWheel("Validating... %s");
   sw.start(json || quiet);
   return checkTimeout(timeout)
@@ -261,26 +269,29 @@ const start = function (argv) {
       parsed = proj;
       return validate({ project: parsed, root });
     })
-    .then(({ issues, warnings }) => {
-      const count = issues.length;
+    .then((validated) => {
+      const count = validated.issues.length;
+      warnings.push(...validated.warnings);
       if (count) {
         throw new ArcError(
           cfgcode.VALIDATION_FAILED,
           phrase.issuesFound(count),
-          { data: { issues } },
+          { data: { issues: validated.issues } },
         );
       }
       sw.stop(true);
-      warn(warnings, { json, quiet });
+      warn(validated.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
       // own releases, which also say when the repository isn't connected.
       if (git) {
-        return whoamiIfAny({ handler: handler({ json, pb, quiet, sw }) });
+        return whoamiIfAny({
+          handler: handler({ json, pb, quiet, sw, warnings }),
+        });
       }
-      return whoami({ handler: handler({ json, pb, quiet, sw }) });
+      return whoami({ handler: handler({ json, pb, quiet, sw, warnings }) });
     })
     .then((current) => {
       if (!current && !git) {
@@ -295,7 +306,7 @@ const start = function (argv) {
         predeploy({
           current,
           git,
-          handler: handler({ json, pb, quiet, sw }),
+          handler: handler({ json, pb, quiet, sw, warnings }),
           project: parsed,
           root,
         }),
@@ -359,7 +370,7 @@ const start = function (argv) {
           artifact,
           current,
           git,
-          handler: handler({ json, pb, quiet, sw }),
+          handler: handler({ json, pb, quiet, sw, warnings }),
           project: parsed,
           root,
         }),
@@ -376,7 +387,7 @@ const start = function (argv) {
       const shown = { ...deployed };
       delete shown.game;
       delete shown.release;
-      const result = git ? shown : { built, ...shown };
+      const result = { ...(git ? shown : { built, ...shown }), warnings };
       sw.stop(true);
       if (argv.wait) {
         return waitAndReport(current, deployed, result, {
@@ -396,7 +407,9 @@ const start = function (argv) {
       }
       return null;
     })
-    .catch((ex) => abort("Deploy aborted.", ex, { json, pb, sw }));
+    .catch((ex) =>
+      abort("Deploy aborted.", ex, { data: { warnings }, json, pb, sw }),
+    );
 };
 
 // [function]

package/bin/arc-pack.js

@@ -60,6 +60,8 @@ const start = function (argv) {
   const root = resolve(process.cwd(), argv.cwd);
   // the project, parsed once for both steps.
   let parsed = null;
+  // what --json lists under `warnings`.
+  let warnings = [];
   let sw = new SpinnerWheel("Validating... %s");
   sw.start(json || quiet);
   return project(root)
@@ -67,13 +69,14 @@ const start = function (argv) {
       parsed = proj;
       return validate({ project: parsed, root });
     })
-    .then(({ issues, warnings }) => {
-      const count = issues.length;
+    .then((validated) => {
+      const count = validated.issues.length;
+      warnings = validated.warnings;
       if (count) {
         throw new ArcError(
           cfgcode.VALIDATION_FAILED,
           phrase.issuesFound(count),
-          { data: { issues } },
+          { data: { issues: validated.issues } },
         );
       }
       sw.stop(true);
@@ -89,7 +92,7 @@ const start = function (argv) {
     })
     .then((artifact) => {
       if (json) {
-        print({ artifact });
+        print({ artifact, warnings });
         return;
       }
       if (!quiet) {
@@ -98,7 +101,9 @@ const start = function (argv) {
         print(artifact, { nl: true, toml: true });
       }
     })
-    .catch((ex) => abort("Pack aborted.", ex, { json, sw }));
+    .catch((ex) =>
+      abort("Pack aborted.", ex, { data: { warnings }, json, sw }),
+    );
 };
 
 // [function]

package/package.json

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

package/src/action/login/flow.js

@@ -28,7 +28,7 @@ const POLL = {
   interval: time.s(15),
   maxDelay: time.s(5),
   timeoutError: () =>
-    new ArcError(cfgcode.LOGIN_EXPIRED, phrase.loginExpired()),
+    new ArcError(cfgcode.LOGIN_CODE_EXPIRED, phrase.loginCodeExpired()),
 };
 
 // [function]
@@ -73,7 +73,10 @@ const pollFlow = function (value, onLoginPoll) {
       case "failed":
         throw new ArcError(cfgcode.LOGIN_FAILED, phrase.loginFailed());
       default:
-        throw new ArcError(cfgcode.LOGIN_EXPIRED, phrase.loginExpired());
+        throw new ArcError(
+          cfgcode.LOGIN_CODE_EXPIRED,
+          phrase.loginCodeExpired(),
+        );
     }
   });
 };

package/src/action/pack/tool.js

@@ -69,15 +69,26 @@ const verifyTotal = function (zip) {
 
 // [function]
 
-const pack = function (name, game, { inputPath, mediaPath, outputPath }) {
+// `deployDir` when the input is deploy_dir, rather than a folder --input
+// named: a missing deploy_dir means the build hasn't written it.
+const pack = function (
+  name,
+  game,
+  { deployDir, inputPath, mediaPath, outputPath },
+) {
   const zip = new Zip(name);
   return pathExists(inputPath)
     .then((existsInput) => {
       if (!existsInput) {
-        throw new ArcError(
-          cfgcode.PATH_NOT_FOUND,
-          phrase.unableToFind(inputPath),
-        );
+        throw deployDir
+          ? new ArcError(
+              cfgcode.DEPLOY_DIR_MISSING,
+              phrase.deployDirMissing(inputPath),
+            )
+          : new ArcError(
+              cfgcode.PATH_NOT_FOUND,
+              phrase.unableToFind(inputPath),
+            );
       }
       zip.addDir(inputPath);
       return zip;
@@ -105,8 +116,11 @@ const main = function ({ input, output, ...conf }) {
   return given(conf).then(({ game, workflow }) => {
     const name = game.handle ?? game.id;
     const file = output ?? `${OUTPUT}/${name}-v${game.version}.zip`;
+    const deployDir = resolve(root, workflow.deploy_dir);
+    const inputPath = resolve(root, input ?? workflow.deploy_dir);
     return pack(parse(file).name, game, {
-      inputPath: resolve(root, input ?? workflow.deploy_dir),
+      deployDir: inputPath === deployDir,
+      inputPath,
       mediaPath: resolve(root, MEDIA),
       outputPath: resolve(root, file),
     });

package/src/action/predeploy/git.js

@@ -77,11 +77,28 @@ const ensureClean = function (root) {
 
 // [function]
 
+// fails with git_remote_missing when there's no origin, and with
+// git_remote_unreachable when it's there but can't be reached.
 const ensureRemote = function (root) {
-  return git(root, ["ls-remote", "origin"]).then(
-    () => null,
-    failWith(cfgcode.GIT_REMOTE_UNAVAILABLE, phrase.gitRemoteMissing()),
-  );
+  return git(root, ["remote", "get-url", "origin"])
+    .then(
+      () => null,
+      failWith(cfgcode.GIT_REMOTE_MISSING, phrase.gitRemoteMissing()),
+    )
+    .then(() => git(root, ["ls-remote", "origin"]))
+    .then(
+      () => null,
+      // git_remote_missing passes through.
+      (err) => {
+        if (err instanceof ArcError) {
+          throw err;
+        }
+        failWith(
+          cfgcode.GIT_REMOTE_UNREACHABLE,
+          phrase.gitRemoteUnreachable(),
+        )(err);
+      },
+    );
 };
 
 // [function]
@@ -168,7 +185,7 @@ const hasTagLocal = function (root, tag) {
 const hasTagRemote = function (root, tag) {
   return git(root, ["ls-remote", "--tags", "origin", `refs/tags/${tag}`]).then(
     (stdout) => Boolean(stdout.trim()),
-    failWith(cfgcode.GIT_REMOTE_UNAVAILABLE, phrase.gitRemoteMissing()),
+    failWith(cfgcode.GIT_REMOTE_UNREACHABLE, phrase.gitRemoteUnreachable()),
   );
 };
 

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

@@ -57,6 +57,7 @@ const ensurePublishable = function ({ handle, id, version }, handler) {
     if (game === null || build === null) {
       if (handler.onLogInfo) {
         handler.onLogInfo({
+          code: cfgcode.WARNING.VERSION_UNCHECKED,
           level: "warn",
           message: phrase.versionUnchecked(version),
         });

package/src/action/validate/unknown.js

@@ -11,7 +11,7 @@ const workflow = require("../../schema/workflow");
 // [use]
 
 const closest = strs.closest;
-const ISSUE = cfgcode.ISSUE;
+const WARNING = cfgcode.WARNING;
 
 // [function]
 
@@ -29,7 +29,7 @@ const known = function (root) {
 // it's reported without failing, with the name it might have meant.
 const warning = function (path, message, near) {
   return {
-    code: ISSUE.FIELD_UNKNOWN,
+    code: WARNING.FIELD_UNKNOWN,
     details: near ? [`Did you mean: ${near}?`] : [],
     link: null,
     message,

package/src/config/code.js

@@ -8,24 +8,26 @@
 
 // the CLI's own codes.
 const CLI = {
-  API_ERROR: "api_error",
+  API_REFUSED: "api_refused",
+  API_UNREACHABLE: "api_unreachable",
   ARGUMENT_INVALID: "argument_invalid",
   BUILD_FAILED: "build_failed",
+  DEPLOY_DIR_MISSING: "deploy_dir_missing",
   GAME_EXISTS: "game_exists",
   GAME_ID_MISSING: "game_id_missing",
   GAME_NOT_DEPLOYED: "game_not_deployed",
   GAME_NOT_FOUND: "game_not_found",
-  GIT_REMOTE_UNAVAILABLE: "git_remote_unavailable",
+  GIT_REMOTE_MISSING: "git_remote_missing",
+  GIT_REMOTE_UNREACHABLE: "git_remote_unreachable",
   GIT_REPO_MISSING: "git_repo_missing",
   GIT_TAG_CREATE_FAILED: "git_tag_create_failed",
   GIT_TAG_EXISTS: "git_tag_exists",
   GIT_TAG_PUSH_FAILED: "git_tag_push_failed",
   GIT_UNCOMMITTED: "git_uncommitted",
   LOCKFILE_MISSING: "lockfile_missing",
-  LOGIN_EXPIRED: "login_expired",
+  LOGIN_CODE_EXPIRED: "login_code_expired",
   LOGIN_FAILED: "login_failed",
   MANIFEST_MISSING: "manifest_missing",
-  NETWORK_ERROR: "network_error",
   NOT_LOGGED_IN: "not_logged_in",
   PACKAGE_FILE_TOO_LARGE: "package_file_too_large",
   PACKAGE_INDEX_MISSING: "package_index_missing",
@@ -48,24 +50,26 @@ const CLI = {
 // thing wherever it appears: GAME_UNAVAILABLE, INTERNAL, REPO_NOT_CONNECTED,
 // and VERSION_EXISTS are the CLI's too.
 const RELEASE = {
-  APP_NOT_INSTALLED: "app_not_installed",
-  EXPIRED: "expired",
+  BUILD_RATE_LIMITED: "build_rate_limited",
   GAME_LIMIT_REACHED: "game_limit_reached",
   GAME_MISMATCH: "game_mismatch",
   GAME_UNAVAILABLE: "game_unavailable",
+  GITHUB_APP_NOT_INSTALLED: "github_app_not_installed",
   INTERNAL: "internal",
   MANIFEST_INVALID: "manifest_invalid",
-  RATE_LIMITED: "rate_limited",
+  RELEASE_EXPIRED: "release_expired",
   REPO_NOT_CONNECTED: "repo_not_connected",
   VERSION_EXISTS: "version_exists",
+  VERSION_MISMATCH: "version_mismatch",
   ZIP_INVALID: "zip_invalid",
+  ZIP_MISSING: "zip_missing",
   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). `arc deploy git`
+// before there's a release (the queue publisher and subscriber Lambdas). `arc deploy git`
 // checks for workflow_missing before it pushes.
 const GITHUB = {
-  TAG_INVALID: "tag_invalid",
+  GIT_TAG_INVALID: "git_tag_invalid",
   WORKFLOW_MISSING: "workflow_missing",
 };
 // an `arc validate` issue's codes, named for the rule it breaks; the field
@@ -76,7 +80,6 @@ const ISSUE = {
   DESCRIPTION_RULES_MISSING: "description_rules_missing",
   DUPLICATE: "duplicate",
   EMPTY: "empty",
-  FIELD_UNKNOWN: "field_unknown",
   INDEX_MISSING: "index_missing",
   INVALID: "invalid",
   MARKDOWN_INVALID: "markdown_invalid",
@@ -93,6 +96,14 @@ const ISSUE = {
   UUID_INVALID: "uuid_invalid",
   VERSION_INVALID: "version_invalid",
 };
+// a warning's codes: what's reported without failing, in an issue's shape.
+// they follow the same rules, and share the Errors page, so no warning code
+// is also an error or issue code.
+const WARNING = {
+  DEPLOY_DIR_NOT_BUILT: "deploy_dir_not_built",
+  FIELD_UNKNOWN: "field_unknown",
+  VERSION_UNCHECKED: "version_unchecked",
+};
 // every error code, for checking one exists.
 const ALL = new Set([
   ...Object.values(CLI),
@@ -101,6 +112,8 @@ const ALL = new Set([
 ]);
 // every issue code.
 const ISSUES = new Set(Object.values(ISSUE));
+// every warning code.
+const WARNINGS = new Set(Object.values(WARNING));
 
 // [export]
 
@@ -113,4 +126,6 @@ module.exports = {
   ISSUE,
   ISSUES,
   RELEASE,
+  WARNING,
+  WARNINGS,
 };

package/src/phrase.js

@@ -101,6 +101,15 @@ const cmdValidate = function () {
 
 // [function]
 
+const deployDirMissing = function (dir) {
+  return blocks(
+    `Unable to find deploy_dir: ${dir}`,
+    "Run `arc build`, or set deploy_dir to the folder your build writes.",
+  );
+};
+
+// [function]
+
 const docAttrInvalid = function (tag, attr, value) {
   return `Value '${value}' is not valid for the '${attr}' attribute on the '${tag}' tag.`;
 };
@@ -207,8 +216,17 @@ const gitChangesPresent = function () {
 
 const gitRemoteMissing = function () {
   return blocks(
-    "Unable to access Git remote 'origin'.",
-    "Check that it exists and that you can access it.",
+    "No Git remote 'origin'.",
+    "Add the game's GitHub repository as origin.",
+  );
+};
+
+// [function]
+
+const gitRemoteUnreachable = function () {
+  return blocks(
+    "Unable to reach Git remote 'origin'.",
+    "Check your connection, and that you can access it.",
   );
 };
 
@@ -357,8 +375,8 @@ const issuesFound = function (count) {
 
 // [function]
 
-const loginExpired = function () {
-  return "Login request expired.";
+const loginCodeExpired = function () {
+  return "Login code expired.";
 };
 
 // [function]
@@ -469,10 +487,9 @@ const packageUncompressedTooLarge = function (size) {
 // and where to see it.
 // `studio` is the game's builds in Studio, for its owner; anyone else can't
 // open it.
-const releaseFailed = function ({ message, reason }, studio) {
+const releaseFailed = function ({ message }, studio) {
   return blocks(
     (message ?? "").split(/(?<=\.)\s+/u).join("\n"),
-    `Reason: ${reason}.`,
     ...(studio ? [[`${TITLE} Studio:`, studio]] : []),
   );
 };
@@ -767,6 +784,7 @@ module.exports = {
   buildSubmitted,
   cmdInit,
   cmdInspect,
+  deployDirMissing,
   docAttrInvalid,
   docAttrUnallowed,
   docCommentUnallowed,
@@ -783,6 +801,7 @@ module.exports = {
   gameUnavailable,
   gitChangesPresent,
   gitRemoteMissing,
+  gitRemoteUnreachable,
   gitRepoMissing,
   gitTagCreateFailed,
   gitTagPushFailed,
@@ -799,7 +818,7 @@ module.exports = {
   imageWidthMin,
   issuesAfterBuild,
   issuesFound,
-  loginExpired,
+  loginCodeExpired,
   loginFailed,
   noGameId,
   noLockFile,

package/src/util/error.js

@@ -32,14 +32,15 @@ const ArcError = class extends Error {
 
 // [function]
 
-// the code a failure reports: its own, api_error for a request the API
-// refused, or internal for anything else, which is a bug in the CLI.
+// the code a failure reports: its own, api_refused for a request the API
+// refused, or internal for a failure on Arcadible's side (a 5xx) and for
+// anything else, which is a bug in the CLI.
 const codeOf = function (ex) {
   if (ex instanceof ArcError) {
     return ex.code;
   }
-  if (ex instanceof HttpError) {
-    return cfgcode.API_ERROR;
+  if (ex instanceof HttpError && !(ex.status >= 500)) {
+    return cfgcode.API_REFUSED;
   }
   return cfgcode.INTERNAL;
 };

package/src/util/output.js

@@ -66,7 +66,7 @@ const print = function (data, { key, nl, toml } = {}) {
 // 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.
+// checked.
 const abort = function (
   heading,
   ex,
@@ -74,12 +74,15 @@ const abort = function (
 ) {
   const message = ex.message;
   const status = ex.status;
+  const shown = code ?? codeOf(ex);
+  const link = `${cfgurl.ERRORS}#${shown}`;
   if (json) {
     print({
       ...ex.data,
       ...data,
       error: {
-        code: code ?? codeOf(ex),
+        code: shown,
+        link,
         message,
         ...(status ? { status } : {}),
       },
@@ -97,12 +100,7 @@ const abort = function (
       log.hd(heading);
     }
     log.pd(message);
-    if (!code) {
-      log.nlpd([
-        phrase.errorCode(codeOf(ex)),
-        chalk.cyan.underline(`${cfgurl.ERRORS}#${codeOf(ex)}`),
-      ]);
-    }
+    log.nlpd([phrase.errorCode(shown), chalk.cyan.underline(link)]);
   }
   process.exit(1);
 };
@@ -119,6 +117,21 @@ const warn = function (warnings, { json, quiet } = {}) {
   warnings.forEach((each) => log.pw(`⚠ ${schema.print(each)}`));
 };
 
+// [function]
+
+// a warning of the command's own, in an issue's shape, as --json lists it
+// under `warnings` beside arc validate's: its code, and the link to it on
+// the Errors page. `path` is the field it's about, if any.
+const warning = function (code, message, path = null) {
+  return {
+    code,
+    details: [],
+    link: `${cfgurl.ERRORS}#${code}`,
+    message,
+    path,
+  };
+};
+
 // [export]
 
-module.exports = { abort, print, printJson, printToml, warn };
+module.exports = { abort, print, printJson, printToml, warn, warning };

package/src/util/request.js

@@ -53,7 +53,7 @@ const parse = function (resp) {
 
 // sends a request to a full URL. `headers` are added to the client's own, and
 // a form is sent as JSON. A request that gets no response, such as when
-// offline, rejects as network_error.
+// offline, rejects as api_unreachable.
 const send = function (method, url, form, headers = {}) {
   const all = {
     [`X-${CLIENT}-Client-Id`]: ID,
@@ -66,7 +66,7 @@ const send = function (method, url, form, headers = {}) {
     headers: all,
     method,
   }).then(parse, (ex) => {
-    throw new ArcError(cfgcode.NETWORK_ERROR, phrase.unableToReach(), {
+    throw new ArcError(cfgcode.API_UNREACHABLE, phrase.unableToReach(), {
       cause: ex,
     });
   });

package/src/util/s3.js

@@ -32,7 +32,7 @@ const requestOpts = function (size) {
 // [function]
 
 // puts the file to the upload link, and resolves once S3 accepts it. A
-// request that gets no response rejects as network_error; a file that can't
+// 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) {
   return new Promise((resolve, reject) => {
@@ -49,7 +49,7 @@ const upload = function (url, { path, size }, onProgress) {
     req.on("error", (ex) => {
       reject(
         readError ??
-          new ArcError(cfgcode.NETWORK_ERROR, phrase.unableToReach(), {
+          new ArcError(cfgcode.API_UNREACHABLE, phrase.unableToReach(), {
             cause: ex,
           }),
       );