kennel 1.39.0 → 1.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ff03815a21fb7a0850ac598043a687268e63b596d33d4b3a741c75f5b11fe87
-  data.tar.gz: 2570ed375f81545c1eb4b251e2f35f3abbfc4c7779191917f5ba87dae65ad7d7
+  metadata.gz: 48d299703094c1309aec2c1e902a6c0e8a37174395a9fccd233cf72f3b75b255
+  data.tar.gz: 72f45df5f14f29c97f4a906d6f59cc9a70acc26040fed0a36520e8c675dbacb0
 SHA512:
-  metadata.gz: 01a572db1d8b0313833197af3dbb3c86226b0b9903d8593beb237868ee7c9d9ceeb62c69cbd9ea4d77257c08a89758f21b63439a78c9bd5044a31ad0c2d2a901
-  data.tar.gz: 61c71ec73f73fa2a81415a2167eb97f1638692d3e1e91ae9c910a741a1d3bd9e8685ba5eb92c7971a8c15647f41d8746312bd370532d48d73ece8ed848b07c2b
+  metadata.gz: ef6beaa1c5ffa0c2b1c6d534e1fd30cd3276d29bf1a16074e06f1499b76466b187c0694e5bc50ca9c9e8bb814cccfec05f477bee16b15b34067df3c78c83d2d3
+  data.tar.gz: eeabb869d2528613cbb1d18b92fe603404c160fc88212b76f97a02d4a77e8262b930fde867ae3fb33e13c0ce330b8998d5494ee233655b294b37461d6e10e5f3

data/lib/kennel.rb

@@ -20,6 +20,7 @@ require "kennel/models/base"
 # parts
 require "kennel/models/monitor"
 require "kennel/models/dash"
+require "kennel/models/dashboard"
 require "kennel/models/screen"
 
 # settings

data/lib/kennel/importer.rb

@@ -64,8 +64,9 @@ module Kennel
     private
 
     def pretty_print(hash)
-      list = hash.sort_by { |k, _| [SORT_ORDER.index(k) || 999, k] } # important to the front and rest deterministic
-      list.map do |k, v|
+      sort_widgets hash
+
+      sort_hash(hash).map do |k, v|
         pretty_value =
           if v.is_a?(Hash) || (v.is_a?(Array) && !v.all? { |e| e.is_a?(String) })
             # update answer here when changing https://stackoverflow.com/questions/8842546/best-way-to-pretty-print-a-hash
@@ -85,5 +86,19 @@ module Kennel
         "  #{k}: -> {#{pretty_value}}"
       end.join(",\n")
     end
+
+    # sort dashboard widgets + nesting
+    def sort_widgets(outer)
+      outer[:widgets]&.each do |widgets|
+        definition = widgets[:definition]
+        definition.replace sort_hash(definition)
+        sort_widgets definition
+      end
+    end
+
+    # important to the front and rest deterministic
+    def sort_hash(hash)
+      Hash[hash.sort_by { |k, _| [SORT_ORDER.index(k) || 999, k] }]
+    end
   end
 end

data/lib/kennel/models/base.rb

@@ -74,7 +74,7 @@ module Kennel
           [expected.size.to_i, actual.size.to_i].max.times do |i|
             a_r = actual.dig(i, level2, :requests) || []
             e_r = expected.dig(i, level2, :requests) || []
-            ignore_defaults e_r, a_r, REQUEST_DEFAULTS
+            ignore_defaults e_r, a_r, self::REQUEST_DEFAULTS
           end
         end
 

data/lib/kennel/models/dash.rb

@@ -75,14 +75,7 @@ module Kennel
       def validate_json(data)
         super
 
-        # check for bad variables
-        # TODO: do the same check for apm_query and their group_by
-        variables = (data[:template_variables] || []).map { |v| "$#{v.fetch(:name)}" }
-        queries = data[:graphs].flat_map { |g| (g[:definition][:requests] || []).map { |r| r[:q] }.compact }
-        bad = queries.grep_v(/(#{variables.map { |v| Regexp.escape(v) }.join("|")})\b/)
-        if bad.any?
-          invalid! "queries #{bad.join(", ")} must use the template variables #{variables.join(", ")}"
-        end
+        validate_template_variables data, :graphs
 
         # check for fields that are unsettable
         data[:graphs].each do |g|
@@ -92,12 +85,6 @@ module Kennel
         end
       end
 
-      def render_template_variables
-        (template_variables || []).map do |v|
-          v.is_a?(String) ? { default: "*", prefix: v, name: v } : v
-        end
-      end
-
       def render_graphs
         definitions.map do |title, viz, type, queries, options = {}, ignored = nil|
           # validate inputs

data/lib/kennel/models/dashboard.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+module Kennel
+  module Models
+    class Dashboard < Base
+      include TemplateVariables
+      include OptionalValidations
+
+      API_LIST_INCOMPLETE = true
+      DASHBOARD_DEFAULTS = { template_variables: [] }.freeze
+      READONLY_ATTRIBUTES = Base::READONLY_ATTRIBUTES + [
+        :author_handle, :author_name, :modified_at, :url, :is_read_only, :notify_list
+      ]
+      REQUEST_DEFAULTS = {
+        style: { line_width: "normal", palette: "dog_classic", line_type: "solid" }
+      }.freeze
+
+      settings :id, :title, :description, :widgets, :kennel_id, :layout_type
+
+      defaults(
+        description: -> { "" },
+        widgets: -> { [] },
+        id: -> { nil }
+      )
+
+      class << self
+        def normalize(expected, actual)
+          super
+
+          ignore_default expected, actual, DASHBOARD_DEFAULTS
+
+          base_pairs(expected, actual).each do |pair|
+            ignore_request_defaults(*pair, :widgets, :definition)
+            pair.each { |dash| dash[:widgets]&.each { |w| w.delete(:id) } }
+          end
+        end
+
+        private
+
+        # expand nested widgets into expected/actual pairs for default resolution
+        # [a, e] -> [[a, e], [aw1, ew1], ...]
+        def base_pairs(*pair)
+          result = [pair]
+          slots = pair.map { |d| d[:widgets]&.size }.compact.max.to_i
+          slots.times do |i|
+            nested = pair.map { |d| d.dig(:widgets, i, :definition) || {} }
+            result << nested if nested.any? { |d| d.key?(:widgets) }
+          end
+          result
+        end
+      end
+
+      attr_reader :project
+
+      def initialize(project, *args)
+        @project = project
+        super(*args)
+      end
+
+      def self.api_resource
+        "dashboard"
+      end
+
+      def as_json
+        return @json if @json
+        @json = {
+          layout_type: layout_type,
+          title: "#{title}#{LOCK}",
+          description: description,
+          template_variables: render_template_variables,
+          widgets: widgets
+        }
+
+        @json[:id] = id if id
+
+        validate_json(@json) if validate
+
+        @json
+      end
+
+      def url(id)
+        Utils.path_to_url "/dashboard/#{id}"
+      end
+
+      private
+
+      def validate_json(data)
+        super
+
+        validate_template_variables data, :widgets
+      end
+    end
+  end
+end

data/lib/kennel/syncer.rb

@@ -74,8 +74,12 @@ module Kennel
         details_cache do |cache|
           actual.each do |a|
             id = a.fetch(:id)
+            e = matching_expected(a)
 
-            if e = delete_matching_expected(a)
+            # check correct class, since we will have multiple actuals for each flavor (dash/screen/dashboard)
+            next if e && e.class.api_resource != a[:api_resource]
+
+            if e && @expected.delete(e)
               fill_details(a, cache) if e.class::API_LIST_INCOMPLETE
               diff = e.diff(a)
               @update << [id, e, a, diff] if diff.any?
@@ -94,7 +98,7 @@ module Kennel
     def fill_details(a, cache)
       resource = a.fetch(:api_resource)
       args = [resource, a.fetch(:id)]
-      full = cache.fetch(args, a.fetch(:modified)) do
+      full = cache.fetch(args, a[:modified] || a.fetch(:modified_at)) do
         unnest(resource, @api.show(*args))
       end
       a.merge!(full)
@@ -117,13 +121,10 @@ module Kennel
       end
 
       Utils.parallel(api_resources.compact.uniq) do |api_resource|
-        # lookup monitors without adding unnecessary downtime information
-        results = @api.list(api_resource, with_downtimes: false)
-        if results.is_a?(Hash)
-          results = results[results.keys.first]
-          results.each { |r| r[:id] = Integer(r.fetch(:id)) }
-        end
-        results.each { |c| c[:api_resource] = api_resource }
+        results = @api.list(api_resource, with_downtimes: false) # lookup monitors without adding unnecessary downtime information
+        results = results[results.keys.first] if results.is_a?(Hash) # dashes/screens are nested in {dash: {}}
+        results.each { |r| r[:id] = Integer(r[:id]) if r[:id] =~ /\A\d+\z/ } # screen ids are integers as strings
+        results.each { |c| c[:api_resource] = api_resource } # store api resource for later diffing
       end.flatten(1)
     end
 
@@ -134,7 +135,7 @@ module Kennel
       end
     end
 
-    def delete_matching_expected(a)
+    def matching_expected(a)
       # index list by all the thing we look up by: tracking id and actual id
       @lookup_map ||= @expected.each_with_object({}) do |e, all|
         keys = [tracking_id(e.as_json)]
@@ -145,8 +146,7 @@ module Kennel
         end
       end
 
-      e = @lookup_map["#{a.fetch(:api_resource)}:#{a.fetch(:id)}"] || @lookup_map[tracking_id(a)]
-      @expected.delete(e) if e
+      @lookup_map["#{a.fetch(:api_resource)}:#{a.fetch(:id)}"] || @lookup_map[tracking_id(a)]
     end
 
     def print_plan(step, list, color)

data/lib/kennel/template_variables.rb

@@ -9,9 +9,25 @@ module Kennel
     private
 
     def render_template_variables
-      template_variables.map do |v|
+      (template_variables || []).map do |v|
         v.is_a?(String) ? { default: "*", prefix: v, name: v } : v
       end
     end
+
+    # check for queries that do not use the variables and would be misleading
+    # TODO: do the same check for apm_query and their group_by
+    def validate_template_variables(data, key)
+      variables = (data[:template_variables] || []).map { |v| "$#{v.fetch(:name)}" }
+      queries = data[key].flat_map do |g|
+        requests =
+          (g.dig(:definition, :requests) || []) +
+          (g.dig(:definition, :widgets) || []).flat_map { |w| w.dig(:definition, :requests) || [] }
+        requests.map { |r| r[:q] }
+      end.compact
+      bad = queries.grep_v(/(#{variables.map { |v| Regexp.escape(v) }.join("|")})\b/)
+      if bad.any?
+        invalid! "queries #{bad.join(", ")} must use the template variables #{variables.join(", ")}"
+      end
+    end
   end
 end

data/lib/kennel/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.39.0
+  version: 1.40.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-11 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,7 @@ files:
 - lib/kennel/importer.rb
 - lib/kennel/models/base.rb
 - lib/kennel/models/dash.rb
+- lib/kennel/models/dashboard.rb
 - lib/kennel/models/monitor.rb
 - lib/kennel/models/project.rb
 - lib/kennel/models/screen.rb