callstacking-rails 0.1.17 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ab0ce71570b5a8fad5a52644bb6c9074397f605e534cff04bca7dc4d77e074b
-  data.tar.gz: fbc85372f3e48c47034d8c6e91e78d609bb406aefad47f6288ddba1b20997978
+  metadata.gz: 122755f46a3f89ee6c310aed0ede48453bf7ff7f92c50f9809fe7466ad49159b
+  data.tar.gz: adfdbd3892e3c6cc5b1e869ce8a1d63185610347b3079a1de8cf6ebb8009eff3
 SHA512:
-  metadata.gz: 2cbd1d85dd50ebbb389e1b0013015c2e0dfdeadbaede7ba8d58fe6869c798f2d8fd30902a1a3872750e751695aae3ef5ebb056146893c3a8d637058aec2ceace
-  data.tar.gz: 7ad047325a5a029b6ba073a41905212be140be57414e88cc0e8d1a5ab30cf107c569b222ef38e18940fc92ad9ca2b6663a53b5d63b4b548f29d293d9223e7938
+  metadata.gz: baa19130df5d47f45d0df4d2a0055edb1d5a2bbb74bdff1919a20de8bd6e6fa5fe6ad8224dddf8a6b973128301f007b76f094d076e0753c1b5257f3b5852c9ac
+  data.tar.gz: 22e7fc256542ea2f13de0f400b350a74a2e115c96610734f0db0e492d416b48d6dd19f26ea68b40a4ffac6ef3a515f27a21604b3a0fe0dca2e43f6017bf1693f

data/README.md

@@ -1,6 +1,6 @@
 # Callstacking::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).  
+Call Stacking 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).  
 
 You no longer need to debug with `binding.pry` or `puts` statements, as the entire callstack for a given request is captured.
 
@@ -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.
+Call Stacking 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).
+Call Stacking 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.
 
@@ -43,7 +43,7 @@ And then execute:
 $ bundle
 ```
    
-Register an account at Callstacking.com
+Register an account at callstacking.com
 ```bash
 callstacking-rails register
 ```
@@ -85,11 +85,23 @@ By setting the RAILS_ENV environment you can maintain multiple settings.
 
 Questions? Create an issue: https://github.com/callstacking/callstacking-rails/issues
 
+## Environment
+
+You can provide the auth token via the `CALLSTACKING_AUTH_TOKEN` environment variable.
+
+Your API token values can be viewed at https://callstacking.com/api_tokens
+
+You can enable/disable tracing via the `CALLSTACKING_ENABLED` environment variable (false|true).
 
 ## 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 a `💥` icon on the right hand side.
+
+Click the icon and observe the full callstack context.
 
-Click the arrows, and observe the full callstack context.
+## Tests
+``
+rake app:test:all
+``
 
 ## 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).

data/exe/callstacking-rails

@@ -17,16 +17,17 @@ read_settings
 
 case action
   when 'register'
-    `open #{settings[:url] || Callstacking::Rails::Settings::PRODUCTION_URL}/users/sign_up`
+    puts "Open the following URL to register:\n\n"
+    puts "  #{settings[:url]}/users/sign_up\n\n"
 
   when 'setup'
     Callstacking::Rails::Setup.new.start
 
   when 'enable'
     Callstacking::Rails::Setup.new.enable_disable
-    puts "Callstacking tracing enabled (#{Callstacking::Rails::Env.environment})"
+    puts "Call Stacking tracing enabled (#{Callstacking::Rails::Env.environment})"
 
   when 'disable'
     Callstacking::Rails::Setup.new.enable_disable(enabled: false)
-    puts "Callstacking tracing disabled (#{Callstacking::Rails::Env.environment})"
+    puts "Call Stacking tracing disabled (#{Callstacking::Rails::Env.environment})"
 end

data/lib/callstacking/rails/engine.rb

@@ -13,13 +13,15 @@ require "callstacking/rails/traces_helper"
 module Callstacking
   module Rails
     class Engine < ::Rails::Engine
+      cattr_accessor :spans, :trace
+
       include Settings
       isolate_namespace Callstacking::Rails
 
       read_settings
 
-      spans = Spans.new
-      trace = Trace.new(spans)
+      @@spans||=Spans.new
+      @@trace||=Trace.new(@@spans)
 
       initializer "engine_name.assets.precompile" do |app|
         app.config.assets.precompile << "checkpoint_rails_manifest.js"
@@ -30,7 +32,7 @@ module Callstacking
           include Callstacking::Rails::TracesHelper
         end
 
