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

[Vendor] Print error message when an error occurs during installation of the last vendored component #936

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ohaibbq
Copy link

@ohaibbq ohaibbq commented Jan 14, 2025

what

Adds an error message to the output of atmos vendor pull for the last component in a vendor manifest

references

closes #935

Summary by CodeRabbit

  • Bug Fixes
    • Improved package installation error reporting by displaying more detailed error messages during the installation process.

@ohaibbq ohaibbq requested a review from a team as a code owner January 14, 2025 04:43
@mergify mergify bot added the triage Needs triage label Jan 14, 2025
Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the Update method in the internal/exec/vendor_model.go file to improve error reporting during package installation. The key change involves adding error messages to the console output when a package fails to install, providing more detailed feedback to users about installation issues.

Changes

File Change Summary
internal/exec/vendor_model.go Enhanced error reporting by including error messages in console output during package installation process

Assessment against linked issues

Objective Addressed Explanation
Print error message during component installation [#935]

Suggested Labels

patch

The changes directly address the issue raised in #935 by ensuring that error messages are now printed when a package installation fails, giving users more visibility into what went wrong during the vendor pull process.

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 or @auto-summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

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

🧹 Nitpick comments (1)
internal/exec/vendor_model.go (1)

165-167: LGTM! Consider standardizing error message format.

The change effectively adds error message output for the last component, addressing the PR objective. The implementation maintains consistency with the existing error handling pattern.

For better consistency across all error messages, consider extracting the error message format into a constant:

+const vendorErrorFormat = "Failed to vendor %s: error : %s"

 // Earlier in the code where error message is formatted
-errMsg = fmt.Sprintf("Failed to vendor %s: error : %s", pkg.name, msg.err)
+errMsg = fmt.Sprintf(vendorErrorFormat, pkg.name, msg.err)

This would ensure uniform error messaging throughout the codebase and make future message format updates easier to maintain.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4799f28 and d403aa9.

📒 Files selected for processing (1)
  • internal/exec/vendor_model.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Summary

@mergify mergify bot removed the triage Needs triage label Jan 14, 2025
Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the Update method in the modelVendor struct to improve error message reporting during package installation. The change enhances the output by conditionally including error messages when packages fail to install, providing more detailed feedback to users about installation issues, particularly when the last component encounters a problem.

Changes

File Change Summary
internal/exec/vendor_model.go Updated error message printing logic in Update method to include error details when package installation fails

Assessment against linked issues

Objective Addressed Explanation
Print error message for failed component installation [#935]

Suggested Labels

minor

The changes directly address the issue by modifying the output to include error messages during package installation, which was the primary concern in the linked issue #935. The modification ensures that users receive more informative feedback when a component fails to vendor, particularly in scenarios involving OCI registry interactions.

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 or @auto-summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

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

🧹 Nitpick comments (1)
internal/exec/vendor_model.go (1)

165-167: LGTM! The error message handling looks solid.

The change effectively addresses the issue by displaying error messages when the last package fails to install. This improves visibility and helps users identify installation problems more easily.

Consider adding some visual separation between the package status and error message for better readability. Here's a suggested enhancement:

-				tea.Printf("%s %s %s %s", mark, pkg.name, version, errMsg),
+				tea.Printf("%s %s %s%s", mark, pkg.name, version, errMsg != "" ? " | " + errMsg : ""),
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4799f28 and d403aa9.

📒 Files selected for processing (1)
  • internal/exec/vendor_model.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Summary

@osterman
Copy link
Member

Thanks, looks helpful!

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.

vendor pull does not print error message when an error occurs while installing the last component
2 participants