use_packwerk 0.65.0 → 0.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09fba875e35dbc9bec54523ce0d6b778624029daa850c4daf2320dc753064205'
-  data.tar.gz: f56b46f76d3111e04f1a09f642843fd48be5a656c336366ecfe2db796f26f0ff
+  metadata.gz: 2c36d9aa08d6196fcfc0a96e3846d0a44f8637f5dc800ac6a0778b7deac637df
+  data.tar.gz: 07b0910be565a9df52b31c63982ad8e8b75808b80de5b77ad78120293a48c890
 SHA512:
-  metadata.gz: e39623119c6f9f1507ebb1a1f7ef7a5eb979ce10af57ee86ac517d74a46f0f96560b333688948a88cac0ac0fcedd43711fdd07f23490de20ea324da924b3a786
-  data.tar.gz: aa492df65946f5d872a28c2328d609a4873c0c6c0183dd0d730de657ca42215d1a7be78e298ac8ca040bbef5432e8d5ce16dc8631364df153dbf8006178dc569
+  metadata.gz: 46635409558c2c7c0557fb6164a979988558c4d47d0b2467dd97728bd67a6b0c6b77c4614e2c25b49ac075b74de392d7b062b435e0b81b1f60cf2c0c4a044f05
+  data.tar.gz: 6ebd403c29e4a432d43e7ace961e68c84192e238f0ad3172ad6af8fc1800c6900684cf5e010eb2bd679870258e3ea7b8ddd0b6d9a87612d03c9809db303ccd39

data/lib/use_packwerk/cli.rb

@@ -77,5 +77,11 @@ module UsePackwerk
         per_file_processors: [UsePackwerk::RubocopPostProcessor.new, UsePackwerk::CodeOwnershipPostProcessor.new]
       )
     end
+
+    desc 'lint_deprecated_references', 'Ensures `deprecated_references.yml` files are up to date'
+    sig { void }
+    def lint_deprecated_references
+      UsePackwerk.lint_deprecated_references!
+    end
   end
 end

data/lib/use_packwerk/configuration.rb

@@ -13,10 +13,18 @@ module UsePackwerk
     sig { returns(UserEventLogger) }
     attr_accessor :user_event_logger
 
+    OnDeprecatedReferencesLintFailure = T.type_alias do
+      T.proc.params(output: String).void
+    end
+
+    sig { returns(OnDeprecatedReferencesLintFailure) }
+    attr_accessor :on_deprecated_references_lint_failure
+
     sig { void }
     def initialize
       @enforce_dependencies = T.let(default_enforce_dependencies, T::Boolean)
       @user_event_logger = T.let(DefaultUserEventLogger.new, UserEventLogger)
+      @on_deprecated_references_lint_failure = T.let(->(output) {}, OnDeprecatedReferencesLintFailure)
     end
 
     sig { returns(T::Boolean) }

data/lib/use_packwerk/private.rb

@@ -389,6 +389,52 @@ module UsePackwerk
       # otherwise `PackageProtections.config` will attempt to reload the client configuratoin.
       @loaded_client_configuration = false
     end
+
+    sig { returns(T::Hash[String, String]) }
+    def self.get_deprecated_references_contents
+      deprecated_references = {}
+      ParsePackwerk.all.each do |package|
+        deprecated_references_yml = ParsePackwerk::DeprecatedReferences.for(package).pathname
+        if deprecated_references_yml.exist?
+          deprecated_references[deprecated_references_yml.to_s] = deprecated_references_yml.read
+        end
+      end
+
+      deprecated_references
+    end
+
+    DeprecatedReferencesFiles = T.type_alias do
+      T::Hash[String, T.nilable(String)]
+    end
+
+    sig { params(before: DeprecatedReferencesFiles, after: DeprecatedReferencesFiles).returns(String) }
+    def self.diff_deprecated_references_yml(before, after)
+      dir_containing_contents_before = Dir.mktmpdir
+      dir_containing_contents_after = Dir.mktmpdir
+      begin
+        write_deprecated_references_to_tmp_folder(before, dir_containing_contents_before)
+        write_deprecated_references_to_tmp_folder(after, dir_containing_contents_after)
+
+        diff = `diff -r #{dir_containing_contents_before}/ #{dir_containing_contents_after}/`
+        # For ease of reading, sub out the tmp directory from the diff
+        diff.gsub(dir_containing_contents_before, '').gsub(dir_containing_contents_after, '')
+      ensure
+        FileUtils.remove_entry dir_containing_contents_before
+        FileUtils.remove_entry dir_containing_contents_after
+      end
+    end
+
+    sig { params(deprecated_references_files: DeprecatedReferencesFiles, tmp_folder: String).void }
+    def self.write_deprecated_references_to_tmp_folder(deprecated_references_files, tmp_folder)
+      deprecated_references_files.each do |filename, contents|
+        next if contents.nil?
+
+        tmp_folder_pathname = Pathname.new(tmp_folder)
+        temp_deprecated_references_yml = tmp_folder_pathname.join(filename)
+        FileUtils.mkdir_p(temp_deprecated_references_yml.dirname)
+        temp_deprecated_references_yml.write(contents)
+      end
+    end
   end
 
   private_constant :Private

data/lib/use_packwerk.rb

@@ -245,4 +245,40 @@ module UsePackwerk
     Private::PackwerkWrapper.packwerk_cli_execute_safely(argv, formatter)
     formatter.aggregated_offenses.compact
   end
+
+  sig { void }
+  def self.lint_deprecated_references!
+    contents_before = Private.get_deprecated_references_contents
+    UsePackwerk.execute(['update-deprecations'])
+    contents_after = Private.get_deprecated_references_contents
+    diff = Private.diff_deprecated_references_yml(contents_before, contents_after)
+
+    if diff == ''
+      # No diff generated by `update-deprecations`
+      exit 0
+    else
+      output = <<~OUTPUT
+        All `deprecated_references.yml` files must be up-to-date and that no diff is generated when running `bin/packwerk update-deprecations`.
+        This helps ensure a high quality signal in other engineers' PRs when inspecting new violations by ensuring there are no unrelated changes.
+
+        There are three main reasons there may be a diff:
+        1) Most likely, you may have stale violations, meaning there are old violations that no longer apply.
+        2) You may have some sort of auto-formatter set up somewhere (e.g. something that reformats YML files) that is, for example, changing double quotes to single quotes. Ensure this is turned off for these auto-generated files.
+        3) You may have edited these files manually. It's recommended to use the `bin/packwerk update-deprecations` command to make changes to `deprecated_references.yml` files.
+
+        In all cases, you can run `bin/packwerk update-deprecations` to update these files.
+
+        Here is the diff generated after running `update-deprecations`:
+        ```
+        #{diff}
+        ```
+
+      OUTPUT
+
+      puts output
+      UsePackwerk.config.on_deprecated_references_lint_failure.call(output)
+
+      exit 1
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.65.0
+  version: 0.66.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2022-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership