All files / kernel-test/src/vats promise-crosswise-vat.ts

0% Statements 0/28
0% Branches 0/6
0% Functions 0/7
0% Lines 0/28

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93                                                                                                                                                                                         
import { E } from '@endo/eventual-send';
import { makePromiseKit } from '@endo/promise-kit';
import { makeDefaultExo } from '@metamask/kernel-utils/exo';
 
import { unwrapTestLogger } from '../test-powers.ts';
import type { TestPowers } from '../test-powers.ts';
 
/**
 * Build function for vats that will run various tests.
 *
 * @param vatPowers - Special powers granted to this vat.
 * @param vatPowers.logger - The logger for the vat.
 * @param parameters - Initialization parameters from the vat's config object.
 * @param parameters.name - The name of the vat.
 * @param parameters.test - The test to run.
 * @param _baggage - Root of vat's persistent state (not used here).
 * @returns The root object for the new vat.
 */
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
export function buildRootObject(
  vatPowers: TestPowers,
  parameters: { name?: string; test?: string } = {},
  _baggage: unknown = null,
) {
  const name = parameters?.name ?? 'anonymous';
  const test = parameters?.test ?? 'unspecified';
  const tlog = unwrapTestLogger(vatPowers, name);
 
  /**
   * Print a message to the log.
   *
   * @param message - The message to print.
   */
  function log(message: string): void {
    // eslint-disable-next-line no-console
    console.log(`${name}: ${message}`);
  }
 
  /**
   * Test if a value is a promise.
   *
   * @param value - The value to test.
   * @returns True iff `value` is a promise.
   */
  function isPromise(value: unknown): boolean {
    return Promise.resolve(value) === value;
  }
 
  log(`buildRootObject`);
  log(`configuration parameters: ${JSON.stringify(parameters)}`);
 
  let promise: Promise<unknown>;
  let resolve: (value: unknown) => void;
 
  return makeDefaultExo('root', {
    async bootstrap(vats: { bob: unknown; carol: unknown }) {
      log(`bootstrap start`);
      tlog(`running test ${test}`);
      const promiseX = E(vats.bob).genPromise();
      const promiseY = E(vats.carol).genPromise();
      await E(vats.bob).resolve([promiseY]);
      await E(vats.carol).resolve([promiseX]);
 
      const resolutionX = (await promiseX) as unknown[];
      const resolutionY = (await promiseY) as unknown[];
      tlog(`isPromise(resolutionX[0]): ${isPromise(resolutionX[0])}`);
      tlog(`isPromise(resolutionY[0]): ${isPromise(resolutionY[0])}`);
      await E(vats.bob).loopback();
      return 'done';
    },
 
    // This is a hack that effectively does the job of stdout.flush() even
    // though we don't have access to stdout itself here. It makes sure we
    // capture all the log output prior to the return value from `bootstrap`
    // resolving.
    loopback() {
      return undefined;
    },
 
    async genPromise() {
      tlog(`genPromise`);
      const { promise: aPromise, resolve: aResolve } = makePromiseKit();
      promise = aPromise;
      resolve = aResolve;
      return promise;
    },
    resolve(resolution: unknown) {
      tlog(`resolve`);
      resolve(resolution);
    },
  });
}