Skip to content

armgit / orca

Public Imported from GitHub
0

Orca is the place for working with a fleet of agents (e.g. Grok Bot, Claude Code). Run any coding agent with your own subscription. Available on desktop, mobile and remote runtime.

11.7 KB
Raw Blame
// Pre-handoff gate: runs the checks a change's paths need, in parallel, printing failures in full.
import { execFileSync, spawnSync } from 'node:child_process'
import { existsSync, readdirSync } from 'node:fs'
import { availableParallelism } from 'node:os'
import path from 'node:path'
import process from 'node:process'
import { pathToFileURL } from 'node:url'
import {
  collectChangedFiles,
  computePassHash,
  readPassHash,
  writePassHash
} from './check-changed-pass-cache.mjs'
import { planChangedChecks } from './check-changed-selection.mjs'
import { resolveOxcCliInvocation } from './oxc-cli-invocation.mjs'
import { resolvePnpmCliInvocation } from './pnpm-cli-invocation.mjs'

const OUTPUT_TAIL_LINES = 200
const HEARTBEAT_MS = 60_000
const DEFAULT_STEP_TIMEOUT_MINUTES = 30
// Windows caps a command line near 32K characters; past this, lint the whole tree instead.
const MAX_PATH_ARGUMENT_CHARS = 24_000
const LINTABLE = /\.[cm]?[jt]sx?$/
const ANTI_SLOP_ROOTS = ['src/', 'config/', 'tests/', 'mobile/']

function parseArgs(argv) {
  const options = {
    force: false,
    base: null,
    maxWorkers: null,
    stepTimeoutMs: DEFAULT_STEP_TIMEOUT_MINUTES * 60_000
  }
  for (const argument of argv) {
    if (argument === '--') {
      continue
    } else if (argument === '--force') {
      options.force = true
    } else if (argument.startsWith('--base=')) {
      options.base = argument.slice('--base='.length)
    } else if (/^--max-?workers=\d+$/i.test(argument)) {
      options.maxWorkers = argument.split('=')[1]
    } else if (/^--timeout=\d+$/.test(argument)) {
      options.stepTimeoutMs = Number(argument.split('=')[1]) * 60_000
    } else {
      throw new Error(
        `Unknown option ${argument}. Use --force, --base=<ref>, --maxWorkers=<n>, --timeout=<minutes>.`
      )
    }
  }
  return options
}

function git(root, args) {
  return execFileSync('git', args, { cwd: root, encoding: 'utf8' }).trim()
}

function resolveMergeBase(root, requested) {
  for (const candidate of [requested, process.env.ORCA_CODE_QUALITY_BASE, 'origin/main', 'main']) {
    if (!candidate) {
      continue
    }
    const verified = spawnSync(
      'git',
      ['rev-parse', '--verify', '--quiet', `${candidate}^{commit}`],
      {
        cwd: root,
        stdio: 'ignore'
      }
    )
    if (verified.status === 0) {
      return { ref: candidate, mergeBase: git(root, ['merge-base', candidate, 'HEAD']) }
    }
  }
  throw new Error('No base: fetch origin/main or pass --base=<ref>.')
}

function seconds(startedAt) {
  return `${((performance.now() - startedAt) / 1000).toFixed(1)}s`
}

function tail(text) {
  const lines = text.trimEnd().split(/\r?\n/)
  if (lines.length <= OUTPUT_TAIL_LINES) {
    return lines.join('\n')
  }
  return [
    `… ${lines.length - OUTPUT_TAIL_LINES} earlier lines omitted`,
    ...lines.slice(-OUTPUT_TAIL_LINES)
  ].join('\n')
}

function fitsCommandLine(files) {
  return files.reduce((total, file) => total + file.length + 1, 0) <= MAX_PATH_ARGUMENT_CHARS
}

// Why before importing @orca/process-host: its dist is what this builds, and a cache hit skips both.
function buildWorkspacePackages(root, env) {
  const pnpm = resolvePnpmCliInvocation()
  const result = spawnSync(pnpm.command, [...pnpm.prefixArgs, 'run', 'build:packages'], {
    cwd: root,
    env,
    encoding: 'utf8',
    shell: pnpm.shell,
    windowsHide: true
  })
  if (result.status !== 0) {
    console.error(tail(`${result.stdout ?? ''}${result.stderr ?? result.error?.message ?? ''}`))
    throw new Error('pnpm run build:packages failed.')
  }
}

