debugbar 0.0.1 → 0.1.0

data/lib/debugbar/subscribers/active_job.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Debugbar
+  class ActiveJobEventSubscriber
+    class_attribute :backtrace_cleaner, default: ActiveSupport::BacktraceCleaner.new
+
+    class << self
+      def enqueue(event)
+        return if Debugbar::Current.ignore?
+
+        job = event.payload[:job]
+        ex = event.payload[:exception_object] || job.enqueue_error
+
+        logs = []
+        logs << if ex
+          "Failed enqueuing #{job.class.name} to #{queue_name(event)}: #{ex.class} (#{ex.message})"
+        elsif event.payload[:aborted]
+          "Failed enqueuing #{job.class.name} to #{queue_name(event)}, a before_enqueue callback halted the enqueuing execution."
+        else
+          "Enqueued #{job.class.name} (Job ID: #{job.job_id}) to #{queue_name(event)}" + args_info(job)
+        end
+        logs << log_enqueue_source
+
+        Debugbar::Tracker.add_job({
+          id: job.job_id,
+          class: job.class.name,
+          queue: queue_name(event),
+          args: job.arguments.map { |arg| format(arg) },
+          successfully_enqueued: job.successfully_enqueued?,
+          scheduled_at: scheduled_at(job),
+          logs: logs,
+        })
+      end
+      # subscribe_log_level :enqueue, :info # ???
+
+      def enqueue_at(event)
+        return if Debugbar::Current.ignore?
+
+        job = event.payload[:job]
+        ex = event.payload[:exception_object] || job.enqueue_error
+
+        logs = []
+        logs << if ex
+          "Failed enqueuing #{job.class.name} to #{queue_name(event)}: #{ex.class} (#{ex.message})"
+        elsif event.payload[:aborted]
+          "Failed enqueuing #{job.class.name} to #{queue_name(event)}, a before_enqueue callback halted the enqueuing execution."
+        else
+          "Enqueued #{job.class.name} (Job ID: #{job.job_id}) to #{queue_name(event)} at #{scheduled_at(job)}" + args_info(job)
+        end
+        logs << log_enqueue_source
+
+        Debugbar::Tracker.add_job({
+          id: job.job_id,
+          class: job.class.name,
+          queue: queue_name(event),
+          args: job.arguments.map { |arg| format(arg) },
+          successfully_enqueued: job.successfully_enqueued?,
+          scheduled_at: scheduled_at(job),
+          logs: logs,
+        })
+      end
+      # subscribe_log_level :enqueue_at, :info
+
+      # def enqueue_all(event)
+      #   info do
+      #     jobs = event.payload[:jobs]
+      #     adapter = event.payload[:adapter]
+      #     enqueued_count = event.payload[:enqueued_count]
+      #
+      #     if enqueued_count == jobs.size
+      #       enqueued_jobs_message(adapter, jobs)
+      #     elsif jobs.any?(&:successfully_enqueued?)
+      #       enqueued_jobs = jobs.select(&:successfully_enqueued?)
+      #
+      #       failed_enqueue_count = jobs.size - enqueued_count
+      #       if failed_enqueue_count == 0
+      #         enqueued_jobs_message(adapter, enqueued_jobs)
+      #       else
+      #         "#{enqueued_jobs_message(adapter, enqueued_jobs)}. "\
+      #           "Failed enqueuing #{failed_enqueue_count} #{'job'.pluralize(failed_enqueue_count)}"
+      #       end
+      #     else
+      #       failed_enqueue_count = jobs.size - enqueued_count
+      #       "Failed enqueuing #{failed_enqueue_count} #{'job'.pluralize(failed_enqueue_count)} "\
+      #         "to #{ActiveJob.adapter_name(adapter)}"
+      #     end
+      #   end
+      # end
+      # # subscribe_log_level :enqueue_all, :info
+
+      private
+      def queue_name(event)
+        ActiveJob.adapter_name(event.payload[:adapter]) + "(#{event.payload[:job].queue_name})"
+      end
+
+      def args_info(job)
+        if job.class.log_arguments? && job.arguments.any?
+          " with arguments: " +
+            job.arguments.map { |arg| format(arg).inspect }.join(", ")
+        else
+          ""
+        end
+      end
+
+      def format(arg)
+        case arg
+        when Hash
+          arg.transform_values { |value| format(value) }
+        when Array
+          arg.map { |value| format(value) }
+        when GlobalID::Identification
+          arg.to_global_id rescue arg
+        else
+          arg
+        end
+      end
+
+      def scheduled_at(job)
+        Time.at(job.scheduled_at).utc if job.scheduled_at
+      end
+
+      def logger
+        ActiveJob::Base.logger
+      end
+
+      def info(progname = nil, &block)
+        return unless super
+
+        if ActiveJob.verbose_enqueue_logs
+          log_enqueue_source
+        end
+      end
+
+      def error(progname = nil, &block)
+        return unless super
+
+        if ActiveJob.verbose_enqueue_logs
+          log_enqueue_source
+        end
+      end
+
+      def log_enqueue_source
+        extract_enqueue_source_location(caller)
+      end
+
+      def extract_enqueue_source_location(locations)
+        backtrace_cleaner.clean(locations.lazy).first
+      end
+
+      def enqueued_jobs_message(adapter, enqueued_jobs)
+        enqueued_count = enqueued_jobs.size
+        job_classes_counts = enqueued_jobs.map(&:class).tally.sort_by { |_k, v| -v }
+        "Enqueued #{enqueued_count} #{'job'.pluralize(enqueued_count)} to #{ActiveJob.adapter_name(adapter)}"\
+          " (#{job_classes_counts.map { |klass, count| "#{count} #{klass}" }.join(', ')})"
+      end
+    end
+  end
+end

data/lib/debugbar/subscribers/active_record.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Debugbar
+  class ActiveRecordEventSubscriber
+    class_attribute :backtrace_cleaner, default: ActiveSupport::BacktraceCleaner.new
+
+    class << self
+      def sql(event)
+        return if Debugbar::Current.ignore?
+
+        payload = event.payload
+
+        return if payload[:name]&.starts_with? "SCHEMA"
+
+        title = if payload[:async]
+          "ASYNC #{payload[:name]} (#{payload[:lock_wait].round(1)}ms) (db time #{event.duration.round(1)}ms)"
+        else
+          "#{payload[:name] || "Unnamed"} (#{event.duration.round(1)}ms)"
+        end
+        title = "CACHE #{title}" if payload[:cached]
+
+        sql = payload[:sql]&.gsub(/\/\*.*\*\//, "") # remove comments
+
+        binds = nil
+        if payload[:binds]&.any?
+          casted_params = type_casted_binds(payload[:type_casted_binds])
+
+          binds = []
+          payload[:binds].each_with_index do |attr, i|
+            attribute_name = if attr.respond_to?(:name)
+              attr.name
+            elsif attr.respond_to?(:[]) && attr[i].respond_to?(:name)
+              attr[i].name
+            else
+              nil
+            end
+
+            filtered_params = filter(attribute_name, casted_params[i])
+
+            binds << render_bind(attr, filtered_params)
+          end
+          binds = binds.inspect
+          binds.prepend("  ")
+        end
+
+        Debugbar::Tracker.add_query({
+          id: event.transaction_id,
+          title: title,
+          name: payload[:name],
+          sql: sql,
+          cached: payload[:cached].present?,
+          async: payload[:async],
+          duration: event.duration.round(1),
+          lock_wait: payload[:lock_wait]&.round(1),
+          binds: binds,
+          source: query_source_location&.split(":in"),
+        })
+      end
+
+      def query_source_location
+        backtrace_cleaner.clean(caller(3))[0]
+      end
+    end
+  end
+end

data/lib/debugbar/subscribers/active_support.rb

@@ -0,0 +1,30 @@
+module Debugbar
+  class ActiveSupportEventSubscriber
+    class << self
+      def cache(event)
+        evt = event.payload
+        evt[:name] = event.name
+        evt[:transaction_id] = event.transaction_id
+        evt[:time] = Time.at(event.time).strftime(Debugbar::TIME_FORMAT)
+        evt[:label] = case event.name
+          when "cache_read.active_support"
+            "read"
+          when "cache_generate.active_support"
+            "generate"
+          when "cache_fetch_hit.active_support"
+            "fetch hit"
+          when "cache_write.active_support"
+            "write"
+          when "cache_delete.active_support"
+            "delete"
+          when "cache_exist?.active_support"
+            "exist?"
+          else
+            "unknown"
+          end
+
+        Debugbar::Tracker.add_cache evt
+      end
+    end
+  end
+end

data/lib/debugbar/version.rb

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

data/lib/debugbar.rb

@@ -1,8 +1,89 @@
-require 'pathname'
-require 'debugbar/engine' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
+# frozen_string_literal: true
 
-module DebugBar
-  def self.root
-    Pathname.new(File.join(File.dirname(__FILE__), ".."))
+module Debugbar
+  autoload :VERSION, "debugbar/version"
+  autoload :Current, "debugbar/current"
+  autoload :Request, "debugbar/request"
+  autoload :RequestBuffer, "debugbar/buffers/request_buffer"
+  autoload :SimpleLogger, "debugbar/loggers/simple_logger"
+
+  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
+
+      SETTERS.each do |m|
+        define_method("#{m}=") do |val|
+          if Current.request.nil?
+            # 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)
+          end
+        end
+      end
+
+      METHODS.each do |m|
+        define_method(m) do |*args, &block|
+          if Current.request
+            return Current.request.send(m, *args, &block)
+          end
+
+          if Current.request.nil? && ENV["DEBUGBAR_VERBOSE_MODE"] == "true"
+            puts "The current request is not set yet. Was trying to call #{m}(#{args.map{ _1.class.name}.join(',')})."
+            pp args
+            nil
+          end
+        end
+      end
+
+      def msg(msg, *extra)
+        if Current.request.nil?
+          puts "The current request is not set yet. Printing to STDOUT instead."
+          puts msg, extra
+        else
+          Current.request.add_msg(msg, extra)
+        end
+      end
+    end
+  end
+
+  include Tracker
+
+  class << self
+    def config
+      @config ||= Config.new(enabled: true)
+    end
+
+    def configure
+      yield config
+    end
+
+    def connect!
+      @connected = true
+    end
+
+    def disconnect!
+      @connected = false
+    end
+
+    def connected?
+      @connected
+    end
+
+    def js_file=(js_file)
+      @js_file = js_file
+    end
+    def js_file
+      @js_file
+    end
+
+    def msg(msg, *extra)
+      Tracker.msg(msg, *extra)
+    end
   end
 end
+
+require 'debugbar/engine'

data/package-lock.json

@@ -0,0 +1,50 @@
+{
+  "name": "debugbar_rb",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "dependencies": {
+        "prettier": "^3.1.0",
+        "vue-shadow-dom": "^4.2.0"
+      },
+      "devDependencies": {
+        "@types/node": "^20.10.4"
+      }
+    },
+    "node_modules/@types/node": {
+      "version": "20.10.4",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.10.4.tgz",
+      "integrity": "sha512-D08YG6rr8X90YB56tSIuBaddy/UXAA9RKJoFvrsnogAum/0pmjkgi4+2nx96A330FmioegBWmEYQ+syqCFaveg==",
+      "dev": true,
+      "dependencies": {
+        "undici-types": "~5.26.4"
+      }
+    },
+    "node_modules/prettier": {
+      "version": "3.1.0",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.1.0.tgz",
+      "integrity": "sha512-TQLvXjq5IAibjh8EpBIkNKxO749UEWABoiIZehEPiY4GNpVdhaFKqSTu+QrlU6D2dPAfubRmtJTi4K4YkQ5eXw==",
+      "bin": {
+        "prettier": "bin/prettier.cjs"
+      },
+      "engines": {
+        "node": ">=14"
+      },
+      "funding": {
+        "url": "https://github.com/prettier/prettier?sponsor=1"
+      }
+    },
+    "node_modules/undici-types": {
+      "version": "5.26.5",
+      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
+      "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
+      "dev": true
+    },
+    "node_modules/vue-shadow-dom": {
+      "version": "4.2.0",
+      "resolved": "https://registry.npmjs.org/vue-shadow-dom/-/vue-shadow-dom-4.2.0.tgz",
+      "integrity": "sha512-lguI064rT2HT/dxqSmXtz860KOvCq+W3nU1jMqroTmX3K1H46q22BMR4emh/Ld3ozy35XJKOaNGcr6mkJ/t/yg=="
+    }
+  }
+}

