Add pluck/patch commands for caches and transients #89

petitphp · 2023-07-25T14:50:31Z

Add commands for plucking and patching values from object cache and transient.

Fixes #26

petitphp · 2023-08-28T14:14:51Z

I cannot reproduce the failures for the functional tests locally :

$ composer behat                                                                 
> run-behat-tests
...................................................................... 70
...................................................................... 140
...................................................................... 210
...................................................................... 280
...................................................................... 350
................

20 scénarios (20 succès)
366 étapes (366 succès)
4m20.27s (10.47Mb)

Seem's like the mu-plugins used to set up those scenarios are not loaded.

danielbachhuber

I cannot reproduce the failures for the functional tests locally :

Yeah, the tests pass locally for me too.

I don't know what the issue might be. @wp-cli/committers Any ideas?

features/cache.feature

features/transient.feature

features/cache.feature

swissspidy · 2023-08-30T10:02:25Z

Unfortunately can't reproduce locally either.

Looks like $current_value is null, so the wp_cache_get() call in the patch() method is returning null for some reason..?

Adding some WP_CLI::log( var_export( wp_cache_get( 'my_key' ), true ) ); calls to within $set_foo could help debug this.

petitphp · 2023-09-07T07:53:14Z

I manage to reproduce the failling tests locally after rebasing main in the branch, I'll look into it.

Scratch that, it was an issue with the rebase 🥲

petitphp · 2023-09-07T08:11:32Z

@danielbachhuber I've split the tests into dedicated files and update them to use When I run if they're expected to succeed.

In 327d99a I added two debug statement to try to understand why the tests are failing in Github CI.

petitphp · 2023-09-18T19:50:29Z

@danielbachhuber I was finally able to fix the failures for the functional tests. It was related to the use of STDIN to get the new value, which didn't properly handle the case where it was empty.

All tests are green on my fork.

danielbachhuber

Nice work getting the tests working, @petitphp !

I left a few comments to work through.

src/Cache_Command.php

src/Cache/RecursiveDataStructureTraverser.php

src/Cache_Command.php

danielbachhuber · 2023-09-18T21:08:04Z

features/transient-patch.feature

+        set_transient( 'my_key_2', ['foo' => ['bar' => 'baz']] );
+      };
+
+      WP_CLI::add_hook( 'before_invoke:transient patch', $set_foo );


Can we use wp transient set to set these initial transient values? The transient cache is persistent in vanilla WordPress, so we shouldn't need to hook into the command invocation in this manner.

Originally I was planing on using wp transient set but it is not possible to set array-like data directly like what's possible with wp option add/update (maybe an idea for a future PR to add this).

I've found another solution by using the wp eval command to execute a set_transient

Given a WP install And I run `wp eval "set_transient( 'my_key', ['foo' => 'bar'] );"` And I run `wp eval "set_transient( 'my_key_2', ['foo' => ['bar' => 'baz']] );"`

features/transient-patch.feature

danielbachhuber · 2023-09-18T21:10:26Z

src/Transient_Command.php

