Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge "objectcache: Consolidate WRITE_PRUNE_SEGMENTS into WRITE_ALLOW_SEGMENTS"

Browse source
This commit is contained in:
jenkins-bot 2024-08-12 16:16:10 +00:00 committed by Gerrit Code Review
commit 959ebbed6a
4 changed files with 20 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
includes/Storage/PageEditStash.php
View file

@ -541,7 +541,7 @@ class PageEditStash {
$keyList = $this->cache->get( $key ) ?: [];
if ( count( $keyList ) >= self::MAX_CACHE_RECENT ) {
$oldestKey = array_shift( $keyList );
$this->cache->delete( $oldestKey, BagOStuff::WRITE_PRUNE_SEGMENTS );
$this->cache->delete( $oldestKey, BagOStuff::WRITE_ALLOW_SEGMENTS );
}
$keyList[] = $newKey;

22
includes/libs/objectcache/BagOStuff.php
View file

@ -120,8 +120,11 @@ abstract class BagOStuff implements
public const WRITE_CACHE_ONLY = 8;
/** Allow partitioning of the value if it is a large string */
public const WRITE_ALLOW_SEGMENTS = 16;
/** Delete all the segments if the value is partitioned */
public const WRITE_PRUNE_SEGMENTS = 32;
/**
* Delete all the segments if the value is partitioned
* @deprecated since 1.43 Use WRITE_ALLOW_SEGMENTS instead.
*/
public const WRITE_PRUNE_SEGMENTS = self::WRITE_ALLOW_SEGMENTS;
/**
* If supported, do not block on write operation completion; instead, treat writes as
* succesful based on whether they could be buffered. When using this flag with methods
@ -242,7 +245,7 @@ abstract class BagOStuff implements
* @param mixed $value
* @param int $exptime Either an interval in seconds or a unix timestamp for expiry
* @param int $flags Bitfield of BagOStuff::WRITE_* constants
*
* If setting WRITE_ALLOW_SEGMENTS, remember to also set it in any delete() calls.
* @return bool Success
*/
abstract public function set( $key, $value, $exptime = 0, $flags = 0 );
@ -250,13 +253,17 @@ abstract class BagOStuff implements
/**
* Delete an item if it exists
*
* For large values written using WRITE_ALLOW_SEGMENTS, this only deletes the main
* segment list key unless WRITE_PRUNE_SEGMENTS is in the flags. While deleting the segment
* list key has the effect of functionally deleting the key, it leaves unused blobs in cache.
* For large values set with WRITE_ALLOW_SEGMENTS, this only deletes the placeholder
* key with the segment list. To delete the underlying blobs, include WRITE_ALLOW_SEGMENTS
* in the flags for delete() as well. While deleting the segment list key has the effect of
* functionally deleting the key, it leaves unused blobs in storage.
*
* The reason that this is not done automatically, is that to delete underlying blobs,
* requires first fetching the current segment list. Given that 99% of keys don't use
* WRITE_ALLOW_SEGMENTS, this would be wasteful.
*
* @param string $key
* @param int $flags Bitfield of BagOStuff::WRITE_* constants
*
* @return bool Success (item deleted or not found)
*/
abstract public function delete( $key, $flags = 0 );
@ -427,7 +434,6 @@ abstract class BagOStuff implements
*
* @param string[] $keys List of keys
* @param int $flags Bitfield of BagOStuff::WRITE_* constants
*
* @return bool Success (items deleted and/or not found)
* @since 1.33
*/

41
includes/libs/objectcache/MediumSpecificBagOStuff.php
View file

@ -173,16 +173,6 @@ abstract class MediumSpecificBagOStuff extends BagOStuff {
*/
abstract protected function doGet( $key, $flags = 0, &$casToken = null );
/**
* Set an item
*
* @param string $key
* @param mixed $value
* @param int $exptime Either an interval in seconds or a unix timestamp for expiry
* @param int $flags Bitfield of BagOStuff::WRITE_* constants
*
* @return bool Success
*/
public function set( $key, $value, $exptime = 0, $flags = 0 ) {
$entry = $this->makeValueOrSegmentList( $key, $value, $exptime, $flags, $ok );
@ -202,20 +192,8 @@ abstract class MediumSpecificBagOStuff extends BagOStuff {
*/
abstract protected function doSet( $key, $value, $exptime = 0, $flags = 0 );
/**
* Delete an item
*
* For large values written using WRITE_ALLOW_SEGMENTS, this only deletes the main
* segment list key unless WRITE_PRUNE_SEGMENTS is in the flags. While deleting the segment
* list key has the effect of functionally deleting the key, it leaves unused blobs in cache.
*
* @param string $key
* @param int $flags Bitfield of BagOStuff::WRITE_* constants
*
* @return bool True if the item was deleted or not found, false on failure
*/
public function delete( $key, $flags = 0 ) {
if ( !$this->fieldHasFlags( $flags, self::WRITE_PRUNE_SEGMENTS ) ) {
if ( !$this->fieldHasFlags( $flags, self::WRITE_ALLOW_SEGMENTS ) ) {
return $this->doDelete( $key, $flags );
}
@ -236,7 +214,7 @@ abstract class MediumSpecificBagOStuff extends BagOStuff {
$mainValue->{SerializedValueContainer::SEGMENTED_HASHES}
);
return $this->deleteMulti( $orderedKeys, $flags & ~self::WRITE_PRUNE_SEGMENTS );
return $this->deleteMulti( $orderedKeys, $flags & ~self::WRITE_ALLOW_SEGMENTS );
}
/**
@ -771,20 +749,9 @@ abstract class MediumSpecificBagOStuff extends BagOStuff {
return $res;
}
/**
* Batch deletion
*
* This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O
*
* @param string[] $keys List of keys
* @param int $flags Bitfield of BagOStuff::WRITE_* constants
*
* @return bool Success
* @since 1.33
*/
public function deleteMulti( array $keys, $flags = 0 ) {
if ( $this->fieldHasFlags( $flags, self::WRITE_PRUNE_SEGMENTS ) ) {
throw new InvalidArgumentException( __METHOD__ . ' got WRITE_PRUNE_SEGMENTS' );
if ( $this->fieldHasFlags( $flags, self::WRITE_ALLOW_SEGMENTS ) ) {
throw new InvalidArgumentException( __METHOD__ . ' got WRITE_ALLOW_SEGMENTS' );
}
return $this->doDeleteMulti( $keys, $flags );

2
tests/phpunit/includes/libs/objectcache/BagOStuffTestBase.php
View file

@ -430,7 +430,7 @@ abstract class BagOStuffTestBase extends MediaWikiIntegrationTestCase {
$this->cache->set( $key, "@$value", 10, BagOStuff::WRITE_ALLOW_SEGMENTS );
$this->assertEquals( "@$value", $this->cache->get( $key ), "get $case" );
$this->assertTrue(
$this->cache->delete( $key, BagOStuff::WRITE_PRUNE_SEGMENTS ),
$this->cache->delete( $key, BagOStuff::WRITE_ALLOW_SEGMENTS ),
"prune $case"
);
$this->assertFalse( $this->cache->get( $key ), "pruned $case" );