Add a transient cleaner tool

[lusimeon]

Motivation

Rather than (or in addition to) set a lifetime to a transient, we often need to clean a transient when a post is saved to update the front-office. So this PR introduce a way to clean transients based on a user-input configuration like the one below.

[
  # Transient to clean on post update.
  'post' => [
    'all' => [
      'transient_key',
    ]
    'post_type_key' => [
      'transient_key',
      'transient_key_1',
    ]
  ],
  # Transient to clean on term update.
  'term' => [
    'all' => []
    'your_taxonomy_type_key' => []
  ],
  # Transient to clean on option update.
  'option' => [
    'all' => []
    'option_key' => []
  ],
]

Todo

• Add unit and functionnal test.

[codecov]

Codecov Report

Merging #8 (e3a9412) into develop (4b4e526) will increase coverage by 13.88%.
The diff coverage is 100.00%.

@@              Coverage Diff               @@
##             develop       #8       +/-   ##
==============================================
+ Coverage      25.35%   39.24%   +13.88%     
- Complexity       102      131       +29     
==============================================
  Files              5        6        +1     
  Lines            280      344       +64     
==============================================
+ Hits              71      135       +64     
  Misses           209      209               

Flag	Coverage Δ	Complexity Δ
unittests	39.24% <100.00%> (+13.88%)	0.00 <29.00> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ	Complexity Δ
src/TransientCleaner.php	100.00% <100.00%> (ø)	29.00 <29.00> (?)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4b4e526...e3a9412. Read the comment docs.

[titouanmathis]

This looks really useful! 👍

I have some thoughts and questions:

• the TransientCleaner might be used as a service when creating new transients, should it implement the singleton pattern?
• as a service, we might need to push a specific transient key to a specific part of the config, I think we need more methods to achieve that:

// Usage
$transient_cleaner = TransientCleaner::getInstance();
$transient_cleaner->addPostConfig('my_transient_key', 'my_cpt_name');

// Definition 
public function addPostConfig( string $transient_key, $cpt_name = 'all' ) {
  $this->config['post'][$cpt_name][] = $transient_key;
}

[lusimeon]

@studiometa/wordpress This PR is ready for review but #11 needs to be merged before merge this one.

@titouanmathis

as a service, we might need to push a specific transient key to a specific part of the config, I think we need more methods to achieve that

Thanks for your feedbacks, in my opinion most of the time the config will be set only one time (on app init), so specific push methods aren't needed.
Otherwise, the behaviour can be achieved with actuals methods. Are you agree?

$config = $cleaner->get_config();
$cleaner->set_config(
    array_merge($config, ['post' => […]]);
);

[perruche]

Does this implementation support a configuration with wildcard caracters, or do we have to manually register all the transient keys ?

When implementing ajax filters for exemple, transient key are generelly looking something like this: filters_transient_key_{request_params}_{language_code}. Could be usefull to be able to delete all transient with the matching pattern: filters_transient_key_

[titouanmathis]

Does this implementation support a configuration with wildcard caracters, or do we have to manually register all the transient keys ?

When implementing ajax filters for exemple, transient key are generelly looking something like this: filters_transient_key_{request_params}_{language_code}. Could be usefull to be able to delete all transient with the matching pattern: filters_transient_key_

I think it does, as there is a strpos() used in the cleaning methods, but I am not sure.
It can be tested easily by adding a test to the TransientCleanerTest.php file 😉

[lusimeon]

I think it does, as there is a strpos() used in the cleaning methods, but I am not sure.

Exactly it does thanks to strpos() ;)

This PR still a WIP, I need to push some fixes to make it working with WordPress Gutenberg post creation, and to validate test suite.

[lusimeon]

This PR still a WIP, I need to push some fixes to make it working with WordPress Gutenberg post creation, and to validate test suite.

I fix test suite and Gutenberg compatibility, so this PR isn't a WIP anymore. Please can you (re)review it one last time?

[perruche]

👏 👏 this is looking really good !