pack_stats 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da5c8a0753cdd0e4b878fc2fb2c2732fc5ca3664b1e53dc55f9c16e3b7f43fef
-  data.tar.gz: a57f443a4572e99c7bd8c187d5b963ff9fdecebf71cf5d1339518ea3f89d5852
+  metadata.gz: 43fc659730748dbbe47795bd71e3b421b746b8a76b1f8fe4c8d058161c3175b6
+  data.tar.gz: f5ad0c0e321f701bd7f426a67faaca0988a00ac5b47c44995139818918e4c540
 SHA512:
-  metadata.gz: 5c1bed7cbd4c71fe9937b9ea9ceb47a9784b7852f3a788f0f69c240848dd1d106e5be56a0005a2f6785f5e948c3419b2c9d7094bca559112e3289fe4334ea3ed
-  data.tar.gz: 06c0b6fd7a7af65934ad6c6f346bb0fafa61874742c12f4d752b8437e5f6024c34153a079c0666004d68eac8c693fbd5354a62d2fc7d45e8bdb6615ded6d0569
+  metadata.gz: 2d4d160bc1584c09a97c271a1f45a38b56183730f65c8a9235b85add2eb45e30a2e403ea19a13364b2a5e06fba41bbad4a36fb4e42adab96b205cadb61e117d4
+  data.tar.gz: 99d1de19334442e788ff48e27a3c980891e0cdfffb6327667dd3338e62b45499762e5d55580244fcac6771c87e3c05a93fe3589445c9ed9a09b22072d040a9ba

data/README.md

@@ -2,6 +2,9 @@
 
 This gem is used to report opinionated statistics about modularization to DataDog and other observability systems.
 
+# Configuring Packs
+This gem assumes you've correctly configured the [`packs`](https://github.com/rubyatscale/packs#configuration) gem so that `pack_stats` knows where to find your code's packs.
+
 # Configuring Ownership
 The gem reports metrics per-team, where each team is configured based on metadata included in Packwerk package.yml files.
 
@@ -38,13 +41,6 @@ PackStats.report_to_datadog!(
   # Example: [Pathname.new("./gems")]
   #
   componentized_source_code_locations: componentized_source_code_locations,
-  #
-  # A file is determined to be packaged if it exists in any of these directories.
-  # This is an array of `Pathname`. `Pathname` can be relative or absolute paths.
-  #
-  # Example: [Pathname.new("./packs")]
-  #
-  packaged_source_code_locations: packaged_source_code_locations,
 )
 ```
 
@@ -69,13 +65,7 @@ namespace(:modularization) do
     # `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
-      )
+      new_package = package.with(enforce_dependencies: true, enforce_privacy: true)
       ParsePackwerk.write_package_yml!(new_package)
     end
 
@@ -83,14 +73,7 @@ namespace(:modularization) do
 
     # 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)
+      ParsePackwerk.write_package_yml!(package)
     end
 
     PackStats.report_to_datadog!(
@@ -105,7 +88,7 @@ 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 `PackStats.get_metrics(...)` to get generic metrics that you can then send to whatever observability provider you use.
+Right now this tool sends metrics to DataDog only. However, if you want to use this with other tools, you can call `PackStats.get_metrics(...)` to get generic metrics that you can then send to whatever observability provider you use.
 
 # Setting Up Your Dashboards
 

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

@@ -63,7 +63,7 @@ module PackStats
                 raise StandardError, "Could not find matching package #{to_package_name}"
               end
 
-              tags = package_tags + [Tag.for('to_package', Metrics.humanized_package_name(to_package_name))] + Metrics.tags_for_to_team(CodeOwnership.for_package(to_package)&.name)
+              tags = package_tags + [Tag.for('to_package', Metrics.humanized_package_name(to_package_name))] + Metrics.tags_for_to_team(Private.package_owner(to_package))
               all_metrics << GaugeMetric.for('by_package.outbound_dependency_violations.per_package.count', Metrics.file_count(violations.select(&:dependency?)), tags)
               all_metrics << GaugeMetric.for('by_package.outbound_privacy_violations.per_package.count', Metrics.file_count(violations.select(&:privacy?)), tags)
             end
@@ -89,7 +89,8 @@ module PackStats
                 raise StandardError, "Could not find matching package #{explicit_dependency}"
               end
 
-              tags = package_tags + [Tag.for('to_package', Metrics.humanized_package_name(explicit_dependency))] + Metrics.tags_for_to_team(CodeOwnership.for_package(to_package)&.name)
+              owner = Private.package_owner(to_package)
+              tags = package_tags + [Tag.for('to_package', Metrics.humanized_package_name(explicit_dependency))] + Metrics.tags_for_to_team(owner)
               all_metrics << GaugeMetric.for('by_package.outbound_explicit_dependencies.per_package.count', 1, tags)
             end
 

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

@@ -17,7 +17,8 @@ module PackStats
           all_metrics = T.let([], T::Array[GaugeMetric])
           app_level_tag = Tag.for('app', app_name)
 
-          all_packages.group_by { |package| CodeOwnership.for_package(package)&.name }.each do |team_name, packages_by_team|
+          
+          all_packages.group_by { |package| Private.package_owner(package) }.each do |team_name, packages_by_team|
             # We look at `all_packages` because we care about ALL inbound violations across all teams
             inbound_violations_by_package = all_packages.flat_map(&:violations).group_by(&:to_package_name)
 
@@ -51,7 +52,7 @@ module PackStats
                 raise StandardError, "Could not find matching package #{violation.to_package_name}"
               end
 
-              CodeOwnership.for_package(to_package)&.name
+              Private.package_owner(to_package)
             end
 
             grouped_outbound_violations.each do |to_team_name, violations|

data/lib/pack_stats/private/metrics.rb

@@ -17,7 +17,7 @@ module PackStats
         [
           Tag.new(key: 'package', value: humanized_package_name(package.name)),
           Tag.new(key: 'app', value: app_name),
-          *Metrics.tags_for_team(CodeOwnership.for_package(package)&.name),
+          *Metrics.tags_for_team(Private.package_owner(package)),
         ]
       end
 

data/lib/pack_stats/private.rb

@@ -48,6 +48,13 @@ module PackStats
         new_metric
       end
     end
+
+    sig { params(package: ParsePackwerk::Package).returns(T.nilable(String) )}
+    def self.package_owner(package)
+      pack = Packs.find(package.name)
+      return nil if pack.nil?
+      CodeOwnership.for_package(pack)&.name
+    end
   end
 
   private_constant :Private

data/lib/pack_stats.rb

@@ -7,6 +7,7 @@ require 'benchmark'
 require 'code_teams'
 require 'code_ownership'
 require 'pathname'
+require 'packs'
 require 'pack_stats/private'
 require 'pack_stats/private/source_code_file'
 require 'pack_stats/private/datadog_reporter'
@@ -27,23 +28,17 @@ module PackStats
     ].freeze, T::Array[Pathname]
   )
 
-  DEFAULT_PACKAGED_SOURCE_CODE_LOCATIONS = T.let(
-    [
-      Pathname.new('packs'),
-      Pathname.new('packages'),
-    ].freeze, T::Array[Pathname]
-  )
-
   sig do
     params(
       datadog_client: Dogapi::Client,
       app_name: String,
       source_code_pathnames: T::Array[Pathname],
       componentized_source_code_locations: T::Array[Pathname],
-      packaged_source_code_locations: T::Array[Pathname],
       report_time: Time,
       verbose: T::Boolean,
       # 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
     ).void
   end
@@ -52,16 +47,15 @@ module PackStats
     app_name:,
     source_code_pathnames:,
     componentized_source_code_locations: DEFAULT_COMPONENTIZED_SOURCE_CODE_LOCATIONS,
