rails-profiler 0.35.2 → 0.35.3

data/app/controllers/profiler/assets_controller.rb

@@ -10,16 +10,21 @@ module Profiler
 
     BUILD_MISSING = "Profiler assets are not built (%s is missing). Run `yarn build:full` in the profiler gem."
 
+    # A year: the URL a page uses carries the digest of the content (?v=), so a new version of
+    # the gem is a new URL. Without the digest, or with an old one, the file is only kept an
+    # hour, as it may be replaced under the same URL.
+    VERSIONED_CACHE_CONTROL = "public, max-age=#{365 * 24 * 3600}, immutable".freeze
+
     def toolbar_js
-      serve("profiler-toolbar.js", "application/javascript")
+      serve "profiler-toolbar.js", "application/javascript"
     end
 
     def main_js
-      serve("profiler.js", "application/javascript")
+      serve "profiler.js", "application/javascript"
     end
 
     def main_css
-      serve("profiler.css", "text/css")
+      serve "profiler.css", "text/css"
     end
 
     def icon
@@ -30,8 +35,12 @@ module Profiler
     private
 
     def serve(name, content_type)
-      body = File.read(Profiler::Engine.root.join("app", "assets", "builds", name))
-      expires_in 1.hour, public: true
+      body = Profiler::Assets.read(name)
+      if Profiler::Assets.current?(name, params[:v])
+        response.headers["Cache-Control"] = VERSIONED_CACHE_CONTROL
+      else
+        expires_in 1.hour, public: true
+      end
       render plain: body, content_type: content_type
     rescue Errno::ENOENT
       render plain: format(BUILD_MISSING, name), status: :not_found

data/app/views/layouts/profiler/application.html.erb

@@ -10,8 +10,8 @@
     <meta name="profiler-name" content="<%= Profiler.configuration.resolved_name %>">
     <meta name="profiler-is-master" content="<%= Profiler.configuration.master? %>">
 
-    <link rel="stylesheet" href="/_profiler/assets/profiler.css">
-    <script src="/_profiler/assets/profiler.js" defer></script>
+    <link rel="stylesheet" href="<%= Profiler::Assets.url("profiler.css") %>">
+    <script src="<%= Profiler::Assets.url("profiler.js") %>" defer></script>
   </head>
 
   <body>

data/app/views/layouts/profiler/embedded.html.erb

@@ -1,3 +1,5 @@
+<% nonce = content_security_policy_nonce %>
+<% nonce_attr = nonce ? %( nonce="#{ERB::Util.html_escape(nonce)}").html_safe : "" %>
 <!DOCTYPE html>
 <html data-theme="<%= params[:theme].presence&.then { |t| %w[light dark].include?(t) ? t : 'dark' } || 'dark' %>">
 <head>
@@ -8,16 +10,16 @@
   <%= csp_meta_tag %>
   <meta name="profiler-version" content="<%= Profiler.version %>">
 
-  <link rel="stylesheet" href="/_profiler/assets/profiler.css">
-  <script src="/_profiler/assets/profiler.js" defer></script>
+  <link rel="stylesheet" href="<%= Profiler::Assets.url("profiler.css") %>">
+  <script src="<%= Profiler::Assets.url("profiler.js") %>" defer></script>
 
-  <style>
+  <style<%= nonce_attr %>>
     /* Embedded overrides, tighter layout, no page chrome */
     body { overflow-y: auto; }
     .container { padding: 16px 20px; }
   </style>
 
-  <script>
+  <script<%= nonce_attr %>>
     // Receive theme changes from the Chrome extension panel via postMessage.
     // The extension sends: { type: 'profiler:set-theme', theme: 'light' | 'dark' }
     window.addEventListener('message', function(e) {

data/lib/profiler/assets.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Profiler
+  # The gem's built front end files. Each is read once and kept until the file changes on disk
+  # (a rebuild in development), and named by a digest of its content so that a browser that
+  # cached one never keeps it past a new version of the gem.
+  module Assets
+    NAMES = %w[profiler.js profiler.css profiler-toolbar.js].freeze
+    URL_PREFIX = "/_profiler/assets"
+
+    Entry = Struct.new(:mtime, :content, :digest)
+
+    @entries = {}
+    @mutex = Mutex.new
+
+    class << self
+      # Where the build writes the files; the gem's own, never the application's.
+      def builds_dir
+        File.expand_path("../../app/assets/builds", __dir__)
+      end
+
+      # The file's content, or raises Errno::ENOENT when the assets are not built.
+      def read(name)
+        entry(name).content
+      end
+
+      # Short digest of the content; the gem version when the file is not built.
+      def digest(name)
+        entry(name).digest
+      rescue Errno::ENOENT
+        Digest::SHA256.hexdigest(Profiler::VERSION)[0, 12]
+      end
+
+      # The URL a page uses for the asset, carrying its digest.
+      def url(name)
+        "#{URL_PREFIX}/#{name}?v=#{digest(name)}"
+      end
+
+      def current?(name, version)
+        version.is_a?(String) && !version.empty? && version == digest(name)
+      end
+
+      private
+
+      def entry(name)
+        raise ArgumentError, "unknown asset: #{name}" unless NAMES.include?(name)
+
+        path = File.join(builds_dir, name)
+        mtime = File.mtime(path)
+        cached = @mutex.synchronize { @entries[name] }
+        return cached if cached && cached.mtime == mtime
+
+        content = File.read(path)
+        fresh = Entry.new(mtime, content, Digest::SHA256.hexdigest(content)[0, 12])
+        @mutex.synchronize { @entries[name] = fresh }
+      end
+    end
+  end
+end

data/lib/profiler/middleware/toolbar_injector.rb

@@ -38,6 +38,24 @@ module Profiler
         )*+
       }xi
 
+      INTERCEPTOR_PATH = File.expand_path("../../../app/assets/javascript/profiler-ajax-interceptor.js", __dir__)
+
+      class << self
+        # The script is the same for every request of a version of the gem: read once. A failed
+        # read is not kept, so that the next request tries again.
+        def ajax_interceptor_code
+          @ajax_interceptor_code ||= File.read(INTERCEPTOR_PATH).freeze
+        rescue => e
+          Profiler.log_error("ToolbarInjector: could not load the AJAX interceptor script", e)
+          ""
+        end
+
+        # The toolbar CSS is a constant of the class too, built once.
+        def toolbar_styles
+          @toolbar_styles ||= build_toolbar_styles
+        end
+      end
+
       def initialize(body, token, nonce = nil)
         @body = body
         @token = token
@@ -139,13 +157,7 @@ module Profiler
       end
 
       def ajax_interceptor_code
-        @ajax_interceptor_code ||= begin
-          path = File.join(__dir__, "..", "..", "..", "app", "assets", "javascript", "profiler-ajax-interceptor.js")
-          File.read(path)
-        rescue => e
-          Profiler.log_error("ToolbarInjector: could not load the AJAX interceptor script", e)
-          ""
-        end
+        self.class.ajax_interceptor_code
       end
 
       # The middleware hands over the page it has already read: an Array of parts, or a String.
@@ -157,11 +169,11 @@ module Profiler
       def toolbar_html
         <<~HTML
           #{ajax_interceptor_script}
-          <style>#{toolbar_styles}</style>
+          <style#{nonce_attr}>#{self.class.toolbar_styles}</style>
           <div id="profiler-toolbar" class="profiler-root" data-token="#{ERB::Util.html_escape(@token)}"></div>
           <button id="profiler-toolbar-toggle" class="profiler-root" title="Toggle profiler (Alt+P)"><span class="profiler-toggle-icon">&#9654;</span></button>
           <script#{nonce_attr}>(function(){var c=localStorage.getItem('profiler-toolbar-collapsed')==='true',t=localStorage.getItem('profiler-theme'),theme=t==='light'?'light':t==='dark'?'dark':(window.matchMedia('(prefers-color-scheme:light)').matches?'light':'dark'),el=document.getElementById('profiler-toolbar'),tog=document.getElementById('profiler-toolbar-toggle');if(c){el.style.cssText='animation:none!important;transform:translateX(calc(100% + 44px))';tog.dataset.collapsed='true';}el.setAttribute('data-theme',theme);tog.setAttribute('data-theme',theme);})();</script>
-          <script src="/_profiler/assets/profiler-toolbar.js" defer#{nonce_attr}></script>
+          <script src="#{Profiler::Assets.url("profiler-toolbar.js")}" defer#{nonce_attr}></script>
         HTML
       end
 
@@ -176,7 +188,7 @@ module Profiler
 
       # Thermal design system, self-contained CSS for the injected toolbar.
       # Variables are defined on #profiler-toolbar to avoid polluting the host app.
-      def toolbar_styles
+      def self.build_toolbar_styles
         <<~'CSS'
           .profiler-root {
             --pf-bg:         #080b10;

data/lib/profiler/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Profiler
-  VERSION = "0.35.2"
+  VERSION = "0.35.3"
 
   GEM_ROOT = File.expand_path("../..", __dir__)
 

data/lib/profiler.rb

@@ -273,6 +273,7 @@ require_relative "profiler/collectors/mailer_collector"
 require_relative "profiler/storage/token"
 require_relative "profiler/storage/private_files"
 require_relative "profiler/storage/unavailable"
+require_relative "profiler/assets"
 require_relative "profiler/ajax_data"
 require_relative "profiler/env_override_store"
 require_relative "profiler/instrumentation/thread_context_propagation"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-profiler
 version: !ruby/object:Gem::Version
-  version: 0.35.2
+  version: 0.35.3
 platform: ruby
 authors:
 - Sébastien Duplessy
@@ -145,6 +145,7 @@ files:
 - lib/profiler.rb
 - lib/profiler/ajax_data.rb
 - lib/profiler/allocation_counter.rb
+- lib/profiler/assets.rb
 - lib/profiler/body_content.rb
 - lib/profiler/boot_env.rb
 - lib/profiler/cluster/master_client.rb