debugbar 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a11b73a9ef8ff90c2be09ed570dde59b7d0e856b958ea6a5ab9c7eab18ff6feb
-  data.tar.gz: 15fd5168d8a6f532842f693c16a7e9c821cbe9c136a459fb58d5e5324eb193ec
+  metadata.gz: f81dfe96cf7e377e64afafc691615d6b1190da2b71a89c02b2a381816458c0b5
+  data.tar.gz: dfe249da8d79a9f5a0c4075c40ad3817d65b0854a91882c7d43eaf54dccdf142
 SHA512:
-  metadata.gz: 0d7fa957a8453eabd1fabe1aebc4a04ba803f1e94932e6bd4d483fb7af0ca63322aef91e7db43ef087d76aaeae2e5890d5b6565af4a525a2a7c8a4433a5f0e9e
-  data.tar.gz: 26914d0f2bd5e2b0ada5cedd00259dd225ca89e31fc6b93459a3c7bdfcd3f30e7f58d4845385d79e06a60cf3f4da632be35d5eaaa8dfe4b9399ade7676e2c343
+  metadata.gz: 3ac4fa1480f2f573f3002b17c1c7656978f0dde5ffd44ba349221599287655f36a2b1af3e31060c1e51dedf63c2630e5d75e0aeb2ded9cb98122f07d8e285ace
+  data.tar.gz: 3cf593ce79357db2e63e19be37f757c4184458ffafe3462c3f200d43984e6902b1ead3977494ed3dfb4fb1fc046fa680736a24dbcc28aae2f13f39e4c629f06e

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## v0.2.0 - 2024-02-28
+
+* Introduce polling in case someone cannot use ActiveCable - See [8b262be7](https://github.com/julienbourdeau/debugbar/commit/8b262be7b644c7b587a6c3348bb02076053a344f)
+  * https://debugbar.dev/docs/polling-mode
+* Show more timings information (total time, DB runtime and CPU time) - See [c02531ed](https://github.com/julienbourdeau/debugbar/commit/c02531ed6e9d9c74df11d4d8c30e3fb7bf970852)
+* Move main middleware higher in the chain - See [7ca51c10](https://github.com/julienbourdeau/debugbar/commit/7ca51c10c5999f7ad14a303c92083614551de134)
+* Silence debugbar routes for quieter logs - See [efe491bd](https://github.com/julienbourdeau/debugbar/commit/efe491bde9e0544e5fb891597bb2af47854c1169)
+
+### Breaking changes
+
+The frontend configuration was slightly modified. If you customized the prefix for the debugbar routes or the channelName, you must update your config.
+Prefix is at the root, and channelName is nested under the cable key.
+
+```diff
+- <%= debugbar_javascript channelName: "something_else", cable: {prefix: "custom-prefix"} %>
++ <%= debugbar_javascript prefix: "custom-prefix", cable: {channelName: "something_else"} %>
+```
+
+## v0.1.0 - 2024-02-13
+
+* Initial release 🎉

data/app/controllers/debugbar/polling_controller.rb

@@ -0,0 +1,23 @@
+module Debugbar
+  class PollingController < ApplicationController
+    skip_before_action :verify_authenticity_token, only: [:confirm]
+    before_action :cors_set_access_control_headers
+
+    def poll
+      render json: RequestBuffer.all.map(&:to_h)
+    end
+
+    def confirm
+      RequestBuffer.remove params[:ids]
+      head :ok
+    end
+
+    private
+
+    def cors_set_access_control_headers
+      response.headers['Access-Control-Allow-Origin'] = '*'
+      response.headers['Access-Control-Allow-Headers'] = 'Content-Type'
+      response.headers['Access-Control-Allow-Methods'] = 'POST, GET'
+    end
+  end
+end

data/app/helpers/debugbar/tag_helpers.rb

@@ -1,5 +1,12 @@
 module Debugbar::TagHelpers
   def debugbar_javascript(opt = {})
+    opt = ActiveSupport::HashWithIndifferentAccess.new(opt)
+
+    # See https://github.com/julienbourdeau/debugbar/issues/8
+    if !defined?(ActionCable) && opt[:mode].nil?
+      opt[:mode] = 'poll'
+    end
+
     html = <<-HTML
       <div id="__debugbar"></div>
     HTML

data/build_demo.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+ruby ./build_fixtures.rb
+rm -rf client/dist-demo
+(cd client/ && VITE_DEMO_MODE=true npm run build)
+
+if [ -d "../debugbar.dev/source/assets/debugbar" ]; then
+  echo
+  echo "debugbar.dev found in parent directory"
+  echo " -> Copying assets"
+  rm -f ../debugbar.dev/source/assets/debugbar/*
+  cp ./client/dist-demo/assets/* ../debugbar.dev/source/assets/debugbar/
+fi

data/build_fixtures.rb

@@ -0,0 +1,32 @@
+require 'net/http'
+require 'json'
+
+fixtures_dir = File.expand_path('../fixtures/requests', __FILE__)
+
+puts "Deleting old fixtures in #{fixtures_dir}"
+Dir.glob("#{fixtures_dir}/*").each { |p| File.delete(p) }
+
+Net::HTTP.start('127.0.0.1', 3000) do |http|
+  [
+    '/post-list',
+    '/slow-page',
+    '/random',
+    '/post/240',
+    '/api/jobs?name=refresh&post_id=123',
+    '/api/jobs?name=send_email&post_id=123',
+    '/api/errors?code=500',
+  ].each do |path|
+    puts "Requesting #{path}"
+    http.request Net::HTTP::Get.new(path)
+    sleep 0.5
+  end
+
+  puts "Requesting debugbar data"
+  response = http.request Net::HTTP::Get.new('/_debugbar/poll')
+  data = JSON.parse(response.body)
+  data.each_with_index do |item, idx|
+    name = ("%03d" % (idx +1)) + '-' + item['meta']['controller'] + '-' + item['meta']['action']
+    File.write("#{fixtures_dir}/#{name}.json", JSON.pretty_generate(item))
+  end
+end
+

data/config/routes.rb

@@ -1,6 +1,9 @@
 Debugbar::Engine.routes.draw do
   mount ActionCable.server => '/cable'
 
-  # TODO: Silence logs for this route if `::Rails.application.config.assets.quiet` is true
+  get 'poll' => "polling#poll"
+  options 'poll/confirm' => "polling#confirm"
+  post 'poll/confirm' => "polling#confirm"
+
   get 'assets/script' => "assets#js"
 end

data/lib/debugbar/buffers/request_buffer.rb

@@ -2,24 +2,9 @@ module Debugbar
   class RequestBuffer
     class << self
       def init(adapter)
-        @enabled = false
         @adapter = adapter
       end
 
-      def enable!
-        @enabled = true
-        send_all
-      end
-
-      def disable!
-        @enabled = false
-      end
-
-      def send_all
-        data = @collection.values.map(&:to_h)
-        ActionCable.server.broadcast("debugbar_channel", data)
-      end
-
       %w(push each all remove clear!).each do |name|
         define_method(name) do |*args, &block|
           ret = @adapter.send(name, *args, &block)

data/lib/debugbar/engine.rb

@@ -1,4 +1,5 @@
 require_relative 'config'
+require_relative 'middlewares/quiet_routes'
 require_relative 'middlewares/track_current_request'
 require_relative '../../app/helpers/debugbar/tag_helpers'
 
@@ -37,7 +38,8 @@ module Debugbar
 
     initializer 'debugbar.inject_middlewares' do |app|
       next unless Debugbar.config.enabled?
-      app.middleware.insert_after ActionDispatch::RequestId, Debugbar::TrackCurrentRequest
+      app.middleware.insert_after ActionDispatch::Executor, Debugbar::TrackCurrentRequest
+      app.middleware.insert_after Debugbar::TrackCurrentRequest, Debugbar::QuietRoutes
     end
 
     initializer 'debugbar.subscribe' do

data/lib/debugbar/middlewares/quiet_routes.rb

@@ -0,0 +1,23 @@
+# This middleware silences the Rails logger for requests to the Debugbar routes.
+# The poll route can be *very* noisy.
+# Rails already does this for the /assets route, see Sprockets::Rails::QuietAssets.
+#
+# @see Sprockets::Rails::QuietAssets
+# @see Rails::Rack::Logger#silence
+#
+module Debugbar
+  class QuietRoutes
+    def initialize(app)
+      @app = app
+      @route_regex = %r(\A/{0,2}#{::Debugbar.config.prefix})
+    end
+
+    def call(env)
+      if env['PATH_INFO'] =~ @route_regex
+        ::Rails.logger.silence { @app.call(env) }
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/debugbar/middlewares/track_current_request.rb

@@ -9,12 +9,15 @@ module Debugbar
 
       return @app.call(env) if Debugbar::Current.ignore?
 
-      Debugbar::Current.new_request!(env['action_dispatch.request_id'])
+      Debugbar::Current.new_request!(SecureRandom.uuid)
 
       res = @app.call(env)
 
       # TODO: Remove this if statement?
-      if Debugbar::Current.request&.id
+      # 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)

data/lib/debugbar/version.rb

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

data/lib/debugbar.rb

@@ -16,17 +16,25 @@ module Debugbar
 
       SETTERS.each do |m|
         define_method("#{m}=") do |val|
-          if Current.request.nil?
+          return if Debugbar::Current.ignore?
+
+          if Current.request
+            return Current.request.send("#{m}=", val)
+          end
+
+          if Current.request.nil? && ENV["DEBUGBAR_VERBOSE_MODE"] == "true"
             # TODO: Much, much better logging needed
-            puts "The current request is not set yet. Was trying to set #{m}=[#{val.class.name}]."
-          else
-            Current.request.send("#{m}=", val)
+            puts "The current request is not set yet. Was trying to set #{m} = #{val.class.name}."
+            pp val
+            nil
           end
         end
       end
 
       METHODS.each do |m|
         define_method(m) do |*args, &block|
+          return if Debugbar::Current.ignore?
+
           if Current.request
             return Current.request.send(m, *args, &block)
           end