Add support for caching Firebase authentication tokens

kreait · Dec 4, 2021 · fdbcb97 · fdbcb97
1 parent 52b29c7
commit fdbcb97
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,8 @@
 # CHANGELOG
 
 ## [Unreleased]
+### Added
+* Added support for caching the authentication tokens used for connecting to the Firebase servers.
 
 ## [3.0.0] - 2021-11-30
 ### Changed

diff --git a/README.md b/README.md
@@ -112,9 +112,10 @@ kreait_firebase:
             tenant_id: 'tenant-id'
             # Optional: Default domain for Dynamic Links
             default_dynamic_links_domain: 'https://my_project.page.link'
-            # Optional: Used to cache Google's public keys. Must implement
-            # \Psr\SimpleCache\CacheInterface (PSR-16)
+            # Optional: Used to cache Google's public keys.
             verifier_cache: null # Example: cache.app
+            # Optional: Used to cache the authentication tokens for connecting to the Firebase servers.
+            auth_token_cache: null # Example: cache.app
             # If set, logs simple HTTP request and response statuses
             http_request_logger:  null # Example: monolog.logger.firebase
             # If set, logs detailed HTTP request and response statuses

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -60,6 +60,11 @@ public function getConfigTreeBuilder(): TreeBuilder
                                 ->example('cache.app')
                                 ->info('Used to cache Google\'s public keys.')
                             ->end()
+                            ->scalarNode('auth_token_cache')
+                                ->defaultNull()
+                                ->example('cache.app')
+                                ->info('Used to cache the authentication tokens for connecting to the Firebase servers.')
+                            ->end()
                             ->scalarNode('http_request_logger')
                                 ->defaultNull()
                                 ->example('monolog.logger.firebase')

diff --git a/src/DependencyInjection/Factory/ProjectFactory.php b/src/DependencyInjection/Factory/ProjectFactory.php
@@ -9,12 +9,14 @@
 use Psr\Cache\CacheItemPoolInterface;
 use Psr\Log\LoggerInterface;
 use Psr\SimpleCache\CacheInterface;
+use Symfony\Component\Cache\Adapter\Psr16Adapter;
 use Symfony\Component\Cache\Psr16Cache;
 
 class ProjectFactory
 {
     private Factory $firebaseFactory;
     private ?CacheInterface $verifierCache = null;
+    private ?CacheItemPoolInterface $authTokenCache = null;
     private ?LoggerInterface $httpRequestLogger = null;
     private ?LoggerInterface $httpRequestDebugLogger = null;
 
@@ -35,6 +37,18 @@ public function setVerifierCache($verifierCache = null): void
         $this->verifierCache = $verifierCache;
     }
 
+    /**
+     * @param CacheInterface|CacheItemPoolInterface|null $authTokenCache
+     */
+    public function setAuthTokenCache($authTokenCache = null): void
+    {
+        if ($authTokenCache instanceof CacheInterface) {
+            $authTokenCache = new Psr16Adapter($authTokenCache);
+        }
+
+        $this->authTokenCache = $authTokenCache;
+    }
+
     public function setHttpRequestLogger(?LoggerInterface $logger = null): void
     {
         $this->httpRequestLogger = $logger;
@@ -72,6 +86,10 @@ public function createFactory(array $config = []): Factory
             $factory = $factory->withVerifierCache($this->verifierCache);
         }
 
+        if ($this->authTokenCache) {
+            $factory = $factory->withAuthTokenCache($this->authTokenCache);
+        }
+
         if ($this->httpRequestLogger) {
             $factory = $factory->withHttpLogger($this->httpRequestLogger);
         }

diff --git a/src/DependencyInjection/FirebaseExtension.php b/src/DependencyInjection/FirebaseExtension.php
@@ -69,6 +69,10 @@ private function registerService(string $name, array $config, string $class, str
             $factory->addMethodCall('setVerifierCache', [new Reference($config['verifier_cache'])]);
         }
 
+        if ($config['auth_token_cache'] ?? null) {
+            $factory->addMethodCall('setAuthTokenCache', [new Reference($config['auth_token_cache'])]);
+        }
+
         if ($config['http_request_logger'] ?? null) {
             $factory->addMethodCall('setHttpRequestLogger', [new Reference($config['http_request_logger'])]);
         }

diff --git a/tests/DependencyInjection/Factory/ProjectFactoryTest.php b/tests/DependencyInjection/Factory/ProjectFactoryTest.php
@@ -122,4 +122,36 @@ public function it_accepts_a_PSR6_verifier_cache(): void
         $this->factory->setVerifierCache($cache);
         $this->factory->createAuth();
     }
+
+    /**
+     * @test
+     */
+    public function it_accepts_a_PSR16_auth_token_cache(): void
+    {
+        $cache = $this->createMock(CacheInterface::class);
+
+        $this->firebaseFactory
+            ->expects($this->once())
+            ->method('withAuthTokenCache')
+            ->with($this->isInstanceOf(CacheItemPoolInterface::class));
+
+        $this->factory->setAuthTokenCache($cache);
+        $this->factory->createAuth();
+    }
+
+    /**
+     * @test
+     */
+    public function it_accepts_a_PSR6_auth_token_cache(): void
+    {
+        $cache = $this->createMock(CacheItemPoolInterface::class);
+
+        $this->firebaseFactory
+            ->expects($this->once())
+            ->method('withAuthTokenCache')
+            ->with($cache);
+
+        $this->factory->setAuthTokenCache($cache);
+        $this->factory->createAuth();
+    }
 }