@assuredloop/orca-bot-kit 0.37.0 → 0.38.0

package/README.md

@@ -528,7 +528,15 @@ effort and context go back to the new harness's defaults unless you give them
 too. A pause closes the tabs the way a restart does, with the
 same refusals, and one more: it also refuses a tab with only its shell in front
 whose conversation the book does not name. `obk up` leaves what is paused
-closed until `obk unpause` brings it back with its conversations. Retiring a
+closed until `obk unpause` brings it back with its conversations. The closed
+tab ended the background shells of each paused session, as a restart does. So
+the unpause tells each session it took off pause and resumed, in one typed
+line, as a restart does: its old tab is closed and its background shells
+ended, and it looks at its scheduled jobs and its mail. The report says under
+each tab whether the line went in. In the `--json` answer, `restartLine` means
+the same after an unpause as after a restart: `true` when the line went in, or
+`false` with the reason in `restartLineTrouble`, and then you tell the session
+yourself. Retiring a
 session takes it off the bot and keeps its conversations in the book under
 `retired`. Once its tab is closed, it stops what the session left running in
 its work dir: each of your processes whose working folder is there, and what

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@assuredloop/orca-bot-kit",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/cli.js

@@ -690,7 +690,7 @@ const commands = {
     const answer = { bots, bot, session, changed, created: [], completed: [], ...up };
     return {
       answer,
-      lines: tabLines(answer, `${changed ? 'Unpaused' : 'Not paused, so brought up as it is'}: ${what}. Your bots folder: ${bots}`),
+      lines: tabLines(answer, `${changed ? 'Unpaused' : 'Not paused, so brought up as it is'}: ${what}. Your bots folder: ${bots}`, 'pause'),
     };
   },
 
@@ -1918,7 +1918,7 @@ function settingsLine({ bot, session, running, settings, rules }) {
   return `${word.padEnd(9)}  ${who}  ${each.join('  ')}  rules ${rules.state}`;
 }
 
