app_profiler 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e510f0a0d20ec300e0ae5593adbdb03195202ea68e6a8ecad5fb13abfef9473
-  data.tar.gz: 66dd66baaa5e863a0b0311431da9ab17f794c3e8902e73b6d29f998c0867db74
+  metadata.gz: 414e73739d0778f252bdb142852ff9a7428a3b76388a5b46108546b91d6a682f
+  data.tar.gz: 1d87ba7dbcd9de74c55bbab01f6fcfa9c2882ca887c9384e06d9c8f54237b58b
 SHA512:
-  metadata.gz: 67c22d47cea0a3fe91928495b4d14f476c727bd98c976bb7ae310b61b317c0a54dc91d350c870cc8cc155a044f33f49dfc5a1c739bd68609261af537c43b8913
-  data.tar.gz: 0e57a16a1bf6195fb8b723ae213e8fb2226a7858448420ef4e495363402033f1e9612971411981f505b9901dde425fc910d82023b788e1d60311d44ff3a0d258
+  metadata.gz: ccd99ffeb214e7a854bde04fca23191d5cd46ab2b370df07e75e5866a6f0bdbb4af4125cad65774bed7984d228ab4ea90387466075aead7da484dc117b9bb70d
+  data.tar.gz: 2629a0e89e29791313b40f25b397cea321f1e27a58d5e42e2c2f18d31577842f94c127d1b2a2d5fa3fc8945539e0f81aa882ac792efb2f7ec8799069f5816cce

data/lib/app_profiler/backend/base_backend.rb

@@ -47,6 +47,10 @@ module AppProfiler
           @run_lock ||= Mutex.new
         end
 
+        def locked?
+          run_lock.locked?
+        end
+
         def name
           raise NotImplementedError
         end

data/lib/app_profiler/backend/vernier_backend.rb

@@ -15,6 +15,10 @@ module AppProfiler
         :retained,
       ].freeze
 
+      PRIVATE_METADATA = [
+        :started_at, # started_at uses a monotonic source, not realtime
+      ].freeze
+
       class << self
         def name
           :vernier
@@ -29,7 +33,9 @@ module AppProfiler
         @mode = params.delete(:mode) || DEFAULTS[:mode]
         raise ArgumentError unless AVAILABLE_MODES.include?(@mode)
 
-        @metadata = params.delete(:metadata)
+        if Gem.loaded_specs["vernier"].version < Gem::Version.new("1.7.0")
+          @metadata = params.delete(:metadata)
+        end
         clear
 
         @collector ||= ::Vernier::Collector.new(@mode, **params)
@@ -60,11 +66,19 @@ module AppProfiler
 
         return unless vernier_profile
 
+        # Store all vernier metadata
+        meta = vernier_profile.meta.reject { |k, v| k == :user_metadata || v.nil? || PRIVATE_METADATA.include?(k) }
+        meta.merge!(@metadata) if @metadata
+
+        # Internal metadata takes precedence over user metadata, but store
+        # everything in user metadata
+        vernier_profile.meta[:user_metadata]&.merge!(meta)
+
         # HACK: - "data" is private, but we want to avoid serializing to JSON then
         # parsing back from JSON by just directly getting the hash
         data = ::Vernier::Output::Firefox.new(vernier_profile).send(:data)
-        data[:meta][:mode] = @mode # TODO: https://github.com/jhawthorn/vernier/issues/30
-        data[:meta].merge!(@metadata) if @metadata
+        data[:meta][:mode] = @mode
+        data[:meta][:vernierUserMetadata] ||= meta # for compatibility with < 1.7.0
         @mode = nil
         @metadata = nil
 

data/lib/app_profiler/base_profile.rb

@@ -23,7 +23,7 @@ module AppProfiler
       end
 
       def from_vernier(data)
-        options = INTERNAL_METADATA_KEYS.map { |key| [key, data[:meta]&.delete(key)] }.to_h
+        options = INTERNAL_METADATA_KEYS.map { |key| [key, data[:meta]&.[](:vernierUserMetadata)&.delete(key)] }.to_h
 
         VernierProfile.new(data, **options).tap do |profile|
           raise ArgumentError, "invalid profile data" unless profile.valid?

data/lib/app_profiler/middleware/upload_action.rb

@@ -24,15 +24,15 @@ module AppProfiler
         def append_headers(response, upload:, autoredirect:)
           return unless upload
 
-          response[1][profile_header]      = AppProfiler.profile_url(upload)
+          location = AppProfiler.profile_url(upload)
+          response[1][profile_header] = location if location
           response[1][profile_data_header] = profile_data_url(upload)
 
           return unless autoredirect
 
           # Automatically redirect to profile if autoredirect is true.
-          location = AppProfiler.profile_url(upload)
           if response[0].to_i < 500 && location
-            response[1]["Location"] = location
+            response[1]["location"] = location
             response[0] = 303
           end
         end

data/lib/app_profiler/railtie.rb

@@ -26,7 +26,8 @@ module AppProfiler
       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
+      server_cors = app.config.app_profiler.server_cors
+      AppProfiler.server.cors = server_cors.nil? ? true : server_cors
       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(

data/lib/app_profiler/request_parameters.rb

@@ -31,9 +31,7 @@ module AppProfiler
         return false
       end
 
-      return false if backend != AppProfiler::Backend::StackprofBackend.name && !AppProfiler.vernier_supported?
-
-      if AppProfiler.vernier_supported? && backend == AppProfiler::VernierProfile::BACKEND_NAME &&
+      if backend == AppProfiler::VernierProfile::BACKEND_NAME &&
           !AppProfiler::Backend::VernierBackend::AVAILABLE_MODES.include?(mode.to_sym)
         AppProfiler.logger.info("[AppProfiler] unsupported profiling mode=#{mode} for backend #{backend}")
         return false

data/lib/app_profiler/vernier_profile.rb

@@ -7,13 +7,14 @@ module AppProfiler
 
     class << self
       def backend_name
-        # cannot reference Backend::VernierBackend because of different ruby versions we have to support
+        # Keep metadata access independent of the optional Vernier gem.
         BACKEND_NAME.to_s
       end
     end
 
     def initialize(data, id: nil, context: nil)
       data[:meta] ||= {}
+      data[:meta][:vernierUserMetadata] ||= {}
       super(data, id: id, context: context)
     end
 
@@ -22,7 +23,7 @@ module AppProfiler
     end
 
     def metadata
-      @data[:meta]
+      @data[:meta][:vernierUserMetadata]
     end
 
     def format

data/lib/app_profiler/version.rb

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

data/lib/app_profiler/viewer/base_middleware.rb

@@ -86,7 +86,7 @@ module AppProfiler
       def render(html)
         [
           200,
-          { "Content-Type" => "text/html" },
+          { "content-type" => "text/html" },
           [
             +<<~HTML,
               <!doctype html>

data/lib/app_profiler/viewer/firefox_remote_viewer/middleware.rb

@@ -11,7 +11,7 @@ module AppProfiler
 
         def initialize(app)
           super
-          @firefox_profiler = Rack::File.new(
+          @firefox_profiler = Rack::Files.new(
             File.join(AppProfiler.root, "node_modules/firefox-profiler/dist"),
           )
         end
@@ -40,9 +40,9 @@ module AppProfiler
             source = "#{proto}://#{host}/app_profiler/firefox/#{path}"
             target = "/from-url/#{CGI.escape(source)}"
 
-            [302, { "Location" => target }, [""]]
+            [302, { "location" => target }, [""]]
           else
-            env[Rack::PATH_INFO] = path.delete_prefix("/app_profiler")
+            env[Rack::PATH_INFO] = "/#{path.delete_prefix("/")}"
             firefox_profiler.call(env)
           end
         end
@@ -50,7 +50,7 @@ module AppProfiler
         def from(env, path)
           setup_yarn unless yarn_setup
           index = File.read(File.join(AppProfiler.root, "node_modules/firefox-profiler/dist/index.html"))
-          [200, { "Content-Type" => "text/html" }, [index]]
+          [200, { "content-type" => "text/html" }, [index]]
         end
 
         def show(_env, name)
@@ -58,7 +58,7 @@ module AppProfiler
             id(file) == name
           end || raise(ArgumentError)
 
-          [200, { "Content-Type" => "application/json" }, [profile.read]]
+          [200, { "content-type" => "application/json" }, [profile.read]]
         end
       end
     end

data/lib/app_profiler/viewer/firefox_remote_viewer.rb

@@ -22,7 +22,7 @@ module AppProfiler
         id = Middleware.id(@profile.file)
 
         if response && response[0].to_i < 500
-          response[1]["Location"] = "/app_profiler/#{NAME}/viewer/#{id}"
+          response[1]["location"] = "/app_profiler/#{NAME}/viewer/#{id}"
           response[0] = 303
         else
           AppProfiler.logger.info("[Profiler] Profile available at /app_profiler/#{id}\n")

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

@@ -11,7 +11,7 @@ module AppProfiler
 
         def initialize(app)
           super
-          @speedscope = Rack::File.new(
+          @speedscope = Rack::Files.new(
             File.join(AppProfiler.root, "node_modules/speedscope/dist/release"),
           )
         end
@@ -32,7 +32,7 @@ module AppProfiler
         def viewer(env, path)
           setup_yarn unless yarn_setup
 
-          env[Rack::PATH_INFO] = path.delete_prefix("/app_profiler/speedscope")
+          env[Rack::PATH_INFO] = "/#{path.delete_prefix("/")}"
           speedscope.call(env)
         end
 
@@ -41,7 +41,7 @@ module AppProfiler
             id(file) == name
           end || raise(ArgumentError)
 
-          [200, { "Content-Type" => "application/json" }, [profile.read]]
+          [200, { "content-type" => "application/json" }, [profile.read]]
         end
       end
     end

data/lib/app_profiler/viewer/speedscope_remote_viewer.rb

@@ -29,7 +29,7 @@ module AppProfiler
         id = Middleware.id(@profile.file)
 
         if response && response[0].to_i < 500
-          response[1]["Location"] = "/app_profiler/#{NAME}/viewer/#{id}"
+          response[1]["location"] = "/app_profiler/#{NAME}/viewer/#{id}"
           response[0] = 303
         else
           AppProfiler.logger.info("[Profiler] Profile available at /app_profiler/#{id}\n")

data/lib/app_profiler/yarn/with_firefox_profiler.rb

@@ -42,7 +42,7 @@ module AppProfiler
           package_json = JSON.parse(package_contents)
           package_json["name"] ||= "firefox-profiler"
           package_json["version"] ||= "0.0.1"
-          File.write("firefox-profiler/package.json", package_json.to_json)
+          File.write("firefox-profiler/package.json", JSON.generate(package_json))
         end
         yarn("--cwd", "#{dir}/firefox-profiler")
 

data/lib/app_profiler.rb

@@ -58,8 +58,8 @@ module AppProfiler
 
   mattr_accessor :speedscope_host, default: "https://speedscope.app"
   mattr_accessor :autoredirect, default: false
-  mattr_reader   :profile_header, default: "X-Profile"
-  mattr_accessor :profile_async_header, default: "X-Profile-Async"
+  mattr_reader   :profile_header, default: "x-profile"
+  mattr_reader :profile_async_header, default: "x-profile-async"
   mattr_accessor :profile_param, default: "profile"
   mattr_accessor :context, default: nil
   mattr_reader   :profile_url_formatter, default: DefaultProfileFormatter
@@ -92,14 +92,9 @@ module AppProfiler
       end
       profiler.run(*args, **kwargs, &block)
     rescue BackendError => e
-      if ActiveSupport.respond_to?(:error_reporter)
-        ActiveSupport.error_reporter.report(e, context: { app_profiler: { backend: backend } })
-      else
-        logger.error(
-          "[AppProfiler.run] exception #{e} configuring backend #{backend}: #{e.message}",
-        )
-      end
+      ActiveSupport.error_reporter.report(e, context: { app_profiler: { backend: backend } })
       yield
+      nil # no profile result
     ensure
       self.backend = original_backend if backend
       ProfileId::Current.reset
@@ -126,7 +121,7 @@ module AppProfiler
     def backend=(new_backend)
       return if (new_profiler_backend = backend_for(new_backend)) == profiler_backend
 
-      if running?
+      if profiler_backend.locked?
         raise BackendError,
           "cannot change backend to #{new_backend} while #{backend} backend is running"
       end
@@ -165,13 +160,7 @@ module AppProfiler
 
       @profile_sampler_enabled.is_a?(Proc) ? @profile_sampler_enabled.call : @profile_sampler_enabled
     rescue => e
-      if ActiveSupport.respond_to?(:error_reporter)
-        ActiveSupport.error_reporter.report(e)
-      else
-        logger.error(
-          "[AppProfiler.profile_sampler_enabled] exception: #{e}, message: #{e.message}",
-        )
-      end
+      ActiveSupport.error_reporter.report(e)
       false
     end
 
@@ -185,8 +174,7 @@ module AppProfiler
     end
 
     def backend_for(backend_name)
-      if vernier_supported? &&
-          backend_name&.to_sym == AppProfiler::VernierProfile::BACKEND_NAME
+      if backend_name&.to_sym == AppProfiler::VernierProfile::BACKEND_NAME
         AppProfiler::Backend::VernierBackend
       elsif backend_name&.to_sym == AppProfiler::Backend::StackprofBackend.name
         AppProfiler::Backend::StackprofBackend
@@ -199,22 +187,22 @@ module AppProfiler
       profiler_backend.name
     end
 
-    def vernier_supported?
-      RUBY_VERSION >= "3.2.1" && defined?(AppProfiler::VernierProfile::BACKEND_NAME)
-    end
-
     def profile_header=(profile_header)
-      @@profile_header = profile_header # rubocop:disable Style/ClassVars
+      @@profile_header = profile_header.downcase # rubocop:disable Style/ClassVars
       @@request_profile_header = nil    # rubocop:disable Style/ClassVars
       @@profile_data_header = nil       # rubocop:disable Style/ClassVars
     end
 
+    def profile_async_header=(profile_async_header)
+      @@profile_async_header = profile_async_header.downcase # rubocop:disable Style/ClassVars
+    end
+
     def request_profile_header
       @@request_profile_header ||= profile_header.upcase.tr("-", "_").prepend("HTTP_") # rubocop:disable Style/ClassVars
     end
 
     def profile_data_header
-      @@profile_data_header ||= profile_header.dup << "-Data" # rubocop:disable Style/ClassVars
+      @@profile_data_header ||= profile_header.dup << "-data" # rubocop:disable Style/ClassVars
     end
 
     def profile_url_formatter=(block)
@@ -268,7 +256,7 @@ module AppProfiler
     end
 
     def clear
-      profiler.stop if running?
+      profiler.stop if profiler_backend.locked?
       @profiler = nil
       @profiler_backend = nil
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -20,14 +20,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -74,16 +116,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: minitest-stub-const
   requirement: !ruby/object:Gem::Requirement
@@ -194,14 +236,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Collect performance profiles for your Rails application.
 test_files: []