kennel 1.122.0 → 1.123.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43b746ea91f86217a6fc43383a3368ccd654c89936c44003088054380be8c36d
-  data.tar.gz: 5fcd75471c8d0152236d032b023b4769975251047bc276f00219df3b1e60964d
+  metadata.gz: f09678f23d63da04d4b5db81eaef471bc0aa437b62ac75082f7bd161f8cd38e4
+  data.tar.gz: a570cc2617295581459a5977727049c243d492312554496f0b1beb432ad8efe8
 SHA512:
-  metadata.gz: e9ce639cdd5748f689eeb352da8ea9c14a2a4243350368574b8b3c1b52534dbf470ca3e969ad96ecd685d8df93d368e7e4d5f5c98da2af7e5cc843ccbc8053ce
-  data.tar.gz: 7039072c9129311145694b53823cab5c11263e972ae8f6c586e0b86063a8ab9d375c2ecd1069bd2812f626ce631f2940fe55ca9a018033b435df63bcbef1d355
+  metadata.gz: 560a1daae6cb797b0e53e06a694e5624667b5597d3d6fb5c783e0166154a8f594064d7bfc1f64fb541723e2b633130d4e8039a8caa3434145552a63114a88678
+  data.tar.gz: '091c93ee61b87146c69e6f8782aab7a3cf2c349a03936f686a099eaca1a96d762193ee8385220fcc9d8c694edacf89aa57c6751e6e8a17bcffb37b1f913f9591'

data/lib/kennel/file_cache.rb

@@ -15,11 +15,13 @@ module Kennel
     end
 
     def open
-      load_data
-      expire_old_data
-      yield self
-    ensure
-      persist
+      @data = load_data || {}
+      begin
+        expire_old_data
+        yield self
+      ensure
+        persist
+      end
     end
 
     def fetch(key, key_version)
@@ -35,12 +37,9 @@ module Kennel
     private
 
     def load_data
-      @data =
-        begin
-          Marshal.load(File.read(@file)) # rubocop:disable Security/MarshalLoad
-        rescue StandardError
-          {}
-        end
+      Marshal.load(File.read(@file)) # rubocop:disable Security/MarshalLoad
+    rescue Errno::ENOENT, TypeError, ArgumentError
+      nil
     end
 
     def persist
@@ -49,6 +48,7 @@ module Kennel
 
       Tempfile.create "kennel-file-cache", dir do |tmp|
         Marshal.dump @data, tmp
+        tmp.flush
         File.rename tmp.path, @file
       end
     end

data/lib/kennel/importer.rb

@@ -38,6 +38,8 @@ module Kennel
 
       case resource
       when "monitor"
+        raise "Import the synthetic test page and not the monitor" if data[:type] == "synthetics alert"
+
         # flatten monitor options so they are all on the base which is how Monitor builds them
         data.merge!(data.delete(:options))
         data.merge!(data.delete(:thresholds) || {})

data/lib/kennel/models/dashboard.rb

@@ -3,7 +3,6 @@ module Kennel
   module Models
     class Dashboard < Record
       include TemplateVariables
-      include OptionalValidations
 
       READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [
         :author_handle, :author_name, :modified_at, :deleted_at, :url, :is_read_only, :notify_list, :restricted_roles
@@ -87,8 +86,7 @@ module Kennel
         tags: -> do # not inherited by default to make onboarding to using dashboard tags simple
           team = project.team
           team.tag_dashboards ? team.tags : []
-        end,
-        id: -> { nil }
+        end
       )
 
       class << self
@@ -152,29 +150,24 @@ module Kennel
         end
       end
 
-      def as_json
-        return @json if @json
+      def build_json
         all_widgets = render_definitions(definitions) + widgets
         expand_q all_widgets
         tags = tags()
         tags_as_string = (tags.empty? ? "" : " (#{tags.join(" ")})")
 
-        @json = {
+        json = super.merge(
           layout_type: layout_type,
           title: "#{title}#{tags_as_string}#{LOCK}",
           description: description,
           template_variables: render_template_variables,
           template_variable_presets: template_variable_presets,
           widgets: all_widgets
-        }
-
-        @json[:reflow_type] = reflow_type if reflow_type # setting nil breaks create with "ordered"
+        )
 
-        @json[:id] = id if id
+        json[:reflow_type] = reflow_type if reflow_type # setting nil breaks create with "ordered"
 
-        validate_json(@json) if validate
-
-        @json
+        json
       end
 
       def self.url(id)
@@ -210,9 +203,8 @@ module Kennel
       end
 
       def validate_update!(_actuals, diffs)
-        if bad_diff = diffs.find { |diff| diff[1] == "layout_type" }
-          invalid! "Datadog does not allow update of #{bad_diff[1]} (#{bad_diff[2].inspect} -> #{bad_diff[3].inspect})"
-        end
+        _, path, from, to = diffs.find { |diff| diff[1] == "layout_type" }
+        invalid_update!(path, from, to) if path
       end
 
       private

