Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

2.5 KB
Raw Blame
import { access, readFile } from "node:fs/promises";
import { join } from "node:path";

import { instrumentationEntries } from "@eve/catalog";

interface RegistryFile {
  path: string;
  target?: string;
}

interface RegistryItem {
  name: string;
  files?: RegistryFile[];
}

interface Registry {
  items: RegistryItem[];
}

const registrySlugsByCatalogSlug: Readonly<Record<string, string>> = {
  braintrust: "braintrust",
  "posthog-instrumentation": "posthog",
  "sentry-instrumentation": "sentry",
  "datadog-instrumentation": "datadog",
  "honeycomb-instrumentation": "honeycomb",
  arize: "arize",
  raindrop: "raindrop",
  oodle: "oodle",
  jaeger: "jaeger",
};

const docsRoot = join(import.meta.dirname, "..");
const registry = JSON.parse(await readFile(join(docsRoot, "registry.json"), "utf8")) as Registry;
const items = registry.items.filter((item) => item.name.startsWith("instrumentation/"));
const expectedSlugs = instrumentationEntries()
  .filter((entry) => entry.surfaces.registry)
  .map((entry) => registrySlugsByCatalogSlug[entry.slug]);
const actualSlugs = items.map((item) => item.name.slice("instrumentation/".length));

if (expectedSlugs.some((slug) => slug === undefined)) {
  throw new Error("Every catalog instrumentation entry needs a registry slug mapping.");
}
if (JSON.stringify(actualSlugs) !== JSON.stringify(expectedSlugs)) {
  throw new Error(
    `Instrumentation registry entries do not match the catalog.\nExpected: ${expectedSlugs.join(", ")}\nActual: ${actualSlugs.join(", ")}`,
  );
}

for (const item of items) {
  const slug = item.name.slice("instrumentation/".length);
  const expectedPath = `registry/instrumentation/${slug}.ts`;
  const expectedFiles: RegistryFile[] = [
    {
      path: expectedPath,
      target: `agent/instrumentation/${slug}.ts`,
    },
  ];
  const actualFiles = item.files?.map(({ path, target }) => ({ path, target }));
  if (JSON.stringify(actualFiles) !== JSON.stringify(expectedFiles)) {
    throw new Error(`Registry item "${item.name}" does not contain the expected files.`);
  }
  for (const file of expectedFiles) {
    await access(join(docsRoot, file.path));
  }
  if (slug !== "braintrust") {
    const source = await readFile(join(docsRoot, expectedPath), "utf8");
    if (
      !source.includes("redact: true") ||
      !source.includes("inputs: true") ||
      !source.includes("outputs: true")
    ) {
      throw new Error(
        `Registry item "${item.name}" must preserve metadata-only export with an explicit redaction policy.`,
      );
    }
  }
}