dial 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cd83bb50a207183202f0f0f9775d060446a352cf88382252fdfc00c4dbb4de6
-  data.tar.gz: a84109907f3884386ce2122ba5173c33ebc8da6e1c900bb94439389a274887b7
+  metadata.gz: d3b2e0414c826c6c8e7237a5b1033b102ee9079491e1d2863db6ffb961a3fda2
+  data.tar.gz: 859585a4e0bcf37eb6c36c2f71e1d16cad9e351c4435cc91981c9254704d21bd
 SHA512:
-  metadata.gz: b1e2a82ea64022c1dcf83f5fc5ae7cdfc3f53794552c9752f4d39f4f490bfcbc25bb3b1632b211ba08c4e4af7c1dd22483c037d06cf2b59dcda44b9d36c92bd7
-  data.tar.gz: 27075354578df3d541fdacb9704959c097a4cd2a128653b8e67b57424b64d934e5c50e1f335a33111012ba2f87b381048cde8ac4d12961dce86cea4059edf54d
+  metadata.gz: dd66117fe0e8c2fcfac7dacb5348cda5eee119e8f199ead4a5161a5af024e52c50f52765dcdcb0804fcbbd53c061d4f9073287322d0146300f7508d82c9c6823
+  data.tar.gz: 6bad07093895c0e2c4d09fd53afecce8d344f189d07eb576d29202ba308009f67eff06a1263ac8d27c2587ca3d3c46f650ffafc499761d56d3f2a092d396d402

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.6.0] - 2025-10-23
+
+- Stop suffixing mounted routes with 'dial/'
+- Add keyboard shortcut to toggle panel visibility
+
 ## [0.5.2] - 2025-10-04
 
 -  Preserve existing prosopite custom loggers

data/README.md

@@ -32,7 +32,7 @@ bundle install
 
 ```ruby
 # this will mount the engine at /dial
-mount Dial::Engine, at: "/"
+mount Dial::Engine, at: "/dial"
 ```
 
 4. (Optional) Configure the gem in an initializer:
@@ -66,6 +66,7 @@ Option | Description | Default
 `storage` | Storage adapter class for profile data. | `Dial::Storage::FileAdapter`
 `storage_options` | Options hash passed to storage adapter. | `{ ttl: 3600 }`
 `content_security_policy_nonce` | Sets the content security policy nonce to use when inserting Dial's script. Can be a string, or a Proc which receives `env` and response `headers` as arguments and returns the nonce string. | Rails generated nonce or `nil`
+`toggle_shortcut_keys` | Array of keys for keyboard shortcut to toggle panel visibility. | `["Alt", "Shift", "D"]`
 `vernier_interval` | Sets the `interval` option for vernier. | `200`
 `vernier_allocation_interval` | Sets the `allocation_interval` option for vernier. | `2_000`
 `prosopite_ignore_queries` | Sets the `ignore_queries` option for prosopite. | `[/schema_migrations/i]`

data/lib/dial/configuration.rb

@@ -18,6 +18,7 @@ module Dial
         storage: Storage::FileAdapter,
         storage_options: { ttl: STORAGE_TTL },
         content_security_policy_nonce: -> env, _headers { env[NONCE] || EMPTY_NONCE },
+        toggle_shortcut_keys: TOGGLE_SHORTCUT_KEYS,
         vernier_interval: VERNIER_INTERVAL,
         vernier_allocation_interval: VERNIER_ALLOCATION_INTERVAL,
         prosopite_ignore_queries: PROSOPITE_IGNORE_QUERIES,

data/lib/dial/constants.rb

@@ -21,6 +21,7 @@ module Dial
   SAMPLING_PERCENTAGE_PROD = 1
   STORAGE_TTL = 60 * 60
   EMPTY_NONCE = ""
+  TOGGLE_SHORTCUT_KEYS = ["Alt", "Shift", "D"].freeze
 
   VERNIER_INTERVAL = 200
   VERNIER_ALLOCATION_INTERVAL = 2_000

data/lib/dial/engine/routes.rb

@@ -3,41 +3,39 @@
 require "uri"
 
 Dial::Engine.routes.draw do
-  scope path: "/dial", as: "dial" do
-    get "profile", to: lambda { |env|
-      query_params = URI.decode_www_form(env[::Rack::QUERY_STRING]).to_h
-      profile_key = query_params["key"]
-      unless profile_key && profile_key.match?(/\A[0-9a-f-]+_vernier\z/i)
-        return [
-          400,
-          { "Content-Type" => "text/plain" },
-          ["Bad Request"]
-        ]
-      end
+  get "/profile", to: lambda { |env|
+    query_params = URI.decode_www_form(env[::Rack::QUERY_STRING]).to_h
+    profile_key = query_params["key"]
+    unless profile_key && profile_key.match?(/\A[0-9a-f-]+_vernier\z/i)
+      return [
+        400,
+        { "Content-Type" => "text/plain" },
+        ["Bad Request"]
+      ]
+    end
 
-      profile_storage_key = Dial::Storage.profile_storage_key profile_key
-      begin
-        content = Dial::Storage.fetch profile_storage_key
-        if content
-          [
-            200,
-            { "Content-Type" => "application/json", "Access-Control-Allow-Origin" => Dial::VERNIER_VIEWER_URL },
-            [content]
-          ]
-        else
-          [
-            404,
-            { "Content-Type" => "text/plain" },
-            ["Not Found"]
-          ]
-        end
-      rescue
+    profile_storage_key = Dial::Storage.profile_storage_key profile_key
+    begin
+      content = Dial::Storage.fetch profile_storage_key
+      if content
+        [
+          200,
+          { "Content-Type" => "application/json", "Access-Control-Allow-Origin" => Dial::VERNIER_VIEWER_URL },
+          [content]
+        ]
+      else
         [
-          500,
+          404,
           { "Content-Type" => "text/plain" },
-          ["Internal Server Error"]
+          ["Not Found"]
         ]
       end
-    }
-  end
+    rescue
+      [
+        500,
+        { "Content-Type" => "text/plain" },
+        ["Internal Server Error"]
+      ]
+    end
+  }
 end

