gitlab-triage 0.14.1 → 0.15.0

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

@@ -9,7 +9,13 @@ module Gitlab
       class RulePolicy < BasePolicy
         # Build an issue from a single rule policy
         def build_issue
-          EntityBuilders::IssueBuilder.new(actions[:summarize], resources, net)
+          action = actions.fetch(:summarize, {})
+
+          EntityBuilders::IssueBuilder.new(
+            type: type,
+            action: action,
+            resources: resources,
+            network: network)
         end
       end
     end

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

@@ -10,13 +10,36 @@ module Gitlab
       class SummaryPolicy < BasePolicy
         # Build an issue from several rules policies
         def build_issue
-          EntityBuilders::IssueBuilder.new(actions[:summarize].merge(item: "{{description}}\n\n"), [], net).tap do |issue|
+          action = actions[:summarize]
+
+          EntityBuilders::IssueBuilder.new(
+            type: type,
+            action: action,
+            resources: [],
+            network: network).tap do |issue|
             issue.items =
               resources.map do |inner_policy_spec, inner_resources|
-                Policies::RulePolicy.new(type, inner_policy_spec, inner_resources, net).build_issue.description
+                Policies::RulePolicy.new(
+                  type, inner_policy_spec, inner_resources, network)
+                  .build_issue
+                  .description
               end.join("\n\n")
           end
         end
+
+        # Due to resources is a different type, this will never work
+        # FIXME: We should try to make sure type is consistent for resources
+        def comment?
+          false
+        end
+
+        private
+
+        def attach_resource_type(resources, type)
+          resources.each_with_object({}) do |(rule, rule_resources), result|
+            result[rule] = super(rule_resources, type)
+          end
+        end
       end
     end
   end

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

@@ -1,32 +1,71 @@
+# frozen_string_literal: true
+
 require_relative '../url_builders/url_builder'
 
 module Gitlab
   module Triage
     module Resource
       class Base
-        attr_reader :resource, :net
+        attr_reader :resource, :parent
+
+        CONFIDENTIAL_TEXT = '(confidential)'
 
-        def initialize(new_resource, new_net)
-          @resource = new_resource
-          @net = new_net
+        def self.define_field(name, &block)
+          define_method(name) do
+            if redact_confidential_attributes?
+              CONFIDENTIAL_TEXT
+            else
+              instance_eval(&block)
+            end
+          end
         end
 
-        private
+        def initialize(
+          resource, parent: nil, network: nil, redact_confidentials: true)
+          @resource = resource
+          @parent = parent
+          @network = network
+          @redact_confidentials = redact_confidentials
+        end
+
+        protected
+
+        def redact_confidential_attributes?
+          parent&.redact_confidential_attributes? ||
+            (@redact_confidentials && resource[:confidential])
+        end
 
         def network
-          net[:network]
+          parent&.network || @network
         end
 
+        private
+
         def url(params = {})
+          build_url(params: params)
+        end
+
+        def resource_url(params: {}, sub_resource_type: nil)
+          build_url(
+            params: params,
+            options: {
+              resource_id: resource[:iid],
+              sub_resource_type: sub_resource_type
+            }
+          )
+        end
+
+        def build_url(params: {}, options: {})
           UrlBuilders::UrlBuilder.new(
-            net_opts.merge(params: { per_page: 100 }.merge(params))
+            url_opts
+              .merge(options)
+              .merge(params: { per_page: 100 }.merge(params))
           ).build
         end
 
-        def net_opts
+        def url_opts
           {
-            host_url: net[:host_url],
-            api_version: net[:api_version],
+            network_options: network.options,
             resource_type: self.class.name.demodulize.underscore.pluralize,
             source: source,
             source_id: resource[:"#{source.singularize}_id"]

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

@@ -1,13 +1,23 @@
+# frozen_string_literal: true
+
 require_relative 'base'
-require_relative 'milestone'
+require_relative 'issue'
+require_relative 'merge_request'
 require_relative 'instance_version'
 
 module Gitlab
   module Triage
     module Resource
-      class Context < Base
+      module Context
         EvaluationError = Class.new(RuntimeError)
 
+        def self.build(resource, **options)
+          const_name = (resource[:type] || 'Base')
+            .to_s.singularize.camelcase
+
+          Resource.const_get(const_name).new(resource, **options).extend(self)
+        end
+
         def eval(ruby)
           instance_eval <<~RUBY
             begin
@@ -26,12 +36,7 @@ module Gitlab
         private
 
         def instance_version
-          @instance_version ||= InstanceVersion.new(net)
-        end
-
-        def milestone
-          @milestone ||=
-            resource[:milestone] && Milestone.new(resource[:milestone], net)
+          @instance_version ||= InstanceVersion.new(parent: self)
         end
       end
     end

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

@@ -4,8 +4,8 @@ module Gitlab
   module Triage
     module Resource
       class InstanceVersion < Base
-        def initialize(new_net)
-          super({}, new_net)
+        def initialize(**options)
+          super({}, options)
         end
 
         def version
@@ -26,8 +26,7 @@ module Gitlab
         def response
           @response ||=
             network.query_api_cached(
-              net[:token],
-              "#{net[:host_url]}/api/#{net[:api_version]}/version")
+              "#{network.options.host_url}/api/#{network.options.api_version}/version")
               .first
         end
       end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'shared/issuable'
+
+module Gitlab
+  module Triage
+    module Resource
+      class Issue < Base
+        include Shared::Issuable
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require 'date'
+require 'time'
+
+module Gitlab
+  module Triage
+    module Resource
+      class Label < Base
+        FIELDS = %i[
+          id
+          project_id
+          group_id
+          name
+          description
+          color
+          priority
+        ].freeze
+
+        TIME_FIELDS = %i[
+          added_at
+        ].freeze
+
+        FIELDS.each do |field|
+          define_field(field) do
+            resource[field]
+          end
+        end
+
+        TIME_FIELDS.each do |field|
+          define_field(field) do
+            value = resource[field]
+
+            Time.parse(value) if value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'label'
+require 'date'
+require 'time'
+
+module Gitlab
+  module Triage
+    module Resource
+      class LabelEvent < Base
+        FIELDS = %i[
+          id
+          resource_type
+          resource_id
+          action
+        ].freeze
+
+        TIME_FIELDS = %i[
+          created_at
+        ].freeze
+
+        FIELDS.each do |field|
+          define_field(field) do
+            resource[field]
+          end
+        end
+
+        TIME_FIELDS.each do |field|
+          define_field(field) do
+            value = resource[field]
+
+            Time.parse(value) if value
+          end
+        end
+
+        def label
+          @label ||= Label.new(
+            resource[:label].reverse_merge(added_at: resource[:created_at]),
+            parent: self)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'shared/issuable'
+
+module Gitlab
+  module Triage
+    module Resource
+      class MergeRequest < Base
+        include Shared::Issuable
+      end
+    end
+  end
+end

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

@@ -27,13 +27,13 @@ module Gitlab
         ].freeze
 
         FIELDS.each do |field|
-          define_method(field) do
+          define_field(field) do
             resource[field]
           end
         end
 
         DATE_FIELDS.each do |field|
-          define_method(field) do
+          define_field(field) do
             value = resource[field]
 
             Date.parse(value) if value
@@ -41,7 +41,7 @@ module Gitlab
         end
 
         TIME_FIELDS.each do |field|
-          define_method(field) do
+          define_field(field) do
             value = resource[field]
 
             Time.parse(value) if value
@@ -73,8 +73,8 @@ module Gitlab
         def all_active
           @all_active ||=
             network
-              .query_api_cached(net[:token], url(state: 'active'))
-              .map { |milestone| self.class.new(milestone, net) }
+              .query_api_cached(url(state: 'active'))
+              .map { |milestone| self.class.new(milestone, parent: self) }
         end
       end
     end

data/lib/gitlab/triage/resource/shared/issuable.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative '../label'
+require_relative '../label_event'
+require_relative '../milestone'
+
+module Gitlab
+  module Triage
+    module Resource
+      module Shared
+        module Issuable
+          def milestone
+            @milestone ||=
+              resource[:milestone] &&
+              Milestone.new(resource[:milestone], parent: self)
+          end
+
+          # This will be more useful when we have:
+          # https://gitlab.com/gitlab-org/gitlab-ce/issues/51011
+          def labels
+            @labels ||= resource[:labels] # an array of label names
+              .map { |label| Label.new({ name: label }, parent: self) }
+          end
+
+          # Make this an alias of `labels` when we have:
+          # https://gitlab.com/gitlab-org/gitlab-ce/issues/51011
+          def labels_with_details
+            @labels_with_details ||= label_events
+              .select { |event| event.action == 'add' }
+              .map(&:label)
+              .uniq(&:name)
+              .select { |label| resource[:labels].include?(label.name) }
+          end
+
+          def label_events
+            @label_events ||= query_label_events
+              .map { |label_event| LabelEvent.new(label_event, parent: self) }
+          end
+
+          def labels_chronologically
+            @labels_chronologically ||= labels_with_details.sort_by(&:added_at)
+          end
+
+          private
+
+          def query_label_events
+            network.query_api_cached(
+              resource_url(sub_resource_type: 'resource_label_events'))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,8 +3,9 @@ module Gitlab
     module UrlBuilders
       class UrlBuilder
         def initialize(options)
-          @host_url = options.fetch(:host_url)
-          @api_version = options.fetch(:api_version)
+          @network_options = options.fetch(:network_options)
+          @host_url = @network_options.host_url
+          @api_version = @network_options.api_version
           @source = options.fetch(:source, 'projects')
           @source_id = options.fetch(:source_id)
           @resource_type = options.fetch(:resource_type)

data/lib/gitlab/triage/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Triage
-    VERSION = '0.14.1'.freeze
+    VERSION = '0.15.0'.freeze
   end
 end

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

@@ -18,9 +18,9 @@ resource_rules:
       - name: Newest and oldest issues summary
         actions:
           summarize:
-            title: "Newest and oldest issues summary"
+            title: "Newest and oldest {{type}} summary"
             summary: |
-              Please triage the following issues:
+              Please triage the following {{type}}:
 
               {{items}}
 
@@ -36,7 +36,7 @@ resource_rules:
             actions:
               summarize:
                 item: "- [ ] [{{title}}]({{web_url}}) {{labels}}"
-                summary: "Please triage the following new issues:\n\n{{items}}"
+                summary: "Please triage the following new {{type}}:\n\n{{items}}"
           - name: Old issues
             conditions:
               state: opened
@@ -45,7 +45,7 @@ resource_rules:
             actions:
               summarize:
                 item: "- [ ] [{{title}}]({{web_url}}) {{labels}}"
-                summary: "Please triage the following old issues:\n\n{{items}}"
+                summary: "Please triage the following old {{type}}:\n\n{{items}}"
   merge_requests:
     rules:
       []