Module: Upkeep::Rails::ControllerRuntime

Extended by:
ActiveSupport::Concern
Defined in:
lib/upkeep/rails/controller_runtime.rb

Constant Summary collapse

SUPPRESS_KEY = 
:upkeep_rails_controller_runtime_suppressed

Class Method Summary collapse

Class Method Details

.install ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 18

def install
  return if @installed
  return unless defined?(::ActionController::Base)

  ::ActionController::Base.include(self)
  @installed = true
end

.installed? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 26

def installed?
  !!@installed
end

.measure_phase(payload, key) ⇒ Object 



121
122
123
124
125
126
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 121

def measure_phase(payload, key)
  started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  yield
ensure
  payload[key] = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000.0).round(3)
end

.record_capture_payload(payload, capture) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 104

def record_capture_payload(payload, capture)
  payload[:response_status] = capture.response_status
  payload[:response_content_type] = capture.response_content_type
  payload[:response_media_type] = capture.response_media_type
  payload[:html_response] = capture.html_response?
  payload[:response_successful] = capture.successful?
  payload[:html_bytes] = capture.html.bytesize
  payload[:graph_frames] = capture.recorder.graph.frame_nodes.size
  payload[:graph_dependencies] = capture.recorder.graph.dependency_nodes.size
  capture.timings.each do |phase, ms|
    payload[:"capture_#{phase}"] = ms
  end
  capture.counters.each do |counter, value|
    payload[:"capture_#{counter}"] = value
  end
end

.request_capture_profile? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 132

def request_capture_profile?
  ActiveSupport::Notifications.notifier.listening?(Upkeep::Rails::REQUEST_CAPTURE)
end

.reset! ⇒ Object 



30
31
32
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 30

def reset!
  @installed = false
end

.suppress ⇒ Object 



34
35
36
37
38
39
40
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 34

def suppress
  previous = Thread.current[SUPPRESS_KEY]
  Thread.current[SUPPRESS_KEY] = true
  yield
ensure
  Thread.current[SUPPRESS_KEY] = previous
end

.suppressed? ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 42

def suppressed?
  Thread.current[SUPPRESS_KEY]
end

.upkeep_capture_request(&action) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 48

def upkeep_capture_request(&action)
  return action.call if ControllerRuntime.suppressed?
  return action.call if Upkeep::Runtime::Observation.recorder

  payload = {
    controller: self.class.name,
    action: action_name,
    method: request.request_method,
    path: request.fullpath,
    subscription_request: upkeep_subscription_request?
  }
  ActiveSupport::Notifications.instrument(Upkeep::Rails::REQUEST_CAPTURE, payload) do
    upkeep_capture_request_with_timing(action, payload)
  end
end

.upkeep_capture_request_with_timing(action, payload) ⇒ Object 



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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 64

def upkeep_capture_request_with_timing(action, payload)
  measure_phase(payload, :deliver_pending_ms) { Upkeep::Rails.deliver_changes_now! }

  result = nil
  capture = nil
  changes = []
  measure_phase(payload, :change_capture_ms) do
    _captured, changes = Upkeep::Runtime::ChangeLog.capture do
      if payload.fetch(:subscription_request)
        capture = Upkeep::Capture::Request.call(self, profile: request_capture_profile?) { action.call }
        result = capture.action_result
      else
        measure_phase(payload, :action_ms) { result = action.call }
      end
    end
  end
  record_capture_payload(payload, capture) if capture

  registration = nil
  if capture
    measure_phase(payload, :register_ms) do
      registration = Upkeep::Rails.register_controller_subscription(self, capture)
    end
  end
  payload[:registered] = !!registration
  if capture && registration
    measure_phase(payload, :inject_ms) do
      response.body = Upkeep::Rails::ClientSubscription.inject(
        capture.html,
        identity: registration.identity,
        subscription: registration.subscription
      )
    end
    payload[:subscription_id] = registration.subscription.id
  end
  measure_phase(payload, :deliver_changes_ms) { Upkeep::Rails.deliver_changes!(changes) }

  result
end

.upkeep_subscription_request? ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/upkeep/rails/controller_runtime.rb', line 128

def upkeep_subscription_request?
  request.get? || request.head?
end