callstacking-rails 0.1.2 → 0.1.3

data/lib/callstacking/rails/trace.rb

@@ -0,0 +1,126 @@
+require "rails"
+require "active_support/concern"
+require "callstacking/rails/client/base"
+require "callstacking/rails/client/authenticate"
+require "callstacking/rails/client/trace"
+require "callstacking/rails/settings"
+
+module Callstacking
+  module Rails
+    class Trace
+      include Callstacking::Rails::Settings
+
+      attr_accessor :spans, :client, :lock
+      cattr_accessor :current_request_id
+
+      def initialize(spans)
+        @traces = []
+        @spans  = spans
+
+        @lock   = Mutex.new
+        @client = Callstacking::Rails::Client::Trace.new
+      end
+
+      def tracing
+        read_settings
+
+        trace_id = nil
+
+        ActiveSupport::Notifications.subscribe("start_processing.action_controller") do |name, start, finish, id, payload|
+          request_id = payload[:request].request_id
+          Callstacking::Rails::Trace.current_request_id = request_id
+
+          trace_id, _interval = client.create(payload[:method], payload[:controller],
+                                              payload[:action], payload[:format],
+                                              ::Rails.root, payload[:request].original_url,
+                                              request_id, payload[:headers],
+                                              payload[:params])
+
+          puts "#{settings[:url] || Callstacking::Rails::Settings::PRODUCTION_URL}/traces/#{trace_id}"
+          
+          create_message(start_request_message(payload), spans.increment_order_num, @traces)
+        end
+
+        @spans.on_call_entry do |nesting_level, order_num, klass, method_name, arguments, path, line_no|
+          create_call_entry(nesting_level, order_num, klass, method_name, arguments, path, line_no, @traces)
+        end
+
+        @spans.on_call_return do |coupled_callee, nesting_level, order_num, klass, method_name, path, line_no, return_val|
+          create_call_return(coupled_callee, nesting_level, order_num, klass, method_name, path, line_no, return_val, @traces)
+        end
+
+        ActiveSupport::Notifications.subscribe("process_action.action_controller") do |name, start, finish, id, payload|
+          create_message(completed_request_message(payload), spans.increment_order_num, @traces)
+          send_traces!(trace_id, @traces)
+        end
+      end
+
+      private
+
+      def completed_request_message(payload)
+        "Completed request: #{payload[:method]} #{payload[:controller]}##{payload[:action]} as #{payload[:format]}"
+      end
+
+      def start_request_message(payload)
+        "Started request: #{payload[:method]} #{payload[:controller]}##{payload[:action]} as #{payload[:format]}"
+      end
+
+      def create_call_return(coupled_callee, nesting_level, order_num, klass, method_name, path, line_no, return_val, traces)
+        lock.synchronize do
+          traces << { trace_entry: { trace_entryable_type: 'TraceCallReturn',
+                                     order_num: order_num,
+                                     nesting_level: nesting_level,
+                                     trace_entryable_attributes: {
+                                       local_variables: {},
+                                       klass: klass_name(klass),
+                                       line_number: line_no,
+                                       path: path,
+                                       method_name: method_name,
+                                       return_value: return_val.inspect,
+                                       coupled_callee: coupled_callee,
+                                     } } }
+        end
+      end
+
+      def create_call_entry(nesting_level, order_num, klass, method_name, arguments, path, line_no, traces)
+        lock.synchronize do
+          traces << { trace_entry: { trace_entryable_type: 'TraceCallEntry',
+                                     order_num: order_num,
+                                     nesting_level: nesting_level,
+                                     trace_entryable_attributes: {
+                                       args: arguments,
+                                       klass: klass_name(klass),
+                                       line_number: line_no,
+                                       path: path,
+                                       method_name: method_name,
+                                     } } }
+        end
+      end
+
+      def create_message(message, order_num, traces)
+        lock.synchronize do
+          traces << { trace_entry: { trace_entryable_type: 'TraceMessage',
+                                     order_num: order_num,
+                                     nesting_level: 0,
+                                     trace_entryable_attributes: {
+                                       message: message
+                                     } } }
+        end
+      end
+
+      def send_traces!(trace_id, traces)
+        lock.synchronize do
+          return if traces.empty?
+
+          client.upsert(trace_id, { traces: traces })
+          traces.clear
+        end
+      end
+
+      private
+      def klass_name(klass)
+        (klass.is_a?(Class) ? klass.name : klass.class.name)
+      end
+    end
+  end
+end

data/lib/{checkpoint → callstacking}/rails/traces_helper.rb

@@ -1,25 +1,26 @@
-require "action_view/helpers/tag_helper.rb"
+require "action_view/helpers/tag_helper"
 require "action_view/context.rb"
 
-module Checkpoint
+module Callstacking
   module Rails
     module TracesHelper
       include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::JavaScriptHelper
       include ActionView::Context
-      include Checkpoint::Rails::Settings
+      include Callstacking::Rails::Settings
 
       def hud
         read_settings
 
-        frame_url = "#{url || Checkpoint::Rails::Settings::PRODUCTION_URL}/traces/#{Checkpoint::Rails::Traceable.current_request_id}/print"
+        frame_url = "#{url || Callstacking::Rails::Settings::PRODUCTION_URL}/traces/#{Callstacking::Rails::Trace.current_request_id}/print"
 
         body = []
         body << (content_tag( :div, data: { turbo:false },
-                    style: 'background-color: #FFF; color: #0000FF; font-size: 20pt; top: 50%; right: 20px;
-                            padding: 30px 10px 0px 10px; position: fixed; height: 100px; width: 40px; cursor: pointer;',
+                    style: 'top: 50%; right: 10px; font-size: 24pt; :hover{text-shadow: 1px 1px 2px #000000};
+                            padding: 0px; position: fixed; height: 50px; width: 40px; cursor: pointer;',
                     onclick: 'document.getElementById("callstacking-debugger").style.display = "unset";
                               document.getElementById("callstacking-close").style.display = "unset";') do
-          "⇐"
+          "💥"
         end)
         
         body << (content_tag(:iframe, src: frame_url, id: 'callstacking-debugger', data: { turbo:false },
@@ -27,6 +28,18 @@ module Checkpoint
                             z-index: 99; opacity: 1.0; background-color: #FFF; color: #000; border: 1px solid;
                             margin: 0; padding: 0; box-shadow: 5px 5px; display: none;") do
         end)
+
+        body << (javascript_tag('
+          document.onkeyup = function(e) {
+            // Mac - option-d   Win - alt-d
+            if (e.altKey && e.which == 68) {
+              if (document.getElementById("callstacking-debugger").style.display === "none") {
+                document.getElementById("callstacking-debugger").style.display = "block";
+              } else {
+                document.getElementById("callstacking-debugger").style.display = "none";
+              }
+            }
+          };'))
         
         body.join
       end

data/lib/callstacking/rails/version.rb

@@ -0,0 +1,5 @@
+module Callstacking
+  module Rails
+    VERSION = "0.1.3"
+  end
+end

data/lib/callstacking/rails.rb

@@ -0,0 +1,7 @@
+require "callstacking/rails/version"
+require "callstacking/rails/engine"
+
+module Callstacking
+  module Rails
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callstacking-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jim Jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2023-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,54 +52,45 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  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: Rolling debugger that shows the full state of each call.
+description: Quickly visualize which methods call which, their parameters, and return
+  values.
 email:
 - jim.jones1@gmail.com
-executables: []
+executables:
+- callstacking-rails
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- LICENSE
 - README.md
 - Rakefile
-- app/assets/config/checkpoint_rails_manifest.js
-- app/assets/stylesheets/checkpoint/rails/application.css
-- app/controllers/checkpoint/rails/application_controller.rb
-- app/controllers/checkpoint/rails/traces_controller.rb
-- app/helpers/checkpoint/rails/application_helper.rb
-- app/jobs/checkpoint/rails/application_job.rb
-- app/mailers/checkpoint/rails/application_mailer.rb
-- app/models/checkpoint/rails/application_record.rb
+- app/assets/config/callstacking_rails_manifest.js
+- app/assets/stylesheets/callstacking/rails/application.css
+- app/controllers/callstacking/rails/application_controller.rb
+- app/helpers/callstacking/rails/application_helper.rb
+- app/jobs/callstacking/rails/application_job.rb
+- app/mailers/callstacking/rails/application_mailer.rb
+- app/models/callstacking/rails/application_record.rb
 - config/routes.rb
-- lib/checkpoint/rails.rb
-- lib/checkpoint/rails/client/authenticate.rb
-- lib/checkpoint/rails/client/base.rb
-- lib/checkpoint/rails/client/trace.rb
-- lib/checkpoint/rails/engine.rb
-- lib/checkpoint/rails/env.rb
-- lib/checkpoint/rails/settings.rb
-- lib/checkpoint/rails/setup.rb
-- lib/checkpoint/rails/traceable.rb
-- lib/checkpoint/rails/traces_helper.rb
-- lib/checkpoint/rails/version.rb
+- exe/callstacking-rails
+- lib/callstacking/rails.rb
+- lib/callstacking/rails/client/authenticate.rb
+- lib/callstacking/rails/client/base.rb
+- lib/callstacking/rails/client/trace.rb
+- lib/callstacking/rails/engine.rb
+- lib/callstacking/rails/env.rb
+- lib/callstacking/rails/instrument.rb
+- lib/callstacking/rails/loader.rb
+- lib/callstacking/rails/settings.rb
+- lib/callstacking/rails/setup.rb
+- lib/callstacking/rails/spans.rb
+- lib/callstacking/rails/trace.rb
+- lib/callstacking/rails/traces_helper.rb
+- lib/callstacking/rails/version.rb
 - lib/tasks/checkpoint/rails_tasks.rake
 homepage: https://github.com/callstacking/callstacking-rails
 licenses:
-- MIT
+- GPL-3.0-or-later
 metadata:
   homepage_uri: https://github.com/callstacking/callstacking-rails
   source_code_uri: https://github.com/callstacking/callstacking-rails
@@ -121,5 +112,6 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Rolling debugger that shows the full state of each call per request.
+summary: Quickly visualize which methods call which, their parameters, and return
+  values.
 test_files: []

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2022 Jim Jones
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/app/assets/config/checkpoint_rails_manifest.js

@@ -1 +0,0 @@
-//= link_directory ../stylesheets/checkpoint/rails .css

data/app/controllers/checkpoint/rails/traces_controller.rb

@@ -1,6 +0,0 @@
-module Checkpoint::Rails
-  class TracesController < ApplicationController
-    def index
-    end
-  end
-end

data/lib/checkpoint/rails/engine.rb

@@ -1,34 +0,0 @@
-require "checkpoint/rails/traceable"
-require "checkpoint/rails/setup"
-require "checkpoint/rails/settings"
-require "checkpoint/rails/client/base"
-require "checkpoint/rails/client/authenticate"
-require "checkpoint/rails/client/trace"
-require "checkpoint/rails/traces_helper"
-
-module Checkpoint
-  module Rails
-    class Engine < ::Rails::Engine
-      isolate_namespace Checkpoint::Rails
-
-      include ::Checkpoint::Rails::Traceable
-
-      initializer "engine_name.assets.precompile" do |app|
-        app.config.assets.precompile << "checkpoint_rails_manifest.js"
-      end
-
-      initializer 'local_helper.action_controller' do
-        ActiveSupport.on_load :action_controller do
-          helper Checkpoint::Rails::TracesHelper
-          include Checkpoint::Rails::TracesHelper
-        end
-      end
-
-      initializer :append_before_action do
-        ActionController::Base.send :after_action, :inject_hud
-      end
-
-      set_trace
-    end
-  end
-end

data/lib/checkpoint/rails/setup.rb

@@ -1,93 +0,0 @@
-require 'yaml'
-require "checkpoint/rails/settings"
-
-module Checkpoint
-  module Rails
-    class Setup
-      include ::Checkpoint::Rails::Settings
-      extend ::Checkpoint::Rails::Settings
-
-      attr_accessor :client
-
-      def initialize
-        read_settings
-      end
-
-      def client
-        @client = Checkpoint::Rails::Client::Authenticate.new
-      end
-
-      def start
-        email      = prompt("Enter email:")
-        password   = prompt("Enter password:")
-
-        url = if Rails::Checkpoint::Env.production? && ENV['CHECKPOINT_RAILS_LOCAL_TEST'].nil?
-                PRODUCTION_URL
-              else
-                prompt("Enter URL for #{Checkpoint::Rails::Env.environment} API calls [#{PRODUCTION_URL}]:") || PRODUCTION_URL
-              end
-
-        save(email, password, url)
-
-        puts "Authentication successful."
-        puts "Settings saved to #{SETTINGS_FILE}"
-      rescue StandardError => e
-        puts "Problem authenticating: #{e.message}"
-      end
-
-      def prompt(label)
-        puts label
-        value = STDIN.gets.chomp
-        puts
-
-        return nil if value == ''
-        value
-      end
-
-      def token(email, password)
-        client.login(email, password)
-      end
-
-      def save(email, password, url)
-        props = { auth_token: '',
-                  url: url,
-        }
-
-        props = { Checkpoint::Rails::Env.environment => {
-          settings: props
-        } }
-
-        write_settings(complete_settings.merge(props))
-
-        props[Checkpoint::Rails::Env.environment][:settings][:auth_token] = token(email, password)
-
-        write_settings(complete_settings.merge(props))
-
-        read_settings
-      end
-
-      def self.instructions
-        read_settings
-        puts "loading environment #{Checkpoint::Rails::Env.environment}"
-        puts
-        puts "Usage: "
-        puts
-        puts "  callstacking-rails register"
-        puts "    Opens a browser window to register as a Callstacking user."
-        puts
-        puts "  callstacking-rails setup"
-        puts "    Interactively prompts you for your Callstacking username/password, "
-        puts "    Stores auth details in #{SETTINGS_FILE} "
-        puts
-        puts " You can have multiple environments."
-        puts "    Default is #{Rails::Checkpoint::Env::DEFAULT_ENVIRONMENT}."
-        puts
-        puts " The #{Checkpoint::Rails::Env.environment}: section in the #{SETTINGS_FILE} contains your credentials."
-        puts " By setting the RAILS_ENV environment you can maintain"
-        puts " multiple settings."
-        puts
-        puts "Questions? Create an issue: https://github.com/callstacking/callstacking-rails/issues"
-      end
-    end
-  end
-end

data/lib/checkpoint/rails/traceable.rb

@@ -1,210 +0,0 @@
-require "active_support/concern"
-require "checkpoint/rails/client/base"
-require "checkpoint/rails/client/authenticate"
-require "checkpoint/rails/client/trace"
-require "checkpoint/rails/settings"
-
-module Checkpoint
-  module Rails
-    module Traceable
-      extend ActiveSupport::Concern
-      include Checkpoint::Rails::Settings
-
-      TARGET_DIV = 'traces'
-
-      mattr_accessor :current_request_id
-
-      def set_trace
-        read_settings
-        
-        client = Checkpoint::Rails::Client::Trace.new
-
-        trace_points = {}
-        params       = {}
-        prev_event   = ''
-        order_num    = 0
-        trace_id     = nil
-        traces       = []
-        lock         = Mutex.new
-        task         = nil
-
-        ActiveSupport::Notifications.subscribe("start_processing.action_controller") do |name, start, finish, id, payload|
-          next if payload[:controller] == 'Checkpoint::Rails::TracesController'
-
-          key = request_key(payload)
-          params[key] = payload[:params]
-
-          nesting_level = -1
-
-          request_id = payload[:request].request_id
-          Checkpoint::Rails::Traceable.current_request_id = request_id
-
-          trace_id, _interval = client.create(payload[:method],  payload[:controller],
-                                              payload[:action],  payload[:format],
-                                              ::Rails.root,      payload[:request].original_url,
-                                              request_id, 
-                                              payload[:headers], params[key])
-
-
-          puts "#{settings[:url] || Checkpoint::Rails::Settings::PRODUCTION_URL}/traces/#{trace_id}"
-
-          task = Concurrent::TimerTask.new(execution_interval: 1, timeout_interval: 60) {
-            send_traces!(trace_id, traces, lock, client)
-          }
-
-          task.execute
-
-          create_message(start_request_message(payload), order_num, traces, lock)
-
-          trace_points[key]&.disable
-          trace_point = TracePoint.new(:call, :return) do |t|
-            trace = caller[0]
-
-            next unless trace.match?(Dir.pwd)
-
-            order_num += 1
-
-            if t.event == :call
-              nesting_level += 1
-
-              prev_event = previous_event(t)
-
-              create_call_entry(nesting_level, order_num, t, traces, lock)
-            elsif t.event == :return
-              coupled_callee = false
-              coupled_callee = true if prev_event == previous_event(t)
-
-              prev_event = previous_event(t)
-              return_value = t.return_value.inspect
-
-              create_call_return(coupled_callee, nesting_level, order_num, return_value, t, traces, lock)
-
-              nesting_level -= 1
-            end
-          end
-
-          trace_point.enable
-          trace_points[key] = trace_point
-        end
-
-        ActiveSupport::Notifications.subscribe("process_action.action_controller") do |name, start, finish, id, payload|
-          trace_points[request_key(payload)]&.disable
-          task&.shutdown
-
-          create_message(completed_request_message(payload), order_num, traces, lock)
-          send_traces!(trace_id, traces, lock, client)
-        end
-      end
-
-      private
-
-      def completed_request_message(payload)
-        "Completed request: #{payload[:method]} #{payload[:controller]}##{payload[:action]} as #{payload[:format]}"
-      end
-
-      def start_request_message(payload)
-        puts "start request message - "
-        "Request: #{payload[:method]} #{payload[:controller]}##{payload[:action]} as #{payload[:format]}"
-      end
-
-      def create_call_return(coupled_callee, nesting_level, order_num, return_value, t, traces, lock)
-        lock.synchronize do
-          traces << { trace_entry: { trace_entryable_type: 'TraceCallReturn',
-                                     order_num: order_num,
-                                     nesting_level: nesting_level,
-                                     trace_entryable_attributes: {
-                                       local_variables: locals_for(t),
-                                       klass: t.binding.receiver.class.name.to_s,
-                                       line_number: t.lineno,
-                                       path: t.path,
-                                       method_name: t.method_id,
-                                       return_value: return_value,
-                                       coupled_callee: coupled_callee,
-                                     } } }
-        end
-      end
-
-      def create_call_entry(nesting_level, order_num, t, traces, lock)
-        lock.synchronize do
-          traces << { trace_entry: { trace_entryable_type: 'TraceCallEntry',
-                                     order_num: order_num,
-                                     nesting_level: nesting_level,
-                                     trace_entryable_attributes: {
-                                       args: arguments_for(t),
-                                       klass: t.binding.receiver.class.name.to_s,
-                                       line_number: t.lineno,
-                                       path: t.path,
-                                       method_name: t.method_id,
-                                     } } }
-        end
-      end
-
-      def create_message(message, order_num, traces, lock)
-        lock.synchronize do
-          traces << { trace_entry: { trace_entryable_type: 'TraceMessage',
-                                     order_num: order_num,
-                                     nesting_level: 0,
-                                     trace_entryable_attributes: {
-                                       message: message
-                                     } } }
-        end
-      end
-
-      def send_traces!(trace_id, traces, lock, client)
-        lock.synchronize do
-          return if traces.empty?
-          
-          client.upsert(trace_id, { traces: traces })
-          traces.clear
-        end
-      end
-
-      def caller_key(t)
-        "#{t.binding.receiver.class.name.to_s}##{t.method_id}"
-      end
-
-      def request_key(payload)
-        "#{payload[:controller]}##{payload[:action]}"
-      end
-
-      def previous_event(t)
-        "#{t.binding.receiver.class.name.to_s}:#{t.method_id}"
-      end
-
-      def view_rendered?(t)
-        t.path.to_s =~ /view/
-      end
-
-      def partial_rendered?(t)
-        view_rendered?(t) && Pathname.new(t.path).basename.to_s =~ /^_/
-      end
-
-      def layout_rendered?(t)
-        view_rendered?(t) && t.path =~ /layouts/
-      end
-
-      def template_rendered?(t)
-        view_rendered?(t) && !partial_rendered?(t) && !layout_rendered?(t)
-      end
-
-      def arguments_for(trace)
-        param_names = trace&.parameters&.map(&:last)
-        return {} if param_names.nil?
-
-        param_names.map do |param|
-          next if [:&, :*, :**].include?(param)
-          [param, trace.binding.local_variable_get(param.to_s)]
-        end.compact.to_h
-      end
-
-      def locals_for(trace)
-        local_names = trace&.binding&.local_variables
-        return {} if local_names.nil?
-
-        local_names.map do |local|
-          [local, trace.binding.local_variable_get(local)]
-        end.to_h
-      end
-    end
-  end
-end

data/lib/checkpoint/rails/version.rb

@@ -1,5 +0,0 @@
-module Checkpoint
-  module Rails
-    VERSION = "0.1.2"
-  end
-end