data/lib/kennel/models/monitor.rb

@@ -2,8 +2,6 @@
 module Kennel
   module Models
     class Monitor < Record
-      include OptionalValidations
-
       RENOTIFY_INTERVALS = [0, 10, 20, 30, 40, 50, 60, 90, 120, 180, 240, 300, 360, 720, 1440].freeze # minutes
       OPTIONAL_SERVICE_CHECK_THRESHOLDS = [:ok, :warning].freeze
       READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [
@@ -41,7 +39,6 @@ module Kennel
         renotify_interval: -> { project.team.renotify_interval },
         warning: -> { nil },
         ok: -> { nil },
-        id: -> { nil },
         notify_no_data: -> { true }, # datadog sets this to false by default, but true is the safer
         no_data_timeframe: -> { 60 },
         notify_audit: -> { MONITOR_OPTION_DEFAULTS.fetch(:notify_audit) },
@@ -56,9 +53,8 @@ module Kennel
         priority: -> { MONITOR_DEFAULTS.fetch(:priority) }
       )
 
-      def as_json
-        return @as_json if @as_json
-        data = {
+      def build_json
+        data = super.merge(
           name: "#{name}#{LOCK}",
           type: type,
           query: query.strip,
@@ -79,9 +75,7 @@ module Kennel
             locked: false, # setting this to true prevents any edit and breaks updates when using replace workflow
             renotify_interval: renotify_interval || 0
           }
-        }
-
-        data[:id] = id if id
+        )
 
         options = data[:options]
         if data.fetch(:type) != "composite"
@@ -120,9 +114,7 @@ module Kennel
           options[:renotify_statuses] = statuses
         end
 
-        validate_json(data) if validate
-
-        @as_json = data
+        data
       end
 
       def resolve_linked_tracking_ids!(id_map, **args)
@@ -140,7 +132,7 @@ module Kennel
         # 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! "Datadog does not allow update of #{path} (#{from.inspect} -> #{to.inspect})"
+          invalid_update!(path, from, to)
         end
       end
 

data/lib/kennel/models/project.rb

@@ -20,7 +20,7 @@ module Kennel
       def validated_parts
         all = parts
         unless all.is_a?(Array) && all.all? { |part| part.is_a?(Record) }
-          invalid! "#parts must return an array of Records"
+          raise "Project #{kennel_id} #parts must return an array of Records"
         end
 
         validate_parts(all)
@@ -29,11 +29,6 @@ module Kennel
 
       private
 
-      # let users know which project/resource failed when something happens during diffing where the backtrace is hidden
-      def invalid!(message)
-        raise ValidationError, "#{kennel_id} #{message}"
-      end
-
       # hook for users to add custom validations via `prepend`
       def validate_parts(parts)
       end

data/lib/kennel/models/record.rb

@@ -2,6 +2,8 @@
 module Kennel
   module Models
     class Record < Base
+      include OptionalValidations
+
       # Apart from if you just don't like the default for some reason,
       # overriding MARKER_TEXT allows for namespacing within the same
       # Datadog account. If you run one Kennel setup with marker text
@@ -30,6 +32,8 @@ module Kennel
 
       settings :id, :kennel_id
 
+      defaults(id: nil)
+
       class << self
         def parse_any_url(url)
           subclasses.detect do |s|
@@ -96,7 +100,7 @@ module Kennel
         @tracking_id ||= begin
           id = "#{project.kennel_id}:#{kennel_id}"
           unless id.match?(ALLOWED_KENNEL_ID_REGEX) # <-> parse_tracking_id
-            raise ValidationError, "#{id} must match #{ALLOWED_KENNEL_ID_REGEX}"
+            raise "#{id} must match #{ALLOWED_KENNEL_ID_REGEX}"
           end
           id
         end
@@ -108,7 +112,7 @@ module Kennel
       def add_tracking_id
         json = as_json
         if self.class.parse_tracking_id(json)
-          invalid! "remove \"-- #{MARKER_TEXT}\" line it from #{self.class::TRACKING_FIELD} to copy a resource"
+          raise "#{tracking_id} Remove \"-- #{MARKER_TEXT}\" line from #{self.class::TRACKING_FIELD} to copy a resource"
         end
         json[self.class::TRACKING_FIELD] =
           "#{json[self.class::TRACKING_FIELD]}\n" \
@@ -119,9 +123,29 @@ module Kennel
         self.class.remove_tracking_id(as_json)
       end
 
+      def build_json
+        {
+          id: id
+        }.compact
+      end
+
+      def as_json
+        @as_json ||= begin
+                       json = build_json
+                       (id = json.delete(:id)) && json[:id] = id
+                       validate_json(json) if validate
+                       json
+                     end
+      end
+
+      # Can raise DisallowedUpdateError
       def validate_update!(*)
       end
 
+      def invalid_update!(field, old_value, new_value)
+        raise DisallowedUpdateError, "#{tracking_id} Datadog does not allow update of #{field} (#{old_value.inspect} -> #{new_value.inspect})"
+      end
+
       private
 
       def resolve(value, type, id_map, force:)
