bulletmark_repairer 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b793a019d2937170c113a1b95eeea035a23e0f85a36f5c86382628467d3b006
-  data.tar.gz: 0e513ae03aab2b2f21785d31be5141abe0a34759a16a97e41b32871caf01d531
+  metadata.gz: 5eabc96bcf1961f834090322c3b9a62173139f806513c5ec99d452f18a661c71
+  data.tar.gz: b55ab6f5adade690b6cb34ef92fc752bdfa697a3b8d7779d54150aaf4e1083bb
 SHA512:
-  metadata.gz: bb0869546bfe5bd2c29586cffc2261f58680bb114a7f5dd01c0d4325df6736d49e24e743200285eb5cf199b87123e22bfe85cb8dce0eb2546d469e71fd98afd9
-  data.tar.gz: 2ef8b880ef7e027b3a49a08638235a342ad8e8f1c7a35485f01f3c3cbbbb09b8cd4b75ec21b7522a2439e685833b05ed9488d3a75c916df8391453ea618f7aa8
+  metadata.gz: 714da7b74b7015194f965c83c1260d31b8a4f75b4f7a24b3038eac6c81ced4aa8a77a79abbe5a684a347093fbb00d0e9f1b05682729b96afe64ed2a83b110534
+  data.tar.gz: e48064688caaa2003d30192bfd2a76ff677fdcb4b4bb02bb8b828fece22b9fd5dab69a47aef2fb836a69e9f5b16db10d2c1faefcb9e249ba5b8a3df671310c03

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.1.6] - 2023-11-09
+
+Fix a bug when N+1 is caused not in the request (e.g. Sidekiq) [51f051e](https://github.com/makicamel/bulletmark_repairer/commit/51f051e608b84b7da96ac879a324ed438c14eeeb)
+
+## [0.1.5] - 2023-10-27
+
+Be able to patch for nested associations require `includes` though child associations are already included [d1b7445](https://github.com/makicamel/bulletmark_repairer/commit/d1b7445556c20bc037beb6a013ac70531426a7ea)
+
 ## [0.1.4] - 2023-10-22
 
 - Patch files other than controllers [218566d](https://github.com/makicamel/bulletmark_repairer/commit/218566d1531751f204941c3dcff7f095a056d39f)

data/README.md

@@ -47,12 +47,12 @@ For example, the following cases are not supported as known cases currently:
 
 ```ruby
 def index
-  # Nested associations require `includes` though child associations are already included
+  # Multiple nested associations require `includes` though child associations are already included
   @plays = Play.includes(:actors)
   # expected correct
-  @plays = Play.includes(actors: [:company])
+  @plays = Play.includes(:actors).includes({:actors=>{:company=>[:offices]}})
   # actual correct
-  @plays = Play.includes(:actors).includes([:company])
+  @plays = Play.includes(:actors).includes({:actors=>[:company]})
 end
 ```
 

data/lib/bulletmark_repairer/associations_builder.rb

@@ -10,7 +10,11 @@ module BulletmarkRepairer
       if associations[marker.index]
         associations[marker.index].add(marker)
       else
-        associations[marker.index] = Associations.new(marker, @application_associations)
+        associations[marker.index] = Associations.new(
+          marker,
+          @application_associations,
+          @loaded_associations
+        )
       end
     end
 
@@ -20,8 +24,9 @@ module BulletmarkRepairer
 
     private
 
-    def initialize
+    def initialize(loaded_associations)
       @application_associations = BulletmarkRepairer::ApplicationAssociations.new
+      @loaded_associations = BulletmarkRepairer::LoadedAssociations.new(loaded_associations)
     end
   end
 
@@ -44,10 +49,12 @@ module BulletmarkRepairer
 
     private
 
-    def initialize(marker, application_associations)
+    def initialize(marker, application_associations, loaded_associations)
       @marker = marker
-      @associations = { base: marker.associations }
       @application_associations = application_associations
+      @loaded_associations = loaded_associations
+      key = @loaded_associations.key(marker.base_class)
+      @associations = { base: key ? { key => marker.associations } : marker.associations }
     end
 
     # @return [Hash, nil]

data/lib/bulletmark_repairer/loaded_associations.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module BulletmarkRepairer
+  class LoadedAssociations
+    attr_reader :associations
+
+    def key(target_klass_name)
+      key = target_klass_name.underscore
+
+      result = []
+      @associations.each do |_base_klass_name, all_associations|
+        all_associations.each do |_key, associations|
+          # TODO: reccurent check
+          associations.each do |values|
+            values.flatten.each do |value|
+              result.append search_key(key, value)
+            end
+          end
+        end
+      end
+      result = result.flatten.compact.uniq.presence
+      build_keys(result)
+    end
+
+    private
+
+    def search_key(key, value)
+      case value
+      when Hash
+        search_key(key, value.keys) || search_key(key, value.values)
+      when Array
+        value.map { |v| search_key(key, v) }
+      else
+        if key.pluralize.to_sym == value
+          key.pluralize.to_sym
+        elsif key.singularize.to_sym == value
+          key.singularize.to_sym
+        end
+      end
+    end
+
+    def build_keys(keys)
+      return unless keys
+
+      if keys.size == 1
+        keys.first
+      else
+        { keys.first => keys.last }
+      end
+    end
+
+    def initialize(original_associations)
+      @associations = Hash.new { |h, k| h[k] = {} }
+      original_associations.each do |base_class, all_associations|
+        all_associations.each do |key, associations|
+          @associations[base_class][key] = associations.to_a
+        end
+      end
+    end
+  end
+end

data/lib/bulletmark_repairer/monkey_patches/active_record/query_method.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BulletmarkRepairer
+  module ActiveRecord
+    module QueryMethod
+      def includes(*args)
+        BulletmarkRepairer::Thread.add(name: model.name, method_type: :includes, args: args)
+        super(args)
+      end
+
+      def eager_load(*args)
+        BulletmarkRepairer::Thread.add(name: model.name, method_type: :eager_load, args: args)
+        super(args)
+      end
+
+      def preload(*args)
+        BulletmarkRepairer::Thread.add(name: model.name, method_type: :preload, args: args)
+        super(args)
+      end
+    end
+  end
+end

data/lib/bulletmark_repairer/patcher.rb

@@ -6,8 +6,8 @@ require 'parser/runner/ruby_rewrite'
 
 module BulletmarkRepairer
   class Patcher
-    def self.execute(notifications:, controller:, action:)
-      new(notifications: notifications, controller: controller, action: action).execute
+    def self.execute(notifications:, controller:, action:, loaded_associations:)
+      new(notifications: notifications, controller: controller, action: action, loaded_associations: loaded_associations).execute
     end
 
     def execute
@@ -24,9 +24,9 @@ module BulletmarkRepairer
 
     private
 
-    def initialize(notifications:, controller:, action:)
+    def initialize(notifications:, controller:, action:, loaded_associations:)
       @markers = Markers.new(notifications, controller: controller, action: action)
-      @associations_builder = BulletmarkRepairer::AssociationsBuilder.new
+      @associations_builder = BulletmarkRepairer::AssociationsBuilder.new(loaded_associations)
     end
   end
 end

data/lib/bulletmark_repairer/rack.rb

@@ -10,16 +10,18 @@ module BulletmarkRepairer
       @app.call(env)
     ensure
       begin
-        if Thread.current[:bullet_notification_collector].notifications_present?
+        if ::Thread.current[:bullet_notification_collector].notifications_present?
           BulletmarkRepairer::Patcher.execute(
-            notifications: Thread.current[:bullet_notification_collector],
+            notifications: ::Thread.current[:bullet_notification_collector],
             controller: env['action_dispatch.request.parameters']['controller'],
-            action: env['action_dispatch.request.parameters']['action']
+            action: env['action_dispatch.request.parameters']['action'],
+            loaded_associations: BulletmarkRepairer::Thread.current
           )
         end
       rescue StandardError => e
         raise e if BulletmarkRepairer.config.debug?
       end
+      BulletmarkRepairer::Thread.clear
     end
   end
 end

data/lib/bulletmark_repairer/railtie.rb

@@ -9,5 +9,10 @@ module BulletmarkRepairer
       require 'bulletmark_repairer/rack'
       app.middleware.insert_after Bullet::Rack, BulletmarkRepairer::Rack
     end
+
+    ActiveSupport.on_load(:active_record) do
+      require 'bulletmark_repairer/monkey_patches/active_record/query_method'
+      ::ActiveRecord::Relation.prepend(BulletmarkRepairer::ActiveRecord::QueryMethod)
+    end
   end
 end

data/lib/bulletmark_repairer/thread.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module BulletmarkRepairer
+  class Thread
+    class << self
+      def current
+        touch
+      end
+
+      def add(name:, method_type:, args:)
+        touch
+        ::Thread.current[:bulletmark_repaier_loaded_associations][name][method_type].add(args)
+      end
+
+      def clear
+        ::Thread.current[:bulletmark_repaier_loaded_associations] = nil
+      end
+
+      private
+
+      def touch
+        ::Thread.current[:bulletmark_repaier_loaded_associations] ||= Hash.new do |hash, key|
+          hash[key] = { includes: Set.new, eager_load: Set.new, preload: Set.new }
+        end
+      end
+    end
+  end
+end

data/lib/bulletmark_repairer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BulletmarkRepairer
-  VERSION = '0.1.4'
+  VERSION = '0.1.6'
 end

data/lib/bulletmark_repairer.rb

@@ -6,8 +6,10 @@ require 'bulletmark_repairer/application_associations'
 require 'bulletmark_repairer/associations_builder'
 require 'bulletmark_repairer/configuration'
 require 'bulletmark_repairer/corrector_builder'
+require 'bulletmark_repairer/loaded_associations'
 require 'bulletmark_repairer/markers'
 require 'bulletmark_repairer/patcher'
+require 'bulletmark_repairer/thread'
 
 module BulletmarkRepairer
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulletmark_repairer
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - makicamel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-22 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -88,11 +88,14 @@ files:
 - lib/bulletmark_repairer/configuration.rb
 - lib/bulletmark_repairer/controller_corrector.rb
 - lib/bulletmark_repairer/corrector_builder.rb
+- lib/bulletmark_repairer/loaded_associations.rb
 - lib/bulletmark_repairer/markers.rb
+- lib/bulletmark_repairer/monkey_patches/active_record/query_method.rb
 - lib/bulletmark_repairer/patcher.rb
 - lib/bulletmark_repairer/rack.rb
 - lib/bulletmark_repairer/railtie.rb
 - lib/bulletmark_repairer/retry_corrector.rb
+- lib/bulletmark_repairer/thread.rb
 - lib/bulletmark_repairer/version.rb
 - sig/bulletmark_repairer.rbs
 homepage: https://github.com/makicamel/bulletmark_repairer
@@ -118,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Auto corrector for N+1 queries detected at runtime with Bullet