fix(test): wait for email HTML body in Email_settings spec

[wyattwalter]

Summary

Email_settings_Spec fails intermittently in CI (~25-35% of runs) when it shares a duration-balanced shard with heavy specs. It's a null-handling bug in the spec's email flow, exposed under maildev/SMTP contention.

Root cause

waitForEmail matches an email by subject + recipient, then hands it to the test. Under contention maildev can surface an email's metadata before its HTML part is parsed, so the matched email's .html is undefined. Tests #3–#6 then do:

const emailHtml = email.html;          // undefined
const match = emailHtml.match(/.../);  // TypeError, thrown inside .then()

That throw is an unhandled promise rejection that aborts the test (the wrapping try/catch is inert against async Cypress failures). Captured CI stack: Email_settings_Spec.ts test #4 (To verify invite workspace email); the same email.html → .match pattern is in tests #3, #5 and #6.

Fix

Fix it at the source rather than masking it. Add an opt-in requireHtml flag to waitForEmail: when set, a matched email whose HTML body isn't populated yet is treated as not yet delivered, so polling continues until the body arrives (or the existing timeout). Tests #3–#6 opt in; their email-body assertions then run for real on a complete email.

(An earlier revision of this PR used email.html || "", but that only stopped the crash by silently skipping the invite-link verification when the body was missing — masking the flake. Reverted in favor of the helper-level fix.)

waitForEmail is identical in CE and EE, so this lands in CE and the hourly sync carries it to EE. The new flag is optional and defaults to current behavior, so other callers (including this spec's test #2, which reads email.text) are unaffected.

Validation

Attribution and the fix were verified on appsmith-ee via amplified /ci-test-limit runs (multiple copies of the spec downstream of a heavy git spec in one shard): the unfixed baseline reproduced the failure at the exact line above.

Ref APP-15291

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/27509234477
Commit: 56deaca
Cypress dashboard.
Tags: @tag.Email
Spec:

---

Sun, 14 Jun 2026 19:36:07 UTC

Summary by CodeRabbit

• Tests
  • Improved email-related test robustness: four end-to-end flows (password reset, workspace invite, application invite — developer role, and application invite — view role) now explicitly require the HTML portion of delivered emails, reducing flakiness and better validating email content.
• Chores
  • Updated limited-test configuration to run the client-side email regression spec during focused CI runs.

Automation

/ok-to-test tags="@tag.Email"

[coderabbitai]

Walkthrough

Add an optional requireHtml flag to AggregateHelper.waitForEmail so matches can require a non-empty HTML body; update four Cypress tests to call waitForEmail(..., requireHtml: true) for password reset and invite flows.

Changes

Email wait/matching updates

Layer / File(s)	Summary
waitForEmail options and matching predicate app/client/cypress/support/Pages/AggregateHelper.ts	waitForEmail options now include requireHtml?: boolean; Maildev email typing includes html?: string; matching predicate adds an htmlReady guard that is required when requireHtml is true.
Tests now require HTML on email matches app/client/cypress/e2e/Regression/ClientSide/AdminSettings/Email_settings_Spec.ts	Four tests (password reset, workspace invite, application invite — developer, application invite — view) now invoke waitForEmail with requireHtml: true.
Limited tests config updated app/client/cypress/limited-tests.txt	Replaced the limited-test entry to run the client-side Email_settings_Spec.ts instead of the server-side BooleanEnum_Spec.ts.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

ok-to-test

Suggested reviewers

• sondermanish

Poem

A tiny flag that stands its post,
Waiting for HTML the tests love most,
Four waits now mindful, patient, true,
Emails with bodies come into view. ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding HTML body requirement to email waiting in the Email_settings spec.
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.
Description check	✅ Passed	PR description thoroughly documents the intermittent failure root cause, the fix rationale, and validation approach with clear technical context.

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

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch ww-fix-email-settings-html-guard

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[wyattwalter]

/ci-test-limit

[github-actions]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/27428547269.
Cypress dashboard
PR: #41893.

[github-actions]

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/27428547269.
Cypress dashboard url: Click here!
All cypress tests have passed 🎉🎉🎉