app_profiler 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cacd68e85ebfc9eb41bff2353511b84439e284949577989885ce79b3153b8bf2
-  data.tar.gz: 32e324f294afd7a68d9edf7dcd6bb996dd34c2cff49bdcfdeb651d210cc3877a
+  metadata.gz: 4342f9415d422d77b172d358f968f9bc6c0ae670364e2ed351c7d1daf7cfcd3f
+  data.tar.gz: 4868b701483cc23fef7dad0432437afe61a65ff4ff5bcd752eec37636f4eeddb
 SHA512:
-  metadata.gz: 8f8c67c8ede68a80ddaf78dca6c81f32702e750d8e42ea973f4d11d171287cea691a60da4360654597c42ff3afe642e24f5a9ffd608de46eb71d6c2e1d062966
-  data.tar.gz: cb2ba40dd3d2e7f25ffcf956a5a52750eb35f0392a5d7b055645a3cd9ea6354f645d61fbf857922f495d8be729280138f80b758a4fac36ae58ed33ef17ceffe4
+  metadata.gz: ab3d7f1677cc9f3a645ca23cf5fc2b3125cd498cbaace7640e31aad8b45e8f9c23bda135bf470b105e723cafeb1c0456149618c3268cc9ea5674fe2427b00fe0
+  data.tar.gz: 12189f7de4e869d34939d9c3cdbeeb94d257de0f31c232f2deff2011a879fadc8aaccfde44f9780eec6bd863375f9a098f3c571ed53bc65c9e9825f83be6d96a

data/lib/app_profiler.rb

@@ -24,7 +24,7 @@ module AppProfiler
   autoload :Profiler, "app_profiler/profiler"
   autoload :Profile, "app_profiler/profile"
 
-  mattr_accessor :logger
+  mattr_accessor :logger, default: Logger.new($stdout)
   mattr_accessor :root
   mattr_accessor :profile_root
 
@@ -32,6 +32,7 @@ module AppProfiler
   mattr_accessor :autoredirect, default: false
   mattr_reader   :profile_header, default: "X-Profile"
   mattr_accessor :context, default: nil
+  mattr_reader   :profile_url_formatter, default: nil
 
   mattr_accessor :storage, default: Storage::FileStorage
   mattr_accessor :viewer, default: Viewer::SpeedscopeViewer
@@ -42,6 +43,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
@@ -57,5 +67,9 @@ module AppProfiler
     def profile_data_header
       @@profile_data_header ||= profile_header.dup << "-Data" # rubocop:disable Style/ClassVars
     end
+
+    def profile_url_formatter=(block)
+      @@profile_url_formatter = block # rubocop:disable Style/ClassVars
+    end
   end
 end

data/lib/app_profiler/middleware/upload_action.rb

@@ -34,7 +34,11 @@ module AppProfiler
         end
 
         def profile_url(upload)
-          "#{AppProfiler.speedscope_host}#profileURL=#{upload.url}"
+          if AppProfiler.profile_url_formatter.nil?
+            "#{AppProfiler.speedscope_host}#profileURL=#{upload.url}"
+          else
+            AppProfiler.profile_url_formatter.call(upload)
+          end
         end
 
         def profile_data_url(upload)

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,28 +24,13 @@ 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?
 
         clear
 
-        StackProf.start(DEFAULTS.merge(params))
+        StackProf.start(**DEFAULTS, **params)
       rescue => error
         AppProfiler.logger.info(
           "[Profiler] failed to start the profiler error_class=#{error.class} error_message=#{error.message}"
@@ -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

@@ -25,6 +25,7 @@ module AppProfiler
         "tmp", "app_profiler"
       )
       AppProfiler.context = app.config.app_profiler.context || Rails.env
+      AppProfiler.profile_url_formatter = app.config.app_profiler.profile_url_formatter
     end
 
     initializer "app_profiler.add_middleware" do |app|

data/lib/app_profiler/storage/file_storage.rb

@@ -11,6 +11,10 @@ module AppProfiler
         def url
           @file
         end
+
+        def name
+          @file.basename
+        end
       end
 
       class << self

data/lib/app_profiler/version.rb

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

data/lib/app_profiler/viewer/speedscope_viewer.rb

@@ -14,6 +14,7 @@ module AppProfiler
       end
 
       def initialize(profile)
+        super()
         @profile = profile
       end
 
@@ -33,7 +34,10 @@ module AppProfiler
       def setup_yarn
         ensure_yarn_installed
         yarn("init --yes") unless package_json_exists?
-        yarn("add --dev speedscope")
+        # 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") unless speedscope_added?
       end
 
       def ensure_yarn_installed
@@ -53,6 +57,10 @@ module AppProfiler
         AppProfiler.root.join("package.json").exist?
       end
 
+      def speedscope_added?
+        AppProfiler.root.join("node_modules/speedscope").exist?
+      end
+
       def exec(command)
         system(command).tap do |return_code|
           yield unless return_code

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -182,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: Collect performance profiles for your Rails application.