kennel 1.155.0 → 1.156.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52d3ae07f004122c89830d62abf500f176f764bda7848dc3bf10094632f81172
-  data.tar.gz: c64b314848c4574326f8d485e4fe6849c53e03a7cf38871e86a2d89cf43cbd0e
+  metadata.gz: eef80c1b9898cbd9f3a319f686836b41d760abbdbacfd8fddfa6ac27cd4706dd
+  data.tar.gz: 80f119c50ac65e3d9985588f37b41961f326b62ce4e028cdc27c6b6d333a75a8
 SHA512:
-  metadata.gz: 9e2a7327e64c318fe1ac443d5157ffd4e0a65a298b56e7a5345cc15ed2f472f09b4a4387c97599633d2357f6d9fc26317a218cfa2e48ab87c0db5a18e0365740
-  data.tar.gz: ae76d3d79ec245ee127266a6ed402766370354a11bc78952a162e001c9bd53037620996524c2e24544d9ac3199df607aee60ff4ed72b320985e2d4fca530bfbb
+  metadata.gz: 4a35987012bf0ebf529107451e3304c92fcd7a2226078c5101ea02d1689c0bfed96d0fb0e0dc14a2c44a7274376fb3fb7b61029363ec3b5bdaf356d459253b11
+  data.tar.gz: '049fb4c8abe6fd1e107c5343e4f9138ab2b981f405ec289ccbca0e506411d8e039310d2a428f5aaa67858c84eef36a069a74932c6a2acc4686eb9b97b013acf8'

data/lib/kennel/filter.rb

@@ -3,9 +3,9 @@
 module Kennel
   class Filter
     def initialize
-      # build early so we fail fast on invalid user input
-      @tracking_id_filter = build_tracking_id_filter
-      @project_filter = build_project_filter
+      # read early so we fail fast on invalid user input
+      @tracking_id_filter = read_tracking_id_filter_from_env
+      @project_filter = read_project_filter_from_env
     end
 
     def filter_projects(projects)
@@ -28,30 +28,36 @@ module Kennel
       return true unless filtering?
       return tracking_id_filter.include?(tracking_id) if tracking_id_filter
 
-      project_filter.include?(tracking_id.split(":").first)
+      project_id = tracking_id.split(":").first
+      project_filter.include?(project_id)
+    end
+
+    def tracking_id_for_path(tracking_id)
+      return tracking_id unless tracking_id.end_with?(".json")
+      tracking_id.sub("generated/", "").sub(".json", "").sub("/", ":")
     end
 
     private
 
     attr_reader :project_filter, :tracking_id_filter
 
-    def build_project_filter
+    # needs to be called after read_tracking_id_filter_from_env
+    def read_project_filter_from_env
       project_names = ENV["PROJECT"]&.split(",")&.sort&.uniq
       tracking_project_names = tracking_id_filter&.map { |id| id.split(":", 2).first }&.sort&.uniq
       if project_names && tracking_project_names && project_names != tracking_project_names
-        raise "do not set PROJECT= when using TRACKING_ID="
+        # avoid everything being filtered out
+        raise "do not set a different PROJECT= when using TRACKING_ID="
       end
       (project_names || tracking_project_names)
     end
 
-    def build_tracking_id_filter
-      (tracking_id = ENV["TRACKING_ID"]) && tracking_id.split(",").map { |id| tracking_id_path_conversion(id) }.sort.uniq
-    end
-
-    # allow users to paste the generated path of an objects to update it without manually converting
-    def tracking_id_path_conversion(tracking_id)
-      return tracking_id unless tracking_id.end_with?(".json")
-      tracking_id.sub("generated/", "").sub(".json", "").sub("/", ":")
+    def read_tracking_id_filter_from_env
+      return unless (tracking_id = ENV["TRACKING_ID"])
+      tracking_id.split(",").map do |id|
+        # allow users to paste the generated/ path of an objects to update it without manually converting
+        tracking_id_for_path(id)
+      end.sort.uniq
     end
 
     def filter_resources(resources, by, expected, name, env)

data/lib/kennel/parts_serializer.rb

@@ -37,9 +37,10 @@ module Kennel
     def existing_files_and_folders
       paths = Dir["generated/**/*"]
 
+      # when filtering we only need the files we are going to write
       if filter.filtering?
         paths.select! do |path|
-          tracking_id = path.split("/")[1..2].to_a.join(":")
+          tracking_id = filter.tracking_id_for_path(path)
           filter.matches_tracking_id?(tracking_id)
         end
       end

data/lib/kennel/projects_provider.rb

@@ -20,21 +20,46 @@ module Kennel
       loader = Zeitwerk::Loader.new
       Dir.exist?("teams") && loader.push_dir("teams", namespace: Teams)
       Dir.exist?("parts") && loader.push_dir("parts")
-      loader.setup
-      loader.eager_load # TODO: this should not be needed but we see hanging CI processes when it's not added
 
-      # TODO: also auto-load projects and update expected path too
-      ["projects"].each do |folder|
+      # TODO: verify this works by running generate and also running generate for each possible PROJECT
+      # in isolation, then remove AUTOLOAD_PROJECTS
+      if ENV["AUTOLOAD_PROJECTS"]
+        loader.push_dir("projects")
+        loader.setup
+
+        if (project = ENV["PROJECT"]) # TODO: use project filter instead and also support TRACKING_ID
+          # we support PROJECT being used for nested folders, to allow teams to easily group their projects
+          # so when loading a project we need to find anything that could be a project source
+          # sorting by name and nesting level to avoid confusion
+          projects_path = "#{File.expand_path("projects")}/"
+          project_path = loader.all_expected_cpaths.each_key.select do |path|
+            path.start_with?(projects_path) && path.end_with?("/#{project}.rb")
+          end.sort.min_by { |p| p.count("/") }
+          if project_path
+            require project_path
+          else
+            Kennel.err.puts "No file named #{project}.rb, falling back to slow loading of all projects instead"
+            loader.eager_load
+          end
+        else
+          loader.eager_load
+        end
+      else
+        loader.setup
+        loader.eager_load # TODO: this should not be needed but we see hanging CI processes when it's not added
+        # TODO: also auto-load projects and update expected path too
+        # but to do that we need to stop the pattern of having a class at the bottom of the project structure
+        # and change to Module::Project + Module::Support
         # we need the extra sort so foo/bar.rb is loaded before foo/bar/baz.rb
-        Dir["#{folder}/**/*.rb"].sort.each { |f| require "./#{f}" } # rubocop:disable Lint/RedundantDirGlobSort
+        Dir["projects/**/*.rb"].sort.each { |f| require "./#{f}" } # rubocop:disable Lint/RedundantDirGlobSort
       end
     rescue NameError => e
       message = e.message
       raise unless (klass = message[/uninitialized constant (.*)/, 1])
 
       # inverse of zeitwerk lib/zeitwerk/inflector.rb
-      path = klass.gsub("::", "/").gsub(/([a-z])([A-Z])/, "\\1_\\2").downcase + ".rb"
-      expected_path = (path.start_with?("teams/") ? path : "parts/#{path}")
+      project_path = klass.gsub("::", "/").gsub(/([a-z])([A-Z])/, "\\1_\\2").downcase + ".rb"
+      expected_path = (project_path.start_with?("teams/") ? project_path : "parts/#{project_path}")
 
       # TODO: prefer to raise a new exception with the old backtrace attacked
       e.define_singleton_method(:message) do

data/lib/kennel/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Kennel
-  VERSION = "1.155.0"
+  VERSION = "1.156.0"
 end

data/lib/kennel.rb

@@ -106,20 +106,16 @@ module Kennel
 
     def generated(**kwargs)
       @generated ||= begin
-        parts = Progress.progress "Finding parts", **kwargs do
+        projects = Progress.progress "Loading projects", **kwargs do
           projects = ProjectsProvider.new.projects
-          projects = filter.filter_projects projects
-
-          parts = Utils.parallel(projects, &:validated_parts).flatten(1)
-          filter.filter_parts parts
+          filter.filter_projects projects
         end
 
-        parts.group_by(&:tracking_id).each do |tracking_id, same|
-          next if same.size == 1
-          raise <<~ERROR
-            #{tracking_id} is defined #{same.size} times
-            use a different `kennel_id` when defining multiple projects/monitors/dashboards to avoid this conflict
-          ERROR
+        parts = Progress.progress "Finding parts", **kwargs do
+          parts = Utils.parallel(projects, &:validated_parts).flatten(1)
+          parts = filter.filter_parts parts
+          validate_unique_tracking_ids(parts)
+          parts
         end
 
         Progress.progress "Building json" do
@@ -133,6 +129,17 @@ module Kennel
       end
     end
 
+    # performance: this takes ~100ms on large codebases, tried rewriting with Set or Hash but it was slower
+    def validate_unique_tracking_ids(parts)
+      parts.group_by(&:tracking_id).each do |tracking_id, same|
+        next if same.size == 1
+        raise <<~ERROR
+          #{tracking_id} is defined #{same.size} times
+          use a different `kennel_id` when defining multiple projects/monitors/dashboards to avoid this conflict
+        ERROR
+      end
+    end
+
     def definitions(**kwargs)
       @definitions ||= Progress.progress("Downloading definitions", **kwargs) do
         Utils.parallel(Models::Record.subclasses) do |klass|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.155.0
+  version: 1.156.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -136,14 +136,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Keep datadog monitors/dashboards/etc in version control, avoid chaotic management