Skip to content

feat: expose helper for writing reports to disk #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devversion merged 1 commit into from
Jan 14, 2026
Merged

feat: expose helper for writing reports to disk #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion runner/eval-cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
DEFAULT_MAX_TEST_REPAIR_ATTEMPTS,
DEFAULT_MODEL_NAME,
DEFAULT_PROMPT_TIMEOUT_RETRIES,
REPORTS_ROOT_DIR,
} from './configuration/constants.js';
import {generateCodeAndAssess} from './orchestration/generate.js';
import {logReportToConsole, writeReportToDisk} from './reporting/report-logging.js';
Expand Down Expand Up @@ -236,7 +237,7 @@ async function handler(cliArgs: Arguments<Options>): Promise<void> {
});

logReportToConsole(runInfo);
await writeReportToDisk(runInfo, runInfo.details.summary.environmentId);
await writeReportToDisk(runInfo, runInfo.details.summary.environmentId, REPORTS_ROOT_DIR);
} catch (error: unknown) {
if (error instanceof UserFacingError) {
console.error(chalk.red(error.message));
Expand Down
1 change: 1 addition & 0 deletions runner/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,4 @@ export {type ServeTestingResult} from './workers/serve-testing/worker-types.js';
export {replaceAtReferencesInPrompt} from './utils/prompt-at-references.js';
export {extractRubrics} from './utils/extract-rubrics.js';
export {combineReports} from './utils/combine-reports.mjs';
export {writeReportToDisk} from './reporting/report-logging.js';
12 changes: 8 additions & 4 deletions runner/reporting/report-logging.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {join} from 'path';
import chalk from 'chalk';
import boxen from 'boxen';
import {IndividualAssessmentState, RunInfo, ScoreBucket} from '../shared-interfaces.js';
import {DEFAULT_AUTORATER_MODEL_NAME, REPORTS_ROOT_DIR} from '../configuration/constants.js';
import {DEFAULT_AUTORATER_MODEL_NAME} from '../configuration/constants.js';
import {calculateBuildAndCheckStats} from '../ratings/stats.js';
import {safeWriteFile} from '../file-system-utils.js';
import {BuildResultStatus} from '../workers/builder/builder-types.js';
Expand All @@ -17,7 +17,6 @@ import {
} from './format.js';
import {Environment} from '../configuration/environment.js';
import {groupSimilarReports} from '../orchestration/grouping.js';
import {LocalExecutor} from '../orchestration/executors/local-executor.js';

/**
* Generates a structured report on fs, based on the assessment run information.
Expand All @@ -38,14 +37,19 @@ import {LocalExecutor} from '../orchestration/executors/local-executor.js';
*
* @param runInfo An object containing all details and results of the assessment run.
* @param id ID of the environment that was used for the eval.
* @param reportsRootDir Root directory where the reports are written to.
* @returns The original `runInfo` object, allowing for chaining.
*/
export async function writeReportToDisk(runInfo: RunInfo, id: string): Promise<void> {
export async function writeReportToDisk(
runInfo: RunInfo,
id: string,
reportsRootDir: string,
): Promise<void> {
// Sanitize report name: allow only a-z, A-Z, 0-9, and hyphens. Replace others with a hyphen.
const sanitizedReportName = runInfo.details.reportName.replace(/[^a-zA-Z0-9-]/g, '-');

const {results} = runInfo;
const reportBaseDir = join(REPORTS_ROOT_DIR, id, sanitizedReportName);
const reportBaseDir = join(reportsRootDir, id, sanitizedReportName);

// Write `summary.json` file, which contains **all** available info.
const summaryJsonPath = join(reportBaseDir, 'summary.json');
Expand Down
Loading