consul-templaterb 1.35.1 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a0f2cd7a7e458f2af107abbca891f03431bcc42df8651e9658bfa928f5d7a1
-  data.tar.gz: a9494da14ca77669a1f044250e421f3546dfeb791ea59c329f6ee43e6af535e5
+  metadata.gz: f29a96f18a7e7229c457c0a31cbb5211ae5d57a96e85193f47154131cbf42d43
+  data.tar.gz: 8fe3323981690e183585c80fe58a4ab44f1a2deffa72bbf14bd1a749cc4447e3
 SHA512:
-  metadata.gz: 1f10abf7fb476c9f2ea652d7c0c68519edb11c9e5bf75e340dbd0e64f0816e84460e75b75380312c7b6911e5f23fe2cef8682b82f661411ef5f0e97ad7f8a7b4
-  data.tar.gz: 502a71a1f9f275fe646285e641d6075463d157f66bf737154b8ae9c8b4609e4d8983759629bf5ef998e1f66621e4963bad5fc837eb295a2a08b26a55e1bfeabc
+  metadata.gz: a47be289a8a7c447732daf3f63624b913a81ee5a09e495c518c020d7c7b9efe9349ed6b09cb2e9ed4fc202ccedd0db650087e7788e9455ec52a3d287f37cf555
+  data.tar.gz: 275755990a89710775fab210479d916fc12e671f8de0f6a42ca94f0708ddcec2fc693dc585b4a00e123b84adaa628630a77f1721cc452a8616c893086030af2a

data/TemplateAPI.md

@@ -631,11 +631,12 @@ secret('secret/foo', [force_ttl: intInSecond])
 
 ## remote_resource
 
-### as_json(url, default_value, [refresh_delay_secs: intInSecond])
+### as_json(url, default_value, [refresh_delay_secs: intInSecond, default_value_on_error: bool])
 
 Fetch json data from any url. This allows to create templates with consul/vault data mixed in with data coming from other services/api.
 Polling interval can be controlled with `refresh_delay_secs` option.
 Request method (`GET`, `POST`, ...) can be controlled with `request_method` option.
+To return default value on the case of error, set `default_value_on_error` to true.
 
 ```erb
 remote_resource.as_json('http://my-api.dev/fridge/list.json', [])

data/lib/consul/async/consul_template.rb

@@ -29,14 +29,14 @@ module Consul
         @endp_manager = endpoints_manager
       end
 
-      def as_json(url, default_value, refresh_delay_secs: 10, **opts)
+      def as_json(url, default_value, refresh_delay_secs: 10, default_value_on_error: false, **opts)
         conf = JSONConfiguration.new(url: url, min_duration: refresh_delay_secs, retry_on_non_diff: refresh_delay_secs, **opts)
         endpoint_id = url + opts.hash.to_s
         @endp_manager.create_if_missing(url, {}, endpoint_id: endpoint_id) do
           if default_value.is_a?(Array)
-            ConsulTemplateJSONArray.new(JSONEndpoint.new(conf, url, default_value))
+            ConsulTemplateJSONArray.new(JSONEndpoint.new(conf, url, default_value, default_value_on_error: default_value_on_error))
           else
-            ConsulTemplateJSONObject.new(JSONEndpoint.new(conf, url, default_value))
+            ConsulTemplateJSONObject.new(JSONEndpoint.new(conf, url, default_value, default_value_on_error: default_value_on_error))
           end
         end
       end

data/lib/consul/async/json_endpoint.rb

@@ -93,9 +93,10 @@ module Consul
     # Endpoint (aka URL) of a remote API that might be called
     class JSONEndpoint
       attr_reader :conf, :url, :queue, :stats, :last_result, :enforce_json_200, :start_time, :default_value, :query_params
-      def initialize(conf, url, default_value, enforce_json_200 = true, query_params = {})
+      def initialize(conf, url, default_value, enforce_json_200: true, query_params: {}, default_value_on_error: false)
         @conf = conf.create(url)
         @default_value = default_value
+        @default_value_on_error = default_value_on_error
         @url = url
         @queue = EM::Queue.new
         @s_callbacks = []
@@ -174,7 +175,7 @@ module Consul
         retry_in = _compute_retry_in([600, conf.retry_duration + 2**@consecutive_errors].min)
         ::Consul::Async::Debug.puts_error "[#{url}] - #{http.error} - Retry in #{retry_in}s #{stats.body_bytes_human}"
         @consecutive_errors += 1
-        http_result = HttpResponse.new(http)
+        http_result = @default_value_on_error ? HttpResponse.new(http, @default_value.to_json) : HttpResponse.new(http)
         EventMachine.add_timer(retry_in) do
           yield
           queue.push(Object.new)
@@ -203,6 +204,7 @@ module Consul
           http = connection[:conn].send(request_method, build_request)
           http.callback do
             if enforce_json_200 && !(200..299).cover?(http.response_header.status) && http.response_header['Content-Type'] != 'application/json'
+              handle_default_on_error(http) if @default_value_on_error
               _handle_error(http) do
                 warn "[RETRY][#{url}] (#{@consecutive_errors} errors)" if (@consecutive_errors % 10) == 1
               end
@@ -227,6 +229,7 @@ module Consul
           end
 
           http.errback do
+            handle_default_on_error(http) if @default_value_on_error
             unless @stopping
               _handle_error(http) do
                 if (@consecutive_errors % 10) == 1
@@ -243,6 +246,15 @@ module Consul
         end
         queue.pop(&cb)
       end
+
+      def handle_default_on_error(http)
+        ::Consul::Async::Debug.puts_error "[#{url}] response status #{http.response_header.status}; using default value"
+        @consecutive_errors = 0
+        json_result = JSONResult.new(@default_value.to_json, false, HttpResponse.new(http, ''), stats, 10, fake: true)
+        @last_result = json_result
+        @ready = true
+        @s_callbacks.each { |c| c.call(json_result) }
+      end
     end
   end
 end

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.35.1'.freeze
+    VERSION = '1.36.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.35.1
+  version: 1.36.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 2024-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request