bugsnag-maze-runner 6.27.0 → 7.23.0

data/lib/maze/server.rb

@@ -9,44 +9,63 @@ require_relative './request_list'
 module Maze
   # Receives and stores requests through a WEBrick HTTPServer
   class Server
+    ALLOWED_HTTP_VERBS = %w[OPTIONS GET POST PUT DELETE HEAD TRACE PATCH CONNECT]
+    DEFAULT_RESPONSE_DELAY = 0
+    DEFAULT_SAMPLING_PROBABILITY = 1
+    DEFAULT_STATUS_CODE = 200
 
     class << self
-      # Allows overwriting of the server status code
-      attr_writer :status_code
-
-      # Dictates if the status code should be reset after use
-      attr_writer :reset_status_code
-
-      # Allows a delay in milliseconds before responding to HTTP requests to be set
-      attr_writer :response_delay_ms
+      # Sets the response delay generator.
+      #
+      # @param generator [Maze::Generator] The new generator
+      def set_response_delay_generator(generator)
+        @response_delay_generator&.close
+        @response_delay_generator = generator
+      end
 
-      # Dictates if the response delay should be reset after use
-      attr_writer :reset_response_delay
+      # Sets the sampling probability generator.
+      #
+      # @param generator [Maze::Generator] The new generator
+      def set_sampling_probability_generator(generator)
+        @sampling_probability_generator&.close
+        @sampling_probability_generator = generator
+      end
 
-      # @return [String] The UUID attached to all command requests for this session
-      attr_reader :command_uuid
+      # Sets the status code generator for the HTTP verb given.  If no verb is given then the
+      # generator will be shared across all allowable HTTP verbs.
+      #
+      # @param generator [Maze::Generator] The new generator
+      # @param verb [String] HTTP verb
+      def set_status_code_generator(generator, verb = nil)
+        @status_code_generators ||= {}
+        Array(verb || ALLOWED_HTTP_VERBS).each do |verb|
+          old = @status_code_generators[verb]
+          @status_code_generators[verb] = generator
+
+          # Close the old generator unless it's still being used by another verb
+          old&.close unless @status_code_generators.value?(old)
+        end
+      end
 
       # The intended HTTP status code on a successful request
       #
-      # @return [Integer] The HTTP status code, defaults to 200
-      def status_code
-        code = @status_code ||= 200
-        @status_code = 200 if reset_status_code
-        code
+      # @param verb [String] HTTP verb for which the status code is wanted
+      #
+      # @return [Integer] The HTTP status code for the verb given
+      def status_code(verb)
+        if @status_code_generators[verb].nil? || @status_code_generators[verb].closed?
+          DEFAULT_STATUS_CODE
+        else
+          @status_code_generators[verb].next
+        end
       end
 
-      def reset_status_code
-        @reset_status_code ||= false
+      def sampling_probability
+        @sampling_probability_generator.next
       end
 
       def response_delay_ms
-        delay = @response_delay_ms ||= 0
-        @response_delay_ms = 0 if reset_response_delay
-        delay
-      end
-
-      def reset_response_delay
-        @reset_response_delay ||= false
+        @response_delay_generator.next
       end
 
       # Provides dynamic access to request lists by name
@@ -64,6 +83,8 @@ module Maze
           builds
         when 'log', 'logs'
           logs
+        when 'trace', 'traces'
+          traces
         when 'upload', 'uploads'
           uploads
         when 'sourcemap', 'sourcemaps'
@@ -89,6 +110,13 @@ module Maze
         @sessions ||= RequestList.new
       end
 
+      # A list of trace requests received
+      #
+      # @return [RequestList] Received error requests
+      def traces
+        @traces ||= RequestList.new
+      end
+
       # A list of build requests received
       #
       # @return [RequestList] Received build requests
@@ -145,9 +173,6 @@ module Maze
       # Starts the WEBrick server in a separate thread
       def start
         attempts = 0
-        $logger.info 'Starting mock server'
-        @command_uuid = SecureRandom.uuid
-        $logger.info "Fixture commands UUID: #{@command_uuid}"
         loop do
 
           @thread = Thread.new do
@@ -161,7 +186,7 @@ module Maze
 
             # Mount a block to respond to all requests with status:200
             server.mount_proc '/' do |_request, response|
-              $logger.info 'Received request on server root, responding with 200'
+              $logger.debug 'Received request on server root, responding with 200'
               response.header['Access-Control-Allow-Origin'] = '*'
               response.body = 'Maze runner received request'
               response.status = 200
@@ -173,9 +198,11 @@ module Maze
             server.mount '/builds', Servlets::Servlet, :builds
             server.mount '/uploads', Servlets::Servlet, :uploads
             server.mount '/sourcemap', Servlets::Servlet, :sourcemaps
+            server.mount '/traces', Servlets::TraceServlet, :traces, Maze::Schemas::TRACE_SCHEMA
             server.mount '/react-native-source-map', Servlets::Servlet, :sourcemaps
             server.mount '/command', Servlets::CommandServlet
             server.mount '/logs', Servlets::LogServlet
