a3ce1f9da7
* Where possible and easy to figure out, change `array` to something like
`array<K,V>` or `V[]` for improved static analysis to catch/prevent
regressions in CI.
* Minor doc improvements:
- consistently use the imperative mood for method briefs,
- consistently use @internal instead of @private,
- explain in @throws why they happen to inform when they should be caught
(and remove if they are not meant to be caught/handled by any caller).
* Simplify addSources() implementation as a simple loop instead recursing
(not worth the complexity, only called once or twice at runtime).
* Use more granular exceptions to distinguish between errors that indicate
a mistake on the caller (logic/invalid arguments error), and runtime
errors (which are more circumstantial).
* Update register() unit test for bad 'moduleInfo' type to use
a nested value, given that the second-parameter level type is
now verified by the signature already.
Change-Id: Id98ba1f28cb7f1c72f0a3e82f4151bcbd0f3db77
126 lines
4.4 KiB
PHP
126 lines
4.4 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace Wikimedia\DependencyStore;
|
|
|
|
/**
|
|
* Class for tracking per-entity dependency path lists that are expensive to mass compute
|
|
*
|
|
* @internal This should not be used outside of ResourceLoader and ResourceLoaderModule
|
|
*/
|
|
abstract class DependencyStore {
|
|
/** @var string */
|
|
const KEY_PATHS = 'paths';
|
|
/** @var string */
|
|
const KEY_AS_OF = 'asOf';
|
|
|
|
/**
|
|
* @param string[] $paths List of dependency paths
|
|
* @param int|null $asOf UNIX timestamp or null
|
|
* @return array
|
|
*/
|
|
public function newEntityDependencies( array $paths = [], $asOf = null ) {
|
|
return [ self::KEY_PATHS => $paths, self::KEY_AS_OF => $asOf ];
|
|
}
|
|
|
|
/**
|
|
* Get the currently tracked dependencies for an entity
|
|
*
|
|
* The "paths" field contains a sorted list of unique paths
|
|
*
|
|
* The "asOf" field reflects the last-modified timestamp of the dependency data itself.
|
|
* It will be null if there is no tracking data available. Note that if empty path lists
|
|
* are never stored (as an optimisation) then it will not be possible to discern whether
|
|
* the result is up-to-date.
|
|
*
|
|
* @param string $type Entity type
|
|
* @param string $entity Entity name
|
|
* @return array Map of (paths: paths, asOf: UNIX timestamp or null)
|
|
* @throws DependencyStoreException
|
|
*/
|
|
final public function retrieve( $type, $entity ) {
|
|
return $this->retrieveMulti( $type, [ $entity ] )[$entity];
|
|
}
|
|
|
|
/**
|
|
* Get the currently tracked dependencies for a set of entities
|
|
*
|
|
* @see KeyValueDependencyStore::retrieve()
|
|
*
|
|
* @param string $type Entity type
|
|
* @param string[] $entities Entity names
|
|
* @return array[] Map of (entity => (paths: paths, asOf: UNIX timestamp or null))
|
|
* @throws DependencyStoreException
|
|
*/
|
|
abstract public function retrieveMulti( $type, array $entities );
|
|
|
|
/**
|
|
* Set the currently tracked dependencies for an entity
|
|
*
|
|
* Dependency data should be set to persist as long as anything might rely on it existing
|
|
* in order to check the validity of some previously computed work. This can be achieved
|
|
* while minimizing storage space under the following scheme:
|
|
* - a) computed work has a TTL (time-to-live)
|
|
* - b) when work is computed, the dependency data is updated
|
|
* - c) the dependency data has a TTL higher enough to accounts for skew/latency
|
|
* - d) the TTL of tracked dependency data is renewed upon access
|
|
*
|
|
* @param string $type Entity type
|
|
* @param string $entity Entity name
|
|
* @param array $data Map of (paths: paths, asOf: UNIX timestamp or null)
|
|
* @param int $ttl New time-to-live in seconds
|
|
* @throws DependencyStoreException
|
|
*/
|
|
final public function store( $type, $entity, array $data, $ttl ) {
|
|
$this->storeMulti( $type, [ $entity => $data ], $ttl );
|
|
}
|
|
|
|
/**
|
|
* Set the currently tracked dependencies for a set of entities
|
|
*
|
|
* @see KeyValueDependencyStore::store()
|
|
*
|
|
* @param string $type Entity type
|
|
* @param array[] $dataByEntity Map of (entity => (paths: paths, asOf: UNIX timestamp or null))
|
|
* @param int $ttl New time-to-live in seconds
|
|
* @throws DependencyStoreException
|
|
*
|
|
*/
|
|
abstract public function storeMulti( $type, array $dataByEntity, $ttl );
|
|
|
|
/**
|
|
* Delete the currently tracked dependencies for an entity or set of entities
|
|
*
|
|
* @param string $type Entity type
|
|
* @param string|string[] $entities Entity name(s)
|
|
* @throws DependencyStoreException
|
|
*/
|
|
abstract public function remove( $type, $entities );
|
|
|
|
/**
|
|
* Set the expiry for the currently tracked dependencies for an entity or set of entities
|
|
*
|
|
* @param string $type Entity type
|
|
* @param string|string[] $entities Entity name(s)
|
|
* @param int $ttl New time-to-live in seconds
|
|
* @throws DependencyStoreException
|
|
*/
|
|
abstract public function renew( $type, $entities, $ttl );
|
|
}
|