Skip to content

docs: describe the Chromium install helper in the directory READMEs - #373

Merged
ThomasK33 merged 2 commits into
mainfrom
docs/chromium-helper-readmes
Nov 10, 2026
Merged

ThomasK33 merged 2 commits into
mainfrom
docs/chromium-helper-readmes

Conversation

@ThomasK33

@ThomasK33 ThomasK33 commented Nov 10, 2026 •

Copy link
Copy Markdown
Member

Why

#370 added two helpers to src/renderer/browserPath.ts and made the Chromium renderer launch through one of them. The directory READMEs of the renderer list the exports and side effects of these files, and they did not name the helpers. The readiness review of #370 asked for this update.

The same review noted that the install command prints a warning box of Playwright. Playwright prints the box when npx runs it from the npx cache. npx does that unless it finds that Playwright version already installed, as in a project that depends on it. The box suggests npm install and a bare npx playwright install, which is the command that the Chromium section tells readers not to use there.

What changed

  • src/renderer/README.md: the interface list names resolveChromiumInstallCommand and withChromiumInstallHint with their callers. The invariants say which error the helper changes and that every other error and result passes through. The side effects say that the command lookup reads playwright/package.json.
  • src/renderer/ghosttyWeb/README.md: the launch entry says that chromium.launch runs inside withChromiumInstallHint.
  • src/cli/commands/README.md: the side effects of doctor name the read of playwright/package.json, which doctor does to name the install command.
  • docs/INSTALL.md: two sentences after the Chromium command block say when Playwright prints its warning box, and that the box can be ignored.

Scope

Docs only. No code, test, or CLI output changes.

Blast Radius

Four Markdown files.

Verification

  • Each cited symbol exists at this head: browserPath.ts:resolveChromiumInstallCommand, browserPath.ts:withChromiumInstallHint, backend.ts:GhosttyWebBackend.bootInternal and doctor.ts:runBrowserCacheAccessibleCheck. The two named callers, src/cli/commands/doctor.ts and src/renderer/ghosttyWeb/backend.ts, both call withChromiumInstallHint, and doctor.ts has one direct call of resolveChromiumInstallCommand.
  • The warning box: npx playwright@1.60.0 install chromium and npx playwright@1.64.1 install chromium, each run in an empty folder, printed the box (WARNING: It looks like you are running 'npx playwright install' without first installing your project's dependencies) and then installed their Chromium build. On this Ubuntu 26.04 host, the 1.60.0 run needed the platform override that docs/TROUBLESHOOTING.md names.
  • The condition of the warning box: at this head, three independent verifiers ran npx playwright@1.64.1 install --dry-run chromium. An empty folder, a project without Playwright and a project with another Playwright version (1.60.0, 1.63.0 or 1.64.0, one per verifier) printed the box for each verifier. A project with playwright@1.64.1 installed did not. Two of the verifiers also ran the command in a subfolder of that project, and it printed no box there.
  • Local: the format check passes.

Generated with xum • Model: anthropic:claude-fable-5-2 • Thinking: xhigh

The renderer READMEs list the exports and side effects of
browserPath.ts and the launch of the Chromium renderer. They did not
name `resolveChromiumInstallCommand` and `withChromiumInstallHint`.

docs/INSTALL.md also says that the warning box of Playwright, which
the pinned install command prints outside a project, can be ignored.

_Generated with [`xum`](https://github.com/coder/xum) • Model: `anthropic:claude-fable-5-2` • Thinking: `xhigh`_
@ThomasK33

Copy link
Copy Markdown
Member Author

@codex review

@ThomasK33

Copy link
Copy Markdown
Member Author

@codex security review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-10T17:25:50.920670Z cf9bc85 Manual request
🔒 Security Review ✅ Completed 2026-11-10T17:26:45.733097Z cf9bc85 Manual request
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Hooray!

Reviewed commit: 89656f948b

ℹ️ 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".

@chatgpt-codex-connector

Copy link
Copy Markdown

🛡️ Codex Security Review

Security review completed. No security issues were found in this pull request.

Reviewed commit: 89656f948b

View security finding report

Only the user who started this review can view the report in Codex.

ℹ️ About Codex security reviews in GitHub

This is an experimental Codex feature. Security reviews are triggered when:

  • You comment "@codex security review"
  • A regular code review gets triggered (for example, "@codex review" or when a PR is opened), and you’re opted in so security review runs alongside code review

Once complete, Codex will leave suggestions, or a comment if no findings are found.

The callers sentence named both helpers, but the renderer calls only
`withChromiumInstallHint`. Playwright prints its warning box whenever
npx runs it from its own cache, also in a project that lacks that
Playwright version, so "outside a project" was too narrow. The
commands README now names the file that `doctor` reads for the install
command.

_Generated with [`xum`](https://github.com/coder/xum) • Model: `anthropic:claude-fable-5-2` • Thinking: `xhigh`_
@ThomasK33 ThomasK33 changed the title docs: describe the Chromium install helper in the renderer READMEs docs: describe the Chromium install helper in the directory READMEs Nov 10, 2026
@ThomasK33

Copy link
Copy Markdown
Member Author

@codex review

@ThomasK33

Copy link
Copy Markdown
Member Author

@codex security review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Nice work!

Reviewed commit: cf9bc85d95

ℹ️ 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".

@chatgpt-codex-connector

Copy link
Copy Markdown

🛡️ Codex Security Review

Security review completed. No security issues were found in this pull request.

Reviewed commit: cf9bc85d95

View security finding report

Only the user who started this review can view the report in Codex.

ℹ️ About Codex security reviews in GitHub

This is an experimental Codex feature. Security reviews are triggered when:

  • You comment "@codex security review"
  • A regular code review gets triggered (for example, "@codex review" or when a PR is opened), and you’re opted in so security review runs alongside code review

Once complete, Codex will leave suggestions, or a comment if no findings are found.

@ThomasK33

ThomasK33 commented Nov 10, 2026 •

Copy link
Copy Markdown
Member Author

Delivery record

  • Final commit: cf9bc85.
  • Checks on that commit: 27 of 27 check runs passed, including quality-gates, quality-gates-macos and pr-title.
  • Independent verification, two rounds with three new verifiers each.
    • Round 1 on 89656f9: three verifiers pass. Their minor notes led to cf9bc85: the condition of the warning box, the callers sentence, one name for the install command, and the file read of doctor.
    • Round 2 on cf9bc85: three verifiers pass. Each of them ran the install command in an empty folder, in a project without Playwright, in a project with another Playwright version and in a project with that Playwright version.
  • Codex: two review rounds. The normal review and the security review are both clean on cf9bc85. 0 threads.
  • Clean-context advisor: ready, no follow-up needed. It found two stale statements in this description (the condition of the warning box, and the number of folders that the verifiers used). I corrected the description. The commit did not change.
  • Minor points with no change:
    • A subfolder of a project with that Playwright version prints no box either. A reader there sees no box, so the instruction to ignore it does no harm.
    • In src/cli/commands/README.md, the launch-failure case has no citation of its own. The same entry already cites doctor.ts:runBrowserLaunchCheck.
    • "browser cache is missing" also covers a cache folder that doctor cannot read or that holds no browser folder. doctor prints one message for these cases.
  • Reason for stopping the review: no open finding on this head.

Generated with xum • Model: anthropic:claude-fable-5-2 • Thinking: xhigh

@ThomasK33
ThomasK33 added this pull request to the merge queue Nov 10, 2026
Merged via the queue into main with commit 681bc58 Nov 10, 2026
29 checks passed
@ThomasK33
ThomasK33 deleted the docs/chromium-helper-readmes branch November 10, 2026 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant