Skip to content

test: Flaky should navigate on navbar toolbar pressing tab - #41135

Merged
tassoevan merged 1 commit into
developfrom
test/sidebar-nav-search
Jul 1, 2026
Merged

test: Flaky should navigate on navbar toolbar pressing tab#41135
tassoevan merged 1 commit into
developfrom
test/sidebar-nav-search

Conversation

@dougfabris

@dougfabris dougfabris commented Jul 1, 2026

Copy link
Copy Markdown
Member

Proposed changes (including videos or screenshots)

Issue(s)

Steps to test or reproduce

Further comments

FLAKY-1798

Review in cubic

Summary by CodeRabbit

  • Bug Fixes
    • Improved sidebar page loading checks for more reliable navigation.
    • Refined keyboard focus behavior coverage in the toolbar, including movement to Marketplace and search.

@dionisio-bot

dionisio-bot Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Looks like this PR is not ready to merge, because of the following issues:

  • This PR is missing the 'stat: QA assured' label

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

@changeset-bot

changeset-bot Bot commented Jul 1, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: c4374f1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

Adds a btnMarketplace locator getter to the Navbar e2e page object and updates the sidebar e2e spec to use poHomeChannel.waitForHome() instead of page.waitForSelector('main'), plus refactors the toolbar tab navigation test into sequential test.step focus assertions.

Changes

Sidebar E2E Test Updates

Layer / File(s) Summary
Navbar Marketplace locator
apps/meteor/tests/e2e/page-objects/fragments/navbar.ts
Adds a btnMarketplace getter returning the “Marketplace” button locator within pagesGroup.
Sidebar spec home-page wait and tab focus test
apps/meteor/tests/e2e/sidebar.spec.ts
Replaces page.waitForSelector('main') with poHomeChannel.waitForHome() in both the main and embedded layout beforeEach hooks, and reworks the toolbar tab navigation test into test.step blocks asserting sequential focus transitions across directory, marketplace, display, and create-new buttons, ending at the search input.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Test
  participant Page
  participant Navbar

  Test->>Page: waitForHome()
  Test->>Page: keyboard.press(Tab)
  Page->>Navbar: focus directory button
  Test->>Page: keyboard.press(Tab)
  Page->>Navbar: focus btnMarketplace
  Test->>Page: keyboard.press(Tab)
  Page->>Navbar: focus display button
  Test->>Page: keyboard.press(Tab)
  Page->>Navbar: focus create new button
  Test->>Page: keyboard.press(Tab)
  Page->>Navbar: focus search input
Loading

Suggested labels: type: chore

Suggested reviewers: juliajforesti, gabriellsh

🚥 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 matches the main change: a flaky navbar toolbar tab-navigation test update.
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.

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.

@codecov

codecov Bot commented Jul 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.12%. Comparing base (3001445) to head (c4374f1).
⚠️ Report is 4 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop   #41135      +/-   ##
===========================================
+ Coverage    69.10%   69.12%   +0.02%     
===========================================
  Files         3433     3433              
  Lines       132323   132340      +17     
  Branches     23068    23097      +29     
===========================================
+ Hits         91438    91482      +44     
+ Misses       37513    37489      -24     
+ Partials      3372     3369       -3     
Flag Coverage Δ
e2e 59.34% <ø> (-0.01%) ⬇️
e2e-api 40.39% <ø> (-0.02%) ⬇️
unit 69.98% <ø> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 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.

@dougfabris dougfabris added this to the 8.7.0 milestone Jul 1, 2026
@dougfabris
dougfabris marked this pull request as ready for review July 1, 2026 16:40
@dougfabris
dougfabris requested a review from a team as a code owner July 1, 2026 16:40

@coderabbitai coderabbitai Bot left a comment

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.

🧹 Nitpick comments (1)
apps/meteor/tests/e2e/sidebar.spec.ts (1)

65-92: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win

Assert initial focus before the Tab sequence.

Every subsequent step asserts focus after each Tab press, but the initial btnHome.focus() call at Line 66 has no corresponding assertion. If .focus() silently fails, every following step could still pass/fail for the wrong reason, undermining the goal of this fix (per commit "add an expect for each tab step").

🔧 Proposed fix
 		test('should navigate on navbar toolbar pressing tab', async ({ page }) => {
 			await poHomeChannel.navbar.btnHome.focus();
+			await expect(poHomeChannel.navbar.btnHome).toBeFocused();
 
 			await test.step('move focus to directory button', async () => {
🤖 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 `@apps/meteor/tests/e2e/sidebar.spec.ts` around lines 65 - 92, The
tab-navigation test in sidebar.spec.ts should also verify the starting focus set
by poHomeChannel.navbar.btnHome.focus() before any Tab presses. Add an assertion
immediately after the initial focus call to confirm btnHome is actually focused,
so the rest of the sequence in test('should navigate on navbar toolbar pressing
tab') only runs from a known state. Use the existing btnHome and toBeFocused
symbols to keep the check aligned with the other focus assertions.
🤖 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 `@apps/meteor/tests/e2e/sidebar.spec.ts`:
- Around line 65-92: The tab-navigation test in sidebar.spec.ts should also
verify the starting focus set by poHomeChannel.navbar.btnHome.focus() before any
Tab presses. Add an assertion immediately after the initial focus call to
confirm btnHome is actually focused, so the rest of the sequence in test('should
navigate on navbar toolbar pressing tab') only runs from a known state. Use the
existing btnHome and toBeFocused symbols to keep the check aligned with the
other focus assertions.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cb872745-7ae4-4ef1-bdb6-9a6d64c152d5

📥 Commits

Reviewing files that changed from the base of the PR and between 70c0ff0 and c4374f1.

📒 Files selected for processing (2)
  • apps/meteor/tests/e2e/page-objects/fragments/navbar.ts
  • apps/meteor/tests/e2e/sidebar.spec.ts
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: cubic · AI code reviewer
  • GitHub Check: Hacktron Security Check
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{ts,tsx,js}

📄 CodeRabbit inference engine (.cursor/rules/playwright.mdc)

**/*.{ts,tsx,js}: Write concise, technical TypeScript/JavaScript with accurate typing in Playwright tests
Avoid code comments in the implementation

Files:

  • apps/meteor/tests/e2e/sidebar.spec.ts
  • apps/meteor/tests/e2e/page-objects/fragments/navbar.ts
**/*.spec.ts

📄 CodeRabbit inference engine (.cursor/rules/playwright.mdc)

**/*.spec.ts: Use descriptive test names that clearly communicate expected behavior in Playwright tests
Use .spec.ts extension for test files (e.g., login.spec.ts)

Files:

  • apps/meteor/tests/e2e/sidebar.spec.ts
apps/meteor/tests/e2e/**/*.spec.ts

📄 CodeRabbit inference engine (.cursor/rules/playwright.mdc)

apps/meteor/tests/e2e/**/*.spec.ts: All test files must be created in apps/meteor/tests/e2e/ directory
Avoid using page.locator() in Playwright tests - always prefer semantic locators such as page.getByRole(), page.getByLabel(), page.getByText(), or page.getByTitle()
Use test.beforeAll() and test.afterAll() for setup/teardown in Playwright tests
Use test.step() for complex test scenarios to improve organization in Playwright tests
Group related tests in the same file
Utilize Playwright fixtures (test, page, expect) for consistency in test files
Prefer web-first assertions (toBeVisible, toHaveText, etc.) in Playwright tests
Use expect matchers for assertions (toEqual, toContain, toBeTruthy, toHaveLength, etc.) instead of assert statements in Playwright tests
Use page.waitFor() with specific conditions instead of hardcoded timeouts in Playwright tests
Implement proper wait strategies for dynamic content in Playwright tests
Maintain test isolation between test cases in Playwright tests
Ensure clean state for each test execution in Playwright tests
Ensure tests run reliably in parallel without shared state conflicts

Files:

  • apps/meteor/tests/e2e/sidebar.spec.ts
apps/meteor/tests/e2e/**/*.{ts,spec.ts}

📄 CodeRabbit inference engine (.cursor/rules/playwright.mdc)

apps/meteor/tests/e2e/**/*.{ts,spec.ts}: Store commonly used locators in variables/constants for reuse
Follow Page Object Model pattern consistently in Playwright tests

Files:

  • apps/meteor/tests/e2e/sidebar.spec.ts
  • apps/meteor/tests/e2e/page-objects/fragments/navbar.ts
apps/meteor/tests/e2e/page-objects/**/*.ts

📄 CodeRabbit inference engine (.cursor/rules/playwright.mdc)

Utilize existing page objects pattern from apps/meteor/tests/e2e/page-objects/

Files:

  • apps/meteor/tests/e2e/page-objects/fragments/navbar.ts
🧠 Learnings (7)
📚 Learning: 2026-02-24T19:22:48.358Z
Learnt from: juliajforesti
Repo: RocketChat/Rocket.Chat PR: 38493
File: apps/meteor/tests/e2e/omnichannel/omnichannel-send-pdf-transcript.spec.ts:66-67
Timestamp: 2026-02-24T19:22:48.358Z
Learning: In Playwright end-to-end tests (e.g., under apps/meteor/tests/e2e/...), prefer locating elements by translated text (getByText) and ARIA roles (getByRole) over data-qa attributes. If translation values change, update the corresponding test locators accordingly. Never use data-qa locators. This guideline applies to all Playwright e2e test specs in the repository and helps keep tests robust to UI text changes and accessible semantics.

Applied to files:

  • apps/meteor/tests/e2e/sidebar.spec.ts
📚 Learning: 2026-02-24T19:39:42.247Z
Learnt from: juliajforesti
Repo: RocketChat/Rocket.Chat PR: 38493
File: apps/meteor/tests/e2e/page-objects/fragments/message.ts:7-7
Timestamp: 2026-02-24T19:39:42.247Z
Learning: In RocketChat e2e tests, avoid using data-qa attributes to locate elements. Prefer semantic locators such as getByRole, getByLabel, getByText, getByTitle and ARIA-based selectors. Apply this rule to all TypeScript files under apps/meteor/tests/e2e to improve test reliability, accessibility, and maintainability.

Applied to files:

  • apps/meteor/tests/e2e/sidebar.spec.ts
  • apps/meteor/tests/e2e/page-objects/fragments/navbar.ts
📚 Learning: 2026-02-26T19:25:44.063Z
Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 38778
File: packages/ui-voip/src/providers/useMediaSession.ts:192-192
Timestamp: 2026-02-26T19:25:44.063Z
Learning: In the Rocket.Chat repository, do not reference Biome lint rules in code review feedback. Biome is not used even if biome.json exists; only reference Biome rules if there is explicit, project-wide usage documented. For TypeScript files, review lint implications without Biome guidance unless the project enables Biome rules.

Applied to files:

  • apps/meteor/tests/e2e/sidebar.spec.ts
  • apps/meteor/tests/e2e/page-objects/fragments/navbar.ts
📚 Learning: 2026-02-26T19:25:44.063Z
Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 38778
File: packages/ui-voip/src/providers/useMediaSession.ts:192-192
Timestamp: 2026-02-26T19:25:44.063Z
Learning: In this repository (RocketChat/Rocket.Chat), Biome lint rules are not used even if a biome.json exists. When reviewing TypeScript files (e.g., packages/ui-voip/src/providers/useMediaSession.ts), ensure lint suggestions do not reference Biome-specific rules. Rely on general ESLint/TypeScript lint rules and project conventions instead.

Applied to files:

  • apps/meteor/tests/e2e/sidebar.spec.ts
  • apps/meteor/tests/e2e/page-objects/fragments/navbar.ts
📚 Learning: 2026-03-06T18:10:15.268Z
Learnt from: tassoevan
Repo: RocketChat/Rocket.Chat PR: 39397
File: packages/gazzodown/src/code/CodeBlock.spec.tsx:47-68
Timestamp: 2026-03-06T18:10:15.268Z
Learning: In tests (especially those using testing-library/dom/jsdom) for Rocket.Chat components, the HTML <code> element has an implicit ARIA role of 'code'. Therefore, screen.getByRole('code') or screen.findByRole('code') will locate <code> elements even without a role attribute. Do not flag findByRole('code') as invalid in reviews; prefer using the implicit role instead of adding role="code" unless necessary for accessibility.

Applied to files:

  • apps/meteor/tests/e2e/sidebar.spec.ts
📚 Learning: 2026-05-06T12:21:44.083Z
Learnt from: juliajforesti
Repo: RocketChat/Rocket.Chat PR: 40256
File: apps/meteor/client/components/CreateDiscussion/CreateDiscussion.tsx:121-149
Timestamp: 2026-05-06T12:21:44.083Z
Learning: Field wrappers in rocket.chat/fuselage-forms (Field, FieldLabel, FieldRow, FieldError, FieldHint) auto-create htmlFor/id associations, aria-describedby, and role="alert" for errors. Do not manually set htmlFor, id, aria-describedby, or role attributes when using these wrappers. This automatic wiring does not apply to plain rocket.chat/fuselage components, which require explicit ID wiring per the accessibility docs. In code reviews, prefer using fuselage-forms wrappers for form fields and verify there is no unnecessary manual ID/aria wiring in files that use these wrappers. If a component uses plain fuselage components, ensure proper id wiring as per docs.

Applied to files:

  • apps/meteor/tests/e2e/sidebar.spec.ts
  • apps/meteor/tests/e2e/page-objects/fragments/navbar.ts
📚 Learning: 2025-12-16T17:29:40.430Z
Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 37834
File: apps/meteor/tests/e2e/page-objects/fragments/admin-flextab-emoji.ts:12-22
Timestamp: 2025-12-16T17:29:40.430Z
Learning: In all page-object files under apps/meteor/tests/e2e/page-objects/, import expect from ../../utils/test (Playwright's async expect) instead of from Jest. Jest's expect is synchronous and incompatible with web-first assertions like toBeVisible, which can cause TypeScript errors.

Applied to files:

  • apps/meteor/tests/e2e/page-objects/fragments/navbar.ts
🔇 Additional comments (2)
apps/meteor/tests/e2e/page-objects/fragments/navbar.ts (1)

65-68: LGTM!

apps/meteor/tests/e2e/sidebar.spec.ts (1)

24-24: LGTM!

Also applies to: 173-173

@cubic-dev-ai cubic-dev-ai Bot left a comment

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.

No issues found across 2 files

Re-trigger cubic

@tassoevan
tassoevan added this pull request to the merge queue Jul 1, 2026
Merged via the queue into develop with commit 761314d Jul 1, 2026
82 of 85 checks passed
@tassoevan
tassoevan deleted the test/sidebar-nav-search branch July 1, 2026 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants