Add Waiters on S3 and DynamoDB (#332)

Author: jderusse

src/DynamoDbClient.php

@@ -23,6 +23,7 @@
 use AsyncAws\DynamoDb\Result\PutItemOutput;
 use AsyncAws\DynamoDb\Result\QueryOutput;
 use AsyncAws\DynamoDb\Result\ScanOutput;
+use AsyncAws\DynamoDb\Result\TableExistsWaiter;
 use AsyncAws\DynamoDb\Result\UpdateItemOutput;
 use AsyncAws\DynamoDb\Result\UpdateTableOutput;
 
@@ -255,6 +256,23 @@ public function scan($input): ScanOutput
         return new ScanOutput($response, $this, $input);
     }
 
+    /**
+     * Check status of operation describeTable.
+     *
+     * @see describeTable
+     *
+     * @param array{
+     *   TableName: string,
+     * }|DescribeTableInput $input
+     */
+    public function tableExists($input): TableExistsWaiter
+    {
+        $input = DescribeTableInput::create($input);
+        $response = $this->getResponse($input->request());
+
+        return new TableExistsWaiter($response, $this, $input);
+    }
+
     /**
      * Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put,
      * delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new

src/Result/TableExistsWaiter.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace AsyncAws\DynamoDb\Result;
+
+use AsyncAws\Core\Exception\Http\HttpException;
+use AsyncAws\Core\Response;
+use AsyncAws\Core\Waiter;
+use AsyncAws\DynamoDb\DynamoDbClient;
+use AsyncAws\DynamoDb\Input\DescribeTableInput;
+
+class TableExistsWaiter extends Waiter
+{
+    protected const WAIT_TIMEOUT = 500.0;
+    protected const WAIT_DELAY = 20.0;
+
+    protected function extractState(Response $response, ?HttpException $exception): string
+    {
+        if (200 === $response->getStatusCode() && 'ACTIVE' === ($response->toArray()['Table']['TableStatus'] ?? null)) {
+            return self::STATE_SUCCESS;
+        }
+
+        if (null !== $exception) {
+            return self::STATE_PENDING;
+        }
+
+        /** @psalm-suppress TypeDoesNotContainType */
+        return null === $exception ? self::STATE_PENDING : self::STATE_FAILURE;
+    }
+
+    protected function refreshState(): Waiter
+    {
+        if (!$this->awsClient instanceof DynamoDbClient) {
+            throw new \InvalidArgumentException('missing client injected in waiter result');
+        }
+        if (!$this->input instanceof DescribeTableInput) {
+            throw new \InvalidArgumentException('missing last request injected in waiter result');
+        }
+
+        return $this->awsClient->TableExists($this->input);
+    }
+}

tests/Integration/DynamoDbClientTest.php

@@ -277,6 +277,18 @@ public function testUpdateTable(): void
         self::assertEquals(8, $result->getTableDescription()->getProvisionedThroughput()->getWriteCapacityUnits());
     }
 
+    public function testTableExists(): void
+    {
+        $client = $this->getClient();
+
+        $input = new DescribeTableInput([
+            'TableName' => $this->tableName,
+        ]);
+
+        self::assertTrue($client->tableExists($input)->isSuccess());
+        self::assertFalse($client->tableExists(['TableName' => 'does-not-exists'])->isSuccess());
+    }
+
     private function getClient(): DynamoDbClient
     {
         if ($this->client instanceof DynamoDbClient) {