pack_stats 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43fc659730748dbbe47795bd71e3b421b746b8a76b1f8fe4c8d058161c3175b6
-  data.tar.gz: f5ad0c0e321f701bd7f426a67faaca0988a00ac5b47c44995139818918e4c540
+  metadata.gz: 24c2ef393916e7e08d2b7c227d747eb07e34ddc1c544c423f48e5797ca9a6483
+  data.tar.gz: 819e2a8238a33a664f7586701892d26bc265adb17afb54943ce1a156a58b62d0
 SHA512:
-  metadata.gz: 2d4d160bc1584c09a97c271a1f45a38b56183730f65c8a9235b85add2eb45e30a2e403ea19a13364b2a5e06fba41bbad4a36fb4e42adab96b205cadb61e117d4
-  data.tar.gz: 99d1de19334442e788ff48e27a3c980891e0cdfffb6327667dd3338e62b45499762e5d55580244fcac6771c87e3c05a93fe3589445c9ed9a09b22072d040a9ba
+  metadata.gz: ce1303c2c2be91aa338b89df57af5f9a59ff76615b95f0733ded2f3543c052c10e47ee3c1e6b01d9b9820edac47609077113d1749211f69c90a8f4cc923fc499
+  data.tar.gz: 32f66cbfa1c998c65591d34c0a076a421e13cd01de7c130d49fa28fae1512396aed7261f27fe458f43f347bbc41abc70253af9c1590ceb4fc8652f0dcb52b84b

data/lib/pack_stats/gauge_metric.rb

@@ -17,10 +17,11 @@ module PackStats
         raise StandardError.new("Metrics names must not exceed 200 characters: #{name}") # rubocop:disable Style/RaiseArgs
       end
 
+      all_tags = [*tags, max_enforcements_tag]
       new(
         name: name,
         count: count,
-        tags: tags
+        tags: all_tags
       )
     end
 
@@ -35,5 +36,16 @@ module PackStats
         other.count == self.count &&
         other.tags == self.tags
     end
+
+    sig { params(tag_value: T::Boolean).void }
+    def self.set_max_enforcements_tag(tag_value)
+      @max_enforcements_tag = T.let(@max_enforcements_tag, T.nilable(Tag))
+      @max_enforcements_tag = Tag.new(key: 'max_enforcements', value: tag_value ? 'true' : 'false')
+    end
+
+    sig { returns(Tag) }
+    def self.max_enforcements_tag
+      @max_enforcements_tag || Tag.new(key: 'max_enforcements', value: 'false')
+    end
   end
 end

data/lib/pack_stats/private/datadog_reporter.rb

@@ -9,7 +9,6 @@ require 'pack_stats/private/metrics/packwerk_checker_usage'
 require 'pack_stats/private/metrics/rubocop_usage'
 require 'pack_stats/private/metrics/packages'
 require 'pack_stats/private/metrics/packages_by_team'
-require 'pack_stats/private/metrics/nested_packs'
 
 module PackStats
   module Private
@@ -29,7 +28,6 @@ module PackStats
           *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
 

data/lib/pack_stats.rb

@@ -39,7 +39,9 @@ module PackStats
       # See note on get_metrics
       packaged_source_code_locations: T.nilable(T::Array[Pathname]),
       # See note on get_metrics
-      use_gusto_legacy_names: T::Boolean
+      use_gusto_legacy_names: T::Boolean,
+      # See note on get_metrics
+      max_enforcements_tag_value: T::Boolean
     ).void
   end
   def self.report_to_datadog!(
@@ -50,7 +52,8 @@ module PackStats
     report_time: Time.now, # rubocop:disable Rails/TimeZone
     verbose: false,
     packaged_source_code_locations: [],
-    use_gusto_legacy_names: false
+    use_gusto_legacy_names: false,
+    max_enforcements_tag_value: false
   )
 
     all_metrics = self.get_metrics(
@@ -58,6 +61,7 @@ module PackStats
       componentized_source_code_locations: componentized_source_code_locations,
       app_name: app_name,
       use_gusto_legacy_names: use_gusto_legacy_names,
+      max_enforcements_tag_value: max_enforcements_tag_value,
     )
 
     # This helps us debug what metrics are being sent
@@ -89,7 +93,12 @@ module PackStats
       # Gusto uses this to preserve historical trends in Dashboards as the names of
       # things changed, but new dashboards can use names that better match current tooling conventions.
       # The behavior of setting this parameter to true might change without warning
-      use_gusto_legacy_names: T::Boolean
+      use_gusto_legacy_names: T::Boolean,
+      # You can set this to `true` to tag all metrics with `max_enforcements:true`.
+      # This is useful if you want to submit two sets of metrics:
+      # Once with the violation counts as configured in the app
+      # Another time with the violation counts after turning on all enforcements and running `bin/packwerk update`.
+      max_enforcements_tag_value: T::Boolean
     ).returns(T::Array[GaugeMetric])
   end
   def self.get_metrics(
@@ -97,8 +106,12 @@ module PackStats
     componentized_source_code_locations:,
     app_name:,
     packaged_source_code_locations: [],
-    use_gusto_legacy_names: false
+    use_gusto_legacy_names: false,
+    max_enforcements_tag_value: false
   )
+
+    GaugeMetric.set_max_enforcements_tag(max_enforcements_tag_value)
+
     all_metrics = Private::DatadogReporter.get_metrics(
       source_code_files: source_code_files(
         source_code_pathnames: source_code_pathnames,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pack_stats
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -193,7 +193,6 @@ files:
 - lib/pack_stats/private/datadog_reporter.rb
 - lib/pack_stats/private/metrics.rb
 - lib/pack_stats/private/metrics/files.rb
-- lib/pack_stats/private/metrics/nested_packs.rb
 - lib/pack_stats/private/metrics/packages.rb
 - lib/pack_stats/private/metrics/packages_by_team.rb
 - lib/pack_stats/private/metrics/packwerk_checker_usage.rb

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

@@ -1,137 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module PackStats
-  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::PackageTodo.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