feat: ship packaged macOS menu bar companion#387
Open
jaycho46 wants to merge 16 commits into
Open
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughChangesAdds a native Swift macOS menu bar companion that reads macOS companion
Estimated code review effort: 4 (Complex) | ~60 minutes Sequence Diagram(s)sequenceDiagram
participant User
participant AppDelegate
participant OcxClient
participant OcxCLI
participant Proxy
User->>AppDelegate: open menu bar companion
AppDelegate->>OcxClient: fetchStatus()
OcxClient->>OcxCLI: run status --json
OcxCLI->>Proxy: request /healthz
Proxy-->>OcxCLI: return health metadata
OcxCLI-->>OcxClient: return status JSON
OcxClient-->>AppDelegate: return OcxStatus
AppDelegate-->>User: render proxy status and details
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 03c4e8ac91
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/release.yml:
- Around line 34-35: Restrict workflow permissions by removing workflow-level
id-token: write and granting it only in the gated publish job; keep
package-macos limited to its minimum required permissions, and set
persist-credentials: false on its checkout step. Treat these .github/**
security-boundary changes as requiring escalation review for any new secret
usage or permission increase.
In `@apps/macos-menu-bar/Sources/OpenCodexMenuBarCore/OcxClient.swift`:
- Around line 84-103: The run(_:arguments:) method currently waits for process
termination before draining pipes, allowing deadlocks and indefinite blocking.
Update run to concurrently drain stdout and stderr while the process runs,
enforce a finite timeout, and terminate the process when the deadline is
exceeded; preserve the existing successful output and commandFailed handling for
normal exits.
In `@docs-site/src/content/docs/guides/macos-menu-bar.md`:
- Around line 36-37: The macOS menu-bar guide needs explicit first-launch
Gatekeeper approval steps in both locales. In
docs-site/src/content/docs/guides/macos-menu-bar.md at lines 36-37, add
instructions to Control-click the app, choose Open, and use Privacy & Security →
Open Anyway if prompted; add the equivalent Japanese instructions in
docs-site/src/content/docs/ja/guides/macos-menu-bar.md at lines 27-28.
In `@docs-site/src/content/docs/reference/cli.md`:
- Around line 114-115: Qualify the healthy metadata documentation to state that
version and uptimeSeconds are populated only when /healthz provides valid
values; otherwise each is null. Apply the same clarification in
docs-site/src/content/docs/reference/cli.md:114-115,
docs-site/src/content/docs/ja/reference/cli.md:111-112,
docs-site/src/content/docs/ko/reference/cli.md:114-115,
docs-site/src/content/docs/ru/reference/cli.md:120-120, and
docs-site/src/content/docs/zh-cn/reference/cli.md:112-113, keeping all locale
pages consistent with the English CLI documentation.
In `@README.md`:
- Around line 75-85: Update README.md lines 75-85 and the macOS menu bar guides
in docs-site/src/content/docs/ko/guides/macos-menu-bar.md lines 14-34,
docs-site/src/content/docs/ru/guides/macos-menu-bar.md lines 14-29, and
docs-site/src/content/docs/zh-cn/guides/macos-menu-bar.md lines 13-27 to use bun
run build:macos-app and the exact release filename
OpenCodex-<version>-macos-universal.zip.
In `@scripts/package-macos-release.sh`:
- Line 56: Update the archive_name assignment in the macOS release packaging
flow to use lowercase “macos” in the published filename, producing
OpenCodex-<version>-macos-<architecture>.zip while preserving the existing
version and architecture_label components.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: f0149fd9-c6d6-42aa-967c-796ae6e5cd6c
📒 Files selected for processing (33)
.github/workflows/ci.yml.github/workflows/release.yml.gitignoreREADME.mdapps/macos-menu-bar/Info.plistapps/macos-menu-bar/Package.swiftapps/macos-menu-bar/Sources/OpenCodexMenuBar/MenuText.swiftapps/macos-menu-bar/Sources/OpenCodexMenuBar/StatusBarIcon.swiftapps/macos-menu-bar/Sources/OpenCodexMenuBar/main.swiftapps/macos-menu-bar/Sources/OpenCodexMenuBarCore/OcxClient.swiftapps/macos-menu-bar/Sources/OpenCodexMenuBarCore/OcxLocator.swiftapps/macos-menu-bar/Sources/OpenCodexMenuBarCore/StatusModels.swiftapps/macos-menu-bar/Tests/OpenCodexMenuBarCoreTests/OpenCodexMenuBarCoreTests.swiftdocs-site/astro.config.mjsdocs-site/src/content/docs/guides/macos-menu-bar.mddocs-site/src/content/docs/ja/guides/macos-menu-bar.mddocs-site/src/content/docs/ja/reference/cli.mddocs-site/src/content/docs/ko/guides/macos-menu-bar.mddocs-site/src/content/docs/ko/reference/cli.mddocs-site/src/content/docs/reference/cli.mddocs-site/src/content/docs/ru/guides/macos-menu-bar.mddocs-site/src/content/docs/ru/reference/cli.mddocs-site/src/content/docs/zh-cn/guides/macos-menu-bar.mddocs-site/src/content/docs/zh-cn/reference/cli.mdpackage.jsonscripts/build-macos-app.shscripts/package-macos-release.shscripts/release.tssrc/cli/status.tsstructure/00_overview.mdstructure/01_runtime.mdstructure/05_gui-and-management-api.mdtests/cli-status-json.test.ts
Keep package-macos on contents:read with persist-credentials disabled so macOS packaging cannot request the npm OIDC token before release gates.
Prevent hung or chatty ocx subprocesses from deadlocking the serial CLI queue by draining stdout/stderr while the process runs and terminating after a deadline.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/macos-menu-bar/Sources/OpenCodexMenuBarCore/OcxClient.swift`:
- Around line 98-119: Update the command execution flow around process.run,
group.wait, and process.waitUntilExit to use process.terminationHandler as the
process-exit signal, waiting up to Self.commandTimeout for termination rather
than using pipe EOF or process.isRunning. Drain stdout and stderr separately
after process termination; on timeout, terminate the process, apply a bounded
force-kill fallback if needed, and wait for confirmed exit before throwing
OcxClientError.commandFailed.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 00db1b83-ef17-4fb0-bdf5-90f19a737d66
📒 Files selected for processing (1)
apps/macos-menu-bar/Sources/OpenCodexMenuBarCore/OcxClient.swift
Avoid treating "installed, but stale" as startable. Route start/restart through service install repair, surface a repair label, and mark the phase as failed until the service is fixed.
Healthy `/healthz` responses may omit version/uptimeSeconds, so status --json docs now state those fields can be null.
Rename the package script and docs from build:macos to build:macos-app, and document the lowercase macos release asset name.
Publish OpenCodex-<version>-macos-<arch>.zip so the artifact name matches the documented release contract.
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs-site/src/content/docs/ko/guides/macos-menu-bar.md (1)
36-37: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winAdd the first-launch Gatekeeper procedure to all translated guides.
The English guide explains how to approve the ad-hoc-signed app, but these translations only warn that approval may be required:
docs-site/src/content/docs/ko/guides/macos-menu-bar.md#L36-L37: add Control-click → Open and System Settings → Privacy & Security → Open Anyway.docs-site/src/content/docs/ru/guides/macos-menu-bar.md#L28-L29: add the equivalent Russian instructions.docs-site/src/content/docs/zh-cn/guides/macos-menu-bar.md#L27-L27: add the equivalent Chinese instructions.As per path instructions, translated locale pages must stay in sync with the English source.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs-site/src/content/docs/ko/guides/macos-menu-bar.md` around lines 36 - 37, Update the translated macOS menu-bar guides to include the complete first-launch Gatekeeper procedure: in docs-site/src/content/docs/ko/guides/macos-menu-bar.md lines 36-37, add Control-click → Open and System Settings → Privacy & Security → Open Anyway in Korean; apply the equivalent Russian instructions in docs-site/src/content/docs/ru/guides/macos-menu-bar.md lines 28-29 and equivalent Chinese instructions in docs-site/src/content/docs/zh-cn/guides/macos-menu-bar.md line 27. Keep all translated pages synchronized with the English guide.Source: Path instructions
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/macos-menu-bar/Sources/OpenCodexMenuBarCore/StatusModels.swift`:
- Around line 58-62: Update the phase computation in the phase property to
require both proxy.running and proxy.health.ok before returning .running.
Preserve .failed for stale services, and ensure a live but unhealthy proxy
reaches .degraded; add a regression test covering running=true with
health.ok=false.
In `@docs-site/src/content/docs/ko/reference/cli.md`:
- Around line 114-115: Update the Korean nullable-field sentence in the CLI
documentation to use grammatically correct endpoint wording and clarify that
version and uptimeSeconds may each independently be null when omitted by the
endpoint, consistent with the API contract and English documentation.
---
Outside diff comments:
In `@docs-site/src/content/docs/ko/guides/macos-menu-bar.md`:
- Around line 36-37: Update the translated macOS menu-bar guides to include the
complete first-launch Gatekeeper procedure: in
docs-site/src/content/docs/ko/guides/macos-menu-bar.md lines 36-37, add
Control-click → Open and System Settings → Privacy & Security → Open Anyway in
Korean; apply the equivalent Russian instructions in
docs-site/src/content/docs/ru/guides/macos-menu-bar.md lines 28-29 and
equivalent Chinese instructions in
docs-site/src/content/docs/zh-cn/guides/macos-menu-bar.md line 27. Keep all
translated pages synchronized with the English guide.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 3c2379fe-d80d-49a4-ad9f-774a4cee40a7
📒 Files selected for processing (17)
README.mdapps/macos-menu-bar/Sources/OpenCodexMenuBar/MenuText.swiftapps/macos-menu-bar/Sources/OpenCodexMenuBar/main.swiftapps/macos-menu-bar/Sources/OpenCodexMenuBarCore/StatusModels.swiftapps/macos-menu-bar/Tests/OpenCodexMenuBarCoreTests/OpenCodexMenuBarCoreTests.swiftdocs-site/src/content/docs/guides/macos-menu-bar.mddocs-site/src/content/docs/ja/guides/macos-menu-bar.mddocs-site/src/content/docs/ja/reference/cli.mddocs-site/src/content/docs/ko/guides/macos-menu-bar.mddocs-site/src/content/docs/ko/reference/cli.mddocs-site/src/content/docs/reference/cli.mddocs-site/src/content/docs/ru/guides/macos-menu-bar.mddocs-site/src/content/docs/ru/reference/cli.mddocs-site/src/content/docs/zh-cn/guides/macos-menu-bar.mddocs-site/src/content/docs/zh-cn/reference/cli.mdpackage.jsonscripts/package-macos-release.sh
Track ocx termination with terminationHandler instead of pipe EOF, then drain pipes separately and force-kill hung processes on timeout.
Treat a live process with failed /healthz as degraded instead of green running, while keeping stale services as failed/repairable.
Make the Korean status docs say each healthy field may independently be null when /healthz omits it.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/macos-menu-bar/Sources/OpenCodexMenuBarCore/OcxClient.swift`:
- Around line 105-124: Synchronize pipe-reading completion before consuming the
buffers in the command execution flow around exitGroup. Track both stdout and
stderr readDataToEndOfFile tasks with a separate DispatchGroup, enter and leave
it around each reader, then wait for that group after process completion and
before assigning stdout and stderr from their boxes; preserve the existing
timeout and termination behavior.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: a3936a80-c3f1-4cd7-89f9-01bf7582f5d6
📒 Files selected for processing (3)
apps/macos-menu-bar/Sources/OpenCodexMenuBarCore/OcxClient.swiftapps/macos-menu-bar/Sources/OpenCodexMenuBarCore/StatusModels.swiftdocs-site/src/content/docs/ko/reference/cli.md
3 tasks
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
1 participant
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.
Summary
apps/macos-menu-barfor proxy running/health status and common actions.ocx status --jsonwith structured health metadata consumed by the companion..zip+ checksum assets to GitHub Releases.Closes #386
Verification
bun x tsc --noEmitbun test --isolate tests/cli-status-json.test.tsupstream/dev; merge-tree check is cleanmain/previewonly, dry-run first,expected-sharetainedChecklist
Summary by CodeRabbit
ocx status --jsonwithproxy.health.versionandproxy.health.uptimeSeconds, including when the proxy is unreachable.