mirror of
https://github.com/stablyai/orca.git
synced 2026-09-22 16:02:32 +00:00
* fix(worktrees): stop silently switching existing Windows setup scripts to Git Bash #6967 derived the Windows setup-runner shell from `terminalWindowsShell`. On upgrade, any Windows user whose terminal preference resolved to Git Bash had their existing `orca.yaml` setup script (and issue command) handed to bash instead of cmd.exe. Scripts authored against the cmd runner — `copy`, `xcopy`, `set VAR=value`, `if errorlevel 1`, `%VAR%`, backslash paths — broke with no migration and no warning, and the failure looked like Orca broke the project. The conflation is also wrong in the steady state: a terminal preference is per-user, so two people on the same repo got different interpreters for the same orca.yaml and no project could write a setup script that worked for all of its Windows contributors. The interpreter is now a property of the script, declared the standard way: a leading `#!` line. Native Windows keeps the historical `.cmd` runner unless the script declares a POSIX shell, so no existing script changes behavior. `resolveSetupRunnerShell` keeps its role as the feasibility gate — a bash runner still requires the terminal to resolve to Git Bash, since the launch command is typed into that shell and uses MSYS `/c/...` paths. `buildWindowsRunnerScript` now drops a leading `#!` line rather than `call`ing it, so a declared-bash script that falls back to cmd (Git Bash missing) fails on a real setup line instead of aborting on errorlevel at line one. WSL worktrees, POSIX platforms, and SSH hosts are untouched. * fix(worktrees): keep the cmd setup runner launchable from a Git Bash pane Adversarial review of this PR found that pinning the runner format per script reopened issue #6896 one layer down. - `WorktreeSetupLaunch.shell` had been redefined to mean "the format the runner file was written in". `resolveSetupRunnerCommand` consumes it as "the shell that types the launch command", so a Git Bash terminal with a batch setup script produced `cmd.exe /c "C:\...\setup-runner.cmd"` typed into a bash pane, where MSYS rewrites the `/c` switch into a drive path: cmd opens interactively and setup never runs. `shell` is the terminal's family again; the runner file's .cmd/.sh extension carries the format, and a batch runner launched from a POSIX pane reuses the existing PowerShell ProcessStartInfo launcher. - The cmd runner dropped a leading `#!` line and ran the rest as batch, so a bash script reaching cmd (PowerShell/cmd terminal, or any SSH-to-Windows host) got its interpreter-agnostic prefix executed before failing mid-way. It now prints why and exits 1 without running anything. - A `#!` line's option flags were discarded: `#!/usr/bin/env -S bash -euo pipefail` lost pipefail because the runner is launched as `bash <path>`. The generated posix runner now replays declared flags via `set` and drops the duplicate interpreter line. - Docs cover the per-user setup command in repository hook settings, which goes through the same `#!` rule, and describe what the `#!` line does and does not select. Tests: composed launch command for a POSIX pane + cmd runner (hooks, shared runner command, setup sequencing gate, observed-setup signal), the cmd runner's shebang refusal, and shebang flag replay. Each fails with the source reverted. * fix(worktrees): replay only real `set` flags and keep the gate in the pane's shell Two round-2 review findings: - `#!/bin/bash -l` replayed `set -l`, which exits 2 and aborted the runner under its own `set -e` before a single setup line ran (all platforms). Only the flags `set` documents are replayed now; a bare `-o` with no option name is dropped instead of dumping the shell-option table. - The wait-for-setup gate picked its language from the runner file, so a batch runner launched from a Git Bash pane got the PowerShell gate while the agent startup command was already POSIX-quoted — `Invoke-Expression` cannot parse `'\''`. The gate now follows the pane; the runner still launches through the ProcessStartInfo launcher, never through bash. --------- Co-authored-by: OrcaWin <293788423+OrcaWin@users.noreply.github.com>
154 lines
5.4 KiB
TypeScript
154 lines
5.4 KiB
TypeScript
import { isWindowsAbsolutePathLike } from './cross-platform-path'
|
|
import {
|
|
buildWindowsCmdRunnerDelayedLaunchCommand,
|
|
windowsRunnerPathNeedsCmdGuard
|
|
} from './windows-cmd-runner-delayed-launch'
|
|
|
|
export type SetupRunnerCommandPlatform = 'windows' | 'posix'
|
|
export type SetupRunnerShellFamily = 'posix' | 'cmd'
|
|
export type SetupRunnerCommandShell = 'posix' | 'windows'
|
|
export type SetupRunnerShell = {
|
|
family: SetupRunnerShellFamily
|
|
executable?: string
|
|
}
|
|
|
|
export type SetupRunnerCommandResolution = {
|
|
command: string
|
|
runnerScriptPathForShell: string
|
|
shell: SetupRunnerCommandShell
|
|
}
|
|
|
|
export function buildSetupRunnerCommand(
|
|
runnerScriptPath: string,
|
|
platform: SetupRunnerCommandPlatform,
|
|
shell?: SetupRunnerShell
|
|
): string {
|
|
return resolveSetupRunnerCommand(runnerScriptPath, platform, shell).command
|
|
}
|
|
|
|
export function getSetupRunnerCommandPlatformForPath(
|
|
runnerScriptPath: string,
|
|
fallbackPlatform: SetupRunnerCommandPlatform
|
|
): SetupRunnerCommandPlatform {
|
|
if (isWindowsAbsolutePathLike(runnerScriptPath)) {
|
|
return 'windows'
|
|
}
|
|
if (runnerScriptPath.startsWith('/')) {
|
|
return 'posix'
|
|
}
|
|
return fallbackPlatform
|
|
}
|
|
|
|
export function resolveSetupRunnerCommand(
|
|
runnerScriptPath: string,
|
|
platform: SetupRunnerCommandPlatform,
|
|
shell?: SetupRunnerShell
|
|
): SetupRunnerCommandResolution {
|
|
if (platform === 'windows') {
|
|
if (isWslUncPath(runnerScriptPath)) {
|
|
const linuxPath = wslUncToLinuxPath(runnerScriptPath)
|
|
return {
|
|
command: `bash ${quotePosixArg(linuxPath)}`,
|
|
runnerScriptPathForShell: linuxPath,
|
|
shell: 'posix'
|
|
}
|
|
}
|
|
if (runnerScriptPath.startsWith('/') && !isWindowsAbsolutePathLike(runnerScriptPath)) {
|
|
return {
|
|
command: `bash ${quotePosixArg(runnerScriptPath)}`,
|
|
runnerScriptPathForShell: runnerScriptPath,
|
|
shell: 'posix'
|
|
}
|
|
}
|
|
// Why: `shell` is the shell that types the command; the runner file's own extension decides
|
|
// what can execute it. A batch runner never goes to bash even from a Git Bash pane.
|
|
const cmdRunnerFile = isWindowsCmdRunnerPath(runnerScriptPath)
|
|
if (!cmdRunnerFile && (shell?.family === 'posix' || /\.sh$/i.test(runnerScriptPath))) {
|
|
// Why: WSL shells need /mnt/... paths, while Git Bash expects /c/... when replaying deferred setup scripts.
|
|
if (isWslExecutable(shell?.executable)) {
|
|
const wslPath = nativeWindowsPathToWslShellPath(runnerScriptPath)
|
|
return {
|
|
command: `bash ${quotePosixArg(wslPath)}`,
|
|
runnerScriptPathForShell: wslPath,
|
|
shell: 'posix'
|
|
}
|
|
}
|
|
// Why: queued setup launches can outlive the process that generated them, so convert native paths before handing off to POSIX shells.
|
|
const posixPath = nativeWindowsPathToPosixShellPath(runnerScriptPath)
|
|
return {
|
|
command: `bash ${quotePosixArg(posixPath)}`,
|
|
runnerScriptPathForShell: posixPath,
|
|
shell: 'posix'
|
|
}
|
|
}
|
|
return {
|
|
// Why: some path characters survive no amount of quoting on a cmd command line, and a Git
|
|
// Bash pane rewrites the bare `/c` switch itself into a drive path (issue #6896) so cmd
|
|
// opens interactively and the runner never starts. Both take the delayed-expansion
|
|
// launcher, which passes the switch through a PowerShell ProcessStartInfo instead. Every
|
|
// other case keeps the plain form.
|
|
command:
|
|
shell?.family === 'posix' || windowsRunnerPathNeedsCmdGuard(runnerScriptPath)
|
|
? buildWindowsCmdRunnerDelayedLaunchCommand(runnerScriptPath)
|
|
: `cmd.exe /c ${quoteWindowsArg(runnerScriptPath)}`,
|
|
runnerScriptPathForShell: runnerScriptPath,
|
|
shell: 'windows'
|
|
}
|
|
}
|
|
|
|
return {
|
|
command: `bash ${quotePosixArg(runnerScriptPath)}`,
|
|
runnerScriptPathForShell: runnerScriptPath,
|
|
shell: 'posix'
|
|
}
|
|
}
|
|
|
|
/** True when the runner file is a batch script, which only cmd can execute. */
|
|
export function isWindowsCmdRunnerPath(runnerScriptPath: string): boolean {
|
|
return /\.(cmd|bat)$/i.test(runnerScriptPath)
|
|
}
|
|
|
|
export function isWslUncPath(path: string): boolean {
|
|
const normalized = path.replace(/\\/g, '/')
|
|
return /^\/\/(wsl\.localhost|wsl\$)\//i.test(normalized)
|
|
}
|
|
|
|
export function wslUncToLinuxPath(windowsPath: string): string {
|
|
const normalized = windowsPath.replace(/\\/g, '/')
|
|
const match = normalized.match(/^\/\/(wsl\.localhost|wsl\$)\/[^/]+(\/.*)?$/i)
|
|
return match?.[2] || '/'
|
|
}
|
|
|
|
function quotePosixArg(value: string): string {
|
|
if (/^[A-Za-z0-9_./:-]+$/.test(value)) {
|
|
return value
|
|
}
|
|
|
|
return `'${value.replace(/'/g, `'\\''`)}'`
|
|
}
|
|
|
|
function quoteWindowsArg(value: string): string {
|
|
return `"${value.replace(/"/g, '""')}"`
|
|
}
|
|
|
|
export function nativeWindowsPathToPosixShellPath(value: string): string {
|
|
const driveMatch = value.match(/^([A-Za-z]):[\\/](.*)$/)
|
|
if (driveMatch) {
|
|
return `/${driveMatch[1].toLowerCase()}/${driveMatch[2].replace(/\\/g, '/')}`
|
|
}
|
|
return value.replace(/\\/g, '/')
|
|
}
|
|
|
|
function nativeWindowsPathToWslShellPath(value: string): string {
|
|
const driveMatch = value.match(/^([A-Za-z]):[\\/](.*)$/)
|
|
if (driveMatch) {
|
|
return `/mnt/${driveMatch[1].toLowerCase()}/${driveMatch[2].replace(/\\/g, '/')}`
|
|
}
|
|
return value.replace(/\\/g, '/')
|
|
}
|
|
|
|
function isWslExecutable(value: string | undefined): boolean {
|
|
const basename = value?.trim().replaceAll('\\', '/').split('/').pop()?.toLowerCase() ?? ''
|
|
return basename === 'wsl.exe' || basename === 'wsl'
|
|
}
|