arcadible 0.1.32 → 0.1.34

package/src/action/predeploy/tool.js

@@ -3,7 +3,7 @@
 // [import]
 
 const ac = require("./ac");
-const project = require("../../parser/project");
+const given = require("../../parser/given");
 
 // [use]
 
@@ -12,40 +12,14 @@ const ensureUnpublished = ac.ensureUnpublished;
 
 // [function]
 
-const ensure = function (current, game, cb) {
-  ensureId(current, game, (err) => {
-    if (err) {
-      cb(err);
-      return;
-    }
-    ensureUnpublished(current, game, (err) => {
-      if (err) {
-        cb(err);
-        return;
-      }
-      cb(null, { to: game.version });
-    });
-  });
-};
-
-// [function]
-
-const main = function (current, { root }, { onPredeployBegin }) {
+const main = function (current, conf, { onPredeployBegin }) {
   if (onPredeployBegin) {
-    onPredeployBegin({ root });
+    onPredeployBegin({ root: conf.root });
   }
-  return project(root).then(
-    ({ game }) =>
-      new Promise((resolve, reject) => {
-        ensure(current, game, (err, data) => {
-          if (err) {
-            reject(err);
-            return;
-          }
-          resolve(data);
-        });
-      }),
-  );
+  return given(conf)
+    .then(({ game }) => ensureId(current, game))
+    .then((game) => ensureUnpublished(current, game))
+    .then((game) => ({ to: game.version }));
 };
 
 // [export]

package/src/action/validate/tool.js

@@ -3,7 +3,7 @@
 // [import]
 
 const game = require("../../schema/game");
-const project = require("../../parser/project");
+const given = require("../../parser/given");
 const readme = require("../../schema/readme");
 const readmeFile = require("../../parser/readme-file");
 const schema = require("../../util/schema");
@@ -44,13 +44,14 @@ const validate = function (proj, readmeStructure, { root }) {
     const { file, ...value } = readmeStructure;
     results.push(readmeValidator(value, { file }));
   }
-  return results.flatMap((result) => result.issues).sort();
+  return results.flatMap((result) => result.issues).sort(schema.compare);
 };
 
 // [function]
 
-const main = function ({ root }) {
-  return Promise.all([project(root), structure(root)]).then(
+const main = function (conf) {
+  const root = conf.root;
+  return Promise.all([given(conf), structure(root)]).then(
     ([proj, readmeStructure]) => validate(proj, readmeStructure, { root }),
   );
 };

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,14 +111,15 @@ const gameReleases = function (id, params, headers) {
 // [export]
 
 module.exports = {
+  accountReleases,
   auth,
   discoverGame,
   discoverGameBuild,
   discoverGameBuilds,
-  endpoint,
   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

@@ -0,0 +1,112 @@
+"use strict";
+// every code a failure can have (OUTPUT.md, Codes), each with an entry on
+// the Errors page. A code names one condition with one fix, as its subject
+// then its state. It's never renamed, reused, or removed, and a new one can
+// be added in any release.
+
+// [declare]
+
+// the CLI's own codes.
+const CLI = {
+  API_ERROR: "api_error",
+  ARGUMENT_INVALID: "argument_invalid",
+  BUILD_FAILED: "build_failed",
+  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_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_FAILED: "login_failed",
+  NETWORK_ERROR: "network_error",
+  NOT_LOGGED_IN: "not_logged_in",
+  PACKAGE_FILE_TOO_LARGE: "package_file_too_large",
+  PACKAGE_INDEX_MISSING: "package_index_missing",
+  PACKAGE_TOO_LARGE: "package_too_large",
+  PACKAGE_TOO_MANY_FILES: "package_too_many_files",
+  PACKAGE_UNCOMPRESSED_TOO_LARGE: "package_uncompressed_too_large",
+  PARSE_FAILED: "parse_failed",
+  PATH_NOT_FOUND: "path_not_found",
+  SESSION_EXPIRED: "session_expired",
+  TEMPLATE_MISSING: "template_missing",
+  TEMPLATE_UNAVAILABLE: "template_unavailable",
+  UPLOAD_FAILED: "upload_failed",
+  UPLOAD_RATE_LIMITED: "upload_rate_limited",
+  VALIDATION_FAILED: "validation_failed",
+  WAIT_TIMED_OUT: "wait_timed_out",
+};
+// a release's reasons, from the pipeline (the API's
+// db/type/release_reason.sql). The CLI shares them, so a name means the same
+// thing wherever it appears: GAME_UNAVAILABLE, INTERNAL, and VERSION_EXISTS
+// are the CLI's too.
+const RELEASE = {
+  APP_NOT_INSTALLED: "app_not_installed",
+  EXPIRED: "expired",
+  GAME_MISMATCH: "game_mismatch",
+  GAME_UNAVAILABLE: "game_unavailable",
+  INTERNAL: "internal",
+  MANIFEST_INVALID: "manifest_invalid",
+  RATE_LIMITED: "rate_limited",
+  REPO_NOT_CONNECTED: "repo_not_connected",
+  VERSION_EXISTS: "version_exists",
+  ZIP_INVALID: "zip_invalid",
+  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`
+// checks for workflow_missing before it pushes.
+const GITHUB = {
+  TAG_INVALID: "tag_invalid",
+  WORKFLOW_MISSING: "workflow_missing",
+};
+// an `arc validate` issue's codes, named for the rule it breaks; the field
+// is the issue's path. They follow the same rules, and share the Errors
+// page, so no issue code is also an error code.
+const ISSUE = {
+  CHARACTERS_INVALID: "characters_invalid",
+  DESCRIPTION_RULES_MISSING: "description_rules_missing",
+  DUPLICATE: "duplicate",
+  EMPTY: "empty",
+  INDEX_MISSING: "index_missing",
+  INVALID: "invalid",
+  MARKDOWN_INVALID: "markdown_invalid",
+  MEDIA_INVALID: "media_invalid",
+  OPTION_INVALID: "option_invalid",
+  OUT_OF_RANGE: "out_of_range",
+  PATH_INVALID: "path_invalid",
+  REQUIRED: "required",
+  TOO_LONG: "too_long",
+  TOO_MANY: "too_many",
+  TOO_SHORT: "too_short",
+  TYPE_INVALID: "type_invalid",
+  URL_INVALID: "url_invalid",
+  UUID_INVALID: "uuid_invalid",
+  VERSION_INVALID: "version_invalid",
+};
+// every error code, for checking one exists.
+const ALL = new Set([
+  ...Object.values(CLI),
+  ...Object.values(GITHUB),
+  ...Object.values(RELEASE),
+]);
+// every issue code.
+const ISSUES = new Set(Object.values(ISSUE));
+
+// [export]
+
+module.exports = {
+  ALL,
+  ...RELEASE,
+  ...CLI,
+  ...GITHUB,
+  GITHUB,
+  ISSUE,
+  ISSUES,
+  RELEASE,
+};

package/src/config/url.js

@@ -12,7 +12,8 @@ const HANDLE = cfgproduct.handle;
 // [export]
 
 module.exports = {
-  GETTING_STARTED: `${cfguri.HOST_HTTP_DEVELOPER}/guides/games/getting-started`,
+  ERRORS: `${cfguri.HOST_HTTP_DEVELOPER}/references/errors`,
+  GETTING_STARTED: `${cfguri.HOST_HTTP_DEVELOPER}/getting-started`,
   LINK: `${cfguri.HOST_HTTP_ACCOUNT}/link`,
   MANIFEST: `${cfguri.HOST_HTTP_DEVELOPER}/references/${HANDLE}-manifest`,
 };

package/src/parser/env.js

@@ -10,11 +10,14 @@ const fs = require("fs-extra");
 
 // [import]
 
+const cfgcode = require("../config/code");
+const error = require("../util/error");
 const objs = require("../util/objs");
 const phrase = require("../phrase");
 
 // [use]
 
+const ArcError = error.ArcError;
 const deepCompact = objs.deepCompact;
 const join = path.join;
 const pathExists = fs.pathExists;
@@ -22,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]
@@ -31,20 +36,31 @@ const parseJson = function (buf) {
   try {
     conf = JSON.parse(buf);
   } catch (ex) {
-    throw new Error(phrase.unableToParse(PACKAGE, ex.message), { cause: ex });
+    throw new ArcError(
+      cfgcode.PARSE_FAILED,
+      phrase.unableToParse(PACKAGE, ex.message),
+      { cause: ex },
+    );
   }
   if (!conf || typeof conf !== "object" || Array.isArray(conf)) {
-    throw new Error(phrase.unableToParse(PACKAGE, "Must be a JSON object."));
+    throw new ArcError(
+      cfgcode.PARSE_FAILED,
+      phrase.unableToParse(PACKAGE, "Must be a JSON object."),
+    );
   }
   return conf;
 };
 
 // [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/parser/given.js

@@ -0,0 +1,17 @@
+"use strict";
+
+// [import]
+
+const project = require("./project");
+
+// [function]
+
+// the project a step was given, or else the one at `root`. `arc deploy`
+// parses the project once and gives it to each step.
+const main = function ({ project: given, root }) {
+  return given ? Promise.resolve(given) : project(root);
+};
+
+// [export]
+
+module.exports = main;

package/src/parser/manifest.js

@@ -10,12 +10,15 @@ const fs = require("fs-extra");
 
 // [import]
 
+const cfgcode = require("../config/code");
 const cfgproduct = require("../config/product");
+const error = require("../util/error");
 const phrase = require("../phrase");
 const TOML = require("../util/toml");
 
 // [use]
 
+const ArcError = error.ArcError;
 const join = path.join;
 const pathExists = fs.pathExists;
 const readFile = fs.readFile;
@@ -31,7 +34,11 @@ const parseToml = function (buf) {
   try {
     return TOML.parse(buf);
   } catch (ex) {
-    throw new Error(phrase.unableToParse(MANIFEST, ex.message), { cause: ex });
+    throw new ArcError(
+      cfgcode.PARSE_FAILED,
+      phrase.unableToParse(MANIFEST, ex.message),
+      { cause: ex },
+    );
   }
 };
 

package/src/parser/media.js

@@ -80,15 +80,11 @@ const gallery = function (root) {
 // [function]
 
 const main = function (root) {
-  return new Promise((resolve, reject) => {
-    Promise.resolve({})
-      .then(art(root))
-      .then(gallery(root))
-      .then(deepCompact)
-      .then((game) => ({ game }))
-      .then(resolve)
-      .catch(reject);
-  });
+  return Promise.resolve({})
+    .then(art(root))
+    .then(gallery(root))
+    .then(deepCompact)
+    .then((game) => ({ game }));
 };
 
 // [export]

package/src/parser/project.js

@@ -6,8 +6,10 @@ const fs = require("fs-extra");
 
 // [import]
 
+const cfgcode = require("../config/code");
 const cfgworkflow = require("../config/workflow");
 const env = require("./env");
+const error = require("../util/error");
 const manifest = require("./manifest");
 const media = require("./media");
 const phrase = require("../phrase");
@@ -16,6 +18,7 @@ const readme = require("./readme");
 
 // [use]
 
+const ArcError = error.ArcError;
 const pathExists = fs.pathExists;
 
 // [function]
@@ -69,7 +72,7 @@ const main = function (root) {
   return pathExists(root)
     .then((exists) => {
       if (!exists) {
-        throw new Error(phrase.unableToFind(root));
+        throw new ArcError(cfgcode.PATH_NOT_FOUND, phrase.unableToFind(root));
       }
       return manifest(root);
     })

package/src/parser/readme-file.js

@@ -11,12 +11,15 @@ const jsdom = require("jsdom");
 
 // [import]
 
+const cfgcode = require("../config/code");
 const cfgproduct = require("../config/product");
+const error = require("../util/error");
 const MD = require("../util/md");
 const phrase = require("../phrase");
 
 // [use]
 
+const ArcError = error.ArcError;
 const join = path.join;
 const JSDOM = jsdom.JSDOM;
 const pathExists = fs.pathExists;
@@ -43,7 +46,11 @@ const render = function (buf, file) {
   try {
     return new JSDOM(MD.parse(buf)).window.document;
   } catch (ex) {
-    throw new Error(phrase.unableToParse(file, ex.message), { cause: ex });
+    throw new ArcError(
+      cfgcode.PARSE_FAILED,
+      phrase.unableToParse(file, ex.message),
+      { cause: ex },
+    );
   }
 };
 

package/src/phrase.js

@@ -149,6 +149,13 @@ const docUnsupported = function () {
 
 // [function]
 
+// the code a failure reports, above the link to its entry on the Errors page.
+const errorCode = function (code) {
+  return `Code: ${code}`;
+};
+
+// [function]
+
 const gameExists = function (idOrHandle) {
   return `Game exists: ${idOrHandle}`;
 };
@@ -164,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}`;
 };
@@ -294,6 +310,12 @@ const imageWidthMin = function (width) {
 
 // [function]
 
+const timeoutInvalid = function () {
+  return "The timeout must be a number of seconds above 0.";
+};
+
+// [function]
+
 const issuesFound = function (count) {
   return blocks(
     `${count} ${count === 1 ? "issue" : "issues"} found.`,
@@ -431,6 +453,12 @@ const releaseNotWaited = function () {
 
 // [function]
 
+const releaseNotWaitedOwner = function () {
+  return "Only the game's owner can wait for its release.";
+};
+
+// [function]
+
 // `built` when workflow.build ran first.
 const releasePublished = function (version, channel, built) {
   return `${built ? "Built and published" : "Published"} v${version} to ${channel}.`;
@@ -446,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.`,
   );
 };
 
@@ -566,12 +600,39 @@ const unableToParse = function (file, message) {
 
 // [function]
 
+const unableToReach = function () {
+  return blocks(
+    `Unable to reach ${TITLE}.`,
+    "Check your internet connection, and try again.",
+  );
+};
+
+// [function]
+
 const uploadFailed = function (status) {
   return `Upload failed with status ${status}.`;
 };
 
 // [function]
 
+const uploadRateLimited = function (version) {
+  return blocks(
+    `v${version} was uploaded in the last 5 minutes.`,
+    "Wait, then deploy again.",
+  );
+};
+
+// [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}`;
 };
@@ -688,9 +749,11 @@ module.exports = {
   docMediaType,
   docTagUnallowed,
   docUnsupported,
+  errorCode,
   gameExists,
   gameNotDeployed,
   gameNotFound,
+  gameRepoMissing,
   gameUnavailable,
   gitChangesPresent,
   gitRemoteMissing,
@@ -727,6 +790,7 @@ module.exports = {
   packageUncompressedTooLarge,
   releaseFailed,
   releaseNotWaited,
+  releaseNotWaitedOwner,
   releasePublished,
   releaseTimedOut,
   releaseWaiting,
@@ -743,10 +807,13 @@ module.exports = {
   tagPushed,
   templateUnavailable,
   timedOut,
+  timeoutInvalid,
   unableToFind,
   unableToOpen,
   unableToParse,
+  unableToReach,
   uploadFailed,
+  uploadRateLimited,
   versionPrerelease,
   versionPublished,
   versionRelease,
@@ -762,4 +829,5 @@ module.exports = {
   videoUnsupported,
   videoWidthMax,
   videoWidthMin,
+  workflowMissing,
 };

package/src/schema/check/game.js

@@ -6,19 +6,18 @@ const path = require("node:path");
 
 // [import]
 
-const fs = require("fs-extra");
-
-// [import]
-
 const docCheck = require("../../util/doc").check;
 const imageCheck = require("../../util/image").check;
 const videoCheck = require("../../util/video").check;
+const workflow = require("./workflow");
 
 // [use]
 
+const exists = workflow.exists;
 const isAbsolute = path.isAbsolute;
+const isInside = workflow.isInside;
+const isRelative = workflow.isRelative;
 const join = path.join;
-const pathExistsSync = fs.pathExistsSync; // eslint-disable-line no-sync
 const relative = path.relative;
 const resolve = path.resolve;
 
@@ -30,12 +29,6 @@ const doc = function (root, str, opts) {
 
 // [function]
 
-const exists = function (root, target) {
-  return pathExistsSync(join(root, target));
-};
-
-// [function]
-
 const image = function (root, target, opts) {
   return imageCheck(join(root, target), opts);
 };
@@ -51,20 +44,6 @@ const isIn = function (root, target, parent) {
 
 // [function]
 
-const isOut = function (root, target) {
-  const rootPath = resolve(root);
-  const targetPath = resolve(root, target);
-  return targetPath === rootPath || targetPath.startsWith(rootPath + path.sep);
-};
-
-// [function]
-
-const isRelative = function (root, target) {
-  return !isAbsolute(target);
-};
-
-// [function]
-
 const video = function (root, target, opts) {
   return videoCheck(join(root, target), opts);
 };
@@ -76,7 +55,7 @@ module.exports = {
   exists,
   image,
   isIn,
-  isOut,
+  isInside,
   isRelative,
   video,
 };