Class: RSpecTelemetry::ConsoleReport

Inherits:
Object
  • Object
show all
Includes:
Helpers
Defined in:
lib/rspec_telemetry/console_report.rb

Defined Under Namespace

Modules: Helpers

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers

fmt, objects, pct, section, truncate

Constructor Details

#initialize(analyzer, files_count:, top: 15) ⇒ ConsoleReport

Returns a new instance of ConsoleReport.



25
26
27
28
29
 
# File 'lib/rspec_telemetry/console_report.rb', line 25

def initialize(analyzer, files_count:, top: 15)
  @analyzer = analyzer
  @files_count = files_count
  @top = top
end

Class Method Details

.drill_down(events, example_id) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/rspec_telemetry/console_report.rb', line 38

def self.drill_down(events, example_id)
  lines = Helpers.section("Example: #{example_id}")
  finished = events.find { |e| e["type"] == "example.finished" }
  if finished
    lines << "  #{finished["full_description"]}"
    lines << "  status: #{finished["status"]}   duration: #{Helpers.fmt(finished["duration_ms"])}"
    if finished["gc_time_ms"]
      lines << "  gc: #{Helpers.fmt(finished["gc_time_ms"])} " \
               "(#{finished["gc_major_count"]} major / #{finished["gc_minor_count"]} minor, " \
               "#{Helpers.objects(finished["allocated_objects"].to_i)} objects allocated)"
    end
  end

  requests = events.select { |e| e["type"] == "action_controller.process_action" }
  unless requests.empty?
    lines << ""
    lines << "  Requests:"
    requests.each { |r| lines << request_line(r) }
  end

  sql_groups = events.select { |e| e["type"] == "sql.group" }
  unless sql_groups.empty?
    lines << ""
    lines << "  SQL (grouped by name):"
    sql_groups.sort_by { |g| -g["total_ms"].to_f }.each { |g| lines << sql_group_line(g) }
    total = sql_groups.sum { |g| g["total_ms"].to_f }
    count = sql_groups.sum { |g| g["count"].to_i }
    lines << "    sql total: #{Helpers.fmt(total)} across #{count} queries"
  end

  slow_queries = events.select { |e| e["type"] == "sql.query" }
  unless slow_queries.empty?
    lines << ""
    lines << "  Slow queries:"
    slow_queries.each do |q|
      lines << "    #{Helpers.fmt(q["duration_ms"])}  #{q["name"]}#{q["in_factory"] ? "  (in factory)" : ""}"
      lines << "      #{q["sql"]}"
    end
  end

  factories = events.select { |e| e["type"] == "factory_bot.run_factory" }
  return lines.join("\n") if factories.empty?

  lines << ""
  lines << "  FactoryBot calls (indented by nesting depth):"
  factories.each { |f| lines << factory_line(f) }
  total = factories.sum { |f| (f["self_duration_ms"] || f["duration_ms"]).to_f }
  lines << ""
  lines << "  factory self total: #{Helpers.fmt(total)} across #{factories.size} calls"
  lines.join("\n")
end

.factory_line(fields) ⇒ Object 



115
116
117
118
119
120
121
 
# File 'lib/rspec_telemetry/console_report.rb', line 115

def self.factory_line(fields)
  indent = "    " + ("  " * fields["depth"].to_i)
  traits = Array(fields["traits"]).empty? ? "" : " [#{fields["traits"].join(",")}]"
  self_ms = fields["self_duration_ms"] || fields["duration_ms"]
  "#{indent}#{fields["factory"]}:#{fields["strategy"]}#{traits}  " \
    "self #{Helpers.fmt(self_ms)} / total #{Helpers.fmt(fields["duration_ms"])}"
end

.request_line(fields) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/rspec_telemetry/console_report.rb', line 103

def self.request_line(fields)
  db = fields["db_runtime_ms"]
  view = fields["view_runtime_ms"]
  breakdown = [
    db ? "db #{Helpers.fmt(db)}" : nil,
    view ? "view #{Helpers.fmt(view)}" : nil
  ].compact.join(", ")
  breakdown = "  (#{breakdown})" unless breakdown.empty?
  "    #{fields["http_method"]} #{fields["controller"]}##{fields["action"]}  " \
    "status #{fields["status"]}  #{Helpers.fmt(fields["duration_ms"])}#{breakdown}"
end

.sql_group_line(fields) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/rspec_telemetry/console_report.rb', line 90

def self.sql_group_line(fields)
  in_factory = fields["in_factory_count"].to_i
  factory_note = in_factory.positive? ? "  (in factories: #{Helpers.fmt(fields["in_factory_ms"])} / #{in_factory})" : ""
  format(
    "    %-32s count %4d   total %9s   max %9s%s",
    Helpers.truncate(fields["name"].to_s, 32),
    fields["count"].to_i,
    Helpers.fmt(fields["total_ms"]),
    Helpers.fmt(fields["max_ms"]),
    factory_note
  )
end

Instance Method Details

#render ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/rspec_telemetry/console_report.rb', line 31

def render
  lines = overview + slow_files + slow_examples + top_factories + top_queries
  lines << ""
  lines << "Tip: drill into one example with `rspec-telemetry --example \"<example_id>\"`"
  lines.join("\n")
end