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

(Node) Remove max delay logic, instead use alpha with avg #2288

Merged
merged 2 commits into from
Sep 26, 2024

Conversation

nick-bisonai
Copy link
Collaborator

Description

Instead of simply comparing RTT with absolute delay,
Use average delay and check sudden increase of delay

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.

Deployment

  • Should publish npm package
  • Should publish Docker image

@nick-bisonai nick-bisonai self-assigned this Sep 26, 2024
@nick-bisonai nick-bisonai requested a review from a team as a code owner September 26, 2024 05:00
Copy link
Contributor

coderabbitai bot commented Sep 26, 2024

Warning

Rate limit exceeded

@nick-bisonai has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 14 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 88807cb and 2d05dfd.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes introduce new configuration parameters for handling ping results in the App structure, replacing the MaxDelay with Alpha and ThresholdFactor. The AppConfig and App structures are updated accordingly. The logic for calculating the average round-trip time (RTT) is modified to use an exponential moving average based on the Alpha parameter. Additionally, the success condition for ping results is updated to incorporate the new threshold logic.

Changes

File Path Change Summary
node/pkg/checker/ping/app.go Updated AppConfig to include Alpha and ThresholdFactor; removed MaxDelay. Updated App to include RTTAvg, Alpha, and ThresholdFactor; removed MaxDelay. Added functions WithAlpha and WithThresholdFactor.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant PingHandler

    User->>App: Start Ping
    App->>PingHandler: Initialize with Alpha and ThresholdFactor
    PingHandler->>App: Send Ping Request
    App->>PingHandler: Calculate RTT using Alpha
    PingHandler-->>App: Return Ping Result
    App->>App: Check if delay > ThresholdFactor * RTTAvg
    App-->>User: Return Success/Failure
Loading

Poem

🐇 In the meadow where pings do play,
New thresholds dance in bright array.
With Alpha's grace and factors fine,
Our pinging friends will surely shine!
Hops of joy, a leap so spry,
For better pings, we all comply! 🌼


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.

Copy link
Contributor

@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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c127b90 and 88807cb.

📒 Files selected for processing (1)
  • node/pkg/checker/ping/app.go (6 hunks)

node/pkg/checker/ping/app.go Outdated Show resolved Hide resolved
node/pkg/checker/ping/app.go Outdated Show resolved Hide resolved
@nick-bisonai nick-bisonai merged commit ba891a0 into master Sep 26, 2024
1 check passed
@nick-bisonai nick-bisonai deleted the feat/update-DNS-ping-checker branch September 26, 2024 05:15
@coderabbitai coderabbitai bot mentioned this pull request Oct 3, 2024
8 tasks
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