Replacing Zend_Cache with symfony/cache component #40058

jakwinkler · 2025-07-09T14:40:12Z

Description (*)

My biggest PR for Magento Open Source.
This PR removes Zend_Cache adapter and introduces symfony-cache to be used instead.

Manual testing scenarios (*)

Do a lot of testing for cache cleaning
Repeat and automate this testing

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves Identify and replace all Zend_Cache usages with symfony/cache across the codebase #40070: Replacing Zend_Cache with symfony/cache component

m2-assistant · 2025-07-09T14:40:17Z

Hi @jakwinkler. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

jakwinkler · 2025-07-09T14:59:46Z

@ihor-sviziev check it out ;-) something we can merge before 2.5? ;-)

ihor-sviziev · 2025-07-09T16:01:14Z

not sure. @engcom-Delta could someone from internal team review and decide whether we can merge it to 2.4 or not?

jakwinkler · 2025-07-09T16:07:14Z

@magento run all tests

Copilot

Pull Request Overview

This PR migrates Magento's cache system from Zend_Cache to Symfony Cache components, addressing a significant architectural change in the framework's caching infrastructure. The changes introduce Symfony Cache as the new caching backend while maintaining compatibility with existing Magento cache interfaces.

Key changes include:

Introduction of a new Symfony Cache adapter that implements Magento's FrontendInterface
Replacement of Zend Cache constants with new constants in FrontendInterface
Updates to Core class to use PSR-6 CacheItemPoolInterface instead of Zend_Cache_Core
Migration of cache backend factory to create Symfony adapters

Reviewed Changes

Copilot reviewed 27 out of 28 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
composer.json	Updates dependencies to replace magento/zend-cache with symfony/cache
lib/internal/Magento/Framework/Cache/FrontendInterface.php	Adds cache cleaning mode constants to replace Zend Cache constants
lib/internal/Magento/Framework/Cache/Frontend/Adapter/Symfony.php	New Symfony Cache adapter implementing FrontendInterface
lib/internal/Magento/Framework/Cache/Core.php	Complete rewrite to use PSR-6 CacheItemPoolInterface
lib/internal/Magento/Framework/App/Cache/Frontend/Factory.php	Factory updated to create Symfony Cache adapters
Multiple test files	Updated to use new constants and mock PSR interfaces

Copilot · 2025-07-09T16:09:20Z

lib/internal/Magento/Framework/Cache/Frontend/Adapter/Symfony.php

+    public function test($identifier)
+    {
+        $item = $this->cache->getItem($this->cleanIdentifier($identifier));
+        return $item->isHit() ? ($item->getMetadata()['mtime'] ?? time()) : false;


The getMetadata() method is not part of the PSR-6 CacheItemInterface standard. This will cause a fatal error when used with standard PSR-6 implementations. Consider using a different approach to track modification time or document that this requires a specific cache adapter implementation.

Suggested change

return $item->isHit() ? ($item->getMetadata()['mtime'] ?? time()) : false;

if ($item->isHit()) {

$data = $item->get();

return $data['mtime'] ?? time();

}

return false;

Copilot · 2025-07-09T16:09:20Z

lib/internal/Magento/Framework/Cache/Core.php

+    public function test($identifier)
+    {
+        $item = $this->cachePool->getItem($this->_id($identifier));
+        return $item->isHit() ? ($item->getMetadata()['mtime'] ?? time()) : false;


The getMetadata() method is not part of the PSR-6 CacheItemInterface standard. This will cause a fatal error when used with standard PSR-6 implementations. Consider using a different approach to track modification time or document that this requires a specific cache adapter implementation.

Suggested change

return $item->isHit() ? ($item->getMetadata()['mtime'] ?? time()) : false;

return $item->isHit() ? ($item->get()['mtime'] ?? time()) : false;

@jakwinkler I see all these issues related to PSR-6 are caused by using wrong interface for the cachePool. I guess the right interface should be \Symfony\Component\Cache\Adapter\AdapterInterface, which extends Psr\Cache\CacheItemPoolInterface

Copilot · 2025-07-09T16:09:20Z

lib/internal/Magento/Framework/Cache/Core.php

+     */
+    public function remove($identifier)
+    {
+        return $this->cachePool->delete($this->_id($identifier));


The delete() method is not part of the PSR-6 CacheItemPoolInterface. The correct method name is deleteItem(). This will cause a fatal error.

Suggested change

return $this->cachePool->delete($this->_id($identifier));

return $this->cachePool->deleteItem($this->_id($identifier));

Copilot · 2025-07-09T16:09:21Z

lib/internal/Magento/Framework/Cache/Core.php

+            $metadata = $item->getMetadata();
+            return [
+                'expire' => $metadata['expiry'] ?? 0,
+                'mtime' => $metadata['mtime'] ?? time(),
+                'tags' => [], // Tags are not directly supported by PSR-6 metadata
+            ];
+        }
+        return false;
+    }

-            return;
+    /**


The getMetadata() method used on line 234 is not part of the PSR-6 CacheItemInterface standard. This will cause a fatal error when used with standard PSR-6 implementations.

Suggested change

$metadata = $item->getMetadata();

return [

'expire' => $metadata['expiry'] ?? 0,

'mtime' => $metadata['mtime'] ?? time(),

'tags' => [], // Tags are not directly supported by PSR-6 metadata

];

}

return false;

}

return;

/**

// Retrieve metadata from a custom storage mechanism

$metadata = $this->retrieveMetadata($cacheId);

return [

'expire' => $metadata['expiry'] ?? 0,

'mtime' => $metadata['mtime'] ?? time(),

'tags' => $metadata['tags'] ?? [], // Tags retrieved from custom storage

];

}

return false;

}

/**

* Retrieve metadata for a given cache ID from custom storage.

*

* @param string $cacheId

* @return array

*/

private function retrieveMetadata($cacheId)

{

// Example implementation: Replace with actual storage logic

$metadataStorage = $this->getMetadataStorage();

return $metadataStorage[$cacheId] ?? [];

}

/**

* Get the metadata storage.

*

* @return array

*/

private function getMetadataStorage()

{

// Example implementation: Replace with actual storage logic

return [

'exampleCacheId' => [

'expiry' => time() + 3600,

'mtime' => time(),

'tags' => ['tag1', 'tag2'],

],

];

}

/**

Copilot · 2025-07-09T16:09:21Z

lib/internal/Magento/Framework/Currency/Data/Currency.php

    {
        if ($tag) {
-            self::$cache->clean(\Zend_Cache::CLEANING_MODE_MATCHING_TAG, $tag);
+            self::$cache->clean(\Magento\Framework\Cache\FrontendInterface::CLEANING_MODE_MATCHING_TAG, (array)$tag);


The clean() method is being called on self::$cache which is typed as FrontendInterface, but the parameter casting to (array) suggests the original code expected a single string. This change in behavior could cause issues if calling code passes a string instead of an array.

Suggested change

self::$cache->clean(\Magento\Framework\Cache\FrontendInterface::CLEANING_MODE_MATCHING_TAG, (array)$tag);

$tags = is_array($tag) ? $tag : [$tag];

self::$cache->clean(\Magento\Framework\Cache\FrontendInterface::CLEANING_MODE_MATCHING_TAG, $tags);

Copilot · 2025-07-09T16:09:21Z

lib/internal/Magento/Framework/Cache/Test/Unit/Frontend/Decorator/ProfilerTest.php

            return $adaptee;
        };
-        $lowLevelFrontend = new Zend($frontendFactory);
+        $lowLevelFrontend = new Symfony($frontendFactory);


The variable $frontendFactory is a closure that returns a CacheItemPoolInterface mock, but the Symfony constructor expects a CacheItemPoolInterface directly, not a factory function. This will cause a type error.

Suggested change

$lowLevelFrontend = new Symfony($frontendFactory);

$cacheItemPool = $frontendFactory();

$lowLevelFrontend = new Symfony($cacheItemPool);

Copilot · 2025-07-09T16:09:21Z

lib/internal/Magento/Framework/App/Cache/Frontend/Factory.php

-                break;
+                // Symfony Cache does not have a direct SQLite adapter. PdoAdapter can be used with SQLite DSN.
+                // For now, fallback to FilesystemAdapter or throw an error.
+                throw new \Exception('SQLite cache backend is not directly supported by Symfony Cache adapters.');


[nitpick] Using the generic Exception class instead of a more specific exception type makes error handling less precise. Consider using a more specific exception class like UnsupportedOperationException or creating a custom exception.

Suggested change

throw new \Exception('SQLite cache backend is not directly supported by Symfony Cache adapters.');

throw new \LogicException('SQLite cache backend is not directly supported by Symfony Cache adapters.');

Copilot · 2025-07-09T16:09:22Z

lib/internal/Magento/Framework/App/Cache/Frontend/Factory.php

-                break;
+                // Symfony Cache does not have an eAccelerator adapter.
+                // For now, fallback to FilesystemAdapter or throw an error.
+                throw new \Exception('eAccelerator cache backend is not directly supported by Symfony Cache adapters.');


[nitpick] Using the generic Exception class instead of a more specific exception type makes error handling less precise. Consider using a more specific exception class like UnsupportedOperationException or creating a custom exception.

Suggested change

throw new \Exception('eAccelerator cache backend is not directly supported by Symfony Cache adapters.');

throw new \LogicException('eAccelerator cache backend is not directly supported by Symfony Cache adapters.');

ihor-sviziev · 2025-07-09T16:15:46Z

composer.json

        "opensearch-project/opensearch-php": "^2.3",
        "pelago/emogrifier": "^7.0",
        "php-amqplib/php-amqplib": "^3.2",
-        "phpseclib/mcrypt_compat": "^2.0",


I think it was removed by misteke, it's not relates to this PR

ihor-sviziev · 2025-07-09T16:22:16Z

@jakwinkler, please review the comments from Copilot and let us know if you would like anything to be fixed based on them. If no, I'll review the pull request

jakwinkler · 2025-07-09T16:24:20Z

@ihor-sviziev I'm not entire sure about PSR-6 starndard with Magento, can you elaborate on that?

ihor-sviziev · 2025-07-10T09:38:02Z

@magento run all tests

BTW, I checked - the bin/magento cache:flush command fails with the error:

bin/magento cache:flush

There is an error in /var/www/html/lib/internal/Magento/Framework/App/Cache/Manager.php at line: 109
Call to undefined method Symfony\Component\Cache\Adapter\TagAwareAdapter::clean()#0 /var/www/html/app/code/Magento/Backend/Console/Command/CacheFlushCommand.php(39): Magento\Framework\App\Cache\Manager->flush(Array)
#1 /var/www/html/app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php(64): Magento\Backend\Console\Command\CacheFlushCommand->performAction(Array)
#2 /var/www/html/vendor/symfony/console/Command/Command.php(326): Magento\Backend\Console\Command\AbstractCacheTypeManageCommand->execute(Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#3 /var/www/html/lib/internal/Magento/Framework/Interception/Interceptor.php(58): Symfony\Component\Console\Command\Command->run(Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#4 /var/www/html/lib/internal/Magento/Framework/Interception/Interceptor.php(138): Magento\Backend\Console\Command\CacheFlushCommand\Interceptor->___callParent('run', Array)
#5 /var/www/html/lib/internal/Magento/Framework/Interception/Interceptor.php(153): Magento\Backend\Console\Command\CacheFlushCommand\Interceptor->Magento\Framework\Interception\{closure}(Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#6 /var/www/html/generated/code/Magento/Backend/Console/Command/CacheFlushCommand/Interceptor.php(77): Magento\Backend\Console\Command\CacheFlushCommand\Interceptor->___callPlugins('run', Array, Array)
#7 /var/www/html/vendor/symfony/console/Application.php(1078): Magento\Backend\Console\Command\CacheFlushCommand\Interceptor->run(Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#8 /var/www/html/vendor/symfony/console/Application.php(324): Symfony\Component\Console\Application->doRunCommand(Object(Magento\Backend\Console\Command\CacheFlushCommand\Interceptor), Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#9 /var/www/html/lib/internal/Magento/Framework/Console/Cli.php(123): Symfony\Component\Console\Application->doRun(Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#10 /var/www/html/vendor/symfony/console/Application.php(175): Magento\Framework\Console\Cli->doRun(Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#11 /var/www/html/bin/magento(23): Symfony\Component\Console\Application->run()
#12 {main}

Looks like you've restricted pushing by maintainers, so I can't add the fix

jakwinkler · 2025-07-10T10:42:20Z

@ihor-sviziev thanks for checking, I'll get back on this in 2-3 days max.

engcom-Charlie · 2025-07-15T11:24:04Z

@magento create issue

ihor-sviziev

please review the comments from Copilot and let us know if you would like anything to be fixed based on them.
Also, please fix the issue described here #40058 (comment)

engcom-Hotel · 2025-07-22T12:29:59Z

Hello @jakwinkler,

Thanks for the contribution!

We are discussing this PR internally, meanwhile moving this PR On Hold. We will update you accordingly.

Thanks

engcom-Bravo · 2025-10-09T10:44:34Z

Hi @jakwinkler,

Thank you for your contribution! The Magento core engineering team is working on the issue which you have addressed in this PR. Team will cherry pick the commits from your PR and may do further implementation to cover few more scenarios as needed. We will reach out to you if we need more information. For now, you can pause work on this PR. Thank you once again!

MagePsycho · 2025-10-18T18:00:58Z

@engcom-Bravo @engcom-Hotel Any updates? This could be a game-changer by bringing in the advantages of the Symfony community.

replacing zend_cache with symfony cache

194e011

Merge branch '2.4-develop' into zend_cache_removal

d5d5529

ihor-sviziev requested a review from Copilot July 9, 2025 16:07

ct-prd-projects-boards-automation bot added the Progress: review label Jul 9, 2025

Copilot AI reviewed Jul 9, 2025

View reviewed changes

Merge branch '2.4-develop' into zend_cache_removal

31af08b

ihor-sviziev reviewed Jul 9, 2025

View reviewed changes

engcom-Hotel added this to Pull Requests Dashboard Jul 11, 2025

github-project-automation bot moved this to Pending Review in Pull Requests Dashboard Jul 11, 2025

ct-prd-projects-boards-automation bot added the Progress: pending review label Jul 11, 2025

engcom-Charlie added the Project: Community Picked PRs upvoted by the community label Jul 14, 2025

ct-prd-projects-boards-automation bot added this to Community Dashboard Jul 14, 2025

ct-prd-projects-boards-automation bot moved this to Pending Review in Community Dashboard Jul 14, 2025

ct-prd-projects-boards-automation bot removed this from Pull Requests Dashboard Jul 14, 2025

engcom-Bravo added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Jul 14, 2025

m2-assistant bot mentioned this pull request Jul 15, 2025

Identify and replace all Zend_Cache usages with symfony/cache across the codebase #40070

Open

5 tasks

engcom-Charlie added feature request Priority: P3 May be fixed according to the position in the backlog. labels Jul 15, 2025

ct-prd-projects-boards-automation bot added this to Pull Requests Dashboard Jul 15, 2025

github-project-automation bot moved this to Pending Review in Pull Requests Dashboard Jul 15, 2025

ct-prd-projects-boards-automation bot removed this from Community Dashboard Jul 15, 2025

engcom-Charlie added this to Community Dashboard Jul 16, 2025

engcom-Charlie removed this from Pull Requests Dashboard Jul 16, 2025

engcom-Charlie moved this to Pending Review in Community Dashboard Jul 16, 2025

ihor-sviziev requested changes Jul 18, 2025

View reviewed changes

engcom-Hotel moved this from Pending Review to On Hold in Community Dashboard Jul 22, 2025

ct-prd-projects-boards-automation bot added Progress: on hold and removed Progress: review labels Jul 22, 2025

-        return $item->isHit() ? ($item->getMetadata()['mtime'] ?? time()) : false;
+        if ($item->isHit()) {
+            $data = $item->get();
+            return $data['mtime'] ?? time();
+        }
+        return false;

	return $item->isHit() ? ($item->getMetadata()['mtime'] ?? time()) : false;
	return $item->isHit() ? ($item->get()['mtime'] ?? time()) : false;

	return $this->cachePool->delete($this->_id($identifier));
	return $this->cachePool->deleteItem($this->_id($identifier));

-            $metadata = $item->getMetadata();
-            return [
-                'expire' => $metadata['expiry'] ?? 0,
-                'mtime' => $metadata['mtime'] ?? time(),
-                'tags' => [], // Tags are not directly supported by PSR-6 metadata
-            ];
-        }
-        return false;
-    }
-            return;
-    /**
+            // Retrieve metadata from a custom storage mechanism
+            $metadata = $this->retrieveMetadata($cacheId);
+            return [
+                'expire' => $metadata['expiry'] ?? 0,
+                'mtime' => $metadata['mtime'] ?? time(),
+                'tags' => $metadata['tags'] ?? [], // Tags retrieved from custom storage
+            ];
+        }
+        return false;
+    }
+    /**
+     * Retrieve metadata for a given cache ID from custom storage.
+     *
+     * @param string $cacheId
+     * @return array
+     */
+    private function retrieveMetadata($cacheId)
+    {
+        // Example implementation: Replace with actual storage logic
+        $metadataStorage = $this->getMetadataStorage();
+        return $metadataStorage[$cacheId] ?? [];
+    }
+    /**
+     * Get the metadata storage.
+     *
+     * @return array
+     */
+    private function getMetadataStorage()
+    {
+        // Example implementation: Replace with actual storage logic
+        return [
+            'exampleCacheId' => [
+                'expiry' => time() + 3600,
+                'mtime' => time(),
+                'tags' => ['tag1', 'tag2'],
+            ],
+        ];
+    }
+    /**

	self::$cache->clean(\Magento\Framework\Cache\FrontendInterface::CLEANING_MODE_MATCHING_TAG, (array)$tag);
	$tags = is_array($tag) ? $tag : [$tag];
	self::$cache->clean(\Magento\Framework\Cache\FrontendInterface::CLEANING_MODE_MATCHING_TAG, $tags);

	$lowLevelFrontend = new Symfony($frontendFactory);
	$cacheItemPool = $frontendFactory();
	$lowLevelFrontend = new Symfony($cacheItemPool);

	throw new \Exception('SQLite cache backend is not directly supported by Symfony Cache adapters.');
	throw new \LogicException('SQLite cache backend is not directly supported by Symfony Cache adapters.');

	throw new \Exception('eAccelerator cache backend is not directly supported by Symfony Cache adapters.');
	throw new \LogicException('eAccelerator cache backend is not directly supported by Symfony Cache adapters.');

Replacing Zend_Cache with symfony/cache component #40058

Are you sure you want to change the base?

Replacing Zend_Cache with symfony/cache component #40058

Uh oh!

Conversation

jakwinkler commented Jul 9, 2025 • edited by m2-assistant bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Manual testing scenarios (*)

Contribution checklist (*)

Resolved issues:

Uh oh!

m2-assistant bot commented Jul 9, 2025

Uh oh!

jakwinkler commented Jul 9, 2025

Uh oh!

ihor-sviziev commented Jul 9, 2025

Uh oh!

jakwinkler commented Jul 9, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

ihor-sviziev Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

ihor-sviziev Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

ihor-sviziev commented Jul 9, 2025

Uh oh!

jakwinkler commented Jul 9, 2025

Uh oh!

ihor-sviziev commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jakwinkler commented Jul 10, 2025

Uh oh!

engcom-Charlie commented Jul 15, 2025

Uh oh!

ihor-sviziev left a comment

Choose a reason for hiding this comment

Uh oh!

engcom-Hotel commented Jul 22, 2025

Uh oh!

engcom-Bravo commented Oct 9, 2025

Uh oh!

MagePsycho commented Oct 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

jakwinkler commented Jul 9, 2025 •

edited by m2-assistant bot

Loading

ihor-sviziev Jul 10, 2025 •

edited

Loading

ihor-sviziev commented Jul 10, 2025 •

edited

Loading