gitlab-triage 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ab21a6dffa12d92f9321ac3c6d2bc0c92627fad703fceb7ebf68494d8f5b259
-  data.tar.gz: e5868058935e55d70ccadaada8030a8bec92dee6ceeeea2f9996cd60f3823cdf
+  metadata.gz: 0b8300cf129b3aefc203d528814c84eb8e06fa54154599b1b4e818f9365ab93c
+  data.tar.gz: e9d4b656207d0fa3322e10cd8618d6ac4bed5122b02f2dca34220d576cf81f57
 SHA512:
-  metadata.gz: a875bebf70cd7dcc2a6c5f064d692535cdf98b664323fb640b22fed7f52ac4d5f49e8b21adb5b4942f626e4f4638d23f3042109ae13c495ae9c732d177e9298f
-  data.tar.gz: 01a627062e23ba73d40be5cc7260a92aa7be9ec30b9fb694585305ae919435174099a701d6045998c03738ee7fd7dcf0cac9ebf821abfea9b4697fd6f8f55e06
+  metadata.gz: 2ceb150c8d07902495e80852aa914c91a14bbd82f84ab4123713f086282a5a7445bb141228eb50a9caef65d78957aecc0e889ec948a95193c046d659feaf31ba
+  data.tar.gz: b5e183ed3ab41aea72b54c4eb790d24e61c2422297d652139b22170da2cab69a04fe38e07e5de0ba9c99d95fd1a0a9c8c3169a7241f62bafffb94c2947a5263b

data/README.md

@@ -46,6 +46,8 @@ resource_rules:
           state: opened
           labels:
             - No Label
+        limits:
+          most_recent: 50
         actions:
           labels:
             - needs attention
@@ -63,6 +65,7 @@ resource_rules:
 A policy consists of the following fields:
 - [Name field](#name-field)
 - [Conditions field](#conditions-field)
+- [Limits field](#limits-field)
 - [Actions field](#actions-field)
 
 #### Name field
@@ -381,6 +384,30 @@ Here's a list of currently available API:
 | succ        | Milestone   | The next active milestone beside this milestone |
 | active?     | Boolean     | `true` if `state` is `active`; `false` otherwise |
 
+#### Limits field
+
+Limits restrict the number of resources on which an action is carried out. They
+can be useful when combined with conditions that return a large number of
+resources. For example, if the conditions are satisfied by thousands of issues a
+limit can be configured to process only fifty of them to avoid making an
+overwhelming number of changes at once.
+
+Accepts a key and value pair where the key is `most_recent` or `oldest`and the
+value is the number of resources to act on. The following table outlines how
+each key affects the sorting and order of resources that it limits.
+
+| Name / Key    | Sorted by    | Order      |
+| ---------     | ----         | ------     |
+| `most_recent` | `created_at` | descending |
+| `oldest`      | `created_at` | ascending  |
+
+Example:
+
+```yml
+limits:
+  most_recent: 50
+```
+
 #### Actions field
 
 Used to declare an action to be carried out on a resource if **all** conditions are satisfied.

data/lib/gitlab/triage/engine.rb

@@ -8,6 +8,7 @@ require_relative 'filters/no_additional_labels_conditions_filter'
 require_relative 'filters/author_member_conditions_filter'
 require_relative 'filters/assignee_member_conditions_filter'
 require_relative 'filters/ruby_conditions_filter'
+require_relative 'limiters/date_field_limiter'
 require_relative 'command_builders/comment_body_builder'
 require_relative 'command_builders/comment_command_builder'
 require_relative 'command_builders/label_command_builder'
@@ -88,20 +89,27 @@ module Gitlab
         rule.fetch(:actions) { {} }
       end
 
+      def rule_limits(rule)
+        rule.fetch(:limits) { {} }
+      end
+
       def process_rule(resource_type, rule)
         ExpandCondition.perform(rule_conditions(rule)) do |conditions|
           # retrieving the resources for every rule is inefficient
           # however, previous rules may affect those upcoming
           resources = network.query_api(options.token, build_get_url(resource_type, conditions))
           puts "\n\n* Found #{resources.count} resources..."
+          print "* Filtering resources..."
+          resources = filter_resources(resources, conditions)
+          puts "\n* Total after filtering: #{resources.count} resources"
           print "* Limiting resources..."
-          resources = limit_resources(resources, conditions)
-          puts "\n* Total resource after limiting: #{resources.count} resources"
+          resources = limit_resources(resources, rule_limits(rule))
+          puts "\n* Total after limiting: #{resources.count} resources"
           process_resources(resource_type, resources, rule)
         end
       end
 
-      def limit_resources(resources, conditions)
+      def filter_resources(resources, conditions)
         net = { host_url: host_url, api_version: api_version, token: options.token, network: network }
 
         resources.select do |resource|
@@ -119,6 +127,14 @@ module Gitlab
         end
       end
 
+      def limit_resources(resources, limits)
+        if limits.empty?
+          resources
+        else
+          Limiters::DateFieldLimiter.new(resources, limits).limit
+        end
+      end
+
       def process_resources(resource_type, resources, rule)
         if options.dry_run
           puts "\nThe following comments would be posted for the rule **#{rule[:name]}**:\n\n"

data/lib/gitlab/triage/filters/base_conditions_filter.rb

@@ -1,4 +1,5 @@
 require 'active_support/all'
+require_relative '../validators/params_validator'
 
 module Gitlab
   module Triage
@@ -47,33 +48,10 @@ module Gitlab
         private
 
         def validate_condition(condition)
-          validate_required_parameters(condition)
-          validate_parameter_types(condition)
-          validate_parameter_content(condition)
+          ParamsValidator.new(self.class.filter_parameters, condition).validate!
         end
 
         def initialize_variables(condition); end
-
-        def validate_required_parameters(condition)
-          self.class.filter_parameters.each do |param|
-            raise ArgumentError, "#{param[:name]} is a required parameter" unless condition[param[:name]]
-          end
-        end
-
-        def validate_parameter_types(condition)
-          self.class.filter_parameters.each do |param|
-            param_types = Array(param[:type]).flatten
-            raise ArgumentError, "#{param[:name]} must be of type #{param[:type]}" unless param_types.any? { |type| condition[param[:name]].is_a?(type) }
-          end
-        end
-
-        def validate_parameter_content(condition)
-          self.class.filter_parameters.each do |param|
-            if param[:values]
-              raise ArgumentError, "#{param[:name]} must be of one of #{param[:values].join(',')}" unless param[:values].include?(condition[param[:name]])
-            end
-          end
-        end
       end
     end
   end

data/lib/gitlab/triage/limiters/base_limiter.rb

@@ -0,0 +1,35 @@
+require 'active_support/all'
+
+module Gitlab
+  module Triage
+    module Limiters
+      class BaseLimiter
+        def initialize(resources, limit)
+          @resources = initialize_resources(resources)
+          validate_limit(limit)
+          initialize_variables(limit)
+        end
+
+        def limit
+          raise NotImplementedError
+        end
+
+        def self.limiter_parameters
+          []
+        end
+
+        private
+
+        def initialize_variables(limit); end
+
+        def initialize_resources(resources)
+          resources
+        end
+
+        def validate_limit(limit)
+          LimiterValidator.new(self.class.limiter_parameters, limit).validate!
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/limiters/date_field_limiter.rb

@@ -0,0 +1,45 @@
+require_relative 'base_limiter'
+require_relative '../validators/limiter_validator'
+
+module Gitlab
+  module Triage
+    module Limiters
+      class DateFieldLimiter < BaseLimiter
+        LIMITS = %i[most_recent oldest].freeze
+
+        def self.limiter_parameters
+          [
+            {
+              name: :most_recent,
+              type: Integer
+            },
+            {
+              name: :oldest,
+              type: Integer
+            }
+          ]
+        end
+
+        def initialize_variables(limit)
+          @criterion = LIMITS.find(&limit.method(:[]))
+          @threshold = limit[@criterion]
+        end
+
+        def limit
+          case @criterion
+          when :most_recent
+            @resources.first(@threshold)
+          when :oldest
+            @resources.last(@threshold)
+          end
+        end
+
+        private
+
+        def initialize_resources(resources)
+          resources.sort_by { |res| res[:created_at] }
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/validators/limiter_validator.rb

@@ -0,0 +1,19 @@
+require_relative 'params_validator'
+
+module Gitlab
+  module Triage
+    class LimiterValidator < ParamsValidator
+      private
+
+      def params_limiter_names
+        @parameter_definitions.map do |param|
+          param[:name]
+        end
+      end
+
+      def validate_required_parameters(value)
+        raise ArgumentError, "For the limits field, please specify one of: `#{params_limiter_names.join('`, `')}`" unless value.keys.map(&:to_sym).one? { |key| params_limiter_names.include?(key) }
+      end
+    end
+  end
+end

data/lib/gitlab/triage/validators/params_validator.rb

@@ -0,0 +1,41 @@
+module Gitlab
+  module Triage
+    class ParamsValidator
+      def initialize(parameter_definitions, value)
+        @parameter_definitions = parameter_definitions
+        @value = value
+      end
+
+      def validate!
+        validate_required_parameters(@value)
+        validate_parameter_types(@value)
+        validate_parameter_content(@value)
+      end
+
+      private
+
+      def validate_required_parameters(value)
+        @parameter_definitions.each do |param|
+          raise ArgumentError, "#{param[:name]} is a required parameter" unless value[param[:name]]
+        end
+      end
+
+      def validate_parameter_types(value)
+        @parameter_definitions.each do |param|
+          if value.has_key?(param[:name])
+            param_types = Array(param[:type]).flatten
+            raise ArgumentError, "#{param[:name]} must be of type #{param[:type]}" unless param_types.any? { |type| value[param[:name]].is_a?(type) }
+          end
+        end
+      end
+
+      def validate_parameter_content(value)
+        @parameter_definitions.each do |param|
+          if param[:values]
+            raise ArgumentError, "#{param[:name]} must be of one of #{param[:values].join(',')}" unless param[:values].include?(value[param[:name]])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Triage
-    VERSION = '0.7.0'.freeze
+    VERSION = '0.8.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-10 00:00:00.000000000 Z
+date: 2018-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -155,6 +155,8 @@ files:
 - lib/gitlab/triage/filters/no_additional_labels_conditions_filter.rb
 - lib/gitlab/triage/filters/ruby_conditions_filter.rb
 - lib/gitlab/triage/filters/votes_conditions_filter.rb
+- lib/gitlab/triage/limiters/base_limiter.rb
+- lib/gitlab/triage/limiters/date_field_limiter.rb
 - lib/gitlab/triage/network.rb
 - lib/gitlab/triage/network_adapters/base_adapter.rb
 - lib/gitlab/triage/network_adapters/httparty_adapter.rb
@@ -165,6 +167,8 @@ files:
 - lib/gitlab/triage/retryable.rb
 - lib/gitlab/triage/ui.rb
 - lib/gitlab/triage/url_builders/url_builder.rb
+- lib/gitlab/triage/validators/limiter_validator.rb
+- lib/gitlab/triage/validators/params_validator.rb
 - lib/gitlab/triage/version.rb
 - support/.gitlab-ci.example.yml
 - support/.triage-policies.example.yml