-    packaged_source_code_locations: DEFAULT_PACKAGED_SOURCE_CODE_LOCATIONS,
     report_time: Time.now, # rubocop:disable Rails/TimeZone
     verbose: false,
+    packaged_source_code_locations: [],
     use_gusto_legacy_names: false
   )
 
     all_metrics = self.get_metrics(
       source_code_pathnames: source_code_pathnames,
       componentized_source_code_locations: componentized_source_code_locations,
-      packaged_source_code_locations: packaged_source_code_locations,
       app_name: app_name,
       use_gusto_legacy_names: use_gusto_legacy_names,
     )
@@ -88,8 +82,9 @@ module PackStats
     params(
       source_code_pathnames: T::Array[Pathname],
       componentized_source_code_locations: T::Array[Pathname],
-      packaged_source_code_locations: T::Array[Pathname],
       app_name: String,
+      # This field is deprecated
+      packaged_source_code_locations: T.nilable(T::Array[Pathname]),
       # It is not recommended to set this to true.
       # 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.
@@ -100,15 +95,14 @@ module PackStats
   def self.get_metrics(
     source_code_pathnames:,
     componentized_source_code_locations:,
-    packaged_source_code_locations:,
     app_name:,
+    packaged_source_code_locations: [],
     use_gusto_legacy_names: false
   )
     all_metrics = Private::DatadogReporter.get_metrics(
       source_code_files: source_code_files(
         source_code_pathnames: source_code_pathnames,
         componentized_source_code_locations: componentized_source_code_locations,
-        packaged_source_code_locations: packaged_source_code_locations
       ),
       app_name: app_name
     )
@@ -124,18 +118,21 @@ module PackStats
     params(
       source_code_pathnames: T::Array[Pathname],
       componentized_source_code_locations: T::Array[Pathname],
-      packaged_source_code_locations: T::Array[Pathname]
     ).returns(T::Array[Private::SourceCodeFile])
   end
   def self.source_code_files(
     source_code_pathnames:,
-    componentized_source_code_locations:,
-    packaged_source_code_locations:
+    componentized_source_code_locations:
   )
 
     # Sorbet has the wrong signatures for `Pathname#find`, whoops!
     componentized_file_set = Set.new(componentized_source_code_locations.select(&:exist?).flat_map { |pathname| T.unsafe(pathname).find.to_a })
-    packaged_file_set = Set.new(packaged_source_code_locations.select(&:exist?).flat_map { |pathname| T.unsafe(pathname).find.to_a })
+
+    packaged_file_set = Packs.all.flat_map do |pack|
+      pack.relative_path.find.to_a
+    end
+
+    packaged_file_set = Set.new(packaged_file_set)
 
     source_code_pathnames.map do |pathname|
       componentized_file = componentized_file_set.include?(pathname)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pack_stats
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: packs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parse_packwerk
   requirement: !ruby/object:Gem::Requirement
@@ -188,16 +202,6 @@ files:
 - lib/pack_stats/private/source_code_file.rb
 - lib/pack_stats/tag.rb
 - lib/pack_stats/tags.rb
-- sorbet/config
-- sorbet/rbi/gems/ast@2.4.2.rbi
-- sorbet/rbi/gems/code_ownership@1.28.0.rbi
-- sorbet/rbi/gems/code_teams@1.0.0.rbi
-- sorbet/rbi/gems/dogapi@1.45.0.rbi
-- sorbet/rbi/gems/manual.rbi
-- sorbet/rbi/gems/parse_packwerk@0.16.0.rbi
-- sorbet/rbi/gems/rspec@3.10.0.rbi
-- sorbet/rbi/gems/rubocop-packs@0.0.30.rbi
-- sorbet/rbi/todo.rbi
 homepage: https://github.com/rubyatscale/pack_stats
 licenses:
 - MIT

data/sorbet/config

@@ -1,4 +0,0 @@
---dir
-.
---ignore=/vendor/bundle
---enable-experimental-requires-ancestor