|
| 1 | +import { Arguments, Argv, CommandModule } from 'yargs'; |
| 2 | +import chalk from 'chalk'; |
| 3 | +import process from 'process'; |
| 4 | +import { getEnvironmentByPath } from './configuration/environment-resolution.js'; |
| 5 | +import { |
| 6 | + BUILT_IN_ENVIRONMENTS, |
| 7 | + LLM_OUTPUT_DIR, |
| 8 | +} from './configuration/constants.js'; |
| 9 | +import { UserFacingError } from './utils/errors.js'; |
| 10 | +import { existsSync, rmSync } from 'fs'; |
| 11 | +import { readFile, readdir } from 'fs/promises'; |
| 12 | +import { join } from 'path'; |
| 13 | +import { glob } from 'tinyglobby'; |
| 14 | +import { LlmResponseFile } from './shared-interfaces.js'; |
| 15 | +import { |
| 16 | + setupProjectStructure, |
| 17 | + writeResponseFiles, |
| 18 | +} from './orchestration/file-system.js'; |
| 19 | +import { serveApp } from './builder/serve-app.js'; |
| 20 | +import { ProgressLogger, ProgressType } from './progress/progress-logger.js'; |
| 21 | +import { formatTitleCard } from './reporting/format.js'; |
| 22 | + |
| 23 | +export const RunModule = { |
| 24 | + builder, |
| 25 | + handler, |
| 26 | + command: 'run', |
| 27 | + describe: 'Run an evaluated app locally', |
| 28 | +} satisfies CommandModule<{}, Options>; |
| 29 | + |
| 30 | +interface Options { |
| 31 | + environment: string; |
| 32 | + prompt: string; |
| 33 | +} |
| 34 | + |
| 35 | +function builder(argv: Argv): Argv<Options> { |
| 36 | + return argv |
| 37 | + .option('environment', { |
| 38 | + type: 'string', |
| 39 | + alias: ['env'], |
| 40 | + default: '', |
| 41 | + description: 'Path to the environment configuration file', |
| 42 | + }) |
| 43 | + .option('prompt', { |
| 44 | + type: 'string', |
| 45 | + default: '', |
| 46 | + description: 'ID of the prompt within the environment that should be run', |
| 47 | + }) |
| 48 | + .version(false) |
| 49 | + .help(); |
| 50 | +} |
| 51 | + |
| 52 | +async function handler(options: Arguments<Options>): Promise<void> { |
| 53 | + try { |
| 54 | + await runApp(options); |
| 55 | + } catch (error) { |
| 56 | + if (error instanceof UserFacingError) { |
| 57 | + console.error(chalk.red(error.message)); |
| 58 | + } else { |
| 59 | + console.error( |
| 60 | + chalk.red('An error occurred during the assessment process:') |
| 61 | + ); |
| 62 | + console.error(chalk.red(error)); |
| 63 | + } |
| 64 | + } |
| 65 | +} |
| 66 | + |
| 67 | +async function runApp(options: Options) { |
| 68 | + const { environment, rootPromptDef, files } = await resolveConfig(options); |
| 69 | + const progress = new ErrorOnlyProgressLogger(); |
| 70 | + |
| 71 | + console.log( |
| 72 | + `Setting up the "${environment.displayName}" environment with the "${rootPromptDef.name}" prompt...` |
| 73 | + ); |
| 74 | + |
| 75 | + const { directory, cleanup } = await setupProjectStructure( |
| 76 | + environment, |
| 77 | + rootPromptDef, |
| 78 | + progress |
| 79 | + ); |
| 80 | + |
| 81 | + const processExitPromise = new Promise<void>((resolve) => { |
| 82 | + const done = () => { |
| 83 | + () => { |
| 84 | + try { |
| 85 | + // Note: we don't use `cleanup` here, because the call needs to be synchronous. |
| 86 | + rmSync(directory, { recursive: true }); |
| 87 | + } catch {} |
| 88 | + resolve(); |
| 89 | + }; |
| 90 | + }; |
| 91 | + |
| 92 | + process.on('exit', done); |
| 93 | + process.on('close', done); |
| 94 | + process.on('SIGINT', done); |
| 95 | + }); |
| 96 | + |
| 97 | + try { |
| 98 | + await writeResponseFiles(directory, files, environment, rootPromptDef.name); |
| 99 | + |
| 100 | + await serveApp( |
| 101 | + environment.serveCommand, |
| 102 | + rootPromptDef.name, |
| 103 | + directory, |
| 104 | + () => {}, |
| 105 | + async (url) => { |
| 106 | + console.log(); |
| 107 | + console.log(formatTitleCard(`🎉 App is up and running at ${url}`)); |
| 108 | + await processExitPromise; |
| 109 | + } |
| 110 | + ); |
| 111 | + } finally { |
| 112 | + await cleanup(); |
| 113 | + } |
| 114 | +} |
| 115 | + |
| 116 | +async function resolveConfig(options: Options) { |
| 117 | + if (!options.environment) { |
| 118 | + throw new UserFacingError( |
| 119 | + [ |
| 120 | + '`--env` flag has not been specified. You have the following options:', |
| 121 | + ' - Pass a path to an environment config file using the `--env` flag.', |
| 122 | + ' - Pass `--env=angular-example` or `--env=solid-example` to use one of our built-in example environments.', |
| 123 | + ' - Pass `--help` to see all available options.', |
| 124 | + ].join('\n') |
| 125 | + ); |
| 126 | + } else if (!options.prompt) { |
| 127 | + throw new UserFacingError( |
| 128 | + '`--prompt` flag has not been specified. ' + |
| 129 | + 'You have to pass a prompt name through the `--prompt` flag.' |
| 130 | + ); |
| 131 | + } |
| 132 | + |
| 133 | + const environment = await getEnvironmentByPath( |
| 134 | + BUILT_IN_ENVIRONMENTS.get(options.environment) || options.environment |
| 135 | + ); |
| 136 | + const environmentDir = join(LLM_OUTPUT_DIR, environment.id); |
| 137 | + |
| 138 | + if (!existsSync(environmentDir)) { |
| 139 | + throw new UserFacingError( |
| 140 | + `Could not find any LLM output for environment "${environment.displayName}" under "${environmentDir}"` |
| 141 | + ); |
| 142 | + } |
| 143 | + |
| 144 | + const prompts = await getPossiblePrompts(environmentDir); |
| 145 | + |
| 146 | + if (!prompts.includes(options.prompt)) { |
| 147 | + throw new UserFacingError( |
| 148 | + `There is no local LLM output for environment "${options.prompt}".\n` + |
| 149 | + `The following prompts have local data:\n` + |
| 150 | + prompts.map((p) => ` - ${p}`).join('\n') |
| 151 | + ); |
| 152 | + } |
| 153 | + |
| 154 | + const rootPromptDef = environment.executablePrompts.find( |
| 155 | + (p) => p.name === options.prompt |
| 156 | + ); |
| 157 | + |
| 158 | + if (!rootPromptDef) { |
| 159 | + throw new UserFacingError( |
| 160 | + `Environment "${environment.displayName}" does not have a prompt with a name of "${options.prompt}".\n` + |
| 161 | + `The following prompts are available:\n` + |
| 162 | + environment.executablePrompts.map((p) => ` - ${p.name}`).join('\n') |
| 163 | + ); |
| 164 | + } |
| 165 | + |
| 166 | + const promptDir = join(environmentDir, options.prompt); |
| 167 | + const filePaths = await glob('**/*', { cwd: promptDir }); |
| 168 | + const files: LlmResponseFile[] = await Promise.all( |
| 169 | + filePaths.map(async (path) => { |
| 170 | + return { |
| 171 | + filePath: path, |
| 172 | + code: await readFile(join(promptDir, path), 'utf8'), |
| 173 | + }; |
| 174 | + }) |
| 175 | + ); |
| 176 | + |
| 177 | + return { environment, rootPromptDef, files }; |
| 178 | +} |
| 179 | + |
| 180 | +async function getPossiblePrompts(environmentDir: string): Promise<string[]> { |
| 181 | + const entities = await readdir(environmentDir, { withFileTypes: true }); |
| 182 | + return entities |
| 183 | + .filter((entity) => entity.isDirectory()) |
| 184 | + .map((entity) => entity.name); |
| 185 | +} |
| 186 | + |
| 187 | +class ErrorOnlyProgressLogger implements ProgressLogger { |
| 188 | + initialize(): void {} |
| 189 | + finalize(): void {} |
| 190 | + |
| 191 | + log(_: unknown, type: ProgressType, message: string, details?: string) { |
| 192 | + if (type === 'error') { |
| 193 | + console.error(chalk.red(message)); |
| 194 | + |
| 195 | + if (details) { |
| 196 | + console.error(chalk.red(message)); |
| 197 | + } |
| 198 | + } |
| 199 | + } |
| 200 | +} |
0 commit comments