callstacking-rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88265ec5da1ad5e4b040bffdb034f0abb9ff11ba7485839b1c565c774dd612ab
-  data.tar.gz: a21ca44694d8b92e2ecba34523adc33ba1bb72c0e0d1cfdb364ba268fa1107e0
+  metadata.gz: f4bc78186fe09232889a12dea985d128878de745f00a7f6761fd2d6bdc1bc6e0
+  data.tar.gz: 113fe92740e5260af527603445de8c0ec5ce49262a332dff1620382bb584dfa3
 SHA512:
-  metadata.gz: 99dcba1223722f85f50fb89200c408d81720028b3f7e6b9291d4a73dae5e1449a9c2152ff6baf07f890be0d718b0df1038f3c5d4b2011cce101cb56742ace0ee
-  data.tar.gz: a545aec1de30363f71eeb4831424d65f2841292c894a50ba7d1859f820306307e2f66ec4f5a5ccade2bda14b439f1a24b40df3d57de9ede4aaa34a75bc243f5d
+  metadata.gz: db7b809625176d70d726b202d11d26d55c73809281af0e569431f9c884ad81ce7868e29fa685a0527a48ffc0ba8fd52cf4e35b4ae0e83bd6cf64684663bc5e31
+  data.tar.gz: 74cf19f86b7ad4da4c67eb1a83af54f51e843d324e067b6d05cf81eede3a1bc14a05903e252ed73359c01d0cf58a35e98940e13688fa2423abd61616ca302c6a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+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/README.md

@@ -1,4 +1,4 @@
-# Callstacking::Rails
+# Checkpoint::Rails
 
 Callstacking is a rolling, checkpoint debugger for Rails.  It records all of the critical method calls within your app, along with their important context (param/argument/return/local variable values).  
 
@@ -17,13 +17,13 @@ For method returns ↳, the final values of the local variables will be listed w
 
 Subsequent calls within a method are visibly nested.
 
