gitlab-triage 1.24.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d4dafafa454a68a9258f5753ef3df345e0a0f13c104158bc1243ecb561d408a
-  data.tar.gz: c0d12641e77a6865e0f5569d405e2548b03884e61280dc262a922ff38b786c84
+  metadata.gz: dfb91844acb53e2543200eae19db3c5abaf9cd79106add7fa5ca7ca9585215dd
+  data.tar.gz: eba68ca3b8a0539f2428e63d71f86fe28ac1e292e89141fa3312192f9a21a2fd
 SHA512:
-  metadata.gz: ea2b0d33abf1eb19403519f264ab25d249a9992e97e08f830505f497a50cc91ae0f9210db270b87d45649ef41c1d1248fcf2ef13b6820991455cfe4d09e8247f
-  data.tar.gz: 063b0a7ec5503f55ee4971e84cc1ddeb81b1ce83997a41dbd48a9c730ada4b402693fc1e4f2be6a955cc9de57c283ed4ee1b37e059633bec355a95c2a55efe3b
+  metadata.gz: fa86c82d57b8e4e9986039098b1c7f8f5b031dae68080bb38a84808ae6df26af48ebf0790d47558e8c9ecf6fad8ba2d7d8208ccb54a6b33cb753e0fac02139c5
+  data.tar.gz: cacc6bc349fa41819c5b163cd67165983021bfee35bc9f607f5a64cb283d1372db51740e4c851238e68ff15776ec6289dc280ee2ca1d11f5714c0d36f7e68013

data/.gitlab-ci.yml

@@ -126,7 +126,7 @@ dry-run:gitlab-triage:
     - gitlab-triage --version
     - gitlab-triage --help
     - gitlab-triage --init
-    - gitlab-triage --dry-run --debug --token $GITLAB_API_TOKEN --source-id $CI_PROJECT_PATH
+    - gitlab-triage --dry-run --debug --source-id $CI_PROJECT_PATH
 
 # This job requires allows to override the `CI_PROJECT_PATH` variable when triggered.
 dry-run:custom:

data/README.md

@@ -21,6 +21,7 @@ Triage policies are defined on a resource level basis, resources being:
 - Epics
 - Issues
 - Merge Requests
+- Branches
 
 Each policy can declare a number of conditions that must all be satisfied before
 a number of actions are carried out.
@@ -42,6 +43,7 @@ Select which resource to add the policy to:
 - `epics`
 - `issues`
 - `merge_requests`
+- `branches`
 
 And create an array of `rules` to define your policies:
 
@@ -120,6 +122,18 @@ resource_rules:
           comment_type: thread
           comment: |
             {{author}} This issue is unlabelled. Please add one or more labels.
+  branches:
+    rules:
+      - name: My branch policy
+        conditions:
+          date:
+            attribute: committed_date
+            condition: older_than
+            interval_type: 6
+            interval: months
+          name: ^feature
+        actions:
+          delete: true
 ```
 
 ### Real world example
@@ -155,7 +169,7 @@ Available condition types:
 - [`milestone` condition](#milestone-condition)
 - [`iteration` condition](#iteration-condition)
 - [`state` condition](#state-condition)
-- [`upvotes` condition](#upvotes-condition)
+- [`votes` condition](#votes-condition)
 - [`labels` condition](#labels-condition)
 - [`forbidden_labels` condition](#forbidden-labels-condition)
 - [`no_additional_labels` condition](#no-additional-labels-condition)
@@ -166,21 +180,23 @@ Available condition types:
 - [`target_branch` condition](#target-branch-condition)
 - [`weight` condition](#weight-condition)
 - [`discussions` condition](#discussions-condition)
+- [`protected` condition](#protected-condition)
 - [`ruby` condition](#ruby-condition)
 
 ##### Date condition
 
 Accepts a hash of fields.
 
-| Field           | Type    | Values                                  | Required  |
-| ---------       | ----    | ----                                    | --------  |
-| `attribute`     | string  | `created_at`, `updated_at`, `merged_at` | yes       |
-| `condition`     | string  | `older_than`, `newer_than`              | yes       |
-| `interval_type` | string  | `days`, `weeks`, `months`, `years`      | yes       |
-| `interval`      | integer | integer                                 | yes       |
+| Field           | Type    | Values                                                                   | Required  |
+| ---------       | ----    |--------------------------------------------------------------------------| --------  |
+| `attribute`     | string  | `created_at`, `updated_at`, `merged_at`, `authored_date`, `committed_date` | yes       |
+| `condition`     | string  | `older_than`, `newer_than`                                               | yes       |
+| `interval_type` | string  | `days`, `weeks`, `months`, `years`                                       | yes       |
+| `interval`      | integer | integer                                                                  | yes       |
 > **Note:**
 >   - `merged_at` only works on merge requests.
 >   - `closed_at` is not supported in the GitLab API, but can be used in a [`ruby` condition](#ruby-condition).
+>   - `committed_date` and `authored_date` only works for branches.
 
 Example:
 
@@ -248,7 +264,7 @@ conditions:
   state: opened
 ```
 
-##### Upvotes condition
+##### Votes condition
 
 Accepts a hash of fields.
 
@@ -262,7 +278,7 @@ Example:
 
 ```yml
 conditions:
-  upvotes:
+  votes:
     attribute: upvotes
     condition: less_than
     threshold: 10
@@ -575,6 +591,13 @@ conditions:
     threshold: 15
 ```
 
+##### Protected condition  
+
+** This condition is only applicable for branches** 
+
+Accept a boolean.
+If not specified, default to `false` to filter out protected branches.
+
 ##### Ruby condition
 
 This condition allows users to write a Ruby expression to be evaluated for
@@ -661,6 +684,8 @@ Available action types:
 - [`comment_type` action option](#comment-type-action-option)
 - [`summarize` action](#summarize-action)
 - [`comment_on_summary` action](#comment-on-summary-action)
+- [`issue` action](#create-a-new-issue-from-each-resource)
+- [`delete` action](#delete-action)
 
 ##### Labels action
 
@@ -1032,6 +1057,30 @@ resource_rules:
               /label ~"needs attention"
 ```
 
+##### Delete action
+
+**This action is only applicable for branches.**
+
+Delete the resource. 
+
+Accept a boolean. Set to `true` to enable.
+
+Example : 
+```yaml
+resource_rules:
+  branches:
+    rules:
+      - name: My branch policy
+        conditions:
+          date:
+            attribute: committed_date
+            condition: older_than
+            interval_type: months
+            interval: 30
+        actions:
+          delete: true
+```
+
 ### Summary policies
 
 Summary policies are special policies that join multiple rule policies together
@@ -1146,6 +1195,7 @@ Here's a list of currently available Ruby expression API:
 | related_merge_requests | [MergeRequest] | The list of merge requests related to the issue |
 | closed_by              | [MergeRequest] | The list of merge requests that close the issue |
 | linked_issues          | [LinkedIssue]  | The list of issues that are linked to the issue |
+| due_date               | Date           | The due date of the issue. Could be `nil` |
 
 ##### Methods for `LinkedIssue`
 
@@ -1357,4 +1407,13 @@ Please refer to the [Contributing Guide](CONTRIBUTING.md).
 
 ## Release Process
 
-Please refer to the [Release Process](docs/release_process.md).
+We release `gitlab-triage` on an ad-hoc basis. There is no regularity to when
+we release, we just release when we make a change - no matter the size of the
+change.
+
+To release a new version:
+
+1. Create a Merge Request.
+1. Use Merge Request template [Release.md](https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage/-/blob/master/.gitlab/merge_request_templates/Release.md).
+1. Follow the instructions.
+1. After the Merge Request has been merged, a new gem version is [published automatically](https://gitlab.com/gitlab-org/quality/pipeline-common/-/blob/master/ci/gem-release.yml)

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

@@ -28,6 +28,11 @@ module Gitlab
         end
 
         def act
+          if policy.type == 'branches'
+            puts Gitlab::Triage::UI.warn "Comment actions are not available for branches. They will NOT be performed\n\n"
+            return
+          end
+
           policy.resources.each do |resource|
             comment = build_comment(resource).strip
 

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Gitlab
+  module Triage
+    module Action
+      class Delete < Base
+        class Dry < Delete
+          def act
+            puts "The following resources will be deleted by the rule **#{policy.name}**:\n\n"
+            super
+          end
+
+          private
+
+          def perform(resource)
+            puts "DELETE resource with type: #{resource[:type]} and id: #{resource_id(resource)}"
+          end
+        end
+
+        def act
+          return unless policy.type&.to_sym == :branches
+
+          policy.resources.each do |resource|
+            perform(resource)
+          end
+        end
+
+        private
+
+        def perform(resource)
+          network.delete_api(build_delete_url(resource))
+        end
+
+        def build_delete_url(resource)
+          delete_url = UrlBuilders::UrlBuilder.new(
+            source: policy.source,
+            source_id: network.options.source_id,
+            resource_type: policy.type,
+            resource_id: resource_id(resource),
+            network_options: network.options
+          ).build
+
+          puts Gitlab::Triage::UI.debug "delete_url: #{delete_url}" if network.options.debug
+
+          delete_url
+        end
+
+        def resource_id(resource)
+          resource[:name]
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/action.rb

@@ -2,6 +2,7 @@ require_relative 'action/summarize'
 require_relative 'action/comment'
 require_relative 'action/comment_on_summary'
 require_relative 'action/issue'
+require_relative 'action/delete'
 
 module Gitlab
   module Triage
@@ -13,7 +14,8 @@ module Gitlab
           [Summarize, policy.summarize?],
           [Comment, policy.comment?],
           [CommentOnSummary, policy.comment_on_summary?],
-          [Issue, policy.issue?]
+          [Issue, policy.issue?],
+          [Delete, policy.delete?]
         ].each do |action, active|
           act(action: action, policy: policy, **args) if active
         end

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

@@ -31,7 +31,8 @@ module Gitlab
           web_url: "{{web_url}}",
           full_reference: "{{references.full}}",
           type: "{{type}}",
-          items: "{{items}}"
+          items: "{{items}}",
+          name: "{{name}}"
         }.freeze
         PLACEHOLDER_REGEX = /{{([\w\.]+)}}/.freeze
 

data/lib/gitlab/triage/engine.rb

@@ -3,6 +3,8 @@ require 'active_support/inflector'
 
 require_relative 'expand_condition'
 require_relative 'filters/merge_request_date_conditions_filter'
+require_relative 'filters/branch_date_filter'
+require_relative 'filters/branch_protected_filter'
 require_relative 'filters/votes_conditions_filter'
 require_relative 'filters/no_additional_labels_conditions_filter'
 require_relative 'filters/author_member_conditions_filter'
@@ -55,7 +57,6 @@ module Gitlab
 
         assert_all!
         assert_project_id!
-        assert_token!
         require_ruby_files
       end
 
@@ -99,12 +100,6 @@ module Gitlab
         raise ArgumentError, 'A project_id is needed (pass it with the `--source-id` option)!'
       end
 
-      def assert_token!
-        return if options.token
-
-        raise ArgumentError, 'A token is needed (pass it with the `--token` option)!'
-      end
-
       def assert_all!
         raise ArgumentError, '--all-projects option cannot be used in conjunction with --source and --source-id option!' if
           options.all && (options.source || options.source_id)
@@ -333,17 +328,27 @@ module Gitlab
         puts
       end
 
-      def filter_resources(resources, conditions)
+      def filter_resources(resources, conditions) # rubocop:disable Metrics/CyclomaticComplexity
         resources.select do |resource|
           results = []
 
           # rubocop:disable Style/IfUnlessModifier
           if conditions[:date]
-            results << Filters::MergeRequestDateConditionsFilter.new(resource, conditions[:date]).calculate
+            case resource[:type]
+            when 'branches'
+              results << Filters::BranchDateFilter.new(resource, conditions[:date]).calculate
+            when 'merge_requests'
+              results << Filters::MergeRequestDateConditionsFilter.new(resource, conditions[:date]).calculate
+            end
+          end
+
+          if resource[:type] == 'branches'
+            results << Filters::BranchProtectedFilter.new(resource, conditions[:protected]).calculate
           end
 
-          if conditions[:upvotes]
-            results << Filters::VotesConditionsFilter.new(resource, conditions[:upvotes]).calculate
+          votes_condition = conditions[:votes] || conditions[:upvotes]
+          if votes_condition
+            results << Filters::VotesConditionsFilter.new(resource, votes_condition).calculate
           end
 
           if conditions[:no_additional_labels]
@@ -402,7 +407,7 @@ module Gitlab
 
         condition_builders << milestone_condition_builder(resource_type, conditions[:milestone]) if conditions[:milestone]
 
-        if conditions[:date] && APIQueryBuilders::DateQueryParamBuilder.applicable?(conditions[:date])
+        if conditions[:date] && APIQueryBuilders::DateQueryParamBuilder.applicable?(conditions[:date]) && resource_type&.to_sym != :branches
           condition_builders << APIQueryBuilders::DateQueryParamBuilder.new(conditions.delete(:date))
         end
 
@@ -411,6 +416,8 @@ module Gitlab
           condition_builders.concat(issues_resource_query(conditions))
         when :merge_requests
           condition_builders.concat(merge_requests_resource_query(conditions))
+        when :branches
+          condition_builders.concat(branches_resource_query(conditions))
         end
 
         condition_builders.compact.each do |condition_builder|
@@ -468,6 +475,12 @@ module Gitlab
         end
       end
 
+      def branches_resource_query(conditions)
+        [].tap do |condition_builders|
+          condition_builders << APIQueryBuilders::SingleQueryParamBuilder.new('search', conditions[:name]) if conditions[:name]
+        end
+      end
+
       def draft_condition_builder(draft_condittion)
         # Issues API only accepts 'yes' and 'no' as strings: https://docs.gitlab.com/ee/api/merge_requests.html
         wip =

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

@@ -0,0 +1,67 @@
+require_relative 'base_conditions_filter'
+
+module Gitlab
+  module Triage
+    module Filters
+      class BranchDateFilter < BaseConditionsFilter
+        ATTRIBUTES = %w[committed_date authored_date].freeze
+        CONDITIONS = %w[older_than newer_than].freeze
+        INTERVAL_TYPES = %w[days weeks months years].freeze
+
+        def self.allowed_attributes
+          self::ATTRIBUTES
+        end
+
+        def self.filter_parameters
+          [
+            {
+              name: :attribute,
+              type: String,
+              values: allowed_attributes
+            },
+            {
+              name: :condition,
+              type: String,
+              values: CONDITIONS
+            },
+            {
+              name: :interval_type,
+              type: String,
+              values: INTERVAL_TYPES
+            },
+            {
+              name: :interval,
+              type: Numeric
+            }
+          ]
+        end
+
+        def initialize_variables(condition)
+          @attribute = condition[:attribute].to_sym
+          @condition = condition[:condition].to_sym
+          @interval_type = condition[:interval_type].to_sym
+          @interval = condition[:interval]
+        end
+
+        def resource_value
+          @resource[:commit][@attribute]&.to_date
+        end
+
+        def condition_value
+          @interval.public_send(@interval_type).ago.to_date # rubocop:disable GitlabSecurity/PublicSend
+        end
+
+        def calculate
+          return false unless resource_value
+
+          case @condition
+          when :older_than
+            resource_value < condition_value
+          when :newer_than
+            resource_value > condition_value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require_relative 'base_conditions_filter'
+
+module Gitlab
+  module Triage
+    module Filters
+      class BranchProtectedFilter < BaseConditionsFilter
+        def initialize_variables(config_value)
+          @attribute = :protected
+          @condition = config_value.nil? ? true : config_value
+        end
+
+        def resource_value
+          @resource[:protected]
+        end
+
+        def condition_value
+          @condition
+        end
+
+        def calculate
+          resource_value == condition_value
+        end
+      end
+    end
+  end
+end

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

@@ -54,6 +54,10 @@ module Gitlab
           }
         GRAPHQL
 
+        def vote_attribute
+          @vote_attribute ||= (conditions.dig(:votes, :attribute) || conditions.dig(:upvotes, :attribute)).to_s
+        end
+
         def resource_fields
           fields = []
 
@@ -64,8 +68,8 @@ module Gitlab
             fields << 'labels { nodes { title } }'
             fields << 'author { id name username }'
             fields << 'assignees { nodes { id name username } }' if conditions.key?(:assignee_member)
-            fields << 'upvotes' if conditions.dig(:upvotes, :attribute).to_s == 'upvotes'
-            fields << 'downvotes' if conditions.dig(:upvotes, :attribute).to_s == 'downvotes'
+            fields << 'upvotes' if vote_attribute == 'upvotes'
+            fields << 'downvotes' if vote_attribute == 'downvotes'
             fields.push('draft', 'mergedAt') if resource_type == 'merge_requests'
           end
 

data/lib/gitlab/triage/network.rb

@@ -30,6 +30,10 @@ module Gitlab
       def post_api(...)
         restapi.post_api(...)
       end
+
+      def delete_api(...)
+        restapi.delete_api(...)
+      end
     end
   end
 end

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

@@ -53,6 +53,26 @@ module Gitlab
           }
         end
 
+        def delete(token, url)
+          response = HTTParty.delete(
+            url,
+            headers: {
+              'User-Agent' => USER_AGENT,
+              'PRIVATE-TOKEN' => token
+            }
+          )
+
+          raise_on_unauthorized_error!(response)
+          raise_on_internal_server_error!(response)
+          raise_on_too_many_requests!(response)
+
+          {
+            results: response.parsed_response,
+            ratelimit_remaining: response.headers["ratelimit-remaining"].to_i,
+            ratelimit_reset_at: Time.at(response.headers["ratelimit-reset"].to_i)
+          }
+        end
+
         private
 
         def raise_on_unauthorized_error!(response)

data/lib/gitlab/triage/option_parser.rb

@@ -8,6 +8,7 @@ module Gitlab
   module Triage
     class OptionParser
       class << self
+        # rubocop:disable Metrics/AbcSize
         def parse(argv)
           options = Options.new
           options.host_url = 'https://gitlab.com'
@@ -89,9 +90,11 @@ module Gitlab
           parser.parse!(argv)
 
           options.source = nil if options.all
+          options.token ||= ''
 
           options
         end
+        # rubocop:enable Metrics/AbcSize
       end
     end
   end

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

@@ -56,13 +56,17 @@ module Gitlab
 
         def comment?
           # The actual keys are strings
-          (actions.keys.map(&:to_sym) - [:summarize, :comment_on_summary]).any?
+          (actions.keys.map(&:to_sym) - [:summarize, :comment_on_summary, :delete, :issue]).any?
         end
 
         def issue?
           actions.key?(:issue)
         end
 
+        def delete?
+          actions.key?(:delete) && actions[:delete]
+        end
+
         def build_issue
           raise NotImplementedError
         end

data/lib/gitlab/triage/resource/branch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'shared/issuable'
+
+module Gitlab
+  module Triage
+    module Resource
+      class Branch < Base
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/context.rb

@@ -6,6 +6,7 @@ require_relative 'issue'
 require_relative 'linked_issue'
 require_relative 'merge_request'
 require_relative 'instance_version'
+require_relative 'branch'
 
 module Gitlab
   module Triage

data/lib/gitlab/triage/resource/issue.rb

@@ -9,6 +9,18 @@ module Gitlab
       class Issue < Base
         include Shared::Issuable
 
+        DATE_FIELDS = %i[
+          due_date
+        ].freeze
+
+        DATE_FIELDS.each do |field|
+          define_field(field) do
+            value = resource[field]
+
+            Date.parse(value) if value
+          end
+        end
+
         def merge_requests_count
           @merge_requests_count ||= resource.dig(:merge_requests_count)
         end
@@ -30,6 +42,10 @@ module Gitlab
             resource_url(sub_resource_type: 'links'))
             .map { |issue| LinkedIssue.new(issue, parent: self) }
         end
+
+        def expired?(today = Date.today)
+          due_date && due_date < today
+        end
       end
     end
   end

data/lib/gitlab/triage/rest_api_network.rb

@@ -10,7 +10,6 @@ module Gitlab
     class RestAPINetwork
       include Retryable
 
-      TokenNotFound = Class.new(StandardError)
       MINIMUM_RATE_LIMIT = 25
 
       attr_reader :options, :adapter
@@ -85,10 +84,25 @@ module Gitlab
         {}
       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 || raise(TokenNotFound)
+        options.token
       end
 
       def rate_limit_debug(response)

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

@@ -34,6 +34,7 @@ module Gitlab
         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

data/lib/gitlab/triage/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Triage
-    VERSION = '1.24.0'
+    VERSION = '1.26.0'
   end
 end

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

@@ -1,4 +1,4 @@
-image: ruby:2.4
+image: ruby:2.7
 
 stages:
   - triage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.26.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -171,6 +171,7 @@ files:
 - 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
@@ -197,6 +198,8 @@ 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/branch_date_filter.rb
+- lib/gitlab/triage/filters/branch_protected_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
@@ -225,6 +228,7 @@ files:
 - 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