ms_rest_azure 0.10.8 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4619807ebd53301967ee5d9845dc6ad192c2ae3b
-  data.tar.gz: ba39d3b5cbe1a768a381d5887480eeff79d05176
+  metadata.gz: 9d37dfda37f047cab1ca8ede97a21b4b6e948cca
+  data.tar.gz: be8a83887c0f8e6d1a9bb532db78af7844e1639b
 SHA512:
-  metadata.gz: 227a68ad8c21f67cf8166b80491d6daffbfa008bea6064b0dc2e5e98e0235e5c6e60585ae6e7482a6a23babf8f7ab3a1144df99d08c28f8f9a92dc5ce4660c86
-  data.tar.gz: e160286a220dc64118709fb10a24c369821cf8c2c896e9a5abbb0de05953dc18a9f656df99ba3883237ebff7955dde766ac41e3b0428c630ddcfb7b41f1a49e4
+  metadata.gz: 7a64ed4cdf61a5d096afa34373487c64a39b10f2a1d4b0a407b052a2446df05d656da0b2749202b8dbc35448269690c90ff14774527a01f4d3145028f83afdd1
+  data.tar.gz: 683983a519bc16e11f76f275fcab91190567bb56987ee50f9b48e8ef6e2ff78c3905297b1be82648b237ee01861145998c98fdc5f2c4db5415ae66235a160dc4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+##2018.07.31 ms_rest_azure version 0.11.0
+* Added USER_DEFINED_IMDS_MAX_RETRY_TIME to msi_token_provider. Refer [PR #1539](https://github.com/Azure/azure-sdk-for-ruby/pull/1539) and [Issue #1344](https://github.com/Azure/azure-sdk-for-ruby/issues/1344) for further details.
+* Modified Long Running Operation Logic to make final calls based on Final State Via value. Refer [PR #1537](https://github.com/Azure/azure-sdk-for-ruby/pull/1537) for further details.
+
 ##2018.06.08 ms_rest_azure version 0.10.8
 * Added case insensitive comparison to Operation status.
 

data/lib/ms_rest_azure.rb

@@ -10,6 +10,7 @@ require 'ms_rest_azure/azure_operation_error.rb'
 require 'ms_rest_azure/azure_operation_response.rb'
 require 'ms_rest_azure/azure_service_client.rb'
 require 'ms_rest_azure/cloud_error_data.rb'
+require 'ms_rest_azure/final_state_via.rb'
 require 'ms_rest_azure/credentials/application_token_provider.rb'
 require 'ms_rest_azure/credentials/cognitive_services_credentials.rb'
 require 'ms_rest_azure/credentials/topic_credentials.rb'

data/lib/ms_rest_azure/azure_service_client.rb

@@ -30,10 +30,11 @@ module MsRestAzure
     # Retrieves the result of 'POST','DELETE','PUT' or 'PATCH' operation. Performs polling of required.
     # @param azure_response [MsRestAzure::AzureOperationResponse] response from Azure service.
     # @param custom_deserialization_block [Proc] custom logic for response deserialization.
+    # @param final_state_via [MsRestAzure::FinalStateVia] Final State via value
     #
     # @return [MsRest::HttpOperationResponse] the response.
     #
-    def get_long_running_operation_result(azure_response, custom_deserialization_block)
+    def get_long_running_operation_result(azure_response, custom_deserialization_block, final_state_via = FinalStateVia::DEFAULT)
       check_for_status_code_failure(azure_response)
 
       http_method = azure_response.request.method
@@ -47,13 +48,22 @@ module MsRestAzure
             if !polling_state.azure_async_operation_header_link.nil?
               update_state_from_azure_async_operation_header(polling_state.get_request(headers: request.headers, base_uri: request.base_uri, user_agent_extended: user_agent_extended), polling_state)
             elsif !polling_state.location_header_link.nil?
-              update_state_from_location_header(polling_state.get_request(headers: request.headers, base_uri: request.base_uri, user_agent_extended: user_agent_extended), polling_state, custom_deserialization_block)
+              update_state_from_location_header(polling_state.get_request(headers: request.headers, base_uri: request.base_uri, user_agent_extended: user_agent_extended), polling_state, custom_deserialization_block, final_state_via)
             elsif http_method === :put
               get_request = MsRest::HttpOperationRequest.new(request.base_uri, request.build_path.to_s, :get, {query_params: request.query_params, headers: request.headers, user_agent_extended: user_agent_extended})
               update_state_from_get_resource_operation(get_request, polling_state, custom_deserialization_block)
             else
               task.shutdown
-              fail AzureOperationError, 'Location header is missing from long running operation'
+              if final_state_via == FinalStateVia::LOCATION
+                if !polling_state.response.body.to_s.empty?
+                  body = JSON.load(polling_state.response.body)
+                  polling_state.resource = custom_deserialization_block.call(body)
+                else
+                  fail AzureOperationError, 'Location header is missing from long running operation'
+                end
+              else
+                fail AzureOperationError, 'Location header is missing from long running operation'
+              end
             end
 
             if AsyncOperationStatus.is_terminal_status(polling_state.status)
@@ -83,6 +93,12 @@ module MsRestAzure
           update_state_from_get_resource_operation(get_request, polling_state, custom_deserialization_block)
         end
 
+        if final_state_via == FinalStateVia::LOCATION
+          if((http_method === :post || http_method === :delete) && !polling_state.location_header_link.nil?)
+            update_state_from_location_header(polling_state.get_request(headers: request.headers, base_uri: request.base_uri, user_agent_extended: user_agent_extended), polling_state, custom_deserialization_block, final_state_via)
+          end
+        end
+
         # Process long-running POST/DELETE operation with schema defined on success status codes
         if (http_method === :post || http_method === :delete) && custom_deserialization_block && polling_state.response
           unless polling_state.response.body.to_s.empty?
@@ -152,8 +168,9 @@ module MsRestAzure
     # @param request [MsRest::HttpOperationRequest] The url retrieve data from.
     # @param polling_state [MsRestAzure::PollingState] polling state to update.
     # @param custom_deserialization_block [Proc] custom deserialization method for parsing response.
+    # @param final_state_via [MsRestAzure::FinalStateVia] Final State via value
     #
-    def update_state_from_location_header(request, polling_state, custom_deserialization_block)
+    def update_state_from_location_header(request, polling_state, custom_deserialization_block, final_state_via = FinalStateVia::DEFAULT)
       result = get_async_with_custom_deserialization(request, custom_deserialization_block)
 
       polling_state.update_response(result.response)
@@ -173,6 +190,8 @@ module MsRestAzure
 
         polling_state.error_data = error_data
         polling_state.resource = result.body
+      elsif final_state_via == FinalStateVia::LOCATION && status_code === 404 && http_method === :delete && !polling_state.azure_async_operation_header_link.nil? && !polling_state.location_header_link.nil?
+        polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
       else
         fail AzureOperationError, "The response from long running operation does not have a valid status code. Method: #{http_method}, Status Code: #{status_code}"
       end

data/lib/ms_rest_azure/credentials/msi_token_provider.rb

@@ -106,13 +106,15 @@ module MsRestAzure
       retry_value = 1
       max_retry = 20
       response = nil
+      user_defined_time_limit = ENV['USER_DEFINED_IMDS_MAX_RETRY_TIME'].nil? ? 104900:ENV['USER_DEFINED_IMDS_MAX_RETRY_TIME']
+      total_wait = 0
 
       slots = []
       (0..max_retry-1).each do |i|
         slots << (100 * ((2 << i) - 1) /1000.to_f)
       end
 
-      while retry_value <= max_retry
+      while retry_value <= max_retry && total_wait < user_defined_time_limit
         response = connection.get do |request|
           request.headers['Metadata'] = 'true'
           request.headers['User-Agent'] = "Azure-SDK-For-Ruby/ms_rest_azure/#{MsRestAzure::VERSION}"
@@ -127,7 +129,9 @@ module MsRestAzure
           if (retry_value > max_retry)
             break
           end
+          wait = wait > user_defined_time_limit ? user_defined_time_limit : wait
           sleep(wait)
+          total_wait += wait
         elsif response.status != 200
           fail AzureOperationError, "Couldn't acquire access token from Managed Service Identity, please verify your tenant id, port and settings"
         else

data/lib/ms_rest_azure/final_state_via.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+module MsRestAzure
+  #
+  # Class which represents a final state via of Azure long running operation.
+  #
+  class FinalStateVia
+    NONE = -1
+    DEFAULT = 0
+    AZURE_ASYNC_OPERATION = 0
+    LOCATION = 1
+    ORIGINAL_URI = 2
+  end
+end

data/lib/ms_rest_azure/version.rb

@@ -3,5 +3,5 @@
 # Licensed under the MIT License. See License.txt in the project root for license information.
 
 module MsRestAzure
-  VERSION = '0.10.8'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ms_rest_azure
 version: !ruby/object:Gem::Version
-  version: 0.10.8
+  version: 0.11.0
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-08 00:00:00.000000000 Z
+date: 2018-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - lib/ms_rest_azure/credentials/cognitive_services_credentials.rb
 - lib/ms_rest_azure/credentials/msi_token_provider.rb
 - lib/ms_rest_azure/credentials/topic_credentials.rb
+- lib/ms_rest_azure/final_state_via.rb
 - lib/ms_rest_azure/polling_state.rb
 - lib/ms_rest_azure/serialization.rb
 - lib/ms_rest_azure/version.rb
@@ -142,7 +143,7 @@ metadata:
   changelog_uri: https://github.com/Azure/azure-sdk-for-ruby/blob/master/runtime/ms_rest_azure/CHANGELOG.md
   documentation_uri: https://azure.microsoft.com/en-us/develop/ruby/
   homepage_uri: https://aka.ms/azure-sdk-for-ruby
-  source_code_uri: https://github.com/Azure/azure-sdk-for-ruby/tree/ms_rest_azure-v0.10.8
+  source_code_uri: https://github.com/Azure/azure-sdk-for-ruby/tree/ms_rest_azure-v0.11.0
 post_install_message: 
 rdoc_options: []
 require_paths: