rubocop-isucon 0.1.0 → 0.2.0

data/lib/rubocop/cop/isucon/mysql2/select_asterisk.rb

@@ -26,144 +26,10 @@ module RuboCop
         #   db.xquery('SELECT users.id, users.name FROM users')
         #
         class SelectAsterisk < Base
-          include Mixin::DatabaseMethods
           include Mixin::Mysql2XqueryMethods
+          include Mixin::SelectAsteriskMethods
 
           extend AutoCorrector
-
-          MSG = "Use SELECT with column names. (e.g. `SELECT id, name FROM table_name`)"
-
-          TODO = "# TODO: Remove needless columns if necessary\n"
-
-          # @param node [RuboCop::AST::Node]
-          def on_send(node)
-            with_error_handling(node) do
-              with_xquery(node) do |type, root_gda|
-                next unless root_gda
-
-                check_and_register_offence(type: type, root_gda: root_gda, node: node)
-              end
-            end
-          end
-
-          private
-
-          # @param type [Symbol] Node type. one of `:str`, `:dstr`
-          # @param root_gda [RuboCop::Isucon::GDA::Client]
-          # @param node [RuboCop::AST::Node]
-          def check_and_register_offence(type:, root_gda:, node:)
-            root_gda.visit_all do |gda|
-              next unless gda.ast.respond_to?(:expr_list)
-
-              gda.ast.expr_list.each do |select_field_node|
-                check_and_register_offence_for_select_field_node(
-                  type: type, node: node, gda: gda,
-                  select_field_node: select_field_node
-                )
-              end
-            end
-          end
-
-          # @param type [Symbol] Node type. one of `:str`, `:dstr`
-          # @param node [RuboCop::AST::Node]
-          # @param gda [RuboCop::Isucon::GDA::Client]
-          # @param select_field_node [GDA::Nodes::SelectField]
-          def check_and_register_offence_for_select_field_node(type:, node:, gda:, select_field_node:)
-            return unless select_field_node.respond_to?(:expr)
-
-            select_field = parse_select_field_node(select_field_node)
-
-            return unless select_field[:column_name] == "*"
-
-            loc = offense_location(type: type, node: node, gda_location: select_field_node.expr.location)
-            return unless loc
-
-            add_offense(loc) do |corrector|
-              perform_autocorrect(corrector: corrector, loc: loc, gda: gda, node: node,
-                                  select_table_name: select_field[:table_name])
-            end
-          end
-
-          # @param select_field_node [GDA::Nodes::SelectField]
-          # @return [Hash<Symbol, String>] table_name, column_name
-          def parse_select_field_node(select_field_node)
-            column_elements = select_field_node.expr.value.split(".", 2)
-
-            case column_elements.count
-            when 1
-              return { column_name: column_elements[0] }
-            when 2
-              return { table_name: column_elements[0], column_name: column_elements[1] }
-            end
-
-            {}
-          end
-
-          # @param corrector [RuboCop::Cop::Corrector]
-          # @param loc [Parser::Source::Range]
-          # @param gda [RuboCop::Isucon::GDA::Client]
-          # @param node [RuboCop::AST::Node]
-          # @param select_table_name [String,nil] table names included in the SELECT clause
-          def perform_autocorrect(corrector:, loc:, gda:, node:, select_table_name:)
-            return unless enabled_database?
-            return if gda.table_names.empty?
-
-            if select_table_name
-              return unless gda.table_names.include?(select_table_name)
-
-              replace_asterisk(corrector: corrector, loc: loc, table_name: select_table_name, table_prefix: true)
-            else
-              return unless gda.table_names.length == 1
-
-              replace_asterisk(corrector: corrector, loc: loc, table_name: gda.table_names[0], table_prefix: false)
-            end
-
-            insert_todo_comment(corrector: corrector, node: node)
-          end
-
-          # @param corrector [RuboCop::Cop::Corrector]
-          # @param loc [Parser::Source::Range]
-          # @param table_name [String]
-          # @param table_prefix [Boolean] Whether add table name to prefix (e.g. `users`.`name`)
-          def replace_asterisk(corrector:, loc:, table_name:, table_prefix:)
-            select_columns = columns_in_select_clause(table_name: table_name, table_prefix: table_prefix)
-            corrector.replace(loc, select_columns)
-          end
-
-          # @param table_name [String]
-          # @param table_prefix [Boolean] Whether add table name to prefix (e.g. `users`.`name`)
-          # @return [String]
-          def columns_in_select_clause(table_name:, table_prefix:)
-            column_names = connection.column_names(table_name)
-
-            column_names.map do |column|
-              if table_prefix
-                "`#{table_name}`.`#{column}`"
-              else
-                "`#{column}`"
-              end
-            end.join(", ")
-          end
-
-          # @param corrector [RuboCop::Cop::Corrector]
-          # @param node [RuboCop::AST::Node]
-          def insert_todo_comment(corrector:, node:)
-            current_line = node.loc.expression.line
-            current_line_range = node.loc.expression.source_buffer.line_range(current_line)
-
-            indent = node_indent_level(node)
-            comment_line = (" " * indent) + TODO
-            corrector.insert_before(current_line_range, comment_line)
-          end
-
-          # @param node [RuboCop::AST::Node]
-          # @return [Integer]
-          def node_indent_level(node)
-            node.loc.expression.source_line =~ /^(\s+)/
-            return 0 unless Regexp.last_match(1)
-
-            Regexp.last_match(1).length
-          end
         end
       end
     end

data/lib/rubocop/cop/isucon/mysql2/where_without_index.rb

@@ -19,84 +19,19 @@ module RuboCop
         #   db.xquery('SELECT id, title FROM articles WHERE id = ?', id)
         #
         class WhereWithoutIndex < Base
-          include Mixin::DatabaseMethods
           include Mixin::Mysql2XqueryMethods
+          include Mixin::WhereWithoutIndexMethods
 
           MSG = "This where clause doesn't seem to have an index. " \
                 "(e.g. `ALTER TABLE %<table_name>s ADD INDEX index_%<column_name>s (%<column_name>s)`)"
 
-          # @param node [RuboCop::AST::Node]
-          def on_send(node)
-            with_error_handling(node) do
-              return unless enabled_database?
-
-              with_xquery(node) do |type, root_gda|
-                next unless root_gda
-                next if exists_index_in_where_clause_columns?(root_gda)
-
-                register_offense(type: type, node: node, root_gda: root_gda)
-              end
-            end
-          end
-
           private
 
-          # @param type [Symbol] Node type. one of `:str`, `:dstr`
-          # @param node [RuboCop::AST::Node]
-          # @param root_gda [RuboCop::Isucon::GDA::Client]
-          def register_offense(type:, node:, root_gda:)
-            root_gda.visit_all do |gda|
-              next if gda.where_nodes.empty?
-
-              loc = offense_location(type: type, node: node, gda_location: gda.where_nodes.first.location)
-              next unless loc
-
-              message = offense_message(gda)
-              add_offense(loc, message: message)
-            end
-          end
-
-          # @param gda [RuboCop::Isucon::GDA::Client]
-          def offense_message(gda)
-            column_name = gda.where_conditions[0].column_operand
-            table_name = find_table_name_from_column_name(table_names: gda.table_names, column_name: column_name)
-            format(MSG, table_name: table_name, column_name: column_name)
-          end
-
-          # @param root_gda [RuboCop::Isucon::GDA::Client]
-          # @return [Boolean]
-          def exists_index_in_where_clause_columns?(root_gda)
-            root_gda.visit_all do |gda|
-              gda.table_names.each do |table_name|
-                return true if covered_where_column_in_index?(gda: gda, table_name: table_name)
-                return true if covered_where_column_in_primary_key?(gda: gda, table_name: table_name)
-              end
-            end
-
-            false
-          end
-
-          # @param gda [RuboCop::Isucon::GDA::Client]
-          # @param table_name [String]
-          # @return [Boolean]
-          def covered_where_column_in_index?(gda:, table_name:)
-            indexes = connection.indexes(table_name)
-            index_first_columns = indexes.map { |index| index.columns[0] }
-
-            gda.where_conditions.any? do |condition|
-              index_first_columns.include?(condition.column_operand)
-            end
-          end
-
-          # @param gda [RuboCop::Isucon::GDA::Client]
           # @param table_name [String]
-          # @return [Boolean]
-          def covered_where_column_in_primary_key?(gda:, table_name:)
-            primary_keys = connection.primary_keys(table_name)
-            return false if primary_keys.empty?
-
-            where_columns = gda.where_conditions.map(&:column_operand)
-            primary_keys.all? { |primary_key| where_columns.include?(primary_key) }
+          # @param column_name [String]
+          # @return [String]
+          def generate_offense_message(table_name:, column_name:)
+            format(MSG, table_name: table_name, column_name: column_name)
           end
         end
       end

data/lib/rubocop/cop/isucon/sqlite3/join_without_index.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Isucon
+      module Sqlite3
+        # Check for `JOIN` without index
+        #
+        # @note If `Database` isn't configured, this cop's feature (offense detection and auto-correct) will not be available.
+        #
+        # @example
+        #   # bad (user_id is not indexed)
+        #   db.execute('SELECT id, title FROM articles JOIN users ON users.id = articles.user_id')
+        #
+        #   # good (user_id is indexed)
+        #   db.execute('SELECT id, title FROM articles JOIN users ON users.id = articles.user_id')
+        #
+        class JoinWithoutIndex < Base
+          include Mixin::Sqlite3ExecuteMethods
+          include Mixin::JoinWithoutIndexMethods
+
+          MSG = "This join clause doesn't seem to have an index. " \
+                "(e.g. `CREATE INDEX index_%<table_name>s_%<column_name>s ON %<table_name>s (%<column_name>s)`)"
+
+          private
+
+          # @param table_name [String]
+          # @param column_name [String]
+          # @return [String]
+          def generate_offense_message(table_name:, column_name:)
+            format(MSG, table_name: table_name, column_name: column_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/isucon/sqlite3/many_join_table.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Isucon
+      module Sqlite3
+        # Check if SQL contains many JOINs
+        #
+        # @example CountTables: 3 (default)
+        #   # bad
+        #   totals = db.execute(
+        #     "SELECT IFNULL(SUM(`submissions`.`score`), 0) AS `total_score`" \
+        #     " FROM `users`" \
+        #     " JOIN `registrations` ON `users`.`id` = `registrations`.`user_id`" \
+        #     " JOIN `courses` ON `registrations`.`course_id` = `courses`.`id`" \
+        #     " LEFT JOIN `classes` ON `courses`.`id` = `classes`.`course_id`" \
+        #     " LEFT JOIN `submissions` ON `users`.`id` = `submissions`.`user_id` AND `submissions`.`class_id` = `classes`.`id`" \
+        #     " WHERE `courses`.`id` = ?" \
+        #     " GROUP BY `users`.`id`",
+        #     [course[:id]]
+        #   ).map { |_| _[:total_score] }
+        #
+        #   # good
+        #   registration_users_count =
+        #     db.execute("SELECT COUNT(`user_id`) AS cnt FROM `registrations` WHERE `course_id` = ?", [course[:id]]).first[:cnt]
+        #
+        #   totals = db.execute(<<~SQL, course[:id]).map { |_| _[:total_score] }
+        #     SELECT IFNULL(SUM(`submissions`.`score`), 0) AS `total_score`
+        #     FROM `submissions`
+        #     JOIN `classes` ON `classes`.`id` = `submissions`.`class_id`
+        #     WHERE `classes`.`course_id` = ?
+        #     GROUP BY `submissions`.`user_id`
+        #   SQL
+        #
+        #   if totals.count < registration_users_count
+        #     no_submissions_count = registration_users_count - totals.count
+        #     totals += [0] * no_submissions_count
+        #   end
+        #
+        # @example CountTables: 5
+        #   # good
+        #   totals = db.execute(
+        #     "SELECT IFNULL(SUM(`submissions`.`score`), 0) AS `total_score`" \
+        #     " FROM `users`" \
+        #     " JOIN `registrations` ON `users`.`id` = `registrations`.`user_id`" \
+        #     " JOIN `courses` ON `registrations`.`course_id` = `courses`.`id`" \
+        #     " LEFT JOIN `classes` ON `courses`.`id` = `classes`.`course_id`" \
+        #     " LEFT JOIN `submissions` ON `users`.`id` = `submissions`.`user_id` AND `submissions`.`class_id` = `classes`.`id`" \
+        #     " WHERE `courses`.`id` = ?" \
+        #     " GROUP BY `users`.`id`",
+        #     [course[:id]]
+        #   ).map { |_| _[:total_score] }
+        #
+        class ManyJoinTable < Base
+          include Mixin::Sqlite3ExecuteMethods
+          include Mixin::ManyJoinTableMethods
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/isucon/sqlite3/n_plus_one_query.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Isucon
+      module Sqlite3
+        # rubocop:disable Layout/LineLength
+
+        # Checks that N+1 query is not used
+        #
+        # @note If `Database` isn't configured, auto-correct will not be available. (Only offense detection can be used)
+        #
+        # @note For the number of N+1 queries that can be detected by this cop, there are too few that can be corrected automatically
+        #
+        # @example
+        #   # bad
+        #   reservations = db.execute('SELECT * FROM `reservations` WHERE `schedule_id` = ?', [schedule_id]).map do |reservation|
+        #     reservation[:user] = db.execute('SELECT * FROM `users` WHERE `id` = ? LIMIT 1', [id]).first
+        #     reservation
+        #   end
+        #
+        #   # good
+        #   rows = db.xquery(<<~SQL, [schedule_id])
+        #     SELECT
+        #       r.id AS reservation_id,
+        #       r.schedule_id AS reservation_schedule_id,
+        #       r.user_id AS reservation_user_id,
+        #       r.created_at AS reservation_created_at,
+        #       u.id AS user_id,
+        #       u.email AS user_email,
+        #       u.nickname AS user_nickname,
+        #       u.staff AS user_staff,
+        #       u.created_at AS user_created_at
+        #     FROM `reservations` AS r
+        #     INNER JOIN users u ON u.id = r.user_id
+        #     WHERE r.schedule_id = ?
+        #   SQL
+        #
+        #   # bad
+        #   courses.map do |course|
+        #     teacher = db.execute('SELECT * FROM `users` WHERE `id` = ?', [course[:teacher_id]]).first
+        #   end
+        #
+        #   # good
+        #   # This is similar to ActiveRecord's preload
+        #   # c.f. https://guides.rubyonrails.org/active_record_querying.html#preload
+        #   courses.map do |course|
+        #     @users_by_id ||= db.execute('SELECT * FROM `users` WHERE `id` IN (?)', [courses.map { |course| course[:teacher_id] }]).each_with_object({}) { |v, hash| hash[v[:id]] = v }
+        #     teacher = @users_by_id[course[:teacher_id]]
+        #   end
+        #
+        class NPlusOneQuery < Base
+          # rubocop:enable Layout/LineLength
+
+          include Mixin::Sqlite3ExecuteMethods
+          include Mixin::NPlusOneQueryMethods
+
+          extend AutoCorrector
+
+          private
+
+          # [Boolean]
+          def array_arg?
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/isucon/sqlite3/select_asterisk.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Isucon
+      module Sqlite3
+        # Avoid `SELECT *` in `db.execute`
+        #
+        # @note If `Database` isn't configured, auto-correct will not be available. (Only offense detection can be used)
+        #
+        # @note This cop replaces `SELECT *` with a `SELECT` by the columns present in the table (e.g. `SELECT id, name`),
+        #       but does not check whether the columns are actually used.
+        #       Please manually delete unused columns after auto corrected
+        #
+        # @example
+        #   # bad
+        #   db.execute('SELECT * FROM users')
+        #
+        #   # bad
+        #   db.execute('SELECT users.* FROM users')
+        #
+        #   # good
+        #   db.execute('SELECT id, name FROM users')
+        #
+        #   # good
+        #   db.execute('SELECT users.id, users.name FROM users')
+        #
+        class SelectAsterisk < Base
+          include Mixin::Sqlite3ExecuteMethods
+          include Mixin::SelectAsteriskMethods
+
+          extend AutoCorrector
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/isucon/sqlite3/where_without_index.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Isucon
+      module Sqlite3
+        # Check for `WHERE` without index
+        #
+        # @note If `Database` isn't configured, this cop's feature (offense detection and auto-correct) will not be available.
+        #
+        # @example
+        #   # bad (user_id is not indexed)
+        #   db.execute('SELECT id, title FROM articles WHERE used_id = ?', [user_id])
+        #
+        #   # good (user_id is indexed)
+        #   db.execute('SELECT id, title FROM articles WHERE used_id = ?', [user_id])
+        #
+        #   # good (id is primary key)
+        #   db.execute('SELECT id, title FROM articles WHERE id = ?', [id])
+        #
+        class WhereWithoutIndex < Base
+          include Mixin::Sqlite3ExecuteMethods
+          include Mixin::WhereWithoutIndexMethods
+
+          MSG = "This where clause doesn't seem to have an index. " \
+                "(e.g. `CREATE INDEX index_%<table_name>s_%<column_name>s ON %<table_name>s (%<column_name>s)`)"
+
+          private
+
+          # @param table_name [String]
+          # @param column_name [String]
+          # @return [String]
+          def generate_offense_message(table_name:, column_name:)
+            format(MSG, table_name: table_name, column_name: column_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/isucon_cops.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
 require_relative "isucon/mixin/database_methods"
+require_relative "isucon/mixin/join_without_index_methods"
+require_relative "isucon/mixin/offense_location_methods"
+require_relative "isucon/mixin/many_join_table_methods"
 require_relative "isucon/mixin/mysql2_xquery_methods"
+require_relative "isucon/mixin/n_plus_one_query_methods"
+require_relative "isucon/mixin/select_asterisk_methods"
 require_relative "isucon/mixin/sinatra_methods"
+require_relative "isucon/mixin/sqlite3_execute_methods"
+require_relative "isucon/mixin/where_without_index_methods"
 
-require_relative "isucon/correctors/mysql2_n_plus_one_query_corrector"
+require_relative "isucon/correctors/n_plus_one_query_corrector"
 
 require_relative "isucon/mysql2/join_without_index"
 require_relative "isucon/mysql2/many_join_table"
@@ -18,3 +25,8 @@ require_relative "isucon/sinatra/rack_logger"
 require_relative "isucon/sinatra/serve_static_file"
 require_relative "isucon/shell/backtick"
 require_relative "isucon/shell/system"
+require_relative "isucon/sqlite3/join_without_index"
+require_relative "isucon/sqlite3/many_join_table"
+require_relative "isucon/sqlite3/n_plus_one_query"
+require_relative "isucon/sqlite3/select_asterisk"
+require_relative "isucon/sqlite3/where_without_index"

data/lib/rubocop/isucon/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Isucon
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-isucon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - sue445
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-23 00:00:00.000000000 Z
+date: 2022-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -221,12 +221,19 @@ files:
 - gemfiles/activerecord_6_1.gemfile
 - gemfiles/activerecord_7_0.gemfile
 - lib/rubocop-isucon.rb
-- lib/rubocop/cop/isucon/correctors/mysql2_n_plus_one_query_corrector.rb
-- lib/rubocop/cop/isucon/correctors/mysql2_n_plus_one_query_corrector/correctable_methods.rb
-- lib/rubocop/cop/isucon/correctors/mysql2_n_plus_one_query_corrector/replace_methods.rb
+- lib/rubocop/cop/isucon/correctors/n_plus_one_query_corrector.rb
+- lib/rubocop/cop/isucon/correctors/n_plus_one_query_corrector/correctable_methods.rb
+- lib/rubocop/cop/isucon/correctors/n_plus_one_query_corrector/replace_methods.rb
 - lib/rubocop/cop/isucon/mixin/database_methods.rb
+- lib/rubocop/cop/isucon/mixin/join_without_index_methods.rb
+- lib/rubocop/cop/isucon/mixin/many_join_table_methods.rb
 - lib/rubocop/cop/isucon/mixin/mysql2_xquery_methods.rb
+- lib/rubocop/cop/isucon/mixin/n_plus_one_query_methods.rb
+- lib/rubocop/cop/isucon/mixin/offense_location_methods.rb
+- lib/rubocop/cop/isucon/mixin/select_asterisk_methods.rb
 - lib/rubocop/cop/isucon/mixin/sinatra_methods.rb
+- lib/rubocop/cop/isucon/mixin/sqlite3_execute_methods.rb
+- lib/rubocop/cop/isucon/mixin/where_without_index_methods.rb
 - lib/rubocop/cop/isucon/mysql2/join_without_index.rb
 - lib/rubocop/cop/isucon/mysql2/many_join_table.rb
 - lib/rubocop/cop/isucon/mysql2/n_plus_one_query.rb
@@ -239,6 +246,11 @@ files:
 - lib/rubocop/cop/isucon/sinatra/logger.rb
 - lib/rubocop/cop/isucon/sinatra/rack_logger.rb
 - lib/rubocop/cop/isucon/sinatra/serve_static_file.rb
+- lib/rubocop/cop/isucon/sqlite3/join_without_index.rb
+- lib/rubocop/cop/isucon/sqlite3/many_join_table.rb
+- lib/rubocop/cop/isucon/sqlite3/n_plus_one_query.rb
+- lib/rubocop/cop/isucon/sqlite3/select_asterisk.rb
+- lib/rubocop/cop/isucon/sqlite3/where_without_index.rb
 - lib/rubocop/cop/isucon_cops.rb
 - lib/rubocop/isucon.rb
 - lib/rubocop/isucon/database_connection.rb