@mergifyio/ci-core 0.1.1

package/dist/index.d.cts

@@ -0,0 +1,189 @@
+import { Attributes, Span, Tracer } from "@opentelemetry/api";
+import { Resource } from "@opentelemetry/resources";
+import { BasicTracerProvider, ReadableSpan, SpanExporter, SpanProcessor } from "@opentelemetry/sdk-trace-base";
+
+//#region src/flaky-detection.d.ts
+type FlakyDetectionContext = {
+  budget_ratio_for_new_tests: number;
+  budget_ratio_for_unhealthy_tests: number;
+  existing_test_names: string[];
+  existing_tests_mean_duration_ms: number;
+  unhealthy_test_names: string[];
+  max_test_execution_count: number;
+  max_test_name_length: number;
+  min_budget_duration_ms: number;
+  min_test_execution_count: number;
+};
+type FlakyDetectionMode = 'new' | 'unhealthy';
+type FlakyDetectionConfig = {
+  apiUrl: string;
+  token: string;
+  repoName: string;
+};
+declare function fetchFlakyDetectionContext(config: FlakyDetectionConfig, logger: (msg: string) => void): Promise<FlakyDetectionContext | null>;
+declare class FlakyDetector {
+  private context;
+  private mode;
+  private candidates;
+  private existingTestsInSession;
+  private budgetMs;
+  private perTestDeadlineMs;
+  private testMetrics;
+  private tooSlowTests;
+  constructor(context: FlakyDetectionContext, mode: FlakyDetectionMode, allTestNames: string[]);
+  isCandidate(testName: string): boolean;
+  /** Calculate max repeats for a candidate test. Call after first execution to use actual duration. */
+  getMaxRepeats(testName: string, initialDurationMs: number): number;
+  recordOutcome(testName: string, outcome: 'pass' | 'fail'): void;
+  isFlaky(testName: string): boolean;
+  getRerunCount(testName: string): number;
+  isTooSlow(testName: string): boolean;
+  /** Get summary data for the terminal report. */
+  getSummary(): {
+    mode: FlakyDetectionMode;
+    budgetMs: number;
+    candidateCount: number;
+    rerunTests: Array<{
+      name: string;
+      rerunCount: number;
+      flaky: boolean;
+      outcomes: string[];
+    }>;
+    tooSlowTests: string[];
+  };
+  private getOrCreateMetrics;
+}
+//#endregion
+//#region src/quarantine.d.ts
+interface QuarantineConfig {
+  apiUrl: string;
+  token: string;
+  repoName: string;
+  branch: string;
+}
+declare function fetchQuarantineList(config: QuarantineConfig, logger: (msg: string) => void): Promise<Set<string>>;
+//#endregion
+//#region src/resources/index.d.ts
+declare function detectResources(frameworkAttributes: Attributes, testRunId: string): Resource;
+//#endregion
+//#region src/tracing.d.ts
+interface TracingConfig {
+  token: string | undefined;
+  repoName: string | undefined;
+  apiUrl: string;
+  testRunId: string;
+  frameworkAttributes: Attributes;
+  tracerName: string;
+  /** Injected exporter — bypasses CI and token checks. */
+  exporter?: SpanExporter;
+}
+interface TracingContext {
+  tracer: Tracer;
+  tracerProvider: BasicTracerProvider;
+  exporter: SpanExporter;
+  resource: Resource;
+  /** Whether the provider should be shut down on test run end. */
+  ownsExporter: boolean;
+}
+declare class SynchronousBatchSpanProcessor implements SpanProcessor {
+  private exporter;
+  private queue;
+  constructor(exporter: SpanExporter);
+  onStart(): void;
+  onEnd(span: ReadableSpan): void;
+  forceFlush(): Promise<void>;
+  shutdown(): Promise<void>;
+}
+declare function createTracing(config: TracingConfig): TracingContext | null;
+//#endregion
+//#region src/types.d.ts
+interface TestCaseError {
+  type: string;
+  message: string;
+  stacktrace: string;
+}
+interface TestCaseFlakyDetection {
+  new: boolean;
+  flaky: boolean;
+  rerunCount: number;
+}
+interface TestCaseResult {
+  /** Relative file path (e.g. Vitest TestModule.relativeModuleId) */
+  filepath: string;
+  /** Absolute file path (e.g. Vitest TestModule.moduleId) */
+  absoluteFilepath: string;
+  /** Test name (e.g. Vitest TestCase.name) */
+  function: string;
+  /** Line number in the file (Vitest requires includeTaskLocation) */
+  lineno: number;
+  /** Parent suite chain (e.g. derived from Vitest fullName) */
+  namespace: string;
+  scope: 'case';
+  status: 'passed' | 'failed' | 'skipped';
+  error?: TestCaseError;
+  /** Duration in ms */
+  duration: number;
+  /** Start time in ms */
+  startTime: number;
+  /** Number of retries */
+  retryCount: number;
+  /** Whether the test passed on a retry (native framework flaky) */
+  flaky: boolean;
+  /** Framework sub-identity (Playwright project name). Optional. */
+  project?: string;
+  /** Whether the test is quarantined. Set by Vitest runner when the quarantine feature is active. */
+  quarantined?: boolean;
+  /** Flaky-detection metadata. Set by Vitest runner when flaky detection is active. */
+  flakyDetection?: TestCaseFlakyDetection;
+}
+interface TestRunSession {
+  /** 16-char hex ID (8 random bytes), matching Mergify CI Insights API format */
+  testRunId: string;
+  scope: 'session';
+  startTime: number;
+  endTime?: number;
+  status: 'passed' | 'failed' | 'interrupted';
+  testCases: TestCaseResult[];
+}
+//#endregion
+//#region src/spans.d.ts
+declare function startSessionSpan(tracing: TracingContext, name: string): Span;
+declare function endSessionSpan(tracing: TracingContext, sessionSpan: Span, reason: 'passed' | 'failed' | 'interrupted'): Promise<void>;
+declare function emitTestCaseSpan(tracer: Tracer, sessionSpan: Span, result: TestCaseResult): void;
+//#endregion
+//#region src/utils.d.ts
+type CIProvider = 'github_actions' | 'jenkins' | 'circleci' | 'buildkite';
+/**
+ * Generate a 16-character hex test run ID (8 random bytes).
+ */
+declare function generateTestRunId(): string;
+/** Convert a string to a boolean. */
+declare function strtobool(value: string): boolean;
+declare function envToBool(value: string | undefined, fallback: boolean): boolean;
+/** Check if running in a CI environment. */
+declare function isInCI(): boolean;
+/** Detect the current CI provider from environment variables. */
+declare function getCIProvider(): CIProvider | null;
+/** Execute a git command and return trimmed stdout, or null on failure. */
+declare function git(...args: string[]): string | null;
+/** Split an "owner/repo" string into parts. */
+declare function splitRepoName(fullName: string): {
+  owner: string;
+  repo: string;
+};
+/**
+ * Resolve the repository name ("owner/repo") from env vars or the git remote.
+ * Checks GITHUB_REPOSITORY, then GIT_URL, then falls back to `git config`.
+ */
+declare function getRepoName(): string | undefined;
+/** Parse a repository name from a git remote URL (SSH or HTTPS). */
+declare function getRepositoryNameFromUrl(url: string): string | null;
+/**
+ * Resolve the branch name for quarantine/flaky-detection lookups from OTel
+ * resource attributes: `vcs.ref.base.name` (PR target) preferred, then
+ * `vcs.ref.head.name` (push branch / PR head). Empty strings fall through.
+ */
+declare function resolveBranchFromAttributes(attrs: Attributes): string | undefined;
+//#endregion
+export { type CIProvider, type FlakyDetectionConfig, type FlakyDetectionContext, type FlakyDetectionMode, FlakyDetector, type QuarantineConfig, SynchronousBatchSpanProcessor, type TestCaseError, type TestCaseFlakyDetection, type TestCaseResult, type TestRunSession, type TracingConfig, type TracingContext, createTracing, detectResources, emitTestCaseSpan, endSessionSpan, envToBool, fetchFlakyDetectionContext, fetchQuarantineList, generateTestRunId, getCIProvider, getRepoName, getRepositoryNameFromUrl, git, isInCI, resolveBranchFromAttributes, splitRepoName, startSessionSpan, strtobool };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -0,0 +1,189 @@
+import { Resource } from "@opentelemetry/resources";
+import { Attributes, Span, Tracer } from "@opentelemetry/api";
+import { BasicTracerProvider, ReadableSpan, SpanExporter, SpanProcessor } from "@opentelemetry/sdk-trace-base";
+
+//#region src/flaky-detection.d.ts
+type FlakyDetectionContext = {
+  budget_ratio_for_new_tests: number;
+  budget_ratio_for_unhealthy_tests: number;
+  existing_test_names: string[];
+  existing_tests_mean_duration_ms: number;
+  unhealthy_test_names: string[];
+  max_test_execution_count: number;
+  max_test_name_length: number;
+  min_budget_duration_ms: number;
+  min_test_execution_count: number;
+};
+type FlakyDetectionMode = 'new' | 'unhealthy';
+type FlakyDetectionConfig = {
+  apiUrl: string;
+  token: string;
+  repoName: string;
+};
+declare function fetchFlakyDetectionContext(config: FlakyDetectionConfig, logger: (msg: string) => void): Promise<FlakyDetectionContext | null>;
+declare class FlakyDetector {
+  private context;
+  private mode;
+  private candidates;
+  private existingTestsInSession;
+  private budgetMs;
+  private perTestDeadlineMs;
+  private testMetrics;
+  private tooSlowTests;
+  constructor(context: FlakyDetectionContext, mode: FlakyDetectionMode, allTestNames: string[]);
+  isCandidate(testName: string): boolean;
+  /** Calculate max repeats for a candidate test. Call after first execution to use actual duration. */
+  getMaxRepeats(testName: string, initialDurationMs: number): number;
+  recordOutcome(testName: string, outcome: 'pass' | 'fail'): void;
+  isFlaky(testName: string): boolean;
+  getRerunCount(testName: string): number;
+  isTooSlow(testName: string): boolean;
+  /** Get summary data for the terminal report. */
+  getSummary(): {
+    mode: FlakyDetectionMode;
+    budgetMs: number;
+    candidateCount: number;
+    rerunTests: Array<{
+      name: string;
+      rerunCount: number;
+      flaky: boolean;
+      outcomes: string[];
+    }>;
+    tooSlowTests: string[];
+  };
+  private getOrCreateMetrics;
+}
+//#endregion
+//#region src/quarantine.d.ts
+interface QuarantineConfig {
+  apiUrl: string;
+  token: string;
+  repoName: string;
+  branch: string;
+}
+declare function fetchQuarantineList(config: QuarantineConfig, logger: (msg: string) => void): Promise<Set<string>>;
+//#endregion
+//#region src/resources/index.d.ts
+declare function detectResources(frameworkAttributes: Attributes, testRunId: string): Resource;
+//#endregion
+//#region src/tracing.d.ts
+interface TracingConfig {
+  token: string | undefined;
+  repoName: string | undefined;
+  apiUrl: string;
+  testRunId: string;
+  frameworkAttributes: Attributes;
+  tracerName: string;
+  /** Injected exporter — bypasses CI and token checks. */
+  exporter?: SpanExporter;
+}
+interface TracingContext {
+  tracer: Tracer;
+  tracerProvider: BasicTracerProvider;
+  exporter: SpanExporter;
+  resource: Resource;
+  /** Whether the provider should be shut down on test run end. */
+  ownsExporter: boolean;
+}
+declare class SynchronousBatchSpanProcessor implements SpanProcessor {
+  private exporter;
+  private queue;
+  constructor(exporter: SpanExporter);
+  onStart(): void;
+  onEnd(span: ReadableSpan): void;
+  forceFlush(): Promise<void>;
+  shutdown(): Promise<void>;
+}
+declare function createTracing(config: TracingConfig): TracingContext | null;
+//#endregion
+//#region src/types.d.ts
+interface TestCaseError {
+  type: string;
+  message: string;
+  stacktrace: string;
+}
+interface TestCaseFlakyDetection {
+  new: boolean;
+  flaky: boolean;
+  rerunCount: number;
+}
+interface TestCaseResult {
+  /** Relative file path (e.g. Vitest TestModule.relativeModuleId) */
+  filepath: string;
+  /** Absolute file path (e.g. Vitest TestModule.moduleId) */
+  absoluteFilepath: string;
+  /** Test name (e.g. Vitest TestCase.name) */
+  function: string;
+  /** Line number in the file (Vitest requires includeTaskLocation) */
+  lineno: number;
+  /** Parent suite chain (e.g. derived from Vitest fullName) */
+  namespace: string;
+  scope: 'case';
+  status: 'passed' | 'failed' | 'skipped';
+  error?: TestCaseError;
+  /** Duration in ms */
+  duration: number;
+  /** Start time in ms */
+  startTime: number;
+  /** Number of retries */
+  retryCount: number;
+  /** Whether the test passed on a retry (native framework flaky) */
+  flaky: boolean;
+  /** Framework sub-identity (Playwright project name). Optional. */
+  project?: string;
+  /** Whether the test is quarantined. Set by Vitest runner when the quarantine feature is active. */
+  quarantined?: boolean;
+  /** Flaky-detection metadata. Set by Vitest runner when flaky detection is active. */
+  flakyDetection?: TestCaseFlakyDetection;
+}
+interface TestRunSession {
+  /** 16-char hex ID (8 random bytes), matching Mergify CI Insights API format */
+  testRunId: string;
+  scope: 'session';
+  startTime: number;
+  endTime?: number;
+  status: 'passed' | 'failed' | 'interrupted';
+  testCases: TestCaseResult[];
+}
+//#endregion
+//#region src/spans.d.ts
+declare function startSessionSpan(tracing: TracingContext, name: string): Span;
+declare function endSessionSpan(tracing: TracingContext, sessionSpan: Span, reason: 'passed' | 'failed' | 'interrupted'): Promise<void>;
+declare function emitTestCaseSpan(tracer: Tracer, sessionSpan: Span, result: TestCaseResult): void;
+//#endregion
+//#region src/utils.d.ts
+type CIProvider = 'github_actions' | 'jenkins' | 'circleci' | 'buildkite';
+/**
+ * Generate a 16-character hex test run ID (8 random bytes).
+ */
+declare function generateTestRunId(): string;
+/** Convert a string to a boolean. */
+declare function strtobool(value: string): boolean;
+declare function envToBool(value: string | undefined, fallback: boolean): boolean;
+/** Check if running in a CI environment. */
+declare function isInCI(): boolean;
+/** Detect the current CI provider from environment variables. */
+declare function getCIProvider(): CIProvider | null;
+/** Execute a git command and return trimmed stdout, or null on failure. */
+declare function git(...args: string[]): string | null;
+/** Split an "owner/repo" string into parts. */
+declare function splitRepoName(fullName: string): {
+  owner: string;
+  repo: string;
+};
+/**
+ * Resolve the repository name ("owner/repo") from env vars or the git remote.
+ * Checks GITHUB_REPOSITORY, then GIT_URL, then falls back to `git config`.
+ */
+declare function getRepoName(): string | undefined;
+/** Parse a repository name from a git remote URL (SSH or HTTPS). */
+declare function getRepositoryNameFromUrl(url: string): string | null;
+/**
+ * Resolve the branch name for quarantine/flaky-detection lookups from OTel
+ * resource attributes: `vcs.ref.base.name` (PR target) preferred, then
+ * `vcs.ref.head.name` (push branch / PR head). Empty strings fall through.
+ */
+declare function resolveBranchFromAttributes(attrs: Attributes): string | undefined;
+//#endregion
+export { type CIProvider, type FlakyDetectionConfig, type FlakyDetectionContext, type FlakyDetectionMode, FlakyDetector, type QuarantineConfig, SynchronousBatchSpanProcessor, type TestCaseError, type TestCaseFlakyDetection, type TestCaseResult, type TestRunSession, type TracingConfig, type TracingContext, createTracing, detectResources, emitTestCaseSpan, endSessionSpan, envToBool, fetchFlakyDetectionContext, fetchQuarantineList, generateTestRunId, getCIProvider, getRepoName, getRepositoryNameFromUrl, git, isInCI, resolveBranchFromAttributes, splitRepoName, startSessionSpan, strtobool };
+//# sourceMappingURL=index.d.mts.map