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

feature: show RPC error message in terminal instead of failing #1967

Merged
merged 1 commit into from
Jul 11, 2024

Conversation

rustatian
Copy link
Member

@rustatian rustatian commented Jul 10, 2024

Reason for This PR

ref: #1952

Description of Changes

  • Instead of failing, show an error message per-plugin in the workers table. This will not affect information which other plugins can show.

License Acceptance

By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

PR Checklist

[Author TODO: Meet these criteria.]
[Reviewer TODO: Verify that these criteria are met. Request changes if not]

  • All commits in this PR are signed (git commit -s).
  • The reason for this PR is clearly provided (issue no. or explanation).
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • Any user-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling in worker and job processing, ensuring that errors are now printed and handled more gracefully.
  • Improvements

    • Updated sorting of worker and job data for better organization and readability.
    • Enhanced table rendering for workers and jobs, including error handling, to provide more reliable output.

Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
@rustatian rustatian added the C-enhancement Category: enhancement. Meaning improvements of current module, transport, etc.. label Jul 10, 2024
@rustatian rustatian requested a review from wolfy-j July 10, 2024 18:28
@rustatian rustatian self-assigned this Jul 10, 2024
Copy link
Contributor

coderabbitai bot commented Jul 10, 2024

Walkthrough

This update primarily involves modifying import paths and altering functions to handle errors locally within the internal/cli/workers package. Specifically, the changes ensure that errors are printed directly rather than returned, simplifying error management. Additionally, the update includes sorting logic for worker and job data in table rendering functions.

Changes

File Change Summary
internal/cli/workers/command.go Updated import path from v1 to v4 for jobs package; modified showWorkers function to handle errors locally.
internal/cli/workers/render.go Updated import paths; added error parameter to WorkerTable and JobsTable; included error handling and sorting logic.

Poem

In the code where workers dwell,
Paths were changed, all is well.
Errors now, they’re locally caught,
Simpler flow, as we’d sought.
Jobs and workers sorted fine,
Bunny cheers, it’s all aligned! 🐇✨


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>.
    • 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 Configration 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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d80c68c and abaa6ab.

Files selected for processing (2)
  • internal/cli/workers/command.go (7 hunks)
  • internal/cli/workers/render.go (5 hunks)
Additional comments not posted (6)
internal/cli/workers/command.go (3)

11-11: Verify the compatibility of the new jobs package version.

Ensure that the new version of the jobs package (v4) is compatible with the existing codebase and does not introduce breaking changes.


54-55: LGTM! The function call changes are approved.

The changes to handle errors internally within the showWorkers function improve robustness.


Line range hint 92-141: LGTM! The function changes are approved.

The changes to handle errors internally and render error messages improve error handling and ensure that error messages do not affect the information displayed by other plugins.

internal/cli/workers/render.go (3)

12-12: Verify the compatibility of the new jobs package version.

Ensure that the new version of the jobs package (v4) is compatible with the existing codebase and does not introduce breaking changes.


Line range hint 22-43: LGTM! The function changes are approved.

The changes to handle errors during table rendering in the WorkerTable function improve user feedback by displaying error messages in the table.


Line range hint 91-115: LGTM! The function changes are approved.

The changes to handle errors during table rendering in the JobsTable function improve user feedback by displaying error messages in the table.

@rustatian rustatian merged commit 60761af into master Jul 11, 2024
12 checks passed
@rustatian rustatian deleted the fix/do-not-fail-on-rpc-error branch July 11, 2024 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: enhancement. Meaning improvements of current module, transport, etc..
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant