sailfork / t3code-github / apps/ server/ src/ observability/ HeapSnapshot.ts

// @effect-diagnostics nodeBuiltinImport:off - v8.writeHeapSnapshot has no Effect equivalent.
import * as NodePath from "node:path";
import * as NodeV8 from "node:v8";

import * as HostProcess from "@t3tools/shared/HostProcess";
import * as DateTime from "effect/DateTime";
import * as Effect from "effect/Effect";
import * as FileSystem from "effect/FileSystem";
import * as Layer from "effect/Layer";
import * as Schema from "effect/Schema";

import * as ServerConfig from "../config.ts";

class HeapSnapshotWriteError extends Schema.TaggedError<HeapSnapshotWriteError>()(
  "HeapSnapshotWriteError",
  { path: Schema.String, cause: Schema.Defect() },
) {
  override get message(): string {
    return `Could not write a heap snapshot to ${this.path}.`;
  }
}

const writeHeapSnapshot = Effect.fn("server.heapSnapshot", { root: true })(
  function* (logsDir: string) {
    const fs = yield* FileSystem.FileSystem;
    const timestamp = DateTime.formatIso(yield* DateTime.now).replaceAll(":", "-");
    const path = NodePath.join(logsDir, `server-${process.pid}-${timestamp}.heapsnapshot`);
    yield* Effect.annotateCurrentSpan({ path });
    yield* Effect.try({
      try: () => NodeV8.writeHeapSnapshot(path),
      catch: (cause) => new HeapSnapshotWriteError({ path, cause }),
    }).pipe(Effect.tapError(() => fs.remove(path, { force: true }).pipe(Effect.ignore)));
    yield* Effect.logInfo("Wrote heap snapshot.", { path });
  },
  Effect.catch((cause) => Effect.logWarning("Failed to write heap snapshot.", { cause })),
);

export const layer = Layer.effectDiscard(
  Effect.gen(function* () {
    if ((yield* HostProcess.Platform) === "win32") return;
    const { logsDir } = yield* ServerConfig.ServerConfig;
    const runFork = Effect.runForkWith(yield* Effect.context<FileSystem.FileSystem>());
    const onSignal = () => void runFork(writeHeapSnapshot(logsDir));
    yield* Effect.acquireRelease(
      Effect.sync(() => process.on("SIGUSR2", onSignal)),
      () => Effect.sync(() => process.off("SIGUSR2", onSignal)),
    );
  }),
);