cruft_tracker 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20710aba981f3164c44b99d0aa870650f19aac7a64b31b8b866655a479dae74c
-  data.tar.gz: 3a4b8fec7d399446a31aef44d77a8fc35e8affc209370393fc3d6bae9037f95b
+  metadata.gz: c9a8291697321237133216a66cb9d58b1e526fe537dddd05644c1fafeaaafb36
+  data.tar.gz: 4ff9fe36c9efd852b03dfc45b7511a74f08f6d92687582ca1316dd8a992031e2
 SHA512:
-  metadata.gz: ad71fc2c540815704899075e337d1c5030165911441befb63d8432689b258e56319c111a3b9dc445eaa67c1e2486dd9bb1af80a82270bfc74c7a523354bf9a5a
-  data.tar.gz: a2d602fa9a427d8c457e38379c8e03707a3d8b58fe4497dbaea8b0e1c3493812dae652c8843645cb42deb430798c67fdcd2213f3491afda1625c3284f97951fe
+  metadata.gz: 7151e6f098431af83070f860877bf3a7e7446b3b13ba0116c56cf5b6b77bf023282c602bf78e1cca181e5cef25ac3e27fac6b2a95ca45d9c1e69b01652efea5b
+  data.tar.gz: bebf3b0e9acbaaf3f4b60753903f48cd548b9e935061c6a28333e8b53eaff8f2099e0d5ff34234864c257c7110b8ce6a7ad75d3e0cae84bd23e264118ee652d8

data/README.md

@@ -59,7 +59,7 @@ class SomeOldClass
 end
 ```
 
-You're unsure if the `some_old_method` method is actually being used. All you need to do is add an instance of the  `is_this_method_used? ` to the CruftTracker initializer. This method requires you to pass the class constant and a symbol to identify the name of the method to track. For example:
+You're unsure if the `some_old_method` method is actually being used. All you need to do is add an instance of the  `is_this_method_used? ` to the CruftTracker initializer. This method requires you to pass the class constant and a symbol to identify the name of the method to track. For example:
 
 ```ruby
 # config/initializers/cruft_tracker.rb
@@ -445,7 +445,7 @@ When the view is actually rendered, CruftTracker will collect information about
 | ---- | ------- | -------------------------------- | -------------- | ------------ | ---------------------- | ------------ | ----------- | ------------------- | ------------------- |
 | 1    | 1       | 98cc3bd79cf6f3606c5afe3b9faf925b | SomeController | do_something | /foo/:id/bar(.:format) | [{...}]      | 1           | 2022-07-06 15:29:06 | 2022-07-06 15:29:06 |
 
-This record is represented by the `CruftTracker::ViewRender` model and can be loaded in the usual ways. You can also access it from a specific view record. EG: `CruftTracker::View.find(1).view_renders`, which will return an association of unique renders.
+This record is represented by the `CruftTracker::ViewRender` model and can be loaded in the usual ways. You can also access it from a specific view record. EG: `CruftTracker::View.find(1).view_renders`, which will return an association of unique renders.
 
 There's a lot packed into that record. Let's disect it:
 
@@ -531,6 +531,34 @@ A word of caution: don't track ever variable. Variables are, by definition, vari
 
 CruftTacker automatically cleans up after itself. ✨🧹 If you remove any configured tracking, CruftTracker will recognize this when your application starts up and mark the associated `cruft_tracker_methods` record as deleted. 
 
+## Configuration
+
+Imagine a scenario where you have a method or view that is used in many places, or maybe as a result of metaprogramming. Perhaps you have some logic that is user-configurable and might lead to a tracked method being called with any number of backtraces. It's not super helpful to track all possible backtraces and it's actively bad, since it wastes space in your database and slows down queries. Besides, it's no fun drinking from the firehose.
+
+CruftTracker provides a few configurable settings to control the amount of data recorded in some of its tables. 
+
+| Name                                             | Default | Description                                                  |
+| ------------------------------------------------ | ------- | ------------------------------------------------------------ |
+| `max_argument_variations_per_tracked_method`     | 50      | Sets the maximum number of distinct arguments that can be recorded for any tracked method. |
+| `max_backtrace_variations_per_tracked_method`    | 50      | Sets the maximum number of distinct backtraces that can be recorded for any tracked method. |
+| `max_view_renders_per_view`                      | 50      | Sets the maximum number of distinct renders that can be recorded for any tracked view. |
+| `max_render_metadata_variations_per_view_render` | 50      | Sets the maximum number of distinct render metadata records that can be recorded for any specific render of a view. |
+
+These configuration values can be set within the CruftTracker initializer like this:
+
+```ruby
+# config/initializers/cruft_tracker.rb
+
+CruftTracker.init do
+  config.max_argument_variations_per_tracked_method = 20
+  config.max_backtrace_variations_per_tracked_method = 25
+  config.max_view_renders_per_view = 30
+  config.max_render_metadata_variations_per_view_render = 35
+  
+  # ... your configuration for tracking methods or views ...
+end
+```
+
 ## API Docs
 
 ### `CruftTracker` module methods

data/app/controllers/cruft_tracker/methods_controller.rb

@@ -2,9 +2,7 @@
 
 module CruftTracker
   class MethodsController < ApplicationController
-
     def index
-      
     end
   end
 end

data/app/helpers/cruft_tracker/application_helper.rb

@@ -17,7 +17,7 @@ module CruftTracker
     private
 
     def cruft_tracker_view
-      path = render_stack.first[:path].gsub(/#{Rails.root}\//, "")
+      path = render_stack.first[:path].gsub(%r{#{Rails.root}/}, '')
       view = CruftTracker::View.find_by(view: path)
 
       return view if view.present?
@@ -26,9 +26,9 @@ module CruftTracker
     end
 
     def route_path
-      _routes.router.recognize(request) do |route, _|
-        return route.path.spec.to_s
-      end
+      _routes
+        .router
+        .recognize(request) { |route, _| return route.path.spec.to_s }
 
       nil
     end
@@ -38,18 +38,20 @@ module CruftTracker
     end
 
     def render_stack
-      caller_locations.select do |caller_location|
-        paths_to_views.any? do |path_for_view|
-          caller_location.path.match?(/^#{path_for_view}\//)
+      caller_locations
+        .select do |caller_location|
+          paths_to_views.any? do |path_for_view|
+            caller_location.path.match?(%r{^#{path_for_view}/})
+          end
+        end
+        .map do |location|
+          {
+            path: location.path,
+            label: location.label,
+            base_label: location.base_label,
+            lineno: location.lineno
+          }
         end
-      end.map do |location|
-        {
-          path: location.path,
-          label: location.label,
-          base_label: location.base_label,
-          lineno: location.lineno
-        }
-      end
     end
   end
 end

data/app/models/cruft_tracker/render_metadata.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module CruftTracker
-  class RenderMetadata  < ActiveRecord::Base
+  class RenderMetadata < ActiveRecord::Base
     belongs_to :view_render, class_name: 'CruftTracker::ViewRender'
   end
 end

data/app/models/cruft_tracker/view.rb

@@ -11,7 +11,9 @@ module CruftTracker
 
     def still_tracked?
       return true if CruftTracker::Registry.include?(self)
-      return true if File.read(absolute_path).match?(/record_cruft_tracker_view_render/)
+      if File.read(absolute_path).match?(/record_cruft_tracker_view_render/)
+        return true
+      end
 
       false
     end

data/app/services/cruft_tracker/cleanup_untracked_views.rb

@@ -9,10 +9,10 @@ module CruftTracker
         CruftTracker::View
           .where(deleted_at: nil)
           .each do |view|
-          unless view.still_exists? && view.still_tracked?
-            view.update(deleted_at: Time.current)
+            unless view.still_exists? && view.still_tracked?
+              view.update(deleted_at: Time.current)
+            end
           end
-        end
       end
     rescue StandardError
       # I'm actively ignoring all errors. Chances are, these are due to something like running rake

data/app/services/cruft_tracker/record_arguments.rb

@@ -9,6 +9,8 @@ module CruftTracker
     private
 
     def execute
+      return unless arguments_record.present?
+
       CruftTracker::LogSuppressor.suppress_logging do
         arguments_record.with_lock do
           arguments_record.reload
@@ -22,16 +24,22 @@ module CruftTracker
     def arguments_record
       @arguments_record ||=
         begin
+          return find_existing_arguments_record if max_records_reached?
+
           CruftTracker::Argument.create(
             method: method,
             arguments_hash: arguments_hash,
             arguments: transformed_arguments
           )
         rescue ActiveRecord::RecordNotUnique
-          CruftTracker::Argument.find_by(arguments_hash: arguments_hash)
+          find_existing_arguments_record
         end
     end
 
+    def find_existing_arguments_record
+      CruftTracker::Argument.find_by(arguments_hash: arguments_hash)
+    end
+
     def arguments_hash
       Digest::MD5.hexdigest(transformed_arguments.to_json)
     end
@@ -39,5 +47,9 @@ module CruftTracker
     def transformed_arguments
       @transformed_arguments ||= transformer.call(arguments)
     end
+
+    def max_records_reached?
+      CruftTracker::Argument.where(method: method).count >= CruftTracker.config.max_argument_variations_per_tracked_method
+    end
   end
 end

data/app/services/cruft_tracker/record_backtrace.rb

@@ -7,6 +7,8 @@ module CruftTracker
     private
 
     def execute
+      return unless backtrace_record.present?
+
       CruftTracker::LogSuppressor.suppress_logging do
         backtrace_record.with_lock do
           backtrace_record.reload
@@ -20,16 +22,22 @@ module CruftTracker
     def backtrace_record
       @backtrace_record ||=
         begin
+          return find_existing_backtrace_record if max_records_reached?
+
           CruftTracker::Backtrace.create(
             traceable: method,
             trace_hash: backtrace_hash,
             trace: filtered_backtrace
           )
         rescue ActiveRecord::RecordNotUnique
-          CruftTracker::Backtrace.find_by(trace_hash: backtrace_hash)
+          find_existing_backtrace_record
         end
     end
 
+    def find_existing_backtrace_record
+      CruftTracker::Backtrace.find_by(trace_hash: backtrace_hash)
+    end
+
     def backtrace_hash
       Digest::MD5.hexdigest(filtered_backtrace.to_json)
     end
@@ -51,5 +59,9 @@ module CruftTracker
           }
         end
     end
+
+    def max_records_reached?
+      CruftTracker::Backtrace.where(traceable: method).count >= CruftTracker.config.max_backtrace_variations_per_tracked_method
+    end
   end
 end

data/app/services/cruft_tracker/record_render_metadata.rb

@@ -10,11 +10,14 @@ module CruftTracker
 
     def execute
       return unless metadata.present?
+      return unless render_metadata_record.present?
 
       CruftTracker::LogSuppressor.suppress_logging do
         render_metadata_record.with_lock do
           render_metadata_record.reload
-          render_metadata_record.update(occurrences: render_metadata_record.occurrences + 1)
+          render_metadata_record.update(
+            occurrences: render_metadata_record.occurrences + 1
+          )
         end
       end
     end
@@ -22,18 +25,28 @@ module CruftTracker
     def render_metadata_record
       @render_metadata_record ||=
         begin
+          return find_existing_render_metadata_record if max_records_reached?
+
           CruftTracker::RenderMetadata.create(
             view_render: view_render,
             metadata_hash: metadata_hash,
             metadata: metadata
           )
         rescue ActiveRecord::RecordNotUnique
-          CruftTracker::RenderMetadata.find_by(metadata_hash: metadata_hash)
+          find_existing_render_metadata_record
         end
     end
 
+    def find_existing_render_metadata_record
+      CruftTracker::RenderMetadata.find_by(metadata_hash: metadata_hash)
+    end
+
     def metadata_hash
       Digest::MD5.hexdigest([view_render.render_hash, metadata].to_json)
     end
+
+    def max_records_reached?
+      CruftTracker::RenderMetadata.where(view_render: view_render).count >= CruftTracker.config.max_render_metadata_variations_per_view_render
+    end
   end
 end

data/app/services/cruft_tracker/record_view_render.rb

@@ -20,6 +20,8 @@ module CruftTracker
     private
 
     def execute
+      return unless view_render_record.present?
+
       CruftTracker::LogSuppressor.suppress_logging do
         view.with_lock do
           view.reload
@@ -28,7 +30,9 @@ module CruftTracker
 
         view_render_record.with_lock do
           view_render_record.reload
-          view_render_record.update(occurrences: view_render_record.occurrences + 1)
+          view_render_record.update(
+            occurrences: view_render_record.occurrences + 1
+          )
 
           record_render_metadata(view_render_record)
 
@@ -38,14 +42,18 @@ module CruftTracker
     end
 
     def record_render_metadata(view_render_record)
-      compose(CruftTracker::RecordRenderMetadata,
-              view_render: view_render_record,
-              metadata: metadata)
+      compose(
+        CruftTracker::RecordRenderMetadata,
+        view_render: view_render_record,
+        metadata: metadata
+      )
     end
 
     def view_render_record
       @view_render_record ||=
         begin
+          return find_existing_view_render_record if max_records_reached?
+
           CruftTracker::ViewRender.create(
             view: view,
             render_hash: render_hash,
@@ -56,10 +64,14 @@ module CruftTracker
             render_stack: render_stack
           )
         rescue ActiveRecord::RecordNotUnique
-          CruftTracker::ViewRender.find_by(render_hash: render_hash)
+          find_existing_view_render_record
         end
     end
 
+    def find_existing_view_render_record
+      CruftTracker::ViewRender.find_by(render_hash: render_hash)
+    end
+
     def render_hash
       Digest::MD5.hexdigest(
         {
@@ -72,5 +84,8 @@ module CruftTracker
       )
     end
 
+    def max_records_reached?
+      CruftTracker::ViewRender.where(view: view).count >= CruftTracker.config.max_view_renders_per_view
+    end
   end
 end

data/app/services/cruft_tracker/track_view.rb

@@ -9,13 +9,14 @@ module CruftTracker
     interface :comment, methods: %i[to_json], default: nil
 
     def execute
-      view_record = CruftTracker::LogSuppressor.suppress_logging do
-        view_record = create_or_find_view_record
-        view_record.deleted_at = nil
-        view_record.comment = comment if comment != view_record.comment
-        view_record.save
-        view_record
-      end
+      view_record =
+        CruftTracker::LogSuppressor.suppress_logging do
+          view_record = create_or_find_view_record
+          view_record.deleted_at = nil
+          view_record.comment = comment if comment != view_record.comment
+          view_record.save
+          view_record
+        end
 
       listen_for_render(view_record)
 
@@ -33,7 +34,7 @@ module CruftTracker
         'CruftTracker was unable to record a view. Have migrations been run?'
       )
     rescue Mysql2::Error::ConnectionError,
-      ActiveRecord::ConnectionNotEstablished
+           ActiveRecord::ConnectionNotEstablished
       Rails.logger.warn(
         'CruftTracker was unable to record a view due to being unable to connect to the database. This may be a non-issue in cases where the database is intentionally not available.'
       )
@@ -51,14 +52,9 @@ module CruftTracker
     end
 
     def create_or_find_view_record
-      CruftTracker::View.create(
-        view: view,
-        comment: comment
-      )
+      CruftTracker::View.create(view: view, comment: comment)
     rescue ActiveRecord::RecordNotUnique
-      CruftTracker::View.find_by(
-        view: view
-      )
+      CruftTracker::View.find_by(view: view)
     end
   end
 end

data/config/routes.rb

@@ -1,3 +1 @@
-CruftTracker::Engine.routes.draw do
-  resources :methods, only: %i[index]
-end
+CruftTracker::Engine.routes.draw { resources :methods, only: %i[index] }

data/lib/cruft_tracker/engine.rb

@@ -14,6 +14,5 @@ module CruftTracker
         helper CruftTracker::ApplicationHelper
       end
     end
-
   end
 end

data/lib/cruft_tracker/version.rb

@@ -1,3 +1,3 @@
 module CruftTracker
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/cruft_tracker.rb

@@ -4,18 +4,18 @@ require 'cruft_tracker/registry'
 require 'cruft_tracker/log_suppressor'
 
 module CruftTracker
+  class << self
+    attr_accessor :config
+  end
+
   def self.init(&block)
+    self.config = Config.instance
+
     self.instance_eval(&block)
   end
 
-  def self.is_this_view_used?(
-    view,
-    comment: nil
-  )
-    CruftTracker::TrackView.run!(
-      view: view,
-      comment: comment
-    )
+  def self.is_this_view_used?(view, comment: nil)
+    CruftTracker::TrackView.run!(view: view, comment: comment)
   end
 
   def self.is_this_method_used?(
@@ -37,4 +37,28 @@ module CruftTracker
   def self.are_any_of_these_methods_being_used?(owner, comment: nil)
     CruftTracker::TrackAllMethods.run!(owner: owner, comment: comment)
   end
+
+  class Config
+    include Singleton
+
+    DEFAULT_MAX_ARGUMENTS_VARIATIONS_PER_TRACKED_METHOD = 50
+    DEFAULT_MAX_BACKTRACE_VARIATIONS_PER_TRACKED_METHOD = 50
+    DEFAULT_MAX_VIEW_RENDERS_PER_VIEW = 50
+    DEFAULT_MAX_RENDER_METADATA_VARIATIONS_PER_VIEW_RENDER = 50
+
+    attr_accessor :max_argument_variations_per_tracked_method,
+                  :max_backtrace_variations_per_tracked_method,
+                  :max_view_renders_per_view,
+                  :max_render_metadata_variations_per_view_render
+
+    def initialize
+      @max_argument_variations_per_tracked_method =
+        DEFAULT_MAX_ARGUMENTS_VARIATIONS_PER_TRACKED_METHOD
+      @max_backtrace_variations_per_tracked_method =
+        DEFAULT_MAX_BACKTRACE_VARIATIONS_PER_TRACKED_METHOD
+      @max_view_renders_per_view = DEFAULT_MAX_VIEW_RENDERS_PER_VIEW
+      @max_render_metadata_variations_per_view_render =
+        DEFAULT_MAX_RENDER_METADATA_VARIATIONS_PER_VIEW_RENDER
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cruft_tracker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Adwerx Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_interaction
@@ -235,6 +235,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: prettier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Have you ever asked yourself, "Is this method even being used?!" Or, "What the heck is this method receiving?" Does your application use Rails? If the answers these questions are yes, this gem may be of use to you!