atmos icon indicating copy to clipboard operation
atmos copied to clipboard

DO NOT MERGE (needs review and testing). Break error into parts

Open haitham911 opened this issue 1 year ago β€’ 2 comments

what

This pull request introduces error handling . Key changes include adding IError interface, updating error handling to use the new IError type, and setting the log level for detailed debug information.

why

Basically break error to parts. the parts that are info to info, and those that are debug to debug

issue url

https://linear.app/cloudposse/issue/DEV-340/change-log-level-of-output-when-imports-are-not-found-to-hide-this

Summary by CodeRabbit

  • New Features

    • Enhanced logging capabilities for command execution based on CLI configuration.
    • Improved error reporting with structured messages and debug information.
  • Bug Fixes

    • Updated error handling to provide clearer insights into issues encountered during stack configuration retrieval.

haitham911 avatar Oct 12 '24 16:10 haitham911

πŸ“ Walkthrough
πŸ“ Walkthrough

Walkthrough

The changes introduce enhancements to the logging and error handling mechanisms within the application. A new import for the logger package is added in cmd/root.go, facilitating improved command execution logging. Modifications in pkg/config/utils.go update error handling to utilize a new error structure that includes debug information. Additionally, pkg/logger/logger.go introduces new variables and methods to manage debug logging, including a new IError struct that formats error messages based on the log level. A new constant for CLI configuration is also defined.

Changes

File Change Summary
cmd/root.go Added import for logger package; updated Execute function to set log level for IError.
pkg/config/utils.go Established dependency on logger; modified error handling in FindAllStackConfigsInPathsForStack and FindAllStackConfigsInPaths to use &logger.IError.
pkg/logger/logger.go Added global variable PrintDebugPart; created SetPrintDebugPart(val string) function; defined IError struct with Error() method for enhanced error reporting.
pkg/config/const.go Added constant CliConfigPrefix for CLI configurations.
pkg/utils/log_utils.go Introduced mutex for thread-safe access to PrintDebugPart; updated SetPrintDebugPart to return an error; defined ExtendedError type with modified Error method.

Poem

In the code where rabbits hop,
New logs and errors make us stop.
With debug info shining bright,
Our paths are clearer, day and night.
Hooray for changes, let’s rejoice,
In every line, we hear the voice! πŸ‡βœ¨


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.

coderabbitai[bot] avatar Oct 12 '24 16:10 coderabbitai[bot]

Also update PR description to reflect changes in the code

osterman avatar Oct 13 '24 22:10 osterman