Class: Bullet::Rack

Inherits:
Object show all
Includes:
Dependency
Defined in:
lib/bullet/rack.rb

Constant Summary collapse

NONCE_MATCHER = 
/script-src .*'nonce-(?<nonce>[A-Za-z0-9+\/]+={0,2})'/

Instance Method Summary collapse

Methods included from Dependency

#active_record40?, #active_record41?, #active_record42?, #active_record4?, #active_record50?, #active_record51?, #active_record52?, #active_record5?, #active_record60?, #active_record61?, #active_record6?, #active_record70?, #active_record71?, #active_record7?, #active_record?, #active_record_version, #mongoid4x?, #mongoid5x?, #mongoid6x?, #mongoid7x?, #mongoid8x?, #mongoid?, #mongoid_version

Constructor Details

#initialize(app) ⇒ Rack

Returns a new instance of Rack.



9
10
11
 
# File 'lib/bullet/rack.rb', line 9

def initialize(app)
  @app = app
end

Instance Method Details

#append_to_html_body(response_body, content) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/bullet/rack.rb', line 57

def append_to_html_body(response_body, content)
  body = response_body.dup
  content = content.html_safe if content.respond_to?(:html_safe)
  if body.include?('</body>')
    position = body.rindex('</body>')
    body.insert(position, content)
  else
    body << content
  end
end

#call(env) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/bullet/rack.rb', line 13

def call(env)
  return @app.call(env) unless Bullet.enable?

  Bullet.start_request
  status, headers, response = @app.call(env)

  response_body = nil

  if Bullet.notification? || Bullet.always_append_html_body
    if Bullet.inject_into_page? && !file?(headers) && !sse?(headers) && !empty?(response) && status == 200
      if html_request?(headers, response)
        response_body = response_body(response)

        with_security_policy_nonce(headers) do |nonce|
          response_body = append_to_html_body(response_body, footer_note) if Bullet.add_footer
          response_body = append_to_html_body(response_body, Bullet.gather_inline_notifications)
          if Bullet.add_footer && !Bullet.skip_http_headers
            response_body = append_to_html_body(response_body, xhr_script(nonce))
          end
        end

        headers['Content-Length'] = response_body.bytesize.to_s
      elsif !Bullet.skip_http_headers
        set_header(headers, 'X-bullet-footer-text', Bullet.footer_info.uniq) if Bullet.add_footer
        set_header(headers, 'X-bullet-console-text', Bullet.text_notifications) if Bullet.console_enabled?
      end
    end
    Bullet.perform_out_of_channel_notifications(env)
  end
  [status, headers, response_body ? [response_body] : response]
ensure
  Bullet.end_request
end

#empty?(response) ⇒ Boolean

fix issue if response’s body is a Proc

Returns:

  • (Boolean) 


48
49
50
51
52
53
54
55
 
# File 'lib/bullet/rack.rb', line 48

def empty?(response)
  # response may be ["Not Found"], ["Move Permanently"], etc, but
  # those should not happen if the status is 200
  return true if !response.respond_to?(:body) && !response.respond_to?(:first)

  body = response_body(response)
  body.nil? || body.empty?
end

#file?(headers) ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/bullet/rack.rb', line 80

def file?(headers)
  headers['Content-Transfer-Encoding'] == 'binary' || headers['Content-Disposition']
end

#footer_note ⇒ Object 



68
69
70
 
# File 'lib/bullet/rack.rb', line 68

def footer_note
  "<details #{details_attributes}><summary #{summary_attributes}>Bullet Warnings</summary><div #{footer_content_attributes}>#{Bullet.footer_info.uniq.join('<br>')}#{footer_console_message}</div></details>"
end

#html_request?(headers, response) ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/bullet/rack.rb', line 88

def html_request?(headers, response)
  headers['Content-Type']&.include?('text/html')
end

#response_body(response) ⇒ Object 



92
93
94
95
96
97
98
 
# File 'lib/bullet/rack.rb', line 92

def response_body(response)
  if response.respond_to?(:body)
    Array === response.body ? response.body.first : response.body
  elsif response.respond_to?(:first)
    response.first
  end
end

#set_header(headers, header_name, header_array) ⇒ Object 



72
73
74
75
76
77
78
 
# File 'lib/bullet/rack.rb', line 72

def set_header(headers, header_name, header_array)
  # Many proxy applications such as Nginx and AWS ELB limit
  # the size a header to 8KB, so truncate the list of reports to
  # be under that limit
  header_array.pop while header_array.to_json.length > 8 * 1024
  headers[header_name] = header_array.to_json
end

#sse?(headers) ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
 
# File 'lib/bullet/rack.rb', line 84

def sse?(headers)
  headers['Content-Type'] == 'text/event-stream'
end