From ec6b83cc1891214c7fa3a236626807b4335f9a2f Mon Sep 17 00:00:00 2001 From: Carl Schwan Date: Tue, 3 May 2022 11:15:24 +0200 Subject: [PATCH] Add stricter psalm type for CappedMemoryCache Signed-off-by: Carl Schwan --- .../lib/Lib/Storage/AmazonS3.php | 28 +++++----- apps/files_external/lib/Lib/Storage/SMB.php | 8 ++- apps/files_sharing/lib/MountProvider.php | 1 + apps/files_sharing/lib/SharedMount.php | 1 + apps/user_ldap/lib/Group_LDAP.php | 12 ++--- apps/user_ldap/lib/Helper.php | 13 ++--- apps/user_ldap/lib/User/Manager.php | 51 +++++-------------- apps/workflowengine/lib/Manager.php | 9 ++-- build/psalm-baseline.xml | 33 +----------- lib/private/Cache/CappedMemoryCache.php | 2 +- lib/private/Diagnostics/QueryLogger.php | 16 +++--- lib/private/Encryption/File.php | 8 +-- lib/private/Encryption/Util.php | 2 +- lib/private/Files/AppData/AppData.php | 21 +++----- lib/private/Files/Config/UserMountCache.php | 27 +++------- tests/lib/Files/Config/UserMountCacheTest.php | 3 +- 16 files changed, 74 insertions(+), 161 deletions(-) diff --git a/apps/files_external/lib/Lib/Storage/AmazonS3.php b/apps/files_external/lib/Lib/Storage/AmazonS3.php index d3e9605e5a1..e7a8c5f9329 100644 --- a/apps/files_external/lib/Lib/Storage/AmazonS3.php +++ b/apps/files_external/lib/Lib/Storage/AmazonS3.php @@ -54,6 +54,7 @@ use OCP\Files\IMimeTypeDetector; use OCP\ICacheFactory; use OCP\IMemcache; use OCP\Server; +use OCP\ICache; class AmazonS3 extends \OC\Files\Storage\Common { use S3ConnectionTrait; @@ -63,23 +64,18 @@ class AmazonS3 extends \OC\Files\Storage\Common { return false; } - /** @var CappedMemoryCache|Result[] */ - private $objectCache; + /** @var CappedMemoryCache */ + private CappedMemoryCache $objectCache; - /** @var CappedMemoryCache|bool[] */ - private $directoryCache; + /** @var CappedMemoryCache */ + private CappedMemoryCache $directoryCache; - /** @var CappedMemoryCache|array */ - private $filesCache; + /** @var CappedMemoryCache */ + private CappedMemoryCache $filesCache; - /** @var IMimeTypeDetector */ - private $mimeDetector; - - /** @var bool|null */ - private $versioningEnabled = null; - - /** @var IMemcache */ - private $memCache; + private IMimeTypeDetector $mimeDetector; + private ?bool $versioningEnabled = null; + private ICache $memCache; public function __construct($parameters) { parent::__construct($parameters); @@ -146,10 +142,9 @@ class AmazonS3 extends \OC\Files\Storage\Common { } /** - * @param $key * @return array|false */ - private function headObject($key) { + private function headObject(string $key) { if (!isset($this->objectCache[$key])) { try { $this->objectCache[$key] = $this->getConnection()->headObject([ @@ -165,6 +160,7 @@ class AmazonS3 extends \OC\Files\Storage\Common { } if (is_array($this->objectCache[$key]) && !isset($this->objectCache[$key]["Key"])) { + /** @psalm-suppress InvalidArgument Psalm doesn't understand nested arrays well */ $this->objectCache[$key]["Key"] = $key; } return $this->objectCache[$key]; diff --git a/apps/files_external/lib/Lib/Storage/SMB.php b/apps/files_external/lib/Lib/Storage/SMB.php index c2555f87b93..bdb9b4f9c8f 100644 --- a/apps/files_external/lib/Lib/Storage/SMB.php +++ b/apps/files_external/lib/Lib/Storage/SMB.php @@ -84,10 +84,8 @@ class SMB extends Common implements INotifyStorage { */ protected $root; - /** - * @var IFileInfo[] - */ - protected $statCache; + /** @var CappedMemoryCache */ + protected CappedMemoryCache $statCache; /** @var ILogger */ protected $logger; @@ -527,7 +525,7 @@ class SMB extends Common implements INotifyStorage { } try { - $this->statCache = []; + $this->statCache = new CappedMemoryCache(); $content = $this->share->dir($this->buildPath($path)); foreach ($content as $file) { if ($file->isDirectory()) { diff --git a/apps/files_sharing/lib/MountProvider.php b/apps/files_sharing/lib/MountProvider.php index bfb40387622..d27f9e5e0da 100644 --- a/apps/files_sharing/lib/MountProvider.php +++ b/apps/files_sharing/lib/MountProvider.php @@ -109,6 +109,7 @@ class MountProvider implements IMountProvider { $view = new View('/' . $user->getUID() . '/files'); $ownerViews = []; $sharingDisabledForUser = $this->shareManager->sharingDisabledForUser($user->getUID()); + /** @var CappedMemoryCache $folderExistCache */ $foldersExistCache = new CappedMemoryCache(); foreach ($superShares as $share) { try { diff --git a/apps/files_sharing/lib/SharedMount.php b/apps/files_sharing/lib/SharedMount.php index 398da5eaf23..95ff66c4b71 100644 --- a/apps/files_sharing/lib/SharedMount.php +++ b/apps/files_sharing/lib/SharedMount.php @@ -96,6 +96,7 @@ class SharedMount extends MountPoint implements MoveableMount { * * @param \OCP\Share\IShare $share * @param SharedMount[] $mountpoints + * @param CappedMemoryCache $folderExistCache * @return string */ private function verifyMountPoint( diff --git a/apps/user_ldap/lib/Group_LDAP.php b/apps/user_ldap/lib/Group_LDAP.php index f9d9b061743..8fcb10cb850 100644 --- a/apps/user_ldap/lib/Group_LDAP.php +++ b/apps/user_ldap/lib/Group_LDAP.php @@ -55,12 +55,12 @@ use Psr\Log\LoggerInterface; class Group_LDAP extends BackendUtility implements GroupInterface, IGroupLDAP, IGetDisplayNameBackend, IDeleteGroupBackend { protected $enabled = false; - /** @var string[][] $cachedGroupMembers array of users with gid as key */ - protected $cachedGroupMembers; - /** @var string[] $cachedGroupsByMember array of groups with uid as key */ - protected $cachedGroupsByMember; - /** @var string[] $cachedNestedGroups array of groups with gid (DN) as key */ - protected $cachedNestedGroups; + /** @var CappedMemoryCache $cachedGroupMembers array of users with gid as key */ + protected CappedMemoryCache $cachedGroupMembers; + /** @var CappedMemoryCache $cachedGroupsByMember array of groups with uid as key */ + protected CappedMemoryCache $cachedGroupsByMember; + /** @var CappedMemoryCache $cachedNestedGroups array of groups with gid (DN) as key */ + protected CappedMemoryCache $cachedNestedGroups; /** @var GroupPluginManager */ protected $groupPluginManager; /** @var LoggerInterface */ diff --git a/apps/user_ldap/lib/Helper.php b/apps/user_ldap/lib/Helper.php index 437fab6b6a8..3ca5de67874 100644 --- a/apps/user_ldap/lib/Helper.php +++ b/apps/user_ldap/lib/Helper.php @@ -35,15 +35,10 @@ use OCP\IConfig; use OCP\IDBConnection; class Helper { - - /** @var IConfig */ - private $config; - - /** @var IDBConnection */ - private $connection; - - /** @var CappedMemoryCache */ - protected $sanitizeDnCache; + private IConfig $config; + private IDBConnection $connection; + /** @var CappedMemoryCache */ + protected CappedMemoryCache $sanitizeDnCache; public function __construct(IConfig $config, IDBConnection $connection) { diff --git a/apps/user_ldap/lib/User/Manager.php b/apps/user_ldap/lib/User/Manager.php index e752b113e3f..e52b093f5af 100644 --- a/apps/user_ldap/lib/User/Manager.php +++ b/apps/user_ldap/lib/User/Manager.php @@ -47,43 +47,20 @@ use Psr\Log\LoggerInterface; * cache */ class Manager { - /** @var Access */ - protected $access; - - /** @var IConfig */ - protected $ocConfig; - - /** @var IDBConnection */ - protected $db; - - /** @var IUserManager */ - protected $userManager; - - /** @var INotificationManager */ - protected $notificationManager; - - /** @var FilesystemHelper */ - protected $ocFilesystem; - - /** @var LoggerInterface */ - protected $logger; - - /** @var Image */ - protected $image; - - /** @param \OCP\IAvatarManager */ - protected $avatarManager; - - /** - * @var CappedMemoryCache $usersByDN - */ - protected $usersByDN; - /** - * @var CappedMemoryCache $usersByUid - */ - protected $usersByUid; - /** @var IManager */ - private $shareManager; + protected ?Access $access = null; + protected IConfig $ocConfig; + protected IDBConnection $db; + protected IUserManager $userManager; + protected INotificationManager $notificationManager; + protected FilesystemHelper $ocFilesystem; + protected LoggerInterface $logger; + protected Image $image; + protected IAvatarManager $avatarManager; + /** @var CappedMemoryCache $usersByDN */ + protected CappedMemoryCache $usersByDN; + /** @var CappedMemoryCache $usersByUid */ + protected CappedMemoryCache $usersByUid; + private IManager $shareManager; public function __construct( IConfig $ocConfig, diff --git a/apps/workflowengine/lib/Manager.php b/apps/workflowengine/lib/Manager.php index 34dbf507b91..f6c3e3086c2 100644 --- a/apps/workflowengine/lib/Manager.php +++ b/apps/workflowengine/lib/Manager.php @@ -109,8 +109,8 @@ class Manager implements IManager { /** @var ILogger */ protected $logger; - /** @var CappedMemoryCache */ - protected $operationsByScope = []; + /** @var CappedMemoryCache */ + protected CappedMemoryCache $operationsByScope; /** @var IUserSession */ protected $session; @@ -350,10 +350,11 @@ class Manager implements IManager { $qb->setParameters(['scope' => $scopeContext->getScope(), 'scopeId' => $scopeContext->getScopeId()]); $result = $qb->execute(); - $this->operationsByScope[$scopeContext->getHash()] = []; + $operations = []; while (($opId = $result->fetchOne()) !== false) { - $this->operationsByScope[$scopeContext->getHash()][] = (int)$opId; + $operations[] = (int)$opId; } + $this->operationsByScope[$scopeContext->getHash()] = $operations; $result->closeCursor(); return in_array($id, $this->operationsByScope[$scopeContext->getHash()], true); diff --git a/build/psalm-baseline.xml b/build/psalm-baseline.xml index 7152a3fbffe..60b1a435339 100644 --- a/build/psalm-baseline.xml +++ b/build/psalm-baseline.xml @@ -1371,9 +1371,7 @@ - - new CappedMemoryCache() - + $e->getCode() $e->getCode() @@ -1911,16 +1909,6 @@ - - $this->cachedGroupsByMember[$uid] - - - $this->cachedGroupsByMember - $this->cachedNestedGroups - new CappedMemoryCache() - new CappedMemoryCache() - new CappedMemoryCache() - $groupName @@ -2116,9 +2104,6 @@ $result - - [] - $result @@ -2989,11 +2974,6 @@ getShareForToken - - - new CappedMemoryCache() - - deleteUserKey @@ -3123,17 +3103,6 @@ array - - $this->cacheInfoCache - $this->cacheInfoCache - $this->cacheInfoCache - $this->mountsForUsers - $this->mountsForUsers - $this->mountsForUsers - $this->mountsForUsers - $this->mountsForUsers - $this->mountsForUsers - diff --git a/lib/private/Cache/CappedMemoryCache.php b/lib/private/Cache/CappedMemoryCache.php index 0a3300435eb..6063b5e7110 100644 --- a/lib/private/Cache/CappedMemoryCache.php +++ b/lib/private/Cache/CappedMemoryCache.php @@ -88,7 +88,7 @@ class CappedMemoryCache implements ICache, \ArrayAccess { } /** - * @param string $key + * @param string $offset * @param T $value * @return void */ diff --git a/lib/private/Diagnostics/QueryLogger.php b/lib/private/Diagnostics/QueryLogger.php index 499947178a3..40d68d94ae3 100644 --- a/lib/private/Diagnostics/QueryLogger.php +++ b/lib/private/Diagnostics/QueryLogger.php @@ -28,15 +28,10 @@ use OC\Cache\CappedMemoryCache; use OCP\Diagnostics\IQueryLogger; class QueryLogger implements IQueryLogger { - /** - * @var \OC\Diagnostics\Query - */ - protected $activeQuery; - - /** - * @var CappedMemoryCache - */ - protected $queries; + protected int $index = 0; + protected ?Query $activeQuery = null; + /** @var CappedMemoryCache */ + protected CappedMemoryCache $queries; /** * QueryLogger constructor. @@ -74,7 +69,8 @@ class QueryLogger implements IQueryLogger { public function stopQuery() { if ($this->activated && $this->activeQuery) { $this->activeQuery->end(microtime(true)); - $this->queries[] = $this->activeQuery; + $this->queries[(string)$this->index] = $this->activeQuery; + $this->index++; $this->activeQuery = null; } } diff --git a/lib/private/Encryption/File.php b/lib/private/Encryption/File.php index 2c486dfade6..2d7e23a8883 100644 --- a/lib/private/Encryption/File.php +++ b/lib/private/Encryption/File.php @@ -47,9 +47,9 @@ class File implements \OCP\Encryption\IFile { /** * cache results of already checked folders * - * @var array + * @var CappedMemoryCache */ - protected $cache; + protected CappedMemoryCache $cache; public function __construct(Util $util, IRootFolder $rootFolder, @@ -62,10 +62,10 @@ class File implements \OCP\Encryption\IFile { /** - * get list of users with access to the file + * Get list of users with access to the file * * @param string $path to the file - * @return array ['users' => $uniqueUserIds, 'public' => $public] + * @return array{users: string[], public: bool} */ public function getAccessList($path) { diff --git a/lib/private/Encryption/Util.php b/lib/private/Encryption/Util.php index dc878ba8fc1..693e24c4721 100644 --- a/lib/private/Encryption/Util.php +++ b/lib/private/Encryption/Util.php @@ -220,7 +220,7 @@ class Util { * get the owner and the path for the file relative to the owners files folder * * @param string $path - * @return array + * @return array{0: string, 1: string} * @throws \BadMethodCallException */ public function getUidAndFilename($path) { diff --git a/lib/private/Files/AppData/AppData.php b/lib/private/Files/AppData/AppData.php index 53f69be7127..471de799c2f 100644 --- a/lib/private/Files/AppData/AppData.php +++ b/lib/private/Files/AppData/AppData.php @@ -38,21 +38,12 @@ use OCP\Files\NotPermittedException; use OCP\Files\SimpleFS\ISimpleFolder; class AppData implements IAppData { - - /** @var IRootFolder */ - private $rootFolder; - - /** @var SystemConfig */ - private $config; - - /** @var string */ - private $appId; - - /** @var Folder */ - private $folder; - - /** @var (ISimpleFolder|NotFoundException)[]|CappedMemoryCache */ - private $folders; + private IRootFolder $rootFolder; + private SystemConfig $config; + private string $appId; + private ?Folder $folder = null; + /** @var CappedMemoryCache */ + private CappedMemoryCache $folders; /** * AppData constructor. diff --git a/lib/private/Files/Config/UserMountCache.php b/lib/private/Files/Config/UserMountCache.php index a5fe04c2cac..c326eeb0b6c 100644 --- a/lib/private/Files/Config/UserMountCache.php +++ b/lib/private/Files/Config/UserMountCache.php @@ -36,7 +36,6 @@ use OCP\Files\Config\ICachedMountInfo; use OCP\Files\Config\IUserMountCache; use OCP\Files\Mount\IMountPoint; use OCP\Files\NotFoundException; -use OCP\ICache; use OCP\IDBConnection; use OCP\IUser; use OCP\IUserManager; @@ -46,30 +45,17 @@ use Psr\Log\LoggerInterface; * Cache mounts points per user in the cache so we can easilly look them up */ class UserMountCache implements IUserMountCache { - /** - * @var IDBConnection - */ - private $connection; - - /** - * @var IUserManager - */ - private $userManager; + private IDBConnection $connection; + private IUserManager $userManager; /** * Cached mount info. - * Map of $userId to ICachedMountInfo. - * - * @var ICache + * @var CappedMemoryCache **/ - private $mountsForUsers; - + private CappedMemoryCache $mountsForUsers; private LoggerInterface $logger; - - /** - * @var ICache - */ - private $cacheInfoCache; + /** @var CappedMemoryCache */ + private CappedMemoryCache $cacheInfoCache; /** * UserMountCache constructor. @@ -132,6 +118,7 @@ class UserMountCache implements IUserMountCache { foreach ($addedMounts as $mount) { $this->addToCache($mount); + /** @psalm-suppress InvalidArgument */ $this->mountsForUsers[$user->getUID()][] = $mount; } foreach ($removedMounts as $mount) { diff --git a/tests/lib/Files/Config/UserMountCacheTest.php b/tests/lib/Files/Config/UserMountCacheTest.php index f4c6a427abd..221159bc983 100644 --- a/tests/lib/Files/Config/UserMountCacheTest.php +++ b/tests/lib/Files/Config/UserMountCacheTest.php @@ -11,6 +11,7 @@ namespace Test\Files\Config; use OC\DB\QueryBuilder\Literal; use OC\Files\Mount\MountPoint; use OC\Files\Storage\Storage; +use OC\Cache\CappedMemoryCache; use OC\User\Manager; use OCP\EventDispatcher\IEventDispatcher; use OCP\Files\Config\ICachedMountInfo; @@ -114,7 +115,7 @@ class UserMountCacheTest extends TestCase { } private function clearCache() { - $this->invokePrivate($this->cache, 'mountsForUsers', [[]]); + $this->invokePrivate($this->cache, 'mountsForUsers', [new CappedMemoryCache()]); } public function testNewMounts() { -- 2.39.5