bug #43302 [Cache] Commit items implicitly only when deferred keys are requested (Sergey Belyshkin)

nicolas-grekas · nicolas-grekas · commit 1231de63e949 · 2021-10-06T10:50:56.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Cache] Commit items implicitly only when deferred keys are requested | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | Because of implicit commits before getting any item, deferred saves are useless. ``` for($r=0; $r<10; ++$r) { $item = $adapter->getItem('Key'.$r); // implicit commit $item->set('Value'.$r); $adapter->saveDeferred($item); } $adapter->commit(); // nothing to commit :-// ``` Let's commit deferred changes only when requested item was deferred previously. Commits ------- 2e8c446 [Cache] Commit items implicitly only when deferred keys are requested
diff --git a/src/Symfony/Component/Cache/Adapter/TagAwareAdapter.php b/src/Symfony/Component/Cache/Adapter/TagAwareAdapter.php
@@ -158,9 +158,10 @@ public function invalidateTags(array $tags)
      */
     public function hasItem($key)
     {
-        if ($this->deferred) {
+        if (\is_string($key) && isset($this->deferred[$key])) {
             $this->commit();
         }
+
         if (!$this->pool->hasItem($key)) {
             return false;
         }
@@ -201,18 +202,21 @@ public function getItem($key)
      */
     public function getItems(array $keys = [])
     {
-        if ($this->deferred) {
-            $this->commit();
-        }
         $tagKeys = [];
+        $commit = false;
 
         foreach ($keys as $key) {
             if ('' !== $key && \is_string($key)) {
+                $commit = $commit || isset($this->deferred[$key]);
                 $key = static::TAGS_PREFIX.$key;
                 $tagKeys[$key] = $key;
             }
         }
 
+        if ($commit) {
+            $this->commit();
+        }
+
         try {
             $items = $this->pool->getItems($tagKeys + $keys);
         } catch (InvalidArgumentException $e) {
diff --git a/src/Symfony/Component/Cache/Traits/AbstractAdapterTrait.php b/src/Symfony/Component/Cache/Traits/AbstractAdapterTrait.php
@@ -39,10 +39,11 @@ trait AbstractAdapterTrait
      */
     public function getItem($key)
     {
-        if ($this->deferred) {
+        $id = $this->getId($key);
+
+        if (isset($this->deferred[$key])) {
             $this->commit();
         }
-        $id = $this->getId($key);
 
         $f = $this->createCacheItem;
         $isHit = false;
@@ -66,14 +67,18 @@ public function getItem($key)
      */
     public function getItems(array $keys = [])
     {
-        if ($this->deferred) {
-            $this->commit();
-        }
         $ids = [];
+        $commit = false;
 
         foreach ($keys as $key) {
             $ids[] = $this->getId($key);
+            $commit = $commit || isset($this->deferred[$key]);
         }
+
+        if ($commit) {
+            $this->commit();
+        }
+
         try {
             $items = $this->doFetch($ids);
         } catch (\Exception $e) {

Original file line number	Diff line number	Diff line change
`@@ -158,9 +158,10 @@ public function invalidateTags(array $tags)`
`158`	`158`	`*/`
`159`	`159`	`public function hasItem($key)`
`160`	`160`	`{`
`161`		`- if ($this->deferred) {`
	`161`	`+ if (\is_string($key) && isset($this->deferred[$key])) {`
`162`	`162`	`$this->commit();`
`163`	`163`	`}`
	`164`	`+`
`164`	`165`	`if (!$this->pool->hasItem($key)) {`
`165`	`166`	`return false;`
`166`	`167`	`}`
`@@ -201,18 +202,21 @@ public function getItem($key)`
`201`	`202`	`*/`
`202`	`203`	`public function getItems(array $keys = [])`
`203`	`204`	`{`
`204`		`- if ($this->deferred) {`
`205`		`- $this->commit();`
`206`		`- }`
`207`	`205`	`$tagKeys = [];`
	`206`	`+ $commit = false;`
`208`	`207`
`209`	`208`	`foreach ($keys as $key) {`
`210`	`209`	`if ('' !== $key && \is_string($key)) {`
	`210`	`+ $commit = $commit \|\| isset($this->deferred[$key]);`
`211`	`211`	`$key = static::TAGS_PREFIX.$key;`
`212`	`212`	`$tagKeys[$key] = $key;`
`213`	`213`	`}`
`214`	`214`	`}`
`215`	`215`
	`216`	`+ if ($commit) {`
	`217`	`+ $this->commit();`
	`218`	`+ }`
	`219`	`+`
`216`	`220`	`try {`
`217`	`221`	`$items = $this->pool->getItems($tagKeys + $keys);`
`218`	`222`	`} catch (InvalidArgumentException $e) {`