app_profiler 0.2.7 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d088d71f0d625a8627a17aa418840597b1d26e01bc05a93848440ce710f461a
-  data.tar.gz: 5f65cc77daaeaacbeed54cc913c08e89fddbc30e64458e1538c2cce2f5e9b381
+  metadata.gz: 88fa4e71be7c319cba26e669752c8a7a46c9b7c56881894944a8ae4b8def6c6f
+  data.tar.gz: 9daa41d818e4fbd0a113186c20e7a18814a3c039bc7dc91d52d26efd7a3ab5c6
 SHA512:
-  metadata.gz: a99c98c4bcf876d9c7147bf552b47ae5b8052f2e3c314a2279c8e34a2f37a9781f47c9f7ee99260281490682d1ea776f00be946494dd8fcd0bb83cbd5db07537
-  data.tar.gz: 4fafc43c3a589636928566a4bdf96fde0abf91eebde85e267852c281f7b5439ce76048c1cbca1cfe18119b99057bc7355fe41c2e48537c6b6a62f7a41b0ffa4b
+  metadata.gz: 8471c04250be1ae8b393a804ee83553ccc5c374008f343ab0213464b130658ee69fa77626a0f557e7423350e60d0ac6c803228a656e48be739def63400d34fe3
+  data.tar.gz: 216c13be42bb571a535c894f543889fa114f97ff49aa84fb59d7ab2a39e8b7f2815c5e75399a3d98b7cbcf645376e37bb4899d8e5c63761f3fac6f1ca2483848

data/lib/app_profiler/base_profile.rb

@@ -8,7 +8,7 @@ module AppProfiler
     private_constant :INTERNAL_METADATA_KEYS
     class UnsafeFilename < StandardError; end
 
-    attr_reader :id, :context
+    attr_reader :context
 
     delegate :[], to: :@data
 
@@ -34,9 +34,17 @@ module AppProfiler
     # `data` is assumed to be a Hash for Stackprof,
     # a vernier "result" object for vernier
     def initialize(data, id: nil, context: nil)
-      @id      = id.presence || SecureRandom.hex
+      ProfileId.current = id if id.present?
+
       @context = context
       @data    = data
+
+      metadata[PROFILE_BACKEND_METADATA_KEY] = self.class.backend_name
+      metadata[PROFILE_ID_METADATA_KEY] = ProfileId.current
+    end
+
+    def id
+      metadata[PROFILE_ID_METADATA_KEY]
     end
 
     def upload

data/lib/app_profiler/profile_id.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module AppProfiler
+  class ProfileId
+    class Current
+      PROFILE_ID_KEY = :__app_profiler_profile_id__
+      class << self
+        # This is a thread local variable which gets reset by the middleware at the end of the request.
+        # Need to be mindful of the middleware order. If we try to access ProfileId after the middleware has finished,
+        # lets say in a middleware which runs before Profiling middleware, it will return a different value,
+        # as the middleware has already reset.
+
+        def id
+          Thread.current[PROFILE_ID_KEY] ||= SecureRandom.hex
+        end
+
+        def id=(id)
+          Thread.current[PROFILE_ID_KEY] = id
+        end
+
+        def reset
+          Thread.current[PROFILE_ID_KEY] = nil
+        end
+      end
+    end
+
+    class << self
+      def current
+        Current.id
+      end
+
+      def current=(id)
+        Current.id = id
+      end
+    end
+  end
+end

data/lib/app_profiler/request_parameters.rb

@@ -33,7 +33,7 @@ module AppProfiler
 
       return false if backend != AppProfiler::Backend::StackprofBackend.name && !AppProfiler.vernier_supported?
 
-      if AppProfiler.vernier_supported? && backend == AppProfiler::Backend::VernierBackend.name &&
+      if AppProfiler.vernier_supported? && 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/stackprof_profile.rb

@@ -4,6 +4,17 @@ module AppProfiler
   class StackprofProfile < BaseProfile
     FILE_EXTENSION = ".stackprof.json"
 
+    class << self
+      def backend_name
+        Backend::StackprofBackend.name.to_s
+      end
+    end
+
+    def initialize(data, id: nil, context: nil)
+      data[:metadata] ||= {}
+      super(data, id: id, context: context)
+    end
+
     def mode
       @data[:mode]
     end

data/lib/app_profiler/vernier_profile.rb

@@ -3,6 +3,19 @@
 module AppProfiler
   class VernierProfile < BaseProfile
     FILE_EXTENSION = ".vernier.json"
+    BACKEND_NAME = :vernier
+
+    class << self
+      def backend_name
+        # cannot reference Backend::VernierBackend because of different ruby versions we have to support
+        BACKEND_NAME.to_s
+      end
+    end
+
+    def initialize(data, id: nil, context: nil)
+      data[:meta] ||= {}
+      super(data, id: id, context: context)
+    end
 
     def mode
       @data[:meta][:mode]

data/lib/app_profiler/version.rb

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

data/lib/app_profiler.rb

@@ -7,6 +7,9 @@ require "logger"
 require "app_profiler/version"
 
 module AppProfiler
+  PROFILE_ID_METADATA_KEY = :profile_id
+  PROFILE_BACKEND_METADATA_KEY = :profiler
+
   class ConfigurationError < StandardError
   end
 
@@ -45,6 +48,7 @@ module AppProfiler
   autoload(:Backend, "app_profiler/backend")
   autoload(:Server, "app_profiler/server")
   autoload(:Sampler, "app_profiler/sampler")
+  autoload(:ProfileId, "app_profiler/profile_id")
 
   mattr_accessor :logger, default: Logger.new($stdout)
   mattr_accessor :root
@@ -89,6 +93,7 @@ module AppProfiler
       yield
     ensure
       self.backend = original_backend if backend
+      ProfileId::Current.reset
     end
 
     def start(*args, backend: nil, **kwargs)
@@ -159,7 +164,7 @@ module AppProfiler
 
     def backend_for(backend_name)
       if vernier_supported? &&
-          backend_name&.to_sym == AppProfiler::Backend::VernierBackend.name
+          backend_name&.to_sym == AppProfiler::VernierProfile::BACKEND_NAME
         AppProfiler::Backend::VernierBackend
       elsif backend_name&.to_sym == AppProfiler::Backend::StackprofBackend.name
         AppProfiler::Backend::StackprofBackend
@@ -173,7 +178,7 @@ module AppProfiler
     end
 
     def vernier_supported?
-      RUBY_VERSION >= "3.2.1" && defined?(AppProfiler::Backend::VernierBackend.name)
+      RUBY_VERSION >= "3.2.1" && defined?(AppProfiler::VernierProfile::BACKEND_NAME)
     end
 
     def profile_header=(profile_header)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.9
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -12,7 +12,7 @@ authors:
 - Scott Francis
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -144,6 +144,7 @@ files:
 - lib/app_profiler/middleware/upload_action.rb
 - lib/app_profiler/middleware/view_action.rb
 - lib/app_profiler/parameters.rb
+- lib/app_profiler/profile_id.rb
 - lib/app_profiler/railtie.rb
 - lib/app_profiler/request_parameters.rb
 - lib/app_profiler/sampler.rb