arcadible 0.1.33 → 0.1.34

package/package.json

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

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,
 };