kennel 2.21.0 → 2.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f604eb100e46e40ba76333717c9ddb99e06cd85be98f7eb19217b7be1b193b2
-  data.tar.gz: 352ead0a6c2ce295f14113d03f9ab956278851d55457340dffa9d6fdf042856e
+  metadata.gz: b931b9c2d75d6e0d69967e3088795e72d8a5f3f558ff1dd1b6de03efde7aabf8
+  data.tar.gz: '081dde24122f351f92c7dc8f16e7877ec3dcd1f7226bd1e4fc126abd3044798d'
 SHA512:
-  metadata.gz: 5d0e3477bcef3043433fca52d3e3c3940f7cd315c7c89ecebb7a07eb7a50d56adcb46522a51492ef47c72346b10bec7446c495c8d368c5ff741a510e2c8885b9
-  data.tar.gz: 0e71a447829ac1dcc996b08858e7dcd720b3e3f6f9e5b2e008bc0e187e952e1cafaa561b62152a37e547053d033ef0c2e37746419205eb1788d859c536f5d77a
+  metadata.gz: ffd01589e499c34d72dd477f5e3e00369582c42cacbf7eae19493e791b84ecbac42c48c5bf34e3d8c8a6245f555d29f62e3cb879cc2e24892b555766f9b5ffcc
+  data.tar.gz: 7a95114123013fd90a64993f86f217b5f4379e0d3dc6b19d876d2ac42f404b4907ef35b2396c811c4291838ca8183073523090bb2d89882dbbffa6972b40bb38

data/lib/kennel/api.rb

@@ -22,8 +22,9 @@ module Kennel
       @client = Faraday.new(url: url)
     end
 
-    def show(api_resource, id, params = {})
-      response = request :get, "/api/v1/#{api_resource}/#{id}", params: params
+    def show(api_resource, id, params = {}, ignore_404: false)
+      response = request :get, "/api/v1/#{api_resource}/#{id}", params: params, ignore_404: ignore_404
+      return if response.nil? # 404 that was ignored
       response = response.fetch(:data) if api_resource == "slo"
       response[:id] = response.delete(:public_id) if api_resource == "synthetics/tests"
       self.class.with_tracking(api_resource, response)
@@ -54,6 +55,8 @@ module Kennel
     end
 
     def update(api_resource, id, attributes)
+      restore_widget_ids(id, attributes) if api_resource == "dashboard"
+
       response = request :put, "/api/v1/#{api_resource}/#{id}", body: attributes
       response[:id] = response.delete(:public_id) if api_resource == "synthetics/tests"
       self.class.with_tracking(api_resource, response)
@@ -74,12 +77,44 @@ module Kennel
     # 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) }.sum
+        results = Utils.parallel(list) { |a| fill_detail!(api_resource, a, cache) }
+
+        # drop resources that were not found (race condition between listing and showing)
+        list.select!.with_index { |_, i| results[i][1] }
+
+        results.count { |uncached, _| uncached }
       end
     end
 
     private
 
+    # keep widget ids stable so stored dashboard urls that point at a widget do not break on every update
+    # widget ids are dropped when diffing since they change on every update, but that also changes them in datadog
+    # and breaks stored urls that point at a specific widget, so restore the previous ids by matching widget titles
+    def restore_widget_ids(id, attributes)
+      return unless (widgets = attributes[:widgets])
+      return unless (current = show("dashboard", id, {}, ignore_404: true))
+
+      ids = {}
+      each_widget_with_key(current[:widgets]) { |key, widget| ids[key] = widget[:id] }
+      each_widget_with_key(widgets) do |key, widget|
+        next unless (id = ids[key])
+        widget[:id] ||= id # do not set nil, that breaks updates
+      end
+    end
+
+    # yield each widget with a key built from its (optional) group title and its own title
+    def each_widget_with_key(widgets, prefix: nil, &block)
+      widgets.each do |widget|
+        title = widget.dig(:definition, :title)
+        key = [prefix, title].compact.join("-")
+        yield key, widget
+        if (nested = widget.dig(:definition, :widgets))
+          each_widget_with_key(nested, prefix: title, &block)
+        end
+      end
+    end
+
     def with_pagination(enabled, params)
       return yield params unless enabled
       raise ArgumentError if params[:limit] || params[:offset]
@@ -96,15 +131,16 @@ module Kennel
     end
 
     # Make diff work even though we cannot mass-fetch definitions
+    # @return [uncached, found]
     def fill_detail!(api_resource, a, cache)
-      uncached = 0
+      uncached = false
       args = [api_resource, a.fetch(:id)]
       full = cache.fetch(args, a.fetch(:modified_at)) do
-        uncached += 1
-        show(*args)
+        uncached = true
+        show(*args, ignore_404: true)
       end
-      a.merge!(full)
-      uncached
+      a.merge!(full) if full
+      [uncached, !!full]
     end
 
     def details_cache(&block)
@@ -117,29 +153,18 @@ module Kennel
       cached = (ENV["FORCE_GET_CACHE"] && method == :get)
 
       with_cache cached, path do
-        response = nil
-        tries.times do |i|
-          response = Utils.retry Faraday::ConnectionFailed, Faraday::TimeoutError, times: 2 do
-            @client.send(method, path) do |request|
-              request.body = JSON.generate(body) if body
-              request.headers["Content-type"] = "application/json"
-              request.headers["DD-API-KEY"] = @api_key
-              request.headers["DD-APPLICATION-KEY"] = @app_key
-            end
+        response = request_with_retries(path, tries) do
+          @client.send(method, path) do |request|
+            request.body = JSON.generate(body) if body
+            request.headers["Content-type"] = "application/json"
+            request.headers["DD-API-KEY"] = @api_key
+            request.headers["DD-APPLICATION-KEY"] = @app_key
           end
-
-          if response.status == 429
-            sleep_until_rate_limit_resets(response)
-            redo
-          end
-
-          last_try = (i == tries - 1)
-          break if last_try || response.status < 500
-          Kennel.err.puts "Retrying on server error #{response.status} for #{path}"
-          sleep retry_backoff_time(i)
         end
 
-        if !response.success? && (response.status != 404 || !ignore_404)
+        next if response.status == 404 && ignore_404
+
+        unless response.success?
           message = "Error #{response.status} during #{method.upcase} #{path}\n"
           message << "request:\n#{JSON.pretty_generate(body)}\nresponse:\n" if body
           message << response.body.encode(message.encoding, invalid: :replace, undef: :replace)
@@ -154,6 +179,28 @@ module Kennel
       end
     end
 
+    # retry on rate-limits and server errors, giving up after `tries` attempts
+    def request_with_retries(path, tries, &block)
+      raise ArgumentError, "tries must be > 0" if tries < 1
+      response = nil
+      tries.times do |i|
+        response = Utils.retry Faraday::ConnectionFailed, Faraday::TimeoutError, times: 2, &block
+
+        # we do not count 429s into the "tries", tries are only for real errors
+        # so this could loop forever if datadog consistently 429s
+        if response.status == 429
+          sleep_until_rate_limit_resets(response)
+          redo
+        end
+
+        last_try = (i == tries - 1)
+        break if last_try || response.status < 500
+        Kennel.err.puts "Retrying on server error #{response.status} for #{path}"
+        sleep retry_backoff_time(i)
+      end
+      response
+    end
+
     def sleep_until_rate_limit_resets(response)
       limit = response.headers["x-ratelimit-limit"]
       period = response.headers["x-ratelimit-period"]

data/lib/kennel/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 2.21.0
+  version: 2.22.0
 platform: ruby
 authors:
 - Michael Grosser