Freeze modifications to ActiveRecord::QueryLogs #52410
Merged
Conversation
This file contains hidden or 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
4 tasks
jhawthorn
commented
Jul 24, 2024
| @@ -185,7 +185,7 @@ def test_empty_comments_are_not_added | |||
|
|
|||
| def test_sql_commenter_format | |||
| ActiveRecord::QueryLogs.tags_formatter = :sqlcommenter | |||
| ActiveRecord::QueryLogs.tags = [:application, {}] | |||
| ActiveRecord::QueryLogs.tags = [:application] | |||
There was a problem hiding this comment.
With this change we could remove this line, but I think it's worth setting the value we're testing for
jhawthorn
commented
Jul 24, 2024
| @@ -134,6 +133,7 @@ def tags_formatter=(format) # :nodoc: | |||
| else | |||
| raise ArgumentError, "Formatter is unsupported: #{format}" | |||
| end | |||
| @tags_formatter = format | |||
There was a problem hiding this comment.
I'd rather this setter be here, after @formatter, so that the exception that can be raised above prevents the assignment.
Tags and taggings build a cache when they are assigned, which means we cannot support them being mutated. This freezes tags and taggings to ensure they aren't changed after assignment. This may not cover all cases, and per the previous PR we intend this to be configured mostly via application.config, but it covers a case we were making in our test suite and so should hopefully cover a mistake users are somewhat likely to make.
jhawthorn
force-pushed
the
freeze_query_logs
branch
from
69a8417 to
146ae32
Compare
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.
Refs #52404 and #52392
Tags and taggings build a cache when they are assigned, which means we cannot support them being mutated. This freezes tags and taggings to ensure they aren't changed after assignment.
This may not cover all cases, and per the previous PR we intend this to be configured mostly via
application.config, but it covers a case we were making in our test suite and so should hopefully cover a mistake users are somewhat likely to make.