modularization_statistics 1.33.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfd014b44b30778ec250a807009b4803b8e4b81c99e4fcc46d70cfca8feca8bb
-  data.tar.gz: ba83025eaa394685d99a28eadb5a7e30893107396b1c723b055e7ab6c6e09895
+  metadata.gz: 3684ee2e07b5f3cba3bb7093be91b88725808a8a3d203e4ede46c7aa116d920c
+  data.tar.gz: 7872ee6e03ff44a158e2274861c0de2700227e976078e3c905dc8f102d58cfaa
 SHA512:
-  metadata.gz: ebad79ae91d8d0731d259574f515375ed2306cb6b89458e969141f5c02ff4c88f67f926e7eec2ffc29659c5486d49f61bcbe51fcec5f4157aa277c9ad46b2c7c
-  data.tar.gz: 3b833b67284142468e86361797fec62761db59e9917db398179593bd2df6e4de4bb392a8ce6b999fe91f7bde496aeabba1165b3341e69ba989ac733e2f27de4c
+  metadata.gz: c6d080bc0c7e9c199e37262c8949a9227510eae2e7cac98d8c90121f788aca0b5123da006ba4a3ade27b512b3a7373ea06f789f82d108d51dc6d83cdf3378291
+  data.tar.gz: 3333265a294391652a0d07199c897e6ff02f2e40536e9a3654f7cfa2c21d1bf91c4f6cff0d5771eeea581b3f17740621d317c7f2a4a058960fd1328a9a801457

data/README.md