+		$traverser = new RecursiveDataStructureTraverser( $current_value );
+
+		try {
+			$traverser->$action( $key_path, $patch_value );


How does the actual transient value get saved?

The transient value is updated later in the elseif condition by using the function store in the $write_func variable.

johnbillion · 2023-11-10T14:41:12Z

What's left to do on this PR?

petitphp · 2023-11-15T08:21:11Z

Hi @johnbillion, sorry for the delay.

I didn't had the time to look at Daniel comments yet. I'll try to check them this week and finish up this PR for a new review.

petitphp · 2023-12-12T08:32:00Z

Hi @danielbachhuber,

I've refactored the feature tests to address your feedbacks, this should be good to go.

All tests workflows using MySQL are green, the ones with SQLite are failing, but doesn't seem related to this PR specifically (eg: Functional - WP latest on 8.2 with SQLite).

swissspidy · 2024-01-08T12:24:15Z

SQLite errors are known, see #92

petitphp · 2024-04-19T18:01:57Z

Hi, this PR should be ready for final review, the failling tests are related to SQLite errors and not to the changes in this PR.

Split features for patch/pluck commands into their own file and use `When I run` for commands when they have a successful outcome.

Co-authored-by: Daniel Bachhuber <[email protected]>

…t get`

…ecks

Co-authored-by: Pascal Birchler <[email protected]>

codecov · 2025-05-05T18:51:16Z

Codecov Report

Attention: Patch coverage is 84.87395% with 18 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/Transient_Command.php	83.33%	10 Missing ⚠️
src/Cache_Command.php	86.44%	8 Missing ⚠️

📢 Thoughts on this report? Let us know!

schlessera · 2025-05-05T22:14:31Z

Thanks for all the work on this, @petitphp !

petitphp force-pushed the feature/pluck-patch-cache-transient branch from 8787b05 to f31a3dd Compare July 31, 2023 19:49

petitphp marked this pull request as ready for review August 23, 2023 22:18

petitphp requested a review from a team as a code owner August 23, 2023 22:18

danielbachhuber requested changes Aug 29, 2023

View reviewed changes

petitphp force-pushed the feature/pluck-patch-cache-transient branch from 4f765d0 to 6e5ecdf Compare September 7, 2023 08:06

petitphp force-pushed the feature/pluck-patch-cache-transient branch 10 times, most recently from 6cd56d8 to e75e7c1 Compare September 18, 2023 14:11

danielbachhuber mentioned this pull request Sep 18, 2023

Resolve duplicate copies of RecursiveDataStructureTraverser wp-cli/wp-cli#5837

Closed

danielbachhuber requested changes Sep 18, 2023

View reviewed changes

petitphp requested a review from danielbachhuber December 12, 2023 08:32

danielbachhuber mentioned this pull request Jan 30, 2024

Release checklist for v2.10.0 wp-cli/wp-cli#5891

Closed

36 tasks

petitphp force-pushed the feature/pluck-patch-cache-transient branch from b9d6f5e to d8ef33a Compare April 26, 2024 08:36

petitphp and others added 25 commits August 4, 2024 18:03

add pluck command to cache

7292638

add pluck command to transient

8e1b63d

add patch command to cache

6e286af

add patch command to transient

bd13459

Add missing expiration option for patch cache command

05424ec

Fix cs

ca02d28

Update Behat features tests

15ad011

Split features for patch/pluck commands into their own file and use `When I run` for commands when they have a successful outcome.

Add temporary log to debug failing tests in github action

ba1f610

Small CS fixes for WPCS v3

6b8d91c

Fix failing functional tests

a70e2d7

Add tests for RecursiveDataStructureTraverser.php

5d0e6df

Fix wrong command in docblock

dd9eec3

Co-authored-by: Daniel Bachhuber <[email protected]>

Fix CS issue

d174717

Co-authored-by: Daniel Bachhuber <[email protected]>

Reuse has_stdin() from framework

ae6d0a6

Fix PHPCS issues

b74bc47

Use wp eval to set the transient

d28445f

split patch feature tests and add additionnal checks with `transien…

b1afe2e

…t get`

split patch feature tests for site transient and add additionnal ch…

8d9ba42

…ecks

Add test cases for invalid keys

7d3a483

Refactor pluck feature tests to use wp eval to set the transient

d061301

new feature test for calling cache pluck command with invalid key

cf568fb

add the new commands to the composer.json

3fa7fe1

use string interpolation for building message

119c991

Co-authored-by: Pascal Birchler <[email protected]>

explicitly call update methods for clearer code

2d17185

Co-authored-by: Pascal Birchler <[email protected]>

fix tests

9eca4d9

schlessera force-pushed the feature/pluck-patch-cache-transient branch from 44903e8 to 9eca4d9 Compare August 4, 2024 16:03

Merge branch 'main' into feature/pluck-patch-cache-transient

de71744

schlessera merged commit 1d789af into wp-cli:main May 5, 2025
42 of 43 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add pluck/patch commands for caches and transients #89

Add pluck/patch commands for caches and transients #89

petitphp commented Jul 25, 2023 •

edited by danielbachhuber

Loading

petitphp commented Aug 28, 2023 •

edited

Loading

danielbachhuber left a comment

swissspidy commented Aug 30, 2023

petitphp commented Sep 7, 2023 •

edited

Loading

petitphp commented Sep 7, 2023

petitphp commented Sep 18, 2023

danielbachhuber left a comment

danielbachhuber Sep 18, 2023

petitphp Dec 1, 2023 •

edited

Loading

danielbachhuber Sep 18, 2023

petitphp Dec 1, 2023

johnbillion commented Nov 10, 2023

petitphp commented Nov 15, 2023

petitphp commented Dec 12, 2023

swissspidy commented Jan 8, 2024

petitphp commented Apr 19, 2024

codecov bot commented May 5, 2025

schlessera commented May 5, 2025

Add pluck/patch commands for caches and transients #89

Add pluck/patch commands for caches and transients #89

Conversation

petitphp commented Jul 25, 2023 • edited by danielbachhuber Loading

petitphp commented Aug 28, 2023 • edited Loading

danielbachhuber left a comment

Choose a reason for hiding this comment

swissspidy commented Aug 30, 2023

petitphp commented Sep 7, 2023 • edited Loading

petitphp commented Sep 7, 2023

petitphp commented Sep 18, 2023

danielbachhuber left a comment

Choose a reason for hiding this comment

danielbachhuber Sep 18, 2023

Choose a reason for hiding this comment

petitphp Dec 1, 2023 • edited Loading

Choose a reason for hiding this comment

danielbachhuber Sep 18, 2023

Choose a reason for hiding this comment

petitphp Dec 1, 2023

Choose a reason for hiding this comment

johnbillion commented Nov 10, 2023

petitphp commented Nov 15, 2023

petitphp commented Dec 12, 2023

swissspidy commented Jan 8, 2024

petitphp commented Apr 19, 2024

codecov bot commented May 5, 2025

Codecov Report

schlessera commented May 5, 2025

petitphp commented Jul 25, 2023 •

edited by danielbachhuber

Loading

petitphp commented Aug 28, 2023 •

edited

Loading

petitphp commented Sep 7, 2023 •

edited

Loading

petitphp Dec 1, 2023 •

edited

Loading