Skip to content

Commit e07955b

Browse files
matej21dg
matej21
authored and
dg
committed
added bulk read support [Closes #2][Closes #42]
1 parent 65cc60b commit e07955b

File tree

10 files changed

+307
-3
lines changed

10 files changed

+307
-3
lines changed

‎src/Caching/Cache.php‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,55 @@ public function load($key, $fallback = NULL)
9797
}
9898

9999

100+
/**
101+
* Reads multiple items from the cache.
102+
* @param array
103+
* @param callable
104+
* @return array
105+
*/
106+
public function bulkLoad(array $keys, $fallback = NULL)
107+
{
108+
if (count($keys) === 0) {
109+
return [];
110+
}
111+
foreach ($keys as $key) {
112+
if (!is_scalar($key)) {
113+
throw new Nette\InvalidArgumentException('Only scalar keys are allowed in bulkLoad()');
114+
}
115+
}
116+
$storageKeys = array_map([$this, 'generateKey'], $keys);
117+
if (!$this->storage instanceof IBulkReader) {
118+
$result = array_combine($keys, array_map([$this->storage, 'read'], $storageKeys));
119+
if ($fallback !== NULL) {
120+
foreach ($result as $key => $value) {
121+
if ($value === NULL) {
122+
$result[$key] = $this->save($key, function (& $dependencies) use ($key, $fallback) {
123+
return call_user_func_array($fallback, [$key, & $dependencies]);
124+
});
125+
}
126+
}
127+
}
128+
return $result;
129+
}
130+
131+
$cacheData = $this->storage->bulkRead($storageKeys);
132+
$result = [];
133+
foreach ($keys as $i => $key) {
134+
$storageKey = $storageKeys[$i];
135+
if (isset($cacheData[$storageKey])) {
136+
$result[$key] = $cacheData[$storageKey];
137+
} elseif ($fallback) {
138+
$result[$key] = $this->save($key, function (& $dependencies) use ($key, $fallback) {
139+
return call_user_func_array($fallback, [$key, & $dependencies]);
140+
});
141+
} else {
142+
$result[$key] = NULL;
143+
}
144+
}
145+
return $result;
146+
}
147+
148+
100149
/**
101150
* Writes item into the cache.
102151
* Dependencies are:

‎src/Caching/IBulkReader.php‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php
2+
3+
/**
4+
* This file is part of the Nette Framework (https://nette.org)
5+
* Copyright (c) 2004 David Grudl (https://davidgrudl.com)
6+
*/
7+
8+
namespace Nette\Caching;
9+
10+
11+
/**
12+
* Cache storage with a bulk read support.
13+
*/
14+
interface IBulkReader
15+
{
16+
17+
/**
18+
* Reads from cache in bulk.
19+
* @param string key
20+
* @return array key => value pairs, missing items are omitted
21+
*/
22+
function bulkRead(array $keys);
23+
24+
}

‎src/Caching/Storages/NewMemcachedStorage.php‎

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
/**
1515
* Memcached storage using memcached extension.
1616
*/
17-
class NewMemcachedStorage implements Nette\Caching\IStorage
17+
class NewMemcachedStorage implements Nette\Caching\IStorage, Nette\Caching\IBulkReader
1818
{
1919
use Nette\SmartObject;
2020

@@ -110,6 +110,39 @@ public function read($key)
110110
}
111111

112112

113+
/**
114+
* Reads from cache in bulk.
115+
* @param string key
116+
* @return array key => value pairs, missing items are omitted
117+
*/
118+
public function bulkRead(array $keys)
119+
{
120+
$prefixedKeys = array_map(function ($key) {
121+
return urlencode($this->prefix . $key);
122+
}, $keys);
123+
$keys = array_combine($prefixedKeys, $keys);
124+
$metas = $this->memcached->getMulti($prefixedKeys);
125+
$result = [];
126+
$deleteKeys = [];
127+
foreach ($metas as $prefixedKey => $meta) {
128+
if (!empty($meta[self::META_CALLBACKS]) && !Cache::checkCallbacks($meta[self::META_CALLBACKS])) {
129+
$deleteKeys[] = $prefixedKey;
130+
} else {
131+
$result[$keys[$prefixedKey]] = $meta[self::META_DATA];
132+
}
133+
134+
if (!empty($meta[self::META_DELTA])) {
135+
$this->memcached->replace($prefixedKey, $meta, $meta[self::META_DELTA] + time());
136+
}
137+
}
138+
if (!empty($deleteKeys)) {
139+
$this->memcached->deleteMulti($deleteKeys, 0);
140+
}
141+
142+
return $result;
143+
}
144+
145+
113146
/**
114147
* Prevents item reading and writing. Lock is released by write() or remove().
115148
* @param string key

‎src/Caching/Storages/SQLiteStorage.php‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
/**
1515
* SQLite storage.
1616
*/
17-
class SQLiteStorage implements Nette\Caching\IStorage
17+
class SQLiteStorage implements Nette\Caching\IStorage, Nette\Caching\IBulkReader
1818
{
1919
use Nette\SmartObject;
2020

@@ -64,6 +64,31 @@ public function read($key)
6464
}
6565

6666

67+
/**
68+
* Reads from cache in bulk.
69+
* @param string key
70+
* @return array key => value pairs, missing items are omitted
71+
*/
72+
public function bulkRead(array $keys)
73+
{
74+
$stmt = $this->pdo->prepare('SELECT key, data, slide FROM cache WHERE key IN (?' . str_repeat(',?', count($keys) - 1) . ') AND (expire IS NULL OR expire >= ?)');
75+
$stmt->execute(array_merge($keys, [time()]));
76+
$result = [];
77+
$updateSlide = [];
78+
foreach ($stmt->fetchAll(\PDO::FETCH_ASSOC) as $row) {
79+
if ($row['slide'] !== NULL) {
80+
$updateSlide[] = $row['key'];
81+
}
82+
$result[$row['key']] = unserialize($row['data']);
83+
}
84+
if (!empty($updateSlide)) {
85+
$stmt = $this->pdo->prepare('UPDATE cache SET expire = ? + slide WHERE key IN(?' . str_repeat(',?', count($updateSlide) - 1) . ')');
86+
$stmt->execute(array_merge([time()], $updateSlide));
87+
}
88+
return $result;
89+
}
90+
91+
6792
/**
6893
* Prevents item reading and writing. Lock is released by write() or remove().
6994
* @param string key

‎tests/Caching/Cache.bulkLoad.phpt‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<?php
2+
3+
/**
4+
* Test: Nette\Caching\Cache load().
5+
*/
6+
7+
use Nette\Caching\Cache;
8+
use Tester\Assert;
9+
10+
11+
require __DIR__ . '/../bootstrap.php';
12+
13+
require __DIR__ . '/Cache.php';
14+
15+
// storage without bulk load support
16+
test(function () {
17+
$storage = new TestStorage;
18+
$cache = new Cache($storage, 'ns');
19+
Assert::same([1 => NULL, 2 => NULL], $cache->bulkLoad([1, 2]), 'data');
20+
21+
Assert::same([1 => 1, 2 => 2], $cache->bulkLoad([1, 2], function ($key) {
22+
return $key;
23+
}));
24+
25+
$data = $cache->bulkLoad([1, 2]);
26+
Assert::same(1, $data[1]['data']);
27+
Assert::same(2, $data[2]['data']);
28+
});
29+
30+
// storage with bulk load support
31+
test(function () {
32+
$storage = new BulkReadTestStorage;
33+
$cache = new Cache($storage, 'ns');
34+
Assert::same([1 => NULL, 2 => NULL], $cache->bulkLoad([1, 2]));
35+
36+
Assert::same([1 => 1, 2 => 2], $cache->bulkLoad([1, 2], function ($key) {
37+
return $key;
38+
}));
39+
40+
$data = $cache->bulkLoad([1, 2]);
41+
Assert::same(1, $data[1]['data']);
42+
Assert::same(2, $data[2]['data']);
43+
});
44+
45+
// dependencies
46+
test(function () {
47+
$storage = new BulkReadTestStorage;
48+
$cache = new Cache($storage, 'ns');
49+
$dependencies = [Cache::TAGS => 'tag'];
50+
$cache->bulkLoad([1], function ($key, & $deps) use ($dependencies) {
51+
$deps = $dependencies;
52+
return $key;
53+
});
54+
55+
$data = $cache->bulkLoad([1, 2]);
56+
Assert::same($dependencies, $data[1]['dependencies']);
57+
});
58+
59+
test(function () {
60+
Assert::exception(function () {
61+
$cache = new Cache(new BulkReadTestStorage());
62+
$cache->bulkLoad([[1]]);
63+
}, Nette\InvalidArgumentException::class, 'Only scalar keys are allowed in bulkLoad()');
64+
});

‎tests/Caching/Cache.php‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?php
22

3+
use Nette\Caching\IBulkReader;
34
use Nette\Caching\IStorage;
45

56
class TestStorage implements IStorage
@@ -25,3 +26,20 @@ public function remove($key) {}
2526

2627
public function clean(array $conditions) {}
2728
}
29+
30+
class BulkReadTestStorage extends TestStorage implements IBulkReader
31+
{
32+
function bulkRead(array $keys)
33+
{
34+
$result = [];
35+
foreach ($keys as $key) {
36+
$data = $this->read($key);
37+
if ($data !== NULL) {
38+
$result[$key] = $data;
39+
}
40+
}
41+
42+
return $result;
43+
}
44+
45+
}

‎tests/Storages/NewMemcached.bulkRead.phpt‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
/**
4+
* Test: Nette\Caching\Storages\NewMemcachedStorage and bulkRead
5+
*/
6+
7+
use Nette\Caching\Storages\NewMemcachedStorage;
8+
use Nette\Caching\Cache;
9+
use Tester\Assert;
10+
11+
12+
require __DIR__ . '/../bootstrap.php';
13+
14+
15+
if (!NewMemcachedStorage::isAvailable()) {
16+
Tester\Environment::skip('Requires PHP extension Memcached.');
17+
}
18+
19+
Tester\Environment::lock('memcached-files', TEMP_DIR);
20+
21+
22+
23+
$cache = new Cache(new NewMemcachedStorage('localhost'));
24+
25+
$cache->save('foo', 'bar');
26+
27+
Assert::same(['foo' => 'bar', 'lorem' => NULL], $cache->bulkLoad(['foo', 'lorem']));

‎tests/Storages/NewMemcached.sliding.phpt‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,31 @@ for ($i = 0; $i < 5; $i++) {
3737
sleep(1);
3838

3939
Assert::truthy($cache->load($key));
40-
4140
}
4241

4342
// Sleeping few seconds...
4443
sleep(5);
4544

4645
Assert::null($cache->load($key));
46+
47+
48+
// Bulk
49+
50+
// Writing cache...
51+
$cache->save($key, $value, [
52+
Cache::EXPIRATION => time() + 3,
53+
Cache::SLIDING => TRUE,
54+
]);
55+
56+
57+
for ($i = 0; $i < 5; $i++) {
58+
// Sleeping 1 second
59+
sleep(1);
60+
61+
Assert::truthy($cache->bulkLoad([$key])[$key]);
62+
}
63+
64+
// Sleeping few seconds...
65+
sleep(5);
66+
67+
Assert::null($cache->load([$key])[$key]);

‎tests/Storages/SQLiteStorage.bulkRead.phpt‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
/**
4+
* Test: Nette\Caching\Storages\SQLiteStorage and bulk read.
5+
*/
6+
7+
use Nette\Caching\Cache;
8+
use Nette\Caching\Storages\SQLiteStorage;
9+
use Tester\Assert;
10+
11+
12+
require __DIR__ . '/../bootstrap.php';
13+
14+
15+
if (!extension_loaded('pdo_sqlite')) {
16+
Tester\Environment::skip('Requires PHP extension pdo_sqlite.');
17+
}
18+
19+
20+
$cache = new Cache(new SQLiteStorage(':memory:'));
21+
$cache->save('foo', 'bar');
22+
23+
Assert::same(['foo' => 'bar', 'lorem' => NULL], $cache->bulkLoad(['foo', 'lorem']));

‎tests/Storages/SQLiteStorage.sliding.phpt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,23 @@ for ($i = 0; $i < 5; $i++) {
4141
sleep(5);
4242

4343
Assert::null($cache->load($key));
44+
45+
46+
// Writing cache...
47+
$cache->save($key, $value, [
48+
Cache::EXPIRATION => time() + 3,
49+
Cache::SLIDING => TRUE,
50+
]);
51+
52+
53+
for ($i = 0; $i < 5; $i++) {
54+
// Sleeping 1 second
55+
sleep(1);
56+
57+
Assert::truthy($cache->bulkLoad([$key])[$key]);
58+
}
59+
60+
// Sleeping few seconds...
61+
sleep(5);
62+
63+
Assert::null($cache->bulkLoad([$key])[$key]);

0 commit comments

Comments
 (0)