Split RailsRoutesSerializer into RailsCollector and serializers

Author: y9v

lib/datadog/appsec/api_security/endpoint_collection/grape_route_serializer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Datadog
+  module AppSec
+    module APISecurity
+      module EndpointCollection
+        # This module serializes Grape routes.
+        module GrapeRouteSerializer
+          module_function
+
+          def serialize(route, path_prefix: '')
+            path = path_prefix + route.pattern.origin
+
+            {
+              type: "REST",
+              resource_name: "#{route.request_method} #{path}",
+              operation_name: "http.request",
+              method: route.request_method,
+              path: path
+            }
+          end
+        end
+      end
+    end
+  end
+end

lib/datadog/appsec/api_security/endpoint_collection/grape_routes_serializer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative 'rails_route_serializer'
+require_relative 'grape_route_serializer'
+require_relative 'sinatra_route_serializer'
+
+module Datadog
+  module AppSec
+    module APISecurity
+      module EndpointCollection
+        # This class works with a collection of rails routes
+        # and produces an Enumerator that yields serialized endpoints.
+        class RailsCollector
+          def initialize(routes)
+            @routes = routes
+          end
+
+          def build_enum
+            Enumerator.new do |yielder|
+              @routes.each do |route|
+                if route.dispatcher?
+                  yielder.yield RailsRouteSerializer.serialize(route)
+                elsif mounted_grape_app?(route.app.rack_app)
+                  route.app.rack_app.routes.each do |grape_route|
+                    yielder.yield GrapeRouteSerializer.serialize(grape_route, path_prefix: route.path.spec.to_s)
+                  end
+                elsif mounted_sinatra_app?(route.app.rack_app)
+                  route.app.rack_app.routes.each do |method, sinatra_routes|
+                    next if method == 'HEAD'
+
+                    sinatra_routes.each do |sinatra_route, _, _|
+                      yielder.yield SinatraRouteSerializer.serialize(
+                        sinatra_route, method: method, path_prefix: route.path.spec.to_s
+                      )
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          private
+
+          def mounted_grape_app?(rack_app)
+            return false unless defined?(::Grape::API)
+
+            rack_app.is_a?(Class) && rack_app < ::Grape::API
+          end
+
+          def mounted_sinatra_app?(rack_app)
+            return false unless defined?(::Sinatra::Base)
+
+            rack_app.is_a?(Class) && rack_app < ::Sinatra::Base
+          end
+        end
+      end
+    end
+  end
+end

lib/datadog/appsec/api_security/endpoint_collection/rails_collector.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Datadog
+  module AppSec
+    module APISecurity
+      module EndpointCollection
+        # This module serializes Rails Journey Router routes.
+        module RailsRouteSerializer
+          FORMAT_SUFFIX = "(.:format)"
+
+          module_function
+
+          def serialize(route)
+            method = route.verb.empty? ? "*" : route.verb
+            path = route.path.spec.to_s.delete_suffix(FORMAT_SUFFIX)
+
+            {
+              type: "REST",
+              resource_name: "#{method} #{path}",
+              operation_name: "http.request",
+              method: method,
+              path: path
+            }
+          end
+        end
+      end
+    end
+  end
+end

lib/datadog/appsec/api_security/endpoint_collection/rails_route_serializer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Datadog
+  module AppSec
+    module APISecurity
+      module EndpointCollection
+        # This module serializes Sinatra routes.
+        module SinatraRouteSerializer
+          module_function
+
+          def serialize(route, method:, path_prefix: '')
+            path = path_prefix + route.safe_string
+
+            {
+              type: "REST",
+              resource_name: "#{method} #{path}",
+              operation_name: "http.request",
+              method: method,
+              path: path
+            }
+          end
+        end
+      end
+    end
+  end
+end

lib/datadog/appsec/api_security/endpoint_collection/rails_routes_serializer.rb

@@ -10,7 +10,7 @@
 require_relative 'gateway/request'
 require_relative 'patches/render_to_body_patch'
 require_relative 'patches/process_action_patch'
-require_relative '../../api_security/endpoint_collection/rails_routes_serializer'
+require_relative '../../api_security/endpoint_collection/rails_collector'
 
 require_relative '../../../tracing/contrib/rack/middlewares'
 
@@ -154,7 +154,7 @@ def report_routes_via_telemetry(routes)
 
             GUARD_ROUTES_REPORTING_ONCE_PER_APP[::Rails.application].run do
               AppSec.telemetry.app_endpoints_loaded(
-                APISecurity::EndpointCollection::RailsRoutesSerializer.new(routes).to_enum
+                APISecurity::EndpointCollection::RailsCollector.new(routes).build_enum
               )
             end
           rescue => e

lib/datadog/appsec/api_security/endpoint_collection/sinatra_route_serializer.rb

@@ -4,7 +4,7 @@ module Datadog
       module EndpointCollection
         interface _RailsRoute
           def dispatcher?: () -> bool
-          def verb: () -> String
+          def verb: () -> ::String
           def path: () -> _RailsRoutePath
           def app: () -> _RailsRouteApp
         end
@@ -14,7 +14,7 @@ module Datadog
         end
 
         interface _RailsRouteSpec
-          def to_s: () -> String
+          def to_s: () -> ::String
         end
 
         interface _RailsRouteApp
@@ -27,22 +27,17 @@ module Datadog
           def routes: () -> untyped
         end
 
-        class RailsRoutesSerializer
-          FORMAT_SUFFIX: String
-
-          @routes: Array[_RailsRoute]
-
-          def initialize: (Array[_RailsRoute] routes) -> void
-
-          def to_enum: () -> Enumerator[Core::Telemetry::Event::AppEndpointsLoaded::endpoint]
-
-          def serialize_route: (_RailsRoute route) -> Core::Telemetry::Event::AppEndpointsLoaded::endpoint
-
-          private
+        interface _GrapeRoute
+          def request_method: () -> String
+          def pattern: () -> _GrapeRoutePattern
+        end
 
-          def grape_app?: (_RackApp rack_app) -> bool
+        interface _GrapeRoutePattern
+          def origin: () -> String
+        end
 
-          def sinatra_app?: (_RackApp rack_app) -> bool
+        interface _SinatraRoute
+          def safe_string: () -> String
         end
       end
     end

lib/datadog/appsec/api_security/endpoint_collection/sinatra_routes_serializer.rb

@@ -0,0 +1,11 @@
+module Datadog
+  module AppSec
+    module APISecurity
+      module EndpointCollection
+        module GrapeRouteSerializer
+          def self?.serialize: (_GrapeRoute route, ?path_prefix: ::String) -> Core::Telemetry::Event::AppEndpointsLoaded::endpoint
+        end
+      end
+    end
+  end
+end