Skip to content

test: fix debug mode failing tests #4769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

test: fix debug mode failing tests #4769

wants to merge 1 commit into from

Conversation

straker
Copy link
Contributor

@straker straker commented May 8, 2025

Trying to debug Firefox nightly test failures and I kept running into a problem with debug mode freezing or having tests fail. I'm still working on fixing all the issues, but here's what I've found so far:

  • the #mocha div element would break a lot of our tests that looked at element selectors (especially empty-heading) since it would add non-unique elements to our tests (e.g. other h1s). This caused one of the tests to freeze and even crash the page as it would try to compare the result object and tried to output the entire contents of the DOM which would exceed the max string length
  • the #mocha div element would break our grid stack, rect, and target size tests as it would add elements to the stack our tests weren't expecting
  • tests that scrolled the page and didn't reset scroll position would break color contrast and grid tests when the fixture would end up in a negative position
  • the size of the #mocha div would cause some our tests that used very large heights to move things off the page to fail when the entire test suite was run (but not individually) since the result list would end up being larger than the large height used in the test
  • all tests that override computedStyle cause the code to freeze (not sure why yet, still investigating)
  • setting axe._memoizedFns length to 0 meant our teardown code didn't reset memoized results, causing test failures across test directories (utils -> commons). Our normal test setup runs all directories in isolation

There are some other random test failures in run and run-rules that I'm also still investigating.

My fixes include:

  • moving the #mocha div to a closed shadow DOM in order to remove it from the root DOM and hiding it from our selector generation (this still allows us to use the HTML ui and get all the nice output in the browser)
  • hiding the shadow DOM element from the grid so it's not included in element stacks and contexts
  • fixing the height of the shadow DOM element so the max screen size isn't affected by the test output
  • fixed the memoized length override

Copy link

coderabbitai bot commented May 8, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@straker straker changed the title tests: fix debug mode failing tests test: fix debug mode failing tests May 8, 2025
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