data/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "prettier": "^3.1.0"
+  }
+}

data/sig/debugbar.rbs

@@ -0,0 +1,4 @@
+module Debugbar
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,59 +1,155 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: debugbar
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
 platform: ruby
-authors: 
-- Andy Jeffries
-autorequire: 
-bindir: bin
+authors:
+- Julien Bourdeau
+autorequire:
+bindir: exe
 cert_chain: []
-
-date: 2011-03-17 00:00:00 +00:00
-default_executable: 
-dependencies: []
-
-description: Debugbar gem for Rails 3
-email: andy@andyjeffries.co.uk
+date: 2024-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actioncable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Get a better understanding of your application performance and behavior
+  (SQL queries, jobs, cache, routes, logs, etc)
+email:
+- julien@debugbar.dev
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.textile
-files: 
+extra_rdoc_files: []
+files:
+- ".prettierrc"
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/channels/debugbar/debugbar_channel.rb
+- app/controllers/debugbar/application_controller.rb
+- app/controllers/debugbar/assets_controller.rb
+- app/helpers/debugbar/tag_helpers.rb
+- app/models/debugbar/application_record.rb
+- client/.gitignore
+- client/README.md
+- client/dist/.vite/manifest.json
+- client/dist/assets/debugbar-u5mP-5-z.js
+- client/dist/assets/ruby-logo-kn_8RniZ.svg
+- client/index.html
+- client/package-lock.json
+- client/package.json
+- client/postcss.config.js
+- client/src/App.vue
+- client/src/AppDemo.vue
+- client/src/AppDev.vue
+- client/src/Debugbar.vue
+- client/src/assets/rails-logo.svg
+- client/src/assets/ruby-logo.svg
+- client/src/components/TabButton.vue
+- client/src/components/panels/CachePanel.vue
+- client/src/components/panels/JobsPanel.vue
+- client/src/components/panels/JsonPanel.vue
+- client/src/components/panels/LogsPanel.vue
+- client/src/components/panels/MessagesPanel.vue
+- client/src/components/panels/ModelsPanel.vue
+- client/src/components/panels/Panel.vue
+- client/src/components/panels/RequestPanel.vue
+- client/src/components/queries/QueriesPanel.vue
+- client/src/components/queries/QueryItem.vue
+- client/src/components/ui/Foldable.vue
+- client/src/components/ui/KeyValueTable.vue
+- client/src/components/ui/Row.vue
+- client/src/components/ui/logo-ruby.vue
+- client/src/demo.ts
+- client/src/dev.ts
+- client/src/main.ts
+- client/src/models/Config.ts
+- client/src/models/Request.ts
+- client/src/stores/RequestsStore.ts
+- client/src/stores/configStore.ts
+- client/src/style.css
+- client/src/types.d.ts
+- client/src/vite-env.d.ts
+- client/tailwind.config.js
+- client/tsconfig.json
+- client/tsconfig.node.json
+- client/vite.config.ts
+- config/routes.rb
+- debugbar.gemspec
+- fixtures/requests/1706607114--demo_post_list.json
+- fixtures/requests/1706607120--api_jobs.json
+- fixtures/requests/1706607123--api_jobs.json
+- fixtures/requests/1706607133--demo_slow_page.json
+- fixtures/requests/1706607136--demo_post.json
+- fixtures/requests/1706607136--demo_random_post.json
+- fixtures/requests/1706607141--api_errors.json
 - lib/debugbar.rb
+- lib/debugbar/buffers/memory_buffer.rb
+- lib/debugbar/buffers/null_buffer.rb
+- lib/debugbar/buffers/request_buffer.rb
+- lib/debugbar/config.rb
+- lib/debugbar/current.rb
 - lib/debugbar/engine.rb
-- lib/debugbar/railties/tasks.rake
-- README.textile
-has_rdoc: true
-homepage: http://andyjeffries.co.uk/
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+- lib/debugbar/loggers/simple_logger.rb
+- lib/debugbar/middlewares/track_current_request.rb
+- lib/debugbar/request.rb
+- lib/debugbar/subscribers/action_controller.rb
+- lib/debugbar/subscribers/active_job.rb
+- lib/debugbar/subscribers/active_record.rb
+- lib/debugbar/subscribers/active_support.rb
+- lib/debugbar/version.rb
+- package-lock.json
+- package.json
+- sig/debugbar.rbs
+homepage: https://debugbar.dev
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://debugbar.dev
+  source_code_uri: https://github.com/julienbourdeau/debugbar
+  changelog_uri: https://debugbar.dev/changelog/
+post_install_message:
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.6.1
-signing_key: 
-specification_version: 3
-summary: Debugbar gem for Rails 3
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Powerful devtools for Ruby on Rails
 test_files: []
-

data/README.textile

@@ -1,18 +0,0 @@
-h1. Debug Bar Gem v0.0.1
-
-h2. Installation
-
-Add the following to your Gemfile:
-
-<pre><code>gem 'debugbar'</code></pre>
-
-And restart your application with:
-
-<pre><code>bundle install
-touch tmp/restart.txt</code></pre>
-
-h2. Introduction
-
-DebugBar provides a Django/Symfony like Debug Bar for Ruby on Rails 3.
-
-This project is only in it's infancy...

data/lib/debugbar/railties/tasks.rake

@@ -1 +0,0 @@
-# Put your custom rake tasks here