-Callstacking is a Rails engine that you mount within your Rails app.
+Checkpoint is a Rails engine that you mount within your Rails app.
 
 Here's a sample debugging sessions recorded from a Jumpstart Rails based app I've been working on.  This is a request for the main page ( https://smartk.id/ ).
 
 ![image](https://user-images.githubusercontent.com/4600/190882432-58092e38-7ee2-4138-b13a-f45ff2b09227.png)
 
-Callstacking Rails records all of the critical method calls within your app, along with their important context (param/argument/return/local variable values).
+Checkpoint Rails records all of the critical method calls within your app, along with their important context (param/argument/return/local variable values).
 
 All in a rolling panel, so that you can debug your call chains from any point in the stack.
 
@@ -42,54 +42,11 @@ And then execute:
 ```bash
 $ bundle
 ```
-   
-Register an account at Callstacking.com
-```bash
-callstacking-rails register
-```
-
-Authenticate to your newly created account.
-
-```bash
-callstacking-rails setup
-```
-            
-You're now ready to start tracing.
 
 ## Usage
-Usage:
-
-> callstacking-rails enable
-
-Enables the callstacking tracing.
-
-> callstacking-rails disable
-
-Disables the callstacking tracing.
-
-> callstacking-rails register
-
-Opens a browser window to register as a callstacking.com user.
-
-> callstacking-rails setup
-
-Interactively prompts you for your callstacking.com username/password.
-Stores auth details in `~/.callstacking`.
-
-You can have multiple environments.
-The default is `development`.
-
-The `development:` section in the `~/.callstacking` config contains your credentials.
-
-By setting the RAILS_ENV environment you can maintain multiple settings.
-
-Questions? Create an issue: https://github.com/callstacking/callstacking-rails/issues
-
-
-## Trace Output
-When you open a page for your app, once the page has rendered, you will see an `<<` arrow on the right hand side.
+When you open a page for your app, once the page has rendered, you will see an arrow on the right hand side.
 
-Click the arrows, and observe the full callstack context.
+Click the arrow, and observe the full callstack context.
 
 ## License
-The gem is available as open source under the terms of the [GPLv3 License](https://www.gnu.org/licenses/gpl-3.0.en.html).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/config/checkpoint_rails_manifest.js

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

data/app/controllers/{callstacking → checkpoint}/rails/application_controller.rb

@@ -1,4 +1,4 @@
-module Callstacking
+module Checkpoint
   module Rails
     class ApplicationController < ActionController::Base
     end

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

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

data/app/helpers/{callstacking → checkpoint}/rails/application_helper.rb

@@ -1,4 +1,4 @@
-module Callstacking
+module Checkpoint
   module Rails
     module ApplicationHelper
     end

data/app/jobs/{callstacking → checkpoint}/rails/application_job.rb

@@ -1,4 +1,4 @@
-module Callstacking
+module Checkpoint
   module Rails
     class ApplicationJob < ActiveJob::Base
     end

data/app/mailers/{callstacking → checkpoint}/rails/application_mailer.rb

@@ -1,4 +1,4 @@
-module Callstacking
+module Checkpoint
   module Rails
     class ApplicationMailer < ActionMailer::Base
       default from: "from@example.com"

data/app/models/{callstacking → checkpoint}/rails/application_record.rb

@@ -1,4 +1,4 @@
-module Callstacking
+module Checkpoint
   module Rails
     class ApplicationRecord < ActiveRecord::Base
       self.abstract_class = true

data/config/routes.rb

@@ -1,4 +1,4 @@
-Callstacking::Rails::Engine.routes.draw do
+Checkpoint::Rails::Engine.routes.draw do
   resources :traces
   root to: "traces#index"
 end

data/lib/{callstacking → checkpoint}/rails/client/authenticate.rb

@@ -1,7 +1,6 @@
 require 'json'
-require "callstacking/rails/client/base"
 
-module Callstacking
+module Checkpoint
   module Rails
     module Client
       class Error < StandardError; end

data/lib/{callstacking → checkpoint}/rails/client/base.rb

@@ -1,14 +1,14 @@
 require 'faraday'
 require 'faraday/follow_redirects'
-require "callstacking/rails/settings"
+require "checkpoint/rails/settings"
 
-module Callstacking
+module Checkpoint
   module Rails
     module Client
       class Error < StandardError; end
 
       class Base
-        include Callstacking::Rails::Settings
+        include Checkpoint::Rails::Settings
 
         def initialize
           read_settings

data/lib/{callstacking → checkpoint}/rails/client/trace.rb

@@ -1,6 +1,4 @@
-require "callstacking/rails/client/base"
-
-module Callstacking
+module Checkpoint
   module Rails
     module Client
       class Trace < Base

data/lib/checkpoint/rails/engine.rb

@@ -0,0 +1,34 @@
+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/{callstacking → checkpoint}/rails/env.rb

@@ -1,6 +1,4 @@
-require "active_support/inflector"
-
-module Callstacking
+module Checkpoint
   module Rails
     class Env
       DEFAULT_ENVIRONMENT = "development"

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

@@ -1,8 +1,8 @@
 require "active_support/concern"
 require "active_support/core_ext/class/attribute_accessors"
-require "callstacking/rails/env"
+require "checkpoint/rails/env"
 
-module Callstacking
+module Checkpoint
   module Rails
     module Settings
       extend ActiveSupport::Concern
@@ -11,7 +11,7 @@ module Callstacking
         attr_accessor :settings
       end
 
-      SETTINGS_FILE = "#{Dir.home}/.callstacking"
+      SETTINGS_FILE = "#{Dir.home}/.callstacking-rails"
       PRODUCTION_URL = "https://callstacking.com"
 
       def url
@@ -30,16 +30,8 @@ module Callstacking
         File.write(SETTINGS_FILE, new_settings.to_yaml)
       end
 
-      def enabled?
-        settings[:enabled]
-      end
-
-      def disabled?
-        !enabled?
-      end
-
       def read_settings
-        @@settings = @settings = complete_settings.dig(::Callstacking::Rails::Env.environment, :settings)
+        @@settings = @settings = complete_settings.dig(::Checkpoint::Rails::Env.environment, :settings)
       rescue StandardError => e
         puts e.full_message
         puts e.backtrace.join("\n")
@@ -47,7 +39,7 @@ module Callstacking
       end
 
       def complete_settings
-        YAML.load(File.read(SETTINGS_FILE)) rescue {}
+        YAML.load(File.read(Checkpoint::Rails::Client::Base::SETTINGS_FILE)) rescue {}
       end
     end
   end

data/lib/checkpoint/rails/setup.rb

@@ -0,0 +1,93 @@
+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

@@ -0,0 +1,210 @@
+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/{callstacking → checkpoint}/rails/traces_helper.rb

@@ -1,25 +1,25 @@
-require "action_view/helpers/tag_helper"
+require "action_view/helpers/tag_helper.rb"
 require "action_view/context.rb"
 
-module Callstacking
+module Checkpoint
   module Rails
     module TracesHelper
       include ActionView::Helpers::TagHelper
       include ActionView::Context
-      include Callstacking::Rails::Settings
+      include Checkpoint::Rails::Settings
 
       def hud
         read_settings
 
-        frame_url = "#{url || Callstacking::Rails::Settings::PRODUCTION_URL}/traces/#{Callstacking::Rails::Trace.current_request_id}/print"
+        frame_url = "#{url || Checkpoint::Rails::Settings::PRODUCTION_URL}/traces/#{Checkpoint::Rails::Traceable.current_request_id}/print"
 
         body = []
         body << (content_tag( :div, data: { turbo:false },
-                    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;',
+                    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;',
                     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 },

data/lib/checkpoint/rails/version.rb

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

data/lib/checkpoint/rails.rb

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