rails_live_dashboard 0.1.0

data/lib/rails_live_dashboard/context.rb

@@ -0,0 +1,19 @@
+require 'singleton'
+
+module RailsLiveDashboard
+  class Context
+    include Singleton
+
+    def start
+      @batch_id = SecureRandom.uuid
+    end
+
+    def batch_id
+      @batch_id ||= SecureRandom.uuid
+    end
+
+    def reset
+      @batch_id = nil
+    end
+  end
+end

data/lib/rails_live_dashboard/engine.rb

@@ -0,0 +1,28 @@
+module RailsLiveDashboard
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsLiveDashboard
+
+    initializer 'rails_live_dashboard', after: :load_config_initializers do |_app|
+      next unless RailsLiveDashboard.configuration.enabled
+    end
+
+    initializer 'rails_live_dashboard.assets.precompile' do |app|
+      next unless RailsLiveDashboard.configuration.enabled
+
+      app.config.assets.precompile += [
+        'builds/rails_live_dashboard/application.js',
+        'builds/rails_live_dashboard/application.css'
+      ]
+    end
+
+    initializer 'rails_live_dashboard.action_controller' do
+      next unless RailsLiveDashboard.configuration.enabled
+
+      Subscribers::ActionControllerSubscriber.new
+    end
+
+    initializer 'rails_live_dashboard.action_record' do
+      Subscribers::ActiveRecordSubscriber.new
+    end
+  end
+end

data/lib/rails_live_dashboard/recorders/exception_recorder.rb

@@ -0,0 +1,42 @@
+module RailsLiveDashboard
+  module Recorders
+    class ExceptionRecorder
+      def initialize(exception)
+        @exception = exception
+      end
+
+      def execute
+        Exception.of_class(@exception.class).update_all(should_show: false)
+
+        Exception.create(
+          batch_id: RailsLiveDashboard::Context.instance.batch_id,
+          content: build_content
+        )
+      end
+
+      private
+
+      def build_content
+        occurrences = Exception.of_class(@exception.class).count
+
+        {
+          class: @exception.class,
+          message: @exception.message,
+          file: file_line[0],
+          line: file_line[1],
+          backtrace: @exception.backtrace,
+          occurrences: occurrences + 1
+        }
+      end
+
+      def file_line
+        return ['', ''] unless @exception.backtrace
+
+        file = @exception.backtrace[0].split(':').first
+        line = @exception.backtrace[0].split(':')[1]
+
+        [file, line]
+      end
+    end
+  end
+end

data/lib/rails_live_dashboard/recorders/query_recorder.rb

@@ -0,0 +1,30 @@
+module RailsLiveDashboard
+  module Recorders
+    class QueryRecorder
+      def initialize(event)
+        @event = event
+      end
+
+      def execute
+        Query.create(
+          batch_id: RailsLiveDashboard::Context.instance.batch_id,
+          content: build_content
+        )
+      end
+
+      private
+
+      def build_content
+        payload = @event.payload
+        {
+          name: payload[:name],
+          sql: payload[:sql].strip.gsub(/(^(\s+)?$\n)/, ''),
+          parameters: payload[:type_casted_binds],
+          duration: (@event.end - @event.time).round(2),
+          kind: payload[:sql].match(/INSERT|UPDATE|DELETE/) ? 'WRITE' : 'READ',
+          cached: payload[:cached] ? true : false
+        }
+      end
+    end
+  end
+end

data/lib/rails_live_dashboard/recorders/request_recorder.rb

@@ -0,0 +1,30 @@
+module RailsLiveDashboard
+  module Recorders
+    class RequestRecorder
+      def initialize(event)
+        @event = event
+      end
+
+      def execute
+        Request.create(
+          batch_id: RailsLiveDashboard::Context.instance.batch_id,
+          content: build_content
+        )
+      end
+
+      private
+
+      def build_content
+        payload = @event.payload
+        payload.merge(
+          {
+            headers: payload[:request].headers.env.reject { |key| key.to_s.include?('.') },
+            body: payload[:response]&.body || nil,
+            duration: @event.duration.round(2),
+            allocations: @event.allocations
+          }
+        )
+      end
+    end
+  end
+end

data/lib/rails_live_dashboard/subscribers/action_controller_subscriber.rb

@@ -0,0 +1,28 @@
+module RailsLiveDashboard
+  module Subscribers
+    class ActionControllerSubscriber
+      def initialize
+        ActiveSupport::Notifications.subscribe 'start_processing.action_controller' do |_event|
+          RailsLiveDashboard::Context.instance.start
+        end
+
+        ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |event|
+          next if event.payload[:controller].include?('RailsLiveDashboard')
+
+          handle_event(event)
+        rescue StandardError => e
+          Rails.logger.error "Error on handle action controller event: #{e.message}"
+        end
+      end
+
+      private
+
+      def handle_event(event)
+        Recorders::RequestRecorder.new(event).execute
+        Recorders::ExceptionRecorder.new(event.payload[:exception_object]).execute if event.payload[:exception_object]
+
+        RailsLiveDashboard::Context.instance.reset
+      end
+    end
+  end
+end

data/lib/rails_live_dashboard/subscribers/active_record_subscriber.rb

@@ -0,0 +1,23 @@
+module RailsLiveDashboard
+  module Subscribers
+    class ActiveRecordSubscriber
+      def initialize
+        ActiveSupport::Notifications.subscribe 'sql.active_record' do |event|
+          next if should_skip(event)
+
+          Recorders::QueryRecorder.new(event).execute
+        rescue StandardError => e
+          Rails.logger.error "ActionRecordSubscriber - Error on handle active record event: #{e.message}"
+        end
+      end
+
+      private
+
+      def should_skip(event)
+        event.payload[:name].blank? ||
+          event.payload[:name].match(/SCHEMA|TRANSACTION|ActiveRecord|RailsLiveDashboard/) ||
+          event.payload[:sql].match(/BEGIN|COMMIT/)
+      end
+    end
+  end
+end

data/lib/rails_live_dashboard/version.rb

@@ -0,0 +1,3 @@
+module RailsLiveDashboard
+  VERSION = '0.1.0'
+end

data/lib/rails_live_dashboard.rb

@@ -0,0 +1,19 @@
+require 'rails_live_dashboard/version'
+require 'rails_live_dashboard/engine'
+require 'rails_live_dashboard/configuration'
+require 'rails_live_dashboard/context'
+require 'rails_live_dashboard/recorders/exception_recorder'
+require 'rails_live_dashboard/recorders/request_recorder'
+require 'rails_live_dashboard/recorders/query_recorder'
+require 'rails_live_dashboard/subscribers/action_controller_subscriber'
+require 'rails_live_dashboard/subscribers/active_record_subscriber'
+
+module RailsLiveDashboard
+  def self.configuration
+    @configuration ||= Configuration.instance
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/tasks/rails_live_dashboard_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_live_dashboard do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: rails_live_dashboard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anderson Dalmina
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3
+description: Realtime dashboard for Rails applications
+email:
+- andersondalmina@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/builds/rails_live_dashboard/application.css
+- app/assets/builds/rails_live_dashboard/application.js
+- app/assets/builds/rails_live_dashboard/application.js.map
+- app/assets/javascripts/rails_live_dashboard/application.js
+- app/assets/javascripts/rails_live_dashboard/controllers/application.js
+- app/assets/javascripts/rails_live_dashboard/controllers/index.js
+- app/assets/javascripts/rails_live_dashboard/controllers/reveal_controller.js
+- app/assets/javascripts/rails_live_dashboard/controllers/tabs_controller.js
+- app/assets/stylesheets/rails_live_dashboard/application.css
+- app/components/rails_live_dashboard/query_duration_badge_component.html.erb
+- app/components/rails_live_dashboard/query_duration_badge_component.rb
+- app/components/rails_live_dashboard/request_duration_badge_component.html.erb
+- app/components/rails_live_dashboard/request_duration_badge_component.rb
+- app/components/rails_live_dashboard/request_method_badge_component.html.erb
+- app/components/rails_live_dashboard/request_method_badge_component.rb
+- app/components/rails_live_dashboard/request_status_badge_component.html.erb
+- app/components/rails_live_dashboard/request_status_badge_component.rb
+- app/controllers/rails_live_dashboard/application_controller.rb
+- app/controllers/rails_live_dashboard/clean_controller.rb
+- app/controllers/rails_live_dashboard/dashboard_controller.rb
+- app/controllers/rails_live_dashboard/exceptions_controller.rb
+- app/controllers/rails_live_dashboard/queries_controller.rb
+- app/controllers/rails_live_dashboard/requests_controller.rb
+- app/controllers/rails_live_dashboard/widgets/slowest_queries_controller.rb
+- app/controllers/rails_live_dashboard/widgets/slowest_requests_controller.rb
+- app/helpers/rails_live_dashboard/application_helper.rb
+- app/helpers/rails_live_dashboard/clean_helper.rb
+- app/helpers/rails_live_dashboard/dashboard_helper.rb
+- app/helpers/rails_live_dashboard/exceptions_helper.rb
+- app/helpers/rails_live_dashboard/requests_helper.rb
+- app/jobs/rails_live_dashboard/application_job.rb
+- app/mailers/rails_live_dashboard/application_mailer.rb
+- app/models/rails_live_dashboard/application_record.rb
+- app/models/rails_live_dashboard/entry.rb
+- app/models/rails_live_dashboard/exception.rb
+- app/models/rails_live_dashboard/query.rb
+- app/models/rails_live_dashboard/request.rb
+- app/models/rails_live_dashboard/types/content.rb
+- app/models/rails_live_dashboard/types/exception_content.rb
+- app/models/rails_live_dashboard/types/query_content.rb
+- app/models/rails_live_dashboard/types/request_content.rb
+- app/views/layouts/rails_live_dashboard/application.html.erb
+- app/views/rails_live_dashboard/dashboard/show.html.erb
+- app/views/rails_live_dashboard/exceptions/_tabs.html.erb
+- app/views/rails_live_dashboard/exceptions/index.html.erb
+- app/views/rails_live_dashboard/exceptions/show.html.erb
+- app/views/rails_live_dashboard/queries/_list.html.erb
+- app/views/rails_live_dashboard/queries/index.html.erb
+- app/views/rails_live_dashboard/queries/show.html.erb
+- app/views/rails_live_dashboard/requests/_contents.html.erb
+- app/views/rails_live_dashboard/requests/_exceptions.html.erb
+- app/views/rails_live_dashboard/requests/_queries.html.erb
+- app/views/rails_live_dashboard/requests/_relateds.html.erb
+- app/views/rails_live_dashboard/requests/index.html.erb
+- app/views/rails_live_dashboard/requests/show.html.erb
+- app/views/rails_live_dashboard/shared/_header.html.erb
+- app/views/rails_live_dashboard/widgets/slowest_queries/show.html.erb
+- app/views/rails_live_dashboard/widgets/slowest_requests/show.html.erb
+- config/routes.rb
+- db/migrate/20240213133517_create_rails_live_dashboard_entries.rb
+- lib/generators/rails_live_dashboard/install_generator.rb
+- lib/generators/templates/initializer.rb
+- lib/rails_live_dashboard.rb
+- lib/rails_live_dashboard/configuration.rb
+- lib/rails_live_dashboard/context.rb
+- lib/rails_live_dashboard/engine.rb
+- lib/rails_live_dashboard/recorders/exception_recorder.rb
+- lib/rails_live_dashboard/recorders/query_recorder.rb
+- lib/rails_live_dashboard/recorders/request_recorder.rb
+- lib/rails_live_dashboard/subscribers/action_controller_subscriber.rb
+- lib/rails_live_dashboard/subscribers/active_record_subscriber.rb
+- lib/rails_live_dashboard/version.rb
+- lib/tasks/rails_live_dashboard_tasks.rake
+homepage: https://github.com/andersondalmina/rails-live-dashboard
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andersondalmina/rails-live-dashboard
+  source_code_uri: https://github.com/andersondalmina/rails-live-dashboard
+  changelog_uri: https://github.com/andersondalmina/rails-live-dashboard/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Realtime dashboard for Rails applications
+test_files: []