Release/v4.0.2 #127
Merged
Release/v4.0.2 #127
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
- `error_handler_proc` support for method signatures with kwargs
- Increase test coverage to 97%
jgillson
reviewed
May 14, 2024
Comment on lines
+23
to
+39
| define_method(decorated_method) do |*args, **kwargs, &block| | ||
| lamb_dart = LambDart::Log.new( | ||
| klass: self, | ||
| method_config_opts:, | ||
| method_payload:, | ||
| args:, | ||
| kwargs:, | ||
| decorated_method:, | ||
| ) | ||
| method_return_value = nil | ||
| log_prefix = nil | ||
| invocation_id = nil | ||
| begin | ||
| config_proxy.log do | ||
| paydirt = DebugLogging::Util.payload_instance_variable_hydration(scope: self, payload: method_payload) | ||
| log_prefix = debug_invocation_to_s( | ||
| klass: to_s, | ||
| separator: "::", | ||
| method_to_log: method_to_log, | ||
| config_proxy: config_proxy, | ||
| ) | ||
| invocation_id = debug_invocation_id_to_s(args: args, config_proxy: config_proxy) | ||
| signature = debug_signature_to_s(args: args, config_proxy: config_proxy) | ||
| paymud = debug_payload_to_s(payload: paydirt, config_proxy: config_proxy) | ||
| "#{log_prefix}#{signature}#{invocation_id} debug: #{paymud}" | ||
| end | ||
| if config_proxy.benchmarkable_for?(:debug_class_benchmarks) | ||
| tms = Benchmark.measure do | ||
| method_return_value = if args.size == 1 && (harsh = args[0]) && harsh.is_a?(Hash) | ||
| original_method.call(**harsh, &block) | ||
| else | ||
| original_method.call(*args, &block) | ||
| end | ||
| end | ||
| config_proxy.log do | ||
| "#{log_prefix} #{debug_benchmark_to_s(tms: tms)}#{invocation_id}" | ||
| end | ||
| else | ||
| method_return_value = if args.size == 1 && (harsh = args[0]) && harsh.is_a?(Hash) | ||
| original_method.call(**harsh, &block) | ||
| else | ||
| original_method.call(*args, &block) | ||
| end | ||
| if config_proxy.exit_scope_markable? && invocation_id && !invocation_id.empty? | ||
| config_proxy.log do | ||
| "#{log_prefix} completed#{invocation_id}" | ||
| end | ||
| end | ||
| end | ||
| method_return_value | ||
| rescue StandardError => e | ||
| if config_proxy.error_handler_proc | ||
| config_proxy.error_handler_proc.call(config_proxy, e, self, method_to_log, args) | ||
| else | ||
| raise e | ||
| real_mccoy = ->() { | ||
| original_method.call(*args, **kwargs, &block) | ||
| } | ||
| _dl_ld_enter_log(lamb_dart) do | ||
| _dl_ld_error_handle(lamb_dart) do | ||
| return _dl_ld_benchmarked(lamb_dart) { real_mccoy.call } if lamb_dart.bench? | ||
|
|
||
| _dl_ld_exit_log(lamb_dart) { real_mccoy.call } |
There was a problem hiding this comment.
@pboling - In this loop over the methods_to_log, could we extract this to a separate method (perhaps call it define_decorated_method); this way the code is a bit cleaner and potentially faster as it reduces the complexity inside each iteration of the loop.
def define_decorated_method(decorated_method, original_method, method_payload, method_config_opts)
define_method(decorated_method) do |*args, **kwargs, &block|
lamb_dart = LambDart::Log.new(
klass: self,
method_config_opts: method_config_opts,
method_payload: method_payload,
args: args,
kwargs: kwargs,
decorated_method: decorated_method
)
real_mccoy = ->() { original_method.call(*args, **kwargs, &block) }
_dl_ld_enter_log(lamb_dart) do
_dl_ld_error_handle(lamb_dart) do
return _dl_ld_benchmarked(lamb_dart) { real_mccoy.call } if lamb_dart.bench?
_dl_ld_exit_log(lamb_dart) { real_mccoy.call }
end
end
end
endAnd it would be called like this:
Array(methods_to_log).each do |decorated_method|
...
(class << self; self; end).class_eval do
define_decorated_method(decorated_method, original_method, method_payload, method_config_opts)
endThere was a problem hiding this comment.
Yeah, I've considered doing something like that. Attacking that complexity is a logical next step.
jgillson
reviewed
May 14, 2024
Comment on lines
+15
to
+34
| Array(methods_to_notify).each do |decorated_method| | ||
| decorated_method, method_payload, method_config_opts = DebugLogging::Util.extract_payload_and_config( | ||
| method_names: decorated_method, | ||
| payload: payload, | ||
| config: config_opts, | ||
| ) | ||
| original_method = method(method_to_notify) | ||
| original_method = method(decorated_method) | ||
| (class << self; self; end).class_eval do | ||
| define_method(method_to_notify) do |*args, &block| | ||
| config_proxy = DebugLogging::Util.config_proxy_finder( | ||
| scope: self, | ||
| config_opts: method_config_opts, | ||
| method_name: method_to_notify, | ||
| proxy_ref: "kn", | ||
| ) do |proxy| | ||
| ActiveSupport::Notifications.subscribe( | ||
| DebugLogging::ArgumentPrinter.debug_event_name_to_s(method_to_notify: method_to_notify), | ||
| ) do |*debug_args| | ||
| proxy.log do | ||
| DebugLogging::LogSubscriber.log_event(ActiveSupport::Notifications::Event.new(*debug_args)) | ||
| end | ||
| end | ||
| end | ||
| paydirt = DebugLogging::Util.payload_instance_variable_hydration(scope: self, payload: method_payload) | ||
| ActiveSupport::Notifications.instrument( | ||
| DebugLogging::ArgumentPrinter.debug_event_name_to_s(method_to_notify: method_to_notify), | ||
| { | ||
| debug_args: args, | ||
| config_proxy: config_proxy, | ||
| **paydirt, | ||
| }, | ||
| ) do | ||
| if args.size == 1 && (harsh = args[0]) && harsh.is_a?(Hash) | ||
| original_method.call(**harsh, &block) | ||
| else | ||
| original_method.call(*args, &block) | ||
| end | ||
| rescue StandardError => e | ||
| if config_proxy.error_handler_proc | ||
| config_proxy.error_handler_proc.call(config_proxy, e, self, method_to_notify, args) | ||
| else | ||
| raise e | ||
| define_method(decorated_method) do |*args, **kwargs, &block| | ||
| lamb_dart = LambDart::Note.new( | ||
| klass: self, | ||
| method_config_opts:, | ||
| method_payload:, | ||
| args:, | ||
| kwargs:, | ||
| decorated_method:, | ||
| ) | ||
| _dl_ld_notify(lamb_dart) do | ||
| _dl_ld_error_handle(lamb_dart) do | ||
| original_method.call(*args, **kwargs, &block) |
There was a problem hiding this comment.
Perhaps we can do the same here as mentioned in the above comment. Perhaps with instance_logger_modularizer.rb, instance_notifier_modularizer.rb, and simple_debug_logging.rb as well.
There was a problem hiding this comment.
Agreed, ideally we could normalize them all, and DRY them up.
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.
4.0.2 (tag) - 2024-05-12
Added
Changed
DebugLogging::ClassLogger&DebugLogging::InstanceLoggerviaLambDartFixed
version_gemDebugLogging::Hooksintegration viaextendDebugLogging::ClassNotifiersupport for method signatures with kwargserror_handler_procsupport for method signatures with kwargs@jgillson refactored your work on ActiveSupport::Notifications. 💟 Would love any comments you have!