debugbar 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fb345ca3b935b2a6baee536310271a5cda8e15132e7a79413fb661e44c0dbef
-  data.tar.gz: 292867bd66a2a1e7348fca7451ef85e2bd756d187cefff23065c349fd90186f7
+  metadata.gz: 6aba562e1aed30badc070345aa43832a4446332e7106ec29fd8cb3b8ceffdcba
+  data.tar.gz: 5bdc9a1ffe211db11e665f5fa07eb0a526da894b529ba091b78195e2dc6bafdf
 SHA512:
-  metadata.gz: 6f0b963c955ca99ff48e9a281a43d3de900b552ed4b16de947529e106c00b5f65ff4cca955b62a521be56a9e1668ce9e6081ce364e57a8137a4dd466dfe087d2
-  data.tar.gz: 609c0a2137bf2f0517e362cbe8771ac4c7f4fef211b200c51621b7af2555a67b71e76967b1c45bf59c3c6c8639b6f255d13cfff341cbb048e83d885d7a8cecca
+  metadata.gz: bce8023b7873a7d6975e7da731dbcdc67b29b1333d5995988c50b209ae0616e23dafa2201d6854fd5298fa738b85e34a89a4f7ee2439f25863dcb24a95061c02
+  data.tar.gz: 47cf338f0bad77e1fa45e6d85f26cc25456adf592d10ee9ea8affe427d7c9a5fb0b74cd39b3f1e367070f43736ed14cfa7afd3ea24b36355255be258d5140327

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## UNRELEASED
+
+* Use the debugbar in the browser dev tools 😎
+
+
+## v0.4.0 - 2025-01-07
+
+* Track HTTP calls made by the app - See [#48](https://github.com/julienbourdeau/debugbar/pull/48)
+  * Learn more: https://debugbar.dev/docs/http
+* Handle multi-processes service (cluster mode in Puma) - See [#45](https://github.com/julienbourdeau/debugbar/pull/45)
+  * Learn more: https://debugbar.dev/docs/puma-configuration
+* Ignore OPTIONS requests - See [08e7ee06](https://github.com/julienbourdeau/debugbar/commit/08e7ee0665f18f419a9a9bbcea00c414d05c2084)
+* ⚠️ Automatically set `action_cable.disable_request_forgery_protection` to true - See [449fc496](https://github.com/julienbourdeau/debugbar/commit/449fc49691182ecedf7cbbe1e5ca276894a70fee)
+* Some design tweak (like the select input to choose the request)
+
+## v0.3.3 - 2024-06-15
+
+* Allow nonce to be set for content security policies - See [#38](https://github.com/julienbourdeau/debugbar/pull/38)
+
 ## v0.3.2 - 2024-05-04
 
 * Improved Debug panel (to be in par with Queries panel) - See [#36](https://github.com/julienbourdeau/debugbar/pull/36)

data/app/channels/debugbar/debugbar_channel.rb

@@ -13,14 +13,11 @@ module Debugbar
         RequestBuffer.remove(data["ids"])
       end
 
-      Debugbar.connect!
-
-      data = RequestBuffer.all.map(&:to_h)
-      ActionCable.server.broadcast("debugbar_channel", data)
+      ActionCable.server.broadcast("debugbar_channel", RequestBuffer.to_h)
     end
 
     def unsubscribed
-      Debugbar.disconnect!
+      # Nothing to do
     end
   end
 end

data/app/controllers/debugbar/polling_controller.rb

@@ -4,7 +4,7 @@ module Debugbar
     before_action :cors_set_access_control_headers
 
     def poll
-      render json: RequestBuffer.all.map(&:to_h)
+      render json: RequestBuffer.to_h
     end
 
     def confirm

data/app/helpers/debugbar/tag_helpers.rb

@@ -22,7 +22,7 @@ module Debugbar::TagHelpers
     HTML
 
     html += <<-HTML
-      <script type="text/javascript" data-turbo-permanent>
+      <script type="text/javascript" data-turbo-permanent nonce="#{opt.delete(:nonce)}">
         window._debugbarConfigOptions = #{opt.to_json}
       </script>
     HTML

data/build_client.sh

@@ -2,4 +2,7 @@
 
 rm -rf client/dist
 (cd client && npm run build)
+
+echo
+echo " -> Copying new assets version to public/debugbar.js"
 cp client/dist/assets/debugbar-*.js public/debugbar.js

data/build_demo.sh

@@ -1,8 +1,9 @@
 #!/bin/bash
 
 ruby ./build_fixtures.rb
+
 rm -rf client/dist-demo
-(cd client/ && VITE_DEMO_MODE=true npm run build)
+(cd client/ && npm run build:demo)
 
 if [ -d "../debugbar.dev/source/assets/debugbar" ]; then
   echo
@@ -10,4 +11,8 @@ if [ -d "../debugbar.dev/source/assets/debugbar" ]; then
   echo " -> Copying assets"
   rm -f ../debugbar.dev/source/assets/debugbar/*
   cp ./client/dist-demo/assets/* ../debugbar.dev/source/assets/debugbar/
+else
+  echo "####################################################"
+  echo "## debugbar.dev was NOT FOUND in parent directory ##"
+  echo "####################################################"
 fi

data/build_fixtures.rb

@@ -8,7 +8,7 @@ Dir.glob("#{fixtures_dir}/*").each { |p| File.delete(p) }
 
 Net::HTTP.start('127.0.0.1', 3000) do |http|
   [
-    '/post-list',
+    '/post-list?with-external-data=true',
     '/slow-page',
     '/random',
     '/post/240',
@@ -29,4 +29,3 @@ Net::HTTP.start('127.0.0.1', 3000) do |http|
     File.write("#{fixtures_dir}/#{name}.json", JSON.pretty_generate(item))
   end
 end
-

data/lib/debugbar/buffers/cache_buffer.rb

@@ -0,0 +1,42 @@
+module Debugbar
+  class CacheBuffer
+    def push(request)
+      collection = get_collection
+      collection[request.id] = request.to_h
+      set_collection(collection)
+    end
+
+    def remove(ids)
+      ids = Array.wrap(ids)
+
+      collection = get_collection
+      ids.each do |id|
+        collection.delete(id)
+      end
+      set_collection(collection)
+    end
+
+    def to_h
+      get_collection.values.map(&:to_h)
+    end
+
+    def each(&block)
+      get_collection.each(&block)
+
+    end
+
+    def clear!
+      Rails.cache.delete("debugbar-requests")
+    end
+
+    private
+
+    def get_collection
+      Rails.cache.fetch("debugbar-requests") { {} }
+    end
+
+    def set_collection(collection)
+      Rails.cache.write("debugbar-requests", collection, expires_in: 10.minutes)
+    end
+  end
+end

data/lib/debugbar/buffers/memory_buffer.rb

@@ -6,7 +6,6 @@ module Debugbar
 
     def push(request)
       @collection[request.id] = request
-      nil
     end
 
     def remove(ids)
@@ -14,21 +13,18 @@ module Debugbar
       ids.each do |id|
         @collection.delete(id)
       end
-      :self
     end
 
-    def all
-      @collection.values
+    def to_h
+      @collection.values.map(&:to_h)
     end
 
     def each(&block)
       @collection.each(&block)
-      :self
     end
 
     def clear!
       @collection = {}
-      :self
     end
   end
 end

data/lib/debugbar/buffers/null_buffer.rb

@@ -6,7 +6,8 @@ module Debugbar
     def remove(_ids)
     end
 
-    def all
+    def to_h
+      {}
     end
 
     def each

data/lib/debugbar/buffers/request_buffer.rb

@@ -5,11 +5,28 @@ module Debugbar
         @adapter = adapter
       end
 
-      %w(push each all remove clear!).each do |name|
-        define_method(name) do |*args, &block|
-          ret = @adapter.send(name, *args, &block)
-          ret == :self ? self : ret
-        end
+      def push(request)
+        @adapter.push(request)
+        nil # Why not return self?
+      end
+
+      def remove(ids)
+        @adapter.remove(ids)
+        self
+      end
+
+      def to_h
+        @adapter.to_h
+      end
+
+      def each(&block)
+        @adapter.each(&block)
+        self
+      end
+
+      def clear!
+        @adapter.clear!
+        self
       end
     end
   end

data/lib/debugbar/config.rb

@@ -33,7 +33,9 @@ module Debugbar
       if ignore_request.is_a? Proc
         ignore_request.call(env)
       else
-        [Debugbar.config.prefix, "/assets"].any? { |s| env['PATH_INFO'].start_with? s }
+        [Debugbar.config.prefix, "/assets"].any? do |s|
+          env['PATH_INFO'].start_with? s
+        end || env['REQUEST_METHOD'] == "OPTIONS"
       end
     end
 

data/lib/debugbar/engine.rb

@@ -7,12 +7,70 @@ module Debugbar
   class Engine < ::Rails::Engine
     isolate_namespace Debugbar
 
+    def log(msg)
+      @logger ||= Logger.new(STDOUT)
+      Array.wrap(msg).each { |m| @logger.warn(m) }
+    end
+
     initializer 'debugbar.config' do |app|
       app.config.debugbar = ::Debugbar.config
     end
 
+    initializer 'debugbar.override_config' do |app|
+      unless app.config.action_cable.disable_request_forgery_protection
+        app.config.action_cable.disable_request_forgery_protection = true
+        log "Debugbar: Action Cable request forgery protection is enabled. This can cause issues with Debugbar. Overriding setting config.action_cable.disable_request_forgery_protection = true now. Update your configuration to get rid of this message."
+      end
+
+      if defined? HttpLog
+        HttpLog.configure do |config|
+          config.enabled = true
+
+          config.json_log = true
+          config.prefix = ''
+
+          config.logger = Debugbar::HttpLogger.new
+          config.logger_method = :log
+
+          config.log_connect   = true
+          config.log_request   = true
+          config.log_headers   = true
+          config.log_data      = true
+          config.log_status    = true
+          config.log_response  = true
+          config.log_benchmark = true
+
+        end
+      end
+    end
+
     initializer 'debugbar.init' do |app|
+      # Display error message if running in multi-process mode without proper configuration
+      if ENV["WEB_CONCURRENCY"].to_i > 1
+        cache_nok = %i[null_store memory_store].include?(Rails.configuration.cache_store.first.to_sym)
+        action_cable_nok = ActionCable.server.config.cable[:adapter].to_s == "async"
+        adapter_nok = app.config.debugbar.buffer_adapter != :cache
+
+        if cache_nok || action_cable_nok || adapter_nok
+          msg = [
+            "############################################################################################################",
+            "# Debugbar: You are using a multi-process server configuration (like Puma in cluster mode)",
+            "# Debugbar: You can use puma in single mode by setting the environment variable WEB_CONCURRENCY to 0",
+            "# Debugbar: If you want to use multiple processes, you must ensure that the following conditions are met:",
+            "# Debugbar: \t Use a persistent cache store (like files or database) in your Application config",
+            "# Debugbar: \t Use a persistent adapter for ActionCable (like Redis or SolidCable)",
+            "# Debugbar: \t Use the :cache buffer_adapter in config/initializers/debugbar.rb",
+            "############################################################################################################",
+          ]
+
+          log msg
+        end
+      end
+
       adapter = case(app.config.debugbar.buffer_adapter)
+      when :cache
+        require_relative 'buffers/cache_buffer'
+        CacheBuffer.new
       when :memory
         require_relative 'buffers/memory_buffer'
         MemoryBuffer.new

data/lib/debugbar/http/http.rb

@@ -0,0 +1,44 @@
+module Debugbar
+  class HttpRequest
+    attr_reader :method, :url, :headers, :body
+
+    def initialize(method, url, headers, body)
+      @method = method
+      @url = url
+      @headers = headers
+      @body = body
+    end
+
+    def self.from_rack(rack_req)
+      headers = rack_req.env.select { |k,v| k.start_with? 'HTTP_'} # https://stackoverflow.com/a/55406700/1001125
+        .transform_keys { |k| k.sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-') }
+        .sort.to_h
+
+      new(rack_req.method, rack_req.original_url, headers, rack_req.body)
+    end
+
+    def to_h
+      { method:, url:, headers:, body: }
+    end
+  end
+
+  class HttpResponse
+    attr_reader :status, :headers, :body
+
+    def initialize(status, headers, body)
+      @status = status
+      @headers = headers
+      @body = body
+    end
+
+    def self.from_rack(rack_res)
+      headers = rack_res.headers.to_h.transform_keys { |s| s.split('-').map(&:capitalize).join('-') }
+
+      new(rack_res.status, headers, rack_res.body)
+    end
+
+    def to_h
+      { status:, headers:, body: }
+    end
+  end
+end

data/lib/debugbar/loggers/http_logger.rb

@@ -0,0 +1,20 @@
+module Debugbar
+  class HttpLogger < ::Logger
+    def initialize(min_level= 2)
+      @min_level = min_level
+    end
+
+    def log(_level, json_str)
+      # We normally rely on the Tracker to know if the current request is set or nil and log an error to STDOUT,
+      # but in this case, it happens so often that the logs are annoying.
+      # In ActiveCable, only the first call goes through the Rake middleware, so every following communication
+      # doesn't go through TrackCurrentRequest, which initializes the request.
+      return if ::Debugbar::Current.request.nil?
+
+      log = JSON.parse(json_str)
+      req = HttpRequest.new(log["method"], log["url"], log["request_headers"], log["request_body"])
+      res = HttpResponse.new(log["response_code"], log["response_headers"], log["response_body"])
+      Debugbar::Tracker.add_http_call(SecureRandom.hex(4), req, res, benchmark: log['benchmark'])
+    end
+  end
+end

data/lib/debugbar/middlewares/track_current_request.rb

@@ -5,34 +5,33 @@ module Debugbar
     end
 
     def call(env)
+      # we don't check if debugbar is enabled because this middleware is only added when it is
+
+      # Set `ignore` attribute to reuse it anywhere
       Debugbar::Current.ignore = Debugbar.config.ignore_request?(env)
 
       return @app.call(env) if Debugbar::Current.ignore?
 
       Debugbar::Current.new_request!(SecureRandom.uuid)
 
-      res = @app.call(env)
+      status, headers, body = @app.call(env)
 
       # TODO: Remove this if statement?
       # We check meta because the frontend doesn't support request without meta yet.
       # It might happen with ActionController::Live where the following code
       # will run BEFORE ActionControllerEventSubscriber.process_action is called
       if Debugbar::Current.request&.meta
-        # filename = "#{Time.now.to_i}--#{Debugbar::Current.request.meta.dig(:params, :controller)}_#{Debugbar::Current.request.meta.dig(:params, :action).gsub('/', '_')}.json"
-        # File.open(Rails.root.join('_requests', filename), "w") do |f|
-        #   f.write(Debugbar::Current.request.to_json)
-        # end
-
         RequestBuffer.push(Debugbar::Current.pop_request!)
 
-        # TODO: Refactor has not having ActionCable might more common than I thought
-        if Debugbar.connected? && defined?(ActionCable)
-          data = RequestBuffer.all.map(&:to_h)
-          ActionCable.server.broadcast("debugbar_channel", data)
+        # TODO: Refactor since not having ActionCable might be more common than I thought
+        if defined?(ActionCable)
+          ActionCable.server.broadcast("debugbar_channel", RequestBuffer.to_h)
         end
       end
 
-      res
+      headers["X-Debugbar-On"] = "yes" # Used for the browser extension
+
+      [status, headers, body]
     end
   end
 

data/lib/debugbar/request.rb

@@ -1,9 +1,9 @@
 module Debugbar
   class Request
     attr_reader :request_id, :meta,
+                :request, :response,
                 :models, :queries, :jobs,
-                :messages, :cache, :logs
-    attr_accessor :request, :response, :headers
+                :messages, :cache, :logs, :http_calls
 
     def initialize(request_id)
       @request_id = request_id
@@ -13,6 +13,7 @@ module Debugbar
       @messages = []
       @cache = []
       @logs = []
+      @http_calls = []
     end
 
     alias_method :id, :request_id
@@ -24,6 +25,14 @@ module Debugbar
       @meta = meta
     end
 
+    def request=(rack_request)
+      @request = HttpRequest.from_rack(rack_request)
+    end
+
+    def response=(rack_response)
+      @response = HttpResponse.from_rack(rack_response)
+    end
+
     def inc_model(name)
       if @models[name]
         @models[name] += 1
@@ -52,47 +61,32 @@ module Debugbar
       @logs << l
     end
 
+    def add_http_call(id, request, response, extra)
+      @http_calls << {
+        id: id,
+        request: request.to_h,
+        response: response.to_h
+      }.merge(extra)
+    end
+
     def to_h
       {
         id: request_id,
         meta: meta,
-        request: request_hash,
-        response: response_hash,
+        request: request.to_h,
+        response: response&.to_h,
         models: models,
         queries: queries,
         jobs: jobs,
         messages: messages,
         cache: cache,
         logs: logs,
+        http_calls: http_calls,
       }
     end
 
     def to_json
       JSON.pretty_generate(to_h)
     end
-
-    private
-
-    def request_hash
-      {
-        method: request.method,
-        path: request.path,
-        format: meta.dig(:format),
-        params: meta.dig(:params),
-        headers: request.env.select { |k,v| k.start_with? 'HTTP_'} # https://stackoverflow.com/a/55406700/1001125
-                        .transform_keys { |k| k.sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-') }
-                        .sort.to_h
-      }
-    end
-
-    def response_hash
-      return nil if response.nil?
-
-      {
-        status: response.status,
-        headers: response.headers.to_h.transform_keys { |s| s.split('-').map(&:capitalize).join('-') },
-        body: response.body,
-      }
-    end
   end
 end

data/lib/debugbar/subscribers/action_controller.rb

@@ -26,7 +26,6 @@ module Debugbar
         Debugbar::Tracker.request = request
         Debugbar::Tracker.response = response
         Debugbar::Tracker.meta = meta
-
       end
     end
   end

data/lib/debugbar/subscribers/active_support.rb

@@ -12,7 +12,7 @@ module Debugbar
           when "cache_generate.active_support"
             "generate"
           when "cache_fetch_hit.active_support"
-            "fetch hit"
+            "fetch hit"
           when "cache_write.active_support"
             "write"
           when "cache_delete.active_support"

data/lib/debugbar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Debugbar
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/debugbar.rb

@@ -6,13 +6,16 @@ module Debugbar
   autoload :Request, "debugbar/request"
   autoload :RequestBuffer, "debugbar/buffers/request_buffer"
   autoload :SimpleLogger, "debugbar/loggers/simple_logger"
+  autoload :HttpLogger, "debugbar/loggers/http_logger"
+  autoload :HttpRequest, "debugbar/http/http"
+  autoload :HttpResponse, "debugbar/http/http"
 
   TIME_FORMAT = "%H:%M:%S.%L"
 
   module Tracker
     class << self
       SETTERS = %i[request response headers meta].freeze
-      METHODS = %i[inc_model add_query add_job add_cache add_log].freeze
+      METHODS = %i[inc_model add_query add_job add_cache add_log add_http_call].freeze
 
       SETTERS.each do |m|
         define_method("#{m}=") do |val|
@@ -69,18 +72,6 @@ module Debugbar
       yield config
     end
 
-    def connect!
-      @connected = true
-    end
-
-    def disconnect!
-      @connected = false
-    end
-
-    def connected?
-      @connected
-    end
-
     def msg(msg, *extra)
       source = caller.first&.split(":in")&.map { |s| s.delete_prefix("#{Rails.root}/").strip.tr("`'", '' ) }
       Tracker.msg(msg, extra, source)