@assuredloop/orca-bot-kit 0.9.0 → 0.11.0

package/src/up.js

@@ -8,10 +8,11 @@ import { existsSync, mkdirSync, realpathSync, writeFileSync } from 'node:fs';
 import path from 'node:path';
 import { setTimeout as pause } from 'node:timers/promises';
 
-import { forgetClaimed, forgetSession, readBook, sessionIdsIn, tabIdsIn, updateBook, withUnclaimed } from './book.js';
+import { forgetClaimed, forgetSession, MAILBOX_WAIT_MS, readBook, sessionIdsIn, tabIdsIn, takeMailboxTurn, updateBook, withUnclaimed } from './book.js';
 import { botDir, botNames, displayName, readBot } from './bot.js';
 import { conversationsIn, hasConversation, heldAsUserTurn, transcriptsIn } from './conversations.js';
 import { installHook } from './hooks.js';
+import { writePermissions } from './permissions.js';
 import { addressOf, harnessOf, isAddressOf, isShortPrompt, launchCommand, mailboxStep, reachesMail, sessionTrouble, startPrompt, workDirOf } from './launch.js';
 import { asFolderProject, coordinatorOf, findProject, harnessInTab, makeMailbox, makeProject, openTab, QUESTION_ON_SCREEN, retitleTab, tabs, TERMINAL_ENV, TIMED_OUT, tellWindow, typeIntoTab, useMailbox } from './orca.js';
 import { TAB_ENV } from './record.js';
@@ -58,7 +59,7 @@ export async function bringUp(bots, { bot: onlyBot, session: onlySession } = {})
     return false;
   });
 
-  const { running, rules, skills } = prepareBots(bots, names, onlySession);
+  const { running, rules, skills, permissions } = prepareBots(bots, names, onlySession);
 
   const report = [];
   const projects = [];
@@ -83,6 +84,7 @@ export async function bringUp(bots, { bot: onlyBot, session: onlySession } = {})
       trouble: `${entry.trouble} Its sessions were not started: a bot comes up with its rules or not at all.`,
     })),
     skills,
+    permissions,
     paused,
     projects,
   };
@@ -90,7 +92,7 @@ export async function bringUp(bots, { bot: onlyBot, session: onlySession } = {})
 
 /**
  * Everything the bots need in place before a session starts, and which of them
- * can be started at all: `{ running, rules, skills }`.
+ * can be started at all: `{ running, rules, skills, permissions }`.
  *
  * Separate from the tabs because the order matters twice over. A session reads
  * its rules, its skills and its hooks as it comes up, so all three have to be
@@ -150,7 +152,12 @@ export function prepareBots(bots, names, onlySession) {
     }
   }
 
-  return { running, rules, skills };
+  // And the permission rules the user allowed, beside the hook and for the same
+  // reason: a session that comes up before its rules are there is asked about
+  // what the user already said yes to (#344).
+  const permissions = running.flatMap(({ bot, home }) => writePermissions(bots, home, bot));
+
+  return { running, rules, skills, permissions };
 }
 
 /**
@@ -289,20 +296,31 @@ async function bringUpSession(bots, home, live, session, bot, title) {
   // does not (#272).
   const rules = rulesStamp(home);
   let held;
-  await updateBook(home, (current) => {
-    // What the harness has in this folder that nobody claims goes on the record,
-    // for a person or Bot Father to settle — added to whatever was already noted,
-    // because this run's scan cannot see what an earlier one found. The kit never
-    // settles it itself.
-    let entry = { ...current.sessions[session.name], tab: made.tabId, launched, rules };
-    if (rules === undefined) delete entry.rules;
-    held = entry.session;
-    // Before the line is typed, so the hook finds no id here and takes the one
-    // it reports for a start rather than a clear, which would tell the duty twice.
-    if (which.noConversation !== undefined && held === which.noConversation) entry = forgetSession(entry, 'no conversation');
-    current.sessions[session.name] = withUnclaimed(entry, which.unclaimed ?? []);
-    forgetClaimed(current);
-  });
+  // Not while the session's mailbox step or a check in its old tab is at work:
+  // the book moving under one leaves the mailbox bound to, or read in, a tab the
+  // book no longer names (#321). Waited for a bounded time and then written all
+  // the same, because this tab is open and its harness has to start; the step
+  // in it then waits its own turn and says what it left. Let go before the line
+  // is typed, since that step takes it.
+  const turn = takeMailboxTurn(home, session.name);
+  try {
+    await updateBook(home, (current) => {
+      // What the harness has in this folder that nobody claims goes on the record,
+      // for a person or Bot Father to settle — added to whatever was already noted,
+      // because this run's scan cannot see what an earlier one found. The kit never
+      // settles it itself.
+      let entry = { ...current.sessions[session.name], tab: made.tabId, launched, rules };
+      if (rules === undefined) delete entry.rules;
+      held = entry.session;
+      // Before the line is typed, so the hook finds no id here and takes the one
+      // it reports for a start rather than a clear, which would tell the duty twice.
+      if (which.noConversation !== undefined && held === which.noConversation) entry = forgetSession(entry, 'no conversation');
+      current.sessions[session.name] = withUnclaimed(entry, which.unclaimed ?? []);
+      forgetClaimed(current);
+    });
+  } finally {
+    turn?.release();
+  }
 
   // The old tab's hook can name another conversation while the tab is being
   // opened. A fresh start chosen before that is chosen again from the id the
@@ -517,6 +535,20 @@ export async function ownMailbox(bots, botName, sessionName) {
     throw new Error(`session mailbox binds ${who}'s mailbox to the Orca tab it runs in, and this is not one: ${TERMINAL_ENV} is not set. The kit runs it in the session's own tab when it starts the session.`);
   }
 
+  // One step, check or tab write for this session at a time, and the book read
+  // once the turn is had (#321). A step that does not get it leaves everything
+  // as it is and says so, and the launch line goes on to the harness.
+  const turn = takeMailboxTurn(home, sessionName);
+  if (turn === undefined) throw noTurn(home, who, sessionName);
+  try {
+    return await mailboxInTurn(home, botName, sessionName, who);
+  } finally {
+    turn.release();
+  }
+}
+
+/** What `ownMailbox` does once it has the session's turn. */
+async function mailboxInTurn(home, botName, sessionName, who) {
   // Only in the tab the book names for the session. Two runs of `up` at once
   // can leave a session two tabs, and the book one of them: a mailbox made or
   // bound in the other would be bound to a tab no message is meant for.
@@ -593,6 +625,15 @@ export async function ownMailbox(bots, botName, sessionName) {
  */
 const STEP_WAIT = { timeoutMs: 20_000 };
 
+/** A step that waited its turn out: nothing was made or bound, and where the mailbox was left. */
+function noTurn(home, who, sessionName) {
+  const held = readBook(home).sessions[sessionName]?.mailbox;
+  const left = typeof held === 'string'
+    ? `${who}'s mailbox ${held} is left bound to ${boundTo(held)}; an \`obk message check\` in ${who}'s own tab binds it there.`
+    : `None is written down for ${who}; it gets one the next time the kit starts it.`;
+  return new Error(`waited ${MAILBOX_WAIT_MS / 1000} seconds for ${who}'s mailbox while another obk was making, binding or reading it, and it did not finish. Nothing was made or bound in this tab. ${left}`);
+}
+
 /** Whether a session that can have a mailbox has none in its book. */
 const lacksMailbox = (home, session, harness) => reachesMail(session, harness)
   && typeof readBook(home).sessions[session.name]?.mailbox !== 'string';

package/src/orca-window.cjs

@@ -1,21 +0,0 @@
-// Run by Orca's own binary as plain Node, the way Orca's `bin/orca` runs its
-// CLI: `ELECTRON_RUN_AS_NODE=1 <Orca> orca-window.cjs <client> <projectId> <wait>`.
-//
-// It asks Orca's runtime, through Orca's own client, for `project.update` with
-// no changes on one project. That is the call that makes Orca's window read its
-// projects again, and Orca's CLI does not offer it (#224, ADR 0023). It exits 0
-// only when the runtime took the call; anything else is a non-zero exit, and
-// the kit reads every non-zero exit the same way.
-
-'use strict';
-
-const [client, projectId, wait] = process.argv.slice(2);
-
-process.exitCode = 1;
-const { RuntimeClient } = require(client);
-new RuntimeClient(undefined, Number(wait))
-  .call('project.update', { projectId, updates: {} })
-  .then((answer) => {
-    if (answer?.ok === true) process.exitCode = 0;
-  }, () => {})
-  .finally(() => process.exit());