Skip to content

docs: add Cypress E2E testing guidelines to README and implementer agents - #4121

Draft
priyanshu6238 wants to merge 6 commits into
masterfrom
update/readme_for_frontend
Draft

priyanshu6238 wants to merge 6 commits into
masterfrom
update/readme_for_frontend

Conversation

@priyanshu6238

@priyanshu6238 priyanshu6238 commented Aug 6, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Cypress E2E tests have moved from the separate glific-cypress repo into this repo's cypress/ directory — this PR documents that move and the workflow going forward.
  • Added an "End-to-End (Cypress) Testing" section to README.md covering pre-requisites, running tests (yarn cy:open / yarn cy:run), lint/format scripts, CI workflows, and where to add/update specs.
  • Updated ui-implementer and ui-consistency-reviewer agents so new UI features get a corresponding Cypress spec under cypress/e2e/, and existing spec fixes/updates happen here rather than in a now-defunct separate repo.

Summary by CodeRabbit

  • Documentation

    • Added Cypress end-to-end testing guidance, including setup, configuration, commands, linting, formatting, and spec conventions.
    • Updated the README table of contents and formatting for improved clarity.
  • Chores

    • Added guidance for coordinating UI implementation with Cypress test coverage.
    • Added instructions for creating and maintaining Cypress end-to-end tests, including validation and reporting requirements.

@coderabbitai

coderabbitai Bot commented Aug 6, 2026 •

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The changes add a dedicated Cypress test-writer agent, define Cypress handoff rules for the UI implementer, and document Cypress setup and usage in the README. The README also receives navigation, formatting, and spacing updates.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Poem

A rabbit reviews the Cypress trail,
With tidy specs and checks that prevail.
UI hands flows to tests in sight,
README guides each command right.
Hop, hop—coverage takes flight!

🚥 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 clearly summarizes the main changes to the README and agent documentation for Cypress E2E testing.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update/readme_for_frontend

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.

@priyanshu6238 priyanshu6238 changed the title docs: update README and agent files to include Cypress E2E testing gu… docs: document Cypress E2E testing now living in the frontend repo Aug 6, 2026
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

@github-actions
github-actions Bot temporarily deployed to pull request August 6, 2026 09:38 Inactive

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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 @.claude/agents/ui-implementer.md:
- Around line 108-111: Update the Cypress execution guidance in the agent
instructions so E2E specs are marked pending only when the Elixir backend is
unavailable. Allow the implementer to run yarn cy:open or yarn cy:run when the
backend is running; otherwise, require documenting that execution remains
pending for the e2e-test-engineer agent or a local run.

In `@README.md`:
- Around line 155-156: Update the README’s Glific backend URL to match Cypress’s
configured backendUrl, documenting https://api.glific.test:4001/api instead of
the outdated host and path. If the README URL is intentionally authoritative,
change the Cypress backendUrl configuration instead and keep both references
consistent.
🪄 Autofix

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: CHILL

Plan: Pro Plus

Run ID: c0133475-b91b-4fe8-b9d6-61188c199144

📥 Commits

Reviewing files that changed from the base of the PR and between 416d3a9 and ed75477.

📒 Files selected for processing (3)
  • .claude/agents/ui-consistency-reviewer.md
  • .claude/agents/ui-implementer.md
  • README.md

Comment thread .claude/agents/ui-implementer.md Outdated
Comment thread README.md Outdated
@github-actions
github-actions Bot temporarily deployed to pull request August 6, 2026 09:43 Inactive
@cypress

cypress Bot commented Aug 6, 2026 •

Copy link
Copy Markdown

Glific    Run #13278

Run Properties:  status check passed Passed #13278  •  git commit d5c8a65b73 ℹ️: Merge 5f990b6e936ce42feb893bda28ae329b6d771cd8 into c90293f14861762a138cbd4297e5...
Project Glific
Branch Review update/readme_for_frontend
Run status status check passed Passed #13278
Run duration 11m 02s
Commit git commit d5c8a65b73 ℹ️: Merge 5f990b6e936ce42feb893bda28ae329b6d771cd8 into c90293f14861762a138cbd4297e5...
Committer Priyanshu singh
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 66
⚠️ You've recorded test results over your free plan limit.
Upgrade your plan to view test results.
View all changes introduced in this branch ↗︎

@github-actions
github-actions Bot temporarily deployed to pull request August 6, 2026 09:49 Inactive
@priyanshu6238 priyanshu6238 self-assigned this Aug 6, 2026
@priyanshu6238 priyanshu6238 changed the title docs: document Cypress E2E testing now living in the frontend repo docs: add Cypress E2E testing guidelines to README and implementer agents Aug 6, 2026
@github-actions
github-actions Bot temporarily deployed to pull request August 6, 2026 09:53 Inactive
Comment thread .claude/agents/ui-consistency-reviewer.md Outdated
Comment thread .claude/agents/ui-implementer.md Outdated
@codecov

codecov Bot commented Aug 6, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.19%. Comparing base (416d3a9) to head (5f990b6).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4121      +/-   ##
==========================================
+ Coverage   82.16%   82.19%   +0.03%     
==========================================
  Files         346      346              
  Lines       15131    15119      -12     
  Branches     3584     3582       -2     
==========================================
- Hits        12432    12427       -5     
+ Misses       1637     1634       -3     
+ Partials     1062     1058       -4     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
github-actions Bot temporarily deployed to pull request August 7, 2026 05:19 Inactive

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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 @.claude/agents/cypress-test-writer.md:
- Around line 52-58: Update the Cypress execution guidance in the agent
instructions to prevent full-suite runs: require scoping execution to the
changed spec using the appropriate Cypress spec option, while clarifying that
cy:open only runs after the user selects the spec. Preserve full-suite execution
as the responsibility of the e2e-test-engineer agent.

In @.claude/agents/ui-implementer.md:
- Around line 112-114: Expand the Cypress handoff checklist in the UI
implementer guidance to include changes to existing spec behavior and critical
paths: authentication/login, messaging/chat, flow builder, and CRUD. Preserve
the existing triggers for new pages, dialogs, and multi-step flows, and align
the checklist with the requirements in cypress-test-writer.md.
🪄 Autofix

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: CHILL

Plan: Pro Plus

Run ID: 770b6782-07c3-40a3-9761-5f274b39163c

📥 Commits

Reviewing files that changed from the base of the PR and between ed75477 and 1308e7e.

📒 Files selected for processing (3)
  • .claude/agents/cypress-test-writer.md
  • .claude/agents/ui-implementer.md
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Comment thread .claude/agents/cypress-test-writer.md
Comment thread .claude/agents/ui-implementer.md Outdated
@github-actions
github-actions Bot temporarily deployed to pull request August 7, 2026 05:31 Inactive
---

You write Cypress specs for glific-frontend. You do not implement UI and you do not run
the full e2e suite against a live backend — that's the `ui-implementer` and

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we need to restructure our agents to,

  • planner
  • implementor
  • test-engineer (for both cypress & vitest or can be separate)
  • reviewer (for overall quality and accuracy)

Can you follow this PR up and split these

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The thinking is the planner decides how to implement including when to write unit and cypress tests and we can use an expensive model like Opus to do that and the sub implementation agents can be run through sonnet which is cheaper. It also means these agents don't think but always expect a clear implementation plan to execute.

@priyanshu6238
priyanshu6238 marked this pull request as draft August 14, 2026 05:20

This branch was previously deployed

1 inactive deployment
pull request — 5f990b6e Deployed Aug 7, 2026 by github-actions[bot]
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.

2 participants