Guillermoandrae\Db\DynamoDb\DynamoDbAdapter

Complexity

Total Complexity

33

Size/Duplication

Total Lines	263
Duplicated Lines	0 %

Test Coverage

Coverage

90.29%

Importance

Changes	7
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	findAll()	0	13	3
A	findWhere()	0	13	3
A	tableExists()	0	9	2
A	listTables()	0	5	1
A	describeTable()	0	11	3
A	useTable()	0	4	1
A	setClient()	0	4	1
A	findLatest()	0	10	2
A	__construct()	0	13	1
A	deleteTable()	0	12	3
A	insert()	0	8	2
A	findById()	0	3	1
A	createTable()	0	14	4
A	findByPrimaryKey()	0	12	3
A	delete()	0	8	2
A	getClient()	0	3	1

<?php

namespace Guillermoandrae\Db\DynamoDb;

use Aws\DynamoDb\DynamoDbClient;
use Aws\DynamoDb\Exception\DynamoDbException;
use Guillermoandrae\Common\Collection;
use Guillermoandrae\Common\CollectionInterface;
use Guillermoandrae\Db\AdapterInterface;
use Guillermoandrae\Db\DbException;
use InvalidArgumentException;

final class DynamoDbAdapter implements AdapterInterface
{
    /**
     * @var DynamoDbClient The DynamoDb client.
     */
    private $client;

    /**
     * @var MarshalerFactory The JSON Marshaler.
     */
    private $marshaler;

    /**
     * @var string The table name.
     */
    private $tableName;

