Fix AppSec Sinatra contrib types

Steepfile

@@ -73,14 +73,6 @@ target :datadog do
   ignore 'lib/datadog/appsec/contrib/rails/patches/render_to_body_patch.rb'
   ignore 'lib/datadog/appsec/contrib/rails/request.rb'
   ignore 'lib/datadog/appsec/contrib/rails/request_middleware.rb'
-  ignore 'lib/datadog/appsec/contrib/sinatra/framework.rb'
-  ignore 'lib/datadog/appsec/contrib/sinatra/gateway/request.rb'
-  ignore 'lib/datadog/appsec/contrib/sinatra/gateway/route_params.rb'
-  ignore 'lib/datadog/appsec/contrib/sinatra/gateway/watcher.rb'
-  ignore 'lib/datadog/appsec/contrib/sinatra/integration.rb'
-  ignore 'lib/datadog/appsec/contrib/sinatra/patcher.rb'
-  ignore 'lib/datadog/appsec/contrib/sinatra/patches/json_patch.rb'
-  ignore 'lib/datadog/appsec/contrib/sinatra/request_middleware.rb'
   ignore 'lib/datadog/appsec/monitor/gateway/watcher.rb'
   ignore 'lib/datadog/core/buffer/thread_safe.rb'
   ignore 'lib/datadog/core/configuration.rb'

lib/datadog/appsec/contrib/sinatra/gateway/watcher.rb

@@ -23,7 +23,7 @@ def watch
 
               def watch_request_dispatch(gateway = Instrumentation.gateway)
                 gateway.watch('sinatra.request.dispatch', :appsec) do |stack, gateway_request|
-                  context = gateway_request.env[AppSec::Ext::CONTEXT_KEY]
+                  context = gateway_request.env[AppSec::Ext::CONTEXT_KEY] # : Context
 
                   persistent_data = {
                     'server.request.body' => gateway_request.form_hash
@@ -49,8 +49,9 @@ def watch_request_dispatch(gateway = Instrumentation.gateway)
               end
 
               def watch_request_routed(gateway = Instrumentation.gateway)
-                gateway.watch('sinatra.request.routed', :appsec) do |stack, (gateway_request, gateway_route_params)|
-                  context = gateway_request.env[AppSec::Ext::CONTEXT_KEY]
+                gateway.watch('sinatra.request.routed', :appsec) do |stack, args|
+                  gateway_request, gateway_route_params = args # : [Gateway::Request, Gateway::RouteParams]
+                  context = gateway_request.env[AppSec::Ext::CONTEXT_KEY] # : Context
 
                   persistent_data = {
                     'server.request.path_params' => gateway_route_params.params
@@ -75,7 +76,7 @@ def watch_request_routed(gateway = Instrumentation.gateway)
 
               def watch_response_body_json(gateway = Instrumentation.gateway)
                 gateway.watch('sinatra.response.body.json', :appsec) do |stack, container|
-                  context = container.context
+                  context = container.context # : Context
 
                   persistent_data = {
                     'server.response.body' => container.data

lib/datadog/appsec/contrib/sinatra/integration.rb

@@ -26,7 +26,7 @@ def self.loaded?
           end
 
           def self.compatible?
-            super && version >= MINIMUM_VERSION
+            !!(super && (version&.>= MINIMUM_VERSION))
           end
 
           def self.auto_instrument?

lib/datadog/appsec/contrib/sinatra/patcher.rb

@@ -71,7 +71,7 @@ def dispatch!
         # path params are returned by pattern.params in process_route, then
         # merged with normal params, so we get both
         module RoutePatch
-          def process_route(*)
+          def process_route(*args)
             env = @request.env
 
             context = env[Datadog::AppSec::Ext::CONTEXT_KEY]
@@ -123,7 +123,7 @@ def patch
           end
 
           def patch_json?
-            defined?(::Sinatra::JSON) && ::Sinatra::Base < ::Sinatra::JSON
+            !!(defined?(::Sinatra::JSON) && ::Sinatra::Base < ::Sinatra::JSON)
           end
         end
       end

lib/datadog/appsec/contrib/sinatra/patches/json_patch.rb

@@ -12,7 +12,7 @@ module Patches
           # body right before it is serialized.
           module JsonPatch
             def json(object, options = {})
-              context = @request.env[Datadog::AppSec::Ext::CONTEXT_KEY]
+              context = @request.env[Datadog::AppSec::Ext::CONTEXT_KEY] # : Context?
               return super unless context
 
               data = Utils::HashCoercion.coerce(object)

sig/datadog/appsec/contrib/rack/gateway/request.rbs

@@ -4,33 +4,35 @@ module Datadog
       module Rack
         module Gateway
           class Request < Instrumentation::Gateway::Argument
-            attr_reader env: untyped
+            @env: ::Hash[::String, top]
 
-            def initialize: (untyped env) -> void
+            attr_reader env: ::Hash[::String, top]
 
-            def request: () -> untyped
+            def initialize: (::Hash[::String, top] env) -> void
 
-            def query: () -> untyped
+            def request: () -> ::Rack::Request
 
-            def headers: () -> untyped
+            def query: () -> ::Hash[::String, top]
 
-            def body: () -> untyped
+            def headers: () -> ::Hash[::String, ::String]
 
-            def method: () -> untyped
+            def body: () -> ::String
 
-            def url: () -> untyped
+            def method: () -> ::String
 
-            def cookies: () -> untyped
+            def url: () -> ::String
 
-            def host: () -> untyped
+            def cookies: () -> ::Hash[::String, ::String]
 
-            def user_agent: () -> untyped
+            def host: () -> ::String
 
-            def remote_addr: () -> untyped
+            def user_agent: () -> ::String
 
-            def form_hash: () -> untyped
+            def remote_addr: () -> ::String
 
-            def client_ip: () -> (nil | untyped)
+            def form_hash: () -> ::Hash[::String, top]
+
+            def client_ip: () -> ::String?
           end
         end
       end

sig/datadog/appsec/contrib/sinatra/framework.rbs

@@ -3,11 +3,7 @@ module Datadog
     module Contrib
       module Sinatra
         module Framework
-          def self.setup: () -> untyped
-
-          def self.config_with_defaults: (untyped datadog_config) -> untyped
-
-          def self.activate_rack!: (untyped datadog_config, untyped sinatra_config) -> untyped
+          def self.setup: () -> void
         end
       end
     end

sig/datadog/appsec/contrib/sinatra/gateway/route_params.rbs

@@ -4,9 +4,11 @@ module Datadog
       module Sinatra
         module Gateway
           class RouteParams < Instrumentation::Gateway::Argument
-            attr_reader params: untyped
+            @params: ::Hash[::String, top]
 
-            def initialize: (untyped params) -> void
+            attr_reader params: ::Hash[::String, top]
+
+            def initialize: (::Hash[::String, top] params) -> void
           end
         end
       end

sig/datadog/appsec/contrib/sinatra/gateway/watcher.rbs

@@ -4,11 +4,13 @@ module Datadog
       module Sinatra
         module Gateway
           module Watcher
-            def self.watch: () -> untyped
+            def self.watch: () -> void
 
-            def self.watch_request_dispatch: (?Datadog::AppSec::Instrumentation::Gateway gateway) -> untyped
+            def self.watch_request_dispatch: (?Datadog::AppSec::Instrumentation::Gateway gateway) -> void
 
-            def self.watch_request_routed: (?Datadog::AppSec::Instrumentation::Gateway gateway) -> untyped
+            def self.watch_request_routed: (?Datadog::AppSec::Instrumentation::Gateway gateway) -> void
+
+            def self.watch_response_body_json: (?Datadog::AppSec::Instrumentation::Gateway gateway) -> void
           end
         end
       end

sig/datadog/appsec/contrib/sinatra/integration.rbs

@@ -4,20 +4,19 @@ module Datadog
       module Sinatra
         class Integration
           include Datadog::AppSec::Contrib::Integration
+          extend Datadog::AppSec::Contrib::Integration::ClassMethods
 
-          MINIMUM_VERSION: untyped
+          MINIMUM_VERSION: Gem::Version
 
-          def self.version: () -> untyped
+          def self.version: () -> Gem::Version?
 
-          def self.loaded?: () -> untyped
+          def self.loaded?: () -> bool
 
-          def self.compatible?: () -> untyped
+          def self.compatible?: () -> bool
 
           def self.auto_instrument?: () -> true
 
-          def default_configuration: () -> untyped
-
-          def patcher: () -> untyped
+          def patcher: () -> singleton(Patcher)
         end
       end
     end

sig/datadog/appsec/contrib/sinatra/patcher.rbs

@@ -2,6 +2,10 @@ module Datadog
   module AppSec
     module Contrib
       module Sinatra
+        interface _SinatraRequest
+          def env: () -> rack_env
+        end
+
         module AppSecSetupPatch
           def setup_middleware: (*untyped args) ?{ () -> untyped } -> untyped
         end
@@ -11,19 +15,25 @@ module Datadog
         end
 
         module DispatchPatch
+          @request: _SinatraRequest
+
           def dispatch!: () -> untyped
         end
 
         module RoutePatch
-          def process_route: () { (untyped) -> untyped } -> untyped
+          @request: _SinatraRequest
+
+          def process_route: (*untyped args) { (*untyped) -> untyped } -> untyped
+
+          def params: () -> ::Hash[::String, top]
         end
 
         module Patcher
-          def self?.patched?: () -> untyped
+          def self?.patched?: () -> bool
 
-          def self?.target_version: () -> untyped
+          def self?.target_version: () -> Gem::Version?
 
-          def self?.patch: () -> untyped
+          def self?.patch: () -> void
 
           def self?.patch_json?: () -> bool
         end

sig/datadog/appsec/contrib/sinatra/patches/json_patch.rbs

@@ -4,7 +4,9 @@ module Datadog
       module Sinatra
         module Patches
           module JsonPatch
-            def json: (untyped object, ?::Hash[untyped, untyped] options) -> untyped
+            @request: Sinatra::_SinatraRequest
+
+            def json: (untyped object, ?untyped options) -> ::String
           end
         end
       end

sig/datadog/appsec/contrib/sinatra/request_middleware.rbs

@@ -3,9 +3,11 @@ module Datadog
     module Contrib
       module Sinatra
         class RequestMiddleware
-          def initialize: (untyped app, ?::Hash[untyped, untyped] opt) -> void
+          @app: rack_app
 
-          def call: (untyped env) -> untyped
+          def initialize: (rack_app app, ?::Hash[::Symbol, top] opt) -> void
+
+          def call: (rack_env env) -> rack_response
         end
       end
     end

sig/datadog/appsec/contrib/sinatra/types.rbs

@@ -0,0 +1,11 @@
+module Datadog
+  module AppSec
+    module Contrib
+      module Sinatra
+        type rack_env = ::Hash[::String, top]
+        type rack_response = [::Integer, ::Hash[::String, ::String], ::Array[::String]]
+        type rack_app = ^(rack_env) -> rack_response
+      end
+    end
+  end
+end

sig/datadog/appsec/instrumentation/gateway.rbs

@@ -6,7 +6,7 @@ module Datadog
         type final_call_result = untyped
         type final_call = ^() -> final_call_result
         type stack = ::Proc
-        type argument = Gateway::Argument | ::String
+        type argument = Gateway::Argument | ::String | ::Array[Gateway::Argument]
 
         type stack_result = ::Array[nil | middleware_result | final_call_result]
 
@@ -17,7 +17,10 @@ module Datadog
 
         def push: (::String name, argument env) ?{ () -> final_call_result } -> stack_result
 
-        def watch: (::String name, ::Symbol key) { (stack next, argument env) -> stack_result } -> void
+        def watch: ("sinatra.request.dispatch", ::Symbol key) { (stack, ::Datadog::AppSec::Contrib::Sinatra::Gateway::Request) -> stack_result } -> void
+                 | ("sinatra.request.routed", ::Symbol key) { (stack, [::Datadog::AppSec::Contrib::Sinatra::Gateway::Request, ::Datadog::AppSec::Contrib::Sinatra::Gateway::RouteParams]) -> stack_result } -> void
+                 | ("sinatra.response.body.json", ::Symbol key) { (stack, Gateway::DataContainer) -> stack_result } -> void
+                 | (::String name, ::Symbol key) { (stack, argument) -> stack_result } -> void
 
         def pushed?: (::String name) -> bool
       end

sig/datadog/appsec/instrumentation/gateway/middleware.rbs

@@ -6,8 +6,8 @@ module Datadog
           attr_reader key: ::Symbol
           attr_reader block: ::Proc
 
-          def initialize: (::Symbol key) { (Gateway::stack next, Gateway::Argument env) -> stack_result } -> void
-          def call: (Gateway::stack next, Gateway::Argument? env) -> stack_result
+          def initialize: (::Symbol key) { (Gateway::stack next, Gateway::argument env) -> stack_result } -> void
+          def call: (Gateway::stack next, Gateway::argument env) -> stack_result
         end
       end
     end

vendor/rbs/rack/0/rack.rbs

@@ -0,0 +1,17 @@
+module Rack
+  class Request
+    def initialize: (::Hash[::String, top] env) -> void
+
+    def env: () -> ::Hash[::String, top]
+
+    def params: () -> ::Hash[::String, top]
+
+    def body: () -> top
+
+    def get?: () -> bool
+
+    def post?: () -> bool
+
+    def path: () -> ::String
+  end
+end

vendor/rbs/sinatra/0/sinatra.rbs

@@ -5,4 +5,7 @@ module Sinatra
 
   class Base
   end
+
+  module JSON
+  end
 end