-function tabLines({ bots, created, completed, rules, skills, permissions = [], tabs, paused = [], projects = [], found = [] }, summary) {
+function tabLines({ bots, created, completed, rules, skills, permissions = [], tabs, paused = [], projects = [], found = [] }, summary, closedBy = 'restart') {
   const lines = [
     ...created.map((entry) => `created    ${entry}`),
     ...completed.map((entry) => `completed  ${entry}`),
@@ -1929,7 +1929,7 @@ function tabLines({ bots, created, completed, rules, skills, permissions = [], t
 
   for (const tab of tabs) {
     lines.push(`${tab.created ? 'opened' : 'found '}     ${tab.title}  tab ${tab.tabId}  terminal ${tab.terminal}`);
-    lines.push(...harnessLines(tab, bots));
+    lines.push(...harnessLines(tab, bots, closedBy));
     if (tab.noMailbox) {
       lines.push(`             it has no mailbox: ${noMailboxYet({ bots, bot: tab.bot, session: tab.name })}`);
     }
@@ -1962,7 +1962,7 @@ function tabLines({ bots, created, completed, rules, skills, permissions = [], t
  * The caller decides what to do next from these lines, so they say both what
  * was typed and what was seen afterwards, and never one in place of the other.
  */
-function harnessLines(tab, bots) {
+function harnessLines(tab, bots, closedBy) {
   if (!tab.created || tab.name === null) return [];
 
   // Nothing was typed into it, so there is nothing more to say about a harness
@@ -1988,7 +1988,7 @@ function harnessLines(tab, bots) {
       `             Look at it:  ${lookAt(tab.terminal)}`,
       ...ANSWER_IT,
       ...promptLines(tab),
-      ...restartLines(tab),
+      ...restartLines(tab, closedBy),
     ];
   }
 
@@ -2010,7 +2010,7 @@ function harnessLines(tab, bots) {
       ...ANSWER_IT,
     ];
 
-  lines.push(...promptLines(tab), ...listLines(tab), ...restartLines(tab));
+  lines.push(...promptLines(tab), ...listLines(tab), ...restartLines(tab, closedBy));
   if (tab.unclaimed !== undefined) lines.push(...unclaimedLines(tab, bots));
   return lines;
 }
@@ -2027,11 +2027,13 @@ function listLines(tab) {
 
 /**
  * Whether a session `obk restart` resumed was typed the line that tells it what
- * the restart ended (#726). When it was not, the caller is the one left to tell it.
+ * the restart ended (#726), or one `obk unpause` resumed, what the pause ended
+ * (#732): `closedBy` names which. When it was not, the caller is the one left
+ * to tell it.
  */
-function restartLines(tab) {
-  if (tab.restartLine === true) return ['             it was typed one line that tells it what the restart ended: its background shells, and to look at its scheduled jobs and its mail.'];
-  if (tab.restartLine === false) return [`             it was not told what the restart ended (${tab.restartLineTrouble}): tell it yourself that its background shells ended, and to look at its scheduled jobs and its mail.`];
+function restartLines(tab, closedBy) {
+  if (tab.restartLine === true) return [`             it was typed one line that tells it what the ${closedBy} ended: its background shells, and to look at its scheduled jobs and its mail.`];
+  if (tab.restartLine === false) return [`             it was not told what the ${closedBy} ended (${tab.restartLineTrouble}): tell it yourself that its background shells ended, and to look at its scheduled jobs and its mail.`];
   return [];
 }
 

package/src/pause.js

@@ -40,10 +40,14 @@ export async function pauseSessions(bots, { bot, session }) {
  */
 export async function unpauseSessions(bots, { bot, session }) {
   const home = fleetMember(bots, bot, 'unpause', session);
-  sessionsOf(readBot(home, bot), session);
+  const sessions = sessionsOf(readBot(home, bot), session);
 
   const changed = markPaused(bots, bot, session, false);
-  return { bot, session, changed, ...(await bringUp(bots, { bot, session })) };
+  // The sessions this took the pause off are told, once they are resumed, what
+  // their closed tab ended (#732). One still paused on its own is not brought
+  // up, so it is told nothing; nothing is told when nothing was paused.
+  const unpaused = changed ? new Set(sessions.map((one) => one.name)) : undefined;
+  return { bot, session, changed, ...(await bringUp(bots, { bot, session, unpaused })) };
 }
 
 /**

package/src/up.js

@@ -49,7 +49,7 @@ const SECOND_LOOK_MS = 2000;
  * one bot and `session` one of its sessions, for a caller that wants one thing
  * back rather than the fleet.
  */
-export async function bringUp(bots, { bot: onlyBot, session: onlySession, restarted } = {}) {
+export async function bringUp(bots, { bot: onlyBot, session: onlySession, restarted, unpaused } = {}) {
   const named = botsNamed(bots, onlyBot);
   if (onlySession !== undefined && onlyBot === undefined) {
     throw new Error('--session needs --bot: say which bot the session belongs to.');
@@ -72,7 +72,7 @@ export async function bringUp(bots, { bot: onlyBot, session: onlySession, restar
     for (const session of sessionsOf(bot, onlySession)) {
       if (session.paused === true) paused.push({ bot: bot.name, session: session.name });
     }
-    const up = await bringUpBot(bots, home, bot, onlySession, restarted);
+    const up = await bringUpBot(bots, home, bot, onlySession, { restarted, unpaused });
     report.push(...up.tabs);
     if (up.project !== undefined) projects.push(up.project);
   }
@@ -230,7 +230,7 @@ export function sessionsOf(bot, onlySession) {
   return named;
 }
 
-async function bringUpBot(bots, home, bot, onlySession, restarted) {
+async function bringUpBot(bots, home, bot, onlySession, { restarted, unpaused } = {}) {
   const name = bot.name;
   const title = displayName(name);
   const sessions = awake(sessionsOf(bot, onlySession));
@@ -250,7 +250,10 @@ async function bringUpBot(bots, home, bot, onlySession, restarted) {
 
   const live = new Map(tabs(home).map((tab) => [tab.tabId, tab]));
   const report = [];
-  for (const session of sessions) report.push(await bringUpSession(bots, home, live, session, bot, title, restarted?.has(session.name) === true));
+  // Which command closed the session's old tab, when one did and the session
+  // is to be told what that ended (#726, #732).
+  const endedBy = (name) => (restarted?.has(name) ? 'restart' : unpaused?.has(name) ? 'unpause' : undefined);
+  for (const session of sessions) report.push(await bringUpSession(bots, home, live, session, bot, title, endedBy(session.name)));
 
   // The ops tab, and the whole of what the kit knows about it: Bot Father's
   // project needs one tab that is not a session, for work across the fleet. Any
@@ -274,7 +277,7 @@ async function bringUpBot(bots, home, bot, onlySession, restarted) {
   return { tabs: report, project: change === undefined && windowTrouble === undefined ? undefined : project };
 }
 
-async function bringUpSession(bots, home, live, session, bot, title, restarted) {
+async function bringUpSession(bots, home, live, session, bot, title, endedBy) {
   const harness = harnessOf(session, bot.harness);
   const book = readBook(home);
   const was = book.sessions[session.name];
@@ -432,12 +435,13 @@ async function bringUpSession(bots, home, live, session, bot, title, restarted)
     : await heldInRecord(home, session.name, harness, launch.prompt, { launched, running: tui.running === true });
 
   // A session whose tab `obk restart` closed lost the background shells its
-  // harness ran there, and nothing else tells it (#726). So once it is resumed
-  // it is typed one line that says so, through the same gate, whatever its
-  // harness. For Codex that line is its first turn too, so it takes the place
-  // of the list line below.
-  const told = !restarted || launch.resume === undefined ? undefined
-    : tui.running === true ? await typeListLine(home, session.name, made.tabId, { line: restartLine(bots) })
+  // harness ran there, and nothing else tells it (#726). So does one that
+  // `obk unpause` took off pause: its old tab is closed (#732). So once it is
+  // resumed it is typed one line that says so, through the same gate, whatever
+  // its harness. For Codex that line is its first turn too, so it takes the
+  // place of the list line below.
+  const told = endedBy === undefined || launch.resume === undefined ? undefined
+    : tui.running === true ? await typeListLine(home, session.name, made.tabId, { line: (endedBy === 'unpause' ? unpauseLine : restartLine)(bots) })
     : { typed: false, why: 'its harness did not come up in the new tab' };
 
   // A Codex session resumed here is not among Orca's agents until its first
@@ -540,12 +544,29 @@ const listLine = (bots) => 'obk: this session was resumed in a new tab, and the
  */
 const restartLine = (bots) => 'obk: obk restart closed this session\'s old tab and resumed the conversation in this new one.'
   + ' Closing the old tab ended the harness there, and the background shells it ran ended with it.'
-  + ' The kit cannot tell which shells ran, or whether a scheduled job of the harness still runs.'
+  + whatToDoAfterTheClose(bots);
+
+/**
+ * What the restart line and the unpause line both say after their first two
+ * sentences: what the kit cannot tell, and what the session does about it.
+ */
+const whatToDoAfterTheClose = (bots) => ' The kit cannot tell which shells ran, or whether a scheduled job of the harness still runs.'
   + ' Look at the harness\'s scheduled jobs before you make one again, so that only one of each runs.'
   + ' Start again the shells you still need.'
   + ` Read your mail with \`${shellWord(ownCli())} message check --bots ${shellWord(bots)}\`, and do what it asks.`
   + ' That includes mail you read just before this line. If nothing needs doing, reply "ok".';
 
+/**
+ * The line a session is typed once `obk unpause` has taken it off pause and
+ * resumed it in a new tab, in the architect's ruling (#732). Its first two
+ * sentences take the place of the restart line's: the kit cannot tell whether
+ * the pause closed the old tab or it was closed before, and the words are true
+ * either way. The rest is the restart line's, word for word.
+ */
+const unpauseLine = (bots) => 'obk: obk unpause took this session off pause and resumed its conversation in this new tab.'
+  + ' Its old tab is closed, which ended the harness there, and the background shells it ran ended with it.'
+  + whatToDoAfterTheClose(bots);
+
 /**
  * How long a resumed Codex tab is given to be one the kit may type into: live,
  * Orca named the agent 7 to 11 s after the restart (#226), and the gate waits