Refactor JS snippet to use WP AJAX #109
Conversation
The custom GET request intercepts normal page generation and might trigger other plugins' actions before Statify is loaded. It also provided an open door for lightweight malicious requests targeting the statistics. Using WP AJAX including Nonce verification reduces both problems.
statify.php
Outdated
| @@ -20,6 +20,7 @@ | |||
| define( 'STATIFY_FILE', __FILE__ ); | |||
| define( 'STATIFY_DIR', dirname( __FILE__ ) ); | |||
| define( 'STATIFY_BASE', plugin_basename( __FILE__ ) ); | |||
| define( 'STATIFY_VERSION', '1.6.3' ); | |||
There was a problem hiding this comment.
Absolutely (if we don‘t add this to 1.6.x - and I don‘t think so - or postpone this to 1.8 obviously)
| /** | ||
| * Track the page view via AJAX. | ||
| * | ||
| * @return void |
There was a problem hiding this comment.
In my mind there is not helpful. Also the hint on phpdoc - This tag should not be used for constructors or methods defined with a void return type.
There was a problem hiding this comment.
We're using this tag in 15 places... Apparently all introduced by myself (default pattern in my IDE because it's mandatory in most of my styleguides - and btw. the PHPdoc ref marks this as "MAY be omitted").
We shouldn't mix it up, so either remove all or none.
Along with some int(eger) and bool(ean) tags probably little out of scope of this PR.
There was a problem hiding this comment.
Yes, plugincollektiv need a style guide, simplest way is the WP codex. In this context it is only a hint and the result of different views, works outside of the pluginkollektiv projects. Feel free to leave that or remove all ;)
|
Hi @stklcode |
stklcode
force-pushed
the
refactorJsAjax
branch
from
d97f297 to
7705dff
Compare
The current JavaScript tracking method issues a GET-request to the home page with two parameters,
statify_referrerandstatify_target. As a result the usual WP page is processed, due to the parameters without caching (at least with the most comon caching plugins).As mehtioned in #100 the tracking call might take long time depending on the actual setup (seen times up to 2s). That's because the request is intercepted and completed after Statify has been intialized. And that is typically not the first plugin loaded.
This PR replaces the custom GET tracking method by a POST call to a WP AJAX action. On AJAX calls the overhead is far less than on actual page generation, because many plugins opt-out immediately.
PS: I already tagged some changes in the PHP code with
@since 1.7.0, because I don't see this change to appear in any 1.6.x release obviously. Doesn't mean anything however, might be rescheduled to any milestone 😃