gitlab-triage 1.41.0 → 1.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eb3292f79448004c49e7196b24da06e6609f5a0215a985472c95de9aeac4150
-  data.tar.gz: f6f94b45be9c7fe6cc43732e3d953455dad93e7246d69ea81162a91f6557a862
+  metadata.gz: 2cd7bbbde45634c445e721eba9e30e348f0d1fef2428a008d4f417f32b8184f7
+  data.tar.gz: 283dfe4c32c0ca14c5fbdb984c0661a522bcd1afa59af97816fc01008e30e48e
 SHA512:
-  metadata.gz: 2b9866966f5f200c25500af8679d2206e413fdd212dba09bbf48ae63d4cb55bf1415b0afded9f308864657f5246fe55cb859769fb2564aa49b4bb0adc946145a
-  data.tar.gz: d662bcbe691135305db76078e76d67be3073273ba4c3dd4f39d5a98a649be5ed0ed06c280869549a3bb3e7bceb74942a34aa8312e3a514ebfec835b1f343f5bd
+  metadata.gz: 1d80bbebf6eb2ce0eb319b8fa65ec6575e5b654135c431216a72e6486ba370a15dbc2b4bbb6c21350c08d215c98670d985ce7400d6c5072f0b79fe78551df0e9
+  data.tar.gz: 3a0f7060d8a6caaa63d89cafad80b3a0962e8198f9d1e4f09aab8671aeba1270f8770163599475ac7bbb33e39ad83660e7d55875425176df75fba8dd8d9f3e90

data/README.md

@@ -4,6 +4,10 @@
 
 This project allows to automate triaging of issues and merge requests for GitLab projects or groups.
 
+## Note this Gem is not supported by the GitLab Support team
+
+If you are a customer who has a GitLab License, **support for this gem is not covered by that license agreement as this is not part of the GitLab Product**. Feel free to open an issue in this project and the maintainers may be able to help.
+
 ## gitlab-triage gem
 
 ### Abstract
@@ -180,6 +184,7 @@ Available condition types:
 - [`target_branch` condition](#target-branch-condition)
 - [`health_status` condition](#health-status-condition)
 - [`weight` condition](#weight-condition)
+- [`issue_type` condition](#issue-type-condition)
 - [`discussions` condition](#discussions-condition)
 - [`protected` condition](#protected-condition)
 - [`ruby` condition](#ruby-condition)
@@ -609,6 +614,25 @@ conditions:
   weight: Any
 ```
 
+##### Issue type condition
+
+**This condition is only applicable for issues.**
+
+Accepts a string per the [API documentation](https://docs.gitlab.com/ee/api/issues.html#list-issues). This condition can only filter by one issue type.
+
+| Issue type      | Type    | Value       |
+| ---------       | ----    | ------      |
+| Regular issue   | string  | `issue`     |
+| Incident        | string  | `incident`  |
+| Test case       | string  | `test_case` |
+
+Example:
+
+```yml
+conditions:
+  issue_type: issue
+```
+
 ##### Discussions condition
 
 Accepts a hash of fields.

data/bin/gitlab-triage

@@ -9,7 +9,11 @@ options = Gitlab::Triage::OptionParser.parse(ARGV)
 options.policies_files << '.triage-policies.yml' if options.policies_files.empty?
 
 options.policies_files.each do |policies_file|
-  policies = HashWithIndifferentAccess.new(YAML.load_file(policies_file))
+  policies = if Psych::VERSION >= '4.0'
+               HashWithIndifferentAccess.new(YAML.load_file(policies_file, aliases: true))
+             else
+               HashWithIndifferentAccess.new(YAML.load_file(policies_file))
+             end
 
   policy_engine = Gitlab::Triage::Engine
     .new(policies: policies, options: options)

data/gitlab-triage.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'GitLab triage automation project.'
   spec.homepage      = 'https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
@@ -31,6 +31,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 5.1'
   spec.add_dependency 'globalid', '~> 0.4'
   spec.add_dependency 'graphql-client', '~> 0.16'
+  # Workaround - pin graphql version
+  # see: https://github.com/github/graphql-client/issues/310
+  # see: https://github.com/rmosolgo/graphql-ruby/pull/4577
+  # see: https://github.com/github/graphql-client/pull/314
+  # We can remove this check once PR 314 is merged and released
+  spec.add_dependency 'graphql', '< 2.1.0'
   spec.add_dependency 'httparty', '~> 0.17'
 
   spec.add_development_dependency 'bundler'

data/lib/gitlab/triage/engine.rb

@@ -35,6 +35,25 @@ module Gitlab
     class Engine
       attr_reader :per_page, :policies, :options
 
+      # This filter map is used to help make the filter_resource method
+      # smaller. We loop through each of the keys (conditions) and map
+      # that to the filters that will be used for it.
+      FILTER_MAP = {
+        date: {
+          'branches' => Filters::BranchDateFilter,
+          'issues' => Filters::IssueDateConditionsFilter,
+          'merge_requests' => Filters::MergeRequestDateConditionsFilter
+        },
+        protected: Filters::BranchProtectedFilter,
+        assignee_member: Filters::AssigneeMemberConditionsFilter,
+        author_member: Filters::AuthorMemberConditionsFilter,
+        discussions: Filters::DiscussionsConditionsFilter,
+        no_additional_labels: Filters::NoAdditionalLabelsConditionsFilter,
+        ruby: Filters::RubyConditionsFilter,
+        votes: Filters::VotesConditionsFilter,
+        upvotes: Filters::VotesConditionsFilter
+      }.freeze
+
       DEFAULT_NETWORK_ADAPTER = Gitlab::Triage::NetworkAdapters::HttpartyAdapter
       DEFAULT_GRAPHQL_ADAPTER = Gitlab::Triage::NetworkAdapters::GraphqlAdapter
       ALLOWED_STATE_VALUES = {
@@ -361,6 +380,8 @@ module Gitlab
           puts "\n* Total after limiting: #{resources.count} resources"
           puts
 
+          resources = sanitize_resources(resources)
+
           yield(PoliciesResources::RuleResources.new(resources), expanded_conditions)
         end
       end
@@ -416,61 +437,47 @@ module Gitlab
         puts
       end
 
-      def filter_resources(resources, conditions) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+      def filter_resources(resources, conditions)
         resources.select do |resource|
-          results = []
-
-          # rubocop:disable Style/IfUnlessModifier
-          if conditions[:date]
-            case resource[:type]
-            when 'branches'
-              results << Filters::BranchDateFilter.new(resource, conditions[:date]).calculate
-            when 'issues'
-              if conditions.dig(:date, :filter_in_ruby)
-                results << Filters::IssueDateConditionsFilter.new(resource, conditions[:date]).calculate
-              end
-            when 'merge_requests'
-              if conditions.dig(:date, :filter_in_ruby) ||
-                  # REST API does not support filtering with merged_at,
-                  # so we have to filter it in Ruby
-                  conditions.dig(:date, :attribute) == 'merged_at'
-                results << Filters::MergeRequestDateConditionsFilter.new(resource, conditions[:date]).calculate
-              end
-            end
-          end
-
-          if resource[:type] == 'branches'
-            results << Filters::BranchProtectedFilter.new(resource, conditions[:protected]).calculate
-          end
-
-          votes_condition = conditions[:votes] || conditions[:upvotes]
-          if votes_condition
-            results << Filters::VotesConditionsFilter.new(resource, votes_condition).calculate
-          end
-
-          if conditions[:no_additional_labels]
-            results << Filters::NoAdditionalLabelsConditionsFilter.new(resource, conditions.fetch(:labels) { [] }).calculate
-          end
+          filter_resource(resource, conditions)
+        end
+      end
 
-          if conditions[:author_member]
-            results << Filters::AuthorMemberConditionsFilter.new(resource, conditions[:author_member], network).calculate
-          end
+      def filter_resource(resource, conditions)
+        results = []
 
-          if conditions[:assignee_member]
-            results << Filters::AssigneeMemberConditionsFilter.new(resource, conditions[:assignee_member], network).calculate
-          end
+        FILTER_MAP.each do |condition_key, filter_value|
+          # Skips to the next key value pair if the condition is not applicable
+          next unless conditions[condition_key]
 
-          if conditions[:discussions]
-            results << Filters::DiscussionsConditionsFilter.new(resource, conditions[:discussions]).calculate
-          end
+          case filter_value
+          when Hash
+            filter_in_ruby = conditions[condition_key].dig(:filter_in_ruby)
+            merged_at = conditions[condition_key].dig(:attribute) == 'merged_at'
+            filter_branch = conditions.dig(:date) && resource[:type] == 'branches'
 
-          if conditions[:ruby]
-            results << Filters::RubyConditionsFilter.new(resource, conditions, network).calculate
+            # Set the filter to the resource type
+            if filter_in_ruby || merged_at || filter_branch
+              filter = filter_value[resource[:type]]
+              results << filter.new(resource, conditions[condition_key]).calculate
+            end
+          else
+            # The `filter_value` set is not of type `hash`
+            filter = filter_value
+
+            # If the :ruby condition exists then filter based off of conditions
+            # else we base off of the `conditions[condition_key]`.
+            results <<
+              if condition_key.to_s == 'no_additional_labels'
+                filter.new(resource, conditions[:labels]).calculate
+              elsif filter.instance_method(:initialize).arity == 2
+                filter.new(resource, conditions[condition_key]).calculate
+              else
+                filter.new(resource, conditions[condition_key], network).calculate
+              end
           end
-          # rubocop:enable Style/IfUnlessModifier
-
-          results.all?
         end
+        results.all?
       end
 
       def limit_resources(resources, limits)
@@ -481,6 +488,13 @@ module Gitlab
         end
       end
 
+      def sanitize_resources(resources)
+        resources.each do |resource|
+          # Titles should not contain newlines. Translate them to spaces.
+          resource[:title]&.tr!("\r\n", '  ')
+        end
+      end
+
       # rubocop:disable Metrics/AbcSize
       # rubocop:disable Metrics/CyclomaticComplexity
       def build_get_url(resource_type, conditions)
@@ -574,6 +588,7 @@ module Gitlab
           condition_builders << APIQueryBuilders::SingleQueryParamBuilder.new('weight', conditions[:weight]) if conditions[:weight]
           condition_builders << iteration_condition_builder(conditions[:iteration]) if conditions[:iteration]
           condition_builders << APIQueryBuilders::SingleQueryParamBuilder.new('health_status', conditions[:health_status]) if conditions[:health_status]
+          condition_builders << APIQueryBuilders::SingleQueryParamBuilder.new('issue_type', conditions[:issue_type]) if conditions[:issue_type]
         end
       end
 

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

@@ -11,7 +11,7 @@ module Gitlab
         end
 
         def initialize(resource, condition, network = nil)
-          super(resource, condition)
+          super(resource, { ruby: condition })
 
           @network = network
         end

data/lib/gitlab/triage/graphql_queries/query_builder.rb

@@ -1,6 +1,6 @@
 require_relative 'query_param_builders/base_param_builder'
 require_relative 'query_param_builders/date_param_builder'
-require_relative 'query_param_builders/labels_param_builder'
+require_relative 'query_param_builders/array_param_builder'
 
 module Gitlab
   module Triage
@@ -15,6 +15,9 @@ module Gitlab
             '$source: ID!',
             '$after: String'
           ]
+
+          has_any_iids = conditions.each_key.find { |key| key.to_s == 'iids' }
+          @resource_declarations << '$iids: [String!]' if has_any_iids
         end
 
         def resource_path
@@ -88,15 +91,12 @@ module Gitlab
             condition_queries << QueryParamBuilders::DateParamBuilder.new(condition_params) if condition.to_s == 'date'
             condition_queries << QueryParamBuilders::BaseParamBuilder.new('milestoneTitle', condition_params) if condition.to_s == 'milestone'
             condition_queries << QueryParamBuilders::BaseParamBuilder.new('state', condition_params, with_quotes: false) if condition.to_s == 'state'
-
-            if condition.to_s == 'iids'
-              @resource_declarations << '$iids: [String!]'
-              condition_queries << QueryParamBuilders::BaseParamBuilder.new('iids', '$iids', with_quotes: false)
-            end
+            condition_queries << QueryParamBuilders::BaseParamBuilder.new('iids', '$iids', with_quotes: false) if condition.to_s == 'iids'
 
             case resource_type
             when 'issues'
               condition_queries << issues_label_query(condition, condition_params)
+              condition_queries << issues_type_query(condition, condition_params)
             when 'merge_requests'
               condition_queries << merge_requests_label_query(condition, condition_params)
               condition_queries << merge_requests_resource_query(condition, condition_params)
@@ -120,7 +120,13 @@ module Gitlab
               return nil
             end
 
-          QueryParamBuilders::LabelsParamBuilder.new(*args[0...-1], **args.last)
+          QueryParamBuilders::ArrayParamBuilder.new(*args[0...-1], **args.last)
+        end
+
+        def issues_type_query(condition, condition_params)
+          return unless condition.to_s == 'issue_type'
+
+          QueryParamBuilders::ArrayParamBuilder.new('types', [condition_params.upcase], with_quotes: false)
         end
 
         def merge_requests_resource_query(condition, condition_params)
@@ -150,7 +156,7 @@ module Gitlab
               return nil
             end
 
-          QueryParamBuilders::LabelsParamBuilder.new(*args[0...-1], **args.last)
+          QueryParamBuilders::ArrayParamBuilder.new(*args[0...-1], **args.last)
         end
       end
     end

data/lib/gitlab/triage/graphql_queries/query_param_builders/array_param_builder.rb

@@ -0,0 +1,27 @@
+require_relative '../../utils'
+require_relative 'base_param_builder'
+
+module Gitlab
+  module Triage
+    module GraphqlQueries
+      module QueryParamBuilders
+        class ArrayParamBuilder < BaseParamBuilder
+          def initialize(param_name, values, with_quotes: true, negated: false)
+            quoted_values = values.map do |value|
+              if with_quotes
+                Utils.graphql_quote(value)
+              else
+                value
+              end
+            end
+
+            array_param_content =
+              quoted_values.join(', ').then { |content| "[#{content}]" }
+
+            super(param_name, array_param_content, with_quotes: false, negated: negated)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Triage
-    VERSION = '1.41.0'
+    VERSION = '1.42.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 1.41.0
+  version: 1.42.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -211,9 +225,9 @@ files:
 - lib/gitlab/triage/filters/votes_conditions_filter.rb
 - lib/gitlab/triage/graphql_network.rb
 - lib/gitlab/triage/graphql_queries/query_builder.rb
+- lib/gitlab/triage/graphql_queries/query_param_builders/array_param_builder.rb
 - lib/gitlab/triage/graphql_queries/query_param_builders/base_param_builder.rb
 - lib/gitlab/triage/graphql_queries/query_param_builders/date_param_builder.rb
-- lib/gitlab/triage/graphql_queries/query_param_builders/labels_param_builder.rb
 - lib/gitlab/triage/limiters/base_limiter.rb
 - lib/gitlab/triage/limiters/date_field_limiter.rb
 - lib/gitlab/triage/network.rb
@@ -267,7 +281,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/gitlab/triage/graphql_queries/query_param_builders/labels_param_builder.rb

@@ -1,18 +0,0 @@
-require_relative '../../utils'
-require_relative 'base_param_builder'
-
-module Gitlab
-  module Triage
-    module GraphqlQueries
-      module QueryParamBuilders
-        class LabelsParamBuilder < BaseParamBuilder
-          def initialize(param_name, labels, negated: false)
-            label_param_content = labels.map { |label| Utils.graphql_quote(label) }.join(', ').then { |content| "[#{content}]" }
-
-            super(param_name, label_param_content, with_quotes: false, negated: negated)
-          end
-        end
-      end
-    end
-  end
-end