google-cloud-env 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22fba900d98b872b7f9de91312f5b169695eebcd395df5080f348b41358f45d3
-  data.tar.gz: 5b14af4d3681740366160c09e6a93d707fe3a6c4c4f866bd1c93ea1c35a76037
+  metadata.gz: cf38fd3f5bb159512f455fde243bd4c6f120535533c5762b92ba28f107fb69ca
+  data.tar.gz: e989ea213443a933d3fa824fb23dc1a0c2e02e613936fe4e135aebc568aa1109
 SHA512:
-  metadata.gz: 1fe82152bd2fdfafbe25a1d00ce3986757917c535a71630a5d32af0bdc7feb120567dd7fbf14a123f44957ca56519de8e2d176ce0084f6902f6182decb60242e
-  data.tar.gz: a146cfd531bd36e4e517a385b3e7b8f252623a68727dff53bb453e6518e1b98236032d90d96b58bd79315b109355e74b4cc6f87f95bac607758674dcf2dbad62
+  metadata.gz: f0ce4b36dae87c5229eae4210e63487da960033430b47e11280cb4752da742d39d7dd3d24ed3cc7ea710124f75da0dbb7b8fa4e36a1ae29cce9f052e77c34100
+  data.tar.gz: d24d266602fa82aba6a6a050f049470c9c85cf937b6e0bd58d804135881b889451219e90f2058b88a74cb67ca1b5741d9df31eeeff8ee8f56a601c82bdd4b4a6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 1.1.0 / 2019-05-29
+
+* Support disabling of the metadata cache
+* Support configurable retries when querying the metadata server
+* Support configuration of the metadata request timeout
+
 ### 1.0.5 / 2018-09-20
 
 * Update documentation.

data/lib/google/cloud/env.rb

@@ -65,6 +65,15 @@ module Google
       # @private URL path for metadata server root.
       METADATA_ROOT_PATH = "/".freeze
 
+      # @private
+      METADATA_FAILURE_EXCEPTIONS = [
+        Faraday::TimeoutError,
+        Faraday::ConnectionFailed,
+        Errno::EHOSTDOWN,
+        Errno::ETIMEDOUT,
+        Timeout::Error
+      ].freeze
+
       ##
       # Create a new instance of the environment information.
       # Most client should not need to call this directly. Obtain a singleton
@@ -72,15 +81,36 @@ module Google
       # is provided for internal testing and allows mocking of the data.
       #
       # @param [Hash] env Mock environment variables.
+      # @param [Hash,false] metadata_cache The metadata cache. You may pass
+      #     a prepopuated cache, an empty cache (the default) or `false` to
+      #     disable the cache completely.
+      # @param [Numeric] request_timeout Timeout for each http request.
+      #     Defaults to 0.1.
+      # @param [Integer] retry_count Number of times to retry http requests.
+      #     Defaults to 1. Note that retry remains in effect even if a custom
+      #     `connection` is provided.
+      # @param [Numeric] retry_interval Time between retries in seconds.
+      #     Defaults to 0.1.
+      # @param [Numeric] retry_backoff_factor Multiplier applied to the retry
+      #     interval on each retry. Defaults to 1.5.
+      # @param [Numeric] retry_max_interval Maximum time between retries in
+      #     seconds. Defaults to 0.5.
       # @param [Faraday::Connection] connection Faraday connection to use.
-      # @param [Hash] metadata_cache Mock cache.
+      #     If specified, overrides the `request_timeout` setting.
       #
-      def initialize env: nil, connection: nil, metadata_cache: nil
+      def initialize env: nil, connection: nil, metadata_cache: nil,
+                     request_timeout: 0.1, retry_count: 2, retry_interval: 0.1,
+                     retry_backoff_factor: 1.5, retry_max_interval: 0.5
+        @disable_metadata_cache = metadata_cache == false
         @metadata_cache = metadata_cache || {}
         @env = env || ::ENV
+        @retry_count = retry_count
+        @retry_interval = retry_interval
+        @retry_backoff_factor = retry_backoff_factor
+        @retry_max_interval = retry_max_interval
         @connection = connection ||
                       ::Faraday.new(url: METADATA_HOST,
-                                    request: { timeout: 0.1 })
+                                    request: { timeout: request_timeout })
       end
 
       ##
@@ -318,17 +348,14 @@ module Google
       # @return [Boolean]
       #
       def metadata?
-        unless metadata_cache.include?(METADATA_ROOT_PATH)
-          begin
-            resp = connection.get METADATA_ROOT_PATH
-            metadata_cache[METADATA_ROOT_PATH] = \
-              resp.status == 200 && resp.headers["Metadata-Flavor"] == "Google"
-          rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed,
-                 Errno::EHOSTDOWN
-            metadata_cache[METADATA_ROOT_PATH] = false
+        path = METADATA_ROOT_PATH
+        if @disable_metadata_cache || !metadata_cache.include?(path)
+          metadata_cache[path] = retry_or_fail_with false do
+            resp = connection.get path
+            resp.status == 200 && resp.headers["Metadata-Flavor"] == "Google"
           end
         end
-        metadata_cache[METADATA_ROOT_PATH]
+        metadata_cache[path]
       end
 
       ##
@@ -342,16 +369,15 @@ module Google
       # @return [String,nil]
       #
       def lookup_metadata type, entry
+        return nil unless metadata?
+
         path = "#{METADATA_PATH_BASE}/#{type}/#{entry}"
-        if !metadata_cache.include?(path) && metadata?
-          begin
+        if @disable_metadata_cache || !metadata_cache.include?(path)
+          metadata_cache[path] = retry_or_fail_with nil do
             resp = connection.get path do |req|
               req.headers = { "Metadata-Flavor" => "Google" }
             end
-            metadata_cache[path] = resp.status == 200 ? resp.body.strip : nil
-          rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed,
-                 Errno::EHOSTDOWN
-            metadata_cache[path] = nil
+            resp.status == 200 ? resp.body.strip : nil
           end
         end
         metadata_cache[path]
@@ -371,6 +397,25 @@ module Google
       attr_reader :connection
       attr_reader :env
       attr_reader :metadata_cache
+
+      def retry_or_fail_with error_result
+        retries_remaining = @retry_count
+        retry_interval = @retry_interval
+        begin
+          yield
+        rescue *METADATA_FAILURE_EXCEPTIONS
+          retries_remaining -= 1
+          if retries_remaining >= 0
+            sleep retry_interval
+            retry_interval *= @retry_backoff_factor
+            if retry_interval > @retry_max_interval
+              retry_interval = @retry_max_interval
+            end
+            retry
+          end
+          error_result
+        end
+      end
     end
 
     @env = Env.new

data/lib/google/cloud/env/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     class Env
-      VERSION = "1.0.5".freeze
+      VERSION = "1.1.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-env
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2019-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.64.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.64.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -202,8 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Google Cloud Platform hosting environment information.