debugbar 0.0.1 → 0.1.0

data/fixtures/requests/1706607136--demo_random_post.json

@@ -0,0 +1,106 @@
+{
+  "id": "05237876-ee86-4ffd-95de-deff834a2e35",
+  "meta": {
+    "controller": "DemoController",
+    "action": "random_post",
+    "params": {
+      "controller": "demo",
+      "action": "random_post"
+    },
+    "format": "html",
+    "method": "GET",
+    "path": "/random",
+    "status": 302,
+    "view_runtime": null,
+    "db_runtime": 13.151000021025538,
+    "duration": 16.539000034332275,
+    "cpu_time": 3.4336249999999993,
+    "idle_time": 13.105375034332276,
+    "allocations": 1573
+  },
+  "request": {
+    "method": "GET",
+    "path": "/random",
+    "format": "html",
+    "params": {
+      "controller": "demo",
+      "action": "random_post"
+    },
+    "headers": {
+      "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7",
+      "Accept-Encoding": "gzip, deflate, br",
+      "Accept-Language": "fr,en;q=0.9",
+      "Connection": "keep-alive",
+      "Cookie": "_demo_app_session=BQrfrqwaDxQLlcrCZCSwiiJrCVN6pWaGEmTUMl5s%2BWP2xDdT5GgSbZ1GjUxNevxh9zy%2FCWIXiCSkpd1bAMAEefyD7BUi4cgt%2BQ4xclmmUfebk8Hnl1sw0fhO0uGUk%2BsR6rZdEHZf%2FOQcUtzhuvk%2BNO4JdOoqLPqD6Z9A%2FuvUroWg3NHedrkYIx5yESdgdL7vYseAorT%2B2BtUH%2BRCftEXrEWRWdWyBHDgAanAcwu96zfwLBURN9h%2FAUBPn8wtvCc%2BoZPQXJlDGXSVEUxLd%2FiZ4INeR707T7HyCw%3D%3D--xI%2FllNiOtCHGENRn--%2Bh1H%2FRmTDAzWYcvTavhbTQ%3D%3D",
+      "Dnt": "1",
+      "Host": "127.0.0.1:3000",
+      "Referer": "http://127.0.0.1:3000/slow-page",
+      "Sec-Ch-Ua": "\"Not_A Brand\";v=\"8\", \"Chromium\";v=\"120\", \"Google Chrome\";v=\"120\"",
+      "Sec-Ch-Ua-Mobile": "?0",
+      "Sec-Ch-Ua-Platform": "\"macOS\"",
+      "Sec-Fetch-Dest": "document",
+      "Sec-Fetch-Mode": "navigate",
+      "Sec-Fetch-Site": "same-origin",
+      "Sec-Fetch-User": "?1",
+      "Upgrade-Insecure-Requests": "1",
+      "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
+      "Version": "HTTP/1.1"
+    }
+  },
+  "response": {
+    "status": 302,
+    "headers": {
+      "X-Frame-Options": "SAMEORIGIN",
+      "X-Xss-Protection": "0",
+      "X-Content-Type-Options": "nosniff",
+      "X-Permitted-Cross-Domain-Policies": "none",
+      "Referrer-Policy": "strict-origin-when-cross-origin",
+      "Location": "http://127.0.0.1:3000/post/930",
+      "Content-Type": "text/html; charset=utf-8",
+      "Cache-Control": "no-cache"
+    },
+    "body": ""
+  },
+  "models": {
+    "Post": 1
+  },
+  "queries": [
+    {
+      "id": "a49beead96b5a5e5ec7b",
+      "title": "Post Load (13.2ms)",
+      "name": "Post Load",
+      "sql": "SELECT `posts`.* FROM `posts` ORDER BY RAND() LIMIT 1 ",
+      "cached": false,
+      "async": false,
+      "duration": 13.2,
+      "lock_wait": null,
+      "binds": null,
+      "source": [
+        "/Users/julien.bourdeau/Personal/rails/demo_app/app/controllers/demo_controller.rb:20",
+        " `random_post'"
+      ]
+    }
+  ],
+  "jobs": [
+
+  ],
+  "messages": [
+    {
+      "msg": "before_action",
+      "extra": [
+        {
+          "params": {
+            "controller": "demo",
+            "action": "random_post"
+          }
+        }
+      ]
+    }
+  ],
+  "cache": [
+
+  ],
+  "logs": [
+
+  ]
+}

data/fixtures/requests/1706607141--api_errors.json

@@ -0,0 +1,73 @@
+{
+  "id": "c38fed3f-4600-4ab4-96b2-1f03510db13a",
+  "meta": {
+    "controller": "ApiController",
+    "action": "errors",
+    "params": {
+      "code": "500",
+      "controller": "api",
+      "action": "errors"
+    },
+    "format": "*/*",
+    "method": "GET",
+    "path": "/api/errors?code=500",
+    "status": 500,
+    "view_runtime": null,
+    "db_runtime": 0.0,
+    "exception": [
+      "RuntimeError",
+      "This is a test error"
+    ],
+    "exception_object": "This is a test error",
+    "duration": 1.061000108718872,
+    "cpu_time": 0.649708000000004,
+    "idle_time": 0.4112921087188681,
+    "allocations": 551
+  },
+  "request": {
+    "method": "GET",
+    "path": "/api/errors",
+    "format": "*/*",
+    "params": {
+      "code": "500",
+      "controller": "api",
+      "action": "errors"
+    },
+    "headers": {
+      "Accept": "*/*",
+      "Accept-Encoding": "gzip, deflate, br",
+      "Accept-Language": "fr,en;q=0.9",
+      "Connection": "keep-alive",
+      "Cookie": "_demo_app_session=TXrvUIFrjCCzEF5STOJH4y3LxjezAtOH0LvuLn8ubvx5%2F7Ki2y%2FGB5zO%2Bb%2BWPhvEeyJXbGRn5WtG2EQUK7cfWlXDQ69Pl35stBJZD2RfAFgzJeVYiqNnRttqmN6caQzfqKMJoGlGL%2B%2BUdlJPWFw7r24FZ960BsHrem6dXmf%2Fc3ulZUMwAq13%2BvRavwYOEvBv%2BzfdMUEuwXXDL0rArzZpmbrPYWevNasPSTrZXcyn4pY9qV1d%2BVINEYhiDTgaHv%2BveYMf5jXTjoVDA3lUDBMYPHU5EMMmce24hw%3D%3D--y7dDFZ0aVSPS0S2f--til504PhC6CQcoMmYKj2YQ%3D%3D",
+      "Dnt": "1",
+      "Host": "127.0.0.1:3000",
+      "Referer": "http://127.0.0.1:3000/post/930",
+      "Sec-Ch-Ua": "\"Not_A Brand\";v=\"8\", \"Chromium\";v=\"120\", \"Google Chrome\";v=\"120\"",
+      "Sec-Ch-Ua-Mobile": "?0",
+      "Sec-Ch-Ua-Platform": "\"macOS\"",
+      "Sec-Fetch-Dest": "empty",
+      "Sec-Fetch-Mode": "cors",
+      "Sec-Fetch-Site": "same-origin",
+      "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
+      "Version": "HTTP/1.1"
+    }
+  },
+  "response": null,
+  "models": {
+  },
+  "queries": [
+
+  ],
+  "jobs": [
+
+  ],
+  "messages": [
+
+  ],
+  "cache": [
+
+  ],
+  "logs": [
+
+  ]
+}

data/lib/debugbar/buffers/memory_buffer.rb

@@ -0,0 +1,34 @@
+module Debugbar
+  class MemoryBuffer
+    def initialize
+      @collection = {}
+    end
+
+    def push(request)
+      @collection[request.id] = request
+      nil
+    end
+
+    def remove(ids)
+      ids = Array.wrap(ids)
+      ids.each do |id|
+        @collection.delete(id)
+      end
+      :self
+    end
+
+    def all
+      @collection.values
+    end
+
+    def each(&block)
+      @collection.each(&block)
+      :self
+    end
+
+    def clear!
+      @collection = {}
+      :self
+    end
+  end
+end

data/lib/debugbar/buffers/null_buffer.rb

@@ -0,0 +1,18 @@
+module Debugbar
+  class NullBuffer
+    def push(_request)
+    end
+
+    def remove(_ids)
+    end
+
+    def all
+    end
+
+    def each
+    end
+
+    def clear!
+    end
+  end
+end

data/lib/debugbar/buffers/request_buffer.rb

@@ -0,0 +1,31 @@
+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)
+          ret == :self ? self : ret
+        end
+      end
+    end
+  end
+end

data/lib/debugbar/config.rb

@@ -0,0 +1,50 @@
+module Debugbar
+  class Config
+    attr_accessor :enabled, :prefix, :buffer_adapter, :ignore_request,
+                  :active_record, :action_controller, :active_job,
+                  :min_log_level
+
+    alias_method :enabled?, :enabled
+
+    def initialize(options = {})
+      opt = defaults.merge options
+      @enabled = opt[:enabled] && !defined?(Rails::Console)
+      @prefix = opt[:prefix]
+      @active_record = opt[:active_record]
+      @action_controller = opt[:action_controller]
+      @active_job = opt[:active_job]
+      @min_log_level = opt[:min_log_level]
+      @buffer_adapter = opt[:buffer_adapter]
+    end
+
+    def defaults
+      {
+        enabled: Rails.env.development?,
+        prefix: "/_debugbar",
+        active_record: true,
+        action_controller: true,
+        active_job: true,
+        min_log_level: -1,
+        buffer_adapter: :memory,
+      }
+    end
+
+    def ignore_request?(env)
+      if ignore_request.is_a? Proc
+        ignore_request.call(env)
+      else
+        [Debugbar.config.prefix, "/assets"].any? { |s| env['PATH_INFO'].start_with? s }
+      end
+    end
+
+    def use_logger?
+      @enabled && @min_log_level >= 0
+    end
+
+    %w(active_record action_controller active_job).each do |name|
+      define_method("#{name}?") do
+        @enabled && instance_variable_get("@#{name}")
+      end
+    end
+  end
+end

data/lib/debugbar/current.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Debugbar
+  class Current < ActiveSupport::CurrentAttributes
+    attribute :request
+    attribute :ignore
+
+    alias_method :ignore?, :ignore
+
+    def new_request!(request_id)
+      self.request = Request.new(request_id)
+    end
+
+    def pop_request!
+      request.tap { self.request = nil }
+    end
+  end
+end

data/lib/debugbar/engine.rb

@@ -1,10 +1,101 @@
+require_relative 'config'
+require_relative 'middlewares/track_current_request'
+
 module Debugbar
-  class Engine < Rails::Engine
-    # This should fix rails3 rc, and also work with beta
-    config.autoload_paths << File.expand_path(File.join(File.dirname(__FILE__), "..", "..")) if config.respond_to? :autoload_paths
+  class Engine < ::Rails::Engine
+    isolate_namespace Debugbar
+
+    initializer 'debugbar.config' do |app|
+      app.config.debugbar = ::Debugbar.config
+    end
+
+    initializer 'debugbar.init' do |app|
+      adapter = case(app.config.debugbar.buffer_adapter)
+      when :memory
+        require_relative 'buffers/memory_buffer'
+        MemoryBuffer.new
+      when :null
+        require_relative 'buffers/null_buffer'
+        NullBuffer.new
+      else
+        throw "Invalid RequestBuffer adapter"
+      end
+
+      Debugbar::RequestBuffer.init(adapter)
+    end
+
+    initializer 'debugbar.helper' do
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.helper(Debugbar::TagHelpers)
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        include Debugbar::TagHelpers
+      end
+    end
+
+    initializer 'debugbar.assets' do
+      dist = File.join(Gem.loaded_specs['debugbar'].full_gem_path, 'client', 'dist')
+      manifest_file =  File.join(dist, '.vite', 'manifest.json')
+      manifest = JSON.parse(File.read(manifest_file))
+
+      Debugbar.js_file = File.join(dist, manifest['src/main.ts']['file'])
+    end
+
+    initializer 'debugbar.inject_middlewares' do |app|
+      next unless Debugbar.config.enabled?
+      app.middleware.insert_after ActionDispatch::RequestId, Debugbar::TrackCurrentRequest
+    end
+
+    initializer 'debugbar.subscribe' do
+      if Debugbar.config.active_record?
+        require_relative 'subscribers/active_record'
+        subscribe "Debugbar::ActiveRecordEventSubscriber" => "sql.active_record"
+      end
+
+      if Debugbar.config.action_controller?
+        require_relative 'subscribers/action_controller'
+        subscribe "Debugbar::ActionControllerEventSubscriber" => %w[
+          start_processing.action_controller process_action.action_controller
+        ]
+      end
+
+      if Debugbar.config.active_job?
+        require_relative 'subscribers/active_job'
+        subscribe "Debugbar::ActiveJobEventSubscriber" => ["enqueue.active_job", "enqueue_at.active_job"]
+      end
+
+      require_relative 'subscribers/active_support'
+      subscribe "Debugbar::ActiveSupportEventSubscriber.cache" => %w(
+        cache_read.active_support
+        cache_generate.active_support
+        cache_fetch_hit.active_support
+        cache_write.active_support
+        cache_delete.active_support
+        cache_exist?.active_support
+      )
+    end
+
+    initializer 'debugbar.track_models' do
+      next unless Debugbar.config.active_record?
+      ActiveSupport.on_load(:active_record) do
+        after_initialize do |model|
+          Debugbar::Tracker.inc_model(model.class.name)
+        end
+      end
+    end
 
-    rake_tasks do
-      load "debugbar/railties/tasks.rake"
+    def subscribe(config)
+      config.each do |subscriber, event_names|
+        event_names = Array.wrap(event_names)
+        class_name, class_method_name = subscriber.split('.')
+        event_names.each do |name|
+          method_name = class_method_name || name.split('.').first
+          ActiveSupport::Notifications.subscribe name do |event|
+            class_name.constantize.send method_name, event
+          end
+        end
+      end
     end
   end
 end

data/lib/debugbar/loggers/simple_logger.rb

@@ -0,0 +1,34 @@
+module Debugbar
+  class SimpleLogger < ::Logger
+    def initialize(min_level= 2)
+      @min_level = min_level
+    end
+
+    def add(severity, message = nil, progname = nil)
+      # 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?
+
+      return if severity < @min_level
+
+      if message.nil?
+        if block_given?
+          message = yield
+        else
+          message = progname
+          progname = nil
+        end
+      end
+
+      Debugbar::Tracker.add_log({
+        time: Time.now.strftime(Debugbar::TIME_FORMAT),
+        severity: severity,
+        severity_label: SEV_LABEL[severity],
+        message: message,
+        progname: progname,
+      })
+    end
+  end
+end

data/lib/debugbar/middlewares/track_current_request.rb

@@ -0,0 +1,35 @@
+module Debugbar
+  class TrackCurrentRequest
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Debugbar::Current.ignore = Debugbar.config.ignore_request?(env)
+
+      return @app.call(env) if Debugbar::Current.ignore?
+
+      Debugbar::Current.new_request!(env['action_dispatch.request_id'])
+
+      res = @app.call(env)
+
+      # TODO: Remove this if statement?
+      if Debugbar::Current.request&.id
+        # 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!)
+
+        if Debugbar.connected?
+          data = RequestBuffer.all.map(&:to_h)
+          ActionCable.server.broadcast("debugbar_channel", data)
+        end
+      end
+
+      res
+    end
+  end
+
+end

data/lib/debugbar/request.rb

@@ -0,0 +1,98 @@
+module Debugbar
+  class Request
+    attr_reader :request_id, :meta,
+                :models, :queries, :jobs,
+                :messages, :cache, :logs
+    attr_accessor :request, :response, :headers
+
+    def initialize(request_id)
+      @request_id = request_id
+      @models = {}
+      @queries = []
+      @jobs = []
+      @messages = []
+      @cache = []
+      @logs = []
+    end
+
+    alias_method :id, :request_id
+
+    def meta=(meta)
+      meta.delete(:headers)
+      meta.delete(:request)
+      meta.delete(:response)
+      @meta = meta
+    end
+
+    def inc_model(name)
+      if @models[name]
+        @models[name] += 1
+      else
+        @models[name] = 1
+      end
+    end
+
+    def add_query(query)
+      @queries << query
+    end
+
+    def add_job(job)
+      @jobs << job
+    end
+
+    def add_msg(msg, extra)
+      @messages << {msg: msg, extra: extra}
+    end
+
+    def add_cache(c)
+      @cache << c
+    end
+
+    def add_log(l)
+      @logs << l
+    end
+
+    def to_h
+      {
+        id: request_id,
+        meta: meta,
+        request: request_hash,
+        response: response_hash,
+        models: models,
+        queries: queries,
+        jobs: jobs,
+        messages: messages,
+        cache: cache,
+        logs: logs,
+      }
+    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

@@ -0,0 +1,33 @@
+module Debugbar
+  class ActionControllerEventSubscriber
+    class << self
+      def start_processing(event)
+        return if Debugbar::Current.ignore?
+
+        Debugbar::Tracker.request = event.payload[:request]
+      end
+
+      def process_action(event)
+        return if Debugbar::Current.ignore?
+
+        meta = event.payload
+
+        meta.delete :headers
+        request = meta.delete :request
+        response = meta.delete :response
+
+        meta.merge!({
+          duration: event.duration,
+          cpu_time: event.cpu_time,
+          idle_time: event.idle_time,
+          allocations: event.allocations,
+        })
+
+        Debugbar::Tracker.request = request
+        Debugbar::Tracker.response = response
+        Debugbar::Tracker.meta = meta
+
+      end
+    end
+  end
+end