code_ownership 1.29.2 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e796fdc12573836124effdc391e8443cb8ae82cdd5804d52ba417cf9fe21b57
-  data.tar.gz: bd19a776739342474b75840d51b8c8f441efe9ad7ac26fca58e3062c43426581
+  metadata.gz: 9810b0bbef35bf354841da08d53391f864e213540ebb61fa5117b98df3b20ba9
+  data.tar.gz: 70dd498844898d361494a86a0c57da788d69cbd7c03eb7e3883c0d4520781089
 SHA512:
-  metadata.gz: 72c79c8a88854736b955b006067b9e03578c3dab1463cdb9d7936340e83166d792ebe8b4075c9dd1642725de780681de2bc8434c494f6c5e3a9e4d379402880f
-  data.tar.gz: bd9a5a8adc21b80d30f34b18f9825969c3f2dfbf8f4b73367154c36867bfc4aa627bc70217cc7ef4480baf7af2d92954af834ecef3f95b6838b28427c5763229
+  metadata.gz: d17b0680d21a907fb5581fa98adc16255984580ac2336a2170d69ab1d11b281d9d180e68e2866435ed5aab8dec1dab90f5849d8431311ddaa3d9014c6a961e9d
+  data.tar.gz: 3e1d9cf9e16234c199085f1de858590af922c7416a219a84fbc3c55c274a1eff59c7b6dba95e66b46f141328dcbd82005cbdaa55cb45b5d0dac32d2778156602

data/lib/code_ownership/private/ownership_mappers/team_globs.rb

@@ -31,6 +31,58 @@ module CodeOwnership
           end
         end
 
+        class MappingContext < T::Struct
+          const :glob, String
+          const :team, CodeTeams::Team
+        end
+
+        class GlobOverlap < T::Struct
+          extend T::Sig
+
+          const :mapping_contexts, T::Array[MappingContext]
+
+          sig { returns(String) }
+          def description
+            # These are sorted only to prevent non-determinism in output between local and CI environments.
+            sorted_contexts = mapping_contexts.sort_by{|context| context.team.config_yml.to_s }
+            description_args = sorted_contexts.map do |context|
+              "`#{context.glob}` (from `#{context.team.config_yml}`)"
+            end
+
+            description_args.join(', ')
+          end
+        end
+
+        sig do
+          returns(T::Array[GlobOverlap])
+        end
+        def find_overlapping_globs
+          mapped_files = T.let({}, T::Hash[String, T::Array[MappingContext]])
+          CodeTeams.all.each_with_object({}) do |team, map| # rubocop:disable Style/ClassVars
+            TeamPlugins::Ownership.for(team).owned_globs.each do |glob|
+              Dir.glob(glob).each do |filename|
+                mapped_files[filename] ||= []
+                T.must(mapped_files[filename]) << MappingContext.new(glob: glob, team: team)
+              end
+            end
+          end
+
+          overlaps = T.let([], T::Array[GlobOverlap])
+          mapped_files.each do |filename, mapping_contexts|
+            if mapping_contexts.count > 1
+              overlaps << GlobOverlap.new(mapping_contexts: mapping_contexts)
+            end
+          end
+
+          deduplicated_overlaps = overlaps.uniq do |glob_overlap|
+            glob_overlap.mapping_contexts.map do |context|
+              [context.glob, context.team.name]
+            end
+          end
+
+          deduplicated_overlaps
+        end
+
         sig do
           override.params(file: String).
             returns(T.nilable(::CodeTeams::Team))

data/lib/code_ownership/private/validations/no_overlapping_globs.rb

@@ -0,0 +1,30 @@
+# typed: strict
+
+module CodeOwnership
+  module Private
+    module Validations
+      class NoOverlappingGlobs
+        extend T::Sig
+        extend T::Helpers
+        include Interface
+
+        sig { override.params(files: T::Array[String], autocorrect: T::Boolean, stage_changes: T::Boolean).returns(T::Array[String]) }
+        def validation_errors(files:, autocorrect: true, stage_changes: true)
+          overlapping_globs = OwnershipMappers::TeamGlobs.new.find_overlapping_globs
+
+          errors = T.let([], T::Array[String])
+
+          if overlapping_globs.any?
+            errors << <<~MSG
+              `owned_globs` cannot overlap between teams. The following globs overlap:
+
+              #{overlapping_globs.map { |overlap| "- #{overlap.description}"}.join("\n")}
+            MSG
+          end
+
+          errors
+        end
+      end
+    end
+  end
+end

data/lib/code_ownership/private.rb

@@ -10,6 +10,7 @@ require 'code_ownership/private/validations/interface'
 require 'code_ownership/private/validations/files_have_owners'
 require 'code_ownership/private/validations/github_codeowners_up_to_date'
 require 'code_ownership/private/validations/files_have_unique_owners'
+require 'code_ownership/private/validations/no_overlapping_globs'
 require 'code_ownership/private/ownership_mappers/interface'
 require 'code_ownership/private/ownership_mappers/file_annotations'
 require 'code_ownership/private/ownership_mappers/team_globs'
@@ -39,6 +40,7 @@ module CodeOwnership
         Validations::FilesHaveOwners.new,
         Validations::FilesHaveUniqueOwners.new,
         Validations::GithubCodeownersUpToDate.new,
+        Validations::NoOverlappingGlobs.new,
       ]
 
       errors = validators.flat_map do |validator|

data/lib/code_ownership.rb

@@ -58,7 +58,6 @@ module CodeOwnership
         ownership_information += ownership_for_mapper
       end
 
-      
       ownership_information << ""
     end
 
@@ -93,7 +92,25 @@ module CodeOwnership
   # first line that corresponds to a file with assigned ownership
   sig { params(backtrace: T.nilable(T::Array[String]), excluded_teams: T::Array[::CodeTeams::Team]).returns(T.nilable(::CodeTeams::Team)) }
   def for_backtrace(backtrace, excluded_teams: [])
-    return unless backtrace
+    first_owned_file_for_backtrace(backtrace, excluded_teams: excluded_teams)&.first
+  end
+
+  # Given a backtrace from either `Exception#backtrace` or `caller`, find the
+  # first owned file in it, useful for figuring out which file is being blamed.
+  sig { params(backtrace: T.nilable(T::Array[String]), excluded_teams: T::Array[::CodeTeams::Team]).returns(T.nilable([::CodeTeams::Team, String])) }
+  def first_owned_file_for_backtrace(backtrace, excluded_teams: [])
+    backtrace_with_ownership(backtrace).each do |(team, file)|
+      if team && !excluded_teams.include?(team)
+        return [team, file]
+      end
+    end
+
+    nil
+  end
+
+  sig { params(backtrace: T.nilable(T::Array[String])).returns(T::Enumerable[[T.nilable(::CodeTeams::Team), String]]) }
+  def backtrace_with_ownership(backtrace)
+    return [] unless backtrace
 
     # The pattern for a backtrace hasn't changed in forever and is considered
     # stable: https://github.com/ruby/ruby/blob/trunk/vm_backtrace.c#L303-L317
@@ -110,18 +127,19 @@ module CodeOwnership
         `(?<function>.*)' # Matches "`block (3 levels) in create'"
       \z}x
 
-    backtrace.each do |line|
+    backtrace.lazy.filter_map do |line|
       match = line.match(backtrace_line)
+      next unless match
 
-      if match
-        team = CodeOwnership.for_file(T.must(match[:file]))
-        if team && !excluded_teams.include?(team)
-          return team
-        end
-      end
+      file = T.must(match[:file])
+
+      [
+        CodeOwnership.for_file(file),
+        file,
+      ]
     end
-    nil
   end
+  private_class_method(:backtrace_with_ownership)
 
   sig { params(klass: T.nilable(T.any(Class, Module))).returns(T.nilable(::CodeTeams::Team)) }
   def for_class(klass)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.29.2
+  version: 1.30.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -148,6 +148,7 @@ files:
 - lib/code_ownership/private/validations/files_have_unique_owners.rb
 - lib/code_ownership/private/validations/github_codeowners_up_to_date.rb
 - lib/code_ownership/private/validations/interface.rb
+- lib/code_ownership/private/validations/no_overlapping_globs.rb
 - sorbet/config
 - sorbet/rbi/gems/code_teams@1.0.0.rbi
 - sorbet/rbi/gems/packs@0.0.2.rbi