refactor: rename ios-runner -> apple-runner (#981)#996
Merged
Conversation
Finish the cosmetic ios-runner -> apple-runner rename now that the top-level XCTest runner is the OS-agnostic Apple engine (iOS/iPadOS/tvOS/macOS/visionOS from one Xcode project). Cosmetic only, no behavior change: - git mv ios-runner/ -> apple-runner/ (AgentDeviceRunner, README, RUNNER_PROTOCOL) - Update repo project-path consumers: build-xcuitest-apple.sh, package.json files globs, .fallowrc.json, write-xcuitest-cache-metadata.mjs, runner-xctestrun.ts fingerprint/project paths, recording overlay + test, daemon-client-timeout kill pattern, setup-apple-replay hashFiles glob, ci.yml swift-compat scan, AGENTS.md. - Rename runtime home cache/derived/lease dir default ~/.agent-device/ios-runner -> ~/.agent-device/apple-runner (build script, package/clean scripts, runner-xctestrun RUNNER_DERIVED_ROOT, runner-lease, runner-contract hint, cli-help/commands.md docs) and the tests asserting it. - Rename OS-agnostic runner symbols: runIosRunnerCommand -> runAppleRunnerCommand, prewarmIosRunnerCache -> prewarmAppleRunnerCache, createIosRunnerCachePrewarmOnColdBoot / createIosRunnerCacheColdBootPrewarmForOpen -> createAppleRunner* (+ call sites, type aliases, test mocks). Intentionally left as ios-runner (out of scope / would change behavior): - prepare ios-runner CLI subcommand (user-facing command name) - AGENT_DEVICE_IOS_RUNNER_* env var names and .tmp/ios-runner-derived CI values - ios-runner-prebuilt cache-key-prefix, ci.yml job id, workflow/ADR filenames - agent-device-ios-runner-<version> release artifact basenames Part of #972 (Phase 3 - Apple PlatformPlugin).
|
Size Report
Startup median (7 runs, lower is better):
Top changed chunks:
|
Member
Author
|
Reviewed after checks completed: no actionable findings. The rename is mergeable and CI is green. The release-adjacent cache-dir migration is called out in the PR body; the remaining stale hash inputs I noticed in setup-apple-replay are pre-existing cache-key debt, not a blocker for this rename. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #981. Part of #972 (Phase 3 — Apple PlatformPlugin).
Finishes the cosmetic
ios-runner→apple-runnerrename now that the top-level XCTest runner project is the OS-agnostic Apple engine (drives iOS/iPadOS/tvOS/macOS/visionOS from one Xcode project). Cosmetic only — no behavior change.What was renamed
Directory
git mv ios-runner/ → apple-runner/(keepsAgentDeviceRunner/,README.md,RUNNER_PROTOCOL.md) — detected as pure renames.Repo project-path consumers (
<root>/ios-runner/AgentDeviceRunner→apple-runner/...)scripts/build-xcuitest-apple.sh(PROJECT_PATH),package.jsonfilesglobs,.fallowrc.json,scripts/write-xcuitest-cache-metadata.mjssrc/platforms/apple/core/runner/runner-xctestrun.ts(project path + source-fingerprint root)src/recording/overlay.ts+src/recording/__tests__/recording-scripts.test.tssrc/daemon/client/daemon-client-timeout.ts(xcodebuild kill pattern).github/actions/setup-apple-replay/action.yml(hashFilesglob),.github/workflows/ci.yml(Swift compat scan dir),AGENTS.mdRuntime home cache/derived/lease dir default (
~/.agent-device/ios-runner→~/.agent-device/apple-runner)build-xcuitest-apple.shderived paths,scripts/package-ios-simulator-runner.sh+scripts/clean-xcuitest-derived.mjsdefaultsrunner-xctestrun.tsRUNNER_DERIVED_ROOT,runner-lease.tsleases dir,runner-contract.tsrecovery hintsrc/cli/parser/cli-help.ts,website/docs/docs/commands.mdrunner-client.test.tsOS-agnostic runner symbols (+ all call sites, type aliases, test mocks)
runIosRunnerCommand→runAppleRunnerCommandprewarmIosRunnerCache→prewarmAppleRunnerCachecreateIosRunnerCachePrewarmOnColdBoot→createAppleRunnerCachePrewarmOnColdBootcreateIosRunnerCacheColdBootPrewarmForOpen→createAppleRunnerCacheColdBootPrewarmForOpenIntentionally left as
ios-runner(out of scope / would change behavior)prepare ios-runnerCLI subcommand — user-facing command name; renaming it is a behavior change, not in scope.AGENT_DEVICE_IOS_RUNNER_*env var names and the.tmp/ios-runner-derivedCI values — kept per issue guidance (renaming would require touching all workflows). The env var stays consistent between build script and runtime, so overrides still resolve.ios-runner-prebuiltcache-key-prefix,ci.ymljob idios-runner-swift-compat, ADR/doc filenames (docs/adr/0005-ios-runner-*,docs/ios-runner-protocol-optimizations.md).agent-device-ios-runner-<version>release artifact basenames inpackage-ios-simulator-runner.sh— release artifact naming consumed by the release workflow; renaming is a separate, riskier change.mkdtempprefixes and skillgym scenario ids containingios-runner(cosmetic labels, no coupling).This touches build/cache/derived paths:
~/.agent-device/ios-runner/to~/.agent-device/apple-runner/. Existing local caches at the old path are orphaned (not deleted); the runner rebuilds into the new path on first use. CI is unaffected because it overrides the path viaAGENT_DEVICE_IOS_RUNNER_DERIVED_PATH(value unchanged).setup-apple-replayhashFiles('apple-runner/**', ...)and the source fingerprint change input strings, so prebuilt-runner caches will miss once and repopulate after merge (expected for a dir rename).write-xcuitest-cache-metadata.mjs↔runner-xctestrun.ts) were updated together to stay consistent.Verification
tsc -p tsconfig.json✅oxlint . --deny-warnings✅oxfmt --write && --check src test✅scripts/layering/check.ts✅rslib build✅vitest run --project unit— only the 3 known flakyfillAndroidandroid tests failed under CPU contention; they pass 92/92 in isolation and are unrelated to this rename ✅fallow audit --base origin/main— no new findings ✅DO NOT MERGE without maintainer review of the cache-dir migration.