chore: set log level to error in benchmarks to reduce log noise by alan-agius4 · Pull Request #26 · danielroe/beasties

alan-agius4 · 2024-10-30T09:01:32Z

Summary by CodeRabbit

Chores
- Standardized logging behavior in benchmark tests by adding a logLevel property set to 'error' in the Beasties constructor.
- Introduced a new constant, DEFAULT_BEASTIES_CONFIG, to streamline configuration across test cases.

coderabbitai · 2024-10-30T09:01:39Z

Walkthrough

The changes introduce a new constant, DEFAULT_BEASTIES_CONFIG, which is a partial configuration object of type Options. This object includes properties for reduceInlineStyles and logLevel. The constant is used in multiple instances where Beasties objects are instantiated within the benchmark tests, replacing direct assignments with a spread operator. The core functionality of the tests remains unchanged, focusing on HTML processing and stylesheet management, without modifications to control flow or error handling.

Changes

File Path	Change Summary
packages/beasties/test/beasties.bench.ts	Introduced `DEFAULT_BEASTIES_CONFIG` and replaced direct assignments with its properties in `Beasties` constructor calls.

Poem

In the land where beasties play,
A new log level joins the fray.
With errors caught in gentle nets,
Our tests will run with no regrets.
Hopping high, we cheer and say,
"Standardized logging saves the day!" 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 37af9c6 and 63e3148.

📒 Files selected for processing (1)

packages/beasties/test/beasties.bench.ts (9 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/beasties/test/beasties.bench.ts

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

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

codspeed-hq · 2024-10-30T09:03:20Z

CodSpeed Performance Report

Merging #26 will degrade performances by 21.95%

_{Comparing alan-agius4:update-log-level (63e3148) with main (d4ea1a3)}

Summary

⚡ 7 improvements
❌ 1 regressions

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

	Benchmark	`main`	`alan-agius4:update-log-level`	Change
⚡	`basic Usage`	4.8 ms	3.5 ms	+35.23%
⚡	`does not decode entities in HTML document`	1,080.9 µs	403.4 µs	×2.7
⚡	`does not encode HTML`	2.4 ms	1.1 ms	×2.3
⚡	`prevent injection via media attr`	8.1 ms	5 ms	+60.84%
❌	`run on HTML file`	7.4 ms	9.4 ms	-21.95%
⚡	`should keep existing link tag attributes`	2.6 ms	1.2 ms	×2.1
⚡	`should keep existing link tag attributes in the noscript link`	2.5 ms	1.1 ms	×2.3
⚡	`skip invalid path`	6.7 ms	4.3 ms	+57.84%

codecov-commenter · 2024-10-30T09:03:41Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.73%. Comparing base (d4ea1a3) to head (63e3148).
⚠️ Report is 288 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #26   +/-   ##
=======================================
  Coverage   83.73%   83.73%           
=======================================
  Files           7        7           
  Lines        1168     1168           
  Branches      269      269           
=======================================
  Hits          978      978           
  Misses        190      190

☔ View full report in Codecov by Sentry.
📢 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.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d4ea1a3 and 37af9c6.

📒 Files selected for processing (1)

packages/beasties/test/beasties.bench.ts (8 hunks)

🔇 Additional comments (1)

packages/beasties/test/beasties.bench.ts (1)

20-20: LGTM! Consistent application of log level configuration across all test cases.

The changes effectively reduce log noise in benchmarks by setting logLevel: 'error' consistently across all test cases. This is a good practice for benchmark tests where we want to focus on performance metrics rather than debug output.

Also applies to: 50-50, 60-60, 86-86, 111-111, 136-136, 160-160, 172-172

coderabbitai Bot reviewed Oct 30, 2024

View reviewed changes

Comment thread packages/beasties/test/beasties.bench.ts Outdated

chore: set log level to error in benchmarks to reduce log noise

63e3148

alan-agius4 force-pushed the update-log-level branch from 37af9c6 to 63e3148 Compare October 30, 2024 09:33

danielroe approved these changes Oct 31, 2024

View reviewed changes

danielroe merged commit a988fb4 into danielroe:main Oct 31, 2024

alan-agius4 deleted the update-log-level branch October 31, 2024 12:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: set log level to error in benchmarks to reduce log noise#26

chore: set log level to error in benchmarks to reduce log noise#26
danielroe merged 1 commit into
danielroe:mainfrom
alan-agius4:update-log-level

alan-agius4 commented Oct 30, 2024 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Oct 30, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codspeed-hq Bot commented Oct 30, 2024 •

edited

Loading

Uh oh!

codecov-commenter commented Oct 30, 2024 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

alan-agius4 commented Oct 30, 2024 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Oct 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codspeed-hq Bot commented Oct 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #26 will degrade performances by 21.95%

Summary

Benchmarks breakdown

Uh oh!

codecov-commenter commented Oct 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alan-agius4 commented Oct 30, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Oct 30, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codspeed-hq Bot commented Oct 30, 2024 •

edited

Loading

codecov-commenter commented Oct 30, 2024 •

edited

Loading