feat: Adding retry for clone errors

[yhakbar]

Description

Adds support for using the errors block to control how errors during source cloning are handled.

TODOs

Read the Gruntwork contribution guidelines.

• Update the docs.
• Run the relevant tests successfully, including pre-commit checks.
• Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable.
• Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Updated errors block to support controlling how errors during source cloning are handled.

Summary by CodeRabbit

• Documentation

  • Revised contributing guidelines by updating pre-release naming conventions and introducing a release candidate channel.
  • Added new guidance on managing errors during source fetching, complete with examples for implementing retry logic.
  • Introduced a new section on error handling for source fetching in the configuration documentation.

• Tests

  • Introduced a new configuration and test case for retry logic when handling invalid remote downloads.
  • Updated test outputs to include an additional formatting field in JSON configurations.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
terragrunt-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 25, 2025 8:52pm

[coderabbitai]

Walkthrough

This update modifies the download source routines to use a context parameter for improved cancellation and deadline management. It renames several parameters for clarity and wraps error handling in a context-aware method. Additionally, the documentation has been updated with revised pre-release naming conventions and a new section on handling errors during source fetching, complete with retry mechanism examples. Test files have also been updated with an added JSON key and a new test for invalid remote downloads using retry logic.

Changes

File(s)	Change Summary
cli/commands/run/download_source.go	Updated downloadSource function signature to accept a context.Context; renamed parameters for clarity; updated logging and error handling using RunWithErrorHandling with context.
docs-starlight/src/content/docs/03-community/01-contributing.md, docs/_docs/03_community/01-contributing.md	Revised pre-release naming conventions and dates; updated recommendations for the alpha channel and introduced an rc release candidate mechanism.
docs-starlight/src/content/docs/04-reference/01-hcl/02-blocks.mdx, docs/_docs/04_reference/04-config-blocks-and-attributes.md	Added a new "Errors during source fetching" section with an example configuration illustrating retry logic for transient network errors.
test/integration_debug_test.go, test/integration_json_test.go, test/integration_test.go	Inserted a new "hcl_fmt": nil key in the JSON configuration outputs to update the expected JSON structure.
test/integration_download_test.go, test/fixtures/download/remote-invalid-with-retries/terragrunt.hcl	Introduced a new test (TestInvalidRemoteDownloadWithRetries) and a fixture file to validate behavior when downloads fail and retry logic reaches its limit.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client (with Context)
    participant DTF as DownloadTerraformSourceIfNecessary
    participant DS as downloadSource
    participant EH as RunWithErrorHandling

    C->>DTF: Call function with ctx, src, opts, cfg
    DTF->>DS: Invoke downloadSource(ctx, src, opts, cfg)
    DS->>EH: Execute getter.GetAny with context awareness
    EH-->>DS: Return result/error
    DS-->>DTF: Propagate download status
    DTF-->>C: Return final result

Loading

Suggested reviewers

• denis256
• levkohimins

Poem

In the realm of code we tread,
A context now leads the thread.
Docs and tests join in the dance,
With retries given a fresh chance.
Here’s to clearer code—a merry advance!
🎉🚀

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 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 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]

Actionable comments posted: 0

🧹 Nitpick comments (1)

test/integration_tofu_state_encryption_test.go (1)

78-192: Consider adding test cases for hcl_fmt behavior.

While the JSON structure looks good, we might want to add test cases that verify the behavior when hcl_fmt has different values (not just nil). This would help catch any formatting-related issues early.

Here's a suggestion for an additional test case:

// Test with hcl_fmt enabled
if generateBlock, ok := generateBlocks.(map[string]interface{})["provider"].(map[string]interface{}); assert.True(t, ok) {
    assert.Equal(t, true, generateBlock["hcl_fmt"])
}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 380e201 and 5e3c80b.

📒 Files selected for processing (1)

• test/integration_tofu_state_encryption_test.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: build-and-test
• GitHub Check: unessential
• GitHub Check: Pull Request has non-contributor approval

🔇 Additional comments (2)

test/integration_tofu_state_encryption_test.go (2)

167-167: Looking good! Nice consistency update.

The addition of "hcl_fmt": nil aligns this test with similar changes in other test files. It's a small but important change for maintaining consistent JSON structure across the test suite.

---

194-220: Nice helper function! 👍

The validateStateIsEncrypted helper is well-written and thorough. It checks both the presence and format of encrypted data, making the tests more robust.