fix: clear up and solve the races around ag-solo initialisation

michaelfig · michaelfig · commit f6482ac7f5f0 · 2020-08-04T22:35:41.000-06:00
diff --git a/packages/agoric-cli/lib/deploy.js b/packages/agoric-cli/lib/deploy.js
@@ -23,9 +23,18 @@ export default async function deployMain(progname, rawArgs, powers, opts) {
   const console = anylogger('agoric:deploy');
 
   const args = rawArgs.slice(1);
+  const deps = opts.need
+    .split(',')
+    .map(dep => dep.trim())
+    .filter(dep => dep);
 
-  if (args.length === 0) {
-    console.error('you must specify at least one deploy.js to run');
+  const init = opts.provide
+    .split(',')
+    .map(dep => dep.trim())
+    .filter(dep => dep);
+
+  if (args.length === 0 && !init.length) {
+    console.error('you must specify at least one deploy.js (or --init=XXX)');
     return 1;
   }
 
@@ -69,16 +78,34 @@ export default async function deployMain(progname, rawArgs, powers, opts) {
 
         // Wait for the chain to become ready.
         let bootP = getBootstrap();
-        const loaded = await E.G(bootP).LOADING;
-        console.debug('Chain loaded:', loaded);
+        let lastUpdateCount;
+        let stillLoading = [...deps].sort();
+        while (stillLoading.length) {
+          // Wait for the notifier to report a new state.
+          console.warn('need:', stillLoading.join(', '));
+          const update = await E(E.G(bootP).loadingNotifier).getUpdateSince(
+            lastUpdateCount,
+          );
+          lastUpdateCount = update.updateCount;
+          const nextLoading = [];
+          for (const dep of stillLoading) {
+            if (update.value.includes(dep)) {
+              // A dependency is still loading.
+              nextLoading.push(dep);
+            }
+          }
+          stillLoading = nextLoading;
+        }
+
+        console.debug(JSON.stringify(deps), 'loaded');
         // Take a new copy, since the chain objects have been added to bootstrap.
         bootP = getBootstrap();
 
         for (const arg of args) {
           const moduleFile = path.resolve(process.cwd(), arg);
           const pathResolve = (...resArgs) =>
             path.resolve(path.dirname(moduleFile), ...resArgs);
-          console.log('running', moduleFile);
+          console.warn('running', moduleFile);
 
           // use a dynamic import to load the deploy script, it is unconfined
           // eslint-disable-next-line import/no-dynamic-require,global-require
@@ -96,6 +123,11 @@ export default async function deployMain(progname, rawArgs, powers, opts) {
           }
         }
 
+        if (init.length) {
+          console.warn('provide:', init.join(', '));
+          await E(E.G(E.G(bootP).local).http).doneLoading(init);
+        }
+
         console.debug('Done!');
         ws.close();
         exit.resolve(0);
diff --git a/packages/agoric-cli/lib/main.js b/packages/agoric-cli/lib/main.js
@@ -107,13 +107,23 @@ const main = async (progname, rawArgs, powers) => {
     });
 
   program
-    .command('deploy <script...>')
+    .command('deploy [script...]')
     .description('run a deployment script against the local Agoric VM')
     .option(
       '--hostport <HOST:PORT>',
       'host and port to connect to VM',
       '127.0.0.1:8000',
     )
+    .option(
+      '--need <DEPENDENCIES>',
+      'comma-separated names of subsystems to wait for',
+      'agoric,wallet',
+    )
+    .option(
+      '--provide <DEPENDENCIES>',
+      'comma-separated names of subsystems this script initializes',
+      '',
+    )
     .action(async (scripts, cmd) => {
       const opts = { ...program.opts(), ...cmd.opts() };
       return subMain(deployMain, ['deploy', ...scripts], opts);
diff --git a/packages/cosmic-swingset/lib/ag-solo/start.js b/packages/cosmic-swingset/lib/ag-solo/start.js
@@ -305,29 +305,34 @@ export default async function start(basedir, argv) {
   swingSetRunning = true;
   deliverOutbound();
 
-  if (hostport && fs.existsSync('./wallet-deploy.js')) {
-    // Install the wallet.
-    let agoricCli;
-    try {
-      agoricCli = require.resolve('.bin/agoric');
-    } catch (e) {
-      // do nothing
-      console.log(`Cannot find agoric CLI:`, e);
-    }
-    // Launch the agoric deploy, letting it synchronize with the chain.
-    if (agoricCli) {
+  if (hostport) {
+    const agoricCli = require.resolve('.bin/agoric');
+
+    const makeHandler = (onSuccess = undefined) => (err, _stdout, stderr) => {
+      if (err) {
+        console.error(err);
+        return;
+      }
+      if (stderr) {
+        // Report the error.
+        process.stderr.write(stderr);
+      }
+      onSuccess && onSuccess();
+    };
+
+    if (fs.existsSync('./wallet-deploy.js')) {
+      // Install the wallet.
+      // Launch the agoric deploy, letting it synchronize with the chain but not wait
+      // until open for business.
       exec(
-        `${agoricCli} deploy --hostport=${hostport} ./wallet-deploy.js`,
-        (err, stdout, stderr) => {
-          if (err) {
-            console.warn(err);
-            return;
-          }
-          if (stderr) {
-            // Report the error.
-            console.error(stderr);
-          }
-        },
+        `${agoricCli} deploy --need=agoric --provide=wallet --hostport=${hostport} ./wallet-deploy.js`,
+        makeHandler(),
+      );
+    } else {
+      // No need to wait for the wallet, just open for business.
+      exec(
+        `${agoricCli} deploy --need= --provide=wallet --hostport=${hostport}`,
+        makeHandler(),
       );
     }
   }
diff --git a/packages/cosmic-swingset/lib/ag-solo/vats/bootstrap.js b/packages/cosmic-swingset/lib/ag-solo/vats/bootstrap.js
@@ -245,6 +245,9 @@ export function buildRootObject(vatPowers) {
     // This will allow dApp developers to register in their api/deploy.js
     let walletRegistered = false;
     const httpRegCallback = {
+      doneLoading(subsystems) {
+        return E(vats.http).doneLoading(subsystems);
+      },
       send(obj, connectionHandles) {
         return E(vats.http).send(obj, connectionHandles);
       },
diff --git a/packages/cosmic-swingset/lib/ag-solo/vats/vat-http.js b/packages/cosmic-swingset/lib/ag-solo/vats/vat-http.js
@@ -1,4 +1,5 @@
 /* global harden */
+import { makeNotifierKit } from '@agoric/notifier';
 import { E } from '@agoric/eventual-send';
 import { getReplHandler } from './repl';
 import { getCapTPHandler } from './captp';
@@ -7,34 +8,32 @@ import { getCapTPHandler } from './captp';
 export function buildRootObject(vatPowers) {
   const { D } = vatPowers;
   let commandDevice;
-  let provisioner;
   const channelIdToHandle = new Map();
   const channelHandleToId = new WeakMap();
-  const loaded = {};
-  loaded.p = new Promise((resolve, reject) => {
-    loaded.res = resolve;
-    loaded.rej = reject;
-  });
-  harden(loaded);
+  let LOADING = harden(['agoric', 'wallet', 'local']);
+  const {
+    notifier: loadingNotifier,
+    updater: loadingUpdater,
+  } = makeNotifierKit(LOADING);
+
   const replObjects = {
-    home: { LOADING: loaded.p }, // TODO: Remove
-    agoric: { LOADING: loaded.p },
+    home: { LOADING },
+    agoric: {},
     local: {},
   };
-  let isReady = false;
-  const readyForClient = {};
+
   let exportedToCapTP = {
-    LOADING: loaded.p,
-    READY: {
-      resolve(value) {
-        isReady = true;
-        readyForClient.res(value);
-      },
-      isReady() {
-        return isReady;
-      },
-    },
+    loadingNotifier,
   };
+  function doneLoading(subsystems) {
+    LOADING = LOADING.filter(subsys => !subsystems.includes(subsys));
+    loadingUpdater.updateState(LOADING);
+    if (LOADING.length) {
+      replObjects.home.LOADING = LOADING;
+    } else {
+      delete replObjects.home.LOADING;
+    }
+  }
 
   const send = (obj, channelHandles) => {
     // TODO: Make this sane by adding support for multicast to the commandDevice.
@@ -47,12 +46,6 @@ export function buildRootObject(vatPowers) {
     }
   };
 
-  readyForClient.p = new Promise((resolve, reject) => {
-    readyForClient.res = resolve;
-    readyForClient.rej = reject;
-  });
-  harden(readyForClient);
-
   const handler = {};
   const registeredURLHandlers = new Map();
 
@@ -68,65 +61,29 @@ export function buildRootObject(vatPowers) {
   }
 
   return harden({
-    setCommandDevice(d, ROLES) {
+    setCommandDevice(d) {
       commandDevice = d;
-      if (ROLES.client) {
-        handler.readyForClient = () => readyForClient.p;
-
-        const replHandler = getReplHandler(replObjects, send, vatPowers);
-        registerURLHandler(replHandler, '/private/repl');
-
-        // Assign the captp handler.
-        // TODO: Break this out into a separate vat.
-        const captpHandler = getCapTPHandler(
-          send,
-          // Harden only our exported objects.
-          () => harden(exportedToCapTP),
-          { E, harden, ...vatPowers },
-        );
-        registerURLHandler(captpHandler, '/private/captp');
-      }
 
-      if (ROLES.controller) {
-        handler.pleaseProvision = obj => {
-          const { nickname, pubkey } = obj;
-          // FIXME: There's a race here.  We return from the call
-          // before the outbound messages have been committed to
-          // a block.  This means the provisioning-server must
-          // retry transactions as they might have the wrong sequence
-          // number.
-          return E(provisioner).pleaseProvision(nickname, pubkey);
-        };
-        handler.pleaseProvisionMany = obj => {
-          const { applies } = obj;
-          return Promise.all(
-            applies.map(args =>
-              // Emulate allSettled.
-              E(provisioner)
-                .pleaseProvision(...args)
-                .then(
-                  value => ({ status: 'fulfilled', value }),
-                  reason => ({ status: 'rejected', reason }),
-                ),
-            ),
-          );
-        };
-      }
+      const replHandler = getReplHandler(replObjects, send, vatPowers);
+      registerURLHandler(replHandler, '/private/repl');
+
+      // Assign the captp handler.
+      // TODO: Break this out into a separate vat.
+      const captpHandler = getCapTPHandler(
+        send,
+        // Harden only our exported objects.
+        () => harden(exportedToCapTP),
+        { E, harden, ...vatPowers },
+      );
+      registerURLHandler(captpHandler, '/private/captp');
     },
 
     registerURLHandler,
     registerAPIHandler: h => registerURLHandler(h, '/api'),
     send,
-
-    setProvisioner(p) {
-      provisioner = p;
-    },
+    doneLoading,
 
     setWallet(wallet) {
-      // This must happen only after the local and agoric objects have been
-      // installed in setPresences.
-      // We're guaranteed that because the deployment script that installs
-      // the wallet only runs after the chain has provisioned us.
       exportedToCapTP = {
         ...exportedToCapTP,
         local: { ...exportedToCapTP.local, wallet },
@@ -142,23 +99,23 @@ export function buildRootObject(vatPowers) {
       handyObjects = undefined,
     ) {
       exportedToCapTP = {
+        ...exportedToCapTP,
         ...decentralObjects, // TODO: Remove; replaced by .agoric
         ...privateObjects, // TODO: Remove; replaced by .local
         ...handyObjects,
-        LOADING: loaded.p, // TODO: Remove; replaced by .agoric.LOADING
-        agoric: { ...decentralObjects, LOADING: loaded.p },
-        local: privateObjects,
+        agoric: { ...decentralObjects },
+        local: { ...privateObjects },
       };
 
       // We need to mutate the repl subobjects instead of replacing them.
       if (privateObjects) {
         Object.assign(replObjects.local, privateObjects);
+        doneLoading(['local']);
       }
 
       if (decentralObjects) {
-        loaded.res('chain bundle loaded');
         Object.assign(replObjects.agoric, decentralObjects);
-        delete replObjects.agoric.LOADING;
+        doneLoading(['agoric']);
       }
 
       // TODO: Remove; home object is deprecated.
@@ -169,7 +126,6 @@ export function buildRootObject(vatPowers) {
           privateObjects,
           handyObjects,
         );
-        delete replObjects.home.LOADING;
       }
     },
 
@@ -240,6 +196,11 @@ export function buildRootObject(vatPowers) {
         }
 
         if (dispatcher === 'onMessage') {
+          D(commandDevice).sendResponse(
+            count,
+            false,
+            harden({ type: 'doesNotUnderstand', obj }),
+          );
           throw Error(`No handler for ${url} ${type}`);
         }
         D(commandDevice).sendResponse(count, false, harden(true));
diff --git a/packages/cosmic-swingset/lib/ag-solo/web.js b/packages/cosmic-swingset/lib/ag-solo/web.js
@@ -192,7 +192,15 @@ export async function makeHTTPListener(basedir, port, host, rawInboundCommand) {
       ).finally(() => channels.delete(channelID));
     });
 
-    inboundCommand({ type: 'ws/meta' }, { ...meta, dispatcher: 'onOpen' }, id);
+    // Close and throw if the open handler gives an error.
+    inboundCommand(
+      { type: 'ws/meta' },
+      { ...meta, dispatcher: 'onOpen' },
+      id,
+    ).catch(e => {
+      log(id, 'error opening connection:', e);
+      ws.close();
+    });
 
     ws.on('message', async message => {
       let obj = {};
diff --git a/packages/cosmic-swingset/package.json b/packages/cosmic-swingset/package.json
@@ -30,6 +30,7 @@
     "@agoric/install-ses": "^0.2.0",
     "@agoric/marshal": "^0.2.3",
     "@agoric/nat": "2.0.1",
+    "@agoric/notifier": "^0.1.3",
     "@agoric/promise-kit": "^0.1.3",
     "@agoric/registrar": "^0.1.3",
     "@agoric/same-structure": "^0.0.8",
