@agoric/telemetry 0.6.3-other-dev-8f8782b.0 → 0.6.3-other-dev-fbe72e7.0.fbe72e7

package/test/flight-recorder.test.js

@@ -0,0 +1,114 @@
+import fs from 'node:fs';
+import tmp from 'tmp';
+import { test } from './prepare-test-env-ava.js';
+
+import {
+  makeSimpleCircularBuffer,
+  makeSlogSenderFromBuffer,
+} from '../src/flight-recorder.js';
+
+// Factored this way to support multiple implementations, which at one point there were
+const bufferTests = test.macro(
+  /**
+   *
+   * @param {*} t
+   * @param {{makeBuffer: typeof makeSimpleCircularBuffer}} input
+   */
+  async (t, input) => {
+    const BUFFER_SIZE = 512;
+
+    const { name: tmpFile, removeCallback } = tmp.fileSync({
+      discardDescriptor: true,
+    });
+    t.teardown(removeCallback);
+    const { fileHandle, readCircBuf, writeCircBuf } = await input.makeBuffer({
+      circularBufferSize: BUFFER_SIZE,
+      circularBufferFilename: tmpFile,
+    });
+    const realSlogSender = makeSlogSenderFromBuffer({
+      fileHandle,
+      writeCircBuf,
+    });
+    let wasShutdown = false;
+    const shutdown = () => {
+      if (wasShutdown) return;
+      wasShutdown = true;
+
+      return realSlogSender.shutdown();
+    };
+    t.teardown(shutdown);
+    // To verify lack of attempted mutation by the consumer, send only hardened
+    // entries.
+    /** @type {typeof realSlogSender} */
+    const slogSender = Object.assign(
+      (obj, serialized) => realSlogSender(harden(obj), serialized),
+      realSlogSender,
+    );
+    slogSender({ type: 'start' });
+    await slogSender.forceFlush();
+    t.is(fs.readFileSync(tmpFile, { encoding: 'utf8' }).length, BUFFER_SIZE);
+
+    const len0 = new Uint8Array(BigUint64Array.BYTES_PER_ELEMENT);
+    const { done: done0 } = await readCircBuf(len0);
+    t.false(done0, 'readCircBuf should not be done');
+    const dv0 = new DataView(len0.buffer);
+    const buf0 = new Uint8Array(Number(dv0.getBigUint64(0)));
+    const { done: done0b } = await readCircBuf(buf0, len0.byteLength);
+    t.false(done0b, 'readCircBuf should not be done');
+    const buf0Str = new TextDecoder().decode(buf0);
+    t.is(buf0Str, `\n{"type":"start"}`, `start compare failed`);
+
+    const last = 500;
+    for (let i = 0; i < last; i += 1) {
+      slogSender({ type: 'iteration', iteration: i });
+      await slogSender.forceFlush();
+      t.is(
+        fs.readFileSync(tmpFile, { encoding: 'utf8' }).length,
+        BUFFER_SIZE,
+        `iteration ${i} length mismatch`,
+      );
+    }
+
+    let offset = 0;
+    const len1 = new Uint8Array(BigUint64Array.BYTES_PER_ELEMENT);
+    for (let i = 490; i < last; i += 1) {
+      const { done: done1 } = await readCircBuf(len1, offset);
+      offset += len1.byteLength;
+      t.false(done1, `readCircBuf ${i} should not be done`);
+      const dv1 = new DataView(len1.buffer);
+      const buf1 = new Uint8Array(Number(dv1.getBigUint64(0)));
+      const { done: done1b } = await readCircBuf(buf1, offset);
+      offset += buf1.byteLength;
+      t.false(done1b, `readCircBuf ${i} should not be done`);
+      const buf1Str = new TextDecoder().decode(buf1);
+      t.is(
+        buf1Str,
+        `\n{"type":"iteration","iteration":${i}}`,
+        `iteration ${i} compare failed`,
+      );
+    }
+
+    const { done: done2 } = await readCircBuf(len1, offset);
+    t.assert(done2, `readCircBuf ${last} should be done`);
+
+    slogSender(null, 'PRE-SERIALIZED');
+    await slogSender.forceFlush();
+    t.truthy(fs.readFileSync(tmpFile).includes('PRE-SERIALIZED'));
+
+    slogSender(null, 'PRE_SHUTDOWN');
+    const shutdownP = shutdown();
+    slogSender(null, 'POST_SHUTDOWN');
+    await shutdownP;
+    slogSender(null, 'SHUTDOWN_COMPLETED');
+
+    const finalContent = fs.readFileSync(tmpFile);
+
+    t.truthy(finalContent.includes('PRE_SHUTDOWN'));
+    t.falsy(finalContent.includes('POST_SHUTDOWN'));
+    t.falsy(finalContent.includes('SHUTDOWN_COMPLETED'));
+  },
+);
+
+test('simple', bufferTests, {
+  makeBuffer: makeSimpleCircularBuffer,
+});

package/test/prepare-test-env-ava.js

@@ -1,5 +1,3 @@
-import '@endo/init';
-
 import { wrapTest } from '@endo/ses-ava';
 import rawTest from 'ava';
 

package/{jsconfig.json → tsconfig.json}

@@ -1,6 +1,7 @@
 // This file can contain .js-specific Typescript compiler config.
 {
   "extends": "../../tsconfig.json",
+  "compilerOptions": {},
   "include": [
     "*.js",
     "scripts",

package/test/test-flight-recorder.js

@@ -1,53 +0,0 @@
-import tmp from 'tmp';
-import { test } from './prepare-test-env-ava.js';
-
-import { makeMemoryMappedCircularBuffer } from '../src/flight-recorder.js';
-
-test('flight-recorder sanity', async t => {
-  const { name: tmpFile, removeCallback } = tmp.fileSync();
-  const { writeJSON: slogSender, readCircBuf } =
-    await makeMemoryMappedCircularBuffer({
-      circularBufferSize: 512,
-      circularBufferFilename: tmpFile,
-    });
-  slogSender({ type: 'start' });
-
-  const len0 = new Uint8Array(BigUint64Array.BYTES_PER_ELEMENT);
-  const { done: done0 } = readCircBuf(len0);
-  t.false(done0, 'readCircBuf should not be done');
-  const dv0 = new DataView(len0.buffer);
-  const buf0 = new Uint8Array(Number(dv0.getBigUint64(0)));
-  const { done: done0b } = readCircBuf(buf0, len0.byteLength);
-  t.false(done0b, 'readCircBuf should not be done');
-  const buf0Str = new TextDecoder().decode(buf0);
-  t.is(buf0Str, `\n{"type":"start"}`, `start compare failed`);
-
-  const last = 500;
-  for (let i = 0; i < last; i += 1) {
-    slogSender({ type: 'iteration', iteration: i });
-  }
-
-  let offset = 0;
-  const len1 = new Uint8Array(BigUint64Array.BYTES_PER_ELEMENT);
-  for (let i = 490; i < last; i += 1) {
-    const { done: done1 } = readCircBuf(len1, offset);
-    offset += len1.byteLength;
-    t.false(done1, `readCircBuf ${i} should not be done`);
-    const dv1 = new DataView(len1.buffer);
-    const buf1 = new Uint8Array(Number(dv1.getBigUint64(0)));
-    const { done: done1b } = readCircBuf(buf1, offset);
-    offset += buf1.byteLength;
-    t.false(done1b, `readCircBuf ${i} should not be done`);
-    const buf1Str = new TextDecoder().decode(buf1);
-    t.is(
-      buf1Str,
-      `\n{"type":"iteration","iteration":${i}}`,
-      `iteration ${i} compare failed`,
-    );
-  }
-
-  const { done: done2 } = readCircBuf(len1, offset);
-  t.assert(done2, `readCircBuf ${last} should be done`);
-  // console.log({ tmpFile });
-  removeCallback();
-});