gitlab-dangerfiles 3.10.0 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad2ad158af390c0b6b52fdd86927b4dd0a6118b7b2eca3ad60aaa88ac40b840a
-  data.tar.gz: 2872e01e85bf7190e2a3fd4cab71868f2e4924234443797e7479a3ab03497120
+  metadata.gz: edf969f524278d280762935cb8a04c78a22180296c3b7e88deb342ab8f83c840
+  data.tar.gz: 6b3b3c493beb17172786cefaa6e6ac1dd1ef243234b5e90e632b79830a7fae9c
 SHA512:
-  metadata.gz: 7dccc5481318999e83be3a9535983ebbf69d731d5394cf66543df0fd77bf7e274d1b012255c9582a503caae5248956aa2441af1b9ad6ffddf6c5bc2bc730013b
-  data.tar.gz: 5d217f45be9fb3c68032bbffd9a7eee4eb4cdb4056200c8dabdaf8255aa084a28ff3cd3ac74a5fa2588634607c4a5d23ffc6d58cc709e9343296112b6b3457b3
+  metadata.gz: 56e849f993eec188646a8f06106855409146070234b158c8cd48abe0378008c9d1c957dafbb1af6dbee4f86744014d1a852bc426993337f8b9978b9e7cdcdd80
+  data.tar.gz: 19f31baf98812c924fc62d88cdc601f0f73a0c9e0c239647e25d6e79c6a1a4eaec831397658883b9cc9aff70e0fabee8e3f4df0908f119c0262788296097793e

data/.gitlab/merge_request_templates/Release.md

@@ -2,7 +2,7 @@
 commit from this merge request, and `<NEW_VERSION>` with the upcoming version number. -->
 ## Diff
 
-https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/compare/v<PREVIOUS_VERSION>...<COMMIT_UPDATING_VERSION>
+https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/compare/v<PREVIOUS_VERSION>...<COMMIT_UPDATING_VERSION>
 
 ## Checklist
 

data/lib/danger/plugins/roulette.rb

@@ -11,11 +11,7 @@ module Danger
     ROULETTE_DATA_URL = "https://gitlab-org.gitlab.io/gitlab-roulette/roulette.json"
     HOURS_WHEN_PERSON_CAN_BE_PICKED = (6..14).freeze
 
-    INCLUDE_TIMEZONE_FOR_CATEGORY = {
-      database: false,
-    }.freeze
-
-    Spin = Struct.new(:category, :reviewer, :maintainer, :optional_role, :timezone_experiment)
+    Spin = Struct.new(:category, :reviewer, :maintainer, :optional_role)
     HTTPError = Class.new(StandardError)
 
     Approval = Struct.new(:category, :spin) do
@@ -33,6 +29,34 @@ module Danger
       end
     end
 
+    def prepare_categories(changes_keys)
+      categories = Set.new(changes_keys)
+
+      # Ensure to spin for database reviewer/maintainer when ~database is applied (e.g. to review SQL queries)
+      categories << :database if labels.include?("database")
+
+      # Ensure to spin for Analytics Instrumentation reviewer when ~"analytics instrumentation::review pending" is applied
+      categories << :analytics_instrumentation if labels.include?("analytics instrumentation::review pending")
+
+      # Skip Analytics Instrumentation reviews for growth experiment MRs
+      categories.delete(:analytics_instrumentation) if labels.include?("growth experiment")
+
+      prepare_ux_category!(categories) if labels.include?("UX")
+
+      # Remove disabled categories
+      categories.subtract(helper.config.disabled_roulette_categories)
+
+      categories
+    end
+
+    def assign_pedroms_for_ux_wider_community_contribution(spins)
+      # We want at least a UX reviewer who can review any wider community
+      # contribution even without a team designer. We assign this to Pedro.
+      ux_spin = look_for_fallback_designer_for_ux_wider_community_contribution?(spins)
+
+      ux_spin && ux_spin.reviewer = teammate_pedroms
+    end
+
     # Finds the +Gitlab::Dangerfiles::Teammate+ object whose username matches the MR author username.
     #
     # @return [Gitlab::Dangerfiles::Teammate]
@@ -45,26 +69,22 @@ module Danger
     #
     # @param project [String] A project path.
     # @param categories [Array<Symbol>] An array of categories symbols.
-    # @param timezone_experiment [Boolean] Whether to select reviewers based in timezone or not.
     #
     # @return [Array<Spin>]
     # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    def spin(project = nil, categories = [:none], timezone_experiment: false)
+    def spin(project = nil, categories = [:none])
       project = (project || config_project_name).downcase
       categories = categories.map { |category| category&.downcase || :none }
       categories.reject! { |category| import_and_integrate_reject_category?(category, project) }
 
       spins = categories.sort_by(&:to_s).map do |category|
-        including_timezone = INCLUDE_TIMEZONE_FOR_CATEGORY.fetch(category, timezone_experiment)
-
-        spin_for_category(project, category, timezone_experiment: including_timezone)
+        spin_for_category(project, category)
       end
 
       backend_spin = spins.find { |spin| spin.category == :backend }
       frontend_spin = spins.find { |spin| spin.category == :frontend }
 
       spins.each do |spin|
-        including_timezone = INCLUDE_TIMEZONE_FOR_CATEGORY.fetch(spin.category, timezone_experiment)
         case spin.category
         when :qa
           # MR includes QA changes, but also other changes, and author isn't an SET
@@ -77,24 +97,24 @@ module Danger
 
           if spin.reviewer.nil?
             # Fetch an already picked backend reviewer, or pick one otherwise
-            spin.reviewer = backend_spin&.reviewer || spin_for_category(project, :backend, timezone_experiment: including_timezone).reviewer
+            spin.reviewer = backend_spin&.reviewer || spin_for_category(project, :backend).reviewer
           end
         when :tooling, :engineering_productivity # Deprecated as of 2.3.0 in favor of tooling
           if spin.maintainer.nil?
             # Fetch an already picked backend maintainer, or pick one otherwise
-            spin.maintainer = backend_spin&.maintainer || spin_for_category(project, :backend, timezone_experiment: including_timezone).maintainer
+            spin.maintainer = backend_spin&.maintainer || spin_for_category(project, :backend).maintainer
           end
         when :ci_template
           if spin.maintainer.nil?
             # Fetch an already picked backend maintainer, or pick one otherwise
-            spin.maintainer = backend_spin&.maintainer || spin_for_category(project, :backend, timezone_experiment: including_timezone).maintainer
+            spin.maintainer = backend_spin&.maintainer || spin_for_category(project, :backend).maintainer
           end
         when :analytics_instrumentation
           spin.optional_role = :maintainer
 
           if spin.maintainer.nil?
             # Fetch an already picked maintainer, or pick one otherwise
-            spin.maintainer = backend_spin&.maintainer || frontend_spin&.maintainer || spin_for_category(project, :backend, timezone_experiment: including_timezone).maintainer
+            spin.maintainer = backend_spin&.maintainer || frontend_spin&.maintainer || spin_for_category(project, :backend).maintainer
           end
         when :import_integrate_be, :import_integrate_fe
           spin.optional_role = :maintainer
@@ -108,7 +128,7 @@ module Danger
 
     # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-    def required_approvals
+    def codeowners_approvals
       approval_rules = helper.mr_approval_state["rules"]
 
       return [] unless approval_rules
@@ -124,13 +144,29 @@ module Danger
       @warnings ||= []
     end
 
+    def teammate_pedroms
+      @teammate_pedroms ||= find_member("pedroms")
+    end
+
+    alias_method :required_approvals, :codeowners_approvals
+
     private
 
     def spin_for_approval_rule?(rule)
       rule["rule_type"] == "code_owner" &&
-        rule["approvals_required"] > 0 &&
+        should_include_codeowners_rule?(rule) &&
         # Exclude generic codeowners rule, which should be covered by others already
-        !generic_codeowners_rule?(rule)
+        !generic_codeowners_rule?(rule) &&
+        !excluded_required_codeowners_rule?(rule)
+    end
+
+    def should_include_codeowners_rule?(rule)
+      rule["approvals_required"] > 0 ||
+        helper.config.included_optional_codeowners_sections_for_roulette.include?(rule["section"])
+    end
+
+    def excluded_required_codeowners_rule?(rule)
+      helper.config.excluded_required_codeowners_sections_for_roulette.include?(rule["section"])
     end
 
     def generic_codeowners_rule?(rule)
@@ -159,12 +195,6 @@ module Danger
       !mr_author?(person) && person.available
     end
 
-    # @param [Gitlab::Dangerfiles::Teammate] person
-    # @return [Boolean]
-    def valid_person_with_timezone?(person)
-      valid_person?(person) && HOURS_WHEN_PERSON_CAN_BE_PICKED.cover?(person.local_hour)
-    end
-
     # @param [Gitlab::Dangerfiles::Teammate] person
     # @return [Boolean]
     def mr_author?(person)
@@ -175,8 +205,8 @@ module Danger
     # @return [Boolean]
     def import_and_integrate_reject_category?(category, project)
       # Reject Import and Integrate categories if the MR author has reviewing abilities for the category.
-      team_mr_author&.import_integrate_be?(project, category, helper.mr_labels) ||
-        team_mr_author&.import_integrate_fe?(project, category, helper.mr_labels)
+      team_mr_author&.import_integrate_be?(project, category, labels) ||
+        team_mr_author&.import_integrate_fe?(project, category, labels)
     end
 
     def random
@@ -185,7 +215,7 @@ module Danger
 
     def spin_role_for_category(team, role, project, category)
       team.select do |member|
-        member.public_send("#{role}?", project, category, helper.mr_labels)
+        member.public_send("#{role}?", project, category, labels)
       end
     end
 
@@ -195,14 +225,10 @@ module Danger
     # @param [Array<Gitlab::Dangerfiles::Teammate>] people
     #
     # @return [Gitlab::Dangerfiles::Teammate]
-    def spin_for_person(people, timezone_experiment: false)
+    def spin_for_person(people)
       shuffled_people = people.shuffle(random: random)
 
-      if timezone_experiment
-        shuffled_people.find(&method(:valid_person_with_timezone?))
-      else
-        shuffled_people.find(&method(:valid_person?))
-      end
+      shuffled_people.find(&method(:valid_person?))
     end
 
     # Spin a reviewer for a particular approval rule
@@ -242,7 +268,7 @@ module Danger
       fallback_approvers.sample(random: random)
     end
 
-    def spin_for_category(project, category, timezone_experiment: false)
+    def spin_for_category(project, category)
       team = project_team(project)
       reviewers, traintainers, maintainers =
         %i[reviewer traintainer maintainer].map do |role|
@@ -252,10 +278,42 @@ module Danger
       weighted_reviewers = Gitlab::Dangerfiles::Weightage::Reviewers.new(reviewers, traintainers).execute
       weighted_maintainers = Gitlab::Dangerfiles::Weightage::Maintainers.new(maintainers).execute
 
-      reviewer = spin_for_person(weighted_reviewers, timezone_experiment: timezone_experiment)
-      maintainer = spin_for_person(weighted_maintainers, timezone_experiment: timezone_experiment)
+      reviewer = spin_for_person(weighted_reviewers)
+      maintainer = spin_for_person(weighted_maintainers)
 
-      Spin.new(category, reviewer, maintainer, false, timezone_experiment)
+      Spin.new(category, reviewer, maintainer, false)
+    end
+
+    def prepare_ux_category!(categories)
+      # Ensure to spin for UX reviewer when ~UX is applied (e.g. to review changes to the UI)
+      if labels.include?("Community contribution")
+        categories << :ux
+      else
+        begin
+          # We only want to spin a reviewer for merge requests which has a
+          # designer for the team. There's no easy way to tell this, so we
+          # pretend this is a community contribution, in which case we only
+          # pick the team designer. If there's no one got picked, it means
+          # there's no designer for this team.
+          labels << "Community contribution"
+
+          ux_spin = spin(nil, [:ux]).first
+
+          categories << :ux if ux_spin.reviewer || ux_spin.maintainer
+        ensure
+          # Make sure we delete the label afterward
+          labels.delete("Community contribution")
+        end
+      end
+    end
+
+    def look_for_fallback_designer_for_ux_wider_community_contribution?(spins)
+      labels.include?("Community contribution") &&
+        spins.find do |spin|
+          spin.category == :ux &&
+            spin.reviewer.nil? &&
+            spin.maintainer.nil?
+        end
     end
 
     # Fetches the given +url+ and parse its response as JSON.
@@ -316,14 +374,20 @@ module Danger
       helper.config.project_name
     end
 
+    # Return the labels from the merge requests. This is cached.
+    #
+    # @return [String]
+    def labels
+      @labels ||= helper.mr_labels
+    end
+
     # Like +team+, but only returns teammates in the current project, based on
     # project_name.
     #
     # @return [Array<Gitlab::Dangerfiles::Teammate>]
     def project_team(project_name)
       company_members.select do |member|
-        member.in_project?(project_name) ||
-          member.in_project?("gitlab") # Used for universal reviewer
+        member.in_project?(project_name)
       end
     rescue => err
       warn("Reviewer roulette failed to load team data: #{err.message}")

data/lib/danger/rules/simple_roulette/Dangerfile

@@ -81,30 +81,16 @@ def warning_list(roulette)
 end
 
 changes = helper.changes_by_category
-
-# Replicating label based categories from:
-# https://gitlab.com/gitlab-org/gitlab/-/blob/master/danger/roulette/Dangerfile
-categories = Set.new(changes.keys)
-
-# Ensure to spin for database reviewer/maintainer when ~database is applied (e.g. to review SQL queries)
-categories << :database if helper.mr_labels.include?('database')
-
-# Ensure to spin for UX reviewer when ~UX is applied (e.g. to review changes to the UI) except when it's from wider community contribution where we want to assign from the corresponding group
-categories << :ux if helper.mr_labels.include?('UX') && !helper.mr_labels.include?('Community contribution')
-
-# Ensure to spin for Analytics Instrumentation reviewer when ~"analytics instrumentation::review pending" is applied
-categories << :analytics_instrumentation if helper.mr_labels.include?("analytics instrumentation::review pending")
-
-# Skip Analytics Instrumentation reviews for growth experiment MRs
-categories.delete(:analytics_instrumentation) if helper.mr_labels.include?("growth experiment")
-
-# Remove disabled categories
-categories.subtract(helper.config.disabled_roulette_categories)
+categories = roulette.prepare_categories(changes.keys)
 
 if changes.any?
   show_category_column = categories.size > 1 || categories.first != :none
   random_roulette_spins = roulette.spin(nil, categories)
 
+  if categories.include?(:ux)
+    roulette.assign_pedroms_for_ux_wider_community_contribution(random_roulette_spins)
+  end
+
   rows = random_roulette_spins.map do |spin|
     markdown_row_for_spins(spin.category, [spin], show_category_column: show_category_column)
   end

data/lib/gitlab/dangerfiles/category.rb

@@ -21,19 +21,11 @@ module Gitlab
       end
       private_class_method :name_to_class
 
-      def has_capability?(...)
-        has_particular_capability?(...) || has_universal_capability?(...)
-      end
-
-      private
-
-      def has_particular_capability?(teammate)
+      def has_capability?(teammate)
         teammate.capabilities(project).include?(capability)
       end
 
-      def has_universal_capability?(teammate)
-        false
-      end
+      private
 
       def capability
         @capability ||= "#{kind} #{name}"
@@ -46,21 +38,17 @@ module Gitlab
       end
 
       class Test < Category
-        private
-
-        def has_particular_capability?(teammate)
+        def has_capability?(teammate)
           return false if kind != :reviewer
 
           area = teammate.role[/Software Engineer in Test(?:.*?, (\w+))/, 1]
 
-          area && labels.any?("devops::#{area.downcase}")
+          !!area && labels.any?("devops::#{area.downcase}")
         end
       end
 
       class Tooling < Category
-        private
-
-        def has_particular_capability?(teammate)
+        def has_capability?(teammate)
           if super
             true
           elsif %i[trainee_maintainer maintainer].include?(kind)
@@ -72,59 +60,52 @@ module Gitlab
       end
 
       class ImportIntegrateBE < Category
-        private
-
-        def has_particular_capability?(teammate)
+        def has_capability?(teammate)
           kind == :reviewer &&
             teammate.role.match?(/Backend Engineer.+Manage:Import and Integrate/)
         end
       end
 
       class ImportIntegrateFE < Category
-        private
-
-        def has_particular_capability?(teammate)
+        def has_capability?(teammate)
           kind == :reviewer &&
             teammate.role.match?(/Frontend Engineer.+Manage:Import and Integrate/)
         end
       end
 
       class UX < Category
+        def has_capability?(teammate)
+          super &&
+
+            if labels.any?("Community contribution")
+              can_review_wider_community_contribution?(teammate)
+            else
+              can_review_team_memeber_contribution?(teammate)
+            end
+        end
+
         private
 
-        def has_particular_capability?(teammate)
-          if labels.any?("Community contribution")
-            can_review_wider_community_contribution?(teammate)
-          else
-            super
-          end
+        def can_review_wider_community_contribution?(teammate)
+          # We want the designer for the team to review the wider community
+          # contribution because they're more familiar with that area.
+          the_designer_for_the_team?(teammate)
         end
 
-        def has_universal_capability?(teammate)
-          # No universal reviewer for community contribution.
-          # If we do, then picking from corresponding group won't be accurate.
-          # After solving the following issue, then we can revisit this:
-          # https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/issues/58
-          return false if labels.any?("Community contribution")
-
-          teammate.projects.each_value.any? do |capabilities|
-            capabilities.include?(capability)
-          end
+        def can_review_team_memeber_contribution?(teammate)
+          # We don't want the designer for the team to review merge
+          # requests for the same team which is designed by themselves.
+          # So they can only review if they're not the designer for the team.
+          !the_designer_for_the_team?(teammate)
         end
 
-        def can_review_wider_community_contribution?(teammate)
+        def the_designer_for_the_team?(teammate)
           # Pick corresponding group for community contribution
-          # Role can be:
-          # Product Designer, Create:Source Code
-          # Product Designer, Verify:Pipeline Insights, Verify:Runner
-          # Product Designer, Release
           # Specialty can be:
           # Source Code
           # [Growth: Activation, Growth: Expansion]
           # Runner
-          areas = teammate.role[/Product Designer(?:.*?, (.+))/, 1]&.split(",")
-
-          group_labels = [*teammate.specialty, *areas].map do |field|
+          group_labels = Array(teammate.specialty).map do |field|
             group = field.strip.sub(/^.+: ?/, "").downcase
 
             "group::#{group}"

data/lib/gitlab/dangerfiles/config.rb

@@ -33,6 +33,14 @@ module Gitlab
       #   @return [Array] indicating which categories would be disabled for the simple roulette. Default to `[]` (all categories are enabled)
       attr_accessor :disabled_roulette_categories
 
+      # @!attribute included_optional_codeowners_sections_for_roulette
+      #   @return [Array] indicating which optional codeowners sections should be included in roulette. Default to `[]`.
+      attr_accessor :included_optional_codeowners_sections_for_roulette
+
+      # @!attribute excluded_required_codeowners_sections_for_roulette
+      #   @return [Array] indicating which required codeowners sections should be excluded from roulette. Default to `[]`.
+      attr_accessor :excluded_required_codeowners_sections_for_roulette
+
       DEFAULT_CHANGES_SIZE_THRESHOLDS = { high: 2_000, medium: 500 }.freeze
       DEFAULT_COMMIT_MESSAGES_MAX_COMMITS_COUNT = 10
 
@@ -44,6 +52,8 @@ module Gitlab
         @code_size_thresholds = DEFAULT_CHANGES_SIZE_THRESHOLDS
         @max_commits_count = DEFAULT_COMMIT_MESSAGES_MAX_COMMITS_COUNT
         @disabled_roulette_categories = []
+        @included_optional_codeowners_sections_for_roulette = []
+        @excluded_required_codeowners_sections_for_roulette = []
       end
     end
   end

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "3.10.0"
+    VERSION = "3.12.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.12.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2023-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake