-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide a way to analyze without passing block
- Loading branch information
Showing
5 changed files
with
220 additions
and
96 deletions.
There are no files selected for viewing
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 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 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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
# frozen_string_literal: true | ||
|
||
module DiverDown | ||
module Trace | ||
class Tracer | ||
class Session | ||
class NotStarted < StandardError; end | ||
|
||
attr_reader :definition | ||
|
||
# @param [DiverDown::Trace::ModuleSet, nil] module_set | ||
# @param [DiverDown::Trace::IgnoredMethodIds, nil] ignored_method_ids | ||
# @param [Set<String>, nil] target_file_set | ||
# @param [#call, nil] filter_method_id_path | ||
def initialize(module_set: DiverDown::Trace::ModuleSet.new, ignored_method_ids: nil, target_file_set: nil, filter_method_id_path: nil, definition: DiverDown::Definition.new) | ||
@module_set = module_set | ||
@ignored_method_ids = ignored_method_ids | ||
@target_file_set = target_file_set | ||
@filter_method_id_path = filter_method_id_path | ||
@definition = definition | ||
@trace_point = build_trace_point | ||
end | ||
|
||
# @return [void] | ||
def start | ||
@trace_point.enable | ||
end | ||
|
||
# @return [void] | ||
def stop | ||
@trace_point.disable | ||
end | ||
|
||
private | ||
|
||
def build_trace_point | ||
call_stack = DiverDown::Trace::CallStack.new | ||
ignored_stack_size = nil | ||
|
||
TracePoint.new(*DiverDown::Trace::Tracer.trace_events) do |tp| | ||
# Skip the trace of the library itself | ||
next if tp.path&.start_with?(DiverDown::LIB_DIR) | ||
next if TracePoint == tp.defined_class | ||
|
||
case tp.event | ||
when :call, :c_call | ||
# puts "#{tp.method_id} #{tp.path}:#{tp.lineno}" | ||
mod = DiverDown::Helper.resolve_module(tp.self) | ||
source_name = DiverDown::Helper.normalize_module_name(mod) if !mod.nil? && @module_set.include?(mod) | ||
already_ignored = !ignored_stack_size.nil? # If the current method_id is ignored | ||
current_ignored = !@ignored_method_ids.nil? && @ignored_method_ids.ignored?(mod, DiverDown::Helper.module?(tp.self), tp.method_id) | ||
pushed = false | ||
|
||
if !source_name.nil? && !(already_ignored || current_ignored) | ||
source = @definition.find_or_build_source(source_name) | ||
|
||
# If the call stack contains a call to a module to be traced | ||
# `@ignored_call_stack` is not nil means the call stack contains a call to a module to be ignored | ||
unless call_stack.empty? | ||
# Add dependency to called source | ||
called_stack_context = call_stack.stack[-1] | ||
called_source = called_stack_context.source | ||
dependency = called_source.find_or_build_dependency(source_name) | ||
|
||
# `dependency.nil?` means source_name equals to called_source.source. | ||
# self-references are not tracked because it is not "dependency". | ||
if dependency | ||
context = DiverDown::Helper.module?(tp.self) ? 'class' : 'instance' | ||
method_id = dependency.find_or_build_method_id(name: tp.method_id, context:) | ||
method_id_path = "#{called_stack_context.caller_location.path}:#{called_stack_context.caller_location.lineno}" | ||
method_id_path = @filter_method_id_path.call(method_id_path) if @filter_method_id_path | ||
method_id.add_path(method_id_path) | ||
end | ||
end | ||
|
||
# `caller_location` is nil if it is filtered by target_files | ||
caller_location = find_neast_caller_location | ||
|
||
if caller_location | ||
pushed = true | ||
|
||
call_stack.push( | ||
StackContext.new( | ||
source:, | ||
method_id: tp.method_id, | ||
caller_location: | ||
) | ||
) | ||
end | ||
end | ||
|
||
call_stack.push unless pushed | ||
|
||
# If a value is already stored, it means that call stack already determined to be ignored at the shallower call stack size. | ||
# Since stacks deeper than the shallowest stack size are ignored, priority is given to already stored values. | ||
if !already_ignored && current_ignored | ||
ignored_stack_size = call_stack.stack_size | ||
end | ||
when :return, :c_return | ||
ignored_stack_size = nil if ignored_stack_size == call_stack.stack_size | ||
call_stack.pop | ||
end | ||
rescue StandardError | ||
tp.disable | ||
raise | ||
end | ||
end | ||
|
||
def find_neast_caller_location | ||
return caller_locations(2, 2)[0] if @target_file_set.nil? | ||
|
||
Thread.each_caller_location do | ||
return _1 if @target_file_set.include?(_1.path) | ||
end | ||
|
||
nil | ||
end | ||
end | ||
end | ||
end | ||
end |
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