-        Callstacking::Rails::Loader.new.on_load(spans) if enabled?
+        Callstacking::Rails::Loader.new.on_load(@@spans) if enabled?
       end
 
       initializer :append_before_action do
@@ -38,10 +40,10 @@ module Callstacking
       end
 
       if enabled?
-        puts "Callstacking enabled (#{Callstacking::Rails::Env.environment})"
+        puts "Call Stacking enabled (#{Callstacking::Rails::Env.environment})"
         trace.tracing
       else
-        puts "Callstacking disabled (#{Callstacking::Rails::Env.environment})"
+        puts "Call Stacking disabled (#{Callstacking::Rails::Env.environment})"
       end
     end
   end

data/lib/callstacking/rails/settings.rb

@@ -15,11 +15,11 @@ module Callstacking
       PRODUCTION_URL = "https://callstacking.com"
 
       def url
-        settings[:url]
+        settings[:url] || PRODUCTION_URL
       end
 
       def auth_token
-        settings[:auth_token]
+        ENV['CALLSTACKING_API_TOKEN'] || settings[:auth_token]
       end
 
       def auth_token?

data/lib/callstacking/rails/setup.rb

@@ -27,18 +27,15 @@ module Callstacking
         email      = prompt("Enter email:")
         password   = prompt("Enter password:", echo: false)
 
-        url = if Callstacking::Rails::Env.production? && ENV['CHECKPOINT_RAILS_LOCAL_TEST'].nil?
-                PRODUCTION_URL
-              else
-                prompt("Enter URL for #{Callstacking::Rails::Env.environment} API calls [#{PRODUCTION_URL}]:") || PRODUCTION_URL
-              end
-
         save(email, password, url)
 
         puts "Authentication successful."
         puts "Settings saved to #{SETTINGS_FILE}"
+        true
       rescue StandardError => e
         puts "Problem authenticating: #{e.message}"
+        puts e.backtrace.join("\n")
+        false
       end
 
       def enable_disable(enabled: true)
@@ -54,11 +51,7 @@ module Callstacking
       def prompt(label, echo: true)
         puts label
 
-        value = if echo
-                  STDIN.gets.chomp
-                else
-                  STDIN.noecho(&:gets).chomp
-                end
+        value = echo ? STDIN.gets.chomp : STDIN.noecho(&:gets).chomp
         puts
 
         return nil if value == ''
@@ -119,6 +112,16 @@ module Callstacking
         puts
         puts "Questions? Create an issue: https://github.com/callstacking/callstacking-rails/issues"
       end
+
+      private
+
+      def url
+        if Callstacking::Rails::Env.production? && ENV['CALLSTACKING_RAILS_LOCAL_TEST'].nil?
+          PRODUCTION_URL
+        else
+          prompt("Enter URL for #{Callstacking::Rails::Env.environment} API calls [#{PRODUCTION_URL}]:") || PRODUCTION_URL
+        end
+      end
     end
   end
 end

data/lib/callstacking/rails/trace.rb

@@ -132,7 +132,7 @@ module Callstacking
                                                                path, original_url, request_id, headers,
                                                                params)
 
-        puts "#{settings[:url] || Callstacking::Rails::Settings::PRODUCTION_URL}/traces/#{trace_id}"
+        print_trace_url(trace_id)
 
         create_message(start_request_message(method, controller, action, format),
                        spans.increment_order_num, @traces)
@@ -140,6 +140,16 @@ module Callstacking
         return trace_id, max_trace_entries
       end
 
+      def print_trace_url(trace_id)
+        url = "#{settings[:url]}/traces/#{trace_id}"
+        
+        puts "*" * url.size
+        puts url
+        puts "*" * url.size
+
+        url
+      end
+
       def complete_request(method, controller, action, format, original_url, trace_id, traces, max_trace_entries)
         if do_not_track_request?(original_url, format)
           traces.clear
@@ -157,9 +167,9 @@ module Callstacking
       end
 
       def do_not_track_request?(url, format)
-        return false if format =~ /(html|json)/i
-        
-        url =~ /(\/stylesheets\/|\/javascripts\/|\/css\/|\/js\/|\.js|\.css)/i
+        return true if format == "*/*"
+
+        (url =~ /(\/assets\/|\/stylesheets\/|\/javascripts\/|\/css\/|\/js\/|\.js|\.css)/i).present?
       end
 
       def return_value(return_val)

data/lib/callstacking/rails/version.rb

@@ -1,5 +1,5 @@
 module Callstacking
   module Rails
-    VERSION = "0.1.17"
+    VERSION = "0.1.19"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callstacking-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.19
 platform: ruby
 authors:
 - Jim Jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails