escape brackets for files owned with a file annotation (#108)

* escape brackets for files owned with an annotation

* bump version

Author: ashleywillard

code_ownership.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'code_ownership'
-  spec.version       = '1.37.0'
+  spec.version       = '1.38.0'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['[email protected]']
   spec.summary       = 'A gem to help engineering teams declare ownership of code'

lib/code_ownership/private.rb

@@ -99,6 +99,7 @@ def self.file_tracked?(file)
       in_unowned_globs = configuration.unowned_globs.any? do |unowned_glob|
         File.fnmatch?(unowned_glob, file, File::FNM_PATHNAME | File::FNM_EXTGLOB)
       end
+
       in_owned_globs && !in_unowned_globs && File.exist?(file)
     end
 

lib/code_ownership/private/ownership_mappers/file_annotations.rb

@@ -39,7 +39,8 @@ def globs_to_owner(files)
             owner = file_annotation_based_owner(filename_relative_to_root)
             next unless owner
 
-            mapping[filename_relative_to_root] = owner
+            escaped_filename = escaped_path_for_codeowners_file(filename_relative_to_root)
+            mapping[escaped_filename] = owner
           end
         end
 
@@ -55,7 +56,8 @@ def update_cache(cache, files)
 
           invalid_files = cache.keys.select do |file|
             # If a file is not tracked, it should be removed from the cache
-            !Private.file_tracked?(file) ||
+            unescaped_file = unescaped_path_for_codeowners_file(file)
+            !Private.file_tracked?(unescaped_file) ||
               # If a file no longer has a file annotation (i.e. `globs_to_owner` doesn't map it)
               # it should be removed from the cache
               # We make sure to only apply this to the input files since otherwise `updated_cache_for_files.key?(file)` would always return `false` when files == []
@@ -126,6 +128,32 @@ def description
 
         sig { override.void }
         def bust_caches!; end
+
+        sig { params(filename: String).returns(String) }
+        def escaped_path_for_codeowners_file(filename)
+          # Globs can contain certain regex characters, like "[" and "]".
+          # However, when we are generating a glob from a file annotation, we
+          # need to escape bracket characters and interpret them literally.
+          # Otherwise the resulting glob will not actually match the directory
+          # containing the file.
+          #
+          # Example
+          # filename: "/some/[xId]/myfile.tsx"
+          # matches: "/some/1/file"
+          # matches: "/some/2/file"
+          # matches: "/some/3/file"
+          # does not match!: "/some/[xId]/myfile.tsx"
+          filename.gsub(/[\[\]]/) { |x| "\\#{x}" }
+        end
+
+        sig { params(filename: String).returns(String) }
+        def unescaped_path_for_codeowners_file(filename)
+          # Globs can contain certain regex characters, like "[" and "]".
+          # We escape bracket characters and interpret them literally for
+          # the CODEOWNERS file. However, we want to compare the unescaped
+          # glob to the actual file path when we check if the file was deleted.
+          filename.gsub(/\\([\[\]])/, '\1')
+        end
       end
     end
   end

spec/lib/code_ownership/private/ownership_mappers/file_annotations_spec.rb

@@ -70,6 +70,23 @@ module CodeOwnership
           expect(CodeOwnership.for_file('frontend/javascripts/packages/my_package/owned_file.jsx').name).to eq 'Bar'
         end
       end
+
+      context 'javascript owned file with brackets' do
+        before do
+          write_configuration
+          write_file('config/teams/bar.yml', <<~CONTENTS)
+            name: Bar
+          CONTENTS
+
+          write_file('frontend/javascripts/packages/my_package/[formID]/owned_file.jsx', <<~CONTENTS)
+            // @team Bar
+          CONTENTS
+        end
+
+        it 'can find the owner of a javascript file with file annotations' do
+          expect(CodeOwnership.for_file('frontend/javascripts/packages/my_package/[formID]/owned_file.jsx').name).to eq 'Bar'
+        end
+      end
     end
 
     describe '.remove_file_annotation!' do