-
Notifications
You must be signed in to change notification settings - Fork 192
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add caching for universe domain (#533)
- Loading branch information
Showing
4 changed files
with
358 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| <?php | ||
| /* | ||
| * Copyright 2016 Google Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| namespace Google\Auth\Tests; | ||
|
|
||
| use Google\Auth\Cache\Item; | ||
| use Google\Auth\Cache\TypedItem; | ||
| use Psr\Cache\CacheItemInterface; | ||
| use Psr\Cache\CacheItemPoolInterface; | ||
|
|
||
| /** | ||
| * Simple in-memory cache implementation. | ||
| */ | ||
| final class TestFileCacheItemPool implements CacheItemPoolInterface | ||
| { | ||
| /** | ||
| * @var string | ||
| */ | ||
| private string $cacheDir; | ||
|
|
||
| /** | ||
| * @var CacheItemInterface[] | ||
| */ | ||
| private $deferredItems; | ||
|
|
||
|
|
||
| public function __construct(string $cacheDir) | ||
| { | ||
| $this->cacheDir = $cacheDir; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return CacheItemInterface The corresponding Cache Item. | ||
| */ | ||
| public function getItem($key): CacheItemInterface | ||
| { | ||
| return current($this->getItems([$key])); // @phpstan-ignore-line | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return iterable<CacheItemInterface> | ||
| * A traversable collection of Cache Items keyed by the cache keys of | ||
| * each item. A Cache item will be returned for each key, even if that | ||
| * key is not found. However, if no keys are specified then an empty | ||
| * traversable MUST be returned instead. | ||
| */ | ||
| public function getItems(array $keys = []): iterable | ||
| { | ||
| $items = []; | ||
| foreach ($keys as $key) { | ||
| if ($this->hasItem($key)) { | ||
| $items[$key] = unserialize(file_get_contents($this->cacheDir . '/' . $key)); | ||
| } else { | ||
| $itemClass = \PHP_VERSION_ID >= 80000 ? TypedItem::class : Item::class; | ||
| $items[$key] = new $itemClass($key); | ||
| } | ||
| } | ||
|
|
||
| return $items; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return bool | ||
| * True if item exists in the cache, false otherwise. | ||
| */ | ||
| public function hasItem($key): bool | ||
| { | ||
| $this->isValidKey($key); | ||
|
|
||
| return file_exists($this->cacheDir . '/' . $key) | ||
| && unserialize(file_get_contents($this->cacheDir . '/' . $key))->isHit(); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return bool | ||
| * True if the pool was successfully cleared. False if there was an error. | ||
| */ | ||
| public function clear(): bool | ||
| { | ||
| $this->deferredItems = []; | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return bool | ||
| * True if the item was successfully removed. False if there was an error. | ||
| */ | ||
| public function deleteItem($key): bool | ||
| { | ||
| return $this->deleteItems([$key]); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return bool | ||
| * True if the items were successfully removed. False if there was an error. | ||
| */ | ||
| public function deleteItems(array $keys): bool | ||
| { | ||
| array_walk($keys, [$this, 'isValidKey']); | ||
|
|
||
| foreach ($keys as $key) { | ||
| unlink($this->cacheDir . '/' . $key); | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return bool | ||
| * True if the item was successfully persisted. False if there was an error. | ||
| */ | ||
| public function save(CacheItemInterface $item): bool | ||
| { | ||
| if (!is_dir($this->cacheDir)) { | ||
| mkdir($this->cacheDir, 0777, true); | ||
| } | ||
| file_put_contents($this->cacheDir . '/' . $item->getKey(), serialize($item)); | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return bool | ||
| * False if the item could not be queued or if a commit was attempted and failed. True otherwise. | ||
| */ | ||
| public function saveDeferred(CacheItemInterface $item): bool | ||
| { | ||
| $this->deferredItems[$item->getKey()] = $item; | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return bool | ||
| * True if all not-yet-saved items were successfully saved or there were none. False otherwise. | ||
| */ | ||
| public function commit(): bool | ||
| { | ||
| foreach ($this->deferredItems as $item) { | ||
| $this->save($item); | ||
| } | ||
|
|
||
| $this->deferredItems = []; | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * Determines if the provided key is valid. | ||
| * | ||
| * @param string $key | ||
| * @return bool | ||
| * @throws InvalidArgumentException | ||
| */ | ||
| private function isValidKey($key) | ||
| { | ||
| $invalidCharacters = '{}()/\\\\@:'; | ||
|
|
||
| if (!is_string($key) || preg_match("#[$invalidCharacters]#", $key)) { | ||
| throw new InvalidArgumentException('The provided key is not valid: ' . var_export($key, true)); | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| <?php | ||
|
|
||
| require_once __DIR__ . '/../../vendor/autoload.php'; | ||
| require_once __DIR__ . '/TestFileCacheItemPool.php'; | ||
|
|
||
| use Google\Auth\FetchAuthTokenCache; | ||
| use Google\Auth\FetchAuthTokenInterface; | ||
| use Google\Auth\GetUniverseDomainInterface; | ||
| use Google\Auth\Tests\TestFileCacheItemPool; | ||
|
|
||
| $cache = new TestFileCacheItemPool(sys_get_temp_dir() . '/google-auth-test'); | ||
|
|
||
| $fetcher = new class($argv[1]) implements FetchAuthTokenInterface, GetUniverseDomainInterface { | ||
| private $cacheKey; | ||
|
|
||
| public function __construct(string $cacheKey) | ||
| { | ||
| $this->cacheKey = $cacheKey; | ||
| } | ||
|
|
||
| public function getUniverseDomain(): string | ||
| { | ||
| throw new \Exception('Should not be called!'); | ||
| } | ||
|
|
||
| public function getCacheKey() | ||
| { | ||
| return $this->cacheKey; | ||
| } | ||
|
|
||
| // no op | ||
| public function fetchAuthToken(?callable $httpHandle = null) | ||
| { | ||
| } | ||
| // no op | ||
| public function getLastReceivedToken() | ||
| { | ||
| } | ||
| }; | ||
|
|
||
| $cacheFetcher = new FetchAuthTokenCache( | ||
| $fetcher, | ||
| ['cacheUniverseDomain' => true], | ||
| $cache | ||
| ); | ||
|
|
||
| echo $cacheFetcher->getUniverseDomain(); |