Skip to content

[codex] Align E2E docs with CEF reality#1464

Merged
senamakel merged 1 commit into
tinyhumansai:mainfrom
jwalin-shah:codex/100x-impl-openhuman-e2e-cef-docs-upstream
May 11, 2026
Merged

[codex] Align E2E docs with CEF reality#1464
senamakel merged 1 commit into
tinyhumansai:mainfrom
jwalin-shah:codex/100x-impl-openhuman-e2e-cef-docs-upstream

Conversation

@jwalin-shah
Copy link
Copy Markdown
Contributor

@jwalin-shah jwalin-shah commented May 11, 2026

Summary

Updates E2E scripts, GitBook docs, and workflow comments to use pnpm wording and describe current CEF automation limits accurately.

Impact

Prevents agents and CI readers from treating disabled Linux WebDriver paths as the default supported route.

Validation

bash -n app/scripts/e2e-agent-review.sh app/scripts/e2e-run-spec.sh app/scripts/e2e-run-all-flows.sh && ! rg -n 'staging core sidecar|yarn .*test:e2e|Linux \(CI default\)|default CI path' app/scripts gitbooks/developing/e2e-testing.md .github/workflows/test.yml .github/workflows/e2e-agent-review.yml

Wave I replacement branch: codex/100x-impl-openhuman-e2e-cef-docs-upstream
Commit: 4405ff6c76f0b347f77c66256bd00efcfff6deef

Opened as draft for review; no deploys, merges, or tracker mutations were performed. Supersedes #1463, which was based on a stale fork branch.

Summary by CodeRabbit

  • Documentation

    • Clarified E2E testing platform support limitations for the default app configuration.
  • Chores

    • Updated build and testing scripts to use the current package manager.
    • Updated CI workflow configuration comments and documentation guidance.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026

📝 Walkthrough

Walkthrough

This PR updates E2E testing infrastructure documentation and build commands to clarify Linux CEF automation limitations and migrate from yarn to pnpm. The workflow files add diagnostic headers explaining that Linux tauri-driver cannot drive CEF-backed WebViews, while all shell scripts and CI job configurations switch build commands to pnpm with --filter syntax. The development guide is comprehensively updated to reflect these platform constraints and revised commands.

Changes

E2E Platform Limitations and Build Command Migration

Layer / File(s) Summary
Platform Limitation Overview
gitbooks/developing/e2e-testing.md
Platform/driver overview table updated to explicitly mark Linux CEF status as disabled in CI and describe supported macOS/Appium path, citing WebKitWebDriver incompatibility with CEF runtime.
Workflow Job Documentation
.github/workflows/e2e-agent-review.yml, .github/workflows/test.yml
e2e-agent-review.yml and test.yml add explanatory comments clarifying that Linux E2E is disabled because tauri-driver cannot drive CEF-backed WebViews, and workflows remain manual-only pending compatible automation.
CI Workflow Configuration Updates
.github/workflows/test.yml
Linux E2E section (commented) updates package cache label and switches dependency/build commands from yarn to pnpm; replaces sidecar staging step with in-process core linking notes. macOS E2E section (commented) similarly updates to pnpm for install, build, and execution. Comments clarifying spec scoping and extended spec skipping are updated.
Build Script Command Updates
app/scripts/e2e-agent-review.sh, app/scripts/e2e-run-all-flows.sh, app/scripts/e2e-run-spec.sh
Build commands migrate from yarn workspace openhuman-app test:e2e:build to pnpm --filter openhuman-app test:e2e:build across all scripts. Linux tauri-driver header comment clarified. Error message guidance updated to recommend pnpm build.
Development Guide Comprehensive Updates
gitbooks/developing/e2e-testing.md
Linux and macOS quick-start sections updated to use pnpm --filter openhuman-app commands. Docker-on-macOS section reflects revised build syntax. CI workflows section documents disabled Linux E2E job and rationale. Troubleshooting adds WebView timeout guidance for CEF/tauri-driver context. Notifications spec platform note reflects Linux execution constraints for default runtime.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • senamakel

Poem

🐰 From yarn to pnpm we hop and skip,
Linux CEF gets a clearer quip:
"WebDriver can't steer this runtime's way,
But macOS/Appium saves the day!"
Scripts and docs now shine so bright,
Test automation's future's right. 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: aligning E2E documentation and CI workflows to reflect CEF runtime reality, specifically that Linux E2E automation is not supported due to CEF-WebDriver incompatibility.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jwalin-shah jwalin-shah marked this pull request as ready for review May 11, 2026 00:23
@jwalin-shah jwalin-shah requested a review from a team May 11, 2026 00:23
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
app/scripts/e2e-run-spec.sh (1)

119-123: ⚡ Quick win

Remove the duplicated bundle URL guard.

Line 119 repeats the exact same check already done at Line 114, so this second block is redundant and easy to accidentally diverge.

Proposed cleanup
-if ! grep -q "127.0.0.1:${E2E_MOCK_PORT}" "$DIST_JS"; then
-  echo "ERROR: frontend bundle does NOT contain mock server URL (127.0.0.1:${E2E_MOCK_PORT})." >&2
-  echo "       Run 'pnpm test:e2e:build' to rebuild with the mock URL." >&2
-  exit 1
-fi
🤖 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 `@app/scripts/e2e-run-spec.sh` around lines 119 - 123, The script contains a
duplicated guard that checks for the mock URL in the built bundle using grep on
"$DIST_JS" with "127.0.0.1:${E2E_MOCK_PORT}" — remove the second identical block
(the repeated if ! grep -q ... then echo ... exit 1 fi) so only the original
check remains; ensure you keep the existing error messages and exit code exactly
as-is and do not alter the variable names E2E_MOCK_PORT or DIST_JS.
🤖 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.

Nitpick comments:
In `@app/scripts/e2e-run-spec.sh`:
- Around line 119-123: The script contains a duplicated guard that checks for
the mock URL in the built bundle using grep on "$DIST_JS" with
"127.0.0.1:${E2E_MOCK_PORT}" — remove the second identical block (the repeated
if ! grep -q ... then echo ... exit 1 fi) so only the original check remains;
ensure you keep the existing error messages and exit code exactly as-is and do
not alter the variable names E2E_MOCK_PORT or DIST_JS.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0935cd83-42c8-4874-beb6-59f47278f580

📥 Commits

Reviewing files that changed from the base of the PR and between 12ef69b and 4405ff6.

📒 Files selected for processing (6)
  • .github/workflows/e2e-agent-review.yml
  • .github/workflows/test.yml
  • app/scripts/e2e-agent-review.sh
  • app/scripts/e2e-run-all-flows.sh
  • app/scripts/e2e-run-spec.sh
  • gitbooks/developing/e2e-testing.md

@senamakel senamakel merged commit 1b99b56 into tinyhumansai:main May 11, 2026
20 checks passed
AusAgentSmith pushed a commit to AusAgentSmith/openhuman that referenced this pull request May 23, 2026
Co-authored-by: Jwalin Shah <jshah1331@gmail.com>
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.

3 participants