bugsnag-maze-runner 10.7.3 → 10.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 460723532ac7cdbb236e248fcc171b87641be8c480c190c9ae9d36acf1fe8f0b
-  data.tar.gz: a5796d5ee2b0e5882c4c8d552a905e08b724e325561d7cda01dbe6c4815c3011
+  metadata.gz: 0de79ce31a9a1b66dfca934d16fb84e0c80ac5a4c5e879e993832f53f9d92c06
+  data.tar.gz: f92ab806fac107be92713d90b346b5dda5d326d7b1cbbbfc8c8a247acfceeb5d
 SHA512:
-  metadata.gz: 776888ccd312f6754f91b2816abc8cc2bbeeb0e21fdee5de6eede8fb67d0dacf0d13de47896d5914b0950445aff259e638ffb9576dac9fed79ce3a5c8beeab49
-  data.tar.gz: 0337eabade7c9431d0b917f23b416aef835852ad57235d7e910366a239992554cc8d3a83ca11f2cf0cd2ffe15f8972c3d97be518c55262351adbdf5ba0f9fbe1
+  metadata.gz: a6473e52c80d43cea5b5ee4f9dd49e5caf6db7f849bc926e032fc080c74ec69180553ab2d3973f6dc90028f6cb4ed8c3f0c7f98a6484e9d2e9110a00f4a87b51
+  data.tar.gz: 5ce8ec5e75ef9b22460bae6f767d5a9ecc1394c2b53fe70b4273bd8ce7a77b591a2a71b32ba80d101bebfb30356c73d43a0bc20c58d91c3b40997384f8743dd1

data/bin/maze-runner

@@ -18,6 +18,11 @@ require_relative '../lib/maze/api/appium/file_manager'
 require_relative '../lib/maze/api/appium/ui_manager'
 require_relative '../lib/maze/api/cucumber/scenario'
 require_relative '../lib/maze/api/exit_code'
+require_relative '../lib/maze/api/model/span'
+require_relative '../lib/maze/api/model/span_kind'
+require_relative '../lib/maze/api/model/span_set'
+require_relative '../lib/maze/api/model/otel_attribute'
+require_relative '../lib/maze/api/model/otel_attribute_type'
 require_relative '../lib/maze/error_monitor/selenium_error_middleware'
 require_relative '../lib/maze/error_monitor/assert_error_middleware'
 require_relative '../lib/maze/error_monitor/config'

data/lib/features/support/internal_hooks.rb

@@ -172,7 +172,7 @@ After do |scenario|
   $success = !scenario.failed?
 
   # Log all received requests to file
-  Maze::MazeOutput.new(scenario).write_requests if Maze.config.file_log
+  Maze::MazeOutput.new(scenario).write_requests_and_spans if Maze.config.file_log
 
   # Invoke the internal hook for the mode of operation
   Maze.internal_hooks.after scenario

data/lib/features/support/span_support.rb

@@ -33,25 +33,33 @@ class SpanSupport
       assert_received_spans(minimum, maximum)
     end
 
+    def received_spans_names
+      spans = spans_from_request_list(Maze::Server.traces)
+      names spans.map { |span| span['name'] }
+
+    end
+
     def assert_received_named_span(span_name)
       timeout = Maze.config.receive_requests_wait
       wait = Maze::Wait.new(timeout: timeout)
-
       received = wait.until { SpanSupport.named_span_exists?(span_name) }
 
+      spans = Maze::Api::Model::SpanSet.new
       list = Maze::Server.traces
-      received_count = SpanSupport.spans_from_request_list(list).size
+      list.remaining.each { |t| spans.add_from_trace_hash(t[:body]) }
+      names = spans.size == 0 ? '.' : ", with names:\n#{spans.names.sort.join("\n")}"
 
       unless received
         raise Test::Unit::AssertionFailedError.new <<-MESSAGE
-Expected span with name #{span_name} not received within the #{timeout}s timeout (#{received_count} spans were received)}.
+Expected span with name #{span_name} not received within the #{timeout}s timeout.  #{spans.size} spans were received#{names}
+
 This could indicate that:
 - Bugsnag crashed with a fatal error.
 - Bugsnag did not make the requests that it should have done.
 - The requests were made, but not deemed to be valid (e.g. missing integrity header).
 - The requests made were prevented from being received due to a network or other infrastructure issue.
 Please check the Maze Runner and device logs to confirm.)
-MESSAGE
+        MESSAGE
       end
 
       Maze::Schemas::Validator.validate_payload_elements(list, 'trace')
@@ -73,7 +81,7 @@ This could indicate that:
 - The requests were made, but not deemed to be valid (e.g. missing integrity header).
 - The requests made were prevented from being received due to a network or other infrastructure issue.
 Please check the Maze Runner and device logs to confirm.)
-MESSAGE
+        MESSAGE
       end
 
       Maze.check.operator(max_received, :>=, received_count, "#{received_count} spans received") if max_received

data/lib/maze/api/model/otel_attribute.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+require_relative 'otel_attribute_type'
+
+module Maze
+  module Api
+    module Model
+      # Element of an OTEL attribute array.
+      class OtelAttributeArrayElement
+        attr_accessor :type, :value
+
+        def initialize(type, value)
+          @type = type
+          @value = value
+        end
+      end
+
+      # OTEL attributes used in both spans and resources
+      class OtelAttribute
+        attr_accessor :type, :key, :value
+
+        def initialize(type, key, value)
+          @key = key
+          @type = type
+          @value = value
+        end
+
+        class << self
+          # Create an array of OtelAttributeArrayElement from a hash array.
+          # @param hash_array [Array<Hash>] Array of hashes representing attribute values.
+          # @return [Array<OtelAttributeArrayElement>] Array of OtelAttributeArrayElement objects.
+          def array_from_hash(hash_array)
+            array = []
+            hash_array.each do |value_hash|
+              type = OtelAttributeType::for_string(value_hash.keys.first)
+              value = value_hash.values.first
+              array << OtelAttributeArrayElement.new(type, value)
+            end
+            array
+          end
+
+          # Create an OtelAttribute from a hash.
+          # @param hash [Hash] Hash representing an OTEL attribute.
+          # @return [OtelAttribute] OtelAttribute object.
+          def from_hash(hash)
+            type = OtelAttributeType.for_string(hash['value'].keys.first)
+            hash_value = hash['value']
+            value = if hash_value.has_key?('arrayValue')
+              array_from_hash(hash_value['arrayValue']['values'])
+            elsif hash_value.has_key?('boolValue')
+              hash_value['boolValue']
+            elsif hash_value.has_key?('doubleValue')
+              hash_value['doubleValue']
+            elsif hash_value.has_key?('intValue')
+              hash_value['intValue']
+            elsif hash_value.has_key?('stringValue')
+              hash_value['stringValue']
+            end
+
+            new(
+              type,
+              hash['key'],
+              value
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maze/api/model/otel_attribute_type.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Maze
+  module Api
+    module Model
+      # OTEL attribute types.
+      module OtelAttributeType
+        ARRAY = 0
+        BOOL = 1
+        DOUBLE = 2
+        INT = 3
+        STRING = 4
+
+        # Get the OTEL attribute type constant for a given string.
+        # @param type_string [String] OTEL attribute type as a string.
+        # @return [Integer, nil] OTEL attribute type constant or nil if not found.
+        def self.for_string(type_string)
+          case type_string
+          when 'arrayValue'
+            ARRAY
+          when 'boolValue'
+            BOOL
+          when 'doubleValue'
+            DOUBLE
+          when 'intValue'
+            INT
+          when 'stringValue'
+            STRING
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maze/api/model/span.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'otel_attribute'
+
+module Maze
+  module Api
+    module Model
+      # A single OTEL span.
+      class Span
+        attr_accessor :id, :kind, :name, :trace_id, :start_time, :end_time, :attributes
+
+        def initialize
+          @attributes = {}
+
+          def add_attribute(attribute)
+            @attributes[attribute.key] = attribute
+          end
+        end
+
+        class << self
+          # Create a Span from a hash.
+          # @param hash [Hash] Hash representing an OTEL span.
+          # @return [Span] Span object.
+          def from_hash(hash)
+            span = new
+            span.id = hash['spanId']
+            span.kind = hash['kind']
+            span.name = hash['name']
+            span.trace_id = hash['traceId']
+            span.start_time = hash['startTimeUnixNano']
+            span.end_time = hash['endTimeUnixNano']
+
+            hash['attributes'].each do |attribute_hash|
+              attribute = OtelAttribute.from_hash(attribute_hash)
+              span.add_attribute(attribute)
+            end
+
+            span
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maze/api/model/span_kind.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Maze
+  module Api
+    module Model
+      # OTEL span kinds.
+      module SpanKind
+        UNSPECIFIED = 0
+        INTERNAL = 1
+        SERVER = 2
+        CLIENT = 3
+        PRODUCER = 4
+        CONSUMER = 5
+      end
+    end
+  end
+end

data/lib/maze/api/model/span_set.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative 'span'
+
+module Maze
+  module Api
+    module Model
+      # A collection of spans, typically representing one or more traces.
+      class SpanSet
+        def initialize
+          @spans = {}
+        end
+
+        # @param span [Maze::Api::Model::Span] Span to add to the SpanSet.
+        def add(span)
+          @spans[span.id] = span
+        end
+
+        # Add spans from a trace hash to the SpanSet.
+        # @param trace_hash [Hash] Trace request payload as a hash.
+        def add_from_trace_hash(trace_hash)
+          SpanSet.add_trace_hash(trace_hash, self)
+        end
+
+        # @param span_id [String] Id of the span to remove from the SpanSet.
+        def remove(span_id)
+          @spans.delete(span_id)
+        end
+
+        # @return [Integer] Number of spans in the SpanSet.
+        def size
+          @spans.size
+        end
+
+        # @return [Array<String>] List of span names in the SpanSet.
+        def names
+          @spans.values.map(&:name)
+        end
+
+        class << self
+          # Creates a new SpanSet from a trace hash.
+          # @param trace_hash [Hash] Trace request payload as a hash.
+          def from_trace_hash(trace_hash)
+            span_set = Maze::Api::Model::SpanSet.new
+            add_trace_hash(trace_hash, span_set)
+            span_set
+          end
+
+          # Adds spans from a trace hash to an existing SpanSet.
+          # @param trace_hash [Hash] Trace request payload as a hash.
+          # @param span_set [Maze::Api::Model::SpanSet] SpanSet to add spans to.
+          def add_trace_hash(trace_hash, span_set)
+            spans = trace_hash['resourceSpans'].flat_map { |r| r['scopeSpans'] }
+                                               .flat_map { |s| s['spans'] }
+                                               .select { |s| !s.nil? }
+
+            spans.each do |span_hash|
+              span = Maze::Api::Model::Span.from_hash(span_hash)
+              span_set.add(span)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maze/interactive_cli.rb

@@ -19,7 +19,10 @@ module Maze
 
     # @!attribute [r] current_buffer
     #   @return [String] A string representation of the current output present in the terminal
-    attr_reader :current_buffer
+    # attr_reader :current_buffer
+    def current_buffer
+      strip_nonprintable(@current_buffer)
+    end
 
     # Creates an InteractiveCLI instance
     #
@@ -169,5 +172,10 @@ module Maze
       # @boring.scrub(line.strip)
       line.strip
     end
+
+    def strip_nonprintable(str)
+      # keep: space..tilde, Tab, CR, LF
+      str.gsub(/[^\x20-\x7E\t\r\n]/, '')
+    end
   end
 end

data/lib/maze/maze_output.rb

@@ -7,6 +7,11 @@ module Maze
       @scenario = scenario
     end
 
+    def write_requests_and_spans
+      write_requests
+      write_spans
+    end
+
     # Writes each list of requests to a separate file under, e.g:
     # maze_output/failed/scenario_name/errors.log
     def write_requests
@@ -91,6 +96,49 @@ module Maze
       end
     end
 
+    # Writes each list of requests to a separate file under, e.g:
+    # maze_output/failed/scenario_name/errors.log
+    def write_spans
+      list = Maze::Server.traces.all
+      return if list.empty?
+
+      path = output_folder
+      filepath = File.join(path, 'spans.log')
+
+      File.open(filepath, 'w+') do |file|
+        spans = spans_from_request_list(list)
+
+        # File summary
+        file.puts "=== Spans Summary ==="
+        file.puts
+        file.puts "Id                Name"
+        spans.each do |span|
+          file.puts "#{span['spanId']}  #{span['name']}"
+        end
+        file.puts
+        file.puts
+
+        # Write the spans
+        counter = 1
+        spans.each do |span|
+          file.puts "=== Span #{counter} of #{spans.size} ==="
+          file.puts
+          file.puts JSON.pretty_generate(span)
+          file.puts
+          file.puts
+
+          counter += 1
+        end
+      end
+    end
+
+    def spans_from_request_list(list)
+      list.flat_map { |req| req[:body]['resourceSpans'] }
+          .flat_map { |r| r['scopeSpans'] }
+          .flat_map { |s| s['spans'] }
+          .select { |s| !s.nil? }
+    end
+
     # Determines the output folder for the scenario
     def output_folder
       folder1 = File.join(Dir.pwd, 'maze_output')

data/lib/maze/schemas/trace_validator.rb

@@ -18,25 +18,7 @@ module Maze
         @success = true
         verify_against_schema
         validate_headers
-        regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.spanId', HEX_STRING_16)
-        regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.traceId', HEX_STRING_32)
-        element_int_in_range('resourceSpans.0.scopeSpans.0.spans.0.kind', 0..5)
-        regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.startTimeUnixNano', '^[0-9]+$')
-        regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.endTimeUnixNano', '^[0-9]+$')
-        each_span_element_contains('resourceSpans.0.scopeSpans.0.spans', 'attributes', 'bugsnag.sampling.p')
-        span_element_contains('resourceSpans.0.resource.attributes', 'deployment.environment')
-        span_element_contains('resourceSpans.0.resource.attributes', 'telemetry.sdk.name')
-        span_element_contains('resourceSpans.0.resource.attributes', 'telemetry.sdk.version')
-        validate_timestamp('resourceSpans.0.scopeSpans.0.spans.0.startTimeUnixNano', HOUR_TOLERANCE)
-        validate_timestamp('resourceSpans.0.scopeSpans.0.spans.0.endTimeUnixNano', HOUR_TOLERANCE)
-        element_a_greater_or_equal_element_b(
-          'resourceSpans.0.scopeSpans.0.spans.0.endTimeUnixNano',
-          'resourceSpans.0.scopeSpans.0.spans.0.startTimeUnixNano'
-        )
-
-        if Maze.config.client_mode_validation
-          span_element_contains('resourceSpans.0.resource.attributes', 'device.id')
-        end
+        validate_fields
       end
 
       def verify_against_schema
@@ -84,6 +66,46 @@ module Maze
         end
       end
 
+      def validate_fields
+        resource_spans = Maze::Helper.read_key_path(@body, 'resourceSpans')
+
+        # Loop through all resource spans
+        (0...resource_spans.size).each do |rs|
+
+          if Maze.config.client_mode_validation
+            span_element_contains("resourceSpans.#{rs}.resource.attributes", 'device.id')
+          end
+          span_element_contains("resourceSpans.#{rs}.resource.attributes", 'deployment.environment')
+          span_element_contains("resourceSpans.#{rs}.resource.attributes", 'telemetry.sdk.name')
+          span_element_contains("resourceSpans.#{rs}.resource.attributes", 'telemetry.sdk.version')
+
+          # Loop through all scope spans
+          scope_spans = Maze::Helper.read_key_path(@body, "resourceSpans.#{rs}.scopeSpans")
+          (0...scope_spans.size).each do |ss|
+
+            each_span_element_contains("resourceSpans.#{rs}.scopeSpans.#{ss}.spans", 'attributes', 'bugsnag.sampling.p')
+
+            # Loop through all spans
+            spans = Maze::Helper.read_key_path(@body, "resourceSpans.#{rs}.scopeSpans.#{ss}.spans")
+            (0...spans.size).each do |s|
+
+              # Field validations
+              regex_comparison("resourceSpans.#{rs}.scopeSpans.#{ss}.spans.#{s}.spanId", HEX_STRING_16)
+              regex_comparison("resourceSpans.#{rs}.scopeSpans.#{ss}.spans.#{s}.traceId", HEX_STRING_32)
+              element_int_in_range("resourceSpans.#{rs}.scopeSpans.#{ss}.spans.#{s}.kind", 0..5)
+              regex_comparison("resourceSpans.#{rs}.scopeSpans.#{ss}.spans.#{s}.startTimeUnixNano", '^[0-9]+$')
+              regex_comparison("resourceSpans.#{rs}.scopeSpans.#{ss}.spans.#{s}.endTimeUnixNano", '^[0-9]+$')
+              validate_timestamp("resourceSpans.#{rs}.scopeSpans.#{ss}.spans.#{s}.startTimeUnixNano", HOUR_TOLERANCE)
+              validate_timestamp("resourceSpans.#{rs}.scopeSpans.#{ss}.spans.#{s}.endTimeUnixNano", HOUR_TOLERANCE)
+              element_a_greater_or_equal_element_b(
+                "resourceSpans.#{rs}.scopeSpans.#{ss}.spans.#{s}.endTimeUnixNano",
+                "resourceSpans.#{rs}.scopeSpans.#{ss}.spans.#{s}.startTimeUnixNano"
+              )
+            end
+          end
+        end
+      end
+
       def span_element_contains(path, key_value, value_type=nil, possible_values=nil)
         container = Maze::Helper.read_key_path(@body, path)
         if container.nil? || !container.kind_of?(Array)

data/lib/maze/schemas/validator_base.rb

@@ -129,7 +129,7 @@ module Maze
         time_in_nanos = Time.now.to_i * 1000000000
         unless (time_in_nanos - parsed_timestamp).abs < tolerance
           @success = false
-          @errors << "Timestamp was expected to be within #{tolerance} nanoseconds of the current time (#{time_in_nanos}), was '#{parsed_timestamp}'"
+          @errors << "Timestamp was expected to be within #{tolerance} nanoseconds of the current time (#{time_in_nanos}), was '#{timestamp}'"
         end
       end
 

data/lib/maze.rb

@@ -8,7 +8,7 @@ require_relative 'maze/timers'
 # providing an alternative to the proliferation of global variables or singletons.
 module Maze
 
-  VERSION = '10.7.3'
+  VERSION = '10.8.0'
 
   class << self
     attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-maze-runner
 version: !ruby/object:Gem::Version
-  version: 10.7.3
+  version: 10.8.0
 platform: ruby
 authors:
 - Steve Kirkland
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-17 00:00:00.000000000 Z
+date: 2025-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -221,6 +221,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.24
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -438,6 +452,11 @@ files:
 - lib/maze/api/appium/ui_manager.rb
 - lib/maze/api/cucumber/scenario.rb
 - lib/maze/api/exit_code.rb
+- lib/maze/api/model/otel_attribute.rb
+- lib/maze/api/model/otel_attribute_type.rb
+- lib/maze/api/model/span.rb
+- lib/maze/api/model/span_kind.rb
+- lib/maze/api/model/span_set.rb
 - lib/maze/appium_server.rb
 - lib/maze/assertions/request_set_assertions.rb
 - lib/maze/aws/sam.rb