+            server.mount '/reflect', Servlets::ReflectiveServlet
             server.start
           rescue StandardError => e
             $logger.warn "Failed to start mock server: #{e.message}"
@@ -202,6 +229,23 @@ module Maze
         @thread&.kill if @thread&.alive?
         @thread = nil
       end
+
+      def reset!
+        # Reset generators
+        set_response_delay_generator(Maze::Generator.new [DEFAULT_RESPONSE_DELAY].cycle)
+        set_status_code_generator(Maze::Generator.new [DEFAULT_STATUS_CODE].cycle)
+        set_sampling_probability_generator(Maze::Generator.new [DEFAULT_SAMPLING_PROBABILITY].cycle)
+
+        # Clear request lists
+        errors.clear
+        sessions.clear
+        builds.clear
+        uploads.clear
+        sourcemaps.clear
+        traces.clear
+        logs.clear
+        invalid_requests.clear
+      end
     end
   end
 end

data/lib/maze/servlets/base_servlet.rb

@@ -11,11 +11,16 @@ module Maze
       # @param response [HTTPResponse] The response to return
       def do_OPTIONS(request, response)
         response.header['Access-Control-Allow-Origin'] = '*'
-        response.header['Access-Control-Allow-Headers'] = %w[Accept
-                                                             Bugsnag-Api-Key Bugsnag-Integrity
-                                                             Bugsnag-Payload-Version
-                                                             Bugsnag-Sent-At Content-Type
-                                                             Origin].join(',')
+        response.header['Access-Control-Allow-Headers'] = %w[
+          Accept
+          Bugsnag-Api-Key
+          Bugsnag-Integrity
+          Bugsnag-Payload-Version
+          Bugsnag-Sent-At
+          Bugsnag-Span-Sampling
+          Content-Type
+          Origin
+        ].join(',')
       end
     end
   end

data/lib/maze/servlets/command_servlet.rb

@@ -16,14 +16,15 @@ module Maze
         response.header['Access-Control-Allow-Origin'] = '*'
 
         commands = Maze::Server.commands
-        # Note that empty? is not the same as size == 0 (design bug to be corrected in v7)
-        if commands.size == 0
-          response.body = 'No commands to provide'
-          response.status = 400
+
+        if commands.size_remaining == 0
+          response.body = '{"action": "noop", "message": "No commands queued"}'
+          response.status = 200
         else
           command = commands.current
-          command[:uuid] = Maze::Server.command_uuid
-          response.body = JSON.pretty_generate(command)
+          command_json = JSON.pretty_generate(command)
+          command[:uuid] = Maze.run_uuid
+          response.body = command_json
           response.status = 200
           commands.next
         end
@@ -37,8 +38,10 @@ module Maze
         super
 
         response.header['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
-        response.status = Server.status_code
+        response.status = Server.status_code('OPTIONS')
       end
     end
   end
 end
+
+

data/lib/maze/servlets/log_servlet.rb

@@ -27,7 +27,7 @@ module Maze
         @requests.add(hash)
 
         response.header['Access-Control-Allow-Origin'] = '*'
-        response.status = Server.status_code
+        response.status = Server.status_code('POST')
       rescue JSON::ParserError => e
         msg = "Unable to parse request as JSON: #{e.message}"
         $logger.error msg
@@ -57,7 +57,7 @@ module Maze
         super
 
         response.header['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
-        response.status = Server.status_code
+        response.status = Server.status_code('OPTIONS')
       end
     end
   end

data/lib/maze/servlets/reflective_servlet.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'rack'
 
 module Maze
   module Servlets
@@ -7,7 +8,7 @@ module Maze
     # - status - HTTP response code
     # For GET requests these are expected to passed as GET parameters,
     # for POST requests they are expected to be given as JSON fields.
-    class ReflectiveServlet < WEBrick::HTTPServlet::AbstractServlet
+    class ReflectiveServlet < BaseServlet
 
       # Accepts a GET request to provide a reflective response to.
       #
@@ -26,17 +27,17 @@ module Maze
       def do_POST(request, response)
 
         content_type = request['Content-Type']
-        unless content_type == 'application/json'
-          msg = "Content-Type '#{content_type}' not supported - only application/json is supported at present"
-          $logger.error msg
-          response.status = 415
-          response.body = msg
-          return
-        end
 
-        body = JSON.parse(request.body)
-        delay_ms = body['delay_ms']
-        status = body['status']
+        # For JSON, pull the instructions from the body.  Otherwise, take them from the query string.
+        if content_type == 'application/json'
+          body = JSON.parse(request.body)
+          delay_ms = body['delay_ms']
+          status = body['status']
+        else
+          query = Rack::Utils.parse_nested_query(request.query_string)
+          delay_ms = query['delay_ms']
+          status = query['status']
+        end
 
         reflect response, delay_ms, status
       rescue JSON::ParserError => e

data/lib/maze/servlets/servlet.rb

@@ -1,18 +1,45 @@
 # frozen_string_literal: true
 
+require 'zlib'
+require 'stringio'
+require 'json_schemer'
+require 'delegate'
+
 module Maze
+  class HttpRequest < SimpleDelegator
+    def body
+      @body ||= decode_body
+    end
+
+    private
+
+    def decode_body
+      delegate = __getobj__
+      if %r{^gzip$}.match(delegate['Content-Encoding'])
+        gz_element = Zlib::GzipReader.new(StringIO.new(delegate.body))
+        gz_element.read
+      else
+        delegate.body
+      end
+    end
+  end
+
   module Servlets
 
     # Receives and parses the requests and payloads sent from the test fixture
     class Servlet < BaseServlet
+      prepend RequestRepeater
+
       # Constructor
       #
       # @param server [HTTPServer] WEBrick HTTPServer
       # @param request_type [Symbol] Request type that the servlet will receive
-      def initialize(server, request_type)
+      # @param schema [Dictionary] A `json-schema` describing the payload for POST requests
+      def initialize(server, request_type, schema=nil)
         super server
         @request_type = request_type
         @requests = Server.list_for request_type
+        @schema = JSONSchemer.schema(schema) unless schema.nil?
       end
 
       # Logs an incoming GET WEBrick request.
@@ -30,9 +57,11 @@ module Maze
       # @param request [HTTPRequest] The incoming GET request
       # @param response [HTTPResponse] The response to return
       def do_POST(request, response)
-        log_request(request)
-        case request['Content-Type']
-        when %r{^multipart/form-data; boundary=([^;]+)}
+        # Turn the WEBrick HttpRequest into our internal HttpRequest delegate
+        request = HttpRequest.new(request)
+
+        content_type = request['Content-Type']
+        if %r{^multipart/form-data; boundary=([^;]+)}.match(content_type)
           boundary = WEBrick::HTTPUtils::dequote($1)
           body = WEBrick::HTTPUtils.parse_form_data(request.body, boundary)
           hash = {
@@ -50,6 +79,10 @@ module Maze
             digests: digests
           }
         end
+        if @schema
+          schema_errors = @schema.validate(hash[:body])
+          hash[:schema_errors] = schema_errors.to_a
+        end
         @requests.add(hash)
 
         # For the response, delaying if configured to do so
@@ -58,8 +91,8 @@ module Maze
           $logger.info "Waiting #{response_delay_ms} milliseconds before responding"
           sleep response_delay_ms / 1000.0
         end
-        response.header['Access-Control-Allow-Origin'] = '*'
-        response.status = Server.status_code
+        set_response_header response.header
+        response.status = Server.status_code('POST')
       rescue JSON::ParserError => e
         msg = "Unable to parse request as JSON: #{e.message}"
         if Maze.config.captured_invalid_requests.include? @request_type
@@ -89,6 +122,10 @@ module Maze
         end
       end
 
+      def set_response_header(header)
+        header['Access-Control-Allow-Origin'] = '*'
+      end
+
       # Logs and returns a set of valid headers for this servlet.
       #
       # @param request [HTTPRequest] The incoming GET request
@@ -97,7 +134,7 @@ module Maze
         super
 
         response.header['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
-        response.status = Server.status_code
+        response.status = Server.status_code('OPTIONS')
       end
 
       private
@@ -116,8 +153,10 @@ module Maze
           body = WEBrick::HTTPUtils.parse_form_data(request.body, boundary)
           $logger.debug 'BODY:'
           LogUtil.log_hash(Logger::Severity::DEBUG, body)
-        else
+        when %r{^application/json$}
           $logger.debug "BODY: #{JSON.pretty_generate(JSON.parse(request.body))}"
+        else
+          $logger.debug "BODY: #{request.body}"
         end
       end
 

data/lib/maze/servlets/trace_servlet.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Maze
+  module Servlets
+    class TraceServlet < Servlet
+      def set_response_header(header)
+        super
+        value = Maze::Server.sampling_probability
+        header['Bugsnag-Sampling-Probability'] =  value unless value == 'null'
+      end
+    end
+  end
+end

data/lib/maze.rb

@@ -7,10 +7,10 @@ require_relative 'maze/timers'
 # Glues the various parts of MazeRunner together that need to be accessed globally,
 # providing an alternative to the proliferation of global variables or singletons.
 module Maze
-  VERSION = '6.27.0'
+  VERSION = '7.23.0'
 
   class << self
-    attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry
+    attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address, :run_uuid
 
     def config
       @config ||= Maze::Configuration.new

data/lib/utils/deep_merge.rb

@@ -0,0 +1,17 @@
+class Hash
+  def deep_merge!(other_hash, &block)
+    merge!(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge(other_val, &block)
+      elsif block_given?
+        block.call(key, this_val, other_val)
+      else
+        other_val
+      end
+    end
+  end
+
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash, &block)
+  end
+end

data/lib/utils/selenium_money_patch.rb

@@ -0,0 +1,17 @@
+# Log the full response so we see more than just the error code
+module Selenium
+  module WebDriver
+    module Error
+      class ServerError < StandardError
+        def initialize(response)
+          if response.is_a? String
+            super(response)
+          else
+            $logger.error "Server response: #{response.inspect}"
+            super("status code #{response.code}")
+          end
+        end
+      end # ServerError
+    end # Error
+  end # WebDriver
+end # Selenium