Set allowed and cache methods as non nullable

travis-reed commented 2 months ago

what

Set allowed_methods and cached_methods as non nullable

Setting nullable to false ensures that the variable value will never be null within the module. If nullable is false and the variable has a default value, then Terraform uses the default when a module input argument is null.

why

I want to be able to sometimes call this module with explicit allowed_methods and cached_methods and sometimes just use the module defaults.

As it stands, I cannot do that without making my default value match your default value. It would be better for the module to use its defaults when I pass in null

Right now I am hitting

Error: Missing required argument

  with module.fanx.module.sdp_assets.module.static_cdn.aws_cloudfront_distribution.default[0],
  on /tmp/terraform-data-dir/modules/fanx.sdp_assets.static_cdn/main.tf line 522, in resource "aws_cloudfront_distribution" "default":
 522:     allowed_methods            = var.allowed_methods

The argument "default_cache_behavior.0.allowed_methods" is required, but no
definition was found.

Which I can work around by setting a default on my side, but it isn't ideal behavior

references

Additional Notes

I wouldn't consider this a breaking change. Today, the behavior if you pass in null as the argument to the module you will get a failure as shown above. This makes passing in null possible without negatively impacting existing users.

Summary by CodeRabbit

Bug Fixes
- Enhanced validation for allowed_methods and cached_methods by ensuring they cannot be set to null, improving overall data integrity.

Gowiem commented 2 months ago

Huh this is interesting @travis-reed -- the first use-case of 'nullable' I've seen. Thanks for providing the explanation!

What version of TF was this introduced? We may need to update our pinning of TF for this module to support this usage depending on when it was added to the language.

Gowiem commented 2 months ago

/terratest

travis-reed commented 2 months ago

Huh this is interesting @travis-reed -- the first use-case of 'nullable' I've seen. Thanks for providing the explanation!

What version of TF was this introduced? We may need to update our pinning of TF for this module to support this usage depending on when it was added to the language.

Thanks for taking a look @Gowiem,

This feature was introduced in terraform 1.1

It looks like this module is requiring >= terraform 1.3 so I would expect this to work without upgrading the required version on the module

travis-reed commented 2 months ago

I see that the bats action failed, but it seems like that may be failing on older merged prs too.

osterman commented 4 weeks ago

@coderabbit full review

coderabbitai[bot] commented 4 weeks ago

:white_check_mark: Actions performed

Full review triggered.

coderabbitai[bot] commented 4 weeks ago

📝 Walkthrough

## Walkthrough The changes involve updates to the `variables.tf` file, specifically adding the `nullable` attribute to the variable declarations for `allowed_methods` and `cached_methods`. Both variables are now set to `nullable = false`, ensuring they cannot be null. This modification enhances the validation of these variables while keeping the rest of the declarations unchanged. ## Changes | File | Change Summary | |------------------|-------------------------------------------------------------------------------| | variables.tf | Updated `allowed_methods` and `cached_methods` to include `nullable = false` | ## Poem > In the land of code where bunnies hop, > Variables now can't take a drop. > `Allowed_methods` and `cached` stand tall, > With `nullable = false`, they won't fall! > Hooray for the changes, let's give a cheer, > For values that matter, we hold dear! 🐰✨

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: ASSERTIVE**

📥 Commits

Reviewing files that changed from the base of the PR and between 86d0a7e3cc1bd445e9fe201d54f4b8fc85fe17dc and 464c680a83052ace091348e006e8b1c07ac7b883.

📒 Files selected for processing (1)

* `variables.tf` (1 hunks)

🔇 Additional comments (2)

variables.tf (2)

`217-220`: **LGTM! Setting allowed_methods as non-nullable with default value is safe.** The change ensures that the variable will never be null while maintaining backward compatibility through the default value. --- `224-227`: **LGTM! Setting cached_methods as non-nullable maintains consistency with allowed_methods.** The change is safe as it has a sensible default value. Note that `cached_methods` must be a subset of `allowed_methods`, and the default values maintain this relationship (["GET", "HEAD"] is a subset of ["DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"]).

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

osterman commented 4 weeks ago

@travis-reed the bats error is:

Cloud Posse requires all providers to use registry format introduced in Terraform 0.13, for example
    aws = {
       source  = "hashicorp/aws"
       version = ">= 3.0"
    }

Please add constraints for these providers:
  - local

osterman commented 4 weeks ago

@CodeRabbit full review

coderabbitai[bot] commented 4 weeks ago

@CodeRabbit full review

:white_check_mark: Actions performed

Full review triggered.

travis-reed commented 4 weeks ago

/terratest

cloudposse / terraform-aws-cloudfront-s3-cdn