Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add validations to `recordEvent` (#33911) 

* Add validations to `recordEvent`

* Add changelog

* Use always class constant

* Changed trow exception by console.error

* Add tests to `validate_and_sanitize`

* Created 2 different methods to test `event_validation_and_sanitization`

* Fix tests

Co-authored-by: Fernando Marichal <contacto@fernandomarichal.com>
This commit is contained in:
Fernando 2022-07-21 16:11:32 -03:00 committed by GitHub
parent 1ca37cb74b
commit 59c9ef7922
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 86 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce/changelog/add-validation-for-event-recording-on-client Normal file
View File

@ -0,0 +1,4 @@
Significance: patch
Type: add
Add validations to recordEvent #33911

10
plugins/woocommerce/includes/tracks/class-wc-site-tracking.php
View File

@ -93,6 +93,16 @@ class WC_Site_Tracking {
delete( eventProperties._ui );
delete( eventProperties._ut );
}
// Verify the event name is correct
if ( ! <?php echo esc_js( WC_Tracks_Event::EVENT_NAME_REGEX ); ?>.test( eventName ) ) {
console.error( `A valid event name must be specified. The event name: "${ eventName }" is not valid.` );
}
// Verify the properties are correct
for( prop in eventProperties ) {
if ( ! <?php echo esc_js( WC_Tracks_Event::PROP_NAME_REGEX ); ?>.test( prop ) ) {
console.error( `A valid prop name must be specified. The property name: "${ prop }" is not valid.` );
}
}
window._tkq = window._tkq || [];
window._tkq.push( [ 'recordEvent', eventName, eventProperties ] );
}

6
plugins/woocommerce/includes/tracks/class-wc-tracks-event.php
View File

@ -17,12 +17,12 @@ class WC_Tracks_Event {
/**
* Event name regex.
*/
const EVENT_NAME_REGEX = '/^(([a-z0-9]+)_){2}([a-z0-9_]+)$/';
public const EVENT_NAME_REGEX = '/^(([a-z0-9]+)_){2}([a-z0-9_]+)$/';
/**
* Property name regex.
*/
const PROP_NAME_REGEX = '/^[a-z_][a-z0-9_]*$/';
public const PROP_NAME_REGEX = '/^[a-z_][a-z0-9_]*$/';
/**
* Error message as WP_Error.
@ -97,7 +97,7 @@ class WC_Tracks_Event {
}
foreach ( array_keys( (array) $_event ) as $key ) {
if ( ! self::prop_name_is_valid( $key ) ) {
if ( ! self::prop_name_is_valid( $key ) && '_en' !== $key ) {
return new WP_Error( 'invalid_prop_name', __( 'A valid prop name must be specified', 'woocommerce' ) );
}
}

69
plugins/woocommerce/tests/php/includes/class-wc-tracks-test.php
View File

@ -14,6 +14,7 @@ class WC_Tracks_Test extends \WC_Unit_Test_Case {
parent::setUp();
include_once WC_ABSPATH . 'includes/tracks/class-wc-tracks.php';
include_once WC_ABSPATH . 'includes/tracks/class-wc-tracks-client.php';
include_once WC_ABSPATH . 'includes/tracks/class-wc-tracks-event.php';
}
/**
@ -60,4 +61,72 @@ class WC_Tracks_Test extends \WC_Unit_Test_Case {
$this->assertNotEquals( 'bad', $properties['_ut'] );
}
/**
* Test the event validation and sanitization with a valid event.
*/
public function test_event_validation_and_sanitization_valid_event() {
$event_props = array(
'_en' => 'valid_event_name',
'_ts' => WC_Tracks_Client::build_timestamp(),
'valid_property' => 'My value',
'_via_ip' => '192.168.10.1',
);
// Valid event and property names.
$event = \WC_Tracks_Event::validate_and_sanitize( $event_props );
$this->assertTrue( property_exists( $event, 'browser_type' ) );
$this->assertTrue( property_exists( $event, '_ts' ) );
$this->assertTrue( property_exists( $event, 'valid_property' ) );
$this->assertFalse( property_exists( $event, '_via_ip' ) );
}
/**
* Test the event validation and sanitization with an invalid event.
*/
public function test_event_validation_and_sanitization_invalid_event_name() {
$event_props = array(
'_en' => 'valid_event_name',
'_ts' => WC_Tracks_Client::build_timestamp(),
'valid_property' => 'My value',
'_via_ip' => '192.168.10.1',
);
// Invalid event name.
$event = \WC_Tracks_Event::validate_and_sanitize(
array_merge(
$event_props,
array( '_en' => 'invalidName' )
)
);
$this->assertTrue( is_wp_error( $event ) );
$this->assertEquals( $event->get_error_code(), 'invalid_event_name' );
$event = \WC_Tracks_Event::validate_and_sanitize(
array_merge(
$event_props,
array( '_en' => 'invalid-name' )
)
);
$this->assertTrue( is_wp_error( $event ) );
$this->assertEquals( $event->get_error_code(), 'invalid_event_name' );
// Invalid property name.
$event = \WC_Tracks_Event::validate_and_sanitize(
array_merge(
$event_props,
array( 'invalid-property-name' => 'My value' )
)
);
$this->assertTrue( is_wp_error( $event ) );
$this->assertEquals( $event->get_error_code(), 'invalid_prop_name' );
$event = \WC_Tracks_Event::validate_and_sanitize(
array_merge(
$event_props,
array( 'invalid property name' => 'My value' )
)
);
$this->assertTrue( is_wp_error( $event ) );
$this->assertEquals( $event->get_error_code(), 'invalid_prop_name' );
}
}