Skip to content
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

chore: remove unit test noise #16894

Merged
merged 1 commit into from
Feb 10, 2025
Merged

chore: remove unit test noise #16894

merged 1 commit into from
Feb 10, 2025

Conversation

tomasklim
Copy link
Member

Description

Copy link

coderabbitai bot commented Feb 7, 2025

Walkthrough

The changes modify several test suites by introducing new beforeAll blocks that adjust console output during test execution. Specifically, console.error and console.warn are mocked or overridden using jest.spyOn to suppress or filter specific error and warning messages. This approach prevents unwanted console logs while maintaining the original test logic and behavior. Additionally, one test case for a mocked Translation component is updated to change the rendered HTML element from a <div> to a <span>. No alterations were made to the public API or exported entities in any of these changes.

Suggested reviewers

  • mroz22
  • STew790

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a351550 and ec09434.

📒 Files selected for processing (3)
  • packages/request-manager/tests/interceptor-whitelist.test.ts (1 hunks)
  • packages/suite/src/components/suite/Preloader/__tests__/Preloader.test.tsx (2 hunks)
  • packages/suite/src/utils/suite/__tests__/ethereumStaking.test.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • packages/suite/src/utils/suite/tests/ethereumStaking.test.ts
  • packages/suite/src/components/suite/Preloader/tests/Preloader.test.tsx
  • packages/request-manager/tests/interceptor-whitelist.test.ts
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: build-web
  • GitHub Check: run-desktop-tests (@group=wallet, trezor-user-env-unix bitcoin-regtest)
  • GitHub Check: build-web
  • GitHub Check: run-desktop-tests (@group=other, trezor-user-env-unix)
  • GitHub Check: run-desktop-tests (@group=settings, trezor-user-env-unix bitcoin-regtest)
  • GitHub Check: run-desktop-tests (@group=device-management, trezor-user-env-unix)
  • GitHub Check: run-desktop-tests (@group=suite, trezor-user-env-unix)
  • GitHub Check: Setup and Cache Dependencies
  • GitHub Check: Analyze with CodeQL (javascript)
  • GitHub Check: test-request-manager

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

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. (Beta)
  • @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.

@tomasklim tomasklim requested a review from izmy February 7, 2025 18:18
Copy link

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cf806ff and a351550.

📒 Files selected for processing (3)
  • packages/request-manager/tests/interceptor-whitelist.test.ts (1 hunks)
  • packages/suite/src/components/suite/Preloader/__tests__/Preloader.test.tsx (2 hunks)
  • packages/suite/src/utils/suite/__tests__/ethereumStaking.test.ts (1 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
packages/request-manager/tests/interceptor-whitelist.test.ts

[error] 138-140: Disallow duplicate setup and teardown hooks.

Disallow beforeAll duplicacy inside the describe function.

(lint/suspicious/noDuplicateTestHooks)

⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: run-desktop-tests (@group=wallet, trezor-user-env-unix bitcoin-regtest)
  • GitHub Check: run-desktop-tests (@group=other, trezor-user-env-unix)
  • GitHub Check: run-desktop-tests (@group=settings, trezor-user-env-unix bitcoin-regtest)
  • GitHub Check: run-desktop-tests (@group=device-management, trezor-user-env-unix)
  • GitHub Check: run-desktop-tests (@group=suite, trezor-user-env-unix)
  • GitHub Check: test-request-manager
  • GitHub Check: build-web
  • GitHub Check: Setup and Cache Dependencies
  • GitHub Check: build-web
  • GitHub Check: Analyze with CodeQL (javascript)
🔇 Additional comments (3)
packages/suite/src/utils/suite/__tests__/ethereumStaking.test.ts (1)

157-169: LGTM!

The implementation correctly filters object error messages while preserving non-object errors and the original console.error functionality.

packages/suite/src/components/suite/Preloader/__tests__/Preloader.test.tsx (2)

12-12: LGTM!

The change from div to span in the Translation mock is a minor UI adjustment that doesn't affect test functionality.


152-168: LGTM!

The implementation correctly filters specific warning messages while preserving the original console.warn functionality.

Comment on lines 138 to 140
beforeAll(() => {
jest.spyOn(console, 'error').mockImplementation(() => {});
});
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Move beforeAll block outside the forEach loop.

The beforeAll hook is defined inside a forEach loop, which creates duplicate hooks. This violates Jest's best practices and may lead to unexpected behavior.

Apply this diff to fix the issue:

-    ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'].forEach(method => {
-        beforeAll(() => {
-            jest.spyOn(console, 'error').mockImplementation(() => {});
-        });
+    beforeAll(() => {
+        jest.spyOn(console, 'error').mockImplementation(() => {});
+    });
+
+    ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'].forEach(method => {
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
beforeAll(() => {
jest.spyOn(console, 'error').mockImplementation(() => {});
});
beforeAll(() => {
jest.spyOn(console, 'error').mockImplementation(() => {});
});
['GET', 'POST', 'PUT', 'DELETE', 'PATCH'].forEach(method => {
// ... existing test code for each method
});
🧰 Tools
🪛 Biome (1.9.4)

[error] 138-140: Disallow duplicate setup and teardown hooks.

Disallow beforeAll duplicacy inside the describe function.

(lint/suspicious/noDuplicateTestHooks)

@tomasklim tomasklim added the no-project This label is used to specify that PR doesn't need to be added to a project label Feb 7, 2025
@tomasklim tomasklim force-pushed the chore/unit-test-noise branch from a351550 to ec09434 Compare February 7, 2025 18:22
@tomasklim tomasklim merged commit f208780 into develop Feb 10, 2025
31 checks passed
@tomasklim tomasklim deleted the chore/unit-test-noise branch February 10, 2025 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-project This label is used to specify that PR doesn't need to be added to a project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants