CLI-1292: Catch Cloud API type errors (#1701)

* CLI-1292: Catch Cloud API type errors * fix message and add tests
acquia · Mar 20, 2024 · 82e821a · 82e821a
1 parent ec62a12
commit 82e821a
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/.phpstorm.meta.php b/.phpstorm.meta.php
@@ -4,6 +4,8 @@
   use AcquiaCloudApi\Response\AccountResponse;
   use AcquiaCloudApi\Response\ApplicationResponse;
   use AcquiaCloudApi\Response\ApplicationsResponse;
+  use AcquiaCloudApi\Response\CronResponse;
+  use AcquiaCloudApi\Response\CronsResponse;
   use AcquiaCloudApi\Response\DatabasesResponse;
   use AcquiaCloudApi\Response\EnvironmentResponse;
   use AcquiaCloudApi\Response\EnvironmentsResponse;
@@ -14,7 +16,9 @@
     'getApplicationByUuid' => ApplicationResponse::class,
     'getApplicationEnvironments' => EnvironmentsResponse::class,
     'getEnvironmentsDatabases' => DatabasesResponse::class,
-    'getEnvironment' => EnvironmentResponse::class
+    'getEnvironment' => EnvironmentResponse::class,
+    'getCron' => CronResponse::class,
+    'getCronJobsByEnvironmentId' => CronsResponse::class
   ]));
 
 }
diff --git a/src/EventListener/ExceptionListener.php b/src/EventListener/ExceptionListener.php
@@ -79,6 +79,10 @@ public function onConsoleError(ConsoleErrorEvent $event): void {
       }
     }
 
+    if ($error instanceof \TypeError && str_contains($error->getMessage(), 'AcquiaCloudApi\Response')) {
+      $newErrorMessage = 'Cloud Platform API returned an unexpected data type. This is not an issue with Acquia CLI but could indicate a problem with your Cloud Platform application.';
+    }
+
     $this->helpMessages[] = "You can find Acquia CLI documentation at https://docs.acquia.com/acquia-cli/";
     $this->writeUpdateHelp($event);
     $this->writeSupportTicketHelp($event);

diff --git a/tests/phpunit/src/Application/ExceptionApplicationTest.php b/tests/phpunit/src/Application/ExceptionApplicationTest.php
@@ -93,4 +93,21 @@ public function testInvalidApplicationUuid(): void {
     self::assertStringContainsString('An alias consists of an application name', $buffer);
   }
 
+  /**
+   * @group serial
+   */
+  public function testApiTypeError(): void {
+    $tamper = function ($response): void {
+      $response[0]->server = [];
+    };
+    $this->mockRequest('getCronJobsByEnvironmentId', '24-a47ac10b-58cc-4372-a567-0e02b2c3d470', NULL, NULL, $tamper);
+    $this->setInput([
+      'command' => 'env:cron-copy',
+      'dest_env' => '24-a47ac10b-58cc-4372-a567-0e02b2c3d471',
+      'source_env' => '24-a47ac10b-58cc-4372-a567-0e02b2c3d470',
+    ]);
+    $buffer = $this->runApp();
+    self::assertStringContainsString('Cloud Platform API returned an unexpected data type.', $buffer);
+  }
+
 }