feature: added suppress_required_validations option #152
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
palkan
requested changes
May 30, 2024
| @@ -2,6 +2,15 @@ | |||
|
|
|||
| ## master | |||
|
|
|||
| ## 2.6.5 (2024-05-30) | |||
There was a problem hiding this comment.
Please, do not update version numbers/dates; it's only done on release
| - [Test helpers](#test-helpers) | ||
| - [OptionParser integration](#optionparser-integration) | ||
| - [RBS support](#rbs-support) | ||
| - [Anyway Config](#anyway-config) |
There was a problem hiding this comment.
This change is irrelevant and not needed; please, revert.
| @@ -79,5 +79,7 @@ def app_root | |||
| self.use_local_files ||= ::Rails.env.development? | |||
| # Don't try read defaults when no key defined | |||
| self.default_environmental_key = nil | |||
|
|
|||
| self.suppress_required_validations = ENV["SECRET_KEY_BASE_DUMMY"] | |||
There was a problem hiding this comment.
Anyway-specific env var must have precedence:
Suggested change
| self.suppress_required_validations = ENV["SECRET_KEY_BASE_DUMMY"] | |
| self.suppress_required_validations = !!ENV["SECRET_KEY_BASE_DUMMY"] unless ENV.key?("ANYWAY_SUPPRESS_VALIDATIONS") |
| @@ -107,5 +110,8 @@ def matching_env?(env) | |||
|
|
|||
| # Tracing is enabled by default | |||
| self.tracing_enabled = true | |||
|
|
|||
| # By default, use ANYWAY_SUPPRESS_VALIDATIONS | |||
| self.suppress_required_validations = ENV["ANYWAY_SUPPRESS_VALIDATIONS"] | |||
There was a problem hiding this comment.
Let's be more specific here:
Suggested change
| self.suppress_required_validations = ENV["ANYWAY_SUPPRESS_VALIDATIONS"] | |
| self.suppress_required_validations = %w[1 t true y yes].include?(ENV["ANYWAY_SUPPRESS_VALIDATIONS"]) |
| @@ -7,6 +7,7 @@ module Anyway | |||
| def self.future: -> Future | |||
| def self.current_environment: -> String? | |||
| def self.default_environmental_key: -> String? | |||
| def self.suppress_required_validations: -> bool? | |||
There was a problem hiding this comment.
It's either true or false
Suggested change
| def self.suppress_required_validations: -> bool? | |
| def self.suppress_required_validations: -> bool |
|
|
||
| context "with env" do | ||
| it "not to raise ValidationError" do | ||
| with_env("ANYWAY_SUPPRESS_VALIDATIONS" => "1") do |
There was a problem hiding this comment.
We should add another test case with the falsey value (e.g., "ANYWAY_SUPPRESS_VALIDATIONS=0").
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request?
Closes #151
What changes did you make? (overview)
Added
suppress_required_validationsconfiguration for skipping validation in CI:Support for the Rails built-in environment variable
SECRET_KEY_BASE_DUMMY. If this variable is set, all validations for required attributes are skipped. This is particularly useful for executingbundle exec rails assets:precompilein CI/CD pipelines.Introduced a global setting
Anyway::Settings.suppress_required_validations = trueto disable validations. This can be toggled via the environment variableANYWAY_SUPPRESS_VALIDATIONS.For Rails applications,
suppress_required_validationsis automatically set totrueifSECRET_KEY_BASE_DUMMYis defined.Is there anything you'd like reviewers to focus on?
Checklist