[spaceship] also catch and handle "Gateway Timeout" (fastlane#13255)

tmm1 · Josh Holtz · commit 9d370e77f35c · 2018-09-03T14:51:21.000-05:00
* [spaceship] catch more internal server errors

* Added new GatewayTimeoutError and tests for catching common errors
diff --git a/spaceship/lib/spaceship/client.rb b/spaceship/lib/spaceship/client.rb
@@ -50,6 +50,7 @@ class Client
     UnexpectedResponse = Spaceship::UnexpectedResponse
     AppleTimeoutError = Spaceship::AppleTimeoutError
     UnauthorizedAccessError = Spaceship::UnauthorizedAccessError
+    GatewayTimeoutError = Spaceship::GatewayTimeoutError
     InternalServerError = Spaceship::InternalServerError
 
     # Authenticates with Apple's web services. This method has to be called once
@@ -532,6 +533,7 @@ def with_retry(tries = 5, &_block)
         Faraday::Error::TimeoutError,
         Faraday::ParsingError, # <h2>Internal Server Error</h2> with content type json
         AppleTimeoutError,
+        GatewayTimeoutError,
         InternalServerError => ex # New Faraday version: Faraday::TimeoutError => ex
       tries -= 1
       unless tries.zero?
@@ -628,6 +630,8 @@ def detect_most_common_errors_and_raise_exceptions(body)
         raise_insuffient_permission_error!(caller_location: 3)
       elsif body.to_s.include?("Internal Server Error - Read")
         raise InternalServerError, "Received an internal server error from App Store Connect / Developer Portal, please try again later"
+      elsif body.to_s.include?("Gateway Timeout - In read")
+        raise GatewayTimeoutError, "Received a gateway timeout error from App Store Connect / Developer Portal, please try again later"
       elsif (body["resultString"] || "").include?("Program License Agreement")
         raise ProgramLicenseAgreementUpdated, "#{body['userString']} Please manually log into your Apple Developer account to review and accept the updated agreement."
       end
diff --git a/spaceship/lib/spaceship/errors.rb b/spaceship/lib/spaceship/errors.rb
@@ -70,4 +70,7 @@ class UnauthorizedAccessError < BasicPreferredInfoError; end
 
   # Raised when 500 is received from App Store Connect
   class InternalServerError < BasicPreferredInfoError; end
+
+  # Raised when 504 is received from App Store Connect
+  class GatewayTimeoutError < BasicPreferredInfoError; end
 end
diff --git a/spaceship/spec/client_spec.rb b/spaceship/spec/client_spec.rb
@@ -39,11 +39,57 @@ def stub_client_retry_auth(status_error, times, status_ok, body)
       then.to_return(status: status_ok, body: body)
   end
 
+  describe 'detect_most_common_errors_and_raise_exceptions' do
+    it "raises Spaceship::InsufficientPermissions for Forbidden" do
+      body = JSON.generate({ messages: { error: "InsufficentPermissions" } })
+      stub_client_request(Spaceship::InsufficientPermissions, 6, 200, body)
+
+      expect do
+        subject.req_home
+      end.to raise_error(Spaceship::InsufficientPermissions)
+    end
+
+    it "raises Spaceship::InsufficientPermissions for insufficient privileges" do
+      body = JSON.generate({ messages: { error: "insufficient privileges" } })
+      stub_client_request(Spaceship::InsufficientPermissions, 6, 200, body)
+
+      expect do
+        subject.req_home
+      end.to raise_error(Spaceship::InsufficientPermissions)
+    end
+
+    it "raises Spaceship::InternalServerError" do
+      stub_client_request(Spaceship::GatewayTimeoutError, 6, 504, "<html>Internal Server - Read</html>")
+
+      expect do
+        subject.req_home
+      end.to raise_error(Spaceship::GatewayTimeoutError)
+    end
+
+    it "raises Spaceship::GatewayTimeoutError" do
+      stub_client_request(Spaceship::GatewayTimeoutError, 6, 504, "<html>Gateway Timeout - In Read</html>")
+
+      expect do
+        subject.req_home
+      end.to raise_error(Spaceship::GatewayTimeoutError)
+    end
+
+    it "raises Spaceship::ProgramLicenseAgreementUpdated" do
+      stub_client_request(Spaceship::ProgramLicenseAgreementUpdated, 6, 200, "Program License Agreement")
+
+      expect do
+        subject.req_home
+      end.to raise_error(Spaceship::ProgramLicenseAgreementUpdated)
+    end
+  end
+
   describe 'retry' do
     [
       Faraday::Error::TimeoutError,
       Faraday::Error::ConnectionFailed,
-      Faraday::ParsingError
+      Faraday::ParsingError,
+      Spaceship::InternalServerError,
+      Spaceship::GatewayTimeoutError
     ].each do |thrown|
       it "re-raises when retry limit reached throwing #{thrown}" do
         stub_client_request(thrown, 6, 200, nil)
