Skip to content

chore: Update benchmark websocket examplpe #248

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

Merged
merged 2 commits into from
May 28, 2025
Merged

chore: Update benchmark websocket examplpe #248

merged 2 commits into from
May 28, 2025

Conversation

chyroc
Copy link
Collaborator

@chyroc chyroc commented May 28, 2025

Summary by CodeRabbit

  • Documentation

    • Updated example code and README to use the correct asynchronous authentication class (AsyncTokenAuth) for asynchronous clients.
  • New Features

    • Added colored terminal output for specific labels in the chat benchmark example to improve readability.

@chyroc chyroc added the chore Project maintenance work not related to features and bug fixes label May 28, 2025
@CLAassistant
Copy link

CLAassistant commented May 28, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

coderabbitai bot commented May 28, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update documentation and example scripts to use AsyncTokenAuth instead of TokenAuth for asynchronous client authentication. Example code and imports are revised accordingly. Additionally, a helper function for green-colored terminal output is introduced in one example. No public APIs or core logic are altered.

Changes

File(s) Change Summary
README.md Updated async authentication usage examples to use AsyncTokenAuth instead of TokenAuth.
examples/auth_pat.py Changed async client authentication to use AsyncTokenAuth; updated import statement.
examples/benchmark_websockets_chat.py Switched to AsyncTokenAuth for async client; added green_text function for colored output.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ExampleScript
    participant AsyncCoze
    participant AsyncTokenAuth

    User->>ExampleScript: Run async example
    ExampleScript->>AsyncTokenAuth: Initialize authentication
    ExampleScript->>AsyncCoze: Create client with AsyncTokenAuth
    AsyncCoze-->>ExampleScript: Ready for async operations
    ExampleScript-->>User: Output results (with colored text if applicable)
Loading

Possibly related PRs

  • chore: Fix import error in README.md #231: Updates asynchronous authentication imports and usage from TokenAuth to AsyncTokenAuth in documentation and examples, directly related to the changes in this PR.
  • chore: Update README.md #217: Introduces broader asynchronous client usage and event handling enhancements, related by asynchronous client usage but not overlapping the specific auth class changes.

Poem

In code and docs, a change was sought,
Async auth now does what it ought!
With green text shining,
And tokens aligning,
The rabbit hops on, never overwrought.
🐇✨


📜 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 c1a6545 and a614284.

📒 Files selected for processing (3)
  • README.md (2 hunks)
  • examples/auth_pat.py (2 hunks)
  • examples/benchmark_websockets_chat.py (4 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Copy link

codecov bot commented May 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.56%. Comparing base (c1a6545) to head (a614284).
Report is 1 commits behind head on main.

@@           Coverage Diff           @@
##             main     #248   +/-   ##
=======================================
  Coverage   88.56%   88.56%           
=======================================
  Files          67       67           
  Lines        6060     6060           
=======================================
  Hits         5367     5367           
  Misses        693      693           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@chyroc chyroc merged commit 6d9d471 into main May 28, 2025
15 checks passed
@chyroc chyroc deleted the examples branch May 28, 2025 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Project maintenance work not related to features and bug fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants