[Bug] Behavior flags should take the default value when the project file is not loaded #338
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
|
Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide. |
mikealfare
commented
Oct 24, 2024
| ] | ||
|
|
||
|
|
||
| def test_register_behavior_flags(adapter): |
There was a problem hiding this comment.
This is the same test as in ./test_behavior_flags.py, but with flags removed from the config fixture above, and swapping the expected values for the two cases where the user override changes the result.
mikealfare
commented
Oct 24, 2024
| # we don't always get project flags, for example, the project file is not loaded during `dbt debug` | ||
| # in that case, load the default values for behavior flags to avoid compilation errors | ||
| # this mimics not loading a project file, or not specifying flags in a project file | ||
| user_overrides = getattr(self.config, "flags", {}) |
There was a problem hiding this comment.
This is effectively the same as swapping [] for flags on line 308, but doing this reads much more cleanly.
colin-rogers-dbt
approved these changes
Oct 25, 2024
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.
Problem
We don't always get the
flagsproperty on theconfigobject that gets used to create aBaseAdapterinstance. This happens wheneverproject.ymlis not loaded. In particular, this happens duringdbt debug, which is meant to be a quick check of whether we can connect to a database; this command only requiresprofile.yml.The decision was initially made to not load any behavior flags in the scenarios where
project.ymlwas not loaded. The rationale there was that we did not want to return one value for a behavior flag whenproject.ymlis not loaded (hence the default) and another value for the behavior flag whenproject.ymlis loaded (the default, potentially overridden by the user). However, in the former scenario, referencing the behavior flag at all results in aCompilationErrorsince the flag does not exist onBaseAdapter.behavior. This is not desirable behavior either.Solution
While the behavior flags are loaded onto
BaseAdapter.behaviordynamically, the object should always have the same flags available. Since the user's overrides are not available whenproject.ymlis not loaded, we should act as ifproject.ymlwas loaded, but without aflagsnode. In other words, we should simply assume the default values when we don't get aflagsattribute.Checklist