gitlab-triage 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68fbfe16d2db2547d8b262ff52cb7065860d13822a92b38d6d505234aafa0855
-  data.tar.gz: 99dc42b1125665a331b8dd6afe576e1c0b8b0abbd0cf8239d5be44184e900c52
+  metadata.gz: 817c2b22f9f62ba6ec09e4441aea29dd4f7ae639bd8b49888236ff11a27e33a9
+  data.tar.gz: fbd6f4fff1adc6e99e271d438fe7ced46cc40db7a83c59ae985a156d9f57a414
 SHA512:
-  metadata.gz: 37e60f6230d1467d18246aa4dc52f439c08939f5a7e2278ed543090c08d5c08b39bffc2840543cbd0a702480d8fbeeb65dc7932fe90a98c2d26a88c8b19f3805
-  data.tar.gz: 8f82804d8431b08791f3e37974a0cc47aacec887af2969f3e612cba8ac8212e0ac6a25f4235424801b01f6eb0d5bc6db72535d0fed1f962658270164613034cd
+  metadata.gz: bab557c9169e861a96fce7b471080194943da6753541860ec3bb01d8790b43bc1c604a59d8fa3e73a0e4dd8dac735dec98746ff2e8a6c97d78d3ee7d87681fa1
+  data.tar.gz: 76a6ce14b74488879f14ca43bb0dcbd1b8d2f22e55d1ce7ee7b4cca5efd42715f462eac219c9f5f40de2a81060aa0c4e58e87db8dd3f1e90788a74c1c61b8f2c

data/README.md

@@ -142,6 +142,7 @@ Available condition types:
 - [`source_branch` condition](#source-branch-condition)
 - [`target_branch` condition](#target-branch-condition)
 - [`weight` condition](#weight-condition)
+- [`discussions` condition](#discussions-condition)
 - [`ruby` condition](#ruby-condition)
 
 ##### Date condition
@@ -486,6 +487,26 @@ conditions:
   weight: Any
 ```
 
+##### Discussions condition
+
+Accepts a hash of fields.
+
+| Field           | Type    | Values                              | Required  |
+| ---------       | ----    | ----                                | --------  |
+| `attribute`     | string  | `threads`, `notes`                  | yes       |
+| `condition`     | string  | `less_than`, `greater_than`         | yes       |
+| `threshold`     | integer | integer                             | yes       |
+
+Example:
+
+```yml
+conditions:
+  discussions:
+    attribute: threads
+    condition: greater_than
+    threshold: 15
+```
+
 ##### Ruby condition
 
 This condition allows users to write a Ruby expression to be evaluated for

data/gitlab-triage.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '~> 5.1'
+  spec.add_dependency 'globalid', '~> 0.4'
+  spec.add_dependency 'graphql-client', '~> 0.16'
   spec.add_dependency 'httparty', '~> 0.17'
 
   spec.add_development_dependency 'bundler'

data/lib/gitlab/triage/engine.rb

@@ -7,6 +7,7 @@ require_relative 'filters/votes_conditions_filter'
 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/discussions_conditions_filter'
 require_relative 'filters/ruby_conditions_filter'
 require_relative 'limiters/date_field_limiter'
 require_relative 'action'
@@ -19,7 +20,10 @@ require_relative 'api_query_builders/single_query_param_builder'
 require_relative 'api_query_builders/multi_query_param_builder'
 require_relative 'url_builders/url_builder'
 require_relative 'network'
+require_relative 'graphql_network'
 require_relative 'network_adapters/httparty_adapter'
+require_relative 'network_adapters/graphql_adapter'
+require_relative 'graphql_queries/query_builder'
 require_relative 'ui'
 
 module Gitlab
@@ -27,7 +31,10 @@ module Gitlab
     class Engine
       attr_reader :per_page, :policies, :options
 
-      def initialize(policies:, options:, network_adapter_class: Gitlab::Triage::NetworkAdapters::HttpartyAdapter)
+      DEFAULT_NETWORK_ADAPTER = Gitlab::Triage::NetworkAdapters::HttpartyAdapter
+      DEFAULT_GRAPHQL_ADAPTER = Gitlab::Triage::NetworkAdapters::GraphqlAdapter
+
+      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 }
         options.api_version = policies.delete(:api_version) { 'v4' }
         options.dry_run = ENV['TEST'] == 'true' if options.dry_run.nil?
@@ -36,6 +43,7 @@ module Gitlab
         @policies = policies
         @options = options
         @network_adapter_class = network_adapter_class
+        @graphql_network_adapter_class = graphql_network_adapter_class
 
         assert_all!
         assert_project_id!
@@ -62,6 +70,10 @@ module Gitlab
         @network ||= Network.new(network_adapter)
       end
 
+      def graphql_network
+        @graphql_network ||= GraphqlNetwork.new(graphql_network_adapter)
+      end
+
       private
 
       def assert_project_id!
@@ -94,6 +106,10 @@ module Gitlab
         @network_adapter ||= @network_adapter_class.new(options)
       end
 
+      def graphql_network_adapter
+        @graphql_network_adapter ||= @graphql_network_adapter_class.new(options)
+      end
+
       def rule_conditions(rule)
         rule.fetch(:conditions) { {} }
       end
@@ -158,8 +174,11 @@ module Gitlab
           # 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))
+          graphql_query = build_graphql_query(resource_type, conditions)
+          graphql_resources = graphql_network.query(graphql_query, source: options.source_id) 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..."
@@ -180,6 +199,13 @@ module Gitlab
         resources.each { |resource| resource[:type] ||= resource_type }
       end
 
+      def decorate_resources_with_graphql_data(resources, graphql_resources)
+        return if graphql_resources.nil?
+
+        graphql_resources_by_id = graphql_resources.to_h { |resource| [resource[:id], resource] }
+        resources.each { |resource| resource.merge!(graphql_resources_by_id[resource[:id]].to_h) }
+      end
+
       def process_action(policy)
         Action.process(
           policy: policy,
@@ -213,6 +239,10 @@ module Gitlab
             results << Filters::AssigneeMemberConditionsFilter.new(resource, conditions[:assignee_member], network).calculate
           end
 
+          if conditions[:discussions]
+            results << Filters::DiscussionsConditionsFilter.new(resource, conditions[:discussions]).calculate
+          end
+
           if conditions[:ruby]
             results << Filters::RubyConditionsFilter.new(resource, conditions, network).calculate
           end
@@ -270,6 +300,11 @@ module Gitlab
           params: params
         ).build
       end
+
+      def build_graphql_query(resource_type, conditions)
+        Gitlab::Triage::GraphqlQueries::QueryBuilder
+          .new(options.source, resource_type, conditions)
+      end
     end
   end
 end

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

@@ -0,0 +1,60 @@
+require_relative 'base_conditions_filter'
+
+module Gitlab
+  module Triage
+    module Filters
+      class DiscussionsConditionsFilter < BaseConditionsFilter
+        ATTRIBUTES = %w[notes threads].freeze
+        CONDITIONS = %w[greater_than less_than].freeze
+
+        def self.filter_parameters
+          [
+            {
+              name: :attribute,
+              type: String,
+              values: ATTRIBUTES
+            },
+            {
+              name: :condition,
+              type: String,
+              values: CONDITIONS
+            },
+            {
+              name: :threshold,
+              type: Numeric
+            }
+          ]
+        end
+
+        def initialize_variables(condition)
+          @attribute = condition[:attribute].to_sym
+          @condition = condition[:condition].to_sym
+          @threshold = condition[:threshold]
+        end
+
+        def resource_value
+          if @attribute == :notes
+            @resource[:user_notes_count]
+          else
+            @resource.dig(:discussions, :nodes)&.count do |node|
+              !node&.dig(:notes, :nodes, 0, :system)
+            end
+          end
+        end
+
+        def condition_value
+          @threshold
+        end
+
+        def calculate
+          case @condition
+          when :greater_than
+            resource_value.to_i > condition_value
+          when :less_than
+            resource_value.to_i < condition_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/graphql_network.rb

@@ -0,0 +1,54 @@
+require 'active_support/all'
+require 'net/protocol'
+require 'globalid'
+
+require_relative 'retryable'
+require_relative 'ui'
+require_relative 'errors'
+
+module Gitlab
+  module Triage
+    class GraphqlNetwork
+      attr_reader :options, :adapter
+
+      def initialize(adapter)
+        @adapter = adapter
+        @options = adapter.options
+      end
+
+      def query(graphql_query, variables = {})
+        return if graphql_query.blank?
+
+        response = {}
+        resources = []
+
+        parsed_graphql_query = adapter.parse(graphql_query.query)
+
+        begin
+          print '.'
+
+          response = adapter.query(
+            parsed_graphql_query,
+            resource_path: graphql_query.resource_path,
+            variables: variables.merge(after: response.delete(:end_cursor))
+          )
+
+          resources.concat(Array.wrap(response.delete(:results)))
+        end while response.delete(:more_pages)
+
+        resources
+          .map { |resource| resource.deep_transform_keys(&:underscore) }
+          .map(&:with_indifferent_access)
+          .map { |resource| resource.merge(id: extract_id_from_global_id(resource[:id])) }
+      end
+
+      private
+
+      def extract_id_from_global_id(global_id)
+        return if global_id.blank?
+
+        GlobalID.parse(global_id).model_id.to_i
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require_relative 'user_notes_query'
+require_relative 'threads_query'
+
+module Gitlab
+  module Triage
+    module GraphqlQueries
+      class QueryBuilder
+        def initialize(source_type, resource_type, conditions)
+          @source_type = source_type.to_s.singularize
+          @resource_type = resource_type
+          @conditions = conditions
+        end
+
+        def resource_path
+          [source_type, resource_type]
+        end
+
+        def query
+          return if query_template.nil?
+
+          format(query_template, source_type: source_type, resource_type: resource_type.to_s.camelize(:lower))
+        end
+
+        delegate :present?, to: :query_template
+
+        private
+
+        attr_reader :source_type, :resource_type, :conditions
+
+        def query_template
+          case conditions.dig(:discussions, :attribute).to_s
+          when 'notes'
+            UserNotesQuery
+          when 'threads'
+            ThreadsQuery
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Gitlab
+  module Triage
+    module GraphqlQueries
+      ThreadsQuery = <<-GRAPHQL.freeze # rubocop:disable Naming/ConstantName
+        query($source: ID!, $after: String) {
+          %{source_type}(fullPath: $source) {
+            id
+            %{resource_type}(after: $after) {
+              pageInfo {
+                hasNextPage
+                endCursor
+              }
+              nodes {
+                id
+                discussions {
+                  nodes {
+                    notes {
+                      nodes {
+                        system
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      GRAPHQL
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Gitlab
+  module Triage
+    module GraphqlQueries
+      UserNotesQuery = <<-GRAPHQL.freeze # rubocop:disable Naming/ConstantName
+        query($source: ID!, $after: String) {
+          %{source_type}(fullPath: $source) {
+            id
+            %{resource_type}(after: $after) {
+              pageInfo {
+                hasNextPage
+                endCursor
+              }
+              nodes {
+                id
+                userNotesCount
+              }
+            }
+          }
+        }
+      GRAPHQL
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+require 'graphql/client'
+require 'graphql/client/http'
+
+require_relative 'base_adapter'
+require_relative '../ui'
+require_relative '../errors'
+
+module Gitlab
+  module Triage
+    module NetworkAdapters
+      class GraphqlAdapter < BaseAdapter
+        Client = GraphQL::Client
+
+        def query(graphql_query, resource_path: [], variables: {})
+          response = client.query(graphql_query, variables: variables, context: { token: options.token })
+
+          raise_on_error!(response)
+
+          parsed_response = parse_response(response, resource_path)
+
+          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?
+
+          {
+            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
+
+        private
+
+        def parse_response(response, resource_path)
+          resource_path.reduce(response.data) { |data, resource| data&.send(resource) }
+        end
+
+        def raise_on_error!(response)
+          return if response.errors.blank?
+
+          puts Gitlab::Triage::UI.debug response.inspect if options.debug
+
+          raise "There was an error: #{response.errors.messages.to_json}"
+        end
+
+        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]
+              }
+            end
+          end
+        end
+
+        def schema
+          @schema ||= Client.load_schema(http_client)
+        end
+
+        def client
+          @client ||= Client.new(schema: schema, execute: http_client).tap { |client| client.allow_dynamic_queries = true }
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Triage
-    VERSION = '1.13.0'
+    VERSION = '1.14.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: graphql-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -158,16 +186,22 @@ files:
 - lib/gitlab/triage/filters/assignee_member_conditions_filter.rb
 - lib/gitlab/triage/filters/author_member_conditions_filter.rb
 - lib/gitlab/triage/filters/base_conditions_filter.rb
+- lib/gitlab/triage/filters/discussions_conditions_filter.rb
 - lib/gitlab/triage/filters/member_conditions_filter.rb
 - lib/gitlab/triage/filters/merge_request_date_conditions_filter.rb
 - lib/gitlab/triage/filters/name_conditions_filter.rb
 - 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/graphql_network.rb
+- lib/gitlab/triage/graphql_queries/query_builder.rb
+- lib/gitlab/triage/graphql_queries/threads_query.rb
+- lib/gitlab/triage/graphql_queries/user_notes_query.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/graphql_adapter.rb
 - lib/gitlab/triage/network_adapters/httparty_adapter.rb
 - lib/gitlab/triage/network_adapters/test_adapter.rb
 - lib/gitlab/triage/option_parser.rb
@@ -213,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: GitLab triage automation project.