aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/relation/record_fetch_warning.rb
blob: 0d31f73ddd54568eb6c9133c550a79cad25ef960 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
module ActiveRecord
  class Relation
    module RecordFetchWarning
      # When this module is prepended to ActiveRecord::Relation and
      # `config.active_record.warn_on_records_fetched_greater_than` is
      # set to an integer, if the number of records a query returns is
      # greater than the value of `warn_on_records_fetched_greater_than`,
      # a warning is logged. This allows for the dection of queries that
      # return a large number of records, which could cause memory
      # bloat.
      #
      # In most cases, fetching large number of records can be performed
      # efficiently using the ActiveRecord::Batches methods.
      # See active_record/lib/relation/batches.rb for more information.
      def exec_queries
        QueryRegistry.reset

        super.tap do
          if logger && warn_on_records_fetched_greater_than
            if @records.length > warn_on_records_fetched_greater_than
              logger.warn "Query fetched #{@records.size} #{@klass} records: #{QueryRegistry.queries.join(";")}"
            end
          end
        end
      end

      ActiveSupport::Notifications.subscribe("sql.active_record") do |*args|
        payload = args.last

        QueryRegistry.queries << payload[:sql]
      end

      class QueryRegistry # :nodoc:
        extend ActiveSupport::PerThreadRegistry

        attr_accessor :queries

        def initialize
          reset
        end

        def reset
          @queries = []
        end
      end
    end
  end
end

ActiveRecord::Relation.prepend ActiveRecord::Relation::RecordFetchWarning