kennel 2.6.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb95ceae817bc98d083407c5a6b19483e12e1932a98209c13fd097cd9bcf7ebd
-  data.tar.gz: 1a0c92f146ab14ffe80bccc86cb12f1561e8d874faefbe7f48f550a4c108cb6e
+  metadata.gz: bebf47eb6fde98d7122a199324dca2c205b94a65e844193d7917f2e384fbc029
+  data.tar.gz: c3631e51b4d7ef363b7fd177e42d688e00f7ea9816b9161b27dd2f48753fff93
 SHA512:
-  metadata.gz: 2b43e7160e79a8174ae60d929d998322cfda2730116500ce8e6ddbfd4114c2217b0d75c5f326ffafbc94c5976155810a858f6d43423430223fa9325207373a75
-  data.tar.gz: b9c53626a278cea303b617ec12f792f89b5a5ca858a20dd75f244367a38065ed436e5309184b04e8c5ba5f7060a5c5dab472837b2729c2313ab6cb730d6f0bef
+  metadata.gz: 7029a570da24413841e71dc380a7f07d476c9cff3b83aee05a032478ed1707771b96f071949e2284003ef51777f955174c9d241a0e11c2d6fbd6aadc1d4ccece
+  data.tar.gz: b5df9cfcd85ff76b762c9c8a96e630f1b3cf509eb8509e71a42fb2d5c8b24efd6588a88033abe38c2d1ff5b37f8087d2e0074be171f3e78066c1796df53f72b4

data/lib/kennel/api.rb

@@ -73,6 +73,7 @@ module Kennel
       end
     end
 
+    # fill the resource with the full response from the `show` if `list` does not return it
     def fill_details!(api_resource, list)
       details_cache do |cache|
         Utils.parallel(list) { |a| fill_detail!(api_resource, a, cache) }

data/lib/kennel/models/dashboard.rb

@@ -208,9 +208,10 @@ module Kennel
         end
       end
 
-      def validate_update!(diffs)
-        _, path, from, to = diffs.find { |diff| diff[1] == "layout_type" }
-        invalid_update!(path, from, to) if path
+      def allowed_update_error(actual)
+        actual_type = actual[:layout_type]
+        return if actual_type == layout_type
+        "cannot update layout_type from #{actual_type} to #{layout_type}"
       end
 
       private

data/lib/kennel/models/monitor.rb

@@ -180,12 +180,11 @@ module Kennel
         end
       end
 
-      def validate_update!(diffs)
-        # ensure type does not change, but not if it's metric->query which is supported and used by importer.rb
-        _, path, from, to = diffs.detect { |_, path, _, _| path == "type" }
-        if path && !(from == "metric alert" && to == "query alert")
-          invalid_update!(path, from, to)
-        end
+      # ensure type does not change, but not if it's metric->query which is supported and used by importer.rb
+      def allowed_update_error(actual)
+        actual_type = actual[:type]
+        return if actual_type == type || (actual_type == "metric alert" && type == "query alert")
+        "cannot update type from #{actual_type} to #{type}"
       end
 
       def self.api_resource

data/lib/kennel/models/project.rb

@@ -18,7 +18,7 @@ module Kennel
       end
 
       def validated_parts
-        all = parts
+        all = filter_parts(parts)
         unless all.is_a?(Array) && all.all? { |part| part.is_a?(Record) }
           raise "Project #{kennel_id} #parts must return an array of Records"
         end
@@ -29,6 +29,11 @@ module Kennel
 
       private
 
+      # hook for users to add custom filtering via `prepend`
+      def filter_parts(parts)
+        parts
+      end
+
       # hook for users to add custom validations via `prepend`
       def validate_parts(parts)
       end

data/lib/kennel/models/record.rb

@@ -142,12 +142,8 @@ module Kennel
         @as_json
       end
 
-      # Can raise DisallowedUpdateError
-      def validate_update!(_diffs)
-      end
-
-      def invalid_update!(field, old_value, new_value)
-        raise DisallowedUpdateError, "#{safe_tracking_id} Datadog does not allow update of #{field} (#{old_value.inspect} -> #{new_value.inspect})"
+      def allowed_update_error(_a)
+        nil
       end
 
       # For use during error handling

data/lib/kennel/syncer/matched_expected.rb

@@ -36,7 +36,13 @@ module Kennel
 
         def matching_expected(a, map)
           klass = a.fetch(:klass)
-          map["#{klass.api_resource}:#{a.fetch(:id)}"] || map[a.fetch(:tracking_id)]
+          full_id = "#{klass.api_resource}:#{a.fetch(:id)}"
+          if (e = map[full_id]) # we try to update and the user has set the id
+            return e unless (error = e.allowed_update_error(a))
+            raise DisallowedUpdateError, "#{full_id} Datadog does not allow update: #{error}"
+          elsif (e = map[a.fetch(:tracking_id)])
+            e.allowed_update_error(a) ? nil : e # force a re-create if we can't update
+          end
         end
       end
     end

data/lib/kennel/syncer/plan_printer.rb

@@ -12,9 +12,9 @@ module Kennel
         if plan.empty?
           Kennel.out.puts Console.color(:green, "Nothing to do")
         else
+          print_changes "Delete", plan.deletes, :red
           print_changes "Create", plan.creates, :green
           print_changes "Update", plan.updates, :yellow
-          print_changes "Delete", plan.deletes, :red
         end
       end
 

data/lib/kennel/syncer.rb

@@ -13,14 +13,13 @@ module Kennel
 
     attr_reader :plan
 
-    def initialize(api, expected, actual, filter:, strict_imports: true)
+    def initialize(api, expected:, actual:, filter:, strict_imports: true)
       @api = api
       @strict_imports = strict_imports
       @filter = filter
 
       @resolver = Resolver.new(expected: expected, filter: filter)
       @plan = Plan.new(*calculate_changes(expected: expected, actual: actual))
