v3(services): route binding respect Retry-After header (cloudfoundry#1811)

* v3(services): route binding respect Retry-After header

[#174398274](https://www.pivotaltracker.com/story/show/174398274)

* Refactor tuple return to Complete/NotComplete types

Co-authored-by: Brian Butz <bbutz@pivotal.io>

Author: blgm

app/actions/service_route_binding_create.rb

@@ -70,17 +70,24 @@ def poll(binding)
           record_audit_event(binding)
         end
 
-        binding.reload.terminal_state?
+        if binding.reload.terminal_state?
+          PollingComplete.new
+        else
+          PollingNotComplete.new(details[:retry_after])
+        end
       rescue => e
         binding.save_with_new_operation({}, {
           type: 'create',
           state: 'failed',
           description: e.message,
         })
 
-        true
+        return PollingComplete.new
       end
 
+      PollingComplete = Class.new.freeze
+      PollingNotComplete = Struct.new(:retry_after).freeze
+
       class UnprocessableCreate < StandardError; end
 
       class RouteBindingAlreadyExists < StandardError; end

app/jobs/v3/create_route_binding_job.rb

@@ -48,8 +48,15 @@ def perform
           return finish if precursor.reload.terminal_state?
         end
 
-        complete = action.poll(precursor)
-        finish if complete
+        polling_status = action.poll(precursor)
+        case polling_status
+        when ServiceRouteBindingCreate::PollingComplete
+          finish
+        when ServiceRouteBindingCreate::PollingNotComplete
+          unless polling_status.retry_after.nil?
+            self.polling_interval_seconds = polling_status.retry_after
+          end
+        end
       end
 
       private

spec/unit/actions/service_route_binding_create_spec.rb

@@ -335,7 +335,8 @@ class BadError < StandardError; end
           end
 
           it 'returns true' do
-            expect(action.poll(binding)).to be_truthy
+            polling_status = action.poll(binding)
+            expect(polling_status).to be_a_kind_of(ServiceRouteBindingCreate::PollingComplete)
           end
 
           it 'updates the last operation' do
@@ -407,7 +408,8 @@ class BadError < StandardError; end
 
         context 'response says in progress' do
           it 'returns false' do
-            expect(action.poll(binding)).to be_falsey
+            polling_status = action.poll(binding)
+            expect(polling_status).to be_a_kind_of(ServiceRouteBindingCreate::PollingNotComplete)
           end
 
           it 'updates the last operation' do
@@ -430,7 +432,8 @@ class BadError < StandardError; end
           let(:state) { 'failed' }
 
           it 'returns true' do
-            expect(action.poll(binding)).to be_truthy
+            polling_status = action.poll(binding)
+            expect(polling_status).to be_a_kind_of(ServiceRouteBindingCreate::PollingComplete)
           end
 
           it 'updates the last operation' do
@@ -448,6 +451,33 @@ class BadError < StandardError; end
             expect(event_repository).not_to have_received(:record_service_instance_event)
           end
         end
+
+        context 'retry interval' do
+          context 'no retry interval' do
+            it 'returns nil' do
+              polling_status = action.poll(binding)
+              expect(polling_status.retry_after).to be_nil
+            end
+          end
+
+          context 'retry interval specified' do
+            let(:fetch_last_operation_response) do
+              {
+                last_operation: {
+                  state: state,
+                  description: description,
+                },
+                retry_after: 10,
+              }
+            end
+
+            it 'returns the value when there was a retry header' do
+              polling_status = action.poll(binding)
+              expect(polling_status).to be_a_kind_of(ServiceRouteBindingCreate::PollingNotComplete)
+              expect(polling_status.retry_after).to eq(10)
+            end
+          end
+        end
       end
     end
   end

spec/unit/jobs/v3/create_route_binding_job_spec.rb

@@ -35,7 +35,7 @@ module V3
       end
 
       describe '#perform' do
-        let(:poll_response) { false }
+        let(:poll_response) { ServiceRouteBindingCreate::PollingNotComplete.new(nil) }
         let(:action) do
           instance_double(V3::ServiceRouteBindingCreate, {
             bind: nil,
@@ -116,7 +116,7 @@ module V3
           end
 
           context 'poll indicates binding complete' do
-            let(:poll_response) { true }
+            let(:poll_response) { ServiceRouteBindingCreate::PollingComplete.new }
 
             it 'finishes the job' do
               subject.perform
@@ -125,6 +125,21 @@ module V3
             end
           end
         end
+
+        context 'retry interval' do
+          def test_retry_after(value, expected)
+            allow(action).to receive(:poll).and_return(ServiceRouteBindingCreate::PollingNotComplete.new(value))
+            subject.perform
+            expect(subject.polling_interval_seconds).to eq(expected)
+          end
+
+          it 'updates the polling interval' do
+            test_retry_after(10, 60) # below default
+            test_retry_after(65, 65)
+            test_retry_after(1.hour, 1.hour)
+            test_retry_after(25.hours, 24.hours) # above limit
+          end
+        end
       end
 
       describe '#operation' do