@cardstack/boxel-cli 0.9.0-unstable.10 → 0.9.0-unstable.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cardstack/boxel-cli",
-  "version": "0.9.0-unstable.10",
+  "version": "0.9.0-unstable.11",
   "license": "MIT",
   "description": "CLI tools for Boxel workspace management",
   "main": "./dist/index.js",

package/src/commands/profile.ts

@@ -422,16 +422,36 @@ export async function listProfiles(
   }
 }
 
+// What adding a profile reaches beyond this module. Tests stand in for the
+// browser and for the person at the terminal through it.
+export interface AddProfileDeps {
+  browserLogin?: typeof browserLogin;
+  ensurePersonalRealm?: typeof ensurePersonalRealm;
+  prompt?: (question: string) => Promise<string>;
+  // Whether a person is at the terminal to answer questions. A coding agent or
+  // a script runs the CLI without a TTY, and a question asked there is never
+  // answered.
+  isTty?: () => boolean;
+}
+
+interface AddProfileContext {
+  browserLogin: typeof browserLogin;
+  ensurePersonalRealm: typeof ensurePersonalRealm;
+  prompt: (question: string) => Promise<string>;
+  interactive: boolean;
+}
+
 // Returns false when the user declined to replace an existing profile.
 async function confirmOverwrite(
   manager: ProfileManager,
   matrixId: string,
+  ctx: AddProfileContext,
 ): Promise<boolean> {
   if (!manager.getProfile(matrixId)) {
     return true;
   }
   console.log(`\n${FG_YELLOW}Profile ${matrixId} already exists.${RESET}`);
-  const overwrite = await prompt('Overwrite? [y/N]: ');
+  const overwrite = await ctx.prompt('Overwrite? [y/N]: ');
   if (overwrite.toLowerCase() !== 'y') {
     console.log('Cancelled.');
     return false;
@@ -439,9 +459,12 @@ async function confirmOverwrite(
   return true;
 }
 
-async function promptDisplayName(matrixId: string): Promise<string> {
+async function promptDisplayName(
+  matrixId: string,
+  ctx: AddProfileContext,
+): Promise<string> {
   const defaultDisplayName = `${getUsernameFromMatrixId(matrixId)} \u00b7 ${getDomainFromMatrixId(matrixId)}`;
-  const displayNameInput = await prompt(
+  const displayNameInput = await ctx.prompt(
     `Display name [${defaultDisplayName}]: `,
   );
   return displayNameInput || defaultDisplayName;
@@ -458,15 +481,25 @@ type AddProfileOutcome =
 // Browser sign-in. The authorization page offers both a password form and a
 // Google button, and reports back whichever account the user signed in as — so
 // unlike the terminal password path there is nothing to ask for up front.
+//
+// Without a TTY the questions that follow the sign-in are not asked: the
+// person already chose to sign in, in the browser, and a question nobody can
+// answer leaves the profile unsaved — so whoever ran the command runs it
+// again and the person is sent through the browser again. The profile is
+// saved as the defaults would have it, and a profile already stored for the
+// account is replaced, since the browser has just proven it is that account.
+// It keeps its display name. `addProfile` leaves a different active profile
+// active.
 async function addProfileViaBrowser(
   manager: ProfileManager,
   matrixUrl: string,
   hostUrl: string,
   realmServerUrl: string,
+  ctx: AddProfileContext,
 ): Promise<AddProfileOutcome> {
   let auth;
   try {
-    auth = await browserLogin({ matrixUrl, hostUrl });
+    auth = await ctx.browserLogin({ matrixUrl, hostUrl });
   } catch (err) {
     if (err instanceof SsoTimeoutError) {
       console.log(`\n${FG_YELLOW}${err.message}${RESET}`);
@@ -482,17 +515,23 @@ async function addProfileViaBrowser(
   console.log(
     `\n${FG_GREEN}✓${RESET} Signed in as ${formatProfileBadge(auth.userId)}`,
   );
-  const proceed = await prompt('Save this profile? [Y/n]: ');
-  if (proceed.toLowerCase() === 'n') {
-    console.log('Cancelled.');
-    return { status: 'cancelled' };
-  }
+  let displayName: string | undefined;
+  if (ctx.interactive) {
+    const proceed = await ctx.prompt('Save this profile? [Y/n]: ');
+    if (proceed.toLowerCase() === 'n') {
+      console.log('Cancelled.');
+      return { status: 'cancelled' };
+    }
 
-  if (!(await confirmOverwrite(manager, auth.userId))) {
-    return { status: 'cancelled' };
-  }
+    if (!(await confirmOverwrite(manager, auth.userId, ctx))) {
+      return { status: 'cancelled' };
+    }
 
-  const displayName = await promptDisplayName(auth.userId);
+    displayName = await promptDisplayName(auth.userId, ctx);
+  } else {
+    // Undefined for a new profile, which addProfileWithAuth names by default.
+    displayName = manager.getProfile(auth.userId)?.displayName;
+  }
   await manager.addProfileWithAuth(
     auth.userId,
     auth,
@@ -508,7 +547,7 @@ async function addProfileViaBrowser(
   // and a failure only warns: the profile works without it, and signing in to
   // the web app offers workspace creation.
   try {
-    const result = await ensurePersonalRealm(auth, realmServerUrl);
+    const result = await ctx.ensurePersonalRealm(auth, realmServerUrl);
     if (result.outcome === 'created') {
       console.log(
         `${FG_GREEN}✓${RESET} Created your personal workspace: ${FG_CYAN}${result.realmUrl}${RESET}`,
@@ -537,10 +576,11 @@ async function addProfileViaPassword(
   domain: string,
   matrixUrl: string,
   realmServerUrl: string,
+  ctx: AddProfileContext,
 ): Promise<AddProfileOutcome> {
   console.log(`\nEnter your Boxel username (without @ or domain)`);
   console.log(`${DIM}Example: ctse, aallen90${RESET}`);
-  const username = await prompt('Username: ');
+  const username = await ctx.prompt('Username: ');
 
   if (!username) {
     console.error(`${FG_RED}Error:${RESET} Username is required.`);
@@ -549,7 +589,7 @@ async function addProfileViaPassword(
 
   const matrixId = `@${username}:${domain}`;
 
-  if (!(await confirmOverwrite(manager, matrixId))) {
+  if (!(await confirmOverwrite(manager, matrixId, ctx))) {
     return { status: 'cancelled' };
   }
 
@@ -560,7 +600,7 @@ async function addProfileViaPassword(
     process.exit(1);
   }
 
-  const displayName = await promptDisplayName(matrixId);
+  const displayName = await promptDisplayName(matrixId, ctx);
 
   await manager.addProfile(
     matrixId,
@@ -572,11 +612,18 @@ async function addProfileViaPassword(
   return { status: 'added', matrixId };
 }
 
-async function addProfile(
+export async function addProfile(
   manager: ProfileManager,
   environment: EnvironmentDefaults,
   useBrowser = true,
+  deps: AddProfileDeps = {},
 ): Promise<void> {
+  const ctx: AddProfileContext = {
+    browserLogin: deps.browserLogin ?? browserLogin,
+    ensurePersonalRealm: deps.ensurePersonalRealm ?? ensurePersonalRealm,
+    prompt: deps.prompt ?? prompt,
+    interactive: (deps.isTty ?? (() => Boolean(process.stdin.isTTY)))(),
+  };
   console.log(`\n${BOLD}Add New Profile${RESET}\n`);
   // The environment comes from flags rather than a prompt, so name it. The
   // realm server identifies it — that's the host every later command talks to,
@@ -595,15 +642,28 @@ async function addProfile(
         environment.matrixUrl,
         environment.appUrl ?? environment.realmServerUrl,
         environment.realmServerUrl,
+        ctx,
       )
     : { status: 'usePassword' };
 
   if (outcome.status === 'usePassword') {
+    // The terminal password sign-in is a run of questions, so without a TTY
+    // it would wait on an answer that never comes.
+    if (!ctx.interactive) {
+      console.error(
+        `${FG_RED}Error:${RESET} Signing in with a password here needs a terminal. ` +
+          `Without one, pass the Matrix ID and the password in the environment: ` +
+          `BOXEL_PASSWORD=... boxel profile add -u @<username>:${environment.domain}`,
+      );
+      process.exitCode = 1;
+      return;
+    }
     outcome = await addProfileViaPassword(
       manager,
       environment.domain,
       environment.matrixUrl,
       environment.realmServerUrl,
+      ctx,
     );
   }
 
@@ -619,8 +679,16 @@ async function addProfile(
 
   if (manager.getActiveProfileId() === matrixId) {
     console.log(`${DIM}This profile is now active.${RESET}`);
+  } else if (!ctx.interactive) {
+    // The browser can sign in as an account nobody meant — a Google identity
+    // with no matching account gets a new one — and without a TTY nobody has
+    // confirmed this one. The profile that was active stays active until
+    // someone chooses this one.
+    console.log(
+      `${DIM}Use 'boxel profile switch ${matrixId}' to switch to this profile.${RESET}`,
+    );
   } else {
-    const switchNow = await prompt('Switch to this profile now? [Y/n]: ');
+    const switchNow = await ctx.prompt('Switch to this profile now? [Y/n]: ');
     if (switchNow.toLowerCase() !== 'n') {
       manager.switchProfile(matrixId);
       console.log(

package/src/index.ts

@@ -3,6 +3,8 @@ import { readFileSync } from 'fs';
 import { resolve } from 'path';
 import { buildBoxelProgram } from './build-program.ts';
 import { setQuiet } from './lib/cli-log.ts';
+import { FG_RED, RESET } from './lib/colors.ts';
+import { PromptInputClosedError } from './lib/prompt.ts';
 
 const pkg = JSON.parse(
   readFileSync(resolve(import.meta.dirname, '../package.json'), 'utf-8'),
@@ -22,4 +24,14 @@ if (process.argv.includes('--quiet')) {
   setQuiet(true);
 }
 
-buildBoxelProgram(pkg.version).parse();
+buildBoxelProgram(pkg.version)
+  .parseAsync()
+  .catch((err: unknown) => {
+    if (err instanceof PromptInputClosedError) {
+      console.error(`${FG_RED}Error:${RESET} ${err.message}`);
+      process.exitCode = 1;
+      return;
+    }
+    // Anything else is unexpected, and its stack is what explains it.
+    throw err;
+  });

package/src/lib/prompt.ts

@@ -1,22 +1,70 @@
 import * as readline from 'readline';
 import { Writable } from 'stream';
 
-export function prompt(question: string): Promise<string> {
-  const wasFlowing = process.stdin.readableFlowing;
+// A question whose input ended before it was answered. The CLI's entry point
+// prints its message without a stack, since it describes how the command was
+// run rather than a fault in it.
+export class PromptInputClosedError extends Error {
+  constructor(question: string, fromTerminal: boolean) {
+    super(
+      `No answer to "${question.trim()}".` +
+        (fromTerminal
+          ? ''
+          : ' Input ended before one was given. Run the command in a terminal, ' +
+            'or pass what it asks for as flags or environment variables.'),
+    );
+    this.name = 'PromptInputClosedError';
+  }
+}
+
+export interface PromptOptions {
+  /** @internal The streams to read from and write to; tests pass their own. */
+  input?: NodeJS.ReadableStream & {
+    readableFlowing?: boolean | null;
+    isTTY?: boolean;
+  };
+  output?: NodeJS.WritableStream;
+}
+
+export function prompt(
+  question: string,
+  options: PromptOptions = {},
+): Promise<string> {
+  const input = options.input ?? process.stdin;
+  const wasFlowing = input.readableFlowing;
   const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
+    input,
+    output: options.output ?? process.stdout,
   });
 
-  return new Promise((resolve) => {
+  return new Promise((resolve, reject) => {
+    // Input that ends before an answer arrives (stdin from /dev/null, or a pipe
+    // that runs dry) closes the interface without ever calling the question's
+    // callback. Left alone, the command's promise never settles and the process
+    // exits as if it had finished, having done nothing it was asked to.
+    let answered = false;
+    rl.once('close', () => {
+      if (!answered) {
+        reject(new PromptInputClosedError(question, Boolean(input.isTTY)));
+      }
+    });
+    // Ctrl+C stops the command, as it does at the no-echo prompt below. Without
+    // a listener here readline would close the interface instead, which reads
+    // as a question left unanswered.
+    rl.on('SIGINT', () => {
+      answered = true;
+      rl.close();
+      process.exit(130);
+    });
     rl.question(question, (answer) => {
+      answered = true;
       rl.close();
       // Creating the interface resumes stdin, and closing it doesn't undo that —
       // a resumed stdin keeps the event loop alive, so a command whose last act
       // is a prompt would sit there having already finished its work. The
       // no-echo prompt below takes the same care.
       if (!wasFlowing) {
-        process.stdin.pause();
+        input.pause();
       }
       resolve(answer.trim());
     });

package/bundled-test-harness/assets/modal-container-YpGh-tkA.js

@@ -1,40 +0,0 @@
-import "./chunk-Rp0pCe6z.js";
-import { wt as setComponentTemplate } from "./cache-DtDz7X5V-Wn8jRDfL.js";
-import { H as templateFactory, S as on } from "./index-DaCZcoCY-CgzbilMy.js";
-import "./modifier-D0EP-FQ7.js";
-import "./component-BJO47HTh.js";
-import { t as Component } from "./dist-CkA1rgqO.js";
-import "./template-factory-ds9s0u8l.js";
-import { $ as CardContainer, D as Header, _ as Modal, nt as Tooltip, pt as IconButton } from "./components-BiwudoSo.js";
-import { v as IconComponent } from "./icons-LMEaS73h.js";
-//#region app/components/modal-container.gts
-var ModalContainer = class extends Component {
-	get size() {
-		return this.args.size ?? "large";
-	}
-	get isOpen() {
-		return this.args.isOpen ?? true;
-	}
-	get closeButtonLabel() {
-		return this.args.closeButtonLabel ?? "Close";
-	}
-	static {
-		setComponentTemplate(templateFactory({
-			"id": "eR3qQR3w",
-			"block": "[[[8,[32,0],[[17,1],[24,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"]],[[\"@size\",\"@isOpen\",\"@onClose\",\"@centered\",\"@isOverlayDismissalDisabled\",\"@layer\"],[[30,0,[\"size\"]],[30,0,[\"isOpen\"]],[30,2],[30,3],[30,4],[30,5]]],[[\"default\"],[[[[1,\"\\n  \"],[8,[32,1],[[16,0,[29,[\"dialog-box\\n      \",[30,6],\"\\n      \",[52,[48,[30,9]],\"dialog-box--with-sidebar\"]]]],[24,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"]],[[\"@displayBoundaries\"],[true]],[[\"default\"],[[[[1,\"\\n\"],[41,[48,[30,9]],[[[1,\"      \"],[10,\"section\"],[14,0,\"dialog-box__sidebar-header\"],[14,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"],[12],[13],[1,\"\\n      \"],[10,\"aside\"],[14,0,\"dialog-box__sidebar\"],[14,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"],[12],[1,\"\\n        \"],[18,9,null],[1,\"\\n      \"],[13],[1,\"\\n\"]],[]],null],[1,\"    \"],[8,[32,2],[[24,0,\"dialog-box__header\"],[24,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"]],[[\"@size\",\"@title\"],[\"large\",[30,7]]],[[\"default\"],[[[[1,\"\\n\"],[41,[30,8],[[[1,\"        \"],[8,[32,3],[[24,0,\"dialog-box__close-tooltip\"],[24,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"]],[[\"@placement\",\"@disabled\"],[\"bottom\",[30,4]]],[[\"trigger\",\"content\"],[[[[1,\"\\n            \"],[8,[32,4],[[24,0,\"dialog-box__close dialog-box__close--in-tooltip\"],[24,\"aria-label\",\"close modal\"],[16,\"disabled\",[30,4]],[24,\"data-test-close-modal\",\"\"],[24,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"],[4,[32,6],[\"click\",[30,2]],null]],[[\"@icon\",\"@width\",\"@height\"],[[32,5],\"12\",\"12\"]],null],[1,\"\\n          \"]],[]],[[[1,\"\\n            \"],[10,1],[14,0,\"close-tooltip\"],[14,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"],[12],[1,\"\\n              \"],[10,1],[14,0,\"close-tooltip__label\"],[14,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"],[12],[1,[30,0,[\"closeButtonLabel\"]]],[13],[1,\"\\n              \"],[10,\"kbd\"],[14,0,\"shortcut-key\"],[14,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"],[12],[1,[30,8]],[13],[1,\"\\n            \"],[13],[1,\"\\n          \"]],[]]]]],[1,\"\\n\"]],[]],[[[1,\"        \"],[8,[32,4],[[24,0,\"dialog-box__close\"],[24,\"aria-label\",\"close modal\"],[16,\"disabled\",[30,4]],[24,\"data-test-close-modal\",\"\"],[24,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"],[4,[32,6],[\"click\",[30,2]],null]],[[\"@icon\",\"@width\",\"@height\"],[[32,5],\"12\",\"12\"]],null],[1,\"\\n\"]],[]]],[1,\"      \"],[18,10,null],[1,\"\\n    \"]],[]]]]],[1,\"\\n    \"],[10,0],[14,0,\"dialog-box__content\"],[14,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"],[12],[1,\"\\n      \"],[18,11,null],[1,\"\\n    \"],[13],[1,\"\\n\"],[41,[48,[30,12]],[[[1,\"      \"],[10,\"footer\"],[14,0,\"dialog-box__footer\"],[14,\"data-scopedcss-adeaf99312-d66846fe00\",\"\"],[12],[1,\"\\n        \"],[18,12,null],[1,\"\\n      \"],[13],[1,\"\\n\"]],[]],null],[1,\"  \"]],[]]]]],[1,\"\\n\"]],[]]]]],[1,\"\\n\"]],[\"&attrs\",\"@onClose\",\"@centered\",\"@isCloseDisabled\",\"@layer\",\"@cardContainerClass\",\"@title\",\"@closeButtonShortcut\",\"&sidebar\",\"&header\",\"&content\",\"&footer\"],[\"if\",\"has-block\",\"yield\"]]",
-			"moduleName": "/home/runner/work/boxel/boxel/packages/host/app/components/modal-container.gts",
-			"scope": () => [
-				Modal,
-				CardContainer,
-				Header,
-				Tooltip,
-				IconButton,
-				IconComponent,
-				on
-			],
-			"isStrictMode": true
-		}), this);
-	}
-};
-//#endregion
-export { ModalContainer as t };