VIP Cache Manager: implement "Purge page and its assets" admin bar button #1880

rinatkhaziev · 2020-11-24T02:38:26Z

Description

This PR adds an Admin Bar button that allows a user to purge the current page and all its external (as opposed to inline) styles and scripts.

Checklist

Please make sure the items below have been covered before requesting a review:

This change works and has been tested locally (or has an appropriate fallback).
This change works and has been tested on a Go sandbox.
This change has relevant unit tests (if applicable).
This change has relevant documentation additions / updates (if applicable).

Steps to Test

Check out PR.
Make sure you're logged in.
Go to any frontend page and verify the button is there and working
Verify cookies are delicious.

Considerations

Do we also want to display the button in the admin to allow purging the assets for Dashboard requests?
Do we want to add a filter to allow users to adjust the needed capability? Currently, it's hardcoded for manage_options which may limit the usefulness.

…tton

vip-cache-manager/js/admin-bar.js

mjangda · 2020-11-24T16:12:19Z

Nice work! Quick thought: we should add some stats for how often this is used and by which sites (probably easiest using Automattic\VIP\Stats\send_pixel().

GaryJones · 2020-11-25T10:37:18Z

vip-cache-manager/js/admin-bar.js

+			btn.removeEventListener('click', onClickHandler);
+		} catch (err) {
+			purgeQueried = false;
+			btn.textContent = '❌ Cache Purge Failed';


Is there the option to use https://make.wordpress.org/accessibility/handbook/markup/wp-a11y-speak/ here, so that screen reader users get notified on the success / failure of the action?

vip-cache-manager/vip-cache-manager.php

rinatkhaziev · 2020-12-09T19:39:31Z

@mjangda I've added the send_pixel in 2fa146f, do you think that's sufficient or overengineered?

vip-cache-manager/vip-cache-manager.php

…-go-cache-manager-action and vip-go-cache-manager-url-purge-by-site for unsuccessful requests

rinatkhaziev · 2020-12-10T01:08:54Z

@mjangda I've recreated your suggestions via a separate commit.

mjangda

Overall this looks pretty solid. Spotted a couple of small things.

vip-cache-manager/js/admin-bar.js

mjangda · 2020-12-10T23:04:02Z

vip-cache-manager/vip-cache-manager.php

+			wp_send_json_error( [ 'error' => 'Malformed payload' ], 400 );
+		}
+
+		if ( ! ( current_user_can( 'manage_options' ) && isset( $req->nonce ) && wp_verify_nonce( $req->nonce, 'purge-page' ) ) ) {


I would split these up because it's very easy to introduce a mistake with a long conditional like this. We can then also separate the deny stats into deny-permissions and deny-nonce.

Good point, will address.

Ok, I've split the check into two, as proposed.

mjangda · 2020-12-10T23:05:36Z

vip-cache-manager/js/admin-bar.js

@@ -0,0 +1,69 @@
+(async () => {


This javascript file needs more ( nacin spacin ) :)

Prettier doesn't like ( nacin spacin ) but let me see what I can do short of fixing each occurrence manually :)

Applied eslint-config-wpvip to the file (will work on adding it to the repo in a separate PR)

vip-cache-manager/js/admin-bar.js

@mjangda

props @mjangda Co-authored-by: Mohammad Jangda <[email protected]>

…issions and the other one for nonces to make it less error-prone and easier to digest

Otherwise load order issues can mean that our onClick doesn't actually register.

No point in triggering a success status there.

mjangda · 2020-12-15T16:22:55Z

Props @emrikol for the initial pass at this!

mjangda

Tested and working great!

netsuso · 2020-12-15T19:59:00Z

stacks-r1307

VIP Cache Manager: implement "Purge page and its assets" admin bar bu…

283ec4b

…tton

rinatkhaziev requested a review from a team as a code owner November 24, 2020 02:38

mjangda reviewed Nov 24, 2020

View reviewed changes

vip-cache-manager/js/admin-bar.js Outdated Show resolved Hide resolved

GaryJones reviewed Nov 25, 2020

View reviewed changes

vip-cache-manager/vip-cache-manager.php Show resolved Hide resolved

rinatkhaziev and others added 2 commits December 8, 2020 10:35

Merge branch 'master' into add/purge-cache-page-button

d3315ff

Track usage via send_pixel

2fa146f

rinatkhaziev added the [Status] Needs Review label Dec 9, 2020

mjangda reviewed Dec 9, 2020

View reviewed changes

vip-cache-manager/vip-cache-manager.php Outdated Show resolved Hide resolved

mjangda reviewed Dec 9, 2020

View reviewed changes

vip-cache-manager/vip-cache-manager.php Outdated Show resolved Hide resolved

mjangda reviewed Dec 9, 2020

View reviewed changes

vip-cache-manager/vip-cache-manager.php Outdated Show resolved Hide resolved

Address send_pixel feedback: make keys more specific, don't track vip…

4c5d320

…-go-cache-manager-action and vip-go-cache-manager-url-purge-by-site for unsuccessful requests

Merge branch 'master' into add/purge-cache-page-button

1614ed1

mjangda reviewed Dec 10, 2020

View reviewed changes

rinatkhaziev and others added 9 commits December 10, 2020 21:38

Remove unnecessary template literal

488d104

props @mjangda Co-authored-by: Mohammad Jangda <[email protected]>

ESlint - 'nacin spacin'

71ef853

s/purgeQueried/purgeInProgress/ - better naming

5f07add

Split compound conditional for auth check into two - the one for perm…

4c77f11

…issions and the other one for nonces to make it less error-prone and easier to digest

Merge branch 'master' into add/purge-cache-page-button

49701c8

Merge branch 'master' into add/purge-cache-page-button

56425cd

Wait until DOMContentLoaded

be7c89a

Otherwise load order issues can mean that our onClick doesn't actually register.

Prevent the default on button click

b1ff7ab

Bail early if we don't have any URLs to purge

879f958

No point in triggering a success status there.

mjangda approved these changes Dec 15, 2020

View reviewed changes

brandon-m-skinner added [Status] Ready to Deploy and removed [Status] Needs Review labels Dec 15, 2020

netsuso merged commit 0691ba6 into master Dec 15, 2020

netsuso deleted the add/purge-cache-page-button branch December 15, 2020 19:51

netsuso added [Status] Deployed to production and removed [Status] Ready to Deploy labels Dec 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VIP Cache Manager: implement "Purge page and its assets" admin bar button #1880

VIP Cache Manager: implement "Purge page and its assets" admin bar button #1880

rinatkhaziev commented Nov 24, 2020 •

edited

Loading

mjangda commented Nov 24, 2020

GaryJones Nov 25, 2020

rinatkhaziev commented Dec 9, 2020

rinatkhaziev commented Dec 10, 2020

mjangda left a comment

mjangda Dec 10, 2020

rinatkhaziev Dec 11, 2020

rinatkhaziev Dec 11, 2020

mjangda Dec 10, 2020

rinatkhaziev Dec 11, 2020

rinatkhaziev Dec 12, 2020

mjangda commented Dec 15, 2020

mjangda left a comment

netsuso commented Dec 15, 2020

VIP Cache Manager: implement "Purge page and its assets" admin bar button #1880

VIP Cache Manager: implement "Purge page and its assets" admin bar button #1880

Conversation

rinatkhaziev commented Nov 24, 2020 • edited Loading

Description

Checklist

Steps to Test

Considerations

mjangda commented Nov 24, 2020

GaryJones Nov 25, 2020

Choose a reason for hiding this comment

rinatkhaziev commented Dec 9, 2020

rinatkhaziev commented Dec 10, 2020

mjangda left a comment

Choose a reason for hiding this comment

mjangda Dec 10, 2020

Choose a reason for hiding this comment

rinatkhaziev Dec 11, 2020

Choose a reason for hiding this comment

rinatkhaziev Dec 11, 2020

Choose a reason for hiding this comment

mjangda Dec 10, 2020

Choose a reason for hiding this comment

rinatkhaziev Dec 11, 2020

Choose a reason for hiding this comment

rinatkhaziev Dec 12, 2020

Choose a reason for hiding this comment

mjangda commented Dec 15, 2020

mjangda left a comment

Choose a reason for hiding this comment

netsuso commented Dec 15, 2020

rinatkhaziev commented Nov 24, 2020 •

edited

Loading