payping-gitlab-triage 0.1.1

data/lib/gitlab/triage/rest_api_network.rb

@@ -0,0 +1,125 @@
+require 'active_support/all'
+require 'net/protocol'
+
+require_relative 'retryable'
+require_relative 'ui'
+require_relative 'errors'
+
+module Gitlab
+  module Triage
+    class RestAPINetwork
+      include Retryable
+
+      MINIMUM_RATE_LIMIT = 25
+
+      attr_reader :options, :adapter
+
+      def initialize(adapter)
+        @adapter = adapter
+        @options = adapter.options
+        @cache = {}
+      end
+
+      def query_api_cached(url)
+        @cache[url] || @cache[url] = query_api(url)
+      end
+
+      def query_api(url)
+        response = {}
+        resources = []
+
+        begin
+          print '.'
+          url = response.fetch(:next_page_url) { url }
+
+          response = execute_with_retry(
+            exception_types: [Net::ReadTimeout, Errors::Network::InternalServerError],
+            backoff_exceptions: Errors::Network::TooManyRequests) do
+            puts Gitlab::Triage::UI.debug "query_api: #{url}" if options.debug
+
+            @adapter.get(token, url)
+          end
+
+          results = response.delete(:results)
+
+          case results
+          when Array
+            resources.concat(results)
+          when Hash
+            resources << results
+          else
+            raise_unexpected_response(results)
+          end
+
+          rate_limit_debug(response) if options.debug
+          rate_limit_wait(response)
+        end while response.delete(:more_pages)
+
+        resources.map!(&:with_indifferent_access)
+      rescue Net::ReadTimeout
+        []
+      end
+
+      def post_api(url, body)
+        response = execute_with_retry(
+          exception_types: Net::ReadTimeout,
+          backoff_exceptions: Errors::Network::TooManyRequests) do
+          puts Gitlab::Triage::UI.debug "post_api: #{url}" if options.debug
+
+          @adapter.post(token, url, body)
+        end
+
+        rate_limit_debug(response) if options.debug
+        rate_limit_wait(response)
+
+        results = response.delete(:results)
+
+        case results
+        when Hash
+          results.with_indifferent_access
+        else
+          raise_unexpected_response(results)
+        end
+      rescue Net::ReadTimeout
+        {}
+      end
+
+      def delete_api(url)
+        response = execute_with_retry(
+          exception_types: Net::ReadTimeout,
+          backoff_exceptions: Errors::Network::TooManyRequests) do
+          puts Gitlab::Triage::UI.debug "delete_api: #{url}" if options.debug
+
+          @adapter.delete(token, url)
+        end
+
+        rate_limit_debug(response) if options.debug
+        rate_limit_wait(response)
+      rescue Net::ReadTimeout
+        {}
+      end
+
+      private
+
+      def token
+        options.token
+      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
+
+      def raise_unexpected_response(results)
+        raise Errors::Network::UnexpectedResponse, "Unexpected response: #{results.inspect}"
+      end
+    end
+  end
+end

data/lib/gitlab/triage/retryable.rb

@@ -0,0 +1,33 @@
+module Gitlab
+  module Triage
+    module Retryable
+      MAX_RETRIES = 3
+      BACK_OFF_SECONDS = 10
+
+      attr_accessor :tries
+
+      def execute_with_retry(exception_types: [StandardError], backoff_exceptions: [])
+        @tries = 0
+
+        until maximum_retries_reached?
+          begin
+            @tries += 1
+            return yield
+          rescue *exception_types
+            raise if maximum_retries_reached?
+          rescue *backoff_exceptions
+            raise if maximum_retries_reached?
+
+            sleep(BACK_OFF_SECONDS)
+          end
+        end
+      end
+
+      private
+
+      def maximum_retries_reached?
+        tries == MAX_RETRIES
+      end
+    end
+  end
+end

data/lib/gitlab/triage/ui.rb

@@ -0,0 +1,23 @@
+module Gitlab
+  module Triage
+    class UI
+      def self.header(text, char: '=')
+        header = char * text.size
+
+        [header, text, header, nil].join("\n")
+      end
+
+      def self.debug(text)
+        "[DEBUG] #{text}"
+      end
+
+      def self.warn(text)
+        "[WARNING] #{text}"
+      end
+
+      def self.error(text)
+        "[ERROR] #{text}"
+      end
+    end
+  end
+end

data/lib/gitlab/triage/url_builders/url_builder.rb

@@ -0,0 +1,54 @@
+module Gitlab
+  module Triage
+    module UrlBuilders
+      class UrlBuilder
+        def initialize(options)
+          @network_options = options.fetch(:network_options)
+          @host_url = @network_options.host_url
+          @api_version = @network_options.api_version
+          @all = options.fetch(:all, false)
+          @source = options.fetch(:source, 'projects')
+          @source_id = options.fetch(:source_id)
+          @resource_type = options.fetch(:resource_type, nil)
+          @sub_resource_type = options.fetch(:sub_resource_type, nil)
+          @resource_id = options.fetch(:resource_id, nil)
+          @params = options.fetch(:params, [])
+
+          @params = @params.merge(scope: :all) if @all
+        end
+
+        def build
+          url = base_url
+          url << "/#{percent_encode(@resource_id.to_s)}" if @resource_id
+          url << "/#{@sub_resource_type}" if @sub_resource_type
+          url << params_string if @params
+          url
+        end
+
+        private
+
+        def host_with_api_url
+          "#{@host_url}/api/#{@api_version}"
+        end
+
+        def base_url
+          url = host_with_api_url
+          url << "/#{@source}/#{percent_encode(@source_id.to_s)}" unless @all
+          url << "/repository" if @resource_type == 'branches'
+          url << "/#{@resource_type}" if @resource_type
+          url
+        end
+
+        def params_string
+          "?" << @params.map do |k, v|
+            "#{percent_encode(k.to_s)}=#{percent_encode(v.to_s)}"
+          end.join("&")
+        end
+
+        def percent_encode(str)
+          CGI.escape(str).gsub('+', '%20')
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/utils.rb

@@ -0,0 +1,13 @@
+module Gitlab
+  module Triage
+    module Utils
+      module_function
+
+      def graphql_quote(string)
+        contents = string.to_s.gsub('"', '\\"')
+
+        %("#{contents}")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+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)
+        return if value.keys.one? { |key| params_limiter_names.include?(key.to_sym) }
+
+        raise ArgumentError, "For the limits field, please specify one of: `#{params_limiter_names.join('`, `')}`"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Gitlab
+  module Triage
+    class ParamsValidator
+      InvalidParameter = Class.new(ArgumentError)
+
+      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 InvalidParameter, "#{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 InvalidParameter, "#{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 InvalidParameter, "#{param[:name]} must be one of #{param[:values].join(',')}" unless param[:values].include?(value[param[:name]])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Triage
+    VERSION = '0.1.1'
+  end
+end

data/lib/gitlab/triage.rb

@@ -0,0 +1,6 @@
+require 'gitlab/triage/version'
+
+module Gitlab
+  module Triage
+  end
+end

data/support/.gitlab-ci.example.yml

@@ -0,0 +1,22 @@
+image: ruby:2.7
+
+stages:
+  - triage
+
+dry-run:triage:
+  stage: triage
+  script:
+    - gem install gitlab-triage
+    - gitlab-triage --help
+    - gitlab-triage --dry-run --token $GITLAB_API_TOKEN --host-url $CI_SERVER_URL --source projects --source-id $CI_PROJECT_PATH
+  when: manual
+  except:
+    - schedules
+
+run:triage:
+  stage: triage
+  script:
+    - gem install gitlab-triage
+    - gitlab-triage --token $GITLAB_API_TOKEN --host-url $CI_SERVER_URL --source projects --source-id $CI_PROJECT_PATH
+  only:
+    - schedules

data/support/.triage-policies.example.yml

@@ -0,0 +1,51 @@
+resource_rules:
+  issues:
+    rules:
+      - name: Comment 1 week old, unlabelled issues
+        conditions:
+          date:
+            attribute: created_at
+            condition: older_than
+            interval_type: weeks
+            interval: 1
+          labels:
+            - None
+          state: opened
+        actions:
+          comment: |
+            This issue has been open for one week and is unlabelled
+    summaries:
+      - name: Newest and oldest issues summary
+        actions:
+          summarize:
+            title: "Newest and oldest {{type}} summary"
+            summary: |
+              Please triage the following {{type}}:
+
+              {{items}}
+
+              Please take care of them before the end of #{7.days.from_now.strftime('%Y-%m-%d')}
+
+              /label ~"needs attention"
+        rules:
+          - name: New issues
+            conditions:
+              state: opened
+            limits:
+              most_recent: 2
+            actions:
+              summarize:
+                item: "- [ ] [{{title}}]({{web_url}}) {{labels}}"
+                summary: "Please triage the following new {{type}}:\n\n{{items}}"
+          - name: Old issues
+            conditions:
+              state: opened
+            limits:
+              oldest: 2
+            actions:
+              summarize:
+                item: "- [ ] [{{title}}]({{web_url}}) {{labels}}"
+                summary: "Please triage the following old {{type}}:\n\n{{items}}"
+  merge_requests:
+    rules:
+      []

metadata

@@ -0,0 +1,280 @@
+--- !ruby/object:Gem::Specification
+name: payping-gitlab-triage
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- GitLab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gitlab-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- gitlab_rubygems@gitlab.com
+executables:
+- gitlab-triage
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".gitlab/CODEOWNERS"
+- ".gitlab/changelog_config.yml"
+- ".gitlab/issue_templates/Default.md"
+- ".gitlab/merge_request_templates/Default.md"
+- ".gitlab/merge_request_templates/Release.md"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- ".tool-versions"
+- ".yardopts"
+- CONTRIBUTING.md
+- Dangerfile
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/gitlab-triage
+- gitlab-triage.gemspec
+- lib/gitlab/triage.rb
+- 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/delete.rb
+- lib/gitlab/triage/action/issue.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
+- lib/gitlab/triage/api_query_builders/multi_query_param_builder.rb
+- lib/gitlab/triage/api_query_builders/single_query_param_builder.rb
+- lib/gitlab/triage/command_builders/base_command_builder.rb
+- lib/gitlab/triage/command_builders/cc_command_builder.rb
+- lib/gitlab/triage/command_builders/comment_command_builder.rb
+- lib/gitlab/triage/command_builders/label_command_builder.rb
+- lib/gitlab/triage/command_builders/move_command_builder.rb
+- lib/gitlab/triage/command_builders/remove_label_command_builder.rb
+- lib/gitlab/triage/command_builders/status_command_builder.rb
+- lib/gitlab/triage/command_builders/text_content_builder.rb
+- lib/gitlab/triage/engine.rb
+- lib/gitlab/triage/entity_builders/issue_builder.rb
+- lib/gitlab/triage/entity_builders/summary_builder.rb
+- lib/gitlab/triage/errors.rb
+- lib/gitlab/triage/errors/network.rb
+- lib/gitlab/triage/expand_condition.rb
+- lib/gitlab/triage/expand_condition/expansion.rb
+- lib/gitlab/triage/expand_condition/list.rb
+- lib/gitlab/triage/expand_condition/sequence.rb
+- 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/branch_date_filter.rb
+- lib/gitlab/triage/filters/branch_protected_filter.rb
+- lib/gitlab/triage/filters/discussions_conditions_filter.rb
+- lib/gitlab/triage/filters/issue_date_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/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
+- 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
+- lib/gitlab/triage/options.rb
+- lib/gitlab/triage/param_builders/date_param_builder.rb
+- lib/gitlab/triage/policies/base_policy.rb
+- lib/gitlab/triage/policies/rule_policy.rb
+- lib/gitlab/triage/policies/summary_policy.rb
+- lib/gitlab/triage/policies_resources/rule_resources.rb
+- lib/gitlab/triage/policies_resources/summary_resources.rb
+- lib/gitlab/triage/resource/base.rb
+- lib/gitlab/triage/resource/branch.rb
+- lib/gitlab/triage/resource/context.rb
+- lib/gitlab/triage/resource/epic.rb
+- lib/gitlab/triage/resource/instance_version.rb
+- lib/gitlab/triage/resource/issue.rb
+- lib/gitlab/triage/resource/label.rb
+- lib/gitlab/triage/resource/label_event.rb
+- lib/gitlab/triage/resource/linked_issue.rb
+- lib/gitlab/triage/resource/merge_request.rb
+- lib/gitlab/triage/resource/milestone.rb
+- lib/gitlab/triage/resource/shared/issuable.rb
+- lib/gitlab/triage/rest_api_network.rb
+- lib/gitlab/triage/retryable.rb
+- lib/gitlab/triage/ui.rb
+- lib/gitlab/triage/url_builders/url_builder.rb
+- lib/gitlab/triage/utils.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
+homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage
+  source_code_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage
+  changelog_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage/-/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: GitLab triage automation project.
+test_files: []