app_profiler 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 340bc83668cbe8abd27780ef23456a6d98f1f8c46059f2b447a25f1e6784483e
-  data.tar.gz: 06fcbd4abe95e53f8e37595df7ca445bcd59f61cd9ba24af8c82578cdb6bb9c4
+  metadata.gz: 69d1e8d957672c105e954b64a547955e4e1c499d3d70b529e1de1b56b2fb7d51
+  data.tar.gz: d7f022da1ebf4ead06ebadae4ded97260276afb12cb885866d76f53e520171c8
 SHA512:
-  metadata.gz: 04cf486ef95efd05af19fd241f05b45c0a942c1e701295181fdef898f59cb24ace85c86e047ea63359b5c5ddfb2f8a233afbc3958004a823e0ffcf0daf692830
-  data.tar.gz: bab5ddd1f1dcfb4d06e23b575341a7d7a783e04191b62a74dd553cf78d5726187500931e34c49ebe5e019d60602ceec074d4071d024008c05c8bfe5e5ddb7d52
+  metadata.gz: 831da45ae0c02c629fc0e1788a6b1a220872b4c449291d72df9adbfdbfada6bf0ab815fe41e5034ad5376176b6235cfcbb83d00e4688a1ba4150faedb5ed5820
+  data.tar.gz: 0177d93977123800440539da265fac443023d8f654f74d64ccd7c4f9a74ed2750c83c2472a7e8285b065a79589fb6024280b4767ee6df148722d34339396cb72

data/lib/app_profiler/middleware/upload_action.rb

@@ -27,8 +27,9 @@ module AppProfiler
           return unless autoredirect
 
           # Automatically redirect to profile if autoredirect is true.
-          if response[0].to_i < 500
-            response[1]["Location"] = AppProfiler.profile_url(upload)
+          location = AppProfiler.profile_url(upload)
+          if response[0].to_i < 500 && location
+            response[1]["Location"] = location
             response[0] = 303
           end
         end

data/lib/app_profiler/railtie.rb

@@ -5,6 +5,7 @@ require "rails"
 module AppProfiler
   class Railtie < Rails::Railtie
     config.app_profiler = ActiveSupport::OrderedOptions.new
+    config.app_profiler.profile_url_formatter = DefaultProfileFormatter
 
     initializer "app_profiler.configs" do |app|
       AppProfiler.logger = app.config.app_profiler.logger || Rails.logger
@@ -45,9 +46,9 @@ module AppProfiler
 
     initializer "app_profiler.enable_server" do
       if AppProfiler.server.enabled
-        AppProfiler::Server.start
+        AppProfiler::Server.start(AppProfiler.logger)
         ActiveSupport::ForkTracker.after_fork do
-          AppProfiler::Server.start
+          AppProfiler::Server.start(AppProfiler.logger)
         end
       end
     end

data/lib/app_profiler/server.rb

@@ -3,6 +3,9 @@
 require "socket"
 require "rack"
 require "tempfile"
+require "json"
+require "active_support/core_ext/hash"
+require "active_support/core_ext/module"
 
 # This module provides a means to start a golang-inspired profile server
 # it is implemented using stdlib and Rack to avoid additional dependencies
@@ -49,80 +52,122 @@ module AppProfiler
       private
 
       def handle(request)
-        response = Rack::Response.new
-        if request.request_method != "GET"
-          response.status = HTTP_NOT_ALLOWED
-          response.write("Only GET requests are supported")
-          return response
-        end
+        return handle_not_allowed(request) if request.request_method != "GET"
+
         case request.path
         when "/profile"
-          begin
-            stackprof_args, duration = validate_profile_params(request.params)
-          rescue InvalidProfileArgsError => e
-            response.status = HTTP_BAD_REQUEST
-            response.write("Invalid argument #{e.message}")
-            return response
-          end
+          handle_profile(request)
+        else
+          handle_not_found(request)
+        end
+      end
 
-          if start_running
-            start_time = Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
-            AppProfiler.start(**stackprof_args)
-            sleep(duration)
-            profile = AppProfiler.stop
-            stop_running
-            response.status = HTTP_OK
-            response.set_header("Content-Type", "application/json")
-            if AppProfiler::Server.cors
-              response.set_header("Access-Control-Allow-Origin", AppProfiler::Server.cors_host)
-            end
-            profile_hash = profile.to_h
-            profile_hash["start_time_nsecs"] = start_time # NOTE: this is not part of the stackprof profile spec
-            response.write(JSON.dump(profile_hash))
-          else
-            response.status = HTTP_CONFLICT
-            response.write("A profile is already running")
+      def handle_not_allowed(request)
+        response = Rack::Response.new
+
+        response.status = HTTP_NOT_ALLOWED
+        response.write("Only GET requests are supported")
+
+        response
+      end
+
+      def handle_profile(request)
+        begin
+          stackprof_args, duration = validate_profile_params(request.params)
+        rescue InvalidProfileArgsError => e
+          return handle_bad_request(request, e.message)
+        end
+
+        response = Rack::Response.new
+
+        if start_running(stackprof_args)
+          start_time = Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
+
+          sleep(duration)
+
+          profile = stop_running
+
+          response.status = HTTP_OK
+          response.set_header("Content-Type", "application/json")
+
+          profile_hash = profile.to_h
+          profile_hash["start_time_nsecs"] = start_time # NOTE: this is not part of the stackprof profile spec
+
+          response.write(JSON.dump(profile_hash))
+
+          if AppProfiler::Server.cors
+            response.set_header("Access-Control-Allow-Origin", AppProfiler::Server.cors_host)
           end
         else
-          response.status = HTTP_NOT_FOUND
-          response.write("Unsupported endpoint #{request.path}")
+          response.status = HTTP_CONFLICT
+          response.write("A profile is already running")
         end
+
+        response
+      end
+
+      def handle_not_found(request)
+        response = Rack::Response.new
+
+        response.status = HTTP_NOT_FOUND
+        response.write("Unsupported endpoint #{request.path}")
+
+        response
+      end
+
+      def handle_bad_request(request, message)
+        response = Rack::Response.new
+
+        response.status = HTTP_BAD_REQUEST
+        response.write("Invalid argument #{message}")
+
         response
       end
 
       def validate_profile_params(params)
         params = params.symbolize_keys
         stackprof_args = {}
+
         begin
           duration = Float(params.key?(:duration) ? params[:duration] : AppProfiler::Server.duration)
         rescue ArgumentError
-          raise InvalidProfileArgsError, "invalid duration #{params[:duration]}"
+          raise InvalidProfileArgsError, "duration: #{params[:duration]}"
         end
+
         if params.key?(:mode)
           if ["cpu", "wall", "object"].include?(params[:mode])
             stackprof_args[:mode] = params[:mode].to_sym
           else
-            raise InvalidProfileArgsError, "invalid mode #{params[:mode]}"
+            raise InvalidProfileArgsError, "mode: #{params[:mode]}"
           end
         end
+
         if params.key?(:interval)
           stackprof_args[:interval] = params[:interval].to_i
-          raise InvalidProfileArgsError, "invalid interval #{params[:interval]}" if stackprof_args[:interval] <= 0
+
+          raise InvalidProfileArgsError, "interval: #{params[:interval]}" if stackprof_args[:interval] <= 0
         end
+
         [stackprof_args, duration]
       end
 
       # Prevent multiple concurrent profiles by synchronizing between threads
-      def start_running
+      def start_running(stackprof_args)
         @semaphore.synchronize do
           return false if @profile_running
 
           @profile_running = true
+
+          AppProfiler.start(**stackprof_args)
         end
       end
 
       def stop_running
-        @semaphore.synchronize { @profile_running = false }
+        @semaphore.synchronize do
+          AppProfiler.stop.tap do
+            @profile_running = false
+          end
+        end
       end
     end
 
@@ -147,6 +192,7 @@ module AppProfiler
       class UNIX < Transport
         def initialize
           super
+
           FileUtils.mkdir_p(PROFILER_TEMPFILE_PATH)
           @socket_file = File.join(PROFILER_TEMPFILE_PATH, "app-profiler-#{Process.pid}.sock")
           File.unlink(@socket_file) if File.exist?(@socket_file) && File.socket?(@socket_file)
@@ -184,7 +230,8 @@ module AppProfiler
         end
       end
 
-      def initialize(transport)
+      def initialize(transport, logger)
+        @logger = logger
         case transport
         when TRANSPORT_UNIX
           @transport = ProfileServer::UNIX.new
@@ -196,7 +243,7 @@ module AppProfiler
 
         @listen_thread = nil
 
-        AppProfiler.logger.info(
+        @logger.info(
           "[AppProfiler::Server] listening on addr=#{@transport.socket.addr}"
         )
         @pid = Process.pid
@@ -216,10 +263,13 @@ module AppProfiler
           loop do
             Thread.new(@transport.socket.accept) do |session|
               request = session.gets
+
               if request.nil?
                 session.close
+
                 next
               end
+
               method, path, http_version = request.split(" ")
               path_info, query_string = path.split("?")
               env = { # an extremely minimal rack env hash, just enough to get the job done
@@ -233,15 +283,18 @@ module AppProfiler
 
               begin
                 session.print("#{http_version} #{status}\r\n")
+
                 headers.each do |header, value|
                   session.print("#{header}: #{value}\r\n")
                 end
+
                 session.print("\r\n")
+
                 body.each do |part|
                   session.print(part)
                 end
               rescue => e
-                AppProfiler.logger.error(
+                @logger.error(
                   "[AppProfiler::Server] exception #{e} responding to request #{request}: #{e.message}"
                 )
               ensure
@@ -265,15 +318,16 @@ module AppProfiler
     class << self
       def reset
         profile_servers.clear
+
         DEFAULTS.each do |config, value|
           class_variable_set(:"@@#{config}", value) # rubocop:disable Style/ClassVars
         end
       end
 
-      def start
+      def start(logger = Logger.new(IO::NULL))
         return if profile_server
 
-        profile_servers[Process.pid] = ProfileServer.new(AppProfiler::Server.transport)
+        profile_servers[Process.pid] = ProfileServer.new(AppProfiler::Server.transport, logger)
         profile_server.serve
         profile_server
       end

data/lib/app_profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppProfiler
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/app_profiler.rb

@@ -4,7 +4,6 @@ require "active_support/core_ext/class"
 require "active_support/core_ext/module"
 require "logger"
 require "app_profiler/version"
-require "app_profiler/railtie" if defined?(Rails::Railtie)
 
 module AppProfiler
   class ConfigurationError < StandardError
@@ -81,7 +80,11 @@ module AppProfiler
     end
 
     def profile_url(upload)
+      return unless AppProfiler.profile_url_formatter
+
       AppProfiler.profile_url_formatter.call(upload)
     end
   end
+
+  require "app_profiler/railtie" if defined?(Rails::Railtie)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,20 +43,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: stackprof
   requirement: !ruby/object:Gem::Requirement