@beignet/devtools 0.0.1

package/src/watchers.ts

@@ -0,0 +1,235 @@
+import type { DevtoolsEvent } from "./events";
+
+export const BUILT_IN_DEVTOOLS_WATCHER_NAMES = [
+  "requests",
+  "errors",
+  "useCases",
+  "eventBus",
+  "jobs",
+  "schedules",
+  "providers",
+  "db",
+  "cache",
+  "storage",
+  "mail",
+  "auth",
+  "audit",
+  "rateLimit",
+  "custom",
+] as const;
+
+export type BuiltInDevtoolsWatcherName =
+  (typeof BUILT_IN_DEVTOOLS_WATCHER_NAMES)[number];
+
+export type DevtoolsWatcherName = BuiltInDevtoolsWatcherName | (string & {});
+
+export interface DevtoolsWatcher {
+  name: DevtoolsWatcherName;
+  label: string;
+  description?: string;
+  eventTypes: readonly DevtoolsEvent["type"][];
+  enabled: boolean;
+}
+
+export type DevtoolsWatcherOptions =
+  | boolean
+  | {
+      enabled?: boolean;
+      label?: string;
+      description?: string;
+      eventTypes?: readonly DevtoolsEvent["type"][];
+    };
+
+export type DevtoolsWatchersOptions = Partial<
+  Record<BuiltInDevtoolsWatcherName, DevtoolsWatcherOptions>
+> &
+  Record<string, DevtoolsWatcherOptions | undefined>;
+
+const BUILT_IN_DEVTOOLS_WATCHERS = {
+  requests: {
+    name: "requests",
+    label: "Requests",
+    description: "HTTP request timing and contract route activity.",
+    eventTypes: ["request"],
+    enabled: true,
+  },
+  errors: {
+    name: "errors",
+    label: "Errors",
+    description: "Unhandled errors, use case failures, and devtools failures.",
+    eventTypes: ["error"],
+    enabled: true,
+  },
+  useCases: {
+    name: "useCases",
+    label: "Use cases",
+    description: "Application command and query execution.",
+    eventTypes: ["usecase"],
+    enabled: true,
+  },
+  eventBus: {
+    name: "eventBus",
+    label: "Event bus",
+    description: "Domain event publishing.",
+    eventTypes: ["eventBus"],
+    enabled: true,
+  },
+  jobs: {
+    name: "jobs",
+    label: "Jobs",
+    description: "Background job scheduling and execution.",
+    eventTypes: ["job"],
+    enabled: true,
+  },
+  schedules: {
+    name: "schedules",
+    label: "Schedules",
+    description: "Scheduled task execution.",
+    eventTypes: ["schedule"],
+    enabled: true,
+  },
+  providers: {
+    name: "providers",
+    label: "Providers",
+    description: "Provider setup, start, and stop lifecycle activity.",
+    eventTypes: ["provider"],
+    enabled: true,
+  },
+  db: {
+    name: "db",
+    label: "Database",
+    description: "Database queries and mutations from first-party providers.",
+    eventTypes: ["custom"],
+    enabled: true,
+  },
+  cache: {
+    name: "cache",
+    label: "Cache",
+    description: "Cache reads, writes, and deletes from first-party providers.",
+    eventTypes: ["custom"],
+    enabled: true,
+  },
+  storage: {
+    name: "storage",
+    label: "Storage",
+    description:
+      "Object storage reads, writes, and deletes from first-party providers.",
+    eventTypes: ["custom"],
+    enabled: true,
+  },
+  mail: {
+    name: "mail",
+    label: "Mail",
+    description: "Mail delivery attempts from first-party providers.",
+    eventTypes: ["custom"],
+    enabled: true,
+  },
+  auth: {
+    name: "auth",
+    label: "Auth",
+    description:
+      "Authentication and session activity from first-party providers.",
+    eventTypes: ["custom"],
+    enabled: true,
+  },
+  audit: {
+    name: "audit",
+    label: "Audit",
+    description: "Durable audit and activity records emitted by the app.",
+    eventTypes: ["custom"],
+    enabled: true,
+  },
+  rateLimit: {
+    name: "rateLimit",
+    label: "Rate limits",
+    description: "Rate limit checks from first-party providers.",
+    eventTypes: ["custom"],
+    enabled: true,
+  },
+  custom: {
+    name: "custom",
+    label: "Custom",
+    description: "Application and integration-specific diagnostic events.",
+    eventTypes: ["custom"],
+    enabled: true,
+  },
+} as const satisfies Record<BuiltInDevtoolsWatcherName, DevtoolsWatcher>;
+
+function normalizeWatcherOptions(
+  name: string,
+  defaultWatcher: DevtoolsWatcher | undefined,
+  options: DevtoolsWatcherOptions | undefined,
+): DevtoolsWatcher {
+  const base = defaultWatcher ?? {
+    name,
+    label: name,
+    eventTypes: [],
+    enabled: true,
+  };
+
+  if (typeof options === "boolean") {
+    return {
+      ...base,
+      enabled: options,
+    };
+  }
+
+  return {
+    ...base,
+    ...options,
+    name,
+    label: options?.label ?? base.label,
+    eventTypes: options?.eventTypes ?? base.eventTypes,
+    enabled: options?.enabled ?? base.enabled,
+  };
+}
+
+export function resolveDevtoolsWatchers(
+  options: DevtoolsWatchersOptions = {},
+): DevtoolsWatcher[] {
+  const watchers = BUILT_IN_DEVTOOLS_WATCHER_NAMES.map((name) =>
+    normalizeWatcherOptions(
+      name,
+      BUILT_IN_DEVTOOLS_WATCHERS[name],
+      options[name],
+    ),
+  );
+
+  for (const [name, option] of Object.entries(options)) {
+    if (
+      BUILT_IN_DEVTOOLS_WATCHER_NAMES.includes(
+        name as BuiltInDevtoolsWatcherName,
+      ) ||
+      option === undefined
+    ) {
+      continue;
+    }
+
+    watchers.push(normalizeWatcherOptions(name, undefined, option));
+  }
+
+  return watchers;
+}
+
+export function isDevtoolsWatcherEnabled(
+  watchers: readonly DevtoolsWatcher[],
+  name: DevtoolsWatcherName,
+): boolean {
+  return watchers.find((watcher) => watcher.name === name)?.enabled ?? true;
+}
+
+export function isDevtoolsEventEnabled(
+  watchers: readonly DevtoolsWatcher[],
+  event: DevtoolsEvent,
+): boolean {
+  if (event.watcher) {
+    return isDevtoolsWatcherEnabled(watchers, event.watcher);
+  }
+
+  if (event.type === "custom") {
+    return isDevtoolsWatcherEnabled(watchers, "custom");
+  }
+
+  const watcher = watchers.find((item) => item.eventTypes.includes(event.type));
+  return watcher?.enabled ?? true;
+}