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

Client enables logging non-typical error responses from the server #8538

Merged
merged 4 commits into from
Oct 14, 2024

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Oct 14, 2024

Motivation and context

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • Bug Fixes
    • Improved error logging by selectively logging ServerError based on specific error codes, reducing unnecessary log entries.

Copy link
Contributor

coderabbitai bot commented Oct 14, 2024

Walkthrough

The changes involve a modification to the shouldLog function in the notifications-reducer.ts file. The function's logic for logging ServerError instances has been enhanced to check against a predefined list of ignored error codes (0, 400, 401, 403, 404, 405, 500). If an error code is found in this list, it will not be logged. The handling of RequestError remains unchanged, continuing to return false for instances of that type.

Changes

File Change Summary
cvat-ui/src/reducers/notifications-reducer.ts Modified shouldLog function to include a check against a list of ignored error codes for ServerError.

Poem

In the code where errors dwell,
A rabbit hops to cast a spell.
With codes ignored, the logs are neat,
A cleaner path for errors' beat.
Hooray for changes, bright and spry,
Let’s log the right ones, oh me, oh my! 🐇✨


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: 0

🧹 Outside diff range and nitpick comments (2)
cvat-ui/src/reducers/notifications-reducer.ts (2)

33-40: LGTM! Consider extracting the ignored codes list.

The changes to the shouldLog function look good and align with the PR objective. The implementation correctly filters out common HTTP status codes while allowing logging for non-typical error responses.

Consider extracting the list of ignored codes into a constant at the top of the file for better maintainability:

const IGNORED_ERROR_CODES = [0, 400, 401, 403, 404, 405, 500];

// Then in the shouldLog function:
return !IGNORED_ERROR_CODES.includes(error.code);

This makes it easier to modify the list in the future if needed.


33-40: Impact analysis: Changes align with PR objective

The modifications to the shouldLog function will result in more selective logging of ServerError instances throughout the reducer. This aligns well with the PR objective of enabling logging for non-typical error responses.

To further improve error handling:

  1. Consider adding a logging service that can provide more detailed error information for debugging purposes.
  2. Implement a mechanism to easily configure which error codes should be ignored or logged, possibly through environment variables or a configuration file.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f49c1c6 and 17295b5.

📒 Files selected for processing (1)
  • cvat-ui/src/reducers/notifications-reducer.ts (1 hunks)
🧰 Additional context used

Copy link

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.21%. Comparing base (12dac6d) to head (2478bb1).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8538      +/-   ##
===========================================
- Coverage    74.24%   74.21%   -0.04%     
===========================================
  Files          400      400              
  Lines        43207    43210       +3     
  Branches      3905     3906       +1     
===========================================
- Hits         32081    32067      -14     
- Misses       11126    11143      +17     
Components Coverage Δ
cvat-ui 78.60% <100.00%> (-0.09%) ⬇️
cvat-server 70.47% <ø> (ø)

@bsekachev bsekachev merged commit f8fe849 into develop Oct 14, 2024
34 checks passed
@bsekachev bsekachev deleted the bs/extra_logging branch October 24, 2024 05:15
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.

2 participants