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

Add codspeed benchmarks for Bluetooth messages #977

Merged
merged 6 commits into from
Oct 13, 2024
Merged

Add codspeed benchmarks for Bluetooth messages #977

merged 6 commits into from
Oct 13, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Oct 13, 2024

Start benchmarking with codspeed to ensure we don't regress performance

Copy link

codecov bot commented Oct 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (62683e2) to head (8f23608).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #977   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           17        17           
  Lines         2671      2671           
=========================================
  Hits          2671      2671           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

codspeed-hq bot commented Oct 13, 2024

CodSpeed Performance Report

Congrats! CodSpeed is installed 🎉

🆕 2 new benchmarks were detected.

You will start to see performance impacts in the reports once the benchmarks are run from your default branch.

Detected benchmarks

  • test_raw_ble_plain_text (23.9 µs)
  • test_raw_ble_plain_text_with_callback (38.9 µs)

@bdraco bdraco changed the title Add codspeed benchmarks Add codspeed benchmarks for Bluetooth messages Oct 13, 2024
@bdraco
Copy link
Member Author

bdraco commented Oct 13, 2024

It looks like we might be accessing the protobuf object more than expected

@bdraco bdraco marked this pull request as ready for review October 13, 2024 22:48
@bdraco bdraco merged commit 5b4ddc6 into main Oct 13, 2024
17 of 18 checks passed
@bdraco bdraco deleted the codspeed branch October 13, 2024 22:48
Copy link
Contributor

coderabbitai bot commented Oct 13, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications to the CI workflow and testing framework. A new job named benchmarks is added to the GitHub Actions configuration, which runs benchmarks using Python 3.12 and includes various setup steps. Additionally, the requirements_test.txt file is updated to include the pytest-codspeed dependency. A new test file, tests/test_bluetooth_benchmarks.py, is created to implement benchmark tests for Bluetooth Low Energy (BLE) plaintext processing, featuring two benchmark functions that utilize mock connections.

Changes

File Change Summary
.github/workflows/ci.yml Added a new job benchmarks for running benchmarks on Python 3.12 with specified steps.
requirements_test.txt Added new dependency pytest-codspeed==2.2.1.
tests/test_bluetooth_benchmarks.py Introduced benchmark tests for BLE plaintext processing with two functions: test_raw_ble_plain_text_with_callback and test_raw_ble_plain_text.

Sequence Diagram(s)

sequenceDiagram
    participant CI as CI Workflow
    participant Bench as Benchmarks Job
    participant Repo as Repository
    participant Python as Python Environment
    participant CodSpeed as CodSpeedHQ Action

    CI->>Bench: Trigger benchmarks job
    Bench->>Repo: Checkout repository
    Bench->>Python: Setup Python 3.12 with pip caching
    Bench->>Python: Install dependencies
    Bench->>CodSpeed: Run benchmarks
Loading

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.

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