prosopite 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 0c9deb860379923d4dc495bb4f24bc44932a8be7d633be9ea59435da7ea7f51f
4
+ data.tar.gz: 4598734ccd6d01208847d97ac03f5bfe570c5121a3d36c6b1746b4f3ab1b455d
5
+ SHA512:
6
+ metadata.gz: a7f1d7d7a9a5607e5d5ea73f734b3ae62a250a49f149daa2a04bf693cfd1072cb4fb3922d97f268b65116db7ad76d629430ce1dfcc792ba9dec5e8185b0440ac
7
+ data.tar.gz: b67c9e0c61ee1a5858c00ba666521699e69efb3866fccc770482e31a04a57a01661dd4e52dac5229b922461aa1f1d0fdff156c7d1ad8ad8b1b9f17d011748042
@@ -0,0 +1,15 @@
1
+ name: CI
2
+ on: [push, pull_request]
3
+ jobs:
4
+ test:
5
+ strategy:
6
+ matrix:
7
+ ruby: [2.5, 2.6, 2.7, '3.0', head]
8
+ runs-on: ubuntu-latest
9
+ steps:
10
+ - uses: actions/checkout@v2
11
+ - uses: ruby/setup-ruby@v1
12
+ with:
13
+ bundler-cache: true
14
+ ruby-version: ${{ matrix.ruby }}
15
+ - run: bundle exec rake test
data/.gitignore ADDED
@@ -0,0 +1,8 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ source "https://rubygems.org"
4
+
5
+ gemspec
6
+
7
+ gem "rake", "~> 13.0"
data/Gemfile.lock ADDED
@@ -0,0 +1,53 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ prosopite (0.1.3)
5
+ pg_query (~> 1.3.0)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ activemodel (6.1.3)
11
+ activesupport (= 6.1.3)
12
+ activerecord (6.1.3)
13
+ activemodel (= 6.1.3)
14
+ activesupport (= 6.1.3)
15
+ activesupport (6.1.3)
16
+ concurrent-ruby (~> 1.0, >= 1.0.2)
17
+ i18n (>= 1.6, < 2)
18
+ minitest (>= 5.1)
19
+ tzinfo (~> 2.0)
20
+ zeitwerk (~> 2.3)
21
+ coderay (1.1.3)
22
+ concurrent-ruby (1.1.8)
23
+ factory_bot (6.1.0)
24
+ activesupport (>= 5.0.0)
25
+ i18n (1.8.9)
26
+ concurrent-ruby (~> 1.0)
27
+ method_source (1.0.0)
28
+ minitest (5.14.3)
29
+ pg_query (1.3.0)
30
+ pry (0.14.0)
31
+ coderay (~> 1.1)
32
+ method_source (~> 1.0)
33
+ rake (13.0.3)
34
+ sqlite3 (1.4.2)
35
+ tzinfo (2.0.4)
36
+ concurrent-ruby (~> 1.0)
37
+ zeitwerk (2.4.2)
38
+
39
+ PLATFORMS
40
+ ruby
41
+ x86_64-linux
42
+
43
+ DEPENDENCIES
44
+ activerecord
45
+ factory_bot
46
+ minitest
47
+ prosopite!
48
+ pry
49
+ rake (~> 13.0)
50
+ sqlite3
51
+
52
+ BUNDLED WITH
53
+ 2.2.10
data/LICENSE.txt ADDED
@@ -0,0 +1,203 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
203
+
data/README.md ADDED
@@ -0,0 +1,188 @@
1
+ # Prosopite ![CI](https://github.com/charkost/prosopite/actions/workflows/ci.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/prosopite.svg)](https://badge.fury.io/rb/prosopite)
2
+
3
+ Prosopite is able to auto-detect Rails N+1 queries with zero false positives / false negatives.
4
+
5
+ ```
6
+ N+1 queries detected:
7
+ SELECT `users`.* FROM `users` WHERE `users`.`id` = 20 LIMIT 1
8
+ SELECT `users`.* FROM `users` WHERE `users`.`id` = 21 LIMIT 1
9
+ SELECT `users`.* FROM `users` WHERE `users`.`id` = 22 LIMIT 1
10
+ SELECT `users`.* FROM `users` WHERE `users`.`id` = 23 LIMIT 1
11
+ SELECT `users`.* FROM `users` WHERE `users`.`id` = 24 LIMIT 1
12
+ Call stack:
13
+ app/controllers/thank_you_controller.rb:4:in `block in index'
14
+ app/controllers/thank_you_controller.rb:3:in `each'
15
+ app/controllers/thank_you_controller.rb:3:in `index':
16
+ app/controllers/application_controller.rb:8:in `block in <class:ApplicationController>'
17
+ ```
18
+
19
+ The need for prosopite emerged after dealing with various false positives / negatives using the
20
+ [bullet](https://github.com/flyerhzm/bullet) gem.
21
+
22
+ ## Compared to Bullet
23
+
24
+ Prosopite can auto-detect the following extra cases of N+1 queries:
25
+
26
+ #### N+1 queries after record creations (usually in tests)
27
+
28
+ ```ruby
29
+ FactoryBot.create_list(:leg, 10)
30
+
31
+ Leg.last(10).each do |l|
32
+ l.chair
33
+ end
34
+ ```
35
+
36
+ #### Not triggered by ActiveRecord associations
37
+
38
+ ```ruby
39
+ Leg.last(4).each do |l|
40
+ Chair.find(l.chair_id)
41
+ end
42
+ ```
43
+
44
+ #### First/last/pluck of collection associations
45
+
46
+ ```ruby
47
+ Chair.last(20).each do |c|
48
+ c.legs.first
49
+ c.legs.last
50
+ c.legs.pluck(:id)
51
+ end
52
+ ```
53
+
54
+ #### Changing the ActiveRecord class with #becomes
55
+
56
+ ```ruby
57
+ Chair.last(20).map{ |c| c.becomes(ArmChair) }.each do |ac|
58
+ ac.legs.map(&:id)
59
+ end
60
+ ```
61
+
62
+ #### Mongoid models calling ActiveRecord
63
+
64
+ ```ruby
65
+ class Leg::Design
66
+ include Mongoid::Document
67
+ ...
68
+ field :cid, as: :chair_id, type: Integer
69
+ ...
70
+ def chair
71
+ @chair ||= Chair.where(id: chair_id).first!
72
+ end
73
+ end
74
+
75
+ Leg::Design.last(20) do |l|
76
+ l.chair
77
+ end
78
+ ```
79
+
80
+ ## How it works
81
+
82
+ Prosopite monitors all SQL queries using the Active Support instrumentation
83
+ and looks for the following pattern which is present in all N+1 query cases:
84
+
85
+ More than one queries have the same call stack and the same query fingerprint.
86
+
87
+ ## Installation
88
+
89
+ Add this line to your application's Gemfile:
90
+
91
+ ```ruby
92
+ gem 'prosopite'
93
+ ```
94
+
95
+ And then execute:
96
+
97
+ $ bundle install
98
+
99
+ Or install it yourself as:
100
+
101
+ $ gem install prosopite
102
+
103
+ ## Configuration
104
+
105
+ The preferred type of notifications can be configured with:
106
+
107
+ * `Prosopite.rails_logger = true`: Send warnings to the Rails log
108
+ * `Prosopite.prosopite_logger = true`: Send warnings to `log/prosopite.log`
109
+ * `Prosopite.stderr_logger = true`: Send warnings to STDERR
110
+ * `Prosopite.raise = true`: Raise warnings as exceptions
111
+
112
+ ## Development Environment Usage
113
+
114
+ Prosopite auto-detection can be enabled on all controllers:
115
+
116
+ ```ruby
117
+ class ApplicationController < ActionController::Base
118
+ before_action do
119
+ Prosopite.scan
120
+ end
121
+
122
+ after_action do
123
+ Prosopite.finish
124
+ end
125
+ end
126
+ ```
127
+ And the preferred notification channel should be configured:
128
+
129
+ ```ruby
130
+ # config/environments/development.rb
131
+
132
+ config.after_initialize do
133
+ Prosopite.rails_logger = true
134
+ end
135
+ ```
136
+
137
+ ## Test Environment Usage
138
+
139
+ Tests with N+1 queries can be configured to fail with:
140
+
141
+ ```ruby
142
+ # config/environments/test.rb
143
+
144
+ config.after_initialize do
145
+ Prosopite.rails_logger = true
146
+ Prosopite.raise = true
147
+ end
148
+ ```
149
+
150
+ And each test can be scanned with:
151
+
152
+ ```ruby
153
+ # spec/spec_helper.rb
154
+
155
+ config.before do
156
+ Prosopite.scan
157
+ end
158
+
159
+ config.after do
160
+ Prosopite.finish
161
+ end
162
+ ```
163
+
164
+ ## Whitelisting
165
+
166
+ Ignore notifications for call stacks containing one or more substrings:
167
+
168
+ ```ruby
169
+ Prosopite.whitelist = ['substring_in_call_stack']
170
+ ```
171
+
172
+ ## Scanning code outside controllers or tests
173
+
174
+ All you have to do is to wrap the code with:
175
+
176
+ ```ruby
177
+ Prosopite.scan
178
+ <code to scan>
179
+ Prosopite.finish
180
+ ```
181
+
182
+ ## Contributing
183
+
184
+ Bug reports and pull requests are welcome on GitHub at https://github.com/charkost/prosopite.
185
+
186
+ ## License
187
+
188
+ Prosopite is licensed under the Apache License, Version 2.0. See LICENSE.txt for the full license text.
data/Rakefile ADDED
@@ -0,0 +1,9 @@
1
+ require "rake/testtask"
2
+
3
+ Rake::TestTask.new(:test) do |t|
4
+ t.libs << "test"
5
+ t.libs << "lib"
6
+ t.test_files = FileList["test/**/test_*.rb"]
7
+ end
8
+
9
+ task default: :test
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Prosopite
4
+ VERSION = "0.1.3"
5
+ end
data/lib/prosopite.rb ADDED
@@ -0,0 +1,155 @@
1
+ require 'pg_query'
2
+
3
+ module Prosopite
4
+ class NPlusOneQueriesError < StandardError; end
5
+ class << self
6
+ attr_writer :raise,
7
+ :stderr_logger,
8
+ :rails_logger,
9
+ :prosopite_logger,
10
+ :whitelist
11
+
12
+ def scan
13
+ return if scan?
14
+ subscribe
15
+
16
+ @query_counter = Hash.new(0)
17
+ @query_holder = Hash.new { |h, k| h[k] = [] }
18
+ @query_caller = {}
19
+
20
+ @whitelist ||= []
21
+ @scan = true
22
+ end
23
+
24
+ def scan?
25
+ @scan
26
+ end
27
+
28
+ def finish
29
+ return unless scan?
30
+
31
+ @notifications = {}
32
+
33
+ @query_counter.each do |location_key, count|
34
+ if count > 1
35
+ fingerprints = @query_holder[location_key].map do |q|
36
+ begin
37
+ fingerprint(q)
38
+ rescue
39
+ raise q
40
+ end
41
+ end
42
+
43
+ kaller = @query_caller[location_key]
44
+
45
+ if fingerprints.uniq.size == 1 && !kaller.any? { |f| @whitelist.any? { |s| f.include?(s) } }
46
+ queries = @query_holder[location_key]
47
+
48
+ unless kaller.any? { |f| f.include?('active_record/validations/uniqueness') }
49
+ @notifications[queries] = kaller
50
+ end
51
+ end
52
+ end
53
+ end
54
+
55
+ @scan = false
56
+ Prosopite.send_notifications if @notifications.present?
57
+ end
58
+
59
+ # Many thanks to https://github.com/genkami/fluent-plugin-query-fingerprint/
60
+ def fingerprint(query)
61
+ query = query.dup
62
+
63
+ unless ActiveRecord::Base.connection.adapter_name.downcase.include?('mysql')
64
+ return PgQuery.fingerprint(query)
65
+ end
66
+
67
+ return "mysqldump" if query =~ %r#\ASELECT /\*!40001 SQL_NO_CACHE \*/ \* FROM `#
68
+ return "percona-toolkit" if query =~ %r#\*\w+\.\w+:[0-9]/[0-9]\*/#
69
+ if match = /\A\s*(call\s+\S+)\(/i.match(query)
70
+ return match.captures.first.downcase!
71
+ end
72
+
73
+ if match = /\A((?:INSERT|REPLACE)(?: IGNORE)?\s+INTO.+?VALUES\s*\(.*?\))\s*,\s*\(/im.match(query)
74
+ query = match.captures.first
75
+ end
76
+
77
+ query.gsub!(%r#/\*[^!].*?\*/#m, "")
78
+ query.gsub!(/(?:--|#)[^\r\n]*(?=[\r\n]|\Z)/, "")
79
+
80
+ return query if query.gsub!(/\Ause \S+\Z/i, "use ?")
81
+
82
+ query.gsub!(/\\["']/, "")
83
+ query.gsub!(/".*?"/m, "?")
84
+ query.gsub!(/'.*?'/m, "?")
85
+
86
+ query.gsub!(/\btrue\b|\bfalse\b/i, "?")
87
+
88
+ query.gsub!(/[0-9+-][0-9a-f.xb+-]*/, "?")
89
+ query.gsub!(/[xb.+-]\?/, "?")
90
+
91
+ query.strip!
92
+ query.gsub!(/[ \n\t\r\f]+/, " ")
93
+ query.downcase!
94
+
95
+ query.gsub!(/\bnull\b/i, "?")
96
+
97
+ query.gsub!(/\b(in|values?)(?:[\s,]*\([\s?,]*\))+/, "\\1(?+)")
98
+
99
+ query.gsub!(/\b(select\s.*?)(?:(\sunion(?:\sall)?)\s\1)+/, "\\1 /*repeat\\2*/")
100
+
101
+ query.gsub!(/\blimit \?(?:, ?\?| offset \?)/, "limit ?")
102
+
103
+ if query =~ /\border by/
104
+ query.gsub!(/\G(.+?)\s+asc/, "\\1")
105
+ end
106
+
107
+ query
108
+ end
109
+
110
+ def send_notifications
111
+ notifications_str = ''
112
+
113
+ @notifications.each do |queries, kaller|
114
+ notifications_str << "N+1 queries detected:\n"
115
+ queries.each { |q| notifications_str << " #{q}\n" }
116
+ notifications_str << "Call stack:\n"
117
+ kaller.each do |f|
118
+ notifications_str << " #{f}\n" unless f.include?(Bundler.bundle_path.to_s)
119
+ end
120
+ notifications_str << "\n"
121
+ end
122
+
123
+ Rails.logger.warn(notifications_str) if @rails_logger
124
+ $stderr.puts(notifications_str) if @stderr_logger
125
+
126
+ if @prosopite_logger
127
+ File.open(File.join(Rails.root, 'log', 'prosopite.log'), 'a') do |f|
128
+ f.puts(notifications_str)
129
+ end
130
+ end
131
+
132
+ raise NPlusOneQueriesError.new(notifications_str) if @raise
133
+ end
134
+
135
+ def subscribe
136
+ return if @subscribed
137
+ @subscribed = true
138
+
139
+ ActiveSupport::Notifications.subscribe 'sql.active_record' do |_, _, _, _, data|
140
+ sql = data[:sql]
141
+
142
+ if scan? && sql.include?('SELECT') && data[:cached].nil?
143
+ location_key = Digest::SHA1.hexdigest(caller.join)
144
+
145
+ @query_counter[location_key] += 1
146
+ @query_holder[location_key] << sql
147
+
148
+ if @query_counter[location_key] > 1
149
+ @query_caller[location_key] = caller.dup
150
+ end
151
+ end
152
+ end
153
+ end
154
+ end
155
+ end
data/prosopite.gemspec ADDED
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "lib/prosopite/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "prosopite"
7
+ spec.version = Prosopite::VERSION
8
+ spec.authors = ["Mpampis Kostas"]
9
+ spec.email = ["charkost.rb@gmail.com"]
10
+
11
+ spec.summary = "N+1 auto-detection for Rails with zero false positives / false negatives"
12
+ spec.description = "N+1 auto-detection for Rails with zero false positives / false negatives"
13
+ spec.homepage = "https://github.com/charkost/prosopite"
14
+ spec.license = "Apache-2.0"
15
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
16
+
17
+ spec.metadata["homepage_uri"] = spec.homepage
18
+ spec.metadata["source_code_uri"] = "https://github.com/charkost/prosopite"
19
+
20
+ # Specify which files should be added to the gem when it is released.
21
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
22
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
23
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
24
+ end
25
+ spec.require_paths = ["lib"]
26
+
27
+ spec.add_runtime_dependency 'pg_query', '~> 1.3.0'
28
+
29
+ spec.add_development_dependency "pry"
30
+ spec.add_development_dependency "minitest"
31
+ spec.add_development_dependency "factory_bot"
32
+ spec.add_development_dependency "activerecord"
33
+ spec.add_development_dependency "sqlite3"
34
+ end
metadata ADDED
@@ -0,0 +1,139 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: prosopite
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.3
5
+ platform: ruby
6
+ authors:
7
+ - Mpampis Kostas
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-02-25 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: pg_query
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 1.3.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 1.3.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: pry
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: factory_bot
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: activerecord
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: sqlite3
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ description: N+1 auto-detection for Rails with zero false positives / false negatives
98
+ email:
99
+ - charkost.rb@gmail.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".github/workflows/ci.yml"
105
+ - ".gitignore"
106
+ - Gemfile
107
+ - Gemfile.lock
108
+ - LICENSE.txt
109
+ - README.md
110
+ - Rakefile
111
+ - lib/prosopite.rb
112
+ - lib/prosopite/version.rb
113
+ - prosopite.gemspec
114
+ homepage: https://github.com/charkost/prosopite
115
+ licenses:
116
+ - Apache-2.0
117
+ metadata:
118
+ homepage_uri: https://github.com/charkost/prosopite
119
+ source_code_uri: https://github.com/charkost/prosopite
120
+ post_install_message:
121
+ rdoc_options: []
122
+ require_paths:
123
+ - lib
124
+ required_ruby_version: !ruby/object:Gem::Requirement
125
+ requirements:
126
+ - - ">="
127
+ - !ruby/object:Gem::Version
128
+ version: 2.4.0
129
+ required_rubygems_version: !ruby/object:Gem::Requirement
130
+ requirements:
131
+ - - ">="
132
+ - !ruby/object:Gem::Version
133
+ version: '0'
134
+ requirements: []
135
+ rubygems_version: 3.1.2
136
+ signing_key:
137
+ specification_version: 4
138
+ summary: N+1 auto-detection for Rails with zero false positives / false negatives
139
+ test_files: []