function buildTasks(root, plan, { files, mergeBase, maxWorkers, bun }) {
  const node = process.execPath
  const oxlint = resolveOxcCliInvocation('oxlint', 'oxlint', root)
  const oxfmt = resolveOxcCliInvocation('oxfmt', 'oxfmt', root)
  const existing = files.filter((file) => existsSync(path.join(root, file)))
  const step = (program, args) => ({ program, args })
  const tasks = []

  if (plan.typecheckProjects.length > 0) {
    tasks.push({
      name: `typecheck (${plan.typecheckProjects.map((config) => path.basename(config, '.json')).join(', ')})`,
      steps: [
        step(node, [
          'config/scripts/run-typecheck-projects-in-parallel.mjs',
          ...plan.typecheckProjects.map((config) => `--project=${config}`),
          // A worker cap means a shared host; 4 checkers cut typecheck CPU by about a third.
          ...(maxWorkers ? [`--checkers=${Math.max(2, Number(maxWorkers) * 2)}`] : [])
        ])
      ]
    })
  }
  const related = plan.unitTests.related.filter((file) => existsSync(path.join(root, file)))
  const colocated = plan.unitTests.colocated.filter((file) => existsSync(path.join(root, file)))
  if (related.length > 0 || colocated.length > 0) {
    const vitest = (selection) =>
      step(node, [
        'config/scripts/run-vitest.mjs',
        ...selection,
        '--config',
        'config/vitest.config.ts',
        '--passWithNoTests',
        ...(maxWorkers ? [`--maxWorkers=${maxWorkers}`] : [])
      ])
    tasks.push({
      name: 'unit tests',
      steps: [
        step(node, ['config/scripts/ensure-native-runtime.mjs', '--runtime=node']),
        ...(related.length > 0
          ? [
              vitest(
                fitsCommandLine(related)
                  ? ['related', '--run', ...related]
                  : ['run', `--changed=${mergeBase}`]
              )
            ]
          : []),
        ...(colocated.length > 0 ? [vitest(['run', ...colocated])] : [])
      ]
    })
  }
  if (plan.staticAnalysis) {
    tasks.push({
      name: 'changed-code quality',
      steps: [step(node, ['config/scripts/check-changed-code-quality.mjs', mergeBase])]
    })
    if (existing.length > 0) {
      tasks.push({
        name: 'format',
        steps: [
          step(oxfmt.command, [
            ...oxfmt.prefixArgs,
            '--check',
            '--no-error-on-unmatched-pattern',
            ...(fitsCommandLine(existing) ? existing : ['.'])
          ])
        ]
      })
    }
    const lintable = existing.filter((file) => LINTABLE.test(file))
    if (lintable.length > 0) {
      const wholeTree = !fitsCommandLine(lintable)
      const antiSlop = lintable.filter((file) =>
        ANTI_SLOP_ROOTS.some((root) => file.startsWith(root))
      )
      tasks.push({
        name: 'oxlint',
        steps: [
          step(oxlint.command, [...oxlint.prefixArgs, '--quiet', ...(wholeTree ? [] : lintable)]),
          ...(antiSlop.length > 0
            ? [
                step(node, ['config/scripts/sync-anti-slop-plugin.mjs']),
                step(bun(), [
                  '--smol',
                  ...oxlint.prefixArgs,
                  '--config',
                  'config/oxlint-anti-slop.json',
                  '--deny-warnings',
                  ...(wholeTree ? ANTI_SLOP_ROOTS : antiSlop)
                ])
              ]
            : [])
        ]
      })
    }
  }
  for (const check of plan.checks) {
    tasks.push({
      name: check.name,
      steps: [
        check.oxlint
          ? step(oxlint.command, [...oxlint.prefixArgs, ...check.oxlint])
          : step(check.runtime === 'bun' ? bun() : node, check.args)
      ]
    })
  }
  return tasks
}

async function runTask(task, { root, env, runProcess, stepTimeoutMs }) {
  const startedAt = performance.now()
  let output = ''
  for (const { program, args } of task.steps) {
    try {
      const result = await runProcess(
        { program, args, cwd: root, env, timeoutMs: stepTimeoutMs || null },
        'tail'
      )
      output += result.stdout + result.stderr
      if (result.timedOut) {
        output += `\nTimed out after ${stepTimeoutMs / 60_000} min; pass --timeout=<minutes> to extend.`
      }
      if (result.code !== 0 || result.timedOut) {
        return { task, ok: false, output, elapsed: seconds(startedAt) }
      }
    } catch (error) {
      return {
        task,
        ok: false,
        output: `${output}${error.message ?? error}`,
        elapsed: seconds(startedAt)
      }
    }
  }
  return { task, ok: true, output, elapsed: seconds(startedAt) }
}

async function runPool(tasks, concurrency, run) {
  const results = []
  let next = 0
  await Promise.all(
    Array.from({ length: Math.min(concurrency, tasks.length) }, async () => {
      while (next < tasks.length) {
        results.push(await run(tasks[next++]))
      }
    })
  )
  return results
}

export async function main(root, argv) {
  const startedAt = performance.now()
  const options = parseArgs(argv)
  const { ref, mergeBase } = resolveMergeBase(root, options.base)
  const files = collectChangedFiles(root, mergeBase)
  if (files.length === 0) {
    console.log(`check:changed: no changes against ${ref}.`)
    return 0
  }
  const hash = computePassHash(root, mergeBase)
  if (!options.force && readPassHash(root) === hash) {
    console.log('Nothing changed since last passing run.')
    return 0
  }

  const plan = planChangedChecks(files, {
    scriptsDir: path.join(root, 'config', 'scripts'),
    listDirectory: (directory) => {
      try {
        return readdirSync(path.join(root, directory))
      } catch {
        return []
      }
    }
  })
  const env = {
    ...process.env,
    ORCA_BACKGROUND_LAUNCH: '1',
    // Why: spawned gates that read the base themselves (flaky-test ratchet) must use --base too.
    ORCA_CODE_QUALITY_BASE: mergeBase,
    ...(process.stdout.isTTY ? { FORCE_COLOR: '1' } : {})
  }
  if (
    plan.typecheckProjects.length > 0 ||
    plan.unitTests.related.length + plan.unitTests.colocated.length > 0
  ) {
    buildWorkspacePackages(root, env)
  }
  const { runProcess, runProcessSync } = await import('@orca/process-host')
  const { resolvePinnedBunExecutable } = await import('./pinned-bun-executable.mjs')
  const bun = () => resolvePinnedBunExecutable(root, runProcessSync) ?? 'bun'
  const tasks = buildTasks(root, plan, {
    files,
    mergeBase,
    maxWorkers: options.maxWorkers,
    bun
  })
  console.log(
    `check:changed: ${files.length} changed file(s) since ${ref} (${mergeBase.slice(0, 10)}); running ${tasks.length} check(s).`
  )

  // Typecheck and tests lead the queue: they take longest, so the short checks fill in around them.
  const concurrency = Math.max(3, Math.floor(availableParallelism() / 3))
  const running = new Map()
  // Why: output is buffered until a task ends, so long test runs would otherwise look hung.
  const heartbeat = setInterval(() => {
    const active = [...running].map(([name, taskStartedAt]) => `${name} ${seconds(taskStartedAt)}`)
    console.log(`… ${seconds(startedAt)} elapsed; running: ${active.join(', ')}`)
  }, HEARTBEAT_MS)
  heartbeat.unref()
  const results = await runPool(tasks, concurrency, async (task) => {
    running.set(task.name, performance.now())
    const result = await runTask(task, {
      root,
      env,
      runProcess,
      stepTimeoutMs: options.stepTimeoutMs
    })
    running.delete(task.name)
    if (result.ok) {
      console.log(`✓ ${task.name} (${result.elapsed})`)
    } else {
      console.error(`\n✗ ${task.name} (${result.elapsed})\n${tail(result.output)}`)
    }
    return result
  }).finally(() => clearInterval(heartbeat))
  const failed = results.filter((result) => !result.ok)
  if (failed.length > 0) {
    console.error(
      `\n✗ ${failed.length} of ${results.length} check(s) failed in ${seconds(startedAt)}: ${failed.map((result) => result.task.name).join(', ')}`
    )
    return 1
  }
  writePassHash(root, hash)
  console.log(`✓ ${results.length} check(s) passed in ${seconds(startedAt)}.`)
  return 0
}

if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
  try {
    const root = execFileSync('git', ['rev-parse', '--show-toplevel'], { encoding: 'utf8' }).trim()
    process.exitCode = await main(root, process.argv.slice(2))
  } catch (error) {
    console.error(`check:changed: ${error.message ?? error}`)
    process.exitCode = 1
  }
}