danger-packwerk 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51e9864c6b966cd4b115e469a1f9fc2c2e316fd634590d43eea1e5030b353f0c
-  data.tar.gz: fbe8f70cb7c3d79017ea379ba7d8ec6fae2961fba98bb254f6b9ff99b1fa30be
+  metadata.gz: 0ad3f46c259911564eb4b955fb62e8152962db5c5682a6ba6000054dde9d8128
+  data.tar.gz: ef61b403058b20869cda462629724943317e55f5f4b1bfe125f9be7323a634c4
 SHA512:
-  metadata.gz: 8cff9b5c28a2357e3c910cfa3c4ee0fd502267950165422ad95c74a07fd0f01f57c613e092670cc41de4d57921a9d88308b02d6de516b481b92a36bfa9fff19c
-  data.tar.gz: fee7d3f4a94bed71d61ebcd878a63c8ad89bd60c9a44e4e18c4d2040442d2ede40483f28eb3ea66cefa69f3f0d5ecabadf3f3b4dc6b766b8b5d4e6ab2810fc4e
+  metadata.gz: cfc452185f83aef5f9ff5e53c475ac7472d7cfcda477a0a1f1fcc863704df6e93358a6e6096f5d4f1afb68176c687c8748a8c2c2562458c03bac47d120de91b4
+  data.tar.gz: '08df3f5e1d6e6d7367c3dc85f464346cf479dd13b5d831b26847b194f90190cb33e429c92095517124ae78eb0d23479c2a3b1146ab5a1ef529bfe967b9cf9192'

data/README.md

@@ -83,11 +83,11 @@ Without any configuration, `deprecated_references_yml_changes.check` should just
 `deprecated_references_yml_changes.check` can be configured to in the following ways:
 
 ### Change the message that displays in the markdown
-The default message displayed is from `lib/danger-packwerk/private/default_offenses_formatter.rb`. To customize this this, pass in `added_offenses_formatter` to `deprecated_references_yml_changes.check` in your `Dangerfile`. Here's a simple example:
+The default message displayed is from `lib/danger-packwerk/private/default_offenses_formatter.rb`. To customize this this, pass in `offenses_formatter` to `deprecated_references_yml_changes.check` in your `Dangerfile`. Here's a simple example:
 ```ruby
 deprecated_references_yml_changes.check(
   # Offenses are a T::Array[DangerPackwerk::BasicReferenceOffense]
-  added_offenses_formatter: -> (added_offenses) do
+  offenses_formatter: -> (added_offenses) do
     "There are #{added_offenses.count} new violations this line!"
   end
 )

data/lib/danger-packwerk/check/default_formatter.rb

@@ -0,0 +1,110 @@
+# typed: strict
+
+require 'code_ownership'
+
+module DangerPackwerk
+  module Check
+    class DefaultFormatter
+      include OffensesFormatter
+      extend T::Sig
+
+      sig do
+        params(
+          custom_help_message: T.nilable(String)
+        ).void
+      end
+      def initialize(custom_help_message: nil)
+        @custom_help_message = custom_help_message
+      end
+
+      sig do
+        override.params(
+          offenses: T::Array[Packwerk::ReferenceOffense],
+          repo_link: String,
+          org_name: String
+        ).returns(String)
+      end
+      def format_offenses(offenses, repo_link, org_name)
+        reference_offense = T.must(offenses.first)
+        violation_types = offenses.map(&:violation_type)
+        referencing_file = reference_offense.reference.relative_path
+        referencing_file_pack = ParsePackwerk.package_from_path(referencing_file).name
+        # We remove leading double colons as they feel like an implementation detail of packwerk.
+        constant_name = reference_offense.reference.constant.name.delete_prefix('::')
+
+        constant_source_package_name = reference_offense.reference.constant.package.name
+
+        constant_location = reference_offense.reference.constant.location
+        constant_source_package = T.must(ParsePackwerk.all.find { |p| p.name == constant_source_package_name })
+        constant_source_package_ownership_info = Private::OwnershipInformation.for_package(constant_source_package, org_name)
+
+        disclaimer = 'Before you run `bin/packwerk update-deprecations`, check out these quick suggestions:'
+        referencing_code_in_right_pack = "- Does the code you are writing live in the right pack?\n  - If not, try `bin/packs move packs/destination_pack #{referencing_file}`"
+        referenced_code_in_right_pack = "- Does #{constant_name} live in the right pack?\n  - If not, try `bin/packs move packs/destination_pack #{constant_location}`"
+        dependency_violation_message = "- Do we actually want to depend on #{constant_source_package_name}?\n  - If so, try `bin/packs add_dependency #{referencing_file_pack} #{constant_source_package_name}`\n  - If not, what can we change about the design so we do not have to depend on #{constant_source_package_name}?"
+        team_to_work_with = constant_source_package_ownership_info.owning_team ? constant_source_package_ownership_info.markdown_link_to_github_members_no_tag : 'the pack owner'
+        privacy_violation_message = "- Does API in #{constant_source_package.name}/public support this use case?\n  - If not, can we work with #{team_to_work_with} to create and use a public API?\n  - If `#{constant_name}` should already be public, try `bin/packs make_public #{constant_location}`."
+
+        if violation_types.include?(Packwerk::ViolationType::Dependency) && violation_types.include?(Packwerk::ViolationType::Privacy)
+          <<~MESSAGE
+            **Packwerk Violation**
+            - Type: Privacy :lock: + Dependency :knot:
+            - Constant: [<ins>`#{constant_name}`</ins>](#{repo_link}/blob/main/#{constant_location})
+            - Owning pack: #{constant_source_package_name}
+              #{constant_source_package_ownership_info.ownership_copy}
+
+            <details><summary>Quick suggestions :bulb:</summary>
+
+            #{disclaimer}
+            #{referencing_code_in_right_pack}
+            #{referenced_code_in_right_pack}
+            #{dependency_violation_message}
+            #{privacy_violation_message}
+
+            </details>
+
+            _#{@custom_help_message}_
+          MESSAGE
+        elsif violation_types.include?(Packwerk::ViolationType::Dependency)
+          <<~MESSAGE
+            **Packwerk Violation**
+            - Type: Dependency :knot:
+            - Constant: [<ins>`#{constant_name}`</ins>](#{repo_link}/blob/main/#{constant_location})
+            - Owning pack: #{constant_source_package_name}
+              #{constant_source_package_ownership_info.ownership_copy}
+
+            <details><summary>Quick suggestions :bulb:</summary>
+
+            #{disclaimer}
+            #{referencing_code_in_right_pack}
+            #{referenced_code_in_right_pack}
+            #{dependency_violation_message}
+
+            </details>
+
+            _#{@custom_help_message}_
+          MESSAGE
+        else # violation_types.include?(Packwerk::ViolationType::Privacy)
+          <<~MESSAGE
+            **Packwerk Violation**
+            - Type: Privacy :lock:
+            - Constant: [<ins>`#{constant_name}`</ins>](#{repo_link}/blob/main/#{constant_location})
+            - Owning pack: #{constant_source_package_name}
+              #{constant_source_package_ownership_info.ownership_copy}
+
+            <details><summary>Quick suggestions :bulb:</summary>
+
+            #{disclaimer}
+            #{referencing_code_in_right_pack}
+            #{referenced_code_in_right_pack}
+            #{privacy_violation_message}
+
+            </details>
+
+            _#{@custom_help_message}_
+          MESSAGE
+        end
+      end
+    end
+  end
+end

data/lib/danger-packwerk/check/offenses_formatter.rb

@@ -0,0 +1,23 @@
+# typed: strict
+
+require 'code_ownership'
+
+module DangerPackwerk
+  module Check
+    module OffensesFormatter
+      extend T::Sig
+      extend T::Helpers
+
+      interface!
+
+      sig do
+        abstract.params(
+          offenses: T::Array[Packwerk::ReferenceOffense],
+          repo_link: String,
+          org_name: String
+        ).returns(String)
+      end
+      def format_offenses(offenses, repo_link, org_name); end
+    end
+  end
+end

data/lib/danger-packwerk/danger_deprecated_references_yml_changes.rb

@@ -17,23 +17,25 @@ module DangerPackwerk
     # Therefore we hope to capture the majority case of people making changes to code while not spamming PRs that do a big rename.
     # We set a max (rather than unlimited) to avoid GitHub rate limiting and general spam if a PR does some sort of mass rename.
     DEFAULT_MAX_COMMENTS = 5
-    AddedOffensesFormatter = T.type_alias { T.proc.params(added_violations: T::Array[BasicReferenceOffense]).returns(String) }
-    DEFAULT_ADDED_OFFENSES_FORMATTER = T.let(->(added_violations) { Private::DefaultAddedOffensesFormatter.format(added_violations) }, AddedOffensesFormatter)
     BeforeComment = T.type_alias { T.proc.params(violation_diff: ViolationDiff, changed_deprecated_references_ymls: T::Array[String]).void }
     DEFAULT_BEFORE_COMMENT = T.let(->(violation_diff, changed_deprecated_references_ymls) {}, BeforeComment)
 
     sig do
       params(
-        added_offenses_formatter: AddedOffensesFormatter,
+        offenses_formatter: T.nilable(Update::OffensesFormatter),
         before_comment: BeforeComment,
         max_comments: Integer
       ).void
     end
     def check(
-      added_offenses_formatter: DEFAULT_ADDED_OFFENSES_FORMATTER,
+      offenses_formatter: nil,
       before_comment: DEFAULT_BEFORE_COMMENT,
       max_comments: DEFAULT_MAX_COMMENTS
     )
+      offenses_formatter ||= Update::DefaultFormatter.new
+      repo_link = github.pr_json[:base][:repo][:html_url]
+      org_name = github.pr_json[:base][:repo][:owner][:login]
+
       changed_deprecated_references_ymls = (git.modified_files + git.added_files + git.deleted_files).grep(DEPRECATED_REFERENCES_PATTERN)
 
       violation_diff = get_violation_diff
@@ -51,7 +53,7 @@ module DangerPackwerk
         location = T.must(violations.first).file_location
 
         markdown(
-          added_offenses_formatter.call(violations),
+          offenses_formatter.format_offenses(violations, repo_link, org_name),
           line: location.line_number,
           file: location.file
         )

data/lib/danger-packwerk/danger_packwerk.rb

@@ -19,8 +19,6 @@ module DangerPackwerk
     DEFAULT_MAX_COMMENTS = 15
     OnFailure = T.type_alias { T.proc.params(offenses: T::Array[Packwerk::ReferenceOffense]).void }
     DEFAULT_ON_FAILURE = T.let(->(offenses) {}, OnFailure)
-    OffensesFormatter = T.type_alias { T.proc.params(offenses: T::Array[Packwerk::ReferenceOffense]).returns(String) }
-    DEFAULT_OFFENSES_FORMATTER = T.let(->(offenses) { offenses.map(&:message).join("\n\n") }, OffensesFormatter)
     DEFAULT_FAIL = false
     DEFAULT_FAILURE_MESSAGE = 'Packwerk violations were detected! Please resolve them to unblock the build.'
 
@@ -35,8 +33,8 @@ module DangerPackwerk
 
     sig do
       params(
+        offenses_formatter: T.nilable(Check::OffensesFormatter),
         max_comments: Integer,
-        offenses_formatter: OffensesFormatter,
         fail_build: T::Boolean,
         failure_message: String,
         on_failure: OnFailure,
@@ -44,13 +42,17 @@ module DangerPackwerk
       ).void
     end
     def check(
+      offenses_formatter: nil,
       max_comments: DEFAULT_MAX_COMMENTS,
-      offenses_formatter: DEFAULT_OFFENSES_FORMATTER,
       fail_build: DEFAULT_FAIL,
       failure_message: DEFAULT_FAILURE_MESSAGE,
       on_failure: DEFAULT_ON_FAILURE,
       grouping_strategy: CommentGroupingStrategy::PerConstantPerLocation
     )
+      offenses_formatter ||= Check::DefaultFormatter.new
+      repo_link = github.pr_json[:base][:repo][:html_url]
+      org_name = github.pr_json[:base][:repo][:owner][:login]
+
       # This is important because by default, Danger will leave a concantenated list of all its messages if it can't find a commentable place in the
       # diff to leave its message. This is an especially bad UX because it will be a huge wall of text not connected to the source of the issue.
       # Furthermore, dismissing these ensures that something like moving a file from pack to pack does not trigger the danger message. That is,
@@ -120,7 +122,7 @@ module DangerPackwerk
         line_number = reference_offense.location&.line
         referencing_file = reference_offense.reference.relative_path
 
-        message = offenses_formatter.call(unique_packwerk_reference_offenses)
+        message = offenses_formatter.format_offenses(unique_packwerk_reference_offenses, repo_link, org_name)
 
         markdown(message, file: referencing_file, line: line_number)
       end

data/lib/danger-packwerk/private/ownership_information.rb

@@ -0,0 +1,60 @@
+# typed: strict
+
+require 'code_ownership'
+
+module DangerPackwerk
+  module Private
+    class OwnershipInformation < T::Struct
+      extend T::Sig
+
+      const :owning_team, T.nilable(CodeTeams::Team)
+      const :github_team, T.nilable(String)
+      const :slack_channel, T.nilable(String)
+      const :org_name, T.nilable(String)
+
+      sig { params(package: ParsePackwerk::Package, org_name: String).returns(OwnershipInformation) }
+      def self.for_package(package, org_name)
+        team = CodeOwnership.for_package(package)
+
+        if team.nil?
+          OwnershipInformation.new
+        else
+          OwnershipInformation.new(
+            owning_team: team,
+            github_team: team.raw_hash.fetch('github', {}).fetch('team', nil),
+            slack_channel: team.raw_hash.fetch('slack', {}).fetch('room_for_humans', nil),
+            org_name: org_name
+          )
+        end
+      end
+
+      sig { returns(String) }
+      def ownership_copy
+        github_team_flow_sensitive = github_team
+        slack_channel_flow_sensitive = slack_channel
+
+        if owning_team && github_team_flow_sensitive && slack_channel_flow_sensitive
+          team_slack_link = markdown_link_to_slack_room
+          "- Owned by #{markdown_link_to_github_members_no_tag} (Slack: #{team_slack_link})"
+        else
+          '- This pack is unowned.'
+        end
+      end
+
+      sig { returns(String) }
+      def markdown_link_to_slack_room
+        "[<ins>#{slack_channel}</ins>](https://slack.com/app_redirect?channel=#{T.must(slack_channel).delete('#')})"
+      end
+
+      #
+      # Note this will NOT tag the team on Github, but it will link
+      # to the mentioned team's members page. If you want to tag and
+      # link the team, simply use the string and Github will handle it.
+      #
+      sig { returns(String) }
+      def markdown_link_to_github_members_no_tag
+        "[<ins>#{github_team}</ins>](https://github.com/orgs/#{org_name}/teams/#{T.must(github_team).gsub("@#{org_name}/", '')}/members)"
+      end
+    end
+  end
+end

data/lib/danger-packwerk/private.rb

@@ -1,7 +1,7 @@
 # typed: strict
 
 require 'danger-packwerk/private/deprecated_references'
-require 'danger-packwerk/private/default_offenses_formatter'
+require 'danger-packwerk/private/ownership_information'
 require 'constant_resolver'
 
 module DangerPackwerk

data/lib/danger-packwerk/update/default_formatter.rb

@@ -0,0 +1,67 @@
+# typed: strict
+
+module DangerPackwerk
+  module Update
+    class DefaultFormatter
+      extend T::Sig
+      include OffensesFormatter
+
+      sig do
+        params(
+          custom_help_message: T.nilable(String)
+        ).void
+      end
+      def initialize(custom_help_message: nil)
+        @custom_help_message = custom_help_message
+      end
+
+      sig { override.params(offenses: T::Array[BasicReferenceOffense], repo_link: String, org_name: String).returns(String) }
+      def format_offenses(offenses, repo_link, org_name)
+        violation = T.must(offenses.first)
+        referencing_file_pack = ParsePackwerk.package_from_path(violation.file)
+        # We remove leading double colons as they feel like an implementation detail of packwerk.
+        constant_name = violation.class_name.delete_prefix('::')
+        constant_source_package_name = violation.to_package_name
+
+        constant_source_package = T.must(ParsePackwerk.find(constant_source_package_name))
+        constant_source_package_owner = Private::OwnershipInformation.for_package(constant_source_package, org_name)
+
+        package_referring_to_constant_owner = Private::OwnershipInformation.for_package(referencing_file_pack, org_name)
+
+        disclaimer = 'We noticed you ran `bin/packwerk update-deprecations`. Check out [the docs](https://github.com/Shopify/packwerk/blob/main/RESOLVING_VIOLATIONS.md) to see other ways to resolve violations.'
+        pluralized_violation = offenses.count > 1 ? 'these violations' : 'this violation'
+        request_to_add_context = "- Could you add some context as a reply here about why we needed to add #{pluralized_violation}?\n"
+
+        dependency_violation_message = "- cc #{package_referring_to_constant_owner.github_team} (#{package_referring_to_constant_owner.markdown_link_to_slack_room}) for the dependency violation.\n" if package_referring_to_constant_owner.owning_team
+
+        privacy_violation_message = "- cc #{constant_source_package_owner.github_team} (#{constant_source_package_owner.markdown_link_to_slack_room}) for the privacy violation.\n" if constant_source_package_owner.owning_team
+
+        if offenses.any?(&:dependency?) && offenses.any?(&:privacy?)
+          <<~MESSAGE.chomp
+            Hi again! It looks like `#{constant_name}` is private API of `#{constant_source_package_name}`, which is also not in `#{referencing_file_pack.name}`'s list of dependencies.
+            #{disclaimer}
+
+            #{request_to_add_context}#{dependency_violation_message}#{privacy_violation_message}
+            #{@custom_help_message}
+          MESSAGE
+        elsif offenses.any?(&:dependency?)
+          <<~MESSAGE.chomp
+            Hi again! It looks like `#{constant_name}` belongs to `#{constant_source_package_name}`, which is not in `#{referencing_file_pack.name}`'s list of dependencies.
+            #{disclaimer}
+
+            #{request_to_add_context}#{dependency_violation_message}
+            #{@custom_help_message}
+          MESSAGE
+        else # violations.any?(&:privacy?)
+          <<~MESSAGE.chomp
+            Hi again! It looks like `#{constant_name}` is private API of `#{constant_source_package_name}`.
+            #{disclaimer}
+
+            #{request_to_add_context}#{privacy_violation_message}
+            #{@custom_help_message}
+          MESSAGE
+        end
+      end
+    end
+  end
+end

data/lib/danger-packwerk/update/offenses_formatter.rb

@@ -0,0 +1,23 @@
+# typed: strict
+
+require 'code_ownership'
+
+module DangerPackwerk
+  module Update
+    module OffensesFormatter
+      extend T::Sig
+      extend T::Helpers
+
+      interface!
+
+      sig do
+        abstract.params(
+          offenses: T::Array[BasicReferenceOffense],
+          repo_link: String,
+          org_name: String
+        ).returns(String)
+      end
+      def format_offenses(offenses, repo_link, org_name); end
+    end
+  end
+end

data/lib/danger-packwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module DangerPackwerk
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

data/lib/danger-packwerk.rb

@@ -9,4 +9,8 @@ module DangerPackwerk
 
   require 'danger-packwerk/danger_packwerk'
   require 'danger-packwerk/danger_deprecated_references_yml_changes'
+  require 'danger-packwerk/check/offenses_formatter'
+  require 'danger-packwerk/check/default_formatter'
+  require 'danger-packwerk/update/offenses_formatter'
+  require 'danger-packwerk/update/default_formatter'
 end