@ontrails/core 1.0.0-beta.3 → 1.0.0-beta.32

package/src/diagnostics.ts

@@ -0,0 +1,21 @@
+/**
+ * Shared diagnostic vocabulary for governance-style findings.
+ *
+ * Runtime side-channel records and field-state reports can still define their
+ * own shapes. This base exists for tools that report rule or check failures.
+ */
+
+export type DiagnosticSeverity = 'error' | 'warn';
+
+export interface DiagnosticBase<TCode extends string = string> {
+  readonly code?: TCode | undefined;
+  readonly message: string;
+  readonly severity: DiagnosticSeverity;
+}
+
+export interface RuleDiagnosticBase<
+  TCode extends string = string,
+  TRule extends string = string,
+> extends DiagnosticBase<TCode> {
+  readonly rule: TRule;
+}

package/src/draft.ts

@@ -0,0 +1,350 @@
+import type { AnyContour } from './contour.js';
+import { getContourReferences } from './contour.js';
+import { ValidationError } from './errors.js';
+import type { AnySignal } from './signal.js';
+import type { AnyResource } from './resource.js';
+import { Result } from './result.js';
+import type { Topo } from './topo.js';
+import type { AnyTrail } from './trail.js';
+
+export const DRAFT_ID_PREFIX = '_draft.';
+
+export type DraftDependencyKind =
+  | 'compose'
+  | 'contour'
+  | 'resource'
+  | 'replaced-by'
+  | 'schema-reference'
+  | 'signal-fire'
+  | 'signal-on'
+  | 'signal-from';
+
+export interface DraftDependency {
+  readonly fromId: string;
+  readonly kind: DraftDependencyKind;
+  readonly toId: string;
+}
+
+export interface DraftDiagnostic {
+  readonly id: string;
+  readonly kind: 'contour' | 'resource' | 'signal' | 'trail' | 'unknown';
+  readonly message: string;
+  readonly rule: 'draft-contamination' | 'draft-id';
+  readonly via?: DraftDependencyKind | undefined;
+  readonly dependsOn?: string | undefined;
+}
+
+/**
+ * @deprecated Use {@link DraftDiagnostic}. Kept as a source-compatible alias
+ * during the v1 vocabulary cutover.
+ */
+export interface DraftFinding extends DraftDiagnostic {
+  readonly id: DraftDiagnostic['id'];
+}
+
+export interface DraftReport {
+  readonly contaminatedIds: ReadonlySet<string>;
+  readonly declaredDraftIds: ReadonlySet<string>;
+  readonly dependencies: readonly DraftDependency[];
+  readonly findings: readonly DraftDiagnostic[];
+}
+
+interface DraftReason {
+  readonly dependsOn: string;
+  readonly via: DraftDependencyKind;
+}
+
+type TopoNode = AnyContour | AnyResource | AnySignal | AnyTrail;
+
+const replacedByTarget = (value: TopoNode): string | undefined => {
+  const raw = value as unknown as { replacedBy?: unknown };
+  return typeof raw.replacedBy === 'string' ? raw.replacedBy : undefined;
+};
+
+export const isDraftId = (id: string): boolean =>
+  id.startsWith(DRAFT_ID_PREFIX);
+
+const dependenciesFromIds = (
+  fromId: string,
+  toIds: readonly string[],
+  kind: DraftDependencyKind
+): DraftDependency[] =>
+  toIds.map((toId) => ({
+    fromId,
+    kind,
+    toId,
+  }));
+
+const dependencyFromTarget = (
+  fromId: string,
+  toId: string | undefined,
+  kind: DraftDependencyKind
+): DraftDependency[] =>
+  toId === undefined
+    ? []
+    : [
+        {
+          fromId,
+          kind,
+          toId,
+        },
+      ];
+
+const trailDependencies = (trail: AnyTrail): DraftDependency[] => [
+  ...dependenciesFromIds(
+    trail.id,
+    (trail.contours ?? []).map((contour) => contour.name),
+    'contour'
+  ),
+  ...dependenciesFromIds(trail.id, trail.composes, 'compose'),
+  ...dependenciesFromIds(
+    trail.id,
+    trail.resources.map(({ id }) => id),
+    'resource'
+  ),
+  ...dependenciesFromIds(trail.id, trail.fires ?? [], 'signal-fire'),
+  ...dependenciesFromIds(trail.id, trail.on ?? [], 'signal-on'),
+  ...dependencyFromTarget(trail.id, replacedByTarget(trail), 'replaced-by'),
+];
+
+const contourDependencies = (contour: AnyContour): DraftDependency[] =>
+  dependenciesFromIds(
+    contour.name,
+    getContourReferences(contour).map((reference) => reference.contour),
+    'schema-reference'
+  );
+
+const signalDependencies = (signal: AnySignal): DraftDependency[] => [
+  ...dependenciesFromIds(signal.id, signal.from ?? [], 'signal-from'),
+  ...dependencyFromTarget(signal.id, replacedByTarget(signal), 'replaced-by'),
+];
+
+const resourceDependencies = (resource: AnyResource): DraftDependency[] =>
+  dependencyFromTarget(resource.id, replacedByTarget(resource), 'replaced-by');
+
+const nodeKind = (
+  id: string,
+  contours: ReadonlyMap<string, AnyContour>,
+  trails: ReadonlyMap<string, AnyTrail>,
+  signals: ReadonlyMap<string, AnySignal>,
+  resources: ReadonlyMap<string, AnyResource>
+): DraftDiagnostic['kind'] => {
+  if (contours.has(id)) {
+    return 'contour';
+  }
+  if (trails.has(id)) {
+    return 'trail';
+  }
+  if (signals.has(id)) {
+    return 'signal';
+  }
+  if (resources.has(id)) {
+    return 'resource';
+  }
+  return 'unknown';
+};
+
+const displayKind = (kind: DraftDiagnostic['kind']): string =>
+  kind === 'unknown' ? 'Node' : kind[0]?.toUpperCase() + kind.slice(1);
+
+const draftIdsFromKeys = (keys: Iterable<string>): string[] =>
+  [...keys].filter(isDraftId);
+
+const collectDeclaredDraftIds = (topo: Topo): ReadonlySet<string> =>
+  new Set([
+    ...draftIdsFromKeys(topo.contours.keys()),
+    ...draftIdsFromKeys(topo.trails.keys()),
+    ...draftIdsFromKeys(topo.signals.keys()),
+    ...draftIdsFromKeys(topo.resources.keys()),
+  ]);
+
+const findingForDraftId = (
+  id: string,
+  kind: DraftDiagnostic['kind']
+): DraftDiagnostic => ({
+  id,
+  kind,
+  message: `${displayKind(id ? kind : 'unknown')} "${id}" is draft and cannot appear in the established graph.`,
+  rule: 'draft-id',
+});
+
+const findingForContamination = (
+  id: string,
+  kind: DraftDiagnostic['kind'],
+  reason: DraftReason
+): DraftDiagnostic => {
+  const dependencyLabel = isDraftId(reason.dependsOn)
+    ? `draft "${reason.dependsOn}"`
+    : `draft-contaminated "${reason.dependsOn}"`;
+
+  return {
+    dependsOn: reason.dependsOn,
+    id,
+    kind,
+    message:
+      `Established ${kind} "${id}" depends on ${dependencyLabel} ` +
+      `via ${reason.via} and cannot appear in the established graph.`,
+    rule: 'draft-contamination',
+    via: reason.via,
+  };
+};
+
+const contaminationReason = (
+  dependency: DraftDependency,
+  contaminatedIds: ReadonlySet<string>
+): DraftReason | undefined => {
+  if (contaminatedIds.has(dependency.fromId)) {
+    return undefined;
+  }
+
+  if (!isDraftId(dependency.toId) && !contaminatedIds.has(dependency.toId)) {
+    return undefined;
+  }
+
+  return {
+    dependsOn: dependency.toId,
+    via: dependency.kind,
+  };
+};
+
+const markContaminatedDependency = (
+  dependency: DraftDependency,
+  contaminatedIds: Set<string>,
+  reasons: Map<string, DraftReason>
+): boolean => {
+  const reason = contaminationReason(dependency, contaminatedIds);
+
+  if (reason === undefined) {
+    return false;
+  }
+
+  contaminatedIds.add(dependency.fromId);
+  reasons.set(dependency.fromId, reason);
+  return true;
+};
+
+const propagateContaminatedIds = (
+  declaredDraftIds: ReadonlySet<string>,
+  dependencies: readonly DraftDependency[]
+): { contaminatedIds: Set<string>; reasons: Map<string, DraftReason> } => {
+  const contaminatedIds = new Set<string>(declaredDraftIds);
+  const reasons = new Map<string, DraftReason>();
+
+  const visit = (): void => {
+    if (
+      dependencies.some((dependency) =>
+        markContaminatedDependency(dependency, contaminatedIds, reasons)
+      )
+    ) {
+      visit();
+    }
+  };
+
+  visit();
+  return { contaminatedIds, reasons };
+};
+
+const contaminationFindingForId = (
+  id: string,
+  declaredDraftIds: ReadonlySet<string>,
+  reasons: ReadonlyMap<string, DraftReason>,
+  contours: ReadonlyMap<string, AnyContour>,
+  trails: ReadonlyMap<string, AnyTrail>,
+  signals: ReadonlyMap<string, AnySignal>,
+  resources: ReadonlyMap<string, AnyResource>
+): DraftDiagnostic | undefined => {
+  if (declaredDraftIds.has(id)) {
+    return undefined;
+  }
+
+  const reason = reasons.get(id);
+  if (reason === undefined) {
+    return undefined;
+  }
+
+  return findingForContamination(
+    id,
+    nodeKind(id, contours, trails, signals, resources),
+    reason
+  );
+};
+
+const collectFindings = (
+  declaredDraftIds: ReadonlySet<string>,
+  contaminatedIds: ReadonlySet<string>,
+  reasons: ReadonlyMap<string, DraftReason>,
+  contours: ReadonlyMap<string, AnyContour>,
+  trails: ReadonlyMap<string, AnyTrail>,
+  signals: ReadonlyMap<string, AnySignal>,
+  resources: ReadonlyMap<string, AnyResource>
+): DraftDiagnostic[] => [
+  ...[...declaredDraftIds]
+    .toSorted()
+    .map((id) =>
+      findingForDraftId(id, nodeKind(id, contours, trails, signals, resources))
+    ),
+  ...[...contaminatedIds].toSorted().flatMap((id) => {
+    const finding = contaminationFindingForId(
+      id,
+      declaredDraftIds,
+      reasons,
+      contours,
+      trails,
+      signals,
+      resources
+    );
+
+    return finding === undefined ? [] : [finding];
+  }),
+];
+
+const collectDependencies = (topo: Topo): DraftDependency[] => [
+  ...[...topo.contours.values()].flatMap(contourDependencies),
+  ...[...topo.trails.values()].flatMap(trailDependencies),
+  ...[...topo.signals.values()].flatMap(signalDependencies),
+  ...[...topo.resources.values()].flatMap(resourceDependencies),
+];
+
+export const deriveDraftReport = (topo: Topo): DraftReport => {
+  const declaredDraftIds = collectDeclaredDraftIds(topo);
+  const dependencies = collectDependencies(topo);
+  const { contaminatedIds, reasons } = propagateContaminatedIds(
+    declaredDraftIds,
+    dependencies
+  );
+  const findings = collectFindings(
+    declaredDraftIds,
+    contaminatedIds,
+    reasons,
+    topo.contours,
+    topo.trails,
+    topo.signals,
+    topo.resources
+  );
+
+  return {
+    contaminatedIds,
+    declaredDraftIds,
+    dependencies,
+    findings,
+  };
+};
+
+export const validateDraftFreeTopo = (
+  topo: Topo
+): Result<void, ValidationError> => {
+  const analysis = deriveDraftReport(topo);
+
+  if (analysis.findings.length === 0) {
+    return Result.ok();
+  }
+
+  return Result.err(
+    new ValidationError(
+      `Established topo validation failed with ${analysis.findings.length} draft issue(s)`,
+      {
+        context: { issues: analysis.findings },
+      }
+    )
+  );
+};

