Merge pull request #6359 from marc1706/ticket/16891

ticket/16891] Add new method for deferring cache purge to end of request

phpBB/config/default/container/services.yml

@@ -40,6 +40,7 @@ services:
              - '@cache.driver'
              - '@config'
              - '@dbal.conn'
+             - '@dispatcher'
              - '%core.root_path%'
              - '%core.php_ext%'
 

phpBB/phpbb/cache/service.php

@@ -18,6 +18,12 @@ namespace phpbb\cache;
 */
 class service
 {
+	/** @var string Name of event used for cache purging */
+	private const PURGE_DEFERRED_ON_EVENT = 'core.garbage_collection';
+
+	/** @var bool Flag whether cache purge has been deferred */
+	private $cache_purge_deferred = false;
+
 	/**
 	* Cache driver.
 	*
@@ -39,6 +45,9 @@ class service
 	*/
 	protected $db;
 
+	/** @var \phpbb\event\dispatcher phpBB Event dispatcher */
+	protected $dispatcher;
+
 	/**
 	* Root path.
 	*
@@ -59,14 +68,16 @@ class service
 	* @param \phpbb\cache\driver\driver_interface $driver The cache driver
 	* @param \phpbb\config\config $config The config
 	* @param \phpbb\db\driver\driver_interface $db Database connection
+	* @param \phpbb\event\dispatcher $dispatcher Event dispatcher
 	* @param string $phpbb_root_path Root path
 	* @param string $php_ext PHP file extension
 	*/
-	public function __construct(\phpbb\cache\driver\driver_interface $driver, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, $phpbb_root_path, $php_ext)
+	public function __construct(\phpbb\cache\driver\driver_interface $driver, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\event\dispatcher $dispatcher, $phpbb_root_path, $php_ext)
 	{
 		$this->set_driver($driver);
 		$this->config = $config;
 		$this->db = $db;
+		$this->dispatcher = $dispatcher;
 		$this->phpbb_root_path = $phpbb_root_path;
 		$this->php_ext = $php_ext;
 	}
@@ -81,6 +92,25 @@ class service
 		return $this->driver;
 	}
 
+	/**
+	 * Deferred purge of the cache.
+	 *
+	 * A deferred purge will be executed after rendering a page.
+	 * It is recommended to be used in cases where an instant purge of the cache
+	 * is not required, i.e. when the goal of a cache purge is to start from a
+	 * clear cache at the next page load.
+	 *
+	 * @return void
+	 */
+	public function deferred_purge(): void
+	{
+		if (!$this->cache_purge_deferred)
+		{
+			$this->dispatcher->addListener(self::PURGE_DEFERRED_ON_EVENT, [$this, 'purge']);
+			$this->cache_purge_deferred = true;
+		}
+	}
+
 	/**
 	* Replaces the cache driver used by this cache service.
 	*

phpBB/phpbb/extension/manager.php

@@ -197,7 +197,7 @@ class manager
 
 		if ($this->cache)
 		{
-			$this->cache->purge();
+			$this->cache->deferred_purge();
 		}
 	}
 

tests/attachment/upload_test.php

@@ -81,7 +81,8 @@ class phpbb_attachment_upload_test extends \phpbb_database_test_case
 		$config = $this->config;
 		$this->phpbb_root_path = $phpbb_root_path;
 		$this->db = $this->new_dbal();
-		$this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), $this->config, $this->db, $phpbb_root_path, $phpEx);
+		$this->phpbb_dispatcher = new phpbb_mock_event_dispatcher();
+		$this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), $this->config, $this->db, $this->phpbb_dispatcher, $phpbb_root_path, $phpEx);
 		$this->request = $this->createMock('\phpbb\request\request');
 
 		$this->filesystem = new \phpbb\filesystem\filesystem();
@@ -136,7 +137,6 @@ class phpbb_attachment_upload_test extends \phpbb_database_test_case
 		));
 		$this->factory = new \phpbb\files\factory($this->container);
 		$this->files_upload = new \phpbb\files\upload($this->filesystem, $this->factory, $this->language, $this->php_ini, $this->request, $this->phpbb_root_path);
-		$this->phpbb_dispatcher = new phpbb_mock_event_dispatcher();
 		$this->user = new \phpbb\user($this->language, '\phpbb\datetime');
 		$this->user->data['user_id'] = ANONYMOUS;
 

tests/cache/common_test_case.php

@@ -74,7 +74,8 @@ abstract class phpbb_cache_common_test_case extends phpbb_database_test_case
 		global $db, $cache, $phpbb_root_path, $phpEx;
 		$config = new phpbb\config\config(array());
 		$db = $this->new_dbal();
-		$cache = new \phpbb\cache\service($this->driver, $config, $db, $phpbb_root_path, $phpEx);
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
+		$cache = new \phpbb\cache\service($this->driver, $config, $db, $phpbb_dispatcher, $phpbb_root_path, $phpEx);
 
 		$sql = "SELECT * FROM phpbb_config
 			WHERE config_name = 'foo'";

tests/cache/dummy_driver_test.php

@@ -50,7 +50,8 @@ class phpbb_cache_dummy_driver_test extends phpbb_database_test_case
 		global $db, $cache, $phpbb_root_path, $phpEx;
 		$config = new phpbb\config\config(array());
 		$db = $this->new_dbal();
-		$cache = new \phpbb\cache\service($this->driver, $config, $db, $phpbb_root_path, $phpEx);
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
+		$cache = new \phpbb\cache\service($this->driver, $config, $db, $phpbb_dispatcher, $phpbb_root_path, $phpEx);
 
 		$sql = "SELECT * FROM phpbb_config
 			WHERE config_name = 'foo'";

tests/dbal/migrator_tool_module_test.php

@@ -32,13 +32,13 @@ class phpbb_dbal_migrator_tool_module_test extends phpbb_database_test_case
 		$skip_add_log = true;
 
 		$db = $this->db = $this->new_dbal();
-		$this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_root_path, $phpEx);
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
+		$this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_dispatcher, $phpbb_root_path, $phpEx);
 		$lang_loader = new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx);
 		$lang = new \phpbb\language\language($lang_loader);
 		$user = $this->user = new \phpbb\user($lang, '\phpbb\datetime');
 
 		$cache = new phpbb_mock_cache;
-		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
 		$auth = $this->createMock('\phpbb\auth\auth');
 		$phpbb_log = new \phpbb\log\log($db, $user, $auth, $phpbb_dispatcher, $phpbb_root_path, 'adm/', $phpEx, LOG_TABLE);
 

tests/dbal/migrator_tool_permission_role_test.php

@@ -64,7 +64,8 @@ class phpbb_dbal_migrator_tool_permission_role_test extends phpbb_database_test_
 		parent::setup();
 
 		$db = $this->db = $this->new_dbal();
-		$cache = $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_root_path, $phpEx);
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
+		$cache = $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_dispatcher, $phpbb_root_path, $phpEx);
 		$this->auth = new \phpbb\auth\auth();
 
 		// Initialize this auth_admin instance later after adding new auth options via this->tool->add()

tests/dbal/migrator_tool_permission_test.php

@@ -38,7 +38,8 @@ class phpbb_dbal_migrator_tool_permission_test extends phpbb_database_test_case
 		parent::setup();
 
 		$db = $this->db = $this->new_dbal();
-		$cache = $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_root_path, $phpEx);
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
+		$cache = $this->cache = new \phpbb\cache\service(new \phpbb\cache\driver\dummy(), new \phpbb\config\config(array()), $this->db, $phpbb_dispatcher, $phpbb_root_path, $phpEx);
 		$this->auth = new \phpbb\auth\auth();
 
 		$this->tool = new \phpbb\db\migration\tool\permission($this->db, $this->cache, $this->auth, $phpbb_root_path, $phpEx);

tests/extension/manager_test.php

@@ -155,6 +155,7 @@ class phpbb_extension_manager_test extends phpbb_database_test_case
 	{
 		$config = new \phpbb\config\config(array('version' => PHPBB_VERSION));
 		$db = $this->new_dbal();
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
 		$factory = new \phpbb\db\tools\factory();
 		$db_tools = $factory->get($db);
 		$phpbb_root_path = __DIR__ . './../../phpBB/';
@@ -185,7 +186,7 @@ class phpbb_extension_manager_test extends phpbb_database_test_case
 			'phpbb_ext',
 			__DIR__ . '/',
 			$php_ext,
-			($with_cache) ? new \phpbb\cache\service(new phpbb_mock_cache(), $config, $db, $phpbb_root_path, $php_ext) : null
+			($with_cache) ? new \phpbb\cache\service(new phpbb_mock_cache(), $config, $db, $phpbb_dispatcher, $phpbb_root_path, $php_ext) : null
 		);
 	}
 }

tests/extension/metadata_manager_test.php

@@ -40,12 +40,13 @@ class phpbb_extension_metadata_manager_test extends phpbb_database_test_case
 			'version'		=> '3.1.0',
 		));
 		$this->db = $this->new_dbal();
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
 		$factory = new \phpbb\db\tools\factory();
 		$this->db_tools = $factory->get($this->db);
 		$this->phpbb_root_path = __DIR__ . '/';
 		$this->phpEx = 'php';
 
-		$this->cache =  new \phpbb\cache\service(new phpbb_mock_cache(), $this->config, $this->db, $this->phpbb_root_path, $this->phpEx);
+		$this->cache =  new \phpbb\cache\service(new phpbb_mock_cache(), $this->config, $this->db, $phpbb_dispatcher, $this->phpbb_root_path, $this->phpEx);
 
 		$this->table_prefix = 'phpbb_';
 
@@ -70,7 +71,7 @@ class phpbb_extension_metadata_manager_test extends phpbb_database_test_case
 			$cache_path,
 			null,
 			$loader,
-			new \phpbb\event\dispatcher($container),
+			$phpbb_dispatcher,
 			array(
 				'cache'			=> false,
 				'debug'			=> false,

tests/notification/base.php

@@ -79,17 +79,17 @@ abstract class phpbb_tests_notification_base extends phpbb_database_test_case
 		$this->user = $user;
 		$this->user_loader = new \phpbb\user_loader($this->db, $phpbb_root_path, $phpEx, 'phpbb_users');
 		$auth = $this->auth = new phpbb_mock_notifications_auth();
+		$this->phpbb_dispatcher = new phpbb_mock_event_dispatcher();
 		$cache_driver = new \phpbb\cache\driver\dummy();
 		$cache = $this->cache = new \phpbb\cache\service(
 			$cache_driver,
 			$this->config,
 			$this->db,
+			$this->phpbb_dispatcher,
 			$phpbb_root_path,
 			$phpEx
 		);
 
-		$this->phpbb_dispatcher = new phpbb_mock_event_dispatcher();
-
 		$phpbb_container = $this->container = new ContainerBuilder();
 		$loader     = new YamlFileLoader($phpbb_container, new FileLocator(__DIR__ . '/fixtures'));
 		$loader->load('services_notification.yml');

tests/notification/notification_method_email_test.php

@@ -58,17 +58,17 @@ class notification_method_email_test extends phpbb_tests_notification_base
 		$this->user = $user;
 		$this->user_loader = new \phpbb\user_loader($this->db, $phpbb_root_path, $phpEx, 'phpbb_users');
 		$auth = $this->auth = new phpbb_mock_notifications_auth();
+		$this->phpbb_dispatcher = new phpbb_mock_event_dispatcher();
 		$cache_driver = new \phpbb\cache\driver\dummy();
 		$cache = $this->cache = new \phpbb\cache\service(
 			$cache_driver,
 			$this->config,
 			$this->db,
+			$this->phpbb_dispatcher,
 			$phpbb_root_path,
 			$phpEx
 		);
 
-		$this->phpbb_dispatcher = new phpbb_mock_event_dispatcher();
-
 		$phpbb_container = $this->container = new ContainerBuilder();
 		$loader     = new YamlFileLoader($phpbb_container, new FileLocator(__DIR__ . '/fixtures'));
 		$loader->load('services_notification.yml');

tests/notification/submit_post_base.php

@@ -79,18 +79,19 @@ abstract class phpbb_notification_submit_post_base extends phpbb_database_test_c
 			'allow_board_notifications'	=> true,
 		));
 
+		// Event dispatcher
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
+
 		$cache_driver = new \phpbb\cache\driver\dummy();
 		$cache = new \phpbb\cache\service(
 			$cache_driver,
 			$config,
 			$db,
+			$phpbb_dispatcher,
 			$phpbb_root_path,
 			$phpEx
 		);
 
-		// Event dispatcher
-		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
-
 		// Language
 		$lang = new \phpbb\language\language(new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx));
 

tests/notification/user_list_trim_test.php

@@ -35,6 +35,7 @@ class phpbb_notification_user_list_trim_test extends phpbb_database_test_case
 			new \phpbb\cache\driver\dummy(),
 			$config,
 			$db,
+			$phpbb_dispatcher,
 			$phpbb_root_path,
 			$phpEx
 		);

tests/session/check_ban_test.php

@@ -58,6 +58,10 @@ class phpbb_session_check_ban_test extends phpbb_session_test_case
 		$phpbb_filesystem = new \phpbb\filesystem\filesystem();
 
 		$this->backup_cache = $cache;
+
+		// Event dispatcher
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
+
 		// Change the global cache object for this test because
 		// the mock cache object does not hit the database as is needed
 		// for this test.
@@ -65,6 +69,7 @@ class phpbb_session_check_ban_test extends phpbb_session_test_case
 			new \phpbb\cache\driver\file(),
 			$config,
 			$this->db,
+			$phpbb_dispatcher,
 			$phpbb_root_path,
 			$phpEx
 		);

tests/test_framework/phpbb_functional_test_case.php

@@ -253,8 +253,15 @@ class phpbb_functional_test_case extends phpbb_test_case
 			array(),
 			new \phpbb\db\migration\helper()
 		);
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
 		$container->set('migrator', $migrator);
-		$container->set('dispatcher', new phpbb_mock_event_dispatcher());
+		$container->set('dispatcher', $phpbb_dispatcher);
+		$cache = $this->getMockBuilder('\phpbb\cache\service')
+			->setConstructorArgs([$this->get_cache_driver(), $config, $this->db, $phpbb_dispatcher, $phpbb_root_path, $phpEx])
+			->setMethods(['deferred_purge'])
+			->getMock();
+		$cache->method('deferred_purge')
+			->willReturnCallback([$cache, 'purge']);
 
 		$extension_manager = new \phpbb\extension\manager(
 			$container,
@@ -264,7 +271,7 @@ class phpbb_functional_test_case extends phpbb_test_case
 			self::$config['table_prefix'] . 'ext',
 			__DIR__ . '/',
 			$phpEx,
-			new \phpbb\cache\service($this->get_cache_driver(), $config, $this->db, $phpbb_root_path, $phpEx)
+			$cache
 		);
 
 		return $extension_manager;

tests/version/version_helper_remote_test.php

@@ -29,10 +29,11 @@ class version_helper_remote_test extends \phpbb_test_case
 			'version'	=> '3.1.0',
 		));
 		$container = new \phpbb_mock_container_builder();
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
 		$db = new \phpbb\db\driver\factory($container);
 		$this->cache = $this->getMockBuilder('\phpbb\cache\service')
 			->setMethods(array('get'))
-			->setConstructorArgs(array(new \phpbb\cache\driver\dummy(), $config, $db, '../../', 'php'))
+			->setConstructorArgs(array(new \phpbb\cache\driver\dummy(), $config, $db, $phpbb_dispatcher, '../../', 'php'))
 			->getMock();
 
 		$this->cache->expects($this->any())