Make error classes' props private and expose public methods

andrii-balitskyi · andrii-balitskyi · commit 2999c93add20 · 2025-01-03T20:31:20.000+01:00
diff --git a/src/Exceptions/SeamActionAttemptError.php b/src/Exceptions/SeamActionAttemptError.php
@@ -6,12 +6,17 @@
 
 class SeamActionAttemptError extends \Exception
 {
-  public ActionAttempt $actionAttempt;
+  private ActionAttempt $actionAttempt;
 
   public function __construct(string $message, ActionAttempt $actionAttempt)
   {
     parent::__construct($message);
     $this->name = get_class($this);
     $this->actionAttempt = $actionAttempt;
   }
+
+  public function getActionAttempt(): ActionAttempt 
+  {
+    return $this->actionAttempt;
+  }
 }
diff --git a/src/Exceptions/SeamActionAttemptFailedError.php b/src/Exceptions/SeamActionAttemptFailedError.php
@@ -6,12 +6,17 @@
 
 class SeamActionAttemptFailedError extends SeamActionAttemptError
 {
-  public string $errorCode;
+  private string $errorCode;
 
   public function __construct(ActionAttempt $actionAttempt)
   {
     parent::__construct($actionAttempt->error->message, $actionAttempt);
     $this->name = get_class($this);
     $this->errorCode = $actionAttempt->error->type;
   }
+
+  public function getErrorCode(): string
+  {
+    return $this->errorCode;
+  }
 }
diff --git a/src/Exceptions/SeamHttpApiError.php b/src/Exceptions/SeamHttpApiError.php
@@ -4,10 +4,10 @@
 
 class SeamHttpApiError extends \Exception
 {
-  public string $errorCode;
-  public int $statusCode;
-  public string $requestId;
-  public ?object $data;
+  private string $errorCode;
+  private int $statusCode;
+  private string $requestId;
+  private ?object $data = null;
 
   public function __construct(object $error, int $statusCode, string $requestId)
   {
diff --git a/tests/AccessCodesTest.php b/tests/AccessCodesTest.php
@@ -4,9 +4,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Tests\Fixture;
-use GuzzleHttp\Client;
-use GuzzleHttp\Exception\ClientErrorResponseException as ClientErrorResponseException;
-use GuzzleHttp\Promise\Is;
 
 final class AccessCodesTest extends TestCase
 {
@@ -62,7 +59,7 @@ public function testAccessCodes(): void
             $seam->access_codes->get(access_code_id: $access_code_id);
 
             $this->fail("Expected the code to be deleted");
-        } catch (Exception $exception) {
+        } catch (\Seam\SeamHttpApiError $exception) {
             $this->assertTrue(
                 str_contains($exception->getMessage(), "Access Code Not Found")
             );
diff --git a/tests/ActionAttemptsTest.php b/tests/ActionAttemptsTest.php
@@ -51,7 +51,7 @@ public function testFailedActionAttempt(): void
                 "status" => "error",
                 "error" => [
                     "message" => "Failed",
-                    "type" => "foo"
+                    "type" => "failed_attempt"
                 ]
             ]
         );
@@ -60,9 +60,9 @@ public function testFailedActionAttempt(): void
             $seam->action_attempts->poll_until_ready($action_attempt->action_attempt_id);
             $this->fail("Expected SeamActionAttemptFailedError");
         } catch (\Seam\SeamActionAttemptFailedError $e) {
-            $this->assertEquals($action_attempt->action_attempt_id, $e->actionAttempt->action_attempt_id);
-            $this->assertEquals("error", $e->actionAttempt->status);
-            $this->assertEquals("foo", $e->errorCode);
+            $this->assertEquals($action_attempt->action_attempt_id, $e->getActionAttempt()->action_attempt_id);
+            $this->assertEquals("error", $e->getActionAttempt()->status);
+            $this->assertEquals("failed_attempt", $e->getErrorCode());
             $this->assertEquals("Failed", $e->getMessage());
         }
     }
@@ -92,8 +92,8 @@ public function testTimeoutActionAttempt(): void
             $seam->action_attempts->poll_until_ready($action_attempt->action_attempt_id, 0.1);
             $this->fail("Expected TimeoutError");
         } catch (\Seam\SeamActionAttemptTimeoutError $e) {
-            $this->assertEquals($action_attempt->action_attempt_id, $e->actionAttempt->action_attempt_id);
-            $this->assertEquals("pending", $e->actionAttempt->status);
+            $this->assertEquals($action_attempt->action_attempt_id, $e->getActionAttempt()->action_attempt_id);
+            $this->assertEquals("pending", $e->getActionAttempt()->status);
             $this->assertEquals("Timed out waiting for action attempt after 0.1s", $e->getMessage());
         }
     }
diff --git a/tests/ClientSessionsTest.php b/tests/ClientSessionsTest.php
@@ -4,7 +4,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Tests\Fixture;
-use GuzzleHttp\Client;
 
 final class ClientSessionsTest extends TestCase
 {
diff --git a/tests/ConnectWebviewsTest.php b/tests/ConnectWebviewsTest.php
@@ -4,7 +4,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Tests\Fixture;
-use GuzzleHttp\Client;
 
 final class ConnectWebviewsTest extends TestCase
 {
diff --git a/tests/ConnectedAccountsTest.php b/tests/ConnectedAccountsTest.php
@@ -48,7 +48,7 @@ public function testDeleteConnectedAccount(): void
         } catch (\Seam\SeamHttpApiError $exception) {
             $this->assertTrue(
                 str_contains(
-                    $exception->errorCode,
+                    $exception->getErrorCode(),
                     "connected_account_not_found"
                 )
             );
diff --git a/tests/DevicesTest.php b/tests/DevicesTest.php
@@ -4,7 +4,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Tests\Fixture;
-use GuzzleHttp\Client;
 
 final class DevicesTest extends TestCase
 {
@@ -47,9 +46,9 @@ public function testGetAndListDevices(): void
             $seam->devices->get(device_id: $device_id);
 
             $this->fail("Expected the device to be deleted");
-        } catch (Exception $exception) {
+        } catch (\Seam\SeamHttpApiError $exception) {
             $this->assertTrue(
-                str_contains($exception->errorCode, "device_not_found")
+                str_contains($exception->getErrorCode(), "device_not_found")
             );
         }
 
diff --git a/tests/EventsTest.php b/tests/EventsTest.php
@@ -4,7 +4,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Tests\Fixture;
-use GuzzleHttp\Client;
 
 final class EventsTest extends TestCase
 {
@@ -38,7 +37,7 @@ public function testListEventsError(): void
         $seam = Fixture::getTestServer();
         try {
             $seam->events->list(since: "invalid_date");
-        } catch (Exception $e) {
+        } catch (\Seam\SeamHttpInvalidInputError $e) {
             $this->assertTrue(
                 str_contains($e->getMessage(), "Must be parsable date string")
             );
diff --git a/tests/HttpErrorTest.php b/tests/HttpErrorTest.php
@@ -21,9 +21,9 @@ public function testInvalidInputError(): void
     );
       $this->fail("Expected InvalidInputError");
     } catch (\Seam\SeamHttpInvalidInputError $e) {
-      $this->assertEquals(400, $e->statusCode);
-      $this->assertNotEmpty($e->requestId);
-      $this->assertEquals('invalid_input', $e->errorCode);
+      $this->assertEquals(400, $e->getStatusCode());
+      $this->assertNotEmpty($e->getRequestId());
+      $this->assertEquals('invalid_input', $e->getErrorCode());
       $this->assertEquals(
         ['Expected array, received number'],
         $e->getValidationErrorMessages('device_ids')
@@ -43,7 +43,7 @@ public function testUnauthorizedError(): void
       $seam->devices->list();
       $this->fail("Expected UnauthorizedError");
     } catch (\Seam\SeamHttpUnauthorizedError $e) {
-      $this->assertNotEmpty($e->requestId);
+      $this->assertNotEmpty($e->getRequestId());
     }
   }
 
@@ -55,9 +55,9 @@ public function testApiError(): void
       $seam->devices->get(device_id: "nonexistent_device_id");
       $this->fail("Expected ApiError");
     } catch (\Seam\SeamHttpApiError $e) {
-      $this->assertEquals(404, $e->statusCode);
-      $this->assertNotEmpty($e->requestId);
-      $this->assertEquals('device_not_found', $e->errorCode);
+      $this->assertEquals(404, $e->getStatusCode());
+      $this->assertNotEmpty($e->getRequestId());
+      $this->assertEquals('device_not_found', $e->getErrorCode());
     }
   }
 
diff --git a/tests/LocksTest.php b/tests/LocksTest.php
@@ -4,7 +4,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Tests\Fixture;
-use GuzzleHttp\Client;
 
 final class LocksTest extends TestCase
 {
diff --git a/tests/WorkspacesTest.php b/tests/WorkspacesTest.php
@@ -4,7 +4,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Tests\Fixture;
-use GuzzleHttp\Client;
 
 final class WorkspacesTest extends TestCase
 {

Original file line number	Diff line number	Diff line change
`@@ -6,12 +6,17 @@`
`6`	`6`
`7`	`7`	`class SeamActionAttemptError extends \Exception`
`8`	`8`	`{`
`9`		`- public ActionAttempt $actionAttempt;`
	`9`	`+ private ActionAttempt $actionAttempt;`
`10`	`10`
`11`	`11`	`public function __construct(string $message, ActionAttempt $actionAttempt)`
`12`	`12`	`{`
`13`	`13`	`parent::__construct($message);`
`14`	`14`	`$this->name = get_class($this);`
`15`	`15`	`$this->actionAttempt = $actionAttempt;`
`16`	`16`	`}`
	`17`	`+`
	`18`	`+ public function getActionAttempt(): ActionAttempt`
	`19`	`+ {`
	`20`	`+ return $this->actionAttempt;`
	`21`	`+ }`
`17`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,12 +6,17 @@`
`6`	`6`
`7`	`7`	`class SeamActionAttemptFailedError extends SeamActionAttemptError`
`8`	`8`	`{`
`9`		`- public string $errorCode;`
	`9`	`+ private string $errorCode;`
`10`	`10`
`11`	`11`	`public function __construct(ActionAttempt $actionAttempt)`
`12`	`12`	`{`
`13`	`13`	`parent::__construct($actionAttempt->error->message, $actionAttempt);`
`14`	`14`	`$this->name = get_class($this);`
`15`	`15`	`$this->errorCode = $actionAttempt->error->type;`
`16`	`16`	`}`
	`17`	`+`
	`18`	`+ public function getErrorCode(): string`
	`19`	`+ {`
	`20`	`+ return $this->errorCode;`
	`21`	`+ }`
`17`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,10 @@`
`4`	`4`
`5`	`5`	`class SeamHttpApiError extends \Exception`
`6`	`6`	`{`
`7`		`- public string $errorCode;`
`8`		`- public int $statusCode;`
`9`		`- public string $requestId;`
`10`		`- public ?object $data;`
	`7`	`+ private string $errorCode;`
	`8`	`+ private int $statusCode;`
	`9`	`+ private string $requestId;`
	`10`	`+ private ?object $data = null;`
`11`	`11`
`12`	`12`	`public function __construct(object $error, int $statusCode, string $requestId)`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public function testFailedActionAttempt(): void`
`51`	`51`	`"status" => "error",`
`52`	`52`	`"error" => [`
`53`	`53`	`"message" => "Failed",`
`54`		`- "type" => "foo"`
	`54`	`+ "type" => "failed_attempt"`
`55`	`55`	`]`
`56`	`56`	`]`
`57`	`57`	`);`
`@@ -60,9 +60,9 @@ public function testFailedActionAttempt(): void`
`60`	`60`	`$seam->action_attempts->poll_until_ready($action_attempt->action_attempt_id);`
`61`	`61`	`$this->fail("Expected SeamActionAttemptFailedError");`
`62`	`62`	`} catch (\Seam\SeamActionAttemptFailedError $e) {`
`63`		`- $this->assertEquals($action_attempt->action_attempt_id, $e->actionAttempt->action_attempt_id);`
`64`		`- $this->assertEquals("error", $e->actionAttempt->status);`
`65`		`- $this->assertEquals("foo", $e->errorCode);`
	`63`	`+ $this->assertEquals($action_attempt->action_attempt_id, $e->getActionAttempt()->action_attempt_id);`
	`64`	`+ $this->assertEquals("error", $e->getActionAttempt()->status);`
	`65`	`+ $this->assertEquals("failed_attempt", $e->getErrorCode());`
`66`	`66`	`$this->assertEquals("Failed", $e->getMessage());`
`67`	`67`	`}`
`68`	`68`	`}`
`@@ -92,8 +92,8 @@ public function testTimeoutActionAttempt(): void`
`92`	`92`	`$seam->action_attempts->poll_until_ready($action_attempt->action_attempt_id, 0.1);`
`93`	`93`	`$this->fail("Expected TimeoutError");`
`94`	`94`	`} catch (\Seam\SeamActionAttemptTimeoutError $e) {`
`95`		`- $this->assertEquals($action_attempt->action_attempt_id, $e->actionAttempt->action_attempt_id);`
`96`		`- $this->assertEquals("pending", $e->actionAttempt->status);`
	`95`	`+ $this->assertEquals($action_attempt->action_attempt_id, $e->getActionAttempt()->action_attempt_id);`
	`96`	`+ $this->assertEquals("pending", $e->getActionAttempt()->status);`
`97`	`97`	`$this->assertEquals("Timed out waiting for action attempt after 0.1s", $e->getMessage());`
`98`	`98`	`}`
`99`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`
`5`	`5`	`use PHPUnit\Framework\TestCase;`
`6`	`6`	`use Tests\Fixture;`
`7`		`-use GuzzleHttp\Client;`
`8`	`7`
`9`	`8`	`final class ClientSessionsTest extends TestCase`
`10`	`9`	`{`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public function testDeleteConnectedAccount(): void`
`48`	`48`	`} catch (\Seam\SeamHttpApiError $exception) {`
`49`	`49`	`$this->assertTrue(`
`50`	`50`	`str_contains(`
`51`		`- $exception->errorCode,`
	`51`	`+ $exception->getErrorCode(),`
`52`	`52`	`"connected_account_not_found"`
`53`	`53`	`)`
`54`	`54`	`);`