@@ -43,6 +43,61 @@ ModularizationStatistics.report_to_datadog!(
 )
 ```
 
+It's recommended to run this in CI on the main/development branch so each new commit has metrics emitted for it.
+
+# Tracking Privacy and Dependency Violations Reliably
+With [`packwerk`](https://github.com/Shopify/packwerk), privacy and dependency violations do not show up until a package has set `enforce_privacy` and `enforce_dependency` (respectively) to `true`. As such, when you're first starting off, you'll see no violations, and then periodic large increases as teams start using these protections. If you're interested in looking at privacy and dependency violations over time as if all packages were enforcing dependencies and privacy the whole time, we recommend setting these values to be true before running modularization statistics in your CI.
+
+```ruby
+require 'modularization_statistics'
+
+namespace(:modularization) do
+  desc(
+    'Publish modularization stats to datadog. ' \
+      'Example: bin/rails "modularization:upload_statistics"'
+  )
+  task(:upload_statistics, [:verbose] => :environment) do |_, args|
+    ignored_paths = Pathname.glob('spec/fixtures/**/**')
+    source_code_pathnames = Pathname.glob('{app,components,lib,packs,spec}/**/**').select(&:file?) - ignored_paths
+
+    # To correctly track violations, we rewrite all `package.yml` files with
+    # `enforce_dependencies` and `enforce_privacy` set to true, then update deprecations.
+    old_packages = ParsePackwerk.all
+    old_packages.each do |package|
+      new_package = ParsePackwerk::Package.new(
+        dependencies: package.dependencies,
+        enforce_dependencies: true,
+        enforce_privacy: true,
+        metadata: package.metadata,
+        name: package.name
+      )
+      ParsePackwerk.write_package_yml!(new_package)
+    end
+
+    Packwerk::Cli.new.execute_command(['update-deprecations'])
+
+    # Now we reset it back so that the protection values are the same as the native packwerk configuration
+    old_packages.each do |package|
+      new_package = ParsePackwerk::Package.new(
+        dependencies: package.dependencies,
+        enforce_dependencies: package.enforce_dependencies,
+        enforce_privacy: package.enforce_privacy,
+        metadata: package.metadata,
+        name: package.name
+      )
+      ParsePackwerk.write_package_yml!(new_package)
+    end
+
+    ModularizationStatistics.report_to_datadog!(
+      datadog_client: Dogapi::Client.new(ENV.fetch('DATADOG_API_KEY')),
+      app_name: Rails.application.class.module_parent_name,
+      source_code_pathnames: source_code_pathnames,
+      verbose: args[:verbose] == 'true' || false
+    )
+  end
+end
+```
+
 # Using Other Observability Tools
 
 Right now this tool sends metrics to DataDog early. However, if you want to use this with other tools, you can call `ModularizationStatistics.get_metrics(...)` to get generic metrics that you can then send to whatever observability provider you use.

data/lib/modularization_statistics/private/datadog_reporter.rb

@@ -2,14 +2,19 @@
 # frozen_string_literal: true
 
 require 'dogapi'
+require 'modularization_statistics/private/metrics'
+require 'modularization_statistics/private/metrics/files'
+require 'modularization_statistics/private/metrics/public_usage'
+require 'modularization_statistics/private/metrics/protection_usage'
+require 'modularization_statistics/private/metrics/packages'
+require 'modularization_statistics/private/metrics/packages_by_team'
+require 'modularization_statistics/private/metrics/nested_packs'
 
 module ModularizationStatistics
   module Private
     class DatadogReporter
       extend T::Sig
 
-      UNKNOWN_OWNER = T.let('Unknown', String)
-
       sig do
         params(
           source_code_files: T::Array[SourceCodeFile],
@@ -17,22 +22,14 @@ module ModularizationStatistics
         ).returns(T::Array[GaugeMetric])
       end
       def self.get_metrics(source_code_files:, app_name:)
-        all_metrics = T.let([], T::Array[GaugeMetric])
-        app_level_tag = Tag.for('app', app_name)
-
-        source_code_files.group_by { |file| file.team_owner&.name }.each do |team_name, files_for_team|
-          file_tags = tags_for_team(team_name) + [app_level_tag]
-          all_metrics += get_file_metrics('by_team', file_tags, files_for_team)
-        end
-
-        file_tags = [app_level_tag]
-        all_metrics += get_file_metrics('totals', file_tags, source_code_files)
-
         packages = ParsePackwerk.all
-        all_metrics += get_package_metrics(packages, app_name)
-        all_metrics += get_package_metrics_by_team(packages, app_name)
 
-        all_metrics
+        [
+          *Metrics::Files.get_metrics(source_code_files, app_name),
+          *Metrics::Packages.get_package_metrics(packages, app_name),
+          *Metrics::PackagesByTeam.get_package_metrics_by_team(packages, app_name),
+          *Metrics::NestedPacks.get_nested_package_metrics(packages, app_name)
+        ]
       end
 
       sig do
@@ -58,268 +55,6 @@ module ModularizationStatistics
           end
         end
       end
-
-      sig { params(package: ParsePackwerk::Package, app_name: String).returns(T::Array[Tag]) }
-      def self.tags_for_package(package, app_name)
-        [
-          Tag.new(key: 'package', value: humanized_package_name(package.name)),
-          Tag.new(key: 'app', value: app_name),
-          *tags_for_team(CodeOwnership.for_package(package)&.name),
-        ]
-      end
-
-      sig { params(team_name: T.nilable(String)).returns(T::Array[Tag]) }
-      def self.tags_for_team(team_name)
-        [Tag.for('team', team_name || UNKNOWN_OWNER)]
-      end
-
-      sig { params(team_name: T.nilable(String)).returns(T::Array[Tag]) }
-      def self.tags_for_to_team(team_name)
-        [Tag.for('to_team', team_name || UNKNOWN_OWNER)]
-      end
-
-      private_class_method :tags_for_package
-
-      sig do
-        params(
-          packages: T::Array[ParsePackwerk::Package],
-          app_name: String
-        ).returns(T::Array[GaugeMetric])
-      end
-      def self.get_package_metrics(packages, app_name)
-        all_metrics = []
-        app_level_tag = Tag.for('app', app_name)
-        package_tags = T.let([app_level_tag], T::Array[Tag])
-        protected_packages = packages.map { |p| PackageProtections::ProtectedPackage.from(p) }
-
-        all_metrics << GaugeMetric.for('all_packages.count', packages.count, package_tags)
-        all_metrics << GaugeMetric.for('all_packages.dependencies.count', packages.sum { |package| package.dependencies.count }, package_tags)
-        all_metrics << GaugeMetric.for('all_packages.dependency_violations.count', protected_packages.sum { |package| file_count(package.violations.select(&:dependency?)) }, package_tags)
-        all_metrics << GaugeMetric.for('all_packages.privacy_violations.count', protected_packages.sum { |package| file_count(package.violations.select(&:privacy?)) }, package_tags)
-        all_metrics << GaugeMetric.for('all_packages.enforcing_dependencies.count', packages.count(&:enforces_dependencies?), package_tags)
-        all_metrics << GaugeMetric.for('all_packages.enforcing_privacy.count', packages.count(&:enforces_privacy?), package_tags)
-
-        all_metrics << GaugeMetric.for('all_packages.notify_on_package_yml_changes.count', packages.count { |p| p.metadata['notify_on_package_yml_changes'] }, package_tags)
-        all_metrics << GaugeMetric.for('all_packages.notify_on_new_violations.count', packages.count { |p| p.metadata['notify_on_new_violations'] }, package_tags)
-
-        all_metrics << GaugeMetric.for('all_packages.with_violations.count', protected_packages.count { |package| package.violations.any? }, package_tags)
-        all_metrics += self.get_public_usage_metrics('all_packages', packages, package_tags)
-        all_metrics << GaugeMetric.for('all_packages.has_readme.count', packages.count { |package| has_readme?(package) }, package_tags)
-
-        all_metrics += self.get_protections_metrics('all_packages', protected_packages, package_tags)
-        all_metrics << GaugeMetric.for('all_packages.package_based_file_ownership.count', packages.count { |package| !package.metadata['owner'].nil? }, package_tags)
-
-        inbound_violations_by_package = protected_packages.flat_map(&:violations).group_by(&:to_package_name)
-
-        protected_packages.each do |protected_package|
-          package = protected_package.original_package
-          package_tags = tags_for_package(package, app_name)
-
-          #
-          # VIOLATIONS (implicit dependencies)
-          #
-          outbound_violations = protected_package.violations
-          inbound_violations = inbound_violations_by_package[package.name] || []
-          all_dependency_violations = (outbound_violations + inbound_violations).select(&:dependency?)
-          all_privacy_violations = (outbound_violations + inbound_violations).select(&:privacy?)
-
-          all_metrics << GaugeMetric.for('by_package.dependency_violations.count', file_count(all_dependency_violations), package_tags)
-          all_metrics << GaugeMetric.for('by_package.privacy_violations.count', file_count(all_privacy_violations), package_tags)
-
-          all_metrics << GaugeMetric.for('by_package.outbound_dependency_violations.count', file_count(outbound_violations.select(&:dependency?)), package_tags)
-          all_metrics << GaugeMetric.for('by_package.inbound_dependency_violations.count', file_count(inbound_violations.select(&:dependency?)), package_tags)
-
-          all_metrics << GaugeMetric.for('by_package.outbound_privacy_violations.count', file_count(outbound_violations.select(&:privacy?)), package_tags)
-          all_metrics << GaugeMetric.for('by_package.inbound_privacy_violations.count', file_count(inbound_violations.select(&:privacy?)), package_tags)
-
-          all_metrics += self.get_public_usage_metrics('by_package', [package], package_tags)
-
-          protected_package.violations.group_by(&:to_package_name).each do |to_package_name, violations|
-            to_package = ParsePackwerk.find(to_package_name)
-            if to_package.nil?
-              raise StandardError, "Could not find matching package #{to_package_name}"
-            end
-
-            tags = package_tags + [Tag.for('to_package', humanized_package_name(to_package_name))] + tags_for_to_team(CodeOwnership.for_package(to_package)&.name)
-            all_metrics << GaugeMetric.for('by_package.outbound_dependency_violations.per_package.count', file_count(violations.select(&:dependency?)), tags)
-            all_metrics << GaugeMetric.for('by_package.outbound_privacy_violations.per_package.count', file_count(violations.select(&:privacy?)), tags)
-          end
-        end
-
-        inbound_explicit_dependency_by_package = {}
-        packages.each do |package|
-          package.dependencies.each do |explicit_dependency|
-            inbound_explicit_dependency_by_package[explicit_dependency] ||= []
-            inbound_explicit_dependency_by_package[explicit_dependency] << package.name
-          end
-        end
-
-        packages.each do |package| # rubocop:disable Style/CombinableLoops
-          package_tags = tags_for_package(package, app_name)
-
-          #
-          # EXPLICIT DEPENDENCIES
-          #
-          package.dependencies.each do |explicit_dependency|
-            to_package = ParsePackwerk.find(explicit_dependency)
-            if to_package.nil?
-              raise StandardError, "Could not find matching package #{explicit_dependency}"
-            end
-
-            tags = package_tags + [Tag.for('to_package', humanized_package_name(explicit_dependency))] + tags_for_to_team(CodeOwnership.for_package(to_package)&.name)
-            all_metrics << GaugeMetric.for('by_package.outbound_explicit_dependencies.per_package.count', 1, tags)
-          end
-
-          all_metrics << GaugeMetric.for('by_package.outbound_explicit_dependencies.count', package.dependencies.count, package_tags)
-          all_metrics << GaugeMetric.for('by_package.inbound_explicit_dependencies.count', inbound_explicit_dependency_by_package[package.name]&.count || 0, package_tags)
-        end
-
-        all_metrics
-      end
-
-      sig do
-        params(
-          all_packages: T::Array[ParsePackwerk::Package],
-          app_name: String
-        ).returns(T::Array[GaugeMetric])
-      end
-      def self.get_package_metrics_by_team(all_packages, app_name)
-        all_metrics = T.let([], T::Array[GaugeMetric])
-        app_level_tag = Tag.for('app', app_name)
-        all_protected_packages = all_packages.map { |p| PackageProtections::ProtectedPackage.from(p) }
-        all_protected_packages.group_by { |protected_package| CodeOwnership.for_package(protected_package.original_package)&.name }.each do |team_name, protected_packages_by_team|
-          # We look at `all_packages` because we care about ALL inbound violations across all teams
-          inbound_violations_by_package = all_protected_packages.flat_map(&:violations).group_by(&:to_package_name)
-
-          team_tags = tags_for_team(team_name) + [app_level_tag]
-          all_metrics << GaugeMetric.for('by_team.all_packages.count', protected_packages_by_team.count, team_tags)
-          all_metrics += self.get_protections_metrics('by_team', protected_packages_by_team, team_tags)
-          all_metrics += self.get_public_usage_metrics('by_team', protected_packages_by_team.map(&:original_package), team_tags)
-
-          all_metrics << GaugeMetric.for('by_team.notify_on_package_yml_changes.count', protected_packages_by_team.count { |p| p.metadata['notify_on_package_yml_changes'] }, team_tags)
-          all_metrics << GaugeMetric.for('by_team.notify_on_new_violations.count', protected_packages_by_team.count { |p| p.metadata['notify_on_new_violations'] }, team_tags)
-
-          #
-          # VIOLATIONS (implicit dependencies)
-          #
-          outbound_violations = protected_packages_by_team.flat_map(&:violations)
-          # Here we only look at packages_by_team because we only care about inbound violations onto packages for this team
-          inbound_violations = protected_packages_by_team.flat_map { |package| inbound_violations_by_package[package.name] || [] }
-          all_dependency_violations = (outbound_violations + inbound_violations).select(&:dependency?)
-          all_privacy_violations = (outbound_violations + inbound_violations).select(&:privacy?)
-
-          all_metrics << GaugeMetric.for('by_team.dependency_violations.count', file_count(all_dependency_violations), team_tags)
-          all_metrics << GaugeMetric.for('by_team.privacy_violations.count', file_count(all_privacy_violations), team_tags)
-
-          all_metrics << GaugeMetric.for('by_team.outbound_dependency_violations.count', file_count(outbound_violations.select(&:dependency?)), team_tags)
-          all_metrics << GaugeMetric.for('by_team.inbound_dependency_violations.count', file_count(inbound_violations.select(&:dependency?)), team_tags)
-
-          all_metrics << GaugeMetric.for('by_team.outbound_privacy_violations.count', file_count(outbound_violations.select(&:privacy?)), team_tags)
-          all_metrics << GaugeMetric.for('by_team.inbound_privacy_violations.count', file_count(inbound_violations.select(&:privacy?)), team_tags)
-
-          all_metrics << GaugeMetric.for('by_team.has_readme.count', protected_packages_by_team.count { |protected_package| has_readme?(protected_package.original_package) }, team_tags)
-
-          grouped_outbound_violations = outbound_violations.group_by do |violation|
-            to_package = ParsePackwerk.find(violation.to_package_name)
-            if to_package.nil?
-              raise StandardError, "Could not find matching package #{violation.to_package_name}"
-            end
-
-            CodeOwnership.for_package(to_package)&.name
-          end
-
-          grouped_outbound_violations.each do |to_team_name, violations|
-            tags = team_tags + tags_for_to_team(to_team_name)
-            all_metrics << GaugeMetric.for('by_team.outbound_dependency_violations.per_team.count', file_count(violations.select(&:dependency?)), tags)
-            all_metrics << GaugeMetric.for('by_team.outbound_privacy_violations.per_team.count', file_count(violations.select(&:privacy?)), tags)
-          end
-        end
-
-        all_metrics
-      end
-
-      private_class_method :get_package_metrics
-
-      sig do
-        params(
-          metric_name_suffix: String,
-          tags: T::Array[Tag],
-          files: T::Array[SourceCodeFile]
-        ).returns(T::Array[GaugeMetric])
-      end
-      def self.get_file_metrics(metric_name_suffix, tags, files)
-        [
-          GaugeMetric.for("component_files.#{metric_name_suffix}", files.count(&:componentized_file?), tags),
-          GaugeMetric.for("packaged_files.#{metric_name_suffix}", files.count(&:packaged_file?), tags),
-          GaugeMetric.for("all_files.#{metric_name_suffix}", files.count, tags),
-        ]
-      end
-
-      private_class_method :get_file_metrics
-
-      sig { params(prefix: String, protected_packages: T::Array[PackageProtections::ProtectedPackage], package_tags: T::Array[Tag]).returns(T::Array[GaugeMetric]) }
-      def self.get_protections_metrics(prefix, protected_packages, package_tags)
-        PackageProtections.all.flat_map do |protection|
-          PackageProtections::ViolationBehavior.each_value.map do |violation_behavior|
-            # https://github.com/Gusto/package_protections/pull/42 changed the public API of these violation behaviors.
-            # To preserve our ability to understand historical trends, we map to the old values.
-            # This allows our dashboards to continue to operate as expected.
-            # Note if we ever open source mod stats, we should probably inject this behavior so that new clients can see the new keys in their metrics.
-            violation_behavior_map = {
-              PackageProtections::ViolationBehavior::FailOnAny => 'fail_the_build_on_any_instances',
-              PackageProtections::ViolationBehavior::FailNever => 'no',
-              PackageProtections::ViolationBehavior::FailOnNew => 'fail_the_build_if_new_instances_appear',
-            }
-            violation_behavior_name = violation_behavior_map[violation_behavior]
-            metric_name = "#{prefix}.#{protection.identifier}.#{violation_behavior_name}.count"
-            count_of_packages = protected_packages.count { |p| p.violation_behavior_for(protection.identifier) == violation_behavior }
-            GaugeMetric.for(metric_name, count_of_packages, package_tags)
-          end
-        end
-      end
-
-      sig { params(prefix: String, packages: T::Array[ParsePackwerk::Package], package_tags: T::Array[Tag]).returns(T::Array[GaugeMetric]) }
-      def self.get_public_usage_metrics(prefix, packages, package_tags)
-        packages_except_for_root = packages.reject { |package| package.name == ParsePackwerk::ROOT_PACKAGE_NAME }
-        all_files = packages_except_for_root.flat_map do |package|
-          package.directory.glob('**/**.rb')
-        end
-
-        all_public_files = T.let([], T::Array[Pathname])
-        is_using_public_directory = 0
-        packages_except_for_root.each do |package|
-          public_files = package.directory.glob('app/public/**/**.rb')
-          all_public_files += public_files
-          is_using_public_directory += 1 if public_files.any?
-        end
-
-        # In Datadog, can divide public files by all files to get the ratio.
-        # This is not a metric that we are targeting -- its for observability and reflection only.
-        [
-          GaugeMetric.for("#{prefix}.all_files.count", all_files.count, package_tags),
-          GaugeMetric.for("#{prefix}.public_files.count", all_public_files.count, package_tags),
-          GaugeMetric.for("#{prefix}.using_public_directory.count", is_using_public_directory, package_tags),
-        ]
-      end
-
-      sig { params(package: ParsePackwerk::Package).returns(T::Boolean) }
-      def self.has_readme?(package)
-        package.directory.join('README.md').exist?
-      end
-
-      sig { params(violations: T::Array[ParsePackwerk::Violation]).returns(Integer) }
-      def self.file_count(violations)
-        violations.sum { |v| v.files.count }
-      end
-
-      sig { params(name: String).returns(String) }
-      def self.humanized_package_name(name)
-        if name == ParsePackwerk::ROOT_PACKAGE_NAME
-          'root'
-        else
-          name
-        end
-      end
     end
   end
 end

data/lib/modularization_statistics/private/metrics/files.rb

@@ -0,0 +1,47 @@
+# typed: strict
+# frozen_string_literal: true
+
+module ModularizationStatistics
+  module Private
+    module Metrics
+      class Files
+        extend T::Sig
+
+        sig do
+          params(
+            source_code_files: T::Array[SourceCodeFile],
+            app_name: String
+          ).returns(T::Array[GaugeMetric])
+        end
+        def self.get_metrics(source_code_files, app_name)
+          all_metrics = T.let([], T::Array[GaugeMetric])
+          app_level_tag = Tag.for('app', app_name)
+
+          source_code_files.group_by { |file| file.team_owner&.name }.each do |team_name, files_for_team|
+            file_tags = Metrics.tags_for_team(team_name) + [app_level_tag]
+            all_metrics += get_file_metrics('by_team', file_tags, files_for_team)
+          end
+
+          file_tags = [app_level_tag]
+          all_metrics += get_file_metrics('totals', file_tags, source_code_files)
+          all_metrics
+        end
+
+        sig do
+          params(
+            metric_name_suffix: String,
+            tags: T::Array[Tag],
+            files: T::Array[SourceCodeFile]
+          ).returns(T::Array[GaugeMetric])
+        end
+        def self.get_file_metrics(metric_name_suffix, tags, files)
+          [
+            GaugeMetric.for("component_files.#{metric_name_suffix}", files.count(&:componentized_file?), tags),
+            GaugeMetric.for("packaged_files.#{metric_name_suffix}", files.count(&:packaged_file?), tags),
+            GaugeMetric.for("all_files.#{metric_name_suffix}", files.count, tags),
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/modularization_statistics/private/metrics/nested_packs.rb

@@ -0,0 +1,137 @@
+# typed: strict
+# frozen_string_literal: true
+
+module ModularizationStatistics
+  module Private
+    module Metrics
+      class NestedPacks
+        extend T::Sig
+
+        class PackGroup < T::Struct
+          extend T::Sig
+
+          const :name, String
+          const :root, ParsePackwerk::Package
+          const :members, T::Array[ParsePackwerk::Package]
+
+          sig { params(packages: T::Array[ParsePackwerk::Package]).returns(T::Array[PackGroup]) }
+          def self.all_from(packages)
+            packs_by_group = {}
+
+            packages.each do |package|
+              # For a child pack, package.directory is `packs/fruits/apples` (i.e. the directory of the package.yml file).
+              # The package.directory.dirname is therefore `packs/fruits`.
+              # For a standalone pack, package.directory.dirname is `packs`
+              # A pack with no parent is in a pack group of its own name
+              root = ParsePackwerk.find(package.directory.dirname.to_s) || package
+              # Mark the parent pack and child pack as being in the pack group of the parent
+              packs_by_group[root.name] ||= { root: root, members: [] }
+              packs_by_group[root.name][:members] << package
+            end
+
+            packs_by_group.map do |name, pack_data|
+              PackGroup.new(
+                name: name,
+                root: pack_data[:root],
+                members: pack_data[:members],
+              )
+            end
+          end
+
+          sig { returns(Integer) }
+          def children_pack_count
+            members.count do |package|
+              package.name != root.name
+            end
+          end
+
+          sig { returns(T::Boolean) }
+          def has_parent?
+            children_pack_count > 0
+          end
+
+          sig { returns(T::Array[ParsePackwerk::Violation]) }
+          def cross_group_violations
+            all_violations = members.flat_map do |member|
+              ParsePackwerk::DeprecatedReferences.for(member).violations
+            end
+
+            all_violations.select do |violation|
+              !members.map(&:name).include?(violation.to_package_name)
+            end
+          end
+        end
+
+        sig do
+          params(
+            packages: T::Array[ParsePackwerk::Package],
+            app_name: String
+          ).returns(T::Array[GaugeMetric])
+        end
+        def self.get_nested_package_metrics(packages, app_name)
+          all_metrics = []
+          app_level_tag = Tag.for('app', app_name)
+          package_tags = T.let([app_level_tag], T::Array[Tag])
+
+          pack_groups = PackGroup.all_from(packages)
+          all_pack_groups_count = pack_groups.count
+          child_pack_count = pack_groups.sum(&:children_pack_count)
+          parent_pack_count = pack_groups.count(&:has_parent?)
+          all_cross_pack_group_violations = pack_groups.flat_map(&:cross_group_violations)
+
+          all_metrics << GaugeMetric.for('all_pack_groups.count', all_pack_groups_count, package_tags)
+          all_metrics << GaugeMetric.for('child_packs.count', child_pack_count, package_tags)
+          all_metrics << GaugeMetric.for('parent_packs.count', parent_pack_count, package_tags)
+          all_metrics << GaugeMetric.for('all_pack_groups.privacy_violations.count', Metrics.file_count(all_cross_pack_group_violations.select(&:privacy?)), package_tags)
+          all_metrics << GaugeMetric.for('all_pack_groups.dependency_violations.count', Metrics.file_count(all_cross_pack_group_violations.select(&:dependency?)), package_tags)\
+
+          packs_by_group = {}
+          pack_groups.each do |pack_group|
+            pack_group.members.each do |member|
+              packs_by_group[member.name] = pack_group.name
+            end
+          end
+
+          inbound_violations_by_pack_group = {}
+          all_cross_pack_group_violations.group_by(&:to_package_name).each do |to_package_name, violations|
+            violations.each do |violation|
+              pack_group_for_violation = packs_by_group[violation.to_package_name]
+              inbound_violations_by_pack_group[pack_group_for_violation] ||= []
+              inbound_violations_by_pack_group[pack_group_for_violation] << violation
+            end
+          end
+
+          pack_groups.each do |pack_group|
+            tags = [
+              *package_tags,
+              Tag.for('pack_group', Metrics.humanized_package_name(pack_group.name)),
+            ]
+
+            outbound_dependency_violations = pack_group.cross_group_violations.select(&:dependency?)
+            inbound_privacy_violations = inbound_violations_by_pack_group.fetch(pack_group.name, []).select(&:privacy?)
+            all_metrics << GaugeMetric.for('by_pack_group.outbound_dependency_violations.count', Metrics.file_count(outbound_dependency_violations), tags)
+            all_metrics << GaugeMetric.for('by_pack_group.inbound_privacy_violations.count', Metrics.file_count(inbound_privacy_violations), tags)
+          end
+
+          pack_groups.each do |from_pack_group|
+            violations_by_to_pack_group = from_pack_group.cross_group_violations.group_by do |violation|
+              packs_by_group[violation.to_package_name]
+            end
+            violations_by_to_pack_group.each do |to_pack_group_name, violations|
+              tags = [
+                *package_tags,
+                Tag.for('pack_group', Metrics.humanized_package_name(from_pack_group.name)),
+                Tag.for('to_pack_group', Metrics.humanized_package_name(to_pack_group_name)),
+              ]
+
+              all_metrics << GaugeMetric.for('by_pack_group.outbound_dependency_violations.per_pack_group.count', Metrics.file_count(violations.select(&:dependency?)), tags)
+              all_metrics << GaugeMetric.for('by_pack_group.outbound_privacy_violations.per_pack_group.count', Metrics.file_count(violations.select(&:privacy?)), tags)
+            end
+          end
+
+          all_metrics
+        end
+      end
+    end
+  end
+end