lavanet / lava

Apache License 2.0
404 stars 207 forks source link

feat: CNS-1010 - Raw QoS excellence #1625

Closed oren-lava closed 1 month ago

oren-lava commented 1 month ago

Description

Closes: #XXXX

In this PR I've added another method of calculating QoS excellence that will generate a report that will replace the current QoS excellence report sent to the node upon relay payment. The "new" report, called raw QoS excellence, doesn't influence anything else - it only replaces the data sent to the node


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates significantly enhance the handling of Quality of Service (QoS) reports across the system. By integrating raw data alongside processed reports, these changes improve the accuracy and granularity of provider performance evaluations. New parameters and fields facilitate a more nuanced approach to session management and reputational updates, ultimately refining the evaluation processes essential for maintaining service quality.

Changes

Files Change Summary
protocol/lavasession/.../consumer_session_manager.go
protocol/lavasession/.../consumer_types.go
Improved QoS report handling by modifying method signatures to return both processed and raw reports. Added fields for enhanced tracking of provider performance metrics.
protocol/provideroptimizer/.../provider_optimizer.go
protocol/provideroptimizer/.../provider_optimizer_test.go
Expanded ProviderData structure with raw score fields and adjusted methods to return both processed and raw scores, enhancing performance evaluations and test coverage.
utils/score/decay_score.go Updated score calculation methods to return both normalized and raw score instances, enhancing score management accuracy and facilitating clear distinctions between score types.

Sequence Diagram(s)

sequenceDiagram
    participant C as ConsumerSessionManager
    participant P as ProviderOptimizer
    participant S as SingleConsumerSession
    participant R as RequestBuilder

    C->>P: Request QoS Reports
    P->>C: Return (QoSReport, RawQoSReport)
    C->>S: SetUsageForSession(QoSReport, RawQoSReport)
    S->>R: ConstructRelaySession(RawQoSReport)
    R->>C: Return RelaySession

Poem

πŸ‡ In the meadow, changes bloom,
With data bright, we clear the gloom!
QoS now dances, metrics in sight,
For providers and sessions, all feels right!
Hop, hop, hooray for the updates dear,
A new dawn breaks, let’s give a cheer! 🌼


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 1 month ago

Test Results

2β€ˆ163 tests  Β±0   2β€ˆ163 :white_check_mark: Β±0   25m 19s :stopwatch: +18s β€‡β€ˆ143 suites Β±0β€‚β€ƒβ€ƒβ€‡β€ˆβ€‡β€‡0 :zzz: Β±0  β€‡β€ˆβ€‡β€‡7 files   Β±0β€‚β€ƒβ€ƒβ€‡β€ˆβ€‡β€‡0 :x: Β±0 

Results for commit ef91148c. ± Comparison against base commit b9a44c6a.

:recycle: This comment has been updated with latest results.