Fix typing

Author: vpellan

lib/datadog/appsec/actions_handler.rb

@@ -24,23 +24,31 @@ def generate_stack(action_params)
         if Datadog.configuration.appsec.stack_trace.enabled
           context = AppSec::Context.active
           # We use methods defined in Tracing::Metadata::Tagging,
-          # which means we can work on both the trace and the service entry span
-          service_entry_operation = context && (context.trace || context.span)
+          # which means we can use both the trace and the service entry span
+          service_entry_operation = (context.trace || context.span) if context
 
           unless service_entry_operation
             Datadog.logger.debug { 'Cannot find trace or service entry span to add stack trace' }
             return
           end
 
+          # caller_locations without params always returns an array but steep still thinks it can be nil
+          # So we add || [] but it will never run the second part anyway (either this or steep:ignore)
           stack_frames = caller_locations || []
-          # caller_locations without params always returns an array but rbs still thinks it can be nil
-          stack_frames.reject! { |loc| loc.path && loc.path.include?('lib/datadog') }
+          # Steep that path can still be nil and that include? is not a method of nil
+          # A way to fix this is to assign loc.path to a variable and use it instead, but it adds an operation
+          # Which is why we are ignoring this line
+          stack_frames.reject! do |loc|
+            loc.path &&
+              loc.path.include?('lib/datadog') # steep:ignore NoMethod
+          end
 
           collected_stack_frames = AppSec::StackTrace::Collection.new(stack_frames)
 
           # ASCII-8BIT is encoded as byte array and backend cannot decode it properly so we enforce UTF-8 on stack_id.
           # We must copy it as it can be frozen.
-          utf8_stack_id = action_params['stack_id'] && action_params['stack_id'].encode('UTF-8')
+          utf8_stack_id = action_params['stack_id'].encode('UTF-8') if action_params['stack_id']
+          # We should always have a stack_id, but we should still send the stack trace if not (visible with feature flags)
           stack_trace = AppSec::StackTrace::Representation.new(utf8_stack_id, collected_stack_frames)
 
           # Add stack trace to trace or service entry span by modifying meta_struct['_dd.stack']

lib/datadog/appsec/stack_trace.rb

@@ -34,10 +34,14 @@ def initialize(frames)
               text: frame.to_s && frame.to_s.encode('UTF-8'),
               # path will show 'main' instead of the actual file
               # but absolute_path does not work for e.g. <internal:kernel>
-              file: (frame.absolute_path || frame.path) && (frame.absolute_path || frame.path).encode('UTF-8'),
+              # Steep says that label can still be nil and that include? is not a method of nil
+              # Which is why we are ignoring this line
+              file: (frame.absolute_path || frame.path) &&
+                (frame.absolute_path || frame.path).encode('UTF-8'), # steep:ignore
               line: frame.lineno,
               # label will show 'block in function' instead of just 'function'
-              function: frame.label && frame.label.encode('UTF-8')
+              function: frame.label &&
+                frame.label.encode('UTF-8') # steep:ignore
             )
           end
           @frames = cropped_frames

sig/datadog/appsec/context.rbs

@@ -13,9 +13,9 @@ module Datadog
 
       type input_data = SecurityEngine::Runner::input_data
 
-      @trace: Tracing::TraceOperation
+      @trace: Tracing::TraceOperation?
 
-      @span: Tracing::SpanOperation
+      @span: Tracing::SpanOperation?
 
       @events: ::Array[untyped]
 
@@ -29,9 +29,9 @@ module Datadog
 
       ActiveContextError: ::StandardError
 
-      attr_reader trace: Tracing::TraceOperation
+      attr_reader trace: Tracing::TraceOperation?
 
-      attr_reader span: Tracing::SpanOperation
+      attr_reader span: Tracing::SpanOperation?
 
       attr_reader events: ::Array[untyped]
 
@@ -41,7 +41,7 @@ module Datadog
 
       def self.deactivate: () -> void
 
-      def self.active: () -> Context
+      def self.active: () -> Context?
 
       def initialize: (Tracing::TraceOperation trace, Tracing::SpanOperation span, AppSec::Processor security_engine) -> void
 

sig/datadog/appsec/event.rbs

@@ -24,7 +24,7 @@ module Datadog
 
       def self.gzip: (untyped value) -> untyped
 
-      def self.add_distributed_tags: (Tracing::TraceOperation trace) -> void
+      def self.add_distributed_tags: (Tracing::TraceOperation? trace) -> void
     end
   end
 end

sig/datadog/appsec/stack_trace.rbs

@@ -1,21 +1,19 @@
 module Datadog
   module AppSec
-    class StackTrace
-      attr_reader id: String
-      attr_reader message: String?
-      attr_reader frames: Array[Frame]
+    module StackTrace
+      class Collection
+        include Enumerable[Frame]
 
-      @to_h: Hash[Symbol, untyped]
+        @frames: Array[Frame]
 
-      def initialize: (String id, Array[Thread::Backtrace::Location]? stack_trace, ?message: String?) -> void
+        def initialize: (Array[Thread::Backtrace::Location] frames) -> void
 
-      def to_h: () -> Hash[Symbol, untyped]
+        def each: () { (Frame) -> void } -> void
 
-      def self.include_stack_trace?: (Hash[String, untyped] action_params) -> bool
+        def []: (Integer index) -> Frame
 
-      private
-
-      def self.from_waf_result: (Hash[String, untyped] action_params) -> Datadog::AppSec::StackTrace
+        def to_msgpack: (::MessagePack::Packer | nil packer) -> ::MessagePack::Packer
+      end
 
       class Frame
         attr_reader id: Integer
@@ -29,6 +27,24 @@ module Datadog
         def initialize: (Integer id, ?text: String?, ?file: String?, ?line: Integer?, ?function: String?) -> void
 
         def to_h: () -> Hash[Symbol, untyped]
+
+        def to_msgpack: ((::MessagePack::Packer | nil) packer) -> ::MessagePack::Packer
+      end
+
+      class Representation
+        attr_reader id: String?
+        attr_reader stack_trace: Collection
+        attr_reader message: String?
+
+        @to_h: Hash[Symbol, String | Array[Hash[Symbol, untyped]] | nil]
+
+        def initialize: (String? id, Collection stack_trace, ?message: String?) -> void
+
+        def to_h: () -> Hash[Symbol, String | Array[Hash[Symbol, untyped]] | nil]
+
+        def to_msgpack: ((::MessagePack::Packer | nil) packer) -> ::MessagePack::Packer
+
+        def pretty_print: (PP q) -> void
       end
     end
   end

sig/datadog/tracing/metadata/tagging.rbs

@@ -8,17 +8,19 @@ module Datadog
         def get_tag: (untyped key) -> untyped
         def set_tag: (untyped key, ?untyped? value) -> untyped
         def set_tags: (untyped tags) -> untyped
+        def set_meta_struct_tags: (Hash[Symbol, untyped] hash) -> Hash[Symbol, untyped]
         def has_tag?: (untyped tag) -> untyped
         def clear_tag: (untyped key) -> untyped
         alias []= set_tag
         alias [] get_tag
         def get_metric: (untyped key) -> untyped
         def set_metric: (untyped key, untyped value) -> untyped
         def clear_metric: (untyped key) -> untyped
-        def get_struct_tag: (untyped key) -> untyped
-        def set_struct_tag: (untyped key, ?untyped? value) -> untyped
-        def has_struct_tag?: (untyped tag) -> untyped
-        def clear_struct_tag: (untyped key) -> untyped
+        def get_meta_struct_tag: (untyped key) -> untyped
+        def set_meta_struct_tag: (untyped key, untyped value) -> untyped
+        def modify_meta_struct_tag: (untyped key) { (untyped) -> untyped } -> untyped
+        def has_meta_struct_tag?: (untyped tag) -> untyped
+        def clear_meta_struct_tag: (untyped key) -> untyped
         def meta: () -> untyped
         def metrics: () -> untyped
         def meta_struct: () -> untyped

sig/datadog/tracing/span.rbs

@@ -26,7 +26,7 @@ module Datadog
           ?end_time: Time?,
           ?id: Integer?,
           ?meta: Hash[String, String]?,
-          ?meta_struct: Hash[String, untyped]?
+          ?meta_struct: Hash[String, untyped]?,
           ?metrics: Hash[String, Float]?,
           ?parent_id: Integer,
           ?resource: String,