bugsnag-maze-runner 8.13.2 → 8.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b19202c96a1340f0752e1ad4f565b45d84d07ce75ee71961bd55387c63135d7e
-  data.tar.gz: 40afc99e0843a9bed7978e5fd0f41d748e11ebfdde5f341fbd23cef8bf1b95db
+  metadata.gz: dd153df2adf96e3f771d981af1bc7daa36e48c08caed9493d52f5ed8a49e2f7b
+  data.tar.gz: ba2b8ffa6ab47ee37eaba88cdce0e86a8e0e28c6f79941651062c9260812bd5c
 SHA512:
-  metadata.gz: ed33f57a999f5f98ee62b90fbd2817f6b6a80c0fc025ff451bd1bbf1ebf4204289ccd0c1c11816afcd1cf2b2147dcf0e28fb9c137c2a7fea2bb698ef7d155ab8
-  data.tar.gz: d824d91a62bd68851b60b167a625f399141c5c3f4e41e557810fb6e346987d63b7fc1cd28bed8dc94eda4556a45d944c7a36da9f0ba0daaaf8711156d32f5495
+  metadata.gz: fddd6897ee26a623f296e4c5504869926cddb9d6e557ae054286d6551f7840755b81599816a4c2c5f670cb124815361514f41f27f0f029fb1c4d1892cd7f44b8
+  data.tar.gz: 9323a020df074f37c128b03f932200dcbf1c81fc54eb32df7e3ea675c7b61c3e1a94203a89a26c7c425f62debd1936510fea19d94d51cd7d0af24acdba23585b

data/bin/maze-runner

@@ -54,6 +54,7 @@ require_relative '../lib/maze/runner'
 require_relative '../lib/maze/terminating_server'
 
 require_relative '../lib/maze/servlets/base_servlet'
+require_relative '../lib/maze/servlets/all_commands_servlet'
 require_relative '../lib/maze/servlets/command_servlet'
 require_relative '../lib/maze/servlets/servlet'
 require_relative '../lib/maze/servlets/log_servlet'

data/lib/maze/helper.rb

@@ -109,6 +109,7 @@ module Maze
       # Logs the given message and exits the program with a failure status
       def error_exit(message)
         $logger.error message
+        Bugsnag.notify(message)
         exit false
       end
 

data/lib/maze/request_list.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'securerandom'
 
 module Maze
   # An abstraction for storing a list of requests (e.g. Errors, Sessions),
@@ -24,7 +25,11 @@ module Maze
     #
     # @param request The new request, from which a clone is made
     def add(request)
-      @requests.append request.clone
+      clone = request.clone
+      # UUID primarily used for commands, but no harm to set on everything
+      clone[:uuid] = SecureRandom.uuid
+      clone[:run_uuid] = Maze.run_uuid
+      @requests.append clone
       @count += 1
     end
 
@@ -33,6 +38,11 @@ module Maze
       @requests[@current] if @requests.size > @current
     end
 
+    # The request at the given index
+    def get(index)
+      @requests[index] if @requests.size > index
+    end
+
     # Peek at requests yet to be processed - i.e. from current onwards.  All requests are left visible in the list.
     # Returns an empty array if there are no requests outstanding.
     def remaining

data/lib/maze/server.rb

@@ -2,7 +2,6 @@
 
 require 'bugsnag'
 require 'json'
-require 'securerandom'
 require 'webrick'
 require_relative './logger'
 require_relative './request_list'
@@ -223,6 +222,7 @@ module Maze
             server.mount '/ndk-symbol', Servlets::Servlet, :sourcemaps
             server.mount '/proguard', Servlets::Servlet, :sourcemaps
             server.mount '/command', Servlets::CommandServlet
+            server.mount '/commands', Servlets::AllCommandsServlet
             server.mount '/logs', Servlets::LogServlet
             server.mount '/metrics', Servlets::Servlet, :metrics
             server.mount '/reflect', Servlets::ReflectiveServlet

data/lib/maze/servlets/all_commands_servlet.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Maze
+  module Servlets
+
+    # Allows clients to queue up "commands", in the form of Ruby hashes, using Maze::Server.commands.add.  GET
+    # requests made to the /command endpoint will then respond with each queued command in turn.
+    class AllCommandsServlet < BaseServlet
+      # Serves all commands held.
+      #
+      # @param request [HTTPRequest] The incoming GET request
+      # @param response [HTTPResponse] The response to return
+      def do_GET(request, response)
+        commands = Maze::Server.commands.all
+
+        command_json = JSON.pretty_generate(commands)
+        response.body = command_json
+        response.status = 200
+
+        response.header['Access-Control-Allow-Origin'] = '*'
+      end
+
+      # Logs and returns a set of valid headers for this servlet.
+      #
+      # @param request [HTTPRequest] The incoming GET request
+      # @param response [HTTPResponse] The response to return
+      def do_OPTIONS(request, response)
+        super
+
+        response.header['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
+        response.status = Server.status_code('OPTIONS')
+      end
+    end
+  end
+end
+
+

data/lib/maze/servlets/command_servlet.rb

@@ -8,25 +8,69 @@ module Maze
     # Allows clients to queue up "commands", in the form of Ruby hashes, using Maze::Server.commands.add.  GET
     # requests made to the /command endpoint will then respond with each queued command in turn.
     class CommandServlet < BaseServlet
+
+      NOOP_COMMAND = '{"action": "noop", "message": "No commands queued"}'
+
       # Serves the next command, if these is one.
       #
-      # @param _request [HTTPRequest] The incoming GET request
+      # @param request [HTTPRequest] The incoming GET request
       # @param response [HTTPResponse] The response to return
-      def do_GET(_request, response)
+      def do_GET(request, response)
+
+        if request.query.empty?
+          # Non-idempotent mode - return the "current" command
+          commands = Maze::Server.commands
+
+          if commands.size_remaining == 0
+            response.body = NOOP_COMMAND
+            response.status = 200
+          else
+            command = commands.current
+            response.body = JSON.pretty_generate(command)
+            response.status = 200
+            commands.next
+          end
+        else
+          $logger.info "request.query = #{request.query}"
+
+
+          # Idempotent mode
+          after_uuid = request.query['after']
+          if after_uuid.nil?
+            response.body = "'after' is the only recognised query parameter"
+            response.status = 400
+          else
+            command_after(after_uuid, response)
+          end
+        end
+
         response.header['Access-Control-Allow-Origin'] = '*'
+      end
 
+      def command_after(uuid, response)
         commands = Maze::Server.commands
-
-        if commands.size_remaining == 0
-          response.body = '{"action": "noop", "message": "No commands queued"}'
-          response.status = 200
+        if uuid.empty?
+          index = -1
+        else
+          index = commands.all.find_index {|command| command[:uuid] == uuid }
+        end
+        if index.nil?
+          msg = "Request invalid - there is no command with a UUID of #{uuid} to follow on from"
+          $logger.error msg
+          response.body = msg
+          response.status = 400
         else
-          command = commands.current
-          command_json = JSON.pretty_generate(command)
-          command[:uuid] = Maze.run_uuid
-          response.body = command_json
-          response.status = 200
-          commands.next
+          if index + 1 < commands.size_all
+            # Respond with the next command in the queue
+            command = commands.get(index + 1)
+            command_json = JSON.pretty_generate(command)
+            response.body = command_json
+            response.status = 200
+          else
+            # The UUID given was for the last command in the list
+            response.body = NOOP_COMMAND
+            response.status = 200
+          end
         end
       end
 

data/lib/maze.rb

@@ -7,7 +7,7 @@ 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 = '8.13.2'
+  VERSION = '8.14.0'
 
   class << self
     attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-maze-runner
 version: !ruby/object:Gem::Version
-  version: 8.13.2
+  version: 8.14.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2023-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -436,6 +436,7 @@ files:
 - lib/maze/schemas/trace_validator.rb
 - lib/maze/schemas/validator.rb
 - lib/maze/server.rb
+- lib/maze/servlets/all_commands_servlet.rb
 - lib/maze/servlets/base_servlet.rb
 - lib/maze/servlets/command_servlet.rb
 - lib/maze/servlets/log_servlet.rb