gitlab-triage 1.14.3 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 274f8c4fdb85670a259e32f6c378512e93a52619184714baea85372f77e54c9b
-  data.tar.gz: 469563e881bb1678de111984c70cdd53c64abe241ab27b69ac206c262a10d078
+  metadata.gz: a2927188b4b24b36453f4bac48a82b9af7d2ddc33bb7b5219f533282da9e8370
+  data.tar.gz: 8d35707ba7d219950ab3ba8dda852e89687f16b360cf1f368ae02038ff3ff7cb
 SHA512:
-  metadata.gz: 8d850e51292669d2763dfbf7f313fe49b24e99c1bce44a12322901a8dc9f164f1a09c96ff56c6b9fcd798fbc82f43aeed06ed6cf80ede7fb2ec517edbe49d631
-  data.tar.gz: ef78109d3c19698308979c36ef43d3f8e163c5d053f45e093f56dd8da05f6a1c34b5463339a6631944718c561b01ded46845b35924a3d1b1454ed0379faa3310
+  metadata.gz: 12def4c673ceb025d1a286c9c10a53c410d037364865482b85500bff9215d6490e6d0fcc2737f859a8bbeeba5a302c5e2ff6cbddfc7bab1599e909c243240d67
+  data.tar.gz: b98bbed0aabc5cf72595f5dbb3b60ce8d5bb25ad4af19aff1de46c34642ac15c7dc367db39ad1092833a97a923ac73957768bf14b5ed06ccb8bfd518e5fdbdc2

data/README.md

@@ -585,6 +585,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
 
@@ -867,6 +868,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/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_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/engine.rb

@@ -181,7 +181,7 @@ module Gitlab
           iids = resources.pluck('iid').map(&:to_s)
 
           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?
+          graphql_resources = graphql_network.query(graphql_query, source: source_full_path, 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)
@@ -317,6 +317,21 @@ module Gitlab
         Gitlab::Triage::GraphqlQueries::QueryBuilder
           .new(options.source, resource_type, conditions)
       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
 end

data/lib/gitlab/triage/errors/network.rb

@@ -3,6 +3,7 @@ module Gitlab
     module Errors
       module Network
         InternalServerError = Class.new(StandardError)
+        UnexpectedResponse = Class.new(StandardError)
       end
     end
   end

data/lib/gitlab/triage/graphql_network.rb

@@ -11,6 +11,8 @@ module Gitlab
     class GraphqlNetwork
       attr_reader :options, :adapter
 
+      MINIMUM_RATE_LIMIT = 25
+
       def initialize(adapter)
         @adapter = adapter
         @options = adapter.options
@@ -33,6 +35,9 @@ module Gitlab
             variables: variables.merge(after: response.delete(:end_cursor))
           )
 
+          rate_limit_debug(response) if options.debug
+          rate_limit_wait(response)
+
           resources.concat(Array.wrap(response.delete(:results)))
         end while response.delete(:more_pages)
 
@@ -49,6 +54,18 @@ module Gitlab
 
         GlobalID.parse(global_id).model_id.to_i
       end
+
+      def rate_limit_debug(response)
+        rate_limit_infos = "Rate limit remaining: #{response[:ratelimit_remaining]} (reset at #{response[:ratelimit_reset_at]})"
+        puts Gitlab::Triage::UI.debug "rate_limit_infos: #{rate_limit_infos}"
+      end
+
+      def rate_limit_wait(response)
+        return unless response.delete(:ratelimit_remaining) < MINIMUM_RATE_LIMIT
+
+        puts Gitlab::Triage::UI.debug "Rate limit almost exceeded, sleeping for #{response[:ratelimit_reset_at] - Time.now} seconds" if options.debug
+        sleep(1) until Time.now >= response[:ratelimit_reset_at]
+      end
     end
   end
 end

data/lib/gitlab/triage/network.rb

@@ -44,8 +44,10 @@ module Gitlab
           case results
           when Array
             resources.concat(results)
-          else
+          when Hash
             resources << results
+          else
+            raise Errors::Network::UnexpectedResponse, "Unexpected response: #{results.inspect}"
           end
 
           rate_limit_debug(response) if options.debug

data/lib/gitlab/triage/network_adapters/graphql_adapter.rb

@@ -1,3 +1,4 @@
+require 'httparty'
 require 'graphql/client'
 require 'graphql/client/http'
 
@@ -17,16 +18,22 @@ module Gitlab
           raise_on_error!(response)
 
           parsed_response = parse_response(response, resource_path)
+          headers = response.extensions.fetch('headers', {})
 
-          return { results: {} } if parsed_response.nil?
-          return { results: parsed_response.map(&:to_h) } if parsed_response.is_a?(Client::List)
-          return { results: parsed_response.to_h } unless parsed_response.nodes?
+          graphql_response = {
+            ratelimit_remaining: headers['ratelimit-remaining'].to_i,
+            ratelimit_reset_at: Time.at(headers['ratelimit-reset'].to_i)
+          }
+
+          return graphql_response.merge(results: {}) if parsed_response.nil?
+          return graphql_response.merge(results: parsed_response.map(&:to_h)) if parsed_response.is_a?(Client::List)
+          return graphql_response.merge(results: parsed_response.to_h) unless parsed_response.nodes?
 
-          {
+          graphql_response.merge(
             more_pages: parsed_response.page_info.has_next_page,
             end_cursor: parsed_response.page_info.end_cursor,
             results: parsed_response.nodes.map(&:to_h)
-          }
+          )
         end
 
         delegate :parse, to: :client
@@ -47,11 +54,27 @@ module Gitlab
 
         def http_client
           Client::HTTP.new("#{options.host_url}/api/graphql") do
-            def headers(context) # rubocop:disable Lint/NestedMethodDefinition
-              {
-                'Content-type' => 'application/json',
-                'PRIVATE-TOKEN' => context[:token]
-              }
+            def execute(document:, operation_name: nil, variables: {}, context: {}) # rubocop:disable Lint/NestedMethodDefinition
+              body = {}
+              body['query'] = document.to_query_string
+              body['variables'] = variables if variables.any?
+              body['operationName'] = operation_name if operation_name
+
+              response = HTTParty.post(
+                uri,
+                body: body.to_json,
+                headers: {
+                  'Content-type' => 'application/json',
+                  'PRIVATE-TOKEN' => context[:token]
+                }
+              )
+
+              case response.code
+              when 200, 400
+                JSON.parse(response.body).merge('extensions' => { 'headers' => response.headers })
+              else
+                { 'errors' => [{ 'message' => "#{response.code} #{response.message}" }] }
+              end
             end
           end
         end

data/lib/gitlab/triage/policies/base_policy.rb

@@ -4,7 +4,10 @@ module Gitlab
   module Triage
     module Policies
       class BasePolicy
+        InvalidPolicyError = Class.new(StandardError)
+
         attr_reader :type, :policy_spec, :resources, :network
+        attr_accessor :summary
 
         def initialize(type, policy_spec, resources, network)
           @type = type
@@ -13,6 +16,10 @@ module Gitlab
           @network = network
         end
 
+        def validate!
+          raise InvalidPolicyError, 'Policies that comment_on_summary must include summarize action' if comment_on_summary? && !summarize?
+        end
+
         def name
           @name ||= (policy_spec[:name] || "#{type}-#{object_id}")
         end
@@ -25,9 +32,13 @@ module Gitlab
           actions.key?(:summarize)
         end
 
+        def comment_on_summary?
+          actions.key?(:comment_on_summary)
+        end
+
         def comment?
           # The actual keys are strings
-          (actions.keys.map(&:to_sym) - [:summarize]).any?
+          (actions.keys.map(&:to_sym) - [:summarize, :comment_on_summary]).any?
         end
 
         def build_issue

data/lib/gitlab/triage/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Triage
-    VERSION = '1.14.3'
+    VERSION = '1.15.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 1.14.3
+  version: 1.15.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -162,6 +162,7 @@ files:
 - lib/gitlab/triage/action.rb
 - lib/gitlab/triage/action/base.rb
 - lib/gitlab/triage/action/comment.rb
+- lib/gitlab/triage/action/comment_on_summary.rb
 - lib/gitlab/triage/action/summarize.rb
 - lib/gitlab/triage/api_query_builders/base_query_param_builder.rb
 - lib/gitlab/triage/api_query_builders/date_query_param_builder.rb