puma 2.2.0 → 8.0.2

data/lib/puma/app/status.rb

@@ -1,55 +1,103 @@
+# frozen_string_literal: true
+require_relative '../json_serialization'
+
 module Puma
   module App
+    # Check out {#call}'s source code to see what actions this web application
+    # can respond to.
     class Status
-      def initialize(server, cli)
-        @server = server
-        @cli = cli
-        @auth_token = nil
-      end
       OK_STATUS = '{ "status": "ok" }'.freeze
+      READ_ONLY_COMMANDS = %w[gc-stats stats].freeze
 
-      attr_accessor :auth_token
-
-      def authenticate(env)
-        return true unless @auth_token
-        env['QUERY_STRING'].to_s.split(/&;/).include?("token=#{@auth_token}")
+      # @param launcher [::Puma::Launcher]
+      # @param token [String, nil] the token used for authentication
+      # @param data_only [Boolean] if true, restrict to read-only data commands
+      #
+      def initialize(launcher, token: nil, data_only: false)
+        @launcher = launcher
+        @auth_token = token
+        @enabled_commands = READ_ONLY_COMMANDS if data_only
       end
 
+      # most commands call methods in `::Puma::Launcher` based on command in
+      # `env['PATH_INFO']`
       def call(env)
         unless authenticate(env)
           return rack_response(403, 'Invalid auth token', 'text/plain')
         end
 
-        case env['PATH_INFO']
-        when /\/stop$/
-          @server.stop
-          return rack_response(200, OK_STATUS)
+        # resp_type is processed by following case statement, return
+        # is a number (status) or a string used as the body of a 200 response
+        command = env['PATH_INFO'][/\/([^\/]+)$/, 1]
+        if @enabled_commands && !@enabled_commands.include?(command)
+          return rack_response(404, "Command #{command.inspect} unavailable", 'text/plain')
+        end
+
+        resp_type =
+          case command
+          when 'stop'
+            @launcher.stop ; 200
+
+          when 'halt'
+            @launcher.halt ; 200
+
+          when 'restart'
+            @launcher.restart ; 200
+
+          when 'phased-restart'
+            @launcher.phased_restart ? 200 : 404
+
+          when 'refork'
+            @launcher.refork ? 200 : 404
 
-        when /\/halt$/
-          @server.halt
-          return rack_response(200, OK_STATUS)
+          when 'reload-worker-directory'
+            @launcher.send(:reload_worker_directory) ? 200 : 404
 
-        when /\/restart$/
-          if @cli and @cli.restart_on_stop!
-            @server.begin_restart
+          when 'gc'
+            GC.start ; 200
+
+          when 'gc-stats'
+            Puma::JSONSerialization.generate GC.stat
+
+          when 'stats'
+            Puma::JSONSerialization.generate @launcher.stats
+
+          when 'thread-backtraces'
+            backtraces = []
+            @launcher.thread_status do |name, backtrace|
+              backtraces << { name: name, backtrace: backtrace }
+            end
+            Puma::JSONSerialization.generate backtraces
 
-            return rack_response(200, OK_STATUS)
           else
-            return rack_response(200, '{ "status": "not configured" }')
+            return rack_response(404, "Unsupported action", 'text/plain')
           end
 
-        when /\/stats$/
-          b = @server.backlog
-          r = @server.running
-          return rack_response(200, %Q!{ "backlog": #{b}, "running": #{r} }!)
+        case resp_type
+        when String
+          rack_response 200, resp_type
+        when 200
+          rack_response 200, OK_STATUS
+        when 404
+          str = env['PATH_INFO'][/\/(\S+)/, 1].tr '-', '_'
+          rack_response 404, "{ \"error\": \"#{str} not available\" }"
         end
-
-        rack_response 404, "Unsupported action", 'text/plain'
       end
 
       private
+
+      def authenticate(env)
+        return true unless @auth_token
+        env['QUERY_STRING'].to_s.split(/[&;]/).include? "token=#{@auth_token}"
+      end
+
       def rack_response(status, body, content_type='application/json')
-        [status, { 'Content-Type' => content_type, 'Content-Length' => body.bytesize.to_s }, [body]]
+        headers = {
+          'content-type' => content_type,
+          'content-length' => body.bytesize.to_s
+        }
+
+        [status, headers, [body]]
       end
     end
   end