data/lib/dial/middleware/panel.rb

@@ -71,6 +71,8 @@ module Dial
             </div>
           </div>
 
+          <div id="dial-hidden-indicator">Dial</div>
+
           <script nonce="#{configured_nonce env, headers}">
             #{script}
           </script>
@@ -149,19 +151,80 @@ module Dial
               color: black;
             }
           }
+
+          #dial-hidden-indicator {
+            all: initial;
+            position: fixed;
+            bottom: 0.5rem;
+            right: 0.5rem;
+            z-index: 9999;
+            background-color: white;
+            color: black;
+            padding: 0.25rem 0.5rem;
+            border-radius: 0.25rem;
+            font-size: 0.75rem;
+            cursor: pointer;
+            display: none;
+            box-shadow: -0.2rem -0.2rem 0.4rem rgba(0, 0, 0, 0.5);
+          }
         CSS
       end
 
       def script
+        shortcut_keys = Dial._configuration.toggle_shortcut_keys
+
         <<~JS
+          var dialPanel = document.getElementById("dial");
           var dialPreview = document.getElementById("dial-preview");
           var dialDetails = document.getElementById("dial-details");
+          var dialHiddenIndicator = document.getElementById("dial-hidden-indicator");
+
+          function getDialHiddenState() {
+            var stored = localStorage.getItem("dial_panel_hidden");
+            if (!stored) return false;
+
+            try {
+              var data = JSON.parse(stored);
+              var expiresAt = new Date(data.expiresAt);
+              if (new Date() > expiresAt) {
+                localStorage.removeItem("dial_panel_hidden");
+                return false;
+              }
+              return data.hidden;
+            } catch (e) {
+              localStorage.removeItem("dial_panel_hidden");
+              return false;
+            }
+          }
+
+          function setDialHiddenState(hidden) {
+            var expiresAt = new Date();
+            expiresAt.setTime(expiresAt.getTime() + (24 * 60 * 60 * 1000));
+            localStorage.setItem("dial_panel_hidden", JSON.stringify({
+              hidden: hidden,
+              expiresAt: expiresAt.toISOString()
+            }));
+          }
+
+          function toggleDialPanel() {
+            var isHidden = dialPanel.style.display === "none";
+            dialPanel.style.display = isHidden ? "flex" : "none";
+            dialHiddenIndicator.style.display = isHidden ? "none" : "block";
+            setDialHiddenState(!isHidden);
+          }
+
+          if (getDialHiddenState()) {
+            dialPanel.style.display = "none";
+            dialHiddenIndicator.style.display = "block";
+          }
 
           dialPreview.addEventListener("click", () => {
             var isCollapsed = ["", "none"].includes(dialDetails.style.display);
             dialDetails.style.display = isCollapsed ? "block" : "none";
           });
 
+          dialHiddenIndicator.addEventListener("click", toggleDialPanel);
+
           document.addEventListener("click", (event) => {
             if (!dialPreview.contains(event.target) && !dialDetails.contains(event.target)) {
               dialDetails.style.display = "none";
@@ -172,6 +235,26 @@ module Dial
               });
             }
           });
+
+          document.addEventListener("keydown", (event) => {
+            var keys = #{shortcut_keys.to_json};
+            var expectedKey = keys[keys.length - 1].toLowerCase();
+            var keyPressed = event.code.toLowerCase() === "key" + expectedKey || event.key.toLowerCase() === expectedKey;
+            var modifiersMatch = true;
+
+            for (var i = 0; i < keys.length - 1; i++) {
+              var modifier = keys[i].toLowerCase();
+              if (modifier === "alt" && !event.altKey) modifiersMatch = false;
+              if (modifier === "ctrl" && !event.ctrlKey) modifiersMatch = false;
+              if (modifier === "shift" && !event.shiftKey) modifiersMatch = false;
+              if (modifier === "meta" && !event.metaKey) modifiersMatch = false;
+            }
+
+            if (keyPressed && modifiersMatch) {
+              event.preventDefault();
+              toggleDialPanel();
+            }
+          });
         JS
       end
 
@@ -192,7 +275,7 @@ module Dial
       def formatted_profile_output env, profile_key
         url_base = ::Rails.application.routes.url_helpers.dial_url host: env[::Rack::HTTP_HOST]
         prefix = "/" unless url_base.end_with? "/"
-        profile_out_url = URI.encode_www_form_component url_base + "#{prefix}dial/profile?key=#{profile_key}"
+        profile_out_url = URI.encode_www_form_component url_base + "#{prefix}profile?key=#{profile_key}"
 
         "<a href='https://vernier.prof/from-url/#{profile_out_url}' target='_blank'>View profile</a>"
       end

data/lib/dial/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dial
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dial
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Joshua Young
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.0.dev
 specification_version: 4
 summary: A modern profiler for your Rails application
 test_files: []