feat(origin_groups): added support for custom group_id

[atimofeev]

what

Added support for optional group_id in origin_groups object, which can be referenced in ordered_cache block.

why

The module code does not allow setting up custom id for origin group.
Instead, the module names groups in this format:
$name-group[$id]

This is not ideal, as when specifying target_origin_id in ordered_cache config, we have to reference it by an arbitrary group id, based on its order of appearance in config, instead of actual name and purpose.

references

closes #339

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The changes introduce an optional group_id attribute to the origin_groups configuration, update its usage in examples, and alter the logic in the main module to use this value as the origin_id for CloudFront origin groups if provided. The variable type definition is updated accordingly.

Changes

File(s)	Change Summary
variables.tf	Added optional group_id string attribute to origin_groups object type definition.
main.tf	Modified origin_id assignment in origin_group block to use group_id if present and non-empty.
examples/complete/main.tf README.yaml	Updated example and documentation to include group_id in origin_groups usage.

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Allow optional attribute to specify custom group name (group_name) in origin_groups (#339)	✅
Use custom group name as CloudFront origin group origin_id if provided (#339)	✅
Update documentation and examples to show usage of custom group name (#339)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch origin-group-name
• Post Copyable Unit Tests in Comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this 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]

Actionable comments posted: 0

🧹 Nitpick comments (2)

variables.tf (2)

656-656: Add validation for group_id.
The optional group_id attribute should be validated to ensure it is non-empty, matches allowed characters for CloudFront origin IDs, and is unique across all origin groups.

---

662-669: Document the new group_id attribute.
The variable description for origin_groups does not mention the new group_id option. Update the documentation to explain its purpose and how it is used in the origin_group block.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9a65f7e and 4c60c05.

⛔ Files ignored due to path filters (1)

• README.md is excluded by !README.md

📒 Files selected for processing (4)

• README.yaml (1 hunks)
• examples/complete/main.tf (1 hunks)
• main.tf (1 hunks)
• variables.tf (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`examples/complete/*.tf`: This is framework for testing and standards are very relaxed, plus certain things need to be certain ways for testing. Exclude from review unless you find...

examples/complete/*.tf: This is framework for testing and standards are very relaxed, plus certain things need to be certain ways for testing. Exclude from review unless you find misspelling or similar error in comments or serious errors in code.

• examples/complete/main.tf

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

• GitHub Check: Summary

🔇 Additional comments (3)

main.tf (1)

492-492: Conditional origin_id fallback is correct.
The use of try(length(origin_group.value.group_id), 0) > 0 cleanly handles missing or empty group_id values and falls back to the autogenerated naming.

README.yaml (1)

134-134: Skip: Illustration only.
The addition of group_id = "groupS3" in the README example aligns with the module enhancement and requires no further action.

examples/complete/main.tf (1)

121-121: Skip: Example demonstration.
The example usage correctly demonstrates the new group_id attribute in the origin_groups block.