Set allowed and cache methods as non nullable #324

travis-reed · 2024-09-25T21:55:39Z

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.

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.

Gowiem · 2024-09-26T01:54:09Z

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 · 2024-09-26T01:54:34Z

/terratest

travis-reed · 2024-09-26T04:27:58Z

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 · 2024-09-26T04:30:29Z

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

osterman · 2024-11-01T15:58:00Z

@CodeRabbit full review

coderabbitai · 2024-11-01T15:58:06Z

✅ Actions performed

Full review triggered.

coderabbitai · 2024-11-01T15:58:09Z

📝 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`

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 464c680 and 50fef7c.

📒 Files selected for processing (1)

variables.tf (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

variables.tf

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 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.

osterman · 2024-11-01T16:00:36Z

@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 · 2024-11-01T16:00:52Z

@CodeRabbit full review

coderabbitai · 2024-11-01T16:01:01Z

@CodeRabbit full review

✅ Actions performed

Full review triggered.

travis-reed · 2024-11-01T19:09:07Z

/terratest

RoseSecurity · 2025-02-24T19:05:03Z

/terratest

RoseSecurity

This looks good to me and all tests are passing. Thanks!

github-actions · 2025-02-24T20:00:56Z

These changes were released in v0.96.2.

Set allowed and cache methods as non nullable

86d0a7e

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.

travis-reed requested review from a team as code owners September 25, 2024 21:55

travis-reed requested review from Gowiem and gberenice September 25, 2024 21:55

mergify bot added the triage Needs triage label Sep 25, 2024

Merge branch 'main' into patch-1

464c680

osterman added the patch A minor, backward compatible change label Nov 1, 2024

Merge branch 'main' into patch-1

50fef7c

RoseSecurity approved these changes Feb 24, 2025

View reviewed changes

RoseSecurity merged commit 8853705 into cloudposse:main Feb 24, 2025
17 checks passed

mergify bot removed the triage Needs triage label Feb 24, 2025

Uh oh!

Set allowed and cache methods as non nullable #324

Set allowed and cache methods as non nullable #324

Uh oh!

Conversation

travis-reed commented Sep 25, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

what

why

references

Additional Notes

Uh oh!

Gowiem commented Sep 26, 2024

Uh oh!

Gowiem commented Sep 26, 2024

Uh oh!

travis-reed commented Sep 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

travis-reed commented Sep 26, 2024

Uh oh!

osterman commented Nov 1, 2024

Uh oh!

coderabbitai bot commented Nov 1, 2024

Uh oh!

coderabbitai bot commented Nov 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

osterman commented Nov 1, 2024

Uh oh!

osterman commented Nov 1, 2024

Uh oh!

coderabbitai bot commented Nov 1, 2024

Uh oh!

travis-reed commented Nov 1, 2024

Uh oh!

RoseSecurity commented Feb 24, 2025

Uh oh!

RoseSecurity left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Feb 24, 2025

Uh oh!

Uh oh!

travis-reed commented Sep 25, 2024 •

edited by coderabbitai bot

Loading

travis-reed commented Sep 26, 2024 •

edited

Loading

coderabbitai bot commented Nov 1, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)