openclaw/src/plugins/plugin-lifecycle-trace.test.ts

import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import {
  tracePluginLifecyclePhase,
  tracePluginLifecyclePhaseAsync,
} from "./plugin-lifecycle-trace.js";

describe("plugin lifecycle trace", () => {
  const originalTraceEnv = process.env.OPENCLAW_PLUGIN_LIFECYCLE_TRACE;
  let errorSpy: ReturnType<typeof vi.spyOn>;

  beforeEach(() => {
    errorSpy = vi.spyOn(console, "error").mockImplementation(() => undefined);
  });

  afterEach(() => {
    if (originalTraceEnv === undefined) {
      delete process.env.OPENCLAW_PLUGIN_LIFECYCLE_TRACE;
    } else {
      process.env.OPENCLAW_PLUGIN_LIFECYCLE_TRACE = originalTraceEnv;
    }
    errorSpy.mockRestore();
  });

  it("does not emit when the trace env var is disabled", () => {
    delete process.env.OPENCLAW_PLUGIN_LIFECYCLE_TRACE;

    expect(tracePluginLifecyclePhase("config read", () => "done")).toBe("done");
    expect(errorSpy).not.toHaveBeenCalled();
  });

  it("emits a successful sync phase with details when enabled", () => {
    process.env.OPENCLAW_PLUGIN_LIFECYCLE_TRACE = "1";

    expect(
      tracePluginLifecyclePhase("config read", () => 42, {
        command: "inspect",
        includeDisabled: true,
        skipped: undefined,
      }),
    ).toBe(42);

    expect(errorSpy).toHaveBeenCalledTimes(1);
    expect(errorSpy.mock.calls[0]?.[0]).toMatch(
      /^\[plugins:lifecycle\] phase="config read" ms=\d+\.\d{2} status=ok command="inspect" includeDisabled=true$/,
    );
  });

  it("emits failed sync phases before rethrowing", () => {
    process.env.OPENCLAW_PLUGIN_LIFECYCLE_TRACE = "true";
    const error = new Error("boom");

    expect(() =>
      tracePluginLifecyclePhase("registry refresh", () => {
        throw error;
      }),
    ).toThrow(error);

    expect(errorSpy).toHaveBeenCalledTimes(1);
    expect(errorSpy.mock.calls[0]?.[0]).toMatch(
      /^\[plugins:lifecycle\] phase="registry refresh" ms=\d+\.\d{2} status=error$/,
    );
  });

  it("emits failed async phases before rejecting", async () => {
    process.env.OPENCLAW_PLUGIN_LIFECYCLE_TRACE = "yes";
    const error = new Error("async boom");

    await expect(
      tracePluginLifecyclePhaseAsync("manifest registry", async () => {
        throw error;
      }),
    ).rejects.toThrow(error);

    expect(errorSpy).toHaveBeenCalledTimes(1);
    expect(errorSpy.mock.calls[0]?.[0]).toMatch(
      /^\[plugins:lifecycle\] phase="manifest registry" ms=\d+\.\d{2} status=error$/,
    );
  });
});