Skip to content

Commit 6c72b8b

Browse files
tyxlajeherve
tyxla
authored and
jeherve
committed
Jetpack Standards: introduce new package.
This package: - moves files that could be used by other projects as is, so they can be installed via a Composer package. - add settings files to help set up a repository via webhooks.
1 parent 6d51bfb commit 6c72b8b

25 files changed

+567
-87
lines changed

‎.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,15 @@ phpcs.xml
4040

4141
!/docker/wordpress/.gitkeep
4242

43+
## Things provided by jetpack-standards
44+
## Some may want to commit these files, other may not. We're not.
45+
.github/labels.json
46+
.github/settings.json
47+
/.editorconfig
48+
/.eslines.json
49+
/.npmrc
50+
/.prettierrc
51+
4352
# Don't list files below this comment if they need to be ignored for bundling the Jetpack release.
4453
# From here on, we only list files that are generated by a build process, ignored in git, but should be present in SVN.
4554
#

‎_inc/lib/admin-pages/class.jetpack-settings-page.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
use Automattic\Jetpack\Tracking\Manager as JetpackTracking;
3+
use Automattic\Jetpack\Tracking;
44

55
include_once( 'class.jetpack-admin-page.php' );
66
include_once( JETPACK__PLUGIN_DIR . 'class.jetpack-modules-list-table.php' );
@@ -120,7 +120,7 @@ function page_render() {
120120
</div><!-- /.content -->
121121
<?php
122122

123-
JetpackTracking::record_user_event( 'wpa_page_view', array( 'path' => 'old_settings' ) );
123+
Tracking::record_user_event( 'wpa_page_view', array( 'path' => 'old_settings' ) );
124124
}
125125

