RubyGems - rails_trace_viewer - Versions diffs - 0.1.2 → 0.1.4 - Mend

rails_trace_viewer 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

checksums.yaml +4 -4
data/README.md +5 -1
data/app/views/rails_trace_viewer/traces/show.html.erb +34 -21
data/lib/rails_trace_viewer/active_job_extension.rb +45 -0
data/lib/rails_trace_viewer/collector.rb +0 -17
data/lib/rails_trace_viewer/engine.rb +55 -32
data/lib/rails_trace_viewer/subscribers/active_job_subscriber.rb +28 -31
data/lib/rails_trace_viewer/subscribers/method_subscriber.rb +22 -0
data/lib/rails_trace_viewer/subscribers/sidekiq_subscriber.rb +2 -11
data/lib/rails_trace_viewer/subscribers/sql_subscriber.rb +19 -8
data/lib/rails_trace_viewer/version.rb +1 -1
data/lib/rails_trace_viewer.rb +1 -1
metadata +2 -2
data/lib/rails_trace_viewer/job_link_registry.rb +0 -42

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ff338c196864dc973331301d6fbdbbc50de7ab3940ae012458f73bdfe5b0183
-  data.tar.gz: b9b535f0575a9972380c9fca35faa82305298b23c64b524182c2ed01df92bc51
+  metadata.gz: abac85cedd4d86a997eea9b60f1b449e88ff3799cd13926fa83c143c3d3d1abb
+  data.tar.gz: 5fc903e2e18a93e94acb048a6b3350c06346840e285119f9e9221d9dc3f76b68
 SHA512:
-  metadata.gz: 824699687247af12dc1abf2fd5be2c5bc45e12896606042c531fec5a6d6918a9b4ae06b7c8990b32ce3cbdb1cf77d5e7a6769e34261c633eef3eec8fb413ce22
-  data.tar.gz: b140ba6bc597e257e286ed3c1d092660041ca5003b5b278dee51d962436ab54a566e01b4d5d331c4c7a5d444024e66691833800b3589a0d6e861297fcdabc4c6
+  metadata.gz: 20aa8961b4ce0797d78614075b8cb100f30b28a1a98e9286d839da5ef04c852f7fcc519b97a3228c8ad1bb2642341726048f5a6bae10337f92e0dc23c75d03ed
+  data.tar.gz: 9769095c141f0bf4024fea8a6e74da56600e4299eaf2b7d98cfb53139e442856e08ae7dad0a26f30f1fadb244b5a57c5e32cf5b5244b2e0b9cef28a8d0723a01

data/README.md CHANGED Viewed

@@ -2,7 +2,11 @@
 An educational and debugging tool for Ruby on Rails to visualize the request lifecycle in real-time.
-[![Watch the Demo](https://img.youtube.com/vi/Zwg3rROyaH0/maxresdefault.jpg)](https://youtu.be/Zwg3rROyaH0)
+<div align="center">
+  <a href="https://youtu.be/duSncwziSwE">
+    <img src="https://markdown-videos-api.jorgenkh.no/url?url=https%3A%2F%2Fyoutu.be%2FduSncwziSwE" alt="Watch the Demo" style="width:100%; max-width:800px; border-radius: 8px; box-shadow: 0 10px 30px rgba(0,0,0,0.15);">
+  </a>
+</div>
 Rails Trace Viewer provides a beautiful, interactive Call Stack Tree that visualizes how your Rails application processes requests. It traces the flow from the Controller through Models, Views, SQL Queries, and even across process boundaries into Sidekiq Background Jobs.

data/app/views/rails_trace_viewer/traces/show.html.erb CHANGED Viewed

@@ -2,6 +2,9 @@
 <html>
 <head>
   <title>Rails Trace Viewer</title>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
   <script src="https://cdn.tailwindcss.com"></script>
   <script src="https://d3js.org/d3.v7.min.js"></script>
   <script src="https://cdnjs.cloudflare.com/ajax/libs/dagre/0.8.5/dagre.min.js"></script>
@@ -144,7 +147,6 @@ document.addEventListener("DOMContentLoaded", () => {
   const emptyState = document.getElementById("empty-state");
   let graphs = {};
   let nodeBuffer = {};
-  let verticalOffset = 60;
   const DAG_SPACING = 200;
   // Node Dimensions
@@ -167,24 +169,34 @@ document.addEventListener("DOMContentLoaded", () => {
   let subscription = null;
   function setupSubscription() {
-    if (cable) cable.disconnect();
-    cable = ActionCable.createConsumer();
-    subscription = cable.subscriptions.create({ channel: "RailsTraceViewer::TraceChannel" }, {
-      connected() { console.log("✅ TraceViewer: Connected"); },
-      disconnected() { console.log("❌ TraceViewer: Disconnected"); },
-      received(data) {
-        if (!data || !data.node) return;
-        if ((data.node.name || "").includes("RailsTraceViewer")) return;
-        emptyState.classList.add("hidden");
-        addNodeToGraph(data.trace_id, data.node);
-        if (this.redrawTimer) clearTimeout(this.redrawTimer);
-        this.redrawTimer = setTimeout(redrawAllGraphs, 100);
-      }
-    });
+    try {
+      if (cable) cable.disconnect();
+    } catch (err) {
+      console.warn("Error disconnecting previous cable:", err);
+    }
+    try {
+      cable = ActionCable.createConsumer();
+      subscription = cable.subscriptions.create({ channel: "RailsTraceViewer::TraceChannel" }, {
+        connected() { console.log("✅ TraceViewer: Connected"); },
+        disconnected() { console.log("❌ TraceViewer: Disconnected"); },
+        received(data) {
+          try {
+            if (!data || !data.node) return;
+            if ((data.node.name || "").includes("RailsTraceViewer")) return;
+            emptyState.classList.add("hidden");
+            addNodeToGraph(data.trace_id, data.node);
+            if (this.redrawTimer) clearTimeout(this.redrawTimer);
+            this.redrawTimer = setTimeout(redrawAllGraphs, 100);
+          } catch (err) {
+            console.error("Error processing trace message:", err);
+          }
+        }
+      });
+    } catch (err) {
+      console.error("Failed to create ActionCable consumer. Is ActionCable mounted at /cable?", err);
+    }
   }
   setupSubscription();
@@ -195,6 +207,7 @@ document.addEventListener("DOMContentLoaded", () => {
     let changed = false;
     Object.keys(nodeBuffer).forEach(pid => {
       const list = nodeBuffer[pid];
+      if (!list) return;
       const kept = [];
       list.forEach(item => {
         if (now - item.receivedAt > 3000) {
@@ -234,7 +247,7 @@ document.addEventListener("DOMContentLoaded", () => {
   // --- Rendering ---
   function redrawAllGraphs() {
     g.selectAll("*").remove();
-    verticalOffset = 60;
+    let verticalOffset = 60;
     Object.keys(graphs).forEach(tid => {
       renderSingleDAG(graphs[tid], verticalOffset);
@@ -259,7 +272,7 @@ document.addEventListener("DOMContentLoaded", () => {
     Object.values(G.nodes).forEach(n => {
       let lbl = n.name || "Unknown";
-      if (lbl.length > 38) lbl = lbl.substring(0, 35) + "...";
+      if (lbl.length > 29) lbl = lbl.substring(0, 27) + "...";
       dag.setNode(n.id, { label: lbl, width: NODE_WIDTH, height: NODE_HEIGHT, type: n.type, fullData: n });
     });

data/lib/rails_trace_viewer/active_job_extension.rb ADDED Viewed

@@ -0,0 +1,45 @@
+module RailsTraceViewer
+  module ActiveJobExtension
+    extend ActiveSupport::Concern
+    included do
+      attr_accessor :rtv_trace_id, :rtv_parent_id
+      around_enqueue do |job, block|
+        if defined?(RailsTraceViewer) && RailsTraceViewer.enabled
+          if RailsTraceViewer::TraceContext.active?
+            job.rtv_trace_id  = RailsTraceViewer::TraceContext.trace_id
+            job.rtv_parent_id = RailsTraceViewer::TraceContext.parent_id
+          else
+            job.rtv_trace_id  ||= SecureRandom.uuid
+            job.rtv_parent_id ||= nil
+          end
+        end
+        block.call
+      end
+    end
+    def serialize
+      data = super
+      if defined?(RailsTraceViewer) && RailsTraceViewer.enabled
+        data["rtv_trace_id"]  = rtv_trace_id  if respond_to?(:rtv_trace_id)  && rtv_trace_id
+        data["rtv_parent_id"] = rtv_parent_id if respond_to?(:rtv_parent_id) && rtv_parent_id
+      end
+      data
+    end
+    def deserialize(job_data)
+      super(job_data)
+      if defined?(RailsTraceViewer) && RailsTraceViewer.enabled
+        self.rtv_trace_id  = job_data["rtv_trace_id"]  if job_data.key?("rtv_trace_id")  && respond_to?(:rtv_trace_id=)
+        self.rtv_parent_id = job_data["rtv_parent_id"] if job_data.key?("rtv_parent_id") && respond_to?(:rtv_parent_id=)
+      end
+      self
+    end
+  end
+end

data/lib/rails_trace_viewer/collector.rb CHANGED Viewed

@@ -129,23 +129,6 @@ module RailsTraceViewer
         after.each(&:call)
       end
-      def finalize_trace(trace_id)
-        trace = nil
-        @mutex.synchronize do
-          tree = TRACE_TREES[trace_id]
-          return unless tree
-          trace = tree[:root]
-          TRACE_TREES.delete(trace_id)
-        end
-        ActionCable.server.broadcast(
-          "rails_trace_viewer",
-          event: "trace_completed",
-          trace: trace
-        )
-      end
     end
   end
 end

data/lib/rails_trace_viewer/engine.rb CHANGED Viewed

@@ -2,48 +2,71 @@ module RailsTraceViewer
   class Engine < ::Rails::Engine
     isolate_namespace RailsTraceViewer
-    config.to_prepare do
-      if Rails.application.routes.routes.empty?
-        Rails.application.reload_routes!
+    initializer "rails_trace_viewer.active_job_extension" do
+      ActiveSupport.on_load(:active_job) do
+        include RailsTraceViewer::ActiveJobExtension
       end
+    end
-      is_mounted = Rails.application.routes.routes.any? do |route|
-        app = route.app
-        while app.respond_to?(:app) && app != app.app
-          app = app.app
+    class << self
+      def enable_tracing!
+        return if @tracing_initialized
+        if Rails.application.routes.routes.empty?
+          Rails.application.reload_routes!
         end
-        match_class = (app == RailsTraceViewer::Engine) || (app.to_s.include?("RailsTraceViewer::Engine"))
-        path_match = (route.path.spec.to_s rescue "").include?("/rails_trace_viewer")
+        is_mounted = Rails.application.routes.routes.any? do |route|
+          app = route.app
+          while app.respond_to?(:app) && app != app.app
+            app = app.app
+          end
-        match_class || path_match
-      end
+          match_class = (app == RailsTraceViewer::Engine) ||
+                        app.to_s.include?("RailsTraceViewer::Engine")
-      if is_mounted
-        RailsTraceViewer.enabled = true
-        unless @booted_message_shown
-          puts "✅ [RailsTraceViewer] Engine mounted. Tracing is ACTIVE."
-          @booted_message_shown = true
+          path_match = (route.path.spec.to_s rescue "")
+                         .include?("/rails_trace_viewer")
+          match_class || path_match
         end
-        RailsTraceViewer::Subscribers::ControllerSubscriber.attach
-        RailsTraceViewer::Subscribers::SqlSubscriber.attach
-        RailsTraceViewer::Subscribers::ViewSubscriber.attach
-        RailsTraceViewer::Subscribers::ActiveJobSubscriber.attach
-        RailsTraceViewer::Subscribers::SidekiqSubscriber.attach if defined?(Sidekiq)
-        RailsTraceViewer::Subscribers::MethodSubscriber.attach
-        RailsTraceViewer::Collector.start_sweeper!
-      else
-        RailsTraceViewer.enabled = false
-        unless @booted_message_shown
-          puts "🚫 [RailsTraceViewer] Engine route not found. Tracing DISABLED (Zero Overhead)."
-          @booted_message_shown = true
+        if is_mounted
+          RailsTraceViewer.enabled = true
+          unless @booted_message_shown
+            puts "✅ [RailsTraceViewer] Engine mounted. Tracing is ACTIVE."
+            @booted_message_shown = true
+          end
+          RailsTraceViewer::Subscribers::ControllerSubscriber.attach
+          RailsTraceViewer::Subscribers::SqlSubscriber.attach
+          RailsTraceViewer::Subscribers::ViewSubscriber.attach
+          RailsTraceViewer::Subscribers::ActiveJobSubscriber.attach
+          RailsTraceViewer::Subscribers::SidekiqSubscriber.attach if defined?(Sidekiq)
+          RailsTraceViewer::Subscribers::MethodSubscriber.attach
+          RailsTraceViewer::Collector.start_sweeper!
+        else
+          RailsTraceViewer.enabled = false
+          unless @booted_message_shown
+            puts "🚫 [RailsTraceViewer] Engine route not found. Tracing DISABLED (Zero Overhead)."
+            @booted_message_shown = true
+          end
         end
+        @tracing_initialized = true
       end
     end
+    config.to_prepare do
+      RailsTraceViewer::Engine.enable_tracing!
+    end
+    console do
+      RailsTraceViewer::Engine.enable_tracing!
+    end
   end
 end

data/lib/rails_trace_viewer/subscribers/active_job_subscriber.rb CHANGED Viewed

@@ -9,19 +9,15 @@ module RailsTraceViewer
         ActiveSupport::Notifications.subscribe("enqueue.active_job") do |*_args, payload|
           job = payload[:job]
-          next if job.class.include?(Sidekiq::Worker)
+          next if job.class.include?(Sidekiq::Worker) rescue false
-          if RailsTraceViewer::TraceContext.active?
-            trace_id  = RailsTraceViewer::TraceContext.trace_id
-            parent_id = RailsTraceViewer::TraceContext.parent_id
-          else
-            trace_id  = SecureRandom.uuid
-            parent_id = nil
-            RailsTraceViewer::TraceContext.start!(trace_id)
-            RailsTraceViewer::Collector.start_trace(trace_id)
-          end
+          trace_id  = job.respond_to?(:rtv_trace_id)  ? job.rtv_trace_id  : nil
+          parent_id = job.respond_to?(:rtv_parent_id) ? job.rtv_parent_id : nil
-          enqueue_node_id = SecureRandom.uuid
+          trace_id  ||= SecureRandom.uuid
+          parent_id ||= nil
+          enqueue_node_id = "rtv-enqueue-#{job.job_id}"
           node = {
             id: enqueue_node_id,
@@ -37,34 +33,35 @@ module RailsTraceViewer
             children: []
           }
-          RailsTraceViewer::JobLinkRegistry.register(job, trace_id: trace_id, enqueue_node_id: enqueue_node_id)
           RailsTraceViewer::Collector.add_node(trace_id, node)
         end
         ActiveSupport::Notifications.subscribe("perform_start.active_job") do |*_args, payload|
           job = payload[:job]
-          RailsTraceViewer::JobLinkRegistry.on_perform(job) do |trace_id, enqueue_node_id|
-            RailsTraceViewer::TraceContext.start_job!(trace_id)
-            RailsTraceViewer::Collector.start_trace(trace_id)
+          trace_id        = job.respond_to?(:rtv_trace_id) ? job.rtv_trace_id : nil
+          trace_id      ||= SecureRandom.uuid
+          enqueue_node_id = "rtv-enqueue-#{job.job_id}"
+          RailsTraceViewer::TraceContext.start_job!(trace_id)
+          RailsTraceViewer::Collector.start_trace(trace_id)
-            node_id = SecureRandom.uuid
-            node = {
-              id: node_id,
-              parent_id: enqueue_node_id,
-              type: "job_perform",
-              name: job.class.name,
-              source: "ActiveJob Perform",
-              job_id: job.job_id,
-              arguments: safe_serialize.call(job.arguments),
-              executions: job.executions,
-              children: []
-            }
+          node_id = SecureRandom.uuid
+          node = {
+            id: node_id,
+            parent_id: enqueue_node_id,
+            type: "job_perform",
+            name: job.class.name,
+            source: "ActiveJob Perform",
+            job_id: job.job_id,
+            arguments: safe_serialize.call(job.arguments),
+            executions: job.executions,
+            children: []
+          }
-            RailsTraceViewer::Collector.add_node(trace_id, node)
-            RailsTraceViewer::TraceContext.push(node_id)
-            RailsTraceViewer::JobLinkRegistry.delete(job)
-          end
+          RailsTraceViewer::Collector.add_node(trace_id, node)
+          RailsTraceViewer::TraceContext.push(node_id)
         end
       end
     end

data/lib/rails_trace_viewer/subscribers/method_subscriber.rb CHANGED Viewed

@@ -40,6 +40,27 @@ module RailsTraceViewer
             is_singleton = tp.defined_class.singleton_class? rescue false
             method_sig = "#{class_name}#{is_singleton ? '.' : '#'}#{tp.method_id}"
+            arguments = {}
+            if tp.binding
+              tp.parameters.each do |type, name|
+                begin
+                  val = tp.binding.local_variable_get(name)
+                  if val.is_a?(String)
+                    arguments[name] = val.length > 1000 ? val[0..1000] + "... (truncated)" : val
+                  elsif val.is_a?(Numeric) || val == true || val == false || val.nil?
+                    arguments[name] = val
+                  elsif defined?(ActiveRecord::Base) && val.is_a?(ActiveRecord::Base)
+                    arguments[name] = val.attributes
+                  else
+                    inspected = val.inspect
+                    arguments[name] = inspected.length > 1000 ? inspected[0..1000] + "... (truncated)" : inspected
+                  end
+                rescue => e
+                  arguments[name] = "Error"
+                end
+              end
+            end
             node = {
               id: node_id,
               parent_id: parent_id,
@@ -50,6 +71,7 @@ module RailsTraceViewer
               line_number: tp.lineno,
               class_name: class_name,
               method_name: tp.method_id,
+              arguments: arguments,
               children: []
             }
             RailsTraceViewer::Collector.add_node(trace_id, node)

data/lib/rails_trace_viewer/subscribers/sidekiq_subscriber.rb CHANGED Viewed

@@ -24,18 +24,13 @@ module RailsTraceViewer
       class ClientMiddleware
         def call(worker_class, job, queue, redis_pool)
-          trace_id = nil
-          parent_id = nil
-          started_new_trace = false
           if RailsTraceViewer::TraceContext.active?
             trace_id  = RailsTraceViewer::TraceContext.trace_id
             parent_id = RailsTraceViewer::TraceContext.parent_id
           else
             trace_id = SecureRandom.uuid
-            RailsTraceViewer::TraceContext.start!(trace_id)
-            RailsTraceViewer::Collector.start_trace(trace_id)
-            started_new_trace = true
+            parent_id = nil
           end
           enqueue_node_id = SecureRandom.uuid
@@ -60,17 +55,13 @@ module RailsTraceViewer
           RailsTraceViewer::Collector.add_node(trace_id, node)
           yield
-        ensure
-          if started_new_trace
-            RailsTraceViewer::TraceContext.stop!
-          end
         end
       end
       class ServerMiddleware
         def call(worker, job, queue)
           trace_id = job["_trace_id"]
-          parent_id = job["_enqueue_node_id"] || job["_parent_id"]
+          parent_id = job["_enqueue_node_id"]
           perform_node_id = nil
           if trace_id

data/lib/rails_trace_viewer/subscribers/sql_subscriber.rb CHANGED Viewed

@@ -1,31 +1,35 @@
 module RailsTraceViewer
   module Subscribers
     class SqlSubscriber
+      IGNORED_SQL_PATTERNS = /\A(?:BEGIN|COMMIT|ROLLBACK|SAVEPOINT|RELEASE SAVEPOINT)\b/i
+      IGNORED_PAYLOAD_NAMES = ["SCHEMA"].to_set
       def self.attach
         return if @attached
         @attached = true
         ActiveSupport::Notifications.subscribe("sql.active_record") do |*_args, payload|
           next unless RailsTraceViewer::TraceContext.active?
-          next if payload[:name] == "SCHEMA"
+          next if IGNORED_PAYLOAD_NAMES.include?(payload[:name])
+          sql = (payload[:sql] || "").to_s
+          next if sql.match?(IGNORED_SQL_PATTERNS)
           source = extract_app_source(caller)
           next unless source
           raw_binds = payload[:type_casted_binds]
-          if raw_binds.respond_to?(:call)
-            raw_binds = raw_binds.call
-          end
+          raw_binds = raw_binds.call if raw_binds.respond_to?(:call)
           binds = (raw_binds || []).map { |val| val.to_s }
           node = {
             id: SecureRandom.uuid,
             parent_id: RailsTraceViewer::TraceContext.parent_id,
             type: "sql",
-            name: payload[:sql],
+            name: sql,
             source: source,
-            full_sql: payload[:sql],
+            full_sql: sql,
             bind_values: binds,
             connection_id: payload[:connection_id],
             children: []
@@ -36,7 +40,14 @@ module RailsTraceViewer
       end
       def self.extract_app_source(bt)
-        bt.find { |line| line.include?("/app/") }
+        app_root = Rails.root.to_s
+        bt.find { |line|
+          path = line.to_s
+          next false unless path.start_with?(app_root)
+          next false if path.include?("/vendor/") || path.include?("/node_modules/")
+          next false if path.include?("/rails_trace_viewer/")
+          true
+        }
       end
     end
   end

data/lib/rails_trace_viewer/version.rb CHANGED Viewed

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

data/lib/rails_trace_viewer.rb CHANGED Viewed

@@ -4,10 +4,10 @@ require "active_support"
 require "active_support/notifications"
 require "rails_trace_viewer/engine"
+require "rails_trace_viewer/active_job_extension"
 require "rails_trace_viewer/collector"
 require "rails_trace_viewer/trace_context"
 require "rails_trace_viewer/broadcaster"
-require "rails_trace_viewer/job_link_registry"
 require "rails_trace_viewer/route_resolver"
 require "rails_trace_viewer/subscribers/controller_subscriber"

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_trace_viewer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Aditya-JOSH
@@ -80,10 +80,10 @@ files:
 - app/views/rails_trace_viewer/traces/show.html.erb
 - config/routes.rb
 - lib/rails_trace_viewer.rb
+- lib/rails_trace_viewer/active_job_extension.rb
 - lib/rails_trace_viewer/broadcaster.rb
 - lib/rails_trace_viewer/collector.rb
 - lib/rails_trace_viewer/engine.rb
-- lib/rails_trace_viewer/job_link_registry.rb
 - lib/rails_trace_viewer/route_resolver.rb
 - lib/rails_trace_viewer/subscribers/active_job_subscriber.rb
 - lib/rails_trace_viewer/subscribers/controller_subscriber.rb

data/lib/rails_trace_viewer/job_link_registry.rb DELETED Viewed

@@ -1,42 +0,0 @@
-require "concurrent/map"
-module RailsTraceViewer
-  class JobLinkRegistry
-    @store   = Concurrent::Map.new
-    @pending = Concurrent::Map.new
-    class << self
-      def register(job, trace_id:, enqueue_node_id:)
-        job_id = job.job_id
-        @store[job_id] = {
-          trace_id: trace_id,
-          enqueue_node_id: enqueue_node_id
-        }
-        if @pending[job_id]
-          @pending[job_id].each do |callback|
-            callback.call(trace_id, enqueue_node_id)
-          end
-          @pending.delete(job_id)
-        end
-      end
-      def on_perform(job, &block)
-        job_id = job.job_id
-        if @store[job_id]
-          data = @store[job_id]
-          block.call(data[:trace_id], data[:enqueue_node_id])
-        else
-          @pending[job_id] ||= []
-          @pending[job_id] << block
-        end
-      end
-      def delete(job)
-        @store.delete(job.job_id)
-      end
-    end
-  end
-end