gitlab-styles 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d23f16df66558ac47e1084f4558dbf68589e7c81a3e99056e193500962c6608
-  data.tar.gz: 0aedb037f3ef8a90a2c3c0c80945949832eaa52da9ec5c3f872d8fc24157f300
+  metadata.gz: 2ffa11a484785184125888f8cc6716080d991e43672b0fb173aa7752ca67caba
+  data.tar.gz: 4e4a4d2349213d8696f838893865d6ebe4f7a865bc61355977c37f32ac4748dd
 SHA512:
-  metadata.gz: 478c9a5284aeb471ca82131d10496ce730126c1a66fb87f6a369153bb4ef65850fef4a92834cc5ac23ea66ef000afdbc2803a05fded8332a14eee08673aa4c36
-  data.tar.gz: 1675434965d80d42e2ffd7fff89eb84460d6bc70c4971e3fcf826273a118a55967a96446addf8454d851ebbbf097adf33a5f0498de1fb8c4b2e63b47a8ca103a
+  metadata.gz: 3568f7eb05f54bcf76640c2a6a53149e4ffc73f0affb6840f2dfc43c59152db7ca7c60b3d06441cfc0399ba1cce8bd23c3667549174ba5c3f282b6be721bf091
+  data.tar.gz: ae89b5dd974632887e8142fcf9a89bb511ddbab969380ba6abd4daa990d3ad67916e95cb39c7394f659a8b9e787257270c557a6fa9579def27f3fcd2e578d364

data/Gemfile

@@ -9,4 +9,5 @@ group :test do
   # Pin these dependencies, otherwise a new rule could break the CI pipelines
   gem 'rubocop', '0.82.0'
   gem 'rubocop-rspec', '1.36.0'
+  gem 'rspec-parameterized', '0.4.2', require: false
 end

data/README.md

@@ -42,6 +42,7 @@ rules:
 - `rubocop-gemspec.yml`
 - `rubocop-layout.yml`
 - `rubocop-lint.yml`
+- `rubocop-migrations.yml`
 - `rubocop-metrics.yml`
 - `rubocop-naming.yml`
 - `rubocop-performance.yml`

data/lib/gitlab/styles/rubocop.rb

@@ -8,6 +8,7 @@ require 'gitlab/styles/rubocop/cop/polymorphic_associations'
 require 'gitlab/styles/rubocop/cop/active_record_dependent'
 require 'gitlab/styles/rubocop/cop/in_batches'
 require 'gitlab/styles/rubocop/cop/line_break_after_guard_clauses'
+require 'gitlab/styles/rubocop/cop/migration/update_large_table'
 require 'gitlab/styles/rubocop/cop/without_reactive_cache'
 require 'gitlab/styles/rubocop/cop/rspec/single_line_hook'
 require 'gitlab/styles/rubocop/cop/rspec/have_link_parameters'

data/lib/gitlab/styles/rubocop/cop/migration/update_large_table.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require_relative '../../migration_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Migration
+          # This cop checks for methods that may lead to batch type issues on a table that's been
+          # explicitly denied because of its size.
+          #
+          # Even though though these methods perform functions to avoid
+          # downtime, using it with tables with millions of rows still causes a
+          # significant delay in the deploy process and is best avoided.
+          #
+          # See https://gitlab.com/gitlab-com/infrastructure/issues/1602 for more
+          # information.
+          class UpdateLargeTable < RuboCop::Cop::Cop
+            include MigrationHelpers
+
+            MSG = 'Using `%s` on the `%s` table will take a long time to ' \
+              'complete, and should be avoided unless absolutely ' \
+              'necessary'
+
+            def_node_matcher :batch_update?, <<~PATTERN
+              (send nil? ${#denied_method?}
+                (sym $...)
+                ...)
+            PATTERN
+
+            def on_send(node)
+              return if denied_tables.empty? || denied_methods.empty?
+              return unless in_migration?(node)
+
+              matches = batch_update?(node)
+              return unless matches
+
+              update_method = matches.first
+              table = matches.last.to_a.first
+
+              return unless denied_tables.include?(table)
+
+              add_offense(node, location: :expression, message: format(MSG, update_method, table))
+            end
+
+            private
+
+            def denied_tables
+              cop_config['DeniedTables'] || []
+            end
+
+            def denied_method?(method_name)
+              denied_methods.include?(method_name)
+            end
+
+            def denied_methods
+              cop_config['DeniedMethods'] || []
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Styles
-    VERSION = '4.0.0'
+    VERSION = '4.1.0'
   end
 end

data/rubocop-default.yml

@@ -12,6 +12,7 @@ inherit_from:
   - rubocop-layout.yml
   - rubocop-lint.yml
   - rubocop-metrics.yml
+  - rubocop-migrations.yml
   - rubocop-naming.yml
   - rubocop-performance.yml
   - rubocop-rails.yml

data/rubocop-migrations.yml

@@ -0,0 +1,21 @@
+# Checks for methods that may lead to batch type issues on a table that's been
+# explicitly denied because of its size.
+#
+# Even though these methods perform functions to avoid
+# downtime, using it with tables with millions of rows still causes a
+# significant delay in the deploy process and is best avoided.
+#
+# See https://gitlab.com/gitlab-com/infrastructure/issues/1602 for more
+# information.
+# The default can be changed as follows:
+#     Migration/UpdateLargeTable:
+#       DeniedTables:
+#         - :usage_data
+#         - :version_checks
+#       DeniedMethods:
+#         - :add_column_with_default
+#         - :change_column_type_concurrently
+#         - :rename_column_concurrently
+#         - :update_column_in_batches
+Migration/UpdateLargeTable:
+  Enabled: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -152,6 +152,7 @@ files:
 - lib/gitlab/styles/rubocop/cop/gem_fetcher.rb
 - lib/gitlab/styles/rubocop/cop/in_batches.rb
 - lib/gitlab/styles/rubocop/cop/line_break_after_guard_clauses.rb
+- lib/gitlab/styles/rubocop/cop/migration/update_large_table.rb
 - lib/gitlab/styles/rubocop/cop/polymorphic_associations.rb
 - lib/gitlab/styles/rubocop/cop/redirect_with_status.rb
 - lib/gitlab/styles/rubocop/cop/rspec/have_link_parameters.rb
@@ -168,6 +169,7 @@ files:
 - rubocop-layout.yml
 - rubocop-lint.yml
 - rubocop-metrics.yml
+- rubocop-migrations.yml
 - rubocop-naming.yml
 - rubocop-performance.yml
 - rubocop-rails.yml