126126
/**

‎class.jetpack-client-server.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
use Automattic\Jetpack\Tracking\Manager as JetpackTracking;
3+
use Automattic\Jetpack\Tracking;
44

55
/**
66
* Client = Plugin
@@ -22,7 +22,7 @@ function client_authorize() {
2222
$result = $this->authorize( $data );
2323
if ( is_wp_error( $result ) ) {
2424
Jetpack::state( 'error', $result->get_error_code() );
25-
JetpackTracking::record_user_event( 'jpc_client_authorize_fail', array(
25+
Tracking::record_user_event( 'jpc_client_authorize_fail', array(
2626
'error_code' => $result->get_error_code(),
2727
'error_message' => $result->get_error_message()
2828
) );
@@ -45,7 +45,7 @@ function client_authorize() {
4545
wp_safe_redirect( Jetpack::admin_url() );
4646
}
4747

48-
JetpackTracking::record_user_event( 'jpc_client_authorize_success' );
48+
Tracking::record_user_event( 'jpc_client_authorize_success' );
4949

5050
$this->do_exit();
5151
}

‎class.jetpack-xmlrpc-server.php‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
use Automattic\Jetpack\Tracking\Manager as JetpackTracking;
3+
use Automattic\Jetpack\Tracking;
44
/**
55
* Just a sack of functions. Not actually an IXR_Server
66
*/
@@ -96,7 +96,7 @@ function provision_xmlrpc_methods() {
9696

9797
function remote_authorize( $request ) {
9898
$user = get_user_by( 'id', $request['state'] );
99-
JetpackTracking::record_user_event( 'jpc_remote_authorize_begin', array(), $user );
99+
Tracking::record_user_event( 'jpc_remote_authorize_begin', array(), $user );
100100

101101
foreach( array( 'secret', 'state', 'redirect_uri', 'code' ) as $required ) {
102102
if ( ! isset( $request[ $required ] ) || empty( $request[ $required ] ) ) {
@@ -127,7 +127,7 @@ function remote_authorize( $request ) {
127127
return $this->error( $result, 'jpc_remote_authorize_fail' );
128128
}
129129

130-
JetpackTracking::record_user_event( 'jpc_remote_authorize_success' );
130+
Tracking::record_user_event( 'jpc_remote_authorize_success' );
131131

132132
return array(
133133
'result' => $result,
@@ -143,7 +143,7 @@ function remote_authorize( $request ) {
143143
* @return WP_Error|array
144144
*/
145145
public function remote_register( $request ) {
146-
JetpackTracking::record_user_event( 'jpc_remote_register_begin', array() );
146+
Tracking::record_user_event( 'jpc_remote_register_begin', array() );
147147

148148
$user = $this->fetch_and_verify_local_user( $request );
149149

@@ -210,7 +210,7 @@ public function remote_register( $request ) {
210210
}
211211
}
212212

213-
JetpackTracking::record_user_event( 'jpc_remote_register_success' );
213+
Tracking::record_user_event( 'jpc_remote_register_success' );
214214

215215
return array(
216216
'client_id' => Jetpack_Options::get_option( 'id' )
@@ -382,12 +382,12 @@ private function fetch_and_verify_local_user( $request ) {
382382

383383
private function tracks_record_error( $name, $error, $user = null ) {
384384
if ( is_wp_error( $error ) ) {
385-
JetpackTracking::record_user_event( $name, array(
385+
Tracking::record_user_event( $name, array(
386386
'error_code' => $error->get_error_code(),
387387
'error_message' => $error->get_error_message()
388388
), $user );
389389
} elseif( is_a( $error, 'IXR_Error' ) ) {
390-
JetpackTracking::record_user_event( $name, array(
390+
Tracking::record_user_event( $name, array(
391391
'error_code' => $error->code,
392392
'error_message' => $error->message
393393
), $user );
@@ -428,16 +428,16 @@ function verify_action( $params ) {
428428

429429
if ( 'authorize' === $action ) {
430430
$tracks_failure_event_name = 'jpc_verify_authorize_fail';
431-
JetpackTracking::record_user_event( 'jpc_verify_authorize_begin', array(), $user );
431+
Tracking::record_user_event( 'jpc_verify_authorize_begin', array(), $user );
432432
}
433433
if ( 'publicize' === $action ) {
434434
// This action is used on a response from a direct XML-RPC done from WordPress.com
435435
$tracks_failure_event_name = 'jpc_verify_publicize_fail';
436-
JetpackTracking::record_user_event( 'jpc_verify_publicize_begin', array(), $user );
436+
Tracking::record_user_event( 'jpc_verify_publicize_begin', array(), $user );
437437
}
438438
if ( 'register' === $action ) {
439439
$tracks_failure_event_name = 'jpc_verify_register_fail';
440-
JetpackTracking::record_user_event( 'jpc_verify_register_begin', array(), $user );
440+
Tracking::record_user_event( 'jpc_verify_register_begin', array(), $user );
441441
}
442442

443443
if ( empty( $verify_secret ) ) {
@@ -475,13 +475,13 @@ function verify_action( $params ) {
475475
Jetpack::delete_secrets( $action, $state );
476476

477477
if ( 'authorize' === $action ) {
478-
JetpackTracking::record_user_event( 'jpc_verify_authorize_success', array(), $user );
478+
Tracking::record_user_event( 'jpc_verify_authorize_success', array(), $user );
479479
}
480480
if ( 'publicize' === $action ) {
481-
JetpackTracking::record_user_event( 'jpc_verify_publicize_success', array(), $user );
481+
Tracking::record_user_event( 'jpc_verify_publicize_success', array(), $user );
482482
}
483483
if ( 'register' === $action ) {
484-
JetpackTracking::record_user_event( 'jpc_verify_register_success', array(), $user );
484+
Tracking::record_user_event( 'jpc_verify_register_success', array(), $user );
485485
}
486486

487487
return $secrets['secret_2'];

‎class.jetpack.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?php
22

33
use Automattic\Jetpack\Constants;
4-
use Automattic\Jetpack\Tracking\Manager as JetpackTracking;
4+
use Automattic\Jetpack\Tracking;
55

66
/*
77
Options:
@@ -923,7 +923,7 @@ function jetpack_admin_ajax_tracks_callback() {
923923
}
924924
}
925925

926-
JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
926+
Tracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
927927
wp_send_json_success();
928928
wp_die();
929929
}
@@ -3263,7 +3263,7 @@ public static function disconnect( $update_activated_state = true ) {
32633263
// If the site is in an IDC because sync is not allowed,
32643264
// let's make sure to not disconnect the production site.
32653265
if ( ! self::validate_sync_error_idc_option() ) {
3266-
JetpackTracking::record_user_event( 'disconnect_site', array() );
3266+
Tracking::record_user_event( 'disconnect_site', array() );
32673267
Jetpack::load_xml_rpc_client();
32683268
$xml = new Jetpack_IXR_Client();
32693269
$xml->query( 'jetpack.deregister' );
@@ -4030,7 +4030,7 @@ function admin_page_load() {
40304030
$error = $registered->get_error_code();
40314031
Jetpack::state( 'error', $error );
40324032
Jetpack::state( 'error', $registered->get_error_message() );
4033-
JetpackTracking::record_user_event( 'jpc_register_fail', array(
4033+
Tracking::record_user_event( 'jpc_register_fail', array(
40344034
'error_code' => $error,
40354035
'error_message' => $registered->get_error_message()
40364036
) );
@@ -4040,7 +4040,7 @@ function admin_page_load() {
40404040
$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
40414041
$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
40424042

4043-
JetpackTracking::record_user_event( 'jpc_register_success', array(
4043+
Tracking::record_user_event( 'jpc_register_success', array(
40444044
'from' => $from
40454045
) );
40464046

@@ -5032,7 +5032,7 @@ public function validate_remote_register_response( $response ) {
50325032
* @return bool|WP_Error
50335033
*/
50345034
public static function register() {
5035-
JetpackTracking::record_user_event( 'jpc_register_begin' );
5035+
Tracking::record_user_event( 'jpc_register_begin' );
50365036
add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
50375037
$secrets = Jetpack::generate_secrets( 'register' );
50385038

@@ -5838,7 +5838,7 @@ function verify_json_api_authorization_request( $environment = null ) {
58385838

58395839
// Host has encoded the request URL, probably as a result of a bad http => https redirect
58405840
if ( Jetpack::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5841-
JetpackTracking::record_user_event( 'error_double_encode' );
5841+
Tracking::record_user_event( 'error_double_encode' );
58425842

58435843
$die_error = sprintf(
58445844
/* translators: %s is a URL */

‎composer.json‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,8 @@
2020
"automattic/jetpack-tracking": "@dev"
2121
},
2222
"require-dev": {
23-
"dealerdirect/phpcodesniffer-composer-installer": "0.5.0",
24-
"wp-coding-standards/wpcs": "2.1.1",
25-
"sirbrillig/phpcs-variable-analysis": "2.6.4",
26-
"phpcompatibility/phpcompatibility-wp": "2.0.0",
27-
"automattic/jetpack-autoloader": "@dev"
23+
"automattic/jetpack-autoloader": "@dev",
24+
"automattic/jetpack-standards": "@dev"
2825
},
2926
"scripts": {
3027
"php:compatibility": "composer install && vendor/bin/phpcs -p -s --runtime-set testVersion '5.3-' --standard=PHPCompatibilityWP --ignore=docker,tools,tests,node_modules,vendor --extensions=php",

‎composer.lock‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎modules/plugin-search.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
use Automattic\Jetpack\Tracking\Manager as JetpackTracking;
3+
use Automattic\Jetpack\Tracking;
44

55
/**
66
* Disable direct access and execution.
@@ -310,7 +310,7 @@ public function inject_jetpack_module_suggestion( $result, $action, $args ) {
310310

311311
// Record event when user searches for a term over 3 chars (less than 3 is not very useful.)
312312
if ( strlen( $args->search ) >= 3 ) {
313-
JetpackTracking::record_user_event( 'wpa_plugin_search_term', array( 'search_term' => $args->search ) );
313+
Tracking::record_user_event( 'wpa_plugin_search_term', array( 'search_term' => $args->search ) );
314314
}
315315

316316
// Lowercase, trim, remove punctuation/special chars, decode url, remove 'jetpack'
@@ -340,7 +340,7 @@ public function inject_jetpack_module_suggestion( $result, $action, $args ) {
340340

341341
if ( isset( $matching_module ) && $this->should_display_hint( $matching_module ) ) {
342342
// Record event when a matching feature is found
343-
JetpackTracking::record_user_event( 'wpa_plugin_search_match_found', array( 'feature' => $matching_module ) );
343+
Tracking::record_user_event( 'wpa_plugin_search_match_found', array( 'feature' => $matching_module ) );
344344

345345
$inject = (array) self::get_jetpack_plugin_data();
346346
$image_url = plugins_url( 'modules/plugin-search/psh', JETPACK__PLUGIN_FILE );

‎modules/sso.php‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
use Automattic\Jetpack\Tracking\Manager as JetpackTracking;
3+
use Automattic\Jetpack\Tracking;
44

55
require_once( JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-helpers.php' );
66
require_once( JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-notices.php' );
@@ -363,7 +363,7 @@ function login_init() {
363363
Jetpack_options::update_option( 'sso_first_login', true );
364364
}
365365

366-
JetpackTracking::record_user_event( 'sso_login_redirect_success' );
366+
Tracking::record_user_event( 'sso_login_redirect_success' );
367367
wp_safe_redirect( $sso_url );
368368
exit;
369369
}
@@ -382,7 +382,7 @@ function login_init() {
382382
add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) );
383383
$reauth = ! empty( $_GET['force_reauth'] );
384384
$sso_url = $this->get_sso_url_or_die( $reauth );
385-
JetpackTracking::record_user_event( 'sso_login_redirect_bypass_success' );
385+
Tracking::record_user_event( 'sso_login_redirect_bypass_success' );
386386
wp_safe_redirect( $sso_url );
387387
exit;
388388
}
@@ -680,7 +680,7 @@ function handle_login() {
680680
if ( Jetpack_SSO_Helpers::is_two_step_required() && 0 === (int) $user_data->two_step_enabled ) {
681681
$this->user_data = $user_data;
682682

683-
JetpackTracking::record_user_event( 'sso_login_failed', array(
683+
Tracking::record_user_event( 'sso_login_failed', array(
684684
'error_message' => 'error_msg_enable_two_step'
685685
) );
686686

@@ -727,7 +727,7 @@ function handle_login() {
727727

728728
$user = Jetpack_SSO_Helpers::generate_user( $user_data );
729729
if ( ! $user ) {
730-
JetpackTracking::record_user_event( 'sso_login_failed', array(
730+
Tracking::record_user_event( 'sso_login_failed', array(
731731
'error_message' => 'could_not_create_username'
732732
) );
733733
add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_unable_to_create_user' ) );
@@ -738,7 +738,7 @@ function handle_login() {
738738
? 'user_created_new_user_override'
739739
: 'user_created_users_can_register';
740740
} else {
741-
JetpackTracking::record_user_event( 'sso_login_failed', array(
741+
Tracking::record_user_event( 'sso_login_failed', array(
742742
'error_message' => 'error_msg_email_already_exists'
743743
) );
744744

@@ -786,7 +786,7 @@ function handle_login() {
786786

787787
$is_json_api_auth = ! empty( $json_api_auth_environment );
788788
$is_user_connected = Jetpack::is_user_connected( $user->ID );
789-
JetpackTracking::record_user_event( 'sso_user_logged_in', array(
789+
Tracking::record_user_event( 'sso_user_logged_in', array(
790790
'user_found_with' => $user_found_with,
791791
'user_connected' => (bool) $is_user_connected,
792792
'user_role' => Jetpack::translate_current_user_to_role(),
@@ -822,7 +822,7 @@ function handle_login() {
822822

823823
add_filter( 'jetpack_sso_default_to_sso_login', '__return_false' );
824824

825-
JetpackTracking::record_user_event( 'sso_login_failed', array(
825+
Tracking::record_user_event( 'sso_login_failed', array(
826826
'error_message' => 'cant_find_user'
827827
) );
828828

@@ -898,7 +898,7 @@ function get_sso_url_or_die( $reauth = false, $args = array() ) {
898898
$error_message = sanitize_text_field(
899899
sprintf( '%s: %s', $sso_redirect->get_error_code(), $sso_redirect->get_error_message() )
900900
);
901-
JetpackTracking::record_user_event( 'sso_login_redirect_failed', array(
901+
Tracking::record_user_event( 'sso_login_redirect_failed', array(
902902
'error_message' => $error_message
903903
) );
904904
wp_die( $error_message );

‎modules/stats.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* @package Jetpack
1515
*/
1616

17-
use Automattic\Jetpack\Tracking\Manager as JetpackTracking;
17+
use Automattic\Jetpack\Tracking;
1818

1919
if ( defined( 'STATS_VERSION' ) ) {
2020
return;
@@ -707,7 +707,7 @@ function stats_reports_page( $main_chart_only = false ) {
707707
}
708708

709709
if ( isset( $_GET['page'] ) && 'stats' === $_GET['page'] && ! isset( $_GET['chart'] ) ) {
710-
JetpackTracking::record_user_event( 'wpa_page_view', array( 'path' => 'old_stats' ) );
710+
Tracking::record_user_event( 'wpa_page_view', array( 'path' => 'old_stats' ) );
711711
}
712712

713713
if ( isset( $_GET['noheader'] ) ) {

0 commit comments

Comments
 (0)