app_profiler 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e7279a1707f2425058eb5db7cb7e4fca673f1a3634ff76542d2703ce5fdfefc
-  data.tar.gz: 8002f14694a26a43c87725ac54c44161401dc116b35dd793dcdf9b3f8f2e85c7
+  metadata.gz: e5e9b631f4b4b68fb8a2f6f2882ee0e4259cf6151d37388b299bd55c5a0ac6c3
+  data.tar.gz: a31ef0b50de69b81c84d5d8ec411e82db94a9aa2690fe633239e6c01f2bd2165
 SHA512:
-  metadata.gz: ed3f2daae5d8a9729c2aee42179927e6f311fd0b1ea39f8934ad6811be19075debebb985660984e8b15ce93f4ab7c8812fde0e3fd63f9b972341147606a9fb23
-  data.tar.gz: 336ac8b880934ef7078347ba1b6a1df046ee58147f91d387ef581b2071a3bcb2acbc50c8cd78e4c465585407bf74babb8b5147ce461936e71ca1993c6682d06b
+  metadata.gz: 4829d7292b8cc680c6936763b8fed26c5ab8f8661ada68f6c3b6a1890cee01d3ad7fb01bf377a3ce4cd3083f8b3b554d5b048c74ac594c540096724083adfb37
+  data.tar.gz: 20798219dc410c7b2ef0096e437ba8e7d8793a3dabac2a66246a765c8db06fca195c5d05981cff4adb28c6df40456876174e5f1d2b0c292fdff4f9922a1c059a

data/lib/app_profiler/middleware/upload_action.rb

@@ -21,26 +21,19 @@ module AppProfiler
         def append_headers(response, upload:, autoredirect:)
           return unless upload
 
-          response[1][profile_header]      = profile_url(upload)
+          response[1][profile_header]      = AppProfiler.profile_url(upload)
           response[1][profile_data_header] = profile_data_url(upload)
 
           return unless autoredirect
 
           # Automatically redirect to profile if autoredirect is true.
-          if response[0].to_i < 500
-            response[1]["Location"] = profile_url(upload)
+          location = AppProfiler.profile_url(upload)
+          if response[0].to_i < 500 && location
+            response[1]["Location"] = location
             response[0] = 303
           end
         end
 
-        def profile_url(upload)
-          if AppProfiler.profile_url_formatter.nil?
-            "#{AppProfiler.speedscope_host}#profileURL=#{upload.url}"
-          else
-            AppProfiler.profile_url_formatter.call(upload)
-          end
-        end
-
         def profile_data_url(upload)
           upload.url.to_s
         end

data/lib/app_profiler/profile.rb

@@ -2,7 +2,7 @@
 
 module AppProfiler
   class Profile
-    INTERNAL_METADATA_KEYS = %i(id context)
+    INTERNAL_METADATA_KEYS = [:id, :context]
     private_constant :INTERNAL_METADATA_KEYS
     class UnsafeFilename < StandardError; end
 
@@ -40,7 +40,13 @@ module AppProfiler
     def upload
       AppProfiler.storage.upload(self).tap do |upload|
         if upload && defined?(upload.url)
-          AppProfiler.logger.info("[Profiler] uploaded profile profile_url=#{upload.url}")
+          AppProfiler.logger.info(
+            <<~INFO.squish
+              [Profiler] data uploaded:
+              profile_url=#{upload.url}
+              profile_viewer_url=#{AppProfiler.profile_url(upload)}
+            INFO
+          )
         end
       end
     rescue => error
@@ -71,7 +77,7 @@ module AppProfiler
         Socket.gethostname,
       ].compact.join("-") << ".json"
 
-      raise UnsafeFilename if /[^0-9A-Za-z.\-\_]/.match(filename)
+      raise UnsafeFilename if /[^0-9A-Za-z.\-\_]/.match?(filename)
 
       AppProfiler.profile_root.join(filename)
     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
@@ -16,6 +17,12 @@ module AppProfiler
       AppProfiler.middleware = app.config.app_profiler.middleware || Middleware
       AppProfiler.middleware.action = app.config.app_profiler.middleware_action || default_middleware_action
       AppProfiler.middleware.disabled = app.config.app_profiler.middleware_disabled || false
+      AppProfiler.server.enabled = app.config.app_profiler.server_enabled || false
+      AppProfiler.server.transport = app.config.app_profiler.server_transport || default_appprofiler_transport
+      AppProfiler.server.port = app.config.app_profiler.server_port || 0
+      AppProfiler.server.duration = app.config.app_profiler.server_duration || 30
+      AppProfiler.server.cors = app.config.app_profiler.server_cors || true
+      AppProfiler.server.cors_host = app.config.app_profiler.server_cors_host || "*"
       AppProfiler.autoredirect = app.config.app_profiler.autoredirect || false
       AppProfiler.speedscope_host = app.config.app_profiler.speedscope_host || ENV.fetch(
         "APP_PROFILER_SPEEDSCOPE_URL", "https://speedscope.app"
@@ -37,6 +44,15 @@ module AppProfiler
       end
     end
 
+    initializer "app_profiler.enable_server" do
+      if AppProfiler.server.enabled
+        AppProfiler::Server.start
+        ActiveSupport::ForkTracker.after_fork do
+          AppProfiler::Server.start
+        end
+      end
+    end
+
     private
 
     def default_middleware_action
@@ -46,5 +62,15 @@ module AppProfiler
         Middleware::UploadAction
       end
     end
+
+    def default_appprofiler_transport
+      if Rails.env.development?
+        # default to TCP server in development so that if wanted users are able to target
+        # the server with speedscope
+        AppProfiler::Server::TRANSPORT_TCP
+      else
+        AppProfiler::Server::TRANSPORT_UNIX
+      end
+    end
   end
 end

data/lib/app_profiler/request_parameters.rb

@@ -81,6 +81,7 @@ module AppProfiler
 
     def header(name)
       return unless @request.has_header?(name)
+
       @request.get_header(name)
     end
 

data/lib/app_profiler/server.rb

@@ -0,0 +1,360 @@
+# frozen_string_literal: true
+
+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
+
+module AppProfiler
+  module Server
+    HTTP_OK = 200
+    HTTP_BAD_REQUEST = 400
+    HTTP_NOT_FOUND = 404
+    HTTP_NOT_ALLOWED = 405
+    HTTP_CONFLICT = 409
+
+    TRANSPORT_UNIX = "unix"
+    TRANSPORT_TCP = "tcp"
+
+    DEFAULTS = {
+      enabled: false,
+      transport: TRANSPORT_UNIX,
+      cors: true,
+      cors_host: "*",
+      port: 0,
+      duration: 30,
+    }
+
+    mattr_accessor :enabled, default: DEFAULTS[:enabled]
+    mattr_accessor :transport, default: DEFAULTS[:transport]
+    mattr_accessor :cors, default: DEFAULTS[:cors]
+    mattr_accessor :cors_host, default: DEFAULTS[:cors_host]
+    mattr_accessor :port, default: DEFAULTS[:port]
+    mattr_accessor :duration, default: DEFAULTS[:duration]
+
+    class ProfileApplication
+      class InvalidProfileArgsError < StandardError; end
+
+      def initialize
+        @semaphore = Thread::Mutex.new
+        @profile_running = false
+      end
+
+      def call(env)
+        handle(Rack::Request.new(env)).finish
+      end
+
+      private
+
+      def handle(request)
+        return handle_not_allowed(request) if request.request_method != "GET"
+
+        case request.path
+        when "/profile"
+          handle_profile(request)
+        else
+          handle_not_found(request)
+        end
+      end
+
+      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_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, "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, "mode: #{params[:mode]}"
+          end
+        end
+
+        if params.key?(:interval)
+          stackprof_args[:interval] = params[:interval].to_i
+
+          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(stackprof_args)
+        @semaphore.synchronize do
+          return false if @profile_running
+
+          @profile_running = true
+
+          AppProfiler.start(**stackprof_args)
+        end
+      end
+
+      def stop_running
+        @semaphore.synchronize do
+          AppProfiler.stop.tap do
+            @profile_running = false
+          end
+        end
+      end
+    end
+
+    # This is a minimal, non-compliant "HTTP" server.
+    # It will create an extremely minimal rack environment hash and hand it off
+    # to our application to process
+    class ProfileServer
+      PROFILER_TEMPFILE_PATH = "/tmp/app_profiler" # for tempfile that indicates port in filename or unix sockets
+
+      class Transport
+        attr_reader :socket
+
+        def client
+          raise(NotImplementedError)
+        end
+
+        def stop
+          raise(NotImplementedError)
+        end
+      end
+
+      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)
+          @socket = UNIXServer.new(@socket_file)
+        end
+
+        def client
+          UNIXSocket.new(@socket_file)
+        end
+
+        def stop
+          File.unlink(@socket_file) if File.exist?(@socket_file) && File.socket?(@socket_file)
+          @socket.close
+        end
+      end
+
+      class TCP < Transport
+        SERVER_ADDRESS = "127.0.0.1" # it is ONLY safe to run this bound to localhost
+
+        def initialize(port = 0)
+          super()
+          FileUtils.mkdir_p(PROFILER_TEMPFILE_PATH)
+          @socket = TCPServer.new(SERVER_ADDRESS, port)
+          @port = @socket.addr[1]
+          @port_file = Tempfile.new("profileserver-#{Process.pid}-port-#{@port}-", PROFILER_TEMPFILE_PATH)
+        end
+
+        def client
+          TCPSocket.new(SERVER_ADDRESS, @port)
+        end
+
+        def stop
+          @port_file.unlink
+          @socket.close
+        end
+      end
+
+      def initialize(transport)
+        case transport
+        when TRANSPORT_UNIX
+          @transport = ProfileServer::UNIX.new
+        when TRANSPORT_TCP
+          @transport = ProfileServer::TCP.new(AppProfiler::Server.port)
+        else
+          raise "invalid transport #{transport}"
+        end
+
+        @listen_thread = nil
+
+        AppProfiler.logger.info(
+          "[AppProfiler::Server] listening on addr=#{@transport.socket.addr}"
+        )
+        @pid = Process.pid
+        at_exit { stop }
+      end
+
+      def client
+        @transport.client
+      end
+
+      def serve
+        return unless @listen_thread.nil?
+
+        app = ProfileApplication.new
+
+        @listen_thread = Thread.new do
+          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
+                "HTTP_VERSION" => http_version,
+                "REQUEST_METHOD" => method,
+                "PATH_INFO" => path_info,
+                "QUERY_STRING" => query_string,
+                "rack.input" => "",
+              }
+              status, headers, body = app.call(env)
+
+              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(
+                  "[AppProfiler::Server] exception #{e} responding to request #{request}: #{e.message}"
+                )
+              ensure
+                session.close
+              end
+            end
+          end
+        end
+      end
+
+      def stop
+        return unless @pid == Process.pid
+
+        @listen_thread.kill
+        @transport.stop
+      end
+    end
+
+    private_constant :ProfileApplication, :ProfileServer
+
+    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
+        return if profile_server
+
+        profile_servers[Process.pid] = ProfileServer.new(AppProfiler::Server.transport)
+        profile_server.serve
+        profile_server
+      end
+
+      def client
+        return unless profile_server
+
+        profile_server.client
+      end
+
+      def stop
+        return unless profile_server
+
+        profile_server.stop
+        profile_servers.delete(Process.pid)
+      end
+
+      private
+
+      def profile_server
+        profile_servers[Process.pid]
+      end
+
+      # It is possible there will be a server pre-fork, this is to distinguish
+      # the child server from its parent via PID
+      def profile_servers
+        @profile_servers ||= {}
+      end
+    end
+  end
+end

data/lib/app_profiler/version.rb

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

data/lib/app_profiler/viewer/speedscope_remote_viewer/base_middleware.rb

@@ -7,10 +7,12 @@ module AppProfiler
     class SpeedscopeRemoteViewer < BaseViewer
       class BaseMiddleware
         class Sanitizer < Rails::Html::SafeListSanitizer
-          self.allowed_tags = Set.new(%w(strong em b i p code pre tt samp kbd var sub
-                                         sup dfn cite big small address hr br div span
-                                         h1 h2 h3 h4 h5 h6 ul ol li dl dt dd abbr
-                                         acronym a img blockquote del ins script))
+          self.allowed_tags = Set.new([
+            "strong", "em", "b", "i", "p", "code", "pre", "tt", "samp", "kbd", "var", "sub",
+            "sup", "dfn", "cite", "big", "small", "address", "hr", "br", "div", "span", "h1",
+            "h2", "h3", "h4", "h5", "h6", "ul", "ol", "li", "dl", "dt", "dd", "abbr", "acronym",
+            "a", "img", "blockquote", "del", "ins", "script",
+          ])
         end
 
         private_constant(:Sanitizer)
@@ -73,7 +75,7 @@ module AppProfiler
 
         def index(_env)
           render(
-            String.new.tap do |content|
+            (+"").tap do |content|
               content << "<h1>Profiles</h1>"
               profile_files.each do |file|
                 content << <<~HTML

data/lib/app_profiler/yarn/command.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AppProfiler
   module Yarn
     module Command
@@ -32,7 +33,7 @@ module AppProfiler
 
       def ensure_command_valid(command)
         unless valid_command?(command)
-          raise YarnError, "Illegal command: #{command.join(' ')}."
+          raise YarnError, "Illegal command: #{command.join(" ")}."
         end
       end
 

data/lib/app_profiler/yarn/with_speedscope.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AppProfiler
   module Yarn
     module WithSpeedscope

data/lib/app_profiler.rb

@@ -4,12 +4,15 @@ 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
   end
 
+  DefaultProfileFormatter = proc do |upload|
+    "#{AppProfiler.speedscope_host}#profileURL=#{upload.url}"
+  end
+
   module Storage
     autoload :BaseStorage, "app_profiler/storage/base_storage"
     autoload :FileStorage, "app_profiler/storage/file_storage"
@@ -26,6 +29,7 @@ module AppProfiler
   require "app_profiler/request_parameters"
   require "app_profiler/profiler"
   require "app_profiler/profile"
+  require "app_profiler/server"
 
   mattr_accessor :logger, default: Logger.new($stdout)
   mattr_accessor :root
@@ -35,11 +39,13 @@ module AppProfiler
   mattr_accessor :autoredirect, default: false
   mattr_reader   :profile_header, default: "X-Profile"
   mattr_accessor :context, default: nil
-  mattr_reader   :profile_url_formatter, default: nil
+  mattr_reader   :profile_url_formatter,
+    default: DefaultProfileFormatter
 
   mattr_accessor :storage, default: Storage::FileStorage
   mattr_accessor :viewer, default: Viewer::SpeedscopeViewer
   mattr_accessor :middleware, default: Middleware
+  mattr_accessor :server, default: Server
 
   class << self
     def run(*args, &block)
@@ -62,9 +68,7 @@ module AppProfiler
     end
 
     def request_profile_header
-      @@request_profile_header ||= begin # rubocop:disable Style/ClassVars
-        profile_header.upcase.gsub("-", "_").prepend("HTTP_")
-      end
+      @@request_profile_header ||= profile_header.upcase.tr("-", "_").prepend("HTTP_") # rubocop:disable Style/ClassVars
     end
 
     def profile_data_header
@@ -74,5 +78,13 @@ module AppProfiler
     def profile_url_formatter=(block)
       @@profile_url_formatter = block # rubocop:disable Style/ClassVars
     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.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2022-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,33 +30,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: stackprof
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,19 +100,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-stub-const
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -128,19 +128,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-stub-const
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 description: 
 email:
 - gems@shopify.com
@@ -157,6 +157,7 @@ files:
 - lib/app_profiler/profiler.rb
 - lib/app_profiler/railtie.rb
 - lib/app_profiler/request_parameters.rb
+- lib/app_profiler/server.rb
 - lib/app_profiler/storage/base_storage.rb
 - lib/app_profiler/storage/file_storage.rb
 - lib/app_profiler/storage/google_cloud_storage.rb
@@ -180,14 +181,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Collect performance profiles for your Rails application.