    /**
     * DynamoDBAdapter constructor.
     *
     * Registers AWS' DynamoDB client and marshaler with this object. If no options are provided, we pass the options
     * needed to connect to a local instance. This constructor also Passes the marshaler over to the request factory.
     *
     * @param array $options OPTIONAL The DynamoDb client options.
     */
    public function __construct(array $options = [
        'region' => 'us-west-2',
        'version'  => 'latest',
        'endpoint' => 'http://localhost:8000',
        'credentials' => [
            'key' => 'not-a-real-key',
            'secret' => 'not-a-real-secret',
        ]
    ])
    {
        $this->setClient(DynamoDbClient::factory($options));

The function Aws\AwsClient::factory() has been deprecated.

        $this->marshaler = MarshalerFactory::factory();

It seems like Guillermoandrae\Db\DynamoDb\MarshalerFactory::factory() of type Aws\DynamoDb\Marshaler is incompatible with the declared type Guillermoandrae\Db\DynamoDb\MarshalerFactory of property $marshaler.

        RequestFactory::setMarshaler($this->marshaler);
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#createtable
     */
    public function createTable(array $data, string $tableName = ''): bool
    {
        try {
            if (empty($tableName)) {
                $tableName = $this->tableName;
            }
            $query = RequestFactory::factory('create-table', $tableName, $data)->get();
            $this->client->createTable($query);
            $this->client->waitUntil('TableExists', ['TableName' => $tableName]);
            return true;
        } catch (DynamoDbException $ex) {
            throw new DbException($ex->getMessage());
        } catch (InvalidArgumentException $ex) {
            throw new DbException('Bad key schema: ' . $ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#deletetable
     */
    public function deleteTable(string $tableName = ''): bool
    {
        try {
            if (empty($tableName)) {
                $tableName = $this->tableName;
            }
            $query = RequestFactory::factory('delete-table', $tableName)->get();
            $this->client->deleteTable($query);
            $this->client->waitUntil('TableNotExists', ['TableName' => $tableName]);
            return true;
        } catch (DynamoDbException $ex) {
            throw new DbException($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#describetable
     */
    public function describeTable(string $tableName = ''): array
    {
        try {
            if (empty($tableName)) {
                $tableName = $this->tableName;
            }
            $query = RequestFactory::factory('describe-table', $tableName)->get();
            $result = $this->client->describeTable($query);
            return $result['Table'];

The expression return $result['Table'] could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

        } catch (DynamoDbException $ex) {
            throw new DbException($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#listtables
     */
    public function tableExists(string $tableName = ''): bool
    {
        if (empty($tableName)) {
            $tableName = $this->tableName;
        }
        $tables = $this->listTables();
        return in_array(
            strtolower($tableName),
            array_map('strtolower', $tables)
        );
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#listtables
     */
    public function listTables(): array
    {
        $query = RequestFactory::factory('list-tables')->get();
        $results = $this->client->listTables($query);
        return $results['TableNames'];

The expression return $results['TableNames'] could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritDoc}
     */
    public function useTable(string $tableName): AdapterInterface
    {
        $this->tableName = $tableName;
        return $this;
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#query
     */
    public function findWhere(array $conditions, int $offset = 0, ?int $limit = null): CollectionInterface
    {
        try {
            $query = RequestFactory::factory('query', $this->tableName, $conditions)->get();
            $results = $this->client->query($query);
            $rows = [];
            foreach ($results['Items'] as $item) {
                $rows[] = $this->marshaler->unmarshalItem($item);

The method unmarshalItem() does not exist on Guillermoandrae\Db\DynamoDb\MarshalerFactory.

            }
            $collection = Collection::make($rows);
            return $collection->limit($offset, $limit);
        } catch (DynamoDbException $ex) {
            throw new DbException($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#scan
     */
    public function findAll(int $offset = 0, ?int $limit = null): CollectionInterface
    {
        try {
            $query = RequestFactory::factory('scan', $this->tableName)->get();
            $results = $this->client->scan($query);
            $rows = [];
            foreach ($results['Items'] as $item) {
                $rows[] = $this->marshaler->unmarshalItem($item);
            }
            $collection = Collection::make($rows);
            return $collection->limit($offset, $limit);
        } catch (DynamoDbException $ex) {
            throw new DbException($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#scan
     */
    public function findLatest(): array
    {
        try {
            $query = RequestFactory::factory('scan', $this->tableName)
                ->setLimit(1)

The method setLimit() does not exist on Guillermoandrae\Db\DynamoDb\RequestInterface. It seems like you code against a sub-type of Guillermoandrae\Db\DynamoDb\RequestInterface such as Guillermoandrae\Db\DynamoDb\ListTablesRequest or Guillermoandrae\Db\DynamoDb\AbstractFilterExpressionAwareRequest.

                ->get();
            $results = $this->client->scan($query);
            return $this->marshaler->unmarshalItem($results['Items'][0]);
        } catch (DynamoDbException $ex) {
            throw new DbException($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     */
    public function findById($id): array
    {
        return $this->findByPrimaryKey($id);
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#getitem
     */
    public function findByPrimaryKey($primaryKey): array
    {
        try {
            $query = RequestFactory::factory('get-item', $this->tableName, $primaryKey)->get();
            $results = $this->client->getItem($query);
            $item = [];
            if (is_array($results['Item'])) {
                $item = $this->marshaler->unmarshalItem($results['Item']);
            }
            return $item;
        } catch (DynamoDbException $ex) {
            throw new DbException($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#putitem
     */
    public function insert(array $data): bool
    {
        try {
            $query = RequestFactory::factory('put-item', $this->tableName, $data)->get();
            $this->client->putItem($query);
            return true;
        } catch (DynamoDbException $ex) {
            throw new DbException($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#deleteitem
     */
    public function delete($id): bool
    {
        try {
            $query = RequestFactory::factory('delete-item', $this->tableName, $id)->get();
            $this->client->deleteItem($query);
            return true;
        } catch (DynamoDbException $ex) {
            throw new DbException($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     */
    public function setClient($client): AdapterInterface
    {
        $this->client = $client;
        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function getClient(): DynamoDbClient
    {
        return $this->client;
    }
}