@rathnasgala/cli 0.0.19 → 0.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rathnasgala/cli",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "type": "module",
   "files": [
     "src"

package/src/index.js

@@ -130,6 +130,9 @@ if (command === 'auth') {
     ask
   });
   const result = await scaffoldSite({
+    notify: (message) => process.stdout.write(`${message}\n`),
+    ask,
+    openUrl: openInBrowser,
     owner: prepared.owner,
     repository: prepared.repository,
     target: prepared.target,

package/src/publication-creation-client.js

@@ -22,7 +22,73 @@ export async function createPublication({
   githubAccessToken,
   name,
   fetchImpl = fetch,
-  authorize = exchangeGithubAuthorization
+  authorize = exchangeGithubAuthorization,
+  notify = () => {},
+  ask,
+  openUrl = () => false,
+  shareAttempts = 3,
+  selfLogin
+}) {
+  let created = false;
+  let shareUrl = 'https://github.com/settings/installations';
+  let repositoryOwner = selfLogin ?? '';
+  let repositoryName = name;
+  for (let attempt = 0; attempt < Math.max(1, shareAttempts); attempt += 1) {
+    const result = await requestPublication({
+      apiBaseUrl, galaAccessToken, githubAccessToken, name, fetchImpl, authorize
+    });
+    if (result.ready) return result.publication;
+
+    /*
+     * The repository exists with the right content; the App installation simply cannot see it,
+     * because it is scoped to selected repositories rather than all of them. Sharing it is a click,
+     * and asking again then returns READY — the server short-circuits on a repository it can
+     * already see. The browser editor recovers the same way; without this the CLI dead-ends on a
+     * state that is one click from working.
+     *
+     * After the first attempt the repository exists, so a further refusal reports UNSUPPORTED
+     * rather than NEEDS_SHARING — the same situation under a different name.
+     */
+    const shareable = result.status === 'NEEDS_SHARING' || created;
+    if (result.status === 'NEEDS_SHARING') {
+      created = true;
+      shareUrl = installationSettingsUrl(result.installationId, result.owner, selfLogin);
+      repositoryName = result.repository ?? repositoryName;
+      repositoryOwner = result.owner ?? repositoryOwner;
+    }
+    if (!shareable || typeof ask !== 'function') throw result.failure;
+
+    notify(`${repositoryOwner}/${repositoryName} was created, but the Gala GitHub App cannot reach `
+      + 'it yet — its installation covers only selected repositories, which is the right way to '
+      + 'have it. Add this one repository to the installation; nothing else needs granting.');
+    notify(`${openUrl(shareUrl) ? 'Opened' : 'Open'} ${shareUrl}`);
+    await ask('Press enter once the App can access that repository. ');
+  }
+  throw new Error(
+    `The Gala GitHub App still cannot reach ${repositoryOwner}/${repositoryName}. Add that `
+    + `repository to the installation at ${shareUrl}, then run scaffold again.`
+  );
+}
+
+/**
+ * The page that grants one repository, rather than the list of every app ever installed.
+ *
+ * GitHub keeps user and organisation installation settings on different paths, and only the caller
+ * knows which this is: the created owner differing from the token's own account means the
+ * installation lives on an organisation.
+ */
+export function installationSettingsUrl(installationId, owner, selfLogin) {
+  const generic = 'https://github.com/settings/installations';
+  if (!Number.isSafeInteger(Number(installationId)) || Number(installationId) <= 0) return generic;
+  const isOrganization = typeof owner === 'string' && typeof selfLogin === 'string'
+    && owner.toLowerCase() !== selfLogin.toLowerCase();
+  return isOrganization
+    ? `https://github.com/organizations/${encodeURIComponent(owner)}/settings/installations/${installationId}`
+    : `https://github.com/settings/installations/${installationId}`;
+}
+
+async function requestPublication({
+  apiBaseUrl, galaAccessToken, githubAccessToken, name, fetchImpl, authorize
 }) {
   const authorization = await authorize({
     apiBaseUrl, galaAccessToken, githubAccessToken, fetchImpl
@@ -44,19 +110,19 @@ export async function createPublication({
   const owner = payload?.owner;
   const repository = payload?.name;
 
-  if (status === 'NEEDS_SHARING') {
-    throw new Error(
-      `${owner}/${repository} was created from the template, but the Gala GitHub App cannot reach `
-      + 'it yet. Open https://github.com/settings/installations, give the App access to that '
-      + 'repository, then run scaffold again with --resume.'
-    );
-  }
   if (status !== 'READY') {
-    throw new Error(
-      `Gala could not create the publication repository (${payload?.outcome ?? status}). `
-      + 'Create it from https://github.com/rathnasgala/site-template yourself, then run scaffold '
-      + 'with --empty-existing-repository.'
-    );
+    return {
+      ready: false, status, owner, repository,
+      // Carried even though the repository is not in the installation yet: it is what makes the
+      // grant a deep link rather than a hunt.
+      installationId: payload?.installationId,
+      failure: new Error(
+        `Gala could not create the publication repository (${payload?.outcome ?? status}). `
+        + 'Give the Gala GitHub App access to it at https://github.com/settings/installations, or '
+        + 'create it from https://github.com/rathnasgala/site-template yourself and run scaffold '
+        + 'with --empty-existing-repository.'
+      )
+    };
   }
   if (typeof owner !== 'string' || typeof repository !== 'string') {
     throw new TypeError('Gala publication creation returned no repository identity');
@@ -66,7 +132,7 @@ export async function createPublication({
     throw new TypeError('Gala publication creation returned no installation');
   }
 
-  return Object.freeze({
+  return { ready: true, status, owner, repository, publication: Object.freeze({
     owner,
     repository,
     installationId,
@@ -74,5 +140,5 @@ export async function createPublication({
     // The server names the repository it actually made, which may differ from what was asked for.
     fullName: `${owner}/${repository}`,
     cloneUrl: `https://github.com/${owner}/${repository}.git`
-  });
+  }) };
 }

package/src/scaffold-site.js

@@ -48,6 +48,7 @@ function registrationLocation(owner, topology, canonicalBaseUrl) {
 
 export async function scaffoldSite({
   owner, repository, target, githubInstallationId, siteOptions, emptyExistingRepository = false,
+  notify = (message) => process.stdout.write(`${message}\n`), ask, openUrl,
   resumeExistingCheckout = false, topology = 'provider-default', canonicalBaseUrl, actionRef,
   buildMode = 'build-and-deploy', templateOwner = 'rathnasgala',
   templateRepository = 'site-template',
@@ -110,7 +111,8 @@ export async function scaffoldSite({
      */
     const created = await createRepository({
       apiBaseUrl: gala.apiBaseUrl, galaAccessToken: gala.accessToken,
-      githubAccessToken: github.accessToken, name: repositoryName
+      githubAccessToken: github.accessToken, name: repositoryName,
+      notify, ask, openUrl, selfLogin: requestedOwner
     });
     repositoryOwner = segment(created.owner, 'owner');
     repositoryName = segment(created.repository, 'repository');