[DEVX-1656] Handle eVCS/STA exceptions from backend. (#2505)

* Back to dev 3.2.3.

* Handle ICR exceptions from ygg.

* Use 409 instead of 410.

* Rename and introduce sta exception.

* Handle workflow creation errors and use constants.

* Do not catch exceptions, let it fail.

* Remove unused imports.

* Also add sta handling for request.

* Fix linting.

* Update to match API.

* Fix typos.

Author: kporras07

src/Collections/Workflows.php

@@ -3,6 +3,7 @@
 namespace Pantheon\Terminus\Collections;
 
 use Pantheon\Terminus\Exceptions\TerminusException;
+use Pantheon\Terminus\Exceptions\TerminusUnsupportedSiteException;
 use Pantheon\Terminus\Models\Environment;
 use Pantheon\Terminus\Models\Organization;
 use Pantheon\Terminus\Models\Site;
@@ -11,6 +12,7 @@
 use Pantheon\Terminus\Models\Workflow;
 use Pantheon\Terminus\Session\SessionAwareInterface;
 use Pantheon\Terminus\Session\SessionAwareTrait;
+use Pantheon\Terminus\Request\Request;
 
 /**
  * Class Workflows
@@ -104,6 +106,18 @@ public function create($type, array $options = []): Workflow
             ]
         );
         if ($results->isError()) {
+            if ($results->getStatusCode() == 409) {
+                $decoded_body = json_decode($results->getData(), false);
+                if (!empty($decoded_body) && !empty($decoded_body->message)) {
+                    // This request is expected to fail for an unsupported site, throw exception.
+                    throw new TerminusUnsupportedSiteException($decoded_body->message);
+                } elseif (!empty($decoded_body) && !empty($decoded_body->reason)) {
+                    // This request is expected to fail, use generic reason.
+                    throw new TerminusUnsupportedSiteException(
+                        Request::UNSUPPORTED_SITE_EXCEPTION_MESSAGE
+                    );
+                }
+            }
             throw new TerminusException(
                 "Workflow Creation Failed: {error}",
                 ['error' => $results->getStatusCodeReason()]

src/Exceptions/TerminusUnsupportedSiteException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Pantheon\Terminus\Exceptions;
+
+/**
+ * Class TerminusUnsupportedSiteException
+ * @package Pantheon\Terminus\Exceptions
+ */
+class TerminusUnsupportedSiteException extends TerminusException
+{
+}

src/Request/Request.php

@@ -15,6 +15,7 @@
 use League\Container\ContainerAwareTrait;
 use Pantheon\Terminus\Config\ConfigAwareTrait;
 use Pantheon\Terminus\Exceptions\TerminusException;
+use Pantheon\Terminus\Exceptions\TerminusUnsupportedSiteException;
 use Pantheon\Terminus\Helpers\LocalMachineHelper;
 use Pantheon\Terminus\Helpers\Utility\TraceId;
 use Pantheon\Terminus\Session\SessionAwareInterface;
@@ -73,6 +74,8 @@ class Request implements
         'CI',
     ];
 
+    public const UNSUPPORTED_SITE_EXCEPTION_MESSAGE = 'This is not supported for this site.';
+
     protected ClientInterface $client;
 
     /**
@@ -229,7 +232,7 @@ private function createRetryDecider(): callable
                 );
             } else {
                 if (preg_match('/[2,4]0\d/', $response->getStatusCode())) {
-                    // Do not retry on 20x and 40x responses.
+                    // Do not retry on 20x or 40x responses.
                     return false;
                 }
 
@@ -441,6 +444,18 @@ public function request($path, array $options = []): RequestOperationResult
             }
         }
 
+        if ($response->getStatusCode() == 409) {
+            if (!empty($decoded_body) && !empty($decoded_body->message)) {
+                // This request is expected to fail for an unsupported site, throw exception.
+                throw new TerminusUnsupportedSiteException($decoded_body->message);
+            } elseif (!empty($decoded_body) && !empty($decoded_body->reason)) {
+                // This request is expected to fail, use generic reason.
+                throw new TerminusUnsupportedSiteException(
+                    self::UNSUPPORTED_SITE_EXCEPTION_MESSAGE
+                );
+            }
+        }
+
         return new RequestOperationResult([
             'data' => $decoded_body ?? $body,
             'headers' => $headers,