[6.x] Fix Cache store with a name other than 'dynamodb' (#37145)

deleugpn · web-flow · commit 74a79b211712 · 2021-04-27T15:16:03.000-05:00
* Fix Cache store with a name other than 'dynamodb'

* StyleCI
diff --git a/src/Illuminate/Cache/CacheManager.php b/src/Illuminate/Cache/CacheManager.php
@@ -2,10 +2,12 @@
 
 namespace Illuminate\Cache;
 
+use Aws\DynamoDb\DynamoDbClient;
 use Closure;
 use Illuminate\Contracts\Cache\Factory as FactoryContract;
 use Illuminate\Contracts\Cache\Store;
 use Illuminate\Contracts\Events\Dispatcher as DispatcherContract;
+use Illuminate\Support\Arr;
 use InvalidArgumentException;
 
 /**
@@ -224,9 +226,11 @@ protected function createDatabaseDriver(array $config)
      */
     protected function createDynamodbDriver(array $config)
     {
+        $client = $this->newDynamodbClient($config);
+
         return $this->repository(
             new DynamoDbStore(
-                $this->app['cache.dynamodb.client'],
+                $client,
                 $config['table'],
                 $config['attributes']['key'] ?? 'key',
                 $config['attributes']['value'] ?? 'value',
@@ -236,6 +240,28 @@ protected function createDynamodbDriver(array $config)
         );
     }
 
+    /**
+     * Create new DynamoDb Client instance.
+     *
+     * @return DynamoDbClient
+     */
+    protected function newDynamodbClient(array $config)
+    {
+        $dynamoConfig = [
+            'region' => $config['region'],
+            'version' => 'latest',
+            'endpoint' => $config['endpoint'] ?? null,
+        ];
+
+        if (isset($config['key']) && isset($config['secret'])) {
+            $dynamoConfig['credentials'] = Arr::only(
+                $config, ['key', 'secret', 'token']
+            );
+        }
+
+        return new DynamoDbClient($dynamoConfig);
+    }
+
     /**
      * Create a new cache repository with the given implementation.
      *
diff --git a/src/Illuminate/Cache/CacheServiceProvider.php b/src/Illuminate/Cache/CacheServiceProvider.php
@@ -2,9 +2,7 @@
 
 namespace Illuminate\Cache;
 
-use Aws\DynamoDb\DynamoDbClient;
 use Illuminate\Contracts\Support\DeferrableProvider;
-use Illuminate\Support\Arr;
 use Illuminate\Support\ServiceProvider;
 use Symfony\Component\Cache\Adapter\Psr16Adapter;
 
@@ -32,24 +30,6 @@ public function register()
         $this->app->singleton('memcached.connector', function () {
             return new MemcachedConnector;
         });
-
-        $this->app->singleton('cache.dynamodb.client', function ($app) {
-            $config = $app['config']->get('cache.stores.dynamodb');
-
-            $dynamoConfig = [
-                'region' => $config['region'],
-                'version' => 'latest',
-                'endpoint' => $config['endpoint'] ?? null,
-            ];
-
-            if ($config['key'] && $config['secret']) {
-                $dynamoConfig['credentials'] = Arr::only(
-                    $config, ['key', 'secret', 'token']
-                );
-            }
-
-            return new DynamoDbClient($dynamoConfig);
-        });
     }
 
     /**
@@ -60,7 +40,7 @@ public function register()
     public function provides()
     {
         return [
-            'cache', 'cache.store', 'cache.psr6', 'memcached.connector', 'cache.dynamodb.client',
+            'cache', 'cache.store', 'cache.psr6', 'memcached.connector',
         ];
     }
 }
diff --git a/src/Illuminate/Cache/DynamoDbStore.php b/src/Illuminate/Cache/DynamoDbStore.php
@@ -525,4 +525,14 @@ public function setPrefix($prefix)
     {
         $this->prefix = ! empty($prefix) ? $prefix.':' : '';
     }
+
+    /**
+     * Get the DynamoDb Client instance.
+     *
+     * @return DynamoDbClient
+     */
+    public function getClient()
+    {
+        return $this->dynamo;
+    }
 }
diff --git a/tests/Integration/Cache/DynamoDbStoreTest.php b/tests/Integration/Cache/DynamoDbStoreTest.php
@@ -4,6 +4,7 @@
 
 use Aws\DynamoDb\DynamoDbClient;
 use Aws\Exception\AwsException;
+use Illuminate\Contracts\Cache\Repository;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Str;
 use Orchestra\Testbench\TestCase;
@@ -85,7 +86,7 @@ protected function getEnvironmentSetUp($app)
         $config = $app['config']->get('cache.stores.dynamodb');
 
         /** @var \Aws\DynamoDb\DynamoDbClient $client */
-        $client = $app['cache.dynamodb.client'];
+        $client = $app->make(Repository::class)->getStore()->getClient();
 
         if ($this->dynamoTableExists($client, $config['table'])) {
             return;

Original file line number	Diff line number	Diff line change
`@@ -525,4 +525,14 @@ public function setPrefix($prefix)`
`525`	`525`	`{`
`526`	`526`	`$this->prefix = ! empty($prefix) ? $prefix.':' : '';`
`527`	`527`	`}`
	`528`	`+`
	`529`	`+ /**`
	`530`	`+ * Get the DynamoDb Client instance.`
	`531`	`+ *`
	`532`	`+ * @return DynamoDbClient`
	`533`	`+ */`
	`534`	`+ public function getClient()`
	`535`	`+ {`
	`536`	`+ return $this->dynamo;`
	`537`	`+ }`
`528`	`538`	`}`