app_profiler 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36a0afed63f70a16ab782039e981583c16e80f846eb6caf6cefce219d7934d0d
-  data.tar.gz: eda36bd2a579b25757db0e872c3f2aa1cbdda60ddf486b4bd3ad90f34f74829c
+  metadata.gz: 1d088d71f0d625a8627a17aa418840597b1d26e01bc05a93848440ce710f461a
+  data.tar.gz: 5f65cc77daaeaacbeed54cc913c08e89fddbc30e64458e1538c2cce2f5e9b381
 SHA512:
-  metadata.gz: 8ef999eb872722bca7b910b88df8a091c756b4d9f0e95da4ac770aacfb0b5454a160ca37b8c13852e25e5fd8aecf698f6bc06f6669104cbbb02c5af033b66a80
-  data.tar.gz: 2896ca3138e8b631445b628bcd6206e77bcd94fbef57c00560b0a63f8677b3103555eef97aabbb936722406d5667ec6c8885c9224fe85cd82d2619f45fdb9051
+  metadata.gz: a99c98c4bcf876d9c7147bf552b47ae5b8052f2e3c314a2279c8e34a2f37a9781f47c9f7ee99260281490682d1ea776f00be946494dd8fcd0bb83cbd5db07537
+  data.tar.gz: 4fafc43c3a589636928566a4bdf96fde0abf91eebde85e267852c281f7b5439ce76048c1cbca1cfe18119b99057bc7355fe41c2e48537c6b6a62f7a41b0ffa4b

data/lib/app_profiler/{profile.rb → base_profile.rb}

@@ -3,9 +3,6 @@
 require "active_support/deprecation/constant_accessor"
 
 module AppProfiler
-  autoload :StackprofProfile, "app_profiler/profile/stackprof"
-  autoload :VernierProfile, "app_profiler/profile/vernier"
-
   class BaseProfile
     INTERNAL_METADATA_KEYS = [:id, :context]
     private_constant :INTERNAL_METADATA_KEYS
@@ -99,19 +96,20 @@ module AppProfiler
     private
 
     def path
-      filename = [
-        AppProfiler.profile_file_prefix.call,
-        mode,
-        id,
-        Socket.gethostname,
-      ].compact.join("-") << format
+      filename = if AppProfiler.profile_file_name.present?
+        AppProfiler.profile_file_name.call(metadata) + format
+      else
+        [
+          AppProfiler.profile_file_prefix.call,
+          mode,
+          id,
+          Socket.gethostname,
+        ].compact.join("-") << format
+      end
 
       raise UnsafeFilename if /[^0-9A-Za-z.\-\_]/.match?(filename)
 
       AppProfiler.profile_root.join(filename)
     end
   end
-
-  include ActiveSupport::Deprecation::DeprecatedConstantAccessor
-  deprecate_constant "Profile", "AppProfiler::BaseProfile", deprecator: ActiveSupport::Deprecation.new
 end

data/lib/app_profiler/exec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module AppProfiler
+  module Exec # :nodoc:
+    protected
+
+    def valid_commands
+      raise NotImplementedError
+    end
+
+    def ensure_command_valid(command)
+      unless valid_command?(command)
+        raise ArgumentError, "Illegal command: #{command.join(" ")}."
+      end
+    end
+
+    def valid_command?(command)
+      valid_commands.any? do |valid_command|
+        next unless valid_command.size == command.size
+
+        valid_command.zip(command).all? do |valid_part, part|
+          part.match?(valid_part)
+        end
+      end
+    end
+
+    def exec(*command, silent: false, environment: {})
+      ensure_command_valid(command)
+
+      if silent
+        system(environment, *command, out: File::NULL).tap { |return_code| yield unless return_code }
+      else
+        system(environment, *command).tap { |return_code| yield unless return_code }
+      end
+    end
+  end
+end

data/lib/app_profiler/middleware.rb

@@ -4,7 +4,6 @@ require "rack"
 require "app_profiler/middleware/base_action"
 require "app_profiler/middleware/upload_action"
 require "app_profiler/middleware/view_action"
-require "app_profiler/sampler/config"
 
 module AppProfiler
   class Middleware

data/lib/app_profiler/railtie.rb

@@ -11,7 +11,12 @@ module AppProfiler
       AppProfiler.logger = app.config.app_profiler.logger || Rails.logger
       AppProfiler.root = app.config.app_profiler.root || Rails.root
       AppProfiler.storage = app.config.app_profiler.storage || Storage::FileStorage
-      AppProfiler.viewer = app.config.app_profiler.viewer || Viewer::SpeedscopeViewer
+      if app.config.app_profiler.stackprof_viewer
+        AppProfiler.stackprof_viewer = app.config.app_profiler.stackprof_viewer
+      end
+      if app.config.app_profiler.vernier_viewer
+        AppProfiler.vernier_viewer = app.config.app_profiler.vernier_viewer
+      end
       AppProfiler.storage.bucket_name = app.config.app_profiler.storage_bucket_name || "profiles"
       AppProfiler.storage.credentials = app.config.app_profiler.storage_credentials || {}
       AppProfiler.middleware = app.config.app_profiler.middleware || Middleware
@@ -37,10 +42,11 @@ module AppProfiler
       AppProfiler.upload_queue_max_length = app.config.app_profiler.upload_queue_max_length || 10
       AppProfiler.upload_queue_interval_secs = app.config.app_profiler.upload_queue_interval_secs || 5
       AppProfiler.profile_file_prefix = app.config.app_profiler.profile_file_prefix || DefaultProfilePrefix
+      AppProfiler.profile_file_name = app.config.app_profiler.profile_file_name
       AppProfiler.profile_enqueue_success = app.config.app_profiler.profile_enqueue_success
       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.backend = app.config.app_profiler.profiler_backend || :stackprof unless AppProfiler.running?
       AppProfiler.forward_metadata_on_upload = app.config.app_profiler.forward_metadata_on_upload || false
       AppProfiler.profile_sampler_enabled = app.config.app_profiler.profile_sampler_enabled || false
       AppProfiler.profile_sampler_config = app.config.app_profiler.profile_sampler_config ||
@@ -49,8 +55,8 @@ module AppProfiler
 
     initializer "app_profiler.add_middleware" do |app|
       unless AppProfiler.middleware.disabled
-        if AppProfiler.viewer == Viewer::SpeedscopeRemoteViewer
-          app.middleware.insert_before(0, Viewer::SpeedscopeRemoteViewer::Middleware)
+        if (Rails.env.development? || Rails.env.test?) && AppProfiler.stackprof_viewer.remote?
+          app.middleware.insert_before(0, AppProfiler.viewer::Middleware)
         end
         app.middleware.insert_before(0, AppProfiler.middleware)
       end

data/lib/app_profiler/sampler/config.rb

@@ -2,6 +2,7 @@
 
 require "app_profiler/sampler/stackprof_config"
 require "app_profiler/sampler/vernier_config"
+
 module AppProfiler
   module Sampler
     class Config
@@ -27,7 +28,7 @@ module AppProfiler
 
         raise ArgumentError, "mode probabilities must sum to 1" unless backends_probability.values.sum == 1.0
 
-        ActiveSupport::Deprecation.new.warn("passing paths is deprecated, use targets instead") if paths
+        AppProfiler.deprecator.warn("passing paths is deprecated, use targets instead") if paths
 
         @sample_rate = sample_rate
         @targets = paths || targets

data/lib/app_profiler/sampler.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "app_profiler/sampler/config"
+
 module AppProfiler
   module Sampler
     @excluded_cache = {}

data/lib/app_profiler/{profile/stackprof.rb → stackprof_profile.rb}

@@ -2,7 +2,7 @@
 
 module AppProfiler
   class StackprofProfile < BaseProfile
-    FILE_EXTENSION = ".json"
+    FILE_EXTENSION = ".stackprof.json"
 
     def mode
       @data[:mode]
@@ -17,7 +17,7 @@ module AppProfiler
     end
 
     def view(params = {})
-      AppProfiler.viewer.view(self, **params)
+      AppProfiler.stackprof_viewer.view(self, **params)
     end
   end
 end

data/lib/app_profiler/storage/google_cloud_storage.rb

@@ -37,7 +37,7 @@ module AppProfiler
 
         def enqueue_upload(profile)
           mutex.synchronize do
-            process_queue_thread unless @process_queue_thread&.alive?
+            start_process_queue_thread
 
             @queue ||= init_queue
             begin
@@ -50,12 +50,6 @@ module AppProfiler
           end
         end
 
-        def reset_queue # for testing
-          init_queue
-          @process_queue_thread&.kill
-          @process_queue_thread = nil
-        end
-
         private
 
         def mutex
@@ -66,8 +60,10 @@ module AppProfiler
           @queue = SizedQueue.new(AppProfiler.upload_queue_max_length)
         end
 
-        def process_queue_thread
-          @process_queue_thread ||= Thread.new do
+        def start_process_queue_thread
+          return if @process_queue_thread&.alive?
+
+          @process_queue_thread = Thread.new do
             loop do
               process_queue
               sleep(AppProfiler.upload_queue_interval_secs)

data/lib/app_profiler/{profile/vernier.rb → vernier_profile.rb}

@@ -2,7 +2,7 @@
 
 module AppProfiler
   class VernierProfile < BaseProfile
-    FILE_EXTENSION = ".gecko.json"
+    FILE_EXTENSION = ".vernier.json"
 
     def mode
       @data[:meta][:mode]
@@ -17,7 +17,7 @@ module AppProfiler
     end
 
     def view(params = {})
-      raise NotImplementedError
+      AppProfiler.vernier_viewer.view(self, **params)
     end
   end
 end

data/lib/app_profiler/version.rb

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

data/lib/app_profiler/viewer/base_middleware.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+gem "rails-html-sanitizer", ">= 1.6.0"
+require "rails-html-sanitizer"
+
+module AppProfiler
+  module Viewer
+    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",
+        ])
+      end
+
+      private_constant(:Sanitizer)
+
+      class << self
+        def id(file)
+          file.basename.to_s
+        end
+      end
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        request = Rack::Request.new(env)
+
+        return index(env) if %r(\A/app_profiler/?\z).match?(request.path_info)
+
+        @app.call(env)
+      end
+
+      protected
+
+      def id(file)
+        self.class.id(file)
+      end
+
+      def profile_files
+        AppProfiler.profile_root.glob("**/*.json")
+      end
+
+      def render(html)
+        [
+          200,
+          { "Content-Type" => "text/html" },
+          [
+            +<<~HTML,
+              <!doctype html>
+              <html>
+                <head>
+                  <title>App Profiler</title>
+                </head>
+                <body>
+                  #{sanitizer.sanitize(html)}
+                </body>
+              </html>
+            HTML
+          ],
+        ]
+      end
+
+      def sanitizer
+        @sanitizer ||= Sanitizer.new
+      end
+
+      def viewer(_env, path)
+        raise NotImplementedError
+      end
+
+      def show(env, id)
+        raise NotImplementedError
+      end
+
+      def index(_env)
+        render(
+          (+"").tap do |content|
+            content << "<h1>Profiles</h1>"
+            profile_files.each do |file|
+              viewer = if file.to_s.end_with?(AppProfiler::VernierProfile::FILE_EXTENSION)
+                AppProfiler::Viewer::FirefoxRemoteViewer::NAME
+              else
+                AppProfiler::Viewer::SpeedscopeRemoteViewer::NAME
+              end
+              content << <<~HTML
+                <p>
+                  <a href="/app_profiler/#{viewer}/viewer/#{id(file)}">
+                    #{id(file)}
+                  </a>
+                </p>
+              HTML
+            end
+          end,
+        )
+      end
+    end
+  end
+end

data/lib/app_profiler/viewer/base_viewer.rb

@@ -7,10 +7,10 @@ module AppProfiler
         def view(profile, params = {})
           new(profile).view(**params)
         end
-      end
 
-      def view(_params = {})
-        raise NotImplementedError
+        def remote?
+          false
+        end
       end
     end
   end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "app_profiler/yarn/command"
+require "app_profiler/yarn/with_firefox_profiler"
+
+module AppProfiler
+  module Viewer
+    class FirefoxRemoteViewer < BaseViewer
+      class Middleware < AppProfiler::Viewer::BaseMiddleware
+        include Yarn::WithFirefoxProfiler
+
+        def initialize(app)
+          super
+          @firefox_profiler = Rack::File.new(
+            File.join(AppProfiler.root, "node_modules/firefox-profiler/dist"),
+          )
+        end
+
+        def call(env)
+          request = Rack::Request.new(env)
+          # Firefox profiler *really* doesn't like for /from-url/ to be at any other mount point
+          # so with this enabled, we take over both /app_profiler and /from-url in the app in development.
+          return from(env, Regexp.last_match(1))   if request.path_info =~ %r(\A/from-url/(.*)\z)
+          return viewer(env, Regexp.last_match(1)) if request.path_info =~ %r(\A/app_profiler/firefox/viewer/(.*)\z)
+          return show(env, Regexp.last_match(1))   if request.path_info =~ %r(\A/app_profiler/firefox/(.*)\z)
+
+          super
+        end
+
+        protected
+
+        attr_reader(:firefox_profiler)
+
+        def viewer(env, path)
+          setup_yarn unless yarn_setup
+
+          if path.end_with?(AppProfiler::VernierProfile::FILE_EXTENSION)
+            proto = env["rack.url_scheme"]
+            host = env["HTTP_HOST"]
+            source = "#{proto}://#{host}/app_profiler/firefox/#{path}"
+            target = "/from-url/#{CGI.escape(source)}"
+
+            [302, { "Location" => target }, [""]]
+          else
+            env[Rack::PATH_INFO] = path.delete_prefix("/app_profiler")
+            firefox_profiler.call(env)
+          end
+        end
+
+        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]]
+        end
+
+        def show(_env, name)
+          profile = profile_files.find do |file|
+            id(file) == name
+          end || raise(ArgumentError)
+
+          [200, { "Content-Type" => "application/json" }, [profile.read]]
+        end
+      end
+    end
+  end
+end

data/lib/app_profiler/viewer/firefox_remote_viewer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "app_profiler/viewer/firefox_remote_viewer/middleware"
+
+module AppProfiler
+  module Viewer
+    class FirefoxRemoteViewer < BaseViewer
+      NAME = "firefox"
+
+      class << self
+        def remote?
+          true
+        end
+      end
+
+      def initialize(profile)
+        super()
+        @profile = profile
+      end
+
+      def view(response: nil, autoredirect: nil, async: false)
+        id = Middleware.id(@profile.file)
+
+        if response && response[0].to_i < 500
+          response[1]["Location"] = "/app_profiler/#{NAME}/viewer/#{id}"
+          response[0] = 303
+        else
+          AppProfiler.logger.info("[Profiler] Profile available at /app_profiler/#{id}\n")
+        end
+      end
+    end
+  end
+end

data/lib/app_profiler/viewer/firefox_viewer.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "app_profiler/exec"
+
+module AppProfiler
+  module Viewer
+    class FirefoxViewer < BaseViewer
+      include Exec
+
+      CHILD_PIDS = []
+
+      at_exit { Process.wait if CHILD_PIDS.any? }
+
+      trap("INT") do
+        CHILD_PIDS.each { |pid| Process.kill("INT", pid) }
+        sleep(0.5)
+      end
+
+      class ProfileViewerError < StandardError; end
+
+      VALID_COMMANDS = [
+        ["which", "profile-viewer"],
+        ["gem", "install", "profile-viewer"],
+        ["profile-viewer", /.*\.json/],
+      ]
+      private_constant(:VALID_COMMANDS)
+
+      class << self
+        def view(profile, params = {})
+          new(profile).view(**params)
+        end
+      end
+
+      def valid_commands
+        VALID_COMMANDS
+      end
+
+      def initialize(profile)
+        super()
+        @profile = profile
+      end
+
+      def view(_params = {})
+        profile_viewer(@profile.file.to_s)
+      end
+
+      private
+
+      def setup_profile_viewer
+        exec("which", "profile-viewer", silent: true) do
+          gem_install("profile-viewer")
+        end
+        @profile_viewer_initialized = true
+      end
+
+      def profile_viewer_setup
+        @profile_viewer_initialized || false
+      end
+
+      def gem_install(gem)
+        exec("gem", "install", gem) do
+          raise ProfileViewerError, "Failed to run gem install #{gem}."
+        end
+      end
+
+      def profile_viewer(path)
+        setup_profile_viewer unless profile_viewer_setup
+
+        CHILD_PIDS << fork do
+          Bundler.with_unbundled_env do
+            exec("profile-viewer", path) do
+              raise ProfileViewerError, "Failed to run profile-viewer."
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,14 +16,23 @@ module AppProfiler
           )
         end
 
+        def call(env)
+          request = Rack::Request.new(env)
+
+          return viewer(env, Regexp.last_match(1)) if request.path_info =~ %r(\A/app_profiler/speedscope/viewer/(.*)\z)
+          return show(env, Regexp.last_match(1))   if request.path_info =~ %r(\A/app_profiler/speedscope/(.*)\z)
+
+          super
+        end
+
         protected
 
         attr_reader(:speedscope)
 
         def viewer(env, path)
           setup_yarn unless yarn_setup
-          env[Rack::PATH_INFO] = path.delete_prefix("/app_profiler")
 
+          env[Rack::PATH_INFO] = path.delete_prefix("/app_profiler/speedscope")
           speedscope.call(env)
         end
 
@@ -32,25 +41,7 @@ module AppProfiler
             id(file) == name
           end || raise(ArgumentError)
 
-          render(
-            <<~HTML,
-              <script type="text/javascript">
-                var graph = #{profile.read};
-                var json = JSON.stringify(graph);
-                var blob = new Blob([json], { type: 'text/plain' });
-                var objUrl = encodeURIComponent(URL.createObjectURL(blob));
-                var iframe = document.createElement('iframe');
-
-                document.body.style.margin = '0px';
-                document.body.appendChild(iframe);
-
-                iframe.style.width = '100vw';
-                iframe.style.height = '100vh';
-                iframe.style.border = 'none';
-                iframe.setAttribute('src', '/app_profiler/viewer/index.html#profileURL=' + objUrl + '&title=' + 'Flamegraph for #{name}');
-              </script>
-            HTML
-          )
+          [200, { "Content-Type" => "application/json" }, [profile.read]]
         end
       end
     end

data/lib/app_profiler/viewer/speedscope_remote_viewer.rb

@@ -1,14 +1,22 @@
 # frozen_string_literal: true
 
-require "app_profiler/viewer/speedscope_remote_viewer/base_middleware"
+require "active_support/deprecation/constant_accessor"
 require "app_profiler/viewer/speedscope_remote_viewer/middleware"
 
 module AppProfiler
   module Viewer
     class SpeedscopeRemoteViewer < BaseViewer
+      include ActiveSupport::Deprecation::DeprecatedConstantAccessor
+      deprecate_constant(
+        "BaseMiddleware",
+        "AppProfiler::Viewer::BaseMiddleware",
+        deprecator: AppProfiler.deprecator,
+      )
+      NAME = "speedscope"
+
       class << self
-        def view(profile, params = {})
-          new(profile).view(**params)
+        def remote?
+          true
         end
       end
 
@@ -21,7 +29,7 @@ module AppProfiler
         id = Middleware.id(@profile.file)
 
         if response && response[0].to_i < 500
-          response[1]["Location"] = "/app_profiler/#{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_viewer.rb

@@ -8,12 +8,6 @@ module AppProfiler
     class SpeedscopeViewer < BaseViewer
       include Yarn::WithSpeedscope
 
-      class << self
-        def view(profile, params = {})
-          new(profile).view(**params)
-        end
-      end
-
       def initialize(profile)
         super()
         @profile = profile

data/lib/app_profiler/yarn/command.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require "app_profiler/exec"
+
 module AppProfiler
   module Yarn
     module Command
+      include Exec
+
       class YarnError < StandardError; end
 
       VALID_COMMANDS = [
@@ -10,10 +14,16 @@ module AppProfiler
         ["yarn", "init", "--yes"],
         ["yarn", "add", "speedscope", "--dev", "--ignore-workspace-root-check"],
         ["yarn", "run", "speedscope", /.*\.json/],
+        ["yarn", "add", "--dev", %r{.*/firefox-profiler}],
+        ["yarn", "--cwd", %r{.*/firefox-profiler}],
+        ["yarn", "--cwd", %r{.*/firefox-profiler}, "build-prod"],
       ]
 
       private_constant(:VALID_COMMANDS)
-      mattr_accessor(:yarn_setup, default: false)
+
+      def valid_commands
+        VALID_COMMANDS
+      end
 
       def yarn(command, *options)
         setup_yarn unless yarn_setup
@@ -29,22 +39,16 @@ module AppProfiler
         yarn("init", "--yes") unless package_json_exists?
       end
 
-      private
-
-      def ensure_command_valid(command)
-        unless valid_command?(command)
-          raise YarnError, "Illegal command: #{command.join(" ")}."
-        end
+      def yarn_setup
+        @yarn_initialized || false
       end
 
-      def valid_command?(command)
-        VALID_COMMANDS.any? do |valid_command|
-          valid_command.zip(command).all? do |valid_part, part|
-            part.match?(valid_part)
-          end
-        end
+      def yarn_setup=(state)
+        @yarn_initialized = state
       end
 
+      private
+
       def ensure_yarn_installed
         exec("which", "yarn", silent: true) do
           raise(
@@ -55,22 +59,12 @@ module AppProfiler
             MSG
           )
         end
-        self.yarn_setup = true
+        @yarn_initialized = true
       end
 
       def package_json_exists?
         AppProfiler.root.join("package.json").exist?
       end
-
-      def exec(*command, silent: false)
-        ensure_command_valid(command)
-
-        if silent
-          system(*command, out: File::NULL).tap { |return_code| yield unless return_code }
-        else
-          system(*command).tap { |return_code| yield unless return_code }
-        end
-      end
     end
   end
 end

data/lib/app_profiler/yarn/with_firefox_profiler.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module AppProfiler
+  module Yarn
+    module WithFirefoxProfiler
+      include Command
+
+      PACKAGE = "https://github.com/tenderlove/profiler#v0.0.2"
+      VALID_COMMANDS = [
+        *VALID_COMMANDS,
+        ["git", "clone", "https://github.com/tenderlove/profiler", "firefox-profiler", "--branch=v0.0.2"],
+      ]
+      private_constant(:PACKAGE, :VALID_COMMANDS)
+
+      def setup_yarn
+        super
+        return if firefox_profiler_added?
+
+        fetch_firefox_profiler
+      end
+
+      def valid_commands
+        VALID_COMMANDS
+      end
+
+      private
+
+      def firefox_profiler_added?
+        AppProfiler.root.join("node_modules/firefox-profiler/dist").exist?
+      end
+
+      def fetch_firefox_profiler
+        repo, branch = PACKAGE.to_s.split("#")
+
+        dir = "./tmp"
+        FileUtils.mkdir_p(dir)
+        Dir.chdir(dir) do
+          clone_args = ["git", "clone", repo, "firefox-profiler"]
+          clone_args.push("--branch=#{branch}") unless branch.nil? || branch&.empty?
+          exec(*clone_args)
+          package_contents = File.read("firefox-profiler/package.json")
+          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)
+        end
+        yarn("--cwd", "#{dir}/firefox-profiler")
+
+        patch_firefox_profiler(dir)
+        yarn("--cwd", "#{dir}/firefox-profiler", "build-prod")
+        patch_file(
+          "#{dir}/firefox-profiler/dist/index.html",
+          'href="locales/en-US/app.ftl"',
+          'href="/app_profiler/firefox/viewer/locales/en-US/app.ftl"',
+        )
+
+        yarn("add", "--dev", "#{dir}/firefox-profiler")
+      end
+
+      def patch_firefox_profiler(dir)
+        # Patch the publicPath so that the app can be "mounted" at the right location
+        patch_file(
+          "#{dir}/firefox-profiler/webpack.config.js",
+          "publicPath: '/'",
+          "publicPath: '/app_profiler/firefox/viewer/'",
+        )
+        patch_file(
+          "#{dir}/firefox-profiler/src/app-logic/l10n.js",
+          "fetch(`/locales/",
+          "fetch(`/app_profiler/firefox/viewer/locales/",
+        )
+      end
+
+      def patch_file(file, find, replace)
+        contents = File.read(file)
+        new_contents = contents.gsub(find, replace)
+        File.write(file, new_contents)
+      end
+    end
+  end
+end

data/lib/app_profiler.rb

@@ -30,16 +30,21 @@ module AppProfiler
   module Viewer
     autoload :BaseViewer, "app_profiler/viewer/base_viewer"
     autoload :SpeedscopeViewer, "app_profiler/viewer/speedscope_viewer"
+    autoload :FirefoxViewer, "app_profiler/viewer/firefox_viewer"
+    autoload :BaseMiddleware, "app_profiler/viewer/base_middleware"
     autoload :SpeedscopeRemoteViewer, "app_profiler/viewer/speedscope_remote_viewer"
+    autoload :FirefoxRemoteViewer, "app_profiler/viewer/firefox_remote_viewer"
   end
 
-  require "app_profiler/middleware"
-  require "app_profiler/parameters"
-  require "app_profiler/request_parameters"
-  require "app_profiler/profile"
-  require "app_profiler/backend"
-  require "app_profiler/server"
-  require "app_profiler/sampler"
+  autoload(:Middleware, "app_profiler/middleware")
+  autoload(:Parameters, "app_profiler/parameters")
+  autoload(:RequestParameters, "app_profiler/request_parameters")
+  autoload(:BaseProfile, "app_profiler/base_profile")
+  autoload :StackprofProfile, "app_profiler/stackprof_profile"
+  autoload :VernierProfile, "app_profiler/vernier_profile"
+  autoload(:Backend, "app_profiler/backend")
+  autoload(:Server, "app_profiler/server")
+  autoload(:Sampler, "app_profiler/sampler")
 
   mattr_accessor :logger, default: Logger.new($stdout)
   mattr_accessor :root
@@ -50,11 +55,10 @@ module AppProfiler
   mattr_reader   :profile_header, default: "X-Profile"
   mattr_accessor :profile_async_header, default: "X-Profile-Async"
   mattr_accessor :context, default: nil
-  mattr_reader   :profile_url_formatter,
-    default: DefaultProfileFormatter
-
+  mattr_reader   :profile_url_formatter, default: DefaultProfileFormatter
   mattr_accessor :storage, default: Storage::FileStorage
-  mattr_accessor :viewer, default: Viewer::SpeedscopeViewer
+  mattr_writer :stackprof_viewer, default: nil
+  mattr_writer :vernier_viewer, default: nil
   mattr_accessor :middleware, default: Middleware
   mattr_accessor :server, default: Server
   mattr_accessor :upload_queue_max_length, default: 10
@@ -64,59 +68,73 @@ module AppProfiler
   mattr_reader :profile_enqueue_failure, default: nil
   mattr_reader :after_process_queue, default: nil
   mattr_accessor :forward_metadata_on_upload, default: false
-
   mattr_accessor :profile_sampler_config
+  mattr_reader :profile_file_name
 
   class << self
+    def deprecator # :nodoc:
+      @deprecator ||= ActiveSupport::Deprecation.new("in future releases", "app_profiler")
+    end
+
     def run(*args, backend: nil, **kwargs, &block)
-      orig_backend = self.backend
-      begin
-        self.backend = backend if backend
-        profiler.run(*args, **kwargs, &block)
-      rescue BackendError => e
-        logger.error(
-          "[AppProfiler.run] exception #{e} configuring backend #{backend}: #{e.message}",
-        )
-        yield
+      if backend
+        original_backend = self.backend
+        self.backend = backend
       end
+      profiler.run(*args, **kwargs, &block)
+    rescue BackendError => e
+      logger.error(
+        "[AppProfiler.run] exception #{e} configuring backend #{backend}: #{e.message}",
+      )
+      yield
     ensure
-      AppProfiler.backend = orig_backend
+      self.backend = original_backend if backend
     end
 
-    def start(*args)
-      profiler.start(*args)
+    def start(*args, backend: nil, **kwargs)
+      self.backend = backend if backend
+      profiler.start(*args, **kwargs)
     end
 
     def stop
       profiler.stop
-      profiler.results
+      profiler.results.tap { clear }
     end
 
     def running?
-      @backend&.running?
+      @profiler&.running?
     end
 
     def profiler
-      backend
-      @backend ||= @profiler_backend.new
+      @profiler ||= profiler_backend.new
     end
 
     def backend=(new_backend)
-      return if new_backend == backend
-
-      new_profiler_backend = backend_for(new_backend)
+      return if (new_profiler_backend = backend_for(new_backend)) == profiler_backend
 
       if running?
         raise BackendError,
           "cannot change backend to #{new_backend} while #{backend} backend is running"
       end
 
-      return if @profiler_backend == new_profiler_backend
-
       clear
       @profiler_backend = new_profiler_backend
     end
 
+    def stackprof_viewer
+      @@stackprof_viewer ||= Viewer::SpeedscopeViewer # rubocop:disable Style/ClassVars
+    end
+
+    def vernier_viewer
+      @@vernier_viewer ||= Viewer::FirefoxViewer # rubocop:disable Style/ClassVars
+    end
+
+    def profile_file_name=(value)
+      raise ArgumentError, "profile_file_name must be a proc" if value && !value.is_a?(Proc)
+
+      @@profile_file_name = value # rubocop:disable Style/ClassVars
+    end
+
     def profile_sampler_enabled=(value)
       if value.is_a?(Proc)
         raise ArgumentError,
@@ -141,22 +159,21 @@ module AppProfiler
 
     def backend_for(backend_name)
       if vernier_supported? &&
-          backend_name == AppProfiler::Backend::VernierBackend.name
+          backend_name&.to_sym == AppProfiler::Backend::VernierBackend.name
         AppProfiler::Backend::VernierBackend
-      elsif backend_name == AppProfiler::Backend::StackprofBackend.name
+      elsif backend_name&.to_sym == AppProfiler::Backend::StackprofBackend.name
         AppProfiler::Backend::StackprofBackend
       else
-        raise BackendError, "unknown backend #{backend_name}"
+        raise BackendError, "unknown backend #{backend_name.inspect}"
       end
     end
 
     def backend
-      @profiler_backend ||= Backend::StackprofBackend
-      @profiler_backend.name
+      profiler_backend.name
     end
 
     def vernier_supported?
-      defined?(AppProfiler::Backend::VernierBackend.name)
+      RUBY_VERSION >= "3.2.1" && defined?(AppProfiler::Backend::VernierBackend.name)
     end
 
     def profile_header=(profile_header)
@@ -207,11 +224,26 @@ module AppProfiler
       AppProfiler.profile_url_formatter.call(upload)
     end
 
+    def viewer
+      deprecator.warn("AppProfiler.viewer is deprecated, please use stackprof_viewer instead.")
+      stackprof_viewer
+    end
+
+    def viewer=(viewer)
+      deprecator.warn("AppProfiler.viewer= is deprecated, please use stackprof_viewer= instead.")
+      self.stackprof_viewer = viewer
+    end
+
     private
 
+    def profiler_backend
+      @profiler_backend ||= Backend::StackprofBackend
+    end
+
     def clear
-      @backend.stop if @backend&.running?
-      @backend = nil
+      profiler.stop if running?
+      @profiler = nil
+      @profiler_backend = nil
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -10,10 +10,9 @@ authors:
 - Jon Simpson
 - Kevin Jalbert
 - Scott Francis
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-15 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -127,7 +126,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - gems@shopify.com
 executables: []
@@ -139,14 +137,13 @@ files:
 - lib/app_profiler/backend/base_backend.rb
 - lib/app_profiler/backend/stackprof_backend.rb
 - lib/app_profiler/backend/vernier_backend.rb
+- lib/app_profiler/base_profile.rb
+- lib/app_profiler/exec.rb
 - lib/app_profiler/middleware.rb
 - lib/app_profiler/middleware/base_action.rb
 - lib/app_profiler/middleware/upload_action.rb
 - lib/app_profiler/middleware/view_action.rb
 - lib/app_profiler/parameters.rb
-- lib/app_profiler/profile.rb
-- lib/app_profiler/profile/stackprof.rb
-- lib/app_profiler/profile/vernier.rb
 - lib/app_profiler/railtie.rb
 - lib/app_profiler/request_parameters.rb
 - lib/app_profiler/sampler.rb
@@ -154,22 +151,27 @@ files:
 - lib/app_profiler/sampler/stackprof_config.rb
 - lib/app_profiler/sampler/vernier_config.rb
 - lib/app_profiler/server.rb
+- lib/app_profiler/stackprof_profile.rb
 - lib/app_profiler/storage/base_storage.rb
 - lib/app_profiler/storage/file_storage.rb
 - lib/app_profiler/storage/google_cloud_storage.rb
+- lib/app_profiler/vernier_profile.rb
 - lib/app_profiler/version.rb
+- lib/app_profiler/viewer/base_middleware.rb
 - lib/app_profiler/viewer/base_viewer.rb
+- lib/app_profiler/viewer/firefox_remote_viewer.rb
+- lib/app_profiler/viewer/firefox_remote_viewer/middleware.rb
+- lib/app_profiler/viewer/firefox_viewer.rb
 - lib/app_profiler/viewer/speedscope_remote_viewer.rb
-- lib/app_profiler/viewer/speedscope_remote_viewer/base_middleware.rb
 - lib/app_profiler/viewer/speedscope_remote_viewer/middleware.rb
 - lib/app_profiler/viewer/speedscope_viewer.rb
 - lib/app_profiler/yarn/command.rb
+- lib/app_profiler/yarn/with_firefox_profiler.rb
 - lib/app_profiler/yarn/with_speedscope.rb
 homepage: https://github.com/Shopify/app_profiler
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Collect performance profiles for your Rails application.
 test_files: []

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

@@ -1,142 +0,0 @@
-# frozen_string_literal: true
-
-gem "rails-html-sanitizer", ">= 1.6.0"
-require "rails-html-sanitizer"
-
-module AppProfiler
-  module Viewer
-    class SpeedscopeRemoteViewer < BaseViewer
-      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",
-          ])
-        end
-
-        private_constant(:Sanitizer)
-
-        class << self
-          def id(file)
-            file.basename.to_s.delete_suffix(".json")
-          end
-        end
-
-        def initialize(app)
-          @app = app
-        end
-
-        def call(env)
-          request = Rack::Request.new(env)
-
-          return index(env)                        if request.path_info =~ %r(\A/app_profiler/?\z)
-          return viewer(env, Regexp.last_match(1)) if request.path_info =~ %r(\A/app_profiler/viewer/(.*)\z)
-          return show(env, Regexp.last_match(1))   if request.path_info =~ %r(\A/app_profiler/(.*)\z)
-
-          @app.call(env)
-        end
-
-        protected
-
-        def id(file)
-          self.class.id(file)
-        end
-
-        def profile_files
-          AppProfiler.profile_root.glob("**/*.json")
-        end
-
-        def render(html)
-          [
-            200,
-            { "Content-Type" => "text/html" },
-            [
-              +<<~HTML,
-                <!doctype html>
-                <html>
-                  <head>
-                    <title>App Profiler</title>
-                  </head>
-                  <body>
-                    #{sanitizer.sanitize(html)}
-                  </body>
-                </html>
-              HTML
-            ],
-          ]
-        end
-
-        def sanitizer
-          @sanitizer ||= Sanitizer.new
-        end
-
-        def viewer(_env, path)
-          raise NotImplementedError
-        end
-
-        def index(_env)
-          render(
-            (+"").tap do |content|
-              content << "<h1>Profiles</h1>"
-              profile_files.each do |file|
-                content << <<~HTML
-                  <p>
-                    <a href="/app_profiler/#{id(file)}">
-                      #{id(file)}
-                    </a>
-                  </p>
-                HTML
-              end
-            end,
-          )
-        end
-
-        def show(env, id)
-          raise NotImplementedError
-        end
-      end
-
-      private_constant(:BaseMiddleware)
-    end
-  end
-end