app_profiler 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c36371d12c24dfed23e6e492b5c3912e01480bfd7a5973bf1f311a86adc86d3
-  data.tar.gz: 1b78da495c55cee24ab6b0d6f8d8194ca6cfb27030de7a4ba90db37fa60e3988
+  metadata.gz: daf174f3e936f7c9e466d16f75cc866f779944ae781e39501dae6d51cd74da42
+  data.tar.gz: 42871b642bf002450af142941793c41a1bfd76d6b6c6932b45e6cca9c287cb58
 SHA512:
-  metadata.gz: bd4e66293f491f25caba2a352b509012344bdc6e04c880cb4c3d60d00f3dc38cab50b9c59cf0cbe14c36adc2591610bd004addc28521cf077b7d3b7c91585947
-  data.tar.gz: 036c9de32a86b5e99e1d244fe1200aa3e0dabdf6d610d91c34aa6621bf8a194b9a769a8a9bae254432d2e2bfae67b137a1209c4214bb2c2ce774aa9db9bea907
+  metadata.gz: cf696efe9cfe2582aafd201e30fe6f82aae17f1b137e93a7d2e2b2c34256f4ace88de0d771fc398844c1010999b5c9424f1b2ab0026395ee88b2ad440a88d54a
+  data.tar.gz: eb47ff8a3c0131065400a702d447fb8c170c9d2769860921be61d082ad6affe1ca714bbd211fd2cfe2aec78a89a57bbd32fc76d950d5fa1531feb5b43e29dac9

data/lib/app_profiler/backend/base_backend.rb

@@ -3,10 +3,6 @@
 module AppProfiler
   module Backend
     class BaseBackend
-      def self.name
-        raise NotImplementedError
-      end
-
       def run(params = {}, &block)
         raise NotImplementedError
       end
@@ -31,6 +27,10 @@ module AppProfiler
         def run_lock
           @run_lock ||= Mutex.new
         end
+
+        def name
+          raise NotImplementedError
+        end
       end
 
       protected

data/lib/app_profiler/backend/stackprof_backend.rb

@@ -16,8 +16,10 @@ module AppProfiler
         :object,
       ].freeze
 
-      def self.name
-        :stackprof
+      class << self
+        def name
+          :stackprof
+        end
       end
 
       def run(params = {})
@@ -44,7 +46,7 @@ module AppProfiler
         StackProf.start(**DEFAULTS, **params)
       rescue => error
         AppProfiler.logger.info(
-          "[Profiler] failed to start the profiler error_class=#{error.class} error_message=#{error.message}"
+          "[Profiler] failed to start the profiler error_class=#{error.class} error_message=#{error.message}",
         )
         release_run_lock
         # This is a boolean instead of nil because StackProf#start returns a
@@ -66,7 +68,7 @@ module AppProfiler
         BaseProfile.from_stackprof(stackprof_profile)
       rescue => error
         AppProfiler.logger.info(
-          "[Profiler] failed to obtain the profile error_class=#{error.class} error_message=#{error.message}"
+          "[Profiler] failed to obtain the profile error_class=#{error.class} error_message=#{error.message}",
         )
         nil
       end

data/lib/app_profiler/backend/vernier_backend.rb

@@ -15,8 +15,10 @@ module AppProfiler
         :retained,
       ].freeze
 
-      def self.name
-        :vernier
+      class << self
+        def name
+          :vernier
+        end
       end
 
       def run(params = {})
@@ -48,7 +50,7 @@ module AppProfiler
         @collector.start
       rescue => error
         AppProfiler.logger.info(
-          "[Profiler] failed to start the profiler error_class=#{error.class} error_message=#{error.message}"
+          "[Profiler] failed to start the profiler error_class=#{error.class} error_message=#{error.message}",
         )
         release_run_lock
         # This is a boolean instead of nil to be consistent with the stackprof backend behaviour
@@ -83,7 +85,7 @@ module AppProfiler
         BaseProfile.from_vernier(data)
       rescue => error
         AppProfiler.logger.info(
-          "[Profiler] failed to obtain the profile error_class=#{error.class} error_message=#{error.message}"
+          "[Profiler] failed to obtain the profile error_class=#{error.class} error_message=#{error.message}",
         )
         nil
       end

data/lib/app_profiler/middleware/upload_action.rb

@@ -14,7 +14,7 @@ module AppProfiler
             append_headers(
               response,
               upload: profile_upload,
-              autoredirect: autoredirect.nil? ? AppProfiler.autoredirect : autoredirect
+              autoredirect: autoredirect.nil? ? AppProfiler.autoredirect : autoredirect,
             ) if response
           end
         end

data/lib/app_profiler/middleware.rb

@@ -41,7 +41,7 @@ module AppProfiler
         profile,
         response: response,
         autoredirect: params.autoredirect,
-        async: params.async
+        async: params.async,
       )
 
       response

data/lib/app_profiler/profile.rb

@@ -15,20 +15,22 @@ module AppProfiler
 
     delegate :[], to: :@data
 
-    # This function should not be called if `StackProf.results` returns nil.
-    def self.from_stackprof(data)
-      options = INTERNAL_METADATA_KEYS.map { |key| [key, data[:metadata]&.delete(key)] }.to_h
+    class << self
+      # This function should not be called if `StackProf.results` returns nil.
+      def from_stackprof(data)
+        options = INTERNAL_METADATA_KEYS.map { |key| [key, data[:metadata]&.delete(key)] }.to_h
 
-      StackprofProfile.new(data, **options).tap do |profile|
-        raise ArgumentError, "invalid profile data" unless profile.valid?
+        StackprofProfile.new(data, **options).tap do |profile|
+          raise ArgumentError, "invalid profile data" unless profile.valid?
+        end
       end
-    end
 
-    def self.from_vernier(data)
-      options = INTERNAL_METADATA_KEYS.map { |key| [key, data[:meta]&.delete(key)] }.to_h
+      def from_vernier(data)
+        options = INTERNAL_METADATA_KEYS.map { |key| [key, data[:meta]&.delete(key)] }.to_h
 
-      VernierProfile.new(data, **options).tap do |profile|
-        raise ArgumentError, "invalid profile data" unless profile.valid?
+        VernierProfile.new(data, **options).tap do |profile|
+          raise ArgumentError, "invalid profile data" unless profile.valid?
+        end
       end
     end
 
@@ -44,7 +46,7 @@ module AppProfiler
       AppProfiler.storage.upload(self).tap do |upload|
         if upload && defined?(upload.url)
           AppProfiler.logger.info(
-            <<~INFO.squish
+            <<~INFO.squish,
               [Profiler] data uploaded:
               profile_url=#{upload.url}
               profile_viewer_url=#{AppProfiler.profile_url(upload)}
@@ -54,7 +56,7 @@ module AppProfiler
       end
     rescue => error
       AppProfiler.logger.info(
-        "[Profiler] failed to upload profile error_class=#{error.class} error_message=#{error.message}"
+        "[Profiler] failed to upload profile error_class=#{error.class} error_message=#{error.message}",
       )
       nil
     end
@@ -78,6 +80,10 @@ module AppProfiler
       @data
     end
 
+    def metadata
+      @data[:metadata]
+    end
+
     def mode
       raise NotImplementedError
     end

data/lib/app_profiler/railtie.rb

@@ -41,6 +41,7 @@ module AppProfiler
       AppProfiler.profile_enqueue_failure = app.config.app_profiler.profile_enqueue_failure
       AppProfiler.after_process_queue = app.config.app_profiler.after_process_queue
       AppProfiler.backend = app.config.app_profiler.profiler_backend || :stackprof
+      AppProfiler.forward_metadata_on_upload = app.config.app_profiler.forward_metadata_on_upload || false
     end
 
     initializer "app_profiler.add_middleware" do |app|

data/lib/app_profiler/server.rb

@@ -280,7 +280,7 @@ module AppProfiler
         @listen_thread = nil
 
         @logger.info(
-          "[AppProfiler::Server] listening on addr=#{@transport.socket.addr}"
+          "[AppProfiler::Server] listening on addr=#{@transport.socket.addr}",
         )
         @pid = Process.pid
       end
@@ -342,7 +342,7 @@ module AppProfiler
                 end
               rescue => e
                 @logger.error(
-                  "[AppProfiler::Server] exception #{e} responding to request #{request}: #{e.message}"
+                  "[AppProfiler::Server] exception #{e} responding to request #{request}: #{e.message}",
                 )
               ensure
                 session.close

data/lib/app_profiler/storage/base_storage.rb

@@ -6,12 +6,14 @@ module AppProfiler
       class_attribute :bucket_name, default: "profiles"
       class_attribute :credentials, default: {}
 
-      def self.upload(_profile)
-        raise NotImplementedError
-      end
+      class << self
+        def upload(_profile)
+          raise NotImplementedError
+        end
 
-      def self.enqueue_upload(_profile)
-        raise NotImplementedError
+        def enqueue_upload(_profile)
+          raise NotImplementedError
+        end
       end
     end
   end

data/lib/app_profiler/storage/google_cloud_storage.rb

@@ -15,6 +15,10 @@ module AppProfiler
         def upload(profile, _params = {})
           file = profile.file.open
 
+          metadata = if AppProfiler.forward_metadata_on_upload && profile.metadata.present?
+            profile.metadata
+          end
+
           ActiveSupport::Notifications.instrument(
             "gcs_upload.app_profiler",
             file_size: file.size,
@@ -24,6 +28,7 @@ module AppProfiler
               gcs_filename(profile),
               content_type: "application/json",
               content_encoding: "gzip",
+              metadata: metadata,
             )
           ensure
             profile.file.unlink

data/lib/app_profiler/version.rb

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

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

@@ -9,17 +9,57 @@ module AppProfiler
       class BaseMiddleware
         class Sanitizer < Rails::HTML::Sanitizer.best_supported_vendor.safe_list_sanitizer
           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",
+            "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)
 
-        def self.id(file)
-          file.basename.to_s.delete_suffix(".json")
+        class << self
+          def id(file)
+            file.basename.to_s.delete_suffix(".json")
+          end
         end
 
         def initialize(app)
@@ -87,7 +127,7 @@ module AppProfiler
                   </p>
                 HTML
               end
-            end
+            end,
           )
         end
 

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

@@ -12,7 +12,7 @@ module AppProfiler
         def initialize(app)
           super
           @speedscope = Rack::File.new(
-            File.join(AppProfiler.root, "node_modules/speedscope/dist/release")
+            File.join(AppProfiler.root, "node_modules/speedscope/dist/release"),
           )
         end
 
@@ -33,7 +33,7 @@ module AppProfiler
           end || raise(ArgumentError)
 
           render(
-            <<~HTML
+            <<~HTML,
               <script type="text/javascript">
                 var graph = #{profile.read};
                 var json = JSON.stringify(graph);

data/lib/app_profiler/yarn/command.rb

@@ -49,7 +49,7 @@ module AppProfiler
         exec("which", "yarn", silent: true) do
           raise(
             YarnError,
-            <<~MSG.squish
+            <<~MSG.squish,
               `yarn` command not found.
               Please install `yarn` or make it available in PATH.
             MSG

data/lib/app_profiler.rb

@@ -61,6 +61,7 @@ module AppProfiler
   mattr_reader :profile_enqueue_success, default: nil
   mattr_reader :profile_enqueue_failure, default: nil
   mattr_reader :after_process_queue, default: nil
+  mattr_accessor :forward_metadata_on_upload, default: false
 
   class << self
     def run(*args, backend: nil, **kwargs, &block)
@@ -70,7 +71,7 @@ module AppProfiler
         profiler.run(*args, **kwargs, &block)
       rescue BackendError => e
         logger.error(
-          "[AppProfiler.run] exception #{e} configuring backend #{backend}: #{e.message}"
+          "[AppProfiler.run] exception #{e} configuring backend #{backend}: #{e.message}",
         )
         yield
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -10,10 +10,10 @@ authors:
 - Jon Simpson
 - Kevin Jalbert
 - Scott Francis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -127,7 +127,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - gems@shopify.com
 executables: []
@@ -165,7 +165,7 @@ homepage: https://github.com/Shopify/app_profiler
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,8 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Collect performance profiles for your Rails application.
 test_files: []