google-cloud-env 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 743c1259c72af3a3cd7872d88adfa2d4ba8d4850733dfba06403ad9014e510fb
-  data.tar.gz: f1d426cd09a3591e4e60e95c0d47ada831ec498bdfc04ab709a90c6333cae560
+  metadata.gz: 86778304c7001d745acd20f90528b22a5e03c2c048f522cedd8e99ab1f50bf24
+  data.tar.gz: '05291246aa4fb33c473f2fa9bceefdc921460b4424174ef357707e07c2c832bc'
 SHA512:
-  metadata.gz: f851d76b537d777a94973491da78ab454dbcbe23f1809ce981d86a654a28af8e1b22c7f2595ea3d4a5c64d0648d263790a61fa36e56a63eb70f83ff9a0862922
-  data.tar.gz: 6b2160f8ab772f8af3bdbc8ee613cbc33e92310d99ac36dbf9a8962a8c75f5db6a6a7145c1560e2aa73e51d5e07acb04d3aa4638d222d2814de5288b043686b5
+  metadata.gz: 3900d323cdddef329f2edc4b17f7098dda5edac5378bfb11fc1311b23dc0680eb83d8f18bef86ad95baeb46315c7466551e7a0c5badf31924d3f6862ff05b1f5
+  data.tar.gz: 5ba1b0660ab4ee0e04f34cec0cee72ef3fda2fe7aa52e14dfb159db4c0a89d9cc38cf215d2606b900c1f0c25f9fc77d942b377ab678179859ac23be23dadfc5e

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release History
 
+### 2.1.0 (2023-12-12)
+
+#### Features
+
+* Provide retrieval_monotonic_time on compute metadata response objects ([#62](https://github.com/googleapis/ruby-cloud-env/issues/62)) 
+
+### 2.0.1 (2023-12-01)
+
+#### Bug Fixes
+
+* Bad response status or flavor headers no longer signal positive metadata existence ([#61](https://github.com/googleapis/ruby-cloud-env/issues/61)) 
+* Increase token expiry buffer to three and a half minutes ([#59](https://github.com/googleapis/ruby-cloud-env/issues/59)) 
+
 ### 2.0.0 (2023-11-14)
 
 This is a major overhaul of the mechanisms underlying this gem, to improve reliability and provide better mocking interfaces. Environment interrogation calls are unchanged, but the mocking override parameters from 1.x have been removed in favor of the new interfaces, hence the semver-major version bump.

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

@@ -89,7 +89,8 @@ module Google
         # {ComputeMetadata#lookup_response}.
         #
         # This object duck-types the `status`, `body`, and `headers` fields of
-        # `Faraday::Response`.
+        # `Faraday::Response`. It also includes the CLOCK_MONOTONIC time when
+        # the data was retrieved.
         #
         class Response
           ##
@@ -105,6 +106,7 @@ module Google
             @status = status
             @body = body
             @headers = headers
+            @retrieval_monotonic_time = Process.clock_gettime Process::CLOCK_MONOTONIC
           end
 
           ##
@@ -124,6 +126,19 @@ module Google
           # @return [Hash{String=>String}]
           #
           attr_reader :headers
+
+          # The CLOCK_MONOTONIC time at which this response was retrieved.
+          # @return [Numeric]
+          #
+          attr_reader :retrieval_monotonic_time
+
+          ##
+          # Returns true if the metadata-flavor is correct for Google Cloud
+          # @return [boolean]
+          #
+          def google_flavor?
+            headers["Metadata-Flavor"] == "Google"
+          end
         end
 
         ##
@@ -233,20 +248,10 @@ module Google
                        compute_smbios: nil
           @variables = variables || Variables.new
           @compute_smbios = compute_smbios || ComputeSMBIOS.new
-          self.host = nil
-          @connection = Faraday.new url: host
-          self.open_timeout = DEFAULT_OPEN_TIMEOUT
-          self.request_timeout = DEFAULT_REQUEST_TIMEOUT
-          self.retry_count = DEFAULT_RETRY_COUNT
-          self.retry_timeout = DEFAULT_RETRY_TIMEOUT
-          self.retry_interval = DEFAULT_RETRY_INTERVAL
-          self.warmup_time = DEFAULT_WARMUP_TIME
-          @cache = create_cache
           # This mutex protects the overrides and existence settings.
           # Those values won't change within a synchronize block.
           @mutex = Thread::Mutex.new
-          reset_existence!
-          @overrides = nil
+          reset!
         end
 
         ##
@@ -443,7 +448,7 @@ module Google
                                      request_timeout: request_timeout,
                                      retry_count: retry_count,
                                      retry_timeout: retry_timeout
-          return nil unless response.status == 200 && response.headers["Metadata-Flavor"] == "Google"
+          return nil unless response.status == 200 && response.google_flavor?
           response.body
         end
 
@@ -618,6 +623,26 @@ module Google
         #
         attr_reader :compute_smbios
 
+        ##
+        # @private
+        # Reset the cache, overrides, and all settings to default, for testing.
+        #
+        def reset!
+          @mutex.synchronize do
+            self.host = nil
+            @connection = Faraday.new url: host
+            self.open_timeout = DEFAULT_OPEN_TIMEOUT
+            self.request_timeout = DEFAULT_REQUEST_TIMEOUT
+            self.retry_count = DEFAULT_RETRY_COUNT
+            self.retry_timeout = DEFAULT_RETRY_TIMEOUT
+            self.retry_interval = DEFAULT_RETRY_INTERVAL
+            self.warmup_time = DEFAULT_WARMUP_TIME
+            @cache = create_cache
+            @overrides = nil
+          end
+          reset_existence!
+        end
+
         ##
         # @private
         # Clear the existence cache, for testing.
@@ -627,6 +652,7 @@ module Google
             @existence = nil
             @startup_time = Process.clock_gettime Process::CLOCK_MONOTONIC
           end
+          self
         end
 
         private
@@ -645,6 +671,29 @@ module Google
           Timeout::Error
         ].freeze
 
+        ##
+        # @private
+        #
+        # A buffer in seconds for token expiry. Our cache for the token will
+        # expire approximately this many seconds before the declared expiry
+        # time of the token itself.
+        #
+        # We want this value to be positive so that we provide some buffer to
+        # offset any clock skew and Metadata Server latency that might affect
+        # our calculation of the expiry time, but more importantly so that a
+        # client has approximately this amount of time to use a token we give
+        # them before it expires.
+        #
+        # We don't want this to be much higher, however, to keep the load down
+        # on the Metadata Server. We've been advised by the compute/serverless
+        # engineering teams to set this value less than 4 minutes because the
+        # Metadata Server can refresh the token as late as 4 minutes before the
+        # actual expiry of the previous token. If our cache expires and we
+        # request a new token, we actually want to receive a new token rather
+        # than the previous old token. See internal issue b/311414224.
+        #
+        TOKEN_EXPIRY_BUFFER = 210
+
         ##
         # @private
         #
@@ -708,8 +757,12 @@ module Google
             req.options.timeout = request_timeout if request_timeout
             req.options.open_timeout = open_timeout if open_timeout
           end
-          post_update_existence true
           response = Response.new http_response.status, http_response.body, http_response.headers
+          if path.nil?
+            post_update_existence(response.status == 200 && response.google_flavor?, response.retrieval_monotonic_time)
+          elsif response.google_flavor?
+            post_update_existence true, response.retrieval_monotonic_time
+          end
           lifetime = determine_data_lifetime path, response.body.strip
           LazyValue.expiring_value lifetime, response
         rescue *TRANSIENT_EXCEPTIONS
@@ -721,14 +774,14 @@ module Google
         # @private
         # Update existence based on a received result
         #
-        def post_update_existence success
+        def post_update_existence success, current_time = nil
           return if @existence == :confirmed
           @mutex.synchronize do
             if success
               @existence = :confirmed
-            elsif @existence != :confirmed &&
-                  Process.clock_gettime(Process::CLOCK_MONOTONIC) > @startup_time + warmup_time
-              @existence = :no
+            elsif @existence != :confirmed
+              current_time ||= Process.clock_gettime Process::CLOCK_MONOTONIC
+              @existence = :no if current_time > @startup_time + warmup_time
             end
           end
         end
@@ -754,8 +807,7 @@ module Google
         def access_token_lifetime data
           json = JSON.parse data rescue nil
           return 0 unless json&.key? "expires_in"
-          # Buffer of 10 seconds to account for MDS latency
-          lifetime = json["expires_in"].to_i - 10
+          lifetime = json["expires_in"].to_i - TOKEN_EXPIRY_BUFFER
           lifetime = 0 if lifetime.negative?
           lifetime
         end
@@ -769,8 +821,7 @@ module Google
           base64 = Base64.decode64 Regexp.last_match[1]
           json = JSON.parse base64 rescue nil
           return 0 unless json&.key? "exp"
-          # Buffer of 10 seconds in case of clock skew
-          lifetime = json["exp"].to_i - Time.now.to_i - 10
+          lifetime = json["exp"].to_i - Time.now.to_i - TOKEN_EXPIRY_BUFFER
           lifetime = 0 if lifetime.negative?
           lifetime
         end

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

@@ -20,7 +20,7 @@ module Google
       # Library version
       # @return [String]
       #
-      VERSION = "2.0.0".freeze
+      VERSION = "2.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: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,10 +59,10 @@ homepage: https://github.com/googleapis/ruby-cloud-env
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/google-cloud-env/2.0.0/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/google-cloud-env/2.1.0/CHANGELOG.md
   source_code_uri: https://github.com/googleapis/ruby-cloud-env
   bug_tracker_uri: https://github.com/googleapis/ruby-cloud-env/issues
-  documentation_uri: https://rubydoc.info/gems/google-cloud-env/2.0.0
+  documentation_uri: https://rubydoc.info/gems/google-cloud-env/2.1.0
 post_install_message: 
 rdoc_options: []
 require_paths: