gitlab-triage 1.14.3 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 274f8c4fdb85670a259e32f6c378512e93a52619184714baea85372f77e54c9b
-  data.tar.gz: 469563e881bb1678de111984c70cdd53c64abe241ab27b69ac206c262a10d078
+  metadata.gz: 75bd839eb28f1b1feee624b5591b623966520685ecf9577d66bd08eb68e25227
+  data.tar.gz: 6fe5843105229f7488bc6c5e54fb58269a928bd80df3b579163636639cd64f6b
 SHA512:
-  metadata.gz: 8d850e51292669d2763dfbf7f313fe49b24e99c1bce44a12322901a8dc9f164f1a09c96ff56c6b9fcd798fbc82f43aeed06ed6cf80ede7fb2ec517edbe49d631
-  data.tar.gz: ef78109d3c19698308979c36ef43d3f8e163c5d053f45e093f56dd8da05f6a1c34b5463339a6631944718c561b01ded46845b35924a3d1b1454ed0379faa3310
+  metadata.gz: d0f70cecc7cd0315143783856920a36970f63d834838ad26ca3210e2077f60859a54ae1208cb1c21d7ead6c718cae36900ad47724e43cbb3c1c3ad095441d715
+  data.tar.gz: 9044cb1de497e46b1b24f0e8ddf73da2fdd9d1dde178c4c0b1a5ff62e599c0581cb965f946ea14802a861180c9f37f72ba84fc972545b759644b528bb1865204

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
     - rubocop-default.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   Exclude:
     - 'vendor/**/*'
     - 'tmp/**/*'

data/README.md

@@ -38,6 +38,7 @@ The format of the file is [YAML](https://en.wikipedia.org/wiki/YAML).
 project.
 
 Select which resource to add the policy to:
+- `epics`
 - `issues`
 - `merge_requests`
 
@@ -47,9 +48,28 @@ For example:
 
 ```yml
 resource_rules:
+  epics:
+    rules:
+      - name: My epic policy
+        conditions:
+          date:
+            attribute: updated_at
+            condition: older_than
+            interval_type: days
+            interval: 5
+          state: opened
+          labels:
+            - None
+        actions:
+          labels:
+            - needs attention
+          mention:
+            - markglenfletcher
+          comment: |
+            {{author}} This epic is unlabelled after 5 days. It needs attention. Please take care of this before the end of #{2.days.from_now.strftime('%Y-%m-%d')}
   issues:
     rules:
-      - name: My policy
+      - name: My issue policy
         conditions:
           date:
             attribute: updated_at
@@ -86,7 +106,7 @@ resource_rules:
               /label ~"needs attention"
   merge_requests:
     rules:
-      - name: My policy
+      - name: My merge request policy
         conditions:
           state: opened
           labels:
@@ -585,6 +605,7 @@ Available action types:
 - [`comment` action](#comment-action)
 - [`comment_type` action option](#comment-type-action-option)
 - [`summarize` action](#summarize-action)
+- [`comment_on_summary` action](#comment-on-summary-action)
 
 ##### Labels action
 
@@ -796,8 +817,8 @@ Accepts a hash of fields.
 
 | Field         | Type   | Description                                     | Required | Placeholders | Ruby expression | Default        |
 | ----          | ----   | ----                                            | ----     | ----         | ----            | ----           |
-| `title`       | string | The title of the generated issue                | yes      | yes          | no              |                |
-| `destination` | integer or string | The project ID or path to create the generated issue in | no       | no           | no              | source project |
+| `title`       | string | The title of the generated issue                | yes      | yes          | yes             |                |
+| `destination` | integer or string | The project ID or path to create the generated issue in | no   | no              | no             | source project |
 | `item`        | string | Template representing each triaged resource     | no       | yes          | yes             |                |
 | `summary`     | string | The description of the generated issue          | no       | Only `{{title}}`, `{{items}}`, `{{type}}` | yes | |
 | `redact_confidential_resources` | boolean | Whether redact fields for confidential resources | no | no | no | true |
@@ -867,6 +888,56 @@ Which could generate an issue like:
   /label ~"needs attention"
   ```
 
+##### Comment on summary action
+
+Generates one comment for each resource, attaching these comments to the summary
+created by the [`summarize` action](#summarize-action).
+
+The use case for this is wanting to create a summary with an overview, and then
+a threaded discussion for each resource, with a header comment starting each
+discussion.
+
+Accepts a single string value: the template used to generate the comments. For
+details of the syntax of this template, see the [comment action](#comment-action).
+
+Since this action depends on the summary, it is invalid to supply a
+`comment_on_summary` action without an accompanying `summarize` sibling action.
+The `summarize` action will always be completed first.
+
+Just like for [comment action](#comment-action), setting `comment_type` in the
+`actions` set controls whether the comment must be resolved for merge requests.
+See: [`comment_type` action option](#comment-type-action-option).
+
+Example:
+
+```yml
+resource_rules:
+  issues:
+    rules:
+      - name: List of issues to discuss
+        limits:
+          most_recent: 15
+        actions:
+          comment_type: thread
+          comment_on_summary: |
+            # {{title}}
+
+            author: {{author}}
+          summarize:
+            title: |
+              #{resource[:type].capitalize} require labels
+            item: |
+              - [ ] [{{title}}]({{web_url}}) {{labels}}
+            summary: |
+              The following {{type}} require labels:
+
+              {{items}}
+
+              Please take care of them before the end of #{7.days.from_now.strftime('%Y-%m-%d')}
+
+              /label ~"needs attention"
+```
+
 ### Summary policies
 
 Summary policies are special policies that join multiple rule policies together

data/bin/gitlab-triage

@@ -3,6 +3,7 @@
 require 'yaml'
 require_relative '../lib/gitlab/triage/option_parser'
 require_relative '../lib/gitlab/triage/engine'
+require_relative '../lib/gitlab/triage/ui'
 
 options = Gitlab::Triage::OptionParser.parse(ARGV)
 options.policies_files << '.triage-policies.yml' if options.policies_files.empty?
@@ -10,7 +11,9 @@ 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))
 
-  Gitlab::Triage::Engine
+  policy_engine = Gitlab::Triage::Engine
     .new(policies: policies, options: options)
-    .perform
+
+  puts Gitlab::Triage::UI.header("Executing policies from #{policies_file}.", char: '*')
+  policy_engine.perform
 end

data/lib/gitlab/triage/action.rb

@@ -1,14 +1,18 @@
 require_relative 'action/summarize'
 require_relative 'action/comment'
+require_relative 'action/comment_on_summary'
 
 module Gitlab
   module Triage
     module Action
       def self.process(policy:, **args)
-        {
-          Summarize => policy.summarize?,
-          Comment => policy.comment?
-        }.compact.each do |action, active|
+        policy.validate!
+
+        [
+          [Summarize, policy.summarize?],
+          [Comment, policy.comment?],
+          [CommentOnSummary, policy.comment_on_summary?]
+        ].each do |action, active|
           act(action: action, policy: policy, **args) if active
         end
       end

data/lib/gitlab/triage/action/comment.rb

@@ -57,14 +57,17 @@ module Gitlab
         end
 
         def build_post_url(resource)
-          # POST /projects/:id/issues/:issue_iid/notes
-          post_url = UrlBuilders::UrlBuilder.new(
+          url_builder_opts = {
             network_options: network.options,
-            source_id: resource[:project_id],
+            source: policy.source,
+            source_id: resource[policy.source_id_sym],
             resource_type: policy.type,
-            resource_id: resource['iid'],
+            resource_id: resource_id(resource),
             sub_resource_type: sub_resource_type
-          ).build
+          }
+
+          # POST /(groups|projects)/:id/(epics|issues|merge_requests)/:iid/notes
+          post_url = UrlBuilders::UrlBuilder.new(url_builder_opts).build
 
           puts Gitlab::Triage::UI.debug "post_url: #{post_url}" if network.options.debug
 
@@ -81,6 +84,15 @@ module Gitlab
             raise ArgumentError, "Unknown comment type: #{type}"
           end
         end
+
+        def resource_id(resource)
+          case policy.type
+          when 'epics'
+            resource['id']
+          else
+            resource['iid']
+          end
+        end
       end
     end
   end

data/lib/gitlab/triage/action/comment_on_summary.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative '../command_builders/text_content_builder'
+require_relative '../command_builders/comment_command_builder'
+require_relative '../command_builders/label_command_builder'
+require_relative '../command_builders/remove_label_command_builder'
+require_relative '../command_builders/cc_command_builder'
+require_relative '../command_builders/status_command_builder'
+require_relative '../command_builders/move_command_builder'
+
+module Gitlab
+  module Triage
+    module Action
+      class CommentOnSummary < Base
+        class Dry < CommentOnSummary
+          def act
+            puts "The following comments would be posted for the rule **#{policy.name}**:\n\n"
+
+            super
+          end
+
+          private
+
+          def perform(comment)
+            puts "# #{summary[:web_url]}\n```\n#{comment}\n```\n"
+          end
+        end
+
+        attr_reader :summary
+
+        def initialize(policy:, network:)
+          super(policy: policy, network: network)
+          @summary = policy.summary
+        end
+
+        def act
+          policy.resources.each do |resource|
+            comment = build_comment(resource).strip
+
+            perform(comment) unless comment.empty?
+          end
+        end
+
+        private
+
+        def build_comment(resource)
+          CommandBuilders::TextContentBuilder.new(policy.actions[:comment_on_summary], resource: resource, network: network).build_command
+        end
+
+        def perform(comment)
+          network.post_api(build_post_url, body: comment)
+        end
+
+        def build_post_url
+          # POST /projects/:id/issues/:issue_iid/notes
+          post_url = UrlBuilders::UrlBuilder.new(
+            network_options: network.options,
+            source_id: summary['project_id'],
+            resource_type: policy.type,
+            resource_id: summary['iid'],
+            sub_resource_type: sub_resource_type
+          ).build
+
+          puts Gitlab::Triage::UI.debug "post_url: #{post_url}" if network.options.debug
+
+          post_url
+        end
+
+        def sub_resource_type
+          case type = policy.actions[:comment_type]
+          when 'comment', nil # nil is default
+            'notes'
+          when 'thread'
+            'discussions'
+          else
+            raise ArgumentError, "Unknown comment type: #{type}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/action/summarize.rb

@@ -10,6 +10,12 @@ module Gitlab
           private
 
           def perform
+            policy.summary = {
+              web_url: '[the-created-issue-url]',
+              project_id: 'some-id',
+              iid: 'some-iid'
+            }.with_indifferent_access
+
             if group_summary_without_destination?
               puts Gitlab::Triage::UI.warn("No issue will be created: No summary destination specified when source is 'groups'.")
               return
@@ -35,7 +41,7 @@ module Gitlab
             return
           end
 
-          network.post_api(post_issue_url, post_issue_body)
+          policy.summary = network.post_api(post_issue_url, post_issue_body)
         end
 
         def issue

data/lib/gitlab/triage/api_query_builders/date_query_param_builder.rb

@@ -1,57 +1,32 @@
-require_relative '../validators/params_validator'
+require_relative '../param_builders/date_param_builder'
+require_relative 'base_query_param_builder'
 
 module Gitlab
   module Triage
     module APIQueryBuilders
-      class DateQueryParamBuilder
+      class DateQueryParamBuilder < BaseQueryParamBuilder
         ATTRIBUTES = %w[updated_at created_at].freeze
-        CONDITIONS = %w[older_than newer_than].freeze
-        INTERVAL_TYPES = %w[days weeks months years].freeze
-
-        def self.filter_parameters
-          [
-            {
-              name: :attribute,
-              type: String,
-              values: ATTRIBUTES
-            },
-            {
-              name: :condition,
-              type: String,
-              values: CONDITIONS
-            },
-            {
-              name: :interval_type,
-              type: String,
-              values: INTERVAL_TYPES
-            },
-            {
-              name: :interval,
-              type: Numeric
-            }
-          ]
-        end
 
         def self.applicable?(condition)
           ATTRIBUTES.include?(condition[:attribute].to_s)
         end
 
         def initialize(condition_hash)
-          @attribute = condition_hash[:attribute].to_s
-          @interval_condition = condition_hash[:condition].to_sym
-          @interval_type = condition_hash[:interval_type]
-          @interval = condition_hash[:interval]
-          validate_condition(condition_hash)
+          date_param_builder = ParamBuilders::DateParamBuilder.new(ATTRIBUTES, condition_hash)
+
+          super(build_param_name(condition_hash), date_param_builder.param_content)
         end
 
-        def validate_condition(condition)
-          ParamsValidator.new(self.class.filter_parameters, condition).validate!
+        def param_content
+          param_contents
         end
 
-        def param_name
-          prefix = attribute.sub(/_at\z/, '')
+        private
+
+        def build_param_name(condition_hash)
+          prefix = condition_hash[:attribute].to_s.sub(/_at\z/, '')
           suffix =
-            case interval_condition
+            case condition_hash[:condition].to_sym
             when :older_than
               'before'
             when :newer_than
@@ -60,18 +35,6 @@ module Gitlab
 
           "#{prefix}_#{suffix}"
         end
-
-        def param_content
-          interval.public_send(interval_type).ago.to_date # rubocop:disable GitlabSecurity/PublicSend
-        end
-
-        def build_param
-          "&#{param_name}=#{param_content.strip}"
-        end
-
-        private
-
-        attr_reader :condition_hash, :attribute, :interval_condition, :interval_type, :interval
       end
     end
   end

data/lib/gitlab/triage/command_builders/label_command_builder.rb

@@ -14,7 +14,11 @@ module Gitlab
 
         def ensure_labels_exist!
           items.each do |label|
-            label_opts = { project_id: resource[:project_id], name: label }
+            source_id_key = resource.key?(:group_id) ? :group_id : :project_id
+            label_opts = {
+              source_id_key => resource[source_id_key],
+              name: label
+            }
 
             unless Resource::Label.new(label_opts, network: network).exist?
               raise Resource::Label::LabelDoesntExistError,

data/lib/gitlab/triage/engine.rb

@@ -37,6 +37,7 @@ module Gitlab
         issues: %w[opened closed],
         merge_requests: %w[opened closed merged]
       }.with_indifferent_access.freeze
+      EpicsTriagingForProjectImpossibleError = Class.new(StandardError)
 
       def initialize(policies:, options:, network_adapter_class: DEFAULT_NETWORK_ADAPTER, graphql_network_adapter_class: DEFAULT_GRAPHQL_ADAPTER)
         options.host_url = policies.delete(:host_url) { options.host_url }
@@ -62,6 +63,10 @@ module Gitlab
         puts
 
         resource_rules.each do |resource_type, resource|
+          if resource_type == 'epics' && options.source != :groups
+            raise(EpicsTriagingForProjectImpossibleError, "Epics can only be triaged at the group level. Please set the `--source groups` option.")
+          end
+
           puts Gitlab::Triage::UI.header("Processing rules for #{resource_type}", char: '-')
           puts
 
@@ -177,14 +182,23 @@ module Gitlab
         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(build_get_url(resource_type, conditions))
-          iids = resources.pluck('iid').map(&:to_s)
+          resources = []
+
+          if rule[:api] == 'graphql'
+            graphql_query = build_graphql_query(resource_type, conditions, true)
+            resources = graphql_network.query(graphql_query, source: source_full_path)
+          else
+            resources = network.query_api(build_get_url(resource_type, conditions))
+            iids = resources.pluck('iid').map(&:to_s)
+
+            graphql_query = build_graphql_query(resource_type, conditions)
+            graphql_resources = graphql_network.query(graphql_query, source: source_full_path, iids: iids) if graphql_query.any?
+
+            decorate_resources_with_graphql_data(resources, graphql_resources)
+          end
 
-          graphql_query = build_graphql_query(resource_type, conditions)
-          graphql_resources = graphql_network.query(graphql_query, source: options.source_id, iids: iids) if graphql_query.present?
           # In some filters/actions we want to know which resource type it is
           attach_resource_type(resources, resource_type)
-          decorate_resources_with_graphql_data(resources, graphql_resources)
 
           puts "\n\n* Found #{resources.count} resources..."
           print "* Filtering resources..."
@@ -199,10 +213,17 @@ module Gitlab
         end
       end
 
-      # We don't have to do this once the response will contain the type
-      # of the resource. For now let's just attach it.
       def attach_resource_type(resources, resource_type)
-        resources.each { |resource| resource[:type] ||= resource_type }
+        resources.each { |resource| resource[:type] = resource_type }
+        # TODO:                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+        # We should not overwrite the attribute here, but we need to
+        # fix it first. We should instead use something like
+        # gitlab_triage_resource_type so it won't conflict with the
+        # existing fields.
+        # And we need to retain the backward compatibility that using
+        # {{type}} will give us this value, rather than from the REST API,
+        # which will give us ISSUE from:
+        # https://gitlab.com/gitlab-org/gitlab/-/merge_requests/59648
       end
 
       def decorate_resources_with_graphql_data(resources, graphql_resources)
@@ -313,9 +334,24 @@ module Gitlab
         ).build
       end
 
-      def build_graphql_query(resource_type, conditions)
+      def build_graphql_query(resource_type, conditions, graphql_only = false)
         Gitlab::Triage::GraphqlQueries::QueryBuilder
-          .new(options.source, resource_type, conditions)
+          .new(options.source, resource_type, conditions, graphql_only: graphql_only)
+      end
+
+      def source_full_path
+        @source_full_path ||= fetch_source_full_path
+      end
+
+      def fetch_source_full_path
+        return options.source_id unless /\A\d+\z/.match?(options.source_id)
+
+        source_details = network.query_api(build_get_url(nil, {})).first
+        full_path = source_details['full_path'] || source_details['path_with_namespace']
+
+        raise ArgumentError, 'A source with given source_id was not found!' if full_path.blank?
+
+        full_path
       end
     end
   end