feat(solo): run sim-chain in a separate process

Author: michaelfig

packages/cosmic-swingset/src/shutdown.js

@@ -0,0 +1,67 @@
+/* global process */
+// @ts-check
+import anylogger from 'anylogger';
+
+const console = anylogger('shutdown');
+
+export const makeFreshShutdown = () => {
+  const shutdownThunks = new Set();
+
+  let shuttingDown = false;
+  /** @type {NodeJS.SignalsListener & NodeJS.BeforeExitListener} */
+  const shutdown = code => {
+    const sig = typeof code === 'string' && code.startsWith('SIG');
+    if (sig) {
+      process.exitCode = 99;
+    }
+    if (shuttingDown) {
+      process.exit();
+    }
+    shuttingDown = true;
+    console.error('Shutting down cleanly...');
+    const shutdowners = [...shutdownThunks.keys()];
+    shutdownThunks.clear();
+    Promise.allSettled([...shutdowners].map(t => Promise.resolve().then(t)))
+      .then(statuses => {
+        for (const status of statuses) {
+          if (status.status === 'rejected') {
+            console.warn(status.reason);
+          }
+        }
+        console.log('Process terminated!');
+      })
+      .catch(error => console.warn('Error shutting down', error))
+      .finally(() => {
+        process.exit();
+      });
+  };
+
+  // gracefully shut down the thunks on process exit
+  process.on('SIGTERM', shutdown);
+  process.on('SIGINT', shutdown);
+  process.on('SIGQUIT', shutdown);
+  process.on('beforeExit', shutdown);
+  process.on('uncaughtException', e => {
+    console.error(e);
+    shutdown(-1);
+  });
+
+  return {
+    registerShutdown: thunk => {
+      shutdownThunks.add(thunk);
+      return () => {
+        shutdownThunks.delete(thunk);
+      };
+    },
+  };
+};
+
+let cachedShutdown = null;
+export const makeCachedShutdown = () => {
+  if (!cachedShutdown) {
+    cachedShutdown = makeFreshShutdown();
+  }
+  return cachedShutdown;
+};
+
+export { makeCachedShutdown as makeShutdown };

packages/solo/src/main.js

@@ -20,7 +20,6 @@ const log = anylogger('ag-solo');
 // As we add more egress types, put the default types in a comma-separated
 // string below.
 const DEFAULT_EGRESSES = 'cosmos';
-process.on('SIGINT', () => process.exit(99));
 
 const AG_SOLO_BASEDIR =
   process.env.AG_SOLO_BASEDIR && path.resolve(process.env.AG_SOLO_BASEDIR);

packages/solo/src/pipe-entrypoint.js

@@ -0,0 +1,62 @@
+/* global process */
+// @ts-check
+import '@endo/init/pre-bundle-source.js';
+import 'node-lmdb';
+import '@endo/init';
+
+import { parse, stringify } from '@endo/marshal';
+import { makePromiseKit } from '@agoric/promise-kit';
+
+import '@agoric/cosmic-swingset/src/anylogger-agoric.js';
+import { connectToFakeChain } from '@agoric/cosmic-swingset/src/sim-chain.js';
+
+// console.error('getting pipe entrypoing started');
+const [method, ...margs] = process.argv.slice(2);
+
+const { send: psend } = process;
+assert(psend);
+const send = (...args) => psend.apply(process, args);
+
+process.on('SIGINT', () => {
+  // console.log('exiting pipe child');
+  process.exit(99);
+});
+
+const main = async () => {
+  let baton = makePromiseKit();
+  let deliverator;
+  switch (method) {
+    case 'connectToFakeChain': {
+      const [basedir, GCI, delay] = margs;
+      deliverator = await connectToFakeChain(
+        basedir,
+        GCI,
+        Number(delay),
+        async (...args) => {
+          // console.log('sending', args);
+          send(stringify(harden(args)));
+          baton = makePromiseKit();
+          return baton.promise;
+        },
+      );
+      break;
+    }
+    default:
+  }
+
+  process.on('message', async msg => {
+    if (msg === 'go') {
+      baton.resolve(undefined);
+      return;
+    }
+    const as = parse(`${msg}`);
+    deliverator(...as).then(() => send('go'));
+  });
+
+  send('go');
+};
+
+main().catch(e => {
+  console.error(e);
+  process.exitCode = 1;
+});

packages/solo/src/pipe.js

@@ -0,0 +1,46 @@
+// @ts-check
+import { fork } from 'child_process';
+import path from 'path';
+
+import { makePromiseKit } from '@agoric/promise-kit';
+import { parse, stringify } from '@endo/marshal';
+
+import { makeShutdown } from '@agoric/cosmic-swingset/src/shutdown.js';
+
+const filename = new URL(import.meta.url).pathname;
+const dirname = path.dirname(filename);
+
+export const connectToPipe = async ({ method, args, deliverInboundToMbx }) => {
+  // console.log('connectToPipe', method, args);
+
+  const cp = fork(path.join(dirname, 'pipe-entrypoint.js'), [method, ...args], {
+    stdio: ['inherit', 'inherit', 'inherit', 'ipc'],
+  });
+  // console.log('connectToPipe', 'done fork');
+
+  let baton = makePromiseKit();
+  cp.on('message', msg => {
+    // console.log('connectToPipe', 'received', msg);
+    if (msg === 'go') {
+      baton.resolve(undefined);
+      return;
+    }
+    // console.log('pipe.js', msg);
+    const as = parse(`${msg}`);
+    deliverInboundToMbx(...as).then(() => cp.send('go'));
+  });
+
+  const { registerShutdown } = makeShutdown();
+  registerShutdown(() => {
+    // console.log('connectToPipe', 'shutdown');
+    cp.kill('SIGINT');
+  });
+
+  await baton.promise;
+  return async (...as) => {
+    // console.log('sending from pipe.js', as);
+    baton = makePromiseKit();
+    cp.send(stringify(harden(as)));
+    return baton.promise;
+  };
+};

packages/solo/src/start.js

@@ -28,10 +28,11 @@ import {
   buildTimer,
 } from '@agoric/swingset-vat';
 import { openSwingStore } from '@agoric/swing-store';
-import { connectToFakeChain } from '@agoric/cosmic-swingset/src/sim-chain.js';
 import { makeWithQueue } from '@agoric/vats/src/queue.js';
+import { makeShutdown } from '@agoric/cosmic-swingset/src/shutdown.js';
 
 import { deliver, addDeliveryTarget } from './outbound.js';
+import { connectToPipe } from './pipe.js';
 import { makeHTTPListener } from './web.js';
 
 import { connectToChain } from './chain-cosmos-sdk.js';
@@ -307,6 +308,7 @@ const deployWallet = async ({ agWallet, deploys, hostport }) => {
 
   // We turn off NODE_OPTIONS in case the user is debugging.
   const { NODE_OPTIONS: _ignore, ...noOptionsEnv } = process.env;
+  let unregister;
   const cp = fork(
     agoricCli,
     [
@@ -321,12 +323,11 @@ const deployWallet = async ({ agWallet, deploys, hostport }) => {
       if (err) {
         console.error(err);
       }
-      // eslint-disable-next-line no-use-before-define
-      process.off('exit', killDeployment);
+      unregister();
     },
   );
-  const killDeployment = () => cp.kill('SIGINT');
-  process.on('exit', killDeployment);
+  const { registerShutdown } = makeShutdown();
+  unregister = registerShutdown(() => cp.kill('SIGINT'));
 };
 
 const start = async (basedir, argv) => {
@@ -421,12 +422,11 @@ const start = async (basedir, argv) => {
           break;
         case 'fake-chain': {
           log(`adding follower/sender for fake chain ${c.GCI}`);
-          const deliverator = await connectToFakeChain(
-            basedir,
-            c.GCI,
-            c.fakeDelay,
+          const deliverator = await connectToPipe({
+            method: 'connectToFakeChain',
+            args: [basedir, c.GCI, c.fakeDelay],
             deliverInboundToMbx,
-          );
+          });
           addDeliveryTarget(c.GCI, deliverator);
           break;
         }