package/src/error-projection.ts

@@ -0,0 +1,51 @@
+import type { ErrorCategory } from './errors.js';
+import { isTrailsError } from './errors.js';
+import { createRedactor } from './redaction/index.js';
+
+const errorRedactor = createRedactor();
+
+export const INTERNAL_ERROR_PUBLIC_MESSAGE = 'Internal server error';
+
+export interface ErrorDiagnosticsProjection {
+  readonly category?: ErrorCategory | undefined;
+  readonly context?: Record<string, unknown> | undefined;
+  readonly message: string;
+  readonly name: string;
+  readonly retryable?: boolean | undefined;
+  readonly stack?: string | undefined;
+}
+
+export const redactErrorString = (value: string): string =>
+  errorRedactor.redact(value);
+
+export const redactErrorContext = (
+  context: Record<string, unknown> | undefined
+): Record<string, unknown> | undefined =>
+  context === undefined ? undefined : errorRedactor.redactObject(context);
+
+export const redactErrorStack = (
+  stack: string | undefined
+): string | undefined =>
+  stack === undefined ? undefined : redactErrorString(stack);
+
+export const projectErrorDiagnostics = (
+  error: Error
+): ErrorDiagnosticsProjection => {
+  const context = isTrailsError(error)
+    ? redactErrorContext(error.context)
+    : undefined;
+  const stack = redactErrorStack(error.stack);
+
+  return {
+    ...(isTrailsError(error)
+      ? {
+          category: error.category,
+          retryable: error.retryable,
+        }
+      : {}),
+    ...(context === undefined ? {} : { context }),
+    message: redactErrorString(error.message),
+    name: error.name || error.constructor.name || 'Error',
+    ...(stack === undefined ? {} : { stack }),
+  };
+};