@@ -133,20 +157,24 @@ module Kennel
         id.is_a?(String) && id.include?(":")
       end
 
-      def resolve_link(tracking_id, type, id_map, force:)
-        if id_map.new?(type.to_s, tracking_id)
+      def resolve_link(sought_tracking_id, sought_type, id_map, force:)
+        if id_map.new?(sought_type.to_s, sought_tracking_id)
           if force
-            invalid!(
-              "#{type} #{tracking_id} was referenced but is also created by the current run.\n" \
-              "It could not be created because of a circular dependency, try creating only some of the resources"
-            )
+            raise UnresolvableIdError, <<~MESSAGE
+              #{tracking_id} #{sought_type} #{sought_tracking_id} was referenced but is also created by the current run.
+              It could not be created because of a circular dependency. Try creating only some of the resources.
+            MESSAGE
           else
             nil # will be re-resolved after the linked object was created
           end
-        elsif id = id_map.get(type.to_s, tracking_id)
+        elsif id = id_map.get(sought_type.to_s, sought_tracking_id)
           id
         else
-          invalid! "Unable to find #{type} #{tracking_id} (does not exist and is not being created by the current run)"
+          raise UnresolvableIdError, <<~MESSAGE
+            #{tracking_id} Unable to find #{sought_type} #{sought_tracking_id}
+            This is either because it doesn't exist, and isn't being created by the current run;
+            or it does exist, but is being deleted.
+          MESSAGE
         end
       end
 

data/lib/kennel/models/slo.rb

@@ -15,7 +15,6 @@ module Kennel
       settings :type, :description, :thresholds, :query, :tags, :monitor_ids, :monitor_tags, :name, :groups
 
       defaults(
-        id: -> { nil },
         tags: -> { @project.tags },
         query: -> { DEFAULTS.fetch(:query) },
         description: -> { DEFAULTS.fetch(:description) },
@@ -24,35 +23,25 @@ module Kennel
         groups: -> { DEFAULTS.fetch(:groups) }
       )
 
-      def initialize(*)
-        super
-        if thresholds.any? { |t| t[:warning] && t[:warning].to_f <= t[:critical].to_f }
-          raise ValidationError, "Threshold warning must be greater-than critical value"
-        end
-      end
-
-      def as_json
-        return @as_json if @as_json
-        data = {
+      def build_json
+        data = super.merge(
           name: "#{name}#{LOCK}",
           description: description,
           thresholds: thresholds,
           monitor_ids: monitor_ids,
           tags: tags.uniq,
           type: type
-        }
+        )
 
         if v = query
           data[:query] = v
         end
-        if v = id
-          data[:id] = v
-        end
+
         if v = groups
           data[:groups] = v
         end
 
-        @as_json = data
+        data
       end
 
       def self.api_resource
@@ -89,6 +78,16 @@ module Kennel
 
         ignore_default(expected, actual, DEFAULTS)
       end
+
+      private
+
+      def validate_json(data)
+        super
+
+        if data[:thresholds].any? { |t| t[:warning] && t[:warning].to_f <= t[:critical].to_f }
+          invalid! "Threshold warning must be greater-than critical value"
+        end
+      end
     end
   end
 end

data/lib/kennel/models/synthetic_test.rb

@@ -11,15 +11,14 @@ module Kennel
       settings :tags, :config, :message, :subtype, :type, :name, :locations, :options
 
       defaults(
-        id: -> { nil },
         tags: -> { @project.tags },
         message: -> { "\n\n#{project.mention}" }
       )
 
-      def as_json
-        return @as_json if @as_json
+      def build_json
         locations = locations()
-        data = {
+
+        super.merge(
           message: message,
           tags: tags,
           config: config,
@@ -28,13 +27,7 @@ module Kennel
           options: options,
           name: "#{name}#{LOCK}",
           locations: locations == :all ? LOCATIONS : locations
-        }
-
-        if v = id
-          data[:id] = v
-        end
-
-        @as_json = data
+        )
       end
 
       def self.api_resource

data/lib/kennel/syncer.rb

@@ -104,11 +104,11 @@ module Kennel
     def resolved?(e)
       assert_resolved e
       true
-    rescue ValidationError
+    rescue UnresolvableIdError
       false
     end
 
-    # raises ValidationError when not resolved
+    # raises UnresolvableIdError when not resolved
     def assert_resolved(e)
       resolve_linked_tracking_ids! [e], force: true
     end

data/lib/kennel/version.rb

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

data/lib/kennel.rb

@@ -40,8 +40,9 @@ module Teams
 end
 
 module Kennel
-  class ValidationError < RuntimeError
-  end
+  ValidationError = Class.new(RuntimeError)
+  UnresolvableIdError = Class.new(RuntimeError)
+  DisallowedUpdateError = Class.new(RuntimeError)
 
   include Kennel::Compatibility
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.122.0
+  version: 1.123.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs