@agoric/telemetry 0.6.3-u19.0 → 0.6.3-u19.2

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+### [0.6.3-u19.2](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.3-u19.1...@agoric/telemetry@0.6.3-u19.2) (2025-03-13)
+
+**Note:** Version bump only for package @agoric/telemetry
+
+
+
+
+
+### [0.6.3-u19.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.3-u19.0...@agoric/telemetry@0.6.3-u19.1) (2025-03-03)
+
+
+### Bug Fixes
+
+* Properly synchronize slog sender termination ([2fc342c](https://github.com/Agoric/agoric-sdk/commit/2fc342c180e296208d077a1d4799da139d3b7848))
+
+
+
 ### [0.6.3-u19.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.2...@agoric/telemetry@0.6.3-u19.0) (2025-02-24)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/telemetry",
-  "version": "0.6.3-u19.0",
+  "version": "0.6.3-u19.2",
   "description": "Agoric's telemetry implementation",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
@@ -22,7 +22,7 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/internal": "^0.4.0-u19.0",
+    "@agoric/internal": "^0.4.0-u19.2",
     "@agoric/store": "^0.9.3-u19.0",
     "@endo/errors": "^1.2.9",
     "@endo/init": "^1.1.8",
@@ -68,5 +68,5 @@
   "typeCoverage": {
     "atLeast": 88.88
   },
-  "gitHead": "29e9704c375a06bb617027093b30d2d25faa6471"
+  "gitHead": "f0ae74b84cb6de3724bfdcd18b4bea7e8199dee1"
 }

package/src/flight-recorder.js

@@ -76,7 +76,7 @@ const initializeCircularBuffer = async (bufferFile, circularBufferSize) => {
  * @param {(outbuf: Uint8Array, readStart: number, firstReadLength: number) => void} readRecord
  * @param {(record: Uint8Array, firstWriteLength: number, circEnd: bigint) => Promise<void>} writeRecord
  */
-function finishCircularBuffer(arenaSize, header, readRecord, writeRecord) {
+function makeCircBufMethods(arenaSize, header, readRecord, writeRecord) {
   const readCircBuf = (outbuf, offset = 0) => {
     offset + outbuf.byteLength <= arenaSize ||
       Fail`Reading past end of circular buffer`;
@@ -269,14 +269,17 @@ export const makeSimpleCircularBuffer = async ({
     await file.write(headerBuffer, undefined, undefined, 0);
   };
 
-  return finishCircularBuffer(arenaSize, header, readRecord, writeRecord);
+  return {
+    fileHandle: file,
+    ...makeCircBufMethods(arenaSize, header, readRecord, writeRecord),
+  };
 };
 
 /**
  *
- * @param {Pick<EReturn<typeof makeSimpleCircularBuffer>, 'writeCircBuf'>} circBuf
+ * @param {Pick<CircularBuffer, 'fileHandle' | 'writeCircBuf'>} circBuf
  */
-export const makeSlogSenderFromBuffer = ({ writeCircBuf }) => {
+export const makeSlogSenderFromBuffer = ({ fileHandle, writeCircBuf }) => {
   /** @type {Promise<void>} */
   let toWrite = Promise.resolve();
   const writeJSON = (obj, serialized = serializeSlogObj(obj)) => {
@@ -289,6 +292,10 @@ export const makeSlogSenderFromBuffer = ({ writeCircBuf }) => {
     forceFlush: async () => {
       await toWrite;
     },
+    shutdown: async () => {
+      await toWrite;
+      await fileHandle.close();
+    },
     usesJsonObject: true,
   });
 };
@@ -299,6 +306,6 @@ export const makeSlogSenderFromBuffer = ({ writeCircBuf }) => {
  * @type {import('./index.js').MakeSlogSender}
  */
 export const makeSlogSender = async opts => {
-  const { writeCircBuf } = await makeSimpleCircularBuffer(opts);
-  return makeSlogSenderFromBuffer({ writeCircBuf });
+  const { fileHandle, writeCircBuf } = await makeSimpleCircularBuffer(opts);
+  return makeSlogSenderFromBuffer({ fileHandle, writeCircBuf });
 };

package/src/index.js

@@ -34,7 +34,10 @@ export const tryFlushSlogSender = async (
   slogSender,
   { env = {}, log } = {},
 ) => {
-  await Promise.resolve(slogSender?.forceFlush?.()).catch(err => {
+  await null;
+  try {
+    await slogSender?.forceFlush?.();
+  } catch (err) {
     log?.('Failed to flush slog sender', err);
     if (err.errors) {
       for (const error of err.errors) {
@@ -44,7 +47,7 @@ export const tryFlushSlogSender = async (
     if (env.SLOGSENDER_FAIL_ON_ERROR) {
       throw err;
     }
-  });
+  }
 };
 
 export const getResourceAttributes = ({

package/src/make-slog-sender.js

@@ -158,15 +158,15 @@ export const makeSlogSender = async (opts = {}) => {
       }
     };
     return Object.assign(slogSender, {
-      forceFlush: async () =>
-        PromiseAllOrErrors([
+      forceFlush: async () => {
+        await PromiseAllOrErrors([
           ...senders.map(sender => sender.forceFlush?.()),
           ...sendErrors.splice(0).map(err => Promise.reject(err)),
-        ]).then(() => {}),
-      shutdown: async () =>
-        PromiseAllOrErrors(senders.map(sender => sender.shutdown?.())).then(
-          () => {},
-        ),
+        ]);
+      },
+      shutdown: async () => {
+        await PromiseAllOrErrors(senders.map(sender => sender.shutdown?.()));
+      },
       usesJsonObject: hasSenderUsingJsonObj,
     });
   }

package/test/flight-recorder.test.js

@@ -1,4 +1,5 @@
 import fs from 'node:fs';
+import { promisify } from 'node:util';
 import tmp from 'tmp';
 import { test } from './prepare-test-env-ava.js';
 
@@ -17,12 +18,21 @@ const bufferTests = test.macro(
   async (t, input) => {
     const BUFFER_SIZE = 512;
 
-    const { name: tmpFile, removeCallback } = tmp.fileSync();
+    const {
+      name: tmpFile,
+      fd,
+      removeCallback,
+    } = tmp.fileSync({ detachDescriptor: true });
+    t.teardown(removeCallback);
+    const fileHandle = /** @type {import('fs/promises').FileHandle} */ ({
+      close: promisify(fs.close.bind(fs, fd)),
+    });
     const { readCircBuf, writeCircBuf } = await input.makeBuffer({
       circularBufferSize: BUFFER_SIZE,
       circularBufferFilename: tmpFile,
     });
-    const slogSender = makeSlogSenderFromBuffer({ writeCircBuf });
+    const slogSender = makeSlogSenderFromBuffer({ fileHandle, writeCircBuf });
+    t.teardown(slogSender.shutdown);
     slogSender({ type: 'start' });
     await slogSender.forceFlush();
     t.is(fs.readFileSync(tmpFile, { encoding: 'utf8' }).length, BUFFER_SIZE);
@@ -73,8 +83,6 @@ const bufferTests = test.macro(
     slogSender(null, 'PRE-SERIALIZED');
     await slogSender.forceFlush();
     t.truthy(fs.readFileSync(tmpFile).includes('PRE-SERIALIZED'));
-    // console.log({ tmpFile });
-    removeCallback();
   },
 );