-      validate_changes
     end
 
     def print_plan
@@ -126,27 +125,19 @@ module Kennel
     # if there is a new item that has the same name or title as an "to be deleted" item,
     # update it instead to avoid old urls from becoming invalid
     # - careful with unmatched_actual being huge since it has all api resources
-    # - don't do it when a monitor type is changing since that would block the update
-    # - don't do it when a dashboard layout_type is changing since that would block the update
-    # - when using a filter and updating the kennel_id of an existing item, old and new must be in the filter
+    # - don't do it when update is not allowed
+    # - when using a filter and updating the kennel_id of an existing item, old and new must be in the filter (PROJECT= works, but not TRACKING_ID)
     def convert_replace_into_update!(matching, unmatched_actual, unmatched_expected)
       unmatched_expected.reject! do |e|
-        e_field, e_value = Kennel::Models::Record::TITLE_FIELDS.detect do |field|
-          next unless (value = e.as_json[field])
-          break [field, value]
-        end
-        raise unless e_field #  uncovered: should never happen ...
-        # TODO: ideally reuse invalid_update! logic and just put the fields somewhere
-        e_monitor_type = e.as_json[:type]
-        e_dashboard_layout_type = e.as_json[:layout_type]
-
+        # find actual by title
+        e_field, e_value = title_field_and_value(e)
         actual = unmatched_actual.detect do |a|
           a[:klass].api_resource == e.class.api_resource &&
-            a[e_field] == e_value &&
-            a[:type] == e_monitor_type &&
-            a[:layout_type] == e_dashboard_layout_type
+            a[e_field] == e_value
         end
-        next false unless actual # keep in unmatched
+
+        # keep unmatched if we could not find or can't update
+        next false if !actual || e.allowed_update_error(actual)
 
         # add as update and remove from unmatched
         unmatched_actual.delete(actual)
@@ -156,10 +147,18 @@ module Kennel
       end
     end
 
-    # fill details of things we need to compare
-    def fill_details!(details_needed)
-      details_needed = details_needed.map { |e, a| a if e && e.class.api_resource == "dashboard" }.compact
-      @api.fill_details! "dashboard", details_needed
+    def title_field_and_value(e)
+      Kennel::Models::Record::TITLE_FIELDS.detect do |field|
+        next unless (value = e.as_json[field])
+        return [field, value]
+      end
+      raise # uncovered: should never happen ...
+    end
+
+    # fill details of things we need to compare, so diff works even though we cannot mass-fetch definitions
+    def fill_details!(matching)
+      dashboards = matching.filter_map { |e, a| a if e && e.class.api_resource == "dashboard" }
+      @api.fill_details! "dashboard", dashboards
     end
 
     def validate_expected_id_not_missing(expected)
@@ -175,14 +174,6 @@ module Kennel
       end
     end
 
-    # We've already validated the desired objects ('generated') in isolation.
-    # Now that we have made the plan, we can perform some more validation.
-    def validate_changes
-      @plan.updates.each do |item|
-        item.expected.validate_update!(item.diff)
-      end
-    end
-
     def filter_actual!(actual)
       return unless filter.filtering? # minor optimization
 

data/lib/kennel/tasks.rb

@@ -109,7 +109,7 @@ namespace :kennel do
     end
   end
 
-  desc "generate local definitions"
+  desc "store definitions in generated/"
   task generate: :environment do
     Kennel::Tasks.kennel.generate
   end

data/lib/kennel/utils.rb

@@ -24,13 +24,14 @@ module Kennel
         workers = Array.new(threads).map do
           Thread.new do
             loop do
-              item, i = work.pop
+              item, i = work.shift
               break unless i
               done[i] =
                 begin
                   yield item
                 rescue Exception => e # rubocop:disable Lint/RescueException
-                  work.clear
+                  work.clear # prevent new work
+                  (workers - [Thread.current]).each(&:kill) # stop ongoing work
                   e
                 end
             end

data/lib/kennel/version.rb

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

data/lib/kennel.rb

@@ -56,7 +56,7 @@ module Kennel
   self.err = $stderr
 
   class Engine
-    attr_accessor :strict_imports
+    attr_accessor :strict_imports # TODO: rename to :enforce_expected_ids_exist
 
     def initialize
       @strict_imports = true
@@ -93,7 +93,9 @@ module Kennel
       @syncer ||= begin
         preload
         Syncer.new(
-          api, generated, definitions,
+          api,
+          expected: generated,
+          actual: definitions,
           filter: filter,
           strict_imports: strict_imports
         )
@@ -129,7 +131,7 @@ module Kennel
       end
     end
 
-    # performance: this takes ~100ms on large codebases, tried rewriting with Set or Hash but it was slower
+    # performance: this takes ~100ms on large codebases, tried rewriting with Set or Hash, but it was slower
     def validate_unique_tracking_ids(parts)
       bad = parts.group_by(&:tracking_id).select { |_, same| same.size > 1 }
       return if bad.empty?
@@ -143,7 +145,10 @@ module Kennel
     def definitions(**kwargs)
       @definitions ||= Progress.progress("Downloading definitions", **kwargs) do
         Utils.parallel(Models::Record.subclasses) do |klass|
-          api.list(klass.api_resource, with_downtimes: false) # lookup monitors without adding unnecessary downtime information
+          # lookup monitors without adding unnecessary downtime information
+          params = (klass.api_resource == "monitor" ? { with_downtimes: false } : {})
+
+          api.list(klass.api_resource, params)
         end.flatten(1)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-30 00:00:00.000000000 Z
+date: 2025-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs