Allow skipping variable inspection by class name #449
Merged
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
This adds a new global setting `BetterErrors.ignored_classes` that will skip inspecting the value of local and instance variables of this type. The default setting ignores action dispatch request and response instances, which are usually not printed anyways due to exceeding the limit of `BetterErrors.maximum_variable_inspect_size`, but also avoids all the memory allocations and database queries that are triggered by calling `#inspect` on variables. The default setting was chosen to avoid excessive database queries for unloaded relations, because both the `ActionDispatch::Request` and the `ActionDispatch::Response` objects hold many references to the controller instance, causing the same instance variables to be inspected over and over again.
|
Seems like with the BOC specs there's a different string representation for inspect_value, which lacks the quotes. I'll rewrite the spec changes to work around that. |
For some weird reason with binding of caller loaded the inspected value for strings is no longer quoted, breaking the specs, so this changes the specs back to using all symbols.
|
Now that the specs were fixed by #453, I changed the specs to use the new matching method. I changed the specs to explicitly set up a context with an ignored class rather than changing all of the other contexts/examples to use a |
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.
This adds a new global setting
BetterErrors.ignored_classesthat will skip inspecting the value of local and instance variables of this type.The default setting ignores action dispatch request and response instances, which are usually not printed anyways due to exceeding the limit of
BetterErrors.maximum_variable_inspect_size, but also avoidsall the memory allocations and database queries that are triggered by calling
#inspecton variables.The default setting was chosen to avoid excessive database queries for unloaded relations, because both the
ActionDispatch::Requestand theActionDispatch::Responseobjects hold many references to the controller instance, causing the same instance variables to be inspected over and over again.(See rails/rails#38445 for details.)
This is a safer alternative to the undocumented setting
BetterErrors.ignored_instance_variables, which could be set to[:@_request, :@_response]for Rails. It also doesn't completely hide the variables, but instead shows a message why the value was omitted, similar tomaximum_variable_inspect_size.