Prefer PhpFileCache for caching docs #7500

shadowhand · 2018-12-02T05:08:20Z

Removes APC and XCache because they are deprecated.

Remvoes APCu because it is not as performant as PhpFileCache and cannot
be cleared using using console tools.

greg0ire · 2018-12-02T12:19:06Z

Please amend your commit message:

- Remvoes APCu because it is not as performant as PhpFileCache and cannot
- be cleared using using console tools.
+ Removes APCu because it is not as performant as PhpFileCache and cannot
+ be cleared using console tools.

Also, what do you mean by "docs"?

Prefer PhpFileCache for caching docs

EDIT: at first, I thought you mean "for caching phpdoc", meaning annotations, now I get it.

docs/en/reference/caching.rst

shadowhand · 2018-12-02T15:25:19Z

@greg0ire updated.

greg0ire · 2018-12-02T15:33:03Z

Please amend your commit message:

- be cleared using using console tools.
+ be cleared using console tools.

Removes APC and XCache because they are deprecated. Removes APCu because it is not as performant as PhpFileCache and cannot be cleared using console tools.

shadowhand · 2018-12-02T20:29:44Z

@greg0ire fixed.

Majkl578 · 2018-12-03T02:28:03Z

Just like APCu, OPCache can't be cleared from CLI either. So in the end this isn't any improvement.

shadowhand · 2018-12-03T03:09:48Z

@Majkl578 clearing PhpFileCache means ~~removing files, and opcache detects the removal of files.~~ updating the namespace version, so the requested cache files will no longer be found.

Edited, see #7500 (comment)

Majkl578 · 2018-12-03T03:30:23Z

opcache detects the removal of files

Only if configured to do so, and this setting should be disabled on production.

Majkl578

As per my comment above, one can of worms is being replaced by another can of worms while the original issue remains.
I support getting rid of APCu, but this is not the correct way.

Ocramius · 2018-12-05T12:34:08Z

The PhpFileCache is perfectly fine for any static-ish setups, like metadata: even better, it fits most deployment strategies too.

…

On Wed, 5 Dec 2018, 13:26 Michael Moravec ***@***.*** wrote: ***@***.**** requested changes on this pull request. As per my comment above, one can of worms is being replaced by another can of worms while the original issue remains. I support getting rid of APCu, but this is not the correct way. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#7500 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJakEh6SlFw40IBdEyiqR928VgIXPOZks5u17uEgaJpZM4Y9PlG> .

lcobucci · 2018-12-05T14:29:28Z

It's quite important to remember that our cache providers don't remove anything on removeAll() but simply bump up the namespace version: https://github.com/doctrine/cache/blob/36c114783b9f30abfd1054e59c28e6e2e8152481/lib/Doctrine/Common/Cache/CacheProvider.php#L153-L165

What @Majkl578 said is really important, the recommended opcache production setup ® doesn't track file system updates (which is what makes opcaching truly remarkable), therefore you can refresh stuff and the app won't get updated unless the deployment is done in a separated environment (phoenix servers, containers, etc) - or reseting opcache (which is possibly done when reloading the web service workers).

shadowhand · 2018-12-05T15:32:29Z

@lcobucci since the there is no filesystem change being done, will running apps see the cache clear, even when the server is not restarted? If so, that would invalidate @Majkl578's concern. I don't understand the subtleties of opcache internals.

lcobucci · 2018-12-05T17:39:49Z

@shadowhand let's remove opcache from equation for one sec. When we do the PhpFileCache#removeAll(), we get the file that stores the namespace version and write the new namespace version to it. That's how the upcoming commands/requests know which version to use.

For production, opcache usually is configured like this (apart from other ones):

opcache.validate_timestamps=0
opcache.enable_file_override=1

The comments of the first one give us the answer to your question:

; When disabled, you must reset the OPcache manually or restart the
; webserver for changes to the filesystem to take effect.

So, no, namespace version change won't be propagated unless opcache is cleared manually or via webserver restart.

shadowhand · 2018-12-06T13:48:11Z

@lcobucci thanks.

@Majkl578 given that your concern is about how opcache might be configured, how do you suggest that this PR be changed to address that?

lcobucci · 2019-08-13T21:52:07Z

@shadowhand sorry about the huge delay here... I'd say that it's fine to use file system cache for annotations, query, and metadata cache but for result set and L2C I'd rather suggest Redis.

lcobucci

I would also not remove APCu and XCache from the docs because they're also helpful scenarios where it's just fine to use them (containerised apps or blue-green deployments).

lcobucci · 2019-11-15T09:55:41Z

docs/en/reference/caching.rst

-    <?php
-    $cacheDriver = new \Doctrine\Common\Cache\ApcCache();
-    $cacheDriver->save('cache_id', 'my_data');
+PhpFileCache


I think the best way for this is to have another header grouping distributed (redis, memcached, etc) and non-distributed (filesystem, apcu, etc) providers. Stating that non-distributed ones are completely fine for query and metadata caches whereas distributed ones are better suited for result set and second-level caches.

lcobucci · 2019-11-15T09:57:25Z

docs/en/reference/caching.rst

-APCu
-~~~~
+The preferred cache driver is ``PhpFileCache``. This driver serializes
+cache items and writes them to a file. This allows for opcode caching


It would be really nice if we mention the impact of opcache configuration and what are the architectural consequences of them. Or maybe point to an external resource with that info.

Because an external resource might disappear, that short mention of the impact would be nice as an extra.

lcobucci · 2019-11-15T10:04:33Z

@shadowhand thanks a lot for the initial write-up. I hope my suggestions make sense to you and help us move this further.

We're working to finalise the 2.6.x minor and since this is not a really urgent bug fix I moved it to 2.7.1 so that we have time to discuss and organise this well.

Thanks again for your contribution 👍

SenseException · 2019-11-17T23:23:15Z

docs/en/reference/caching.rst

@@ -304,8 +270,11 @@ use on your ORM configuration.
 .. code-block:: php

    <?php
+    $cacheDriver = new \Doctrine\Common\Cache\PhpFileCacheCache(


Suggested change

$cacheDriver = new \Doctrine\Common\Cache\PhpFileCacheCache(

$cacheDriver = new \Doctrine\Common\Cache\PhpFileCache(

SenseException · 2019-11-17T23:24:46Z

docs/en/reference/caching.rst

@@ -318,7 +287,11 @@ cache implementation.
 .. code-block:: php

    <?php
-    $config->setResultCacheImpl(new \Doctrine\Common\Cache\ApcuCache());
+    $cacheDriver = new \Doctrine\Common\Cache\PhpFileCacheCache(


Suggested change

$cacheDriver = new \Doctrine\Common\Cache\PhpFileCacheCache(

$cacheDriver = new \Doctrine\Common\Cache\PhpFileCache(

SenseException · 2019-11-17T23:25:44Z

docs/en/reference/caching.rst

@@ -335,7 +308,11 @@ result cache driver.
 .. code-block:: php

    <?php
-    $query->setResultCacheDriver(new \Doctrine\Common\Cache\ApcuCache());
+    $cacheDriver = new \Doctrine\Common\Cache\PhpFileCacheCache(


Suggested change

$cacheDriver = new \Doctrine\Common\Cache\PhpFileCacheCache(

$cacheDriver = new \Doctrine\Common\Cache\PhpFileCache(

SenseException · 2019-11-17T23:26:21Z

docs/en/reference/caching.rst

@@ -387,7 +364,11 @@ first.
 .. code-block:: php

    <?php
-    $config->setMetadataCacheImpl(new \Doctrine\Common\Cache\ApcuCache());
+    $cacheDriver = new \Doctrine\Common\Cache\PhpFileCacheCache(


Suggested change

$cacheDriver = new \Doctrine\Common\Cache\PhpFileCacheCache(

$cacheDriver = new \Doctrine\Common\Cache\PhpFileCache(

SenseException · 2019-11-17T23:29:57Z

docs/en/reference/caching.rst

-APCu
-~~~~
+The preferred cache driver is ``PhpFileCache``. This driver serializes
+cache items and writes them to a file. This allows for opcode caching


Because an external resource might disappear, that short mention of the impact would be nice as an extra.

beberlei · 2020-01-08T18:39:46Z

Merged in 20c4603

shadowhand mentioned this pull request Dec 2, 2018

Add warning about using CLI tool with APC(u) cache #7493

Closed

greg0ire requested changes Dec 2, 2018

View reviewed changes

greg0ire previously approved these changes Dec 2, 2018

View reviewed changes

Prefer PhpFileCache for caching docs

162c62f

Removes APC and XCache because they are deprecated. Removes APCu because it is not as performant as PhpFileCache and cannot be cleared using console tools.

shadowhand dismissed greg0ire’s stale review via 162c62f December 2, 2018 20:29

greg0ire approved these changes Dec 2, 2018

View reviewed changes

Ocramius added Improvement Documentation labels Dec 5, 2018

Ocramius added this to the 2.6.4 milestone Dec 5, 2018

Ocramius approved these changes Dec 5, 2018

View reviewed changes

Majkl578 suggested changes Dec 5, 2018

View reviewed changes

lcobucci modified the milestones: 2.6.4, 2.6.5 Sep 23, 2019

ostrolucky approved these changes Nov 14, 2019

View reviewed changes

ostrolucky added the Requires merge/review label Nov 14, 2019

lcobucci suggested changes Nov 15, 2019

View reviewed changes

lcobucci removed this from the 2.6.5 milestone Nov 15, 2019

lcobucci added this to the 2.7.1 milestone Nov 15, 2019

lcobucci mentioned this pull request Nov 15, 2019

Update improving-performance.rst to reflect current state of PHP ecosystem #7619

Closed

SenseException requested changes Nov 17, 2019

View reviewed changes

beberlei closed this Jan 8, 2020

beberlei removed the Requires merge/review label Feb 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prefer PhpFileCache for caching docs #7500

Prefer PhpFileCache for caching docs #7500

shadowhand commented Dec 2, 2018

greg0ire commented Dec 2, 2018 •

edited

Loading

shadowhand commented Dec 2, 2018

greg0ire commented Dec 2, 2018

shadowhand commented Dec 2, 2018

Majkl578 commented Dec 3, 2018

shadowhand commented Dec 3, 2018 •

edited

Loading

Majkl578 commented Dec 3, 2018

Majkl578 left a comment

Ocramius commented Dec 5, 2018 via email

lcobucci commented Dec 5, 2018 •

edited

Loading

shadowhand commented Dec 5, 2018 •

edited

Loading

lcobucci commented Dec 5, 2018

shadowhand commented Dec 6, 2018

lcobucci commented Aug 13, 2019

lcobucci left a comment

lcobucci Nov 15, 2019

lcobucci Nov 15, 2019

SenseException Nov 17, 2019

lcobucci commented Nov 15, 2019

SenseException Nov 17, 2019

SenseException Nov 17, 2019

SenseException Nov 17, 2019

SenseException Nov 17, 2019

SenseException Nov 17, 2019

beberlei commented Jan 8, 2020

	$cacheDriver = new \Doctrine\Common\Cache\PhpFileCacheCache(
	$cacheDriver = new \Doctrine\Common\Cache\PhpFileCache(

Prefer PhpFileCache for caching docs #7500

Prefer PhpFileCache for caching docs #7500

Conversation

shadowhand commented Dec 2, 2018

greg0ire commented Dec 2, 2018 • edited Loading

shadowhand commented Dec 2, 2018

greg0ire commented Dec 2, 2018

shadowhand commented Dec 2, 2018

Majkl578 commented Dec 3, 2018

shadowhand commented Dec 3, 2018 • edited Loading

Majkl578 commented Dec 3, 2018

Majkl578 left a comment

Choose a reason for hiding this comment

Ocramius commented Dec 5, 2018 via email

lcobucci commented Dec 5, 2018 • edited Loading

shadowhand commented Dec 5, 2018 • edited Loading

lcobucci commented Dec 5, 2018

shadowhand commented Dec 6, 2018

lcobucci commented Aug 13, 2019

lcobucci left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lcobucci commented Nov 15, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beberlei commented Jan 8, 2020

greg0ire commented Dec 2, 2018 •

edited

Loading

shadowhand commented Dec 3, 2018 •

edited

Loading

lcobucci commented Dec 5, 2018 •

edited

Loading

shadowhand commented Dec 5, 2018 •

edited

Loading