app_profiler 0.0.6 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e470d5d476934d052b8f5229cea27500fd089d46228458bee9caccd6147d4fdc
-  data.tar.gz: a7087d13e92ccb0f709bd566c171395bcbc7a3a4d3cdd840cdaf54b712f371f2
+  metadata.gz: 160040c64c01368d5a6832e6fccc20ed14eecdd7ff0a4a9a18e4f7aeee62c83b
+  data.tar.gz: 76107cd56b460c68e33ef32677a3d822e83319b3cb9084e39e30841ee8bb8db7
 SHA512:
-  metadata.gz: e87134e41f02914bce8da256ab75e11eb160dee8dfe05121aff17c9f537c71af68c832efa750ab4713b3d5365f51fa08938e678f434e04fc9de4b6b830d870ce
-  data.tar.gz: fa2d66d349c5328ad24a6fac732ab04dd67fe77184ac32f680d55f06b204deaf0d08412d42abf87a627e25250bb9a442d6474c8a197e696494f8a6cc5d99e221
+  metadata.gz: 2c926b73ab9abe0773f5f7d2415672a89f444c2c3448387f57e07fe69b359c6a70175beaaba91171bda2f24702dae7073b76f094ef9d5de8fcc7ca360c3cc0a4
+  data.tar.gz: eb3af95b1164676ec400acd49732532e74c91565cfa70db31db7fbbcb00b188d6e68c5e35ae02ef526bf55694438e48a1fe97ece448a7de649cd0198871fd9de

data/lib/app_profiler/middleware/upload_action.rb

@@ -42,7 +42,7 @@ module AppProfiler
         end
 
         def profile_data_url(upload)
-          upload.url
+          upload.url.to_s
         end
 
         def profile_header

data/lib/app_profiler/profile.rb

@@ -4,6 +4,7 @@ module AppProfiler
   class Profile
     INTERNAL_METADATA_KEYS = %i(id context)
     private_constant :INTERNAL_METADATA_KEYS
+    class UnsafeFilename < StandardError; end
 
     delegate    :[], to: :@data
     attr_reader :id, :context
@@ -70,6 +71,8 @@ module AppProfiler
         Socket.gethostname,
       ].compact.join("-") << ".json"
 
+      raise UnsafeFilename if /[^0-9A-Za-z.\-\_]/.match(filename)
+
       AppProfiler.profile_root.join(filename)
     end
   end

data/lib/app_profiler/profiler.rb

@@ -24,21 +24,6 @@ module AppProfiler
         stop if started
       end
 
-      def results
-        stackprof_profile = stackprof_results
-
-        return unless stackprof_profile
-
-        Profile.from_stackprof(stackprof_profile)
-      rescue => error
-        AppProfiler.logger.info(
-          "[Profiler] failed to obtain the profile error_class=#{error.class} error_message=#{error.message}"
-        )
-        nil
-      end
-
-      private
-
       def start(params = {})
         # Do not start the profiler if StackProf was started somewhere else.
         return false if running?
@@ -59,6 +44,21 @@ module AppProfiler
         StackProf.stop
       end
 
+      def results
+        stackprof_profile = stackprof_results
+
+        return unless stackprof_profile
+
+        Profile.from_stackprof(stackprof_profile)
+      rescue => error
+        AppProfiler.logger.info(
+          "[Profiler] failed to obtain the profile error_class=#{error.class} error_message=#{error.message}"
+        )
+        nil
+      end
+
+      private
+
       def stackprof_results
         StackProf.results
       end

data/lib/app_profiler/railtie.rb

@@ -30,6 +30,9 @@ 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)
+        end
         app.middleware.insert_before(0, AppProfiler.middleware)
       end
     end

data/lib/app_profiler/version.rb

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

data/lib/app_profiler/viewer/base_viewer.rb

@@ -3,7 +3,13 @@
 module AppProfiler
   module Viewer
     class BaseViewer
-      def self.view(_profile)
+      class << self
+        def view(profile)
+          new(profile).view
+        end
+      end
+
+      def view(_profile)
         raise NotImplementedError
       end
     end

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "rails-html-sanitizer"
+
+module AppProfiler
+  module Viewer
+    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))
+        end
+
+        private_constant(:Sanitizer)
+
+        def self.id(file)
+          file.basename.to_s.delete_suffix(".json")
+        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(
+            String.new.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

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "app_profiler/yarn/command"
+require "app_profiler/yarn/with_speedscope"
+
+module AppProfiler
+  module Viewer
+    class SpeedscopeRemoteViewer < BaseViewer
+      class Middleware < BaseMiddleware
+        include Yarn::WithSpeedscope
+
+        def initialize(app)
+          super
+          @speedscope = Rack::File.new(
+            File.join(AppProfiler.root, "node_modules/speedscope/dist/release")
+          )
+        end
+
+        protected
+
+        attr_reader(:speedscope)
+
+        def viewer(env, path)
+          setup_yarn unless yarn_setup
+          env[Rack::PATH_INFO] = path.delete_prefix("/app_profiler")
+
+          speedscope.call(env)
+        end
+
+        def show(_env, name)
+          profile = profile_files.find do |file|
+            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
+          )
+        end
+      end
+    end
+  end
+end

data/lib/app_profiler/viewer/speedscope_remote_viewer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "app_profiler/viewer/speedscope_remote_viewer/base_middleware"
+require "app_profiler/viewer/speedscope_remote_viewer/middleware"
+
+module AppProfiler
+  module Viewer
+    class SpeedscopeRemoteViewer < BaseViewer
+      class << self
+        def view(profile)
+          new(profile).view
+        end
+      end
+
+      def initialize(profile)
+        super()
+        @profile = profile
+      end
+
+      def view
+        id = Middleware.id(@profile.file)
+        AppProfiler.logger.info("[Profiler] Profile available at /app_profiler/#{id}\n")
+      end
+    end
+  end
+end

data/lib/app_profiler/viewer/speedscope_viewer.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+require "app_profiler/yarn/command"
+require "app_profiler/yarn/with_speedscope"
+
 module AppProfiler
   module Viewer
     class SpeedscopeViewer < BaseViewer
-      mattr_accessor :yarn_setup, default: false
-
-      class YarnError < StandardError; end
+      include Yarn::WithSpeedscope
 
       class << self
         def view(profile)
@@ -14,52 +15,12 @@ module AppProfiler
       end
 
       def initialize(profile)
+        super()
         @profile = profile
       end
 
       def view
-        yarn("run speedscope \"#{@profile.file}\"")
-      end
-
-      private
-
-      def yarn(command)
-        setup_yarn unless yarn_setup
-        exec("yarn #{command}") do
-          raise YarnError, "Failed to run #{command}."
-        end
-      end
-
-      def setup_yarn
-        ensure_yarn_installed
-        yarn("init --yes") unless package_json_exists?
-        # We currently only support this gem in the root Gemfile.
-        # See https://github.com/Shopify/app_profiler/issues/15
-        # for more information
-        yarn("add --dev --ignore-workspace-root-check speedscope")
-      end
-
-      def ensure_yarn_installed
-        exec("which yarn > /dev/null") do
-          raise(
-            YarnError,
-            <<~MSG.squish
-              `yarn` command not found.
-              Please install `yarn` or make it available in PATH.
-            MSG
-          )
-        end
-        self.yarn_setup = true
-      end
-
-      def package_json_exists?
-        AppProfiler.root.join("package.json").exist?
-      end
-
-      def exec(command)
-        system(command).tap do |return_code|
-          yield unless return_code
-        end
+        yarn("run", "speedscope", @profile.file.to_s)
       end
     end
   end

data/lib/app_profiler/yarn/command.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+module AppProfiler
+  module Yarn
+    module Command
+      class YarnError < StandardError; end
+
+      VALID_COMMANDS = [
+        ["which", "yarn"],
+        ["yarn", "init", "--yes"],
+        ["yarn", "add", "speedscope", "--dev", "--ignore-workspace-root-check"],
+        ["yarn", "run", "speedscope", /.*\.json/],
+      ]
+
+      private_constant(:VALID_COMMANDS)
+      mattr_accessor(:yarn_setup, default: false)
+
+      def yarn(command, *options)
+        setup_yarn unless yarn_setup
+
+        exec("yarn", command, *options) do
+          raise YarnError, "Failed to run #{command}."
+        end
+      end
+
+      def setup_yarn
+        ensure_yarn_installed
+
+        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
+      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
+      end
+
+      def ensure_yarn_installed
+        exec("which", "yarn", silent: true) do
+          raise(
+            YarnError,
+            <<~MSG.squish
+              `yarn` command not found.
+              Please install `yarn` or make it available in PATH.
+            MSG
+          )
+        end
+        self.yarn_setup = 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_speedscope.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module AppProfiler
+  module Yarn
+    module WithSpeedscope
+      include Command
+
+      def setup_yarn
+        super
+        # We currently only support this gem in the root Gemfile.
+        # See https://github.com/Shopify/app_profiler/issues/15
+        # for more information
+        yarn("add", "speedscope", "--dev", "--ignore-workspace-root-check") unless speedscope_added?
+      end
+
+      private
+
+      def speedscope_added?
+        AppProfiler.root.join("node_modules/speedscope").exist?
+      end
+    end
+  end
+end

data/lib/app_profiler.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require "active_support"
+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)
 
@@ -17,14 +19,15 @@ module AppProfiler
   module Viewer
     autoload :BaseViewer, "app_profiler/viewer/base_viewer"
     autoload :SpeedscopeViewer, "app_profiler/viewer/speedscope_viewer"
+    autoload :SpeedscopeRemoteViewer, "app_profiler/viewer/speedscope_remote_viewer"
   end
 
-  autoload :Middleware, "app_profiler/middleware"
-  autoload :RequestParameters, "app_profiler/request_parameters"
-  autoload :Profiler, "app_profiler/profiler"
-  autoload :Profile, "app_profiler/profile"
+  require "app_profiler/middleware"
+  require "app_profiler/request_parameters"
+  require "app_profiler/profiler"
+  require "app_profiler/profile"
 
-  mattr_accessor :logger
+  mattr_accessor :logger, default: Logger.new($stdout)
   mattr_accessor :root
   mattr_accessor :profile_root
 
@@ -43,6 +46,15 @@ module AppProfiler
       Profiler.run(*args, &block)
     end
 
+    def start(*args)
+      Profiler.start(*args)
+    end
+
+    def stop
+      Profiler.stop
+      Profiler.results
+    end
+
     def profile_header=(profile_header)
       @@profile_header = profile_header # rubocop:disable Style/ClassVars
       @@request_profile_header = nil    # rubocop:disable Style/ClassVars

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.9
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -162,7 +162,12 @@ files:
 - lib/app_profiler/storage/google_cloud_storage.rb
 - lib/app_profiler/version.rb
 - lib/app_profiler/viewer/base_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_speedscope.rb
 homepage: https://github.com/Shopify/app_profiler
 licenses: []
 metadata:
@@ -182,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Collect performance profiles for your Rails application.