Module: Sqreen::Dependency::Sinatra

Defined in:
lib/sqreen/dependency/sinatra.rb

Class Method Summary collapse

Class Method Details

.insert_datadog_middleware(builder, *args, &block) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/sqreen/dependency/sinatra.rb', line 68

def insert_datadog_middleware(builder, *args, &block)
  return unless defined?(Datadog) && Datadog.respond_to?(:configuration) && Datadog.configuration.instrumented_integrations.key?(:sinatra)

  Datadog.configure do |c|
    sinatra_config = Datadog.configuration[:sinatra]

    c.use(
      :rack,
      service_name: sinatra_config[:service_name],
      distributed_tracing: sinatra_config[:distributed_tracing],
    ) unless Datadog.configuration.instrumented_integrations.key?(:rack)
  end

  insert_middleware(builder, Datadog::Contrib::Rack::TraceMiddleware, args, block) do |p, u|
    u.insert(0, p)
  end
end

.insert_middleware(builder, middleware, args, block) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/sqreen/dependency/sinatra.rb', line 90

def insert_middleware(builder, middleware, args, block)
  use = builder.instance_variable_get('@use')
  wrapped = wrap_middleware(middleware, *args, &block)

  catch(:skip) do
    throw(:skip) if middlewares(builder).include?(middleware)

    yield(wrapped, use)
  end
end

.insert_sqreen_middlewares(builder, *args, &block) ⇒ Object 



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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/sqreen/dependency/sinatra.rb', line 20

def insert_sqreen_middlewares(builder, *args, &block)
  Sqreen.log.debug { 'Inserting Sqreen middlewares for Sinatra' }

  insert_middleware(builder, Sqreen::ErrorHandlingMiddleware, args, block) do |p, u|
    if middlewares(builder).include?(::Sinatra::ShowExceptions)
      Sqreen.log.warn('Sinatra :show_exceptions detected: Sinatra exception handling may prevent the Sqreen error page to display on attacks.')
    end

    if (i = middlewares(builder).index(::Rack::Head))
      u.insert(i, p)
    elsif (i = middlewares(builder).index(::Rack::MethodOverride))
      u.insert(i + 1, p)
    elsif (i = middlewares(builder).index(::Sinatra::ExtendedRack))
      u.insert(i + 1, p)
    else
      u.insert(0, p)
    end
  end

  insert_middleware(builder, Sqreen::ShrinkWrap, args, block) do |p, u|
    if (i = middlewares(builder).index(::Sinatra::ExtendedRack))
      u.insert(i, p)
    else
      u.insert(0, p)
    end
  end

  insert_middleware(builder, Sqreen::Middleware, args, block) do |p, u|
    if (i = middlewares(builder).index(::Sinatra::ExtendedRack))
      u.insert(i, p)
    else
      u.insert(1, p)
    end
  end

  insert_middleware(builder, Sqreen::SinatraMiddleware, args, block) do |p, u|
    if ::Sqreen::Dependency.const_exist?('Rack::PostBodyContentTypeParser') && (i = middlewares(builder).index(::Rack::PostBodyContentTypeParser))
      u.insert(i + 1, p)
    elsif (i = middlewares(builder).index(::Rack::Protection))
      u.insert(i + 1, p)
    else
      u.append(p)
    end
  end

  insert_datadog_middleware(builder, *args, &block)
end

.inspect_middlewares(builder) ⇒ Object 



101
102
103
104
105
 
# File 'lib/sqreen/dependency/sinatra.rb', line 101

def inspect_middlewares(builder)
  Sqreen.log.debug do
    "Middlewares: " << middlewares(builder).map(&:inspect).inspect
  end
end

.middlewares(builder) ⇒ Object 



107
108
109
110
111
112
113
114
115
 
# File 'lib/sqreen/dependency/sinatra.rb', line 107

def middlewares(builder)
  builder.instance_variable_get(:@use).map do |p|
    unless p.respond_to?(:binding) && p.binding.local_variable_defined?(:middleware)
      next :unknown
    end

    p.binding.local_variable_get(:middleware)
  end
end

.required? ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/sqreen/dependency/sinatra.rb', line 16

def required?
  Sqreen::Dependency.const_exist?('Sinatra::Base')
end

.wrap_middleware(middleware, *args, &block) ⇒ Object 



86
87
88
 
# File 'lib/sqreen/dependency/sinatra.rb', line 86

def wrap_middleware(middleware, *args, &block)
  proc { |app| middleware.new(app, *args, &block) }
end