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

Create lookup_notes method to bypass woocommerce_note_where_clauses filter. (https://github.com/woocommerce/woocommerce-admin/pull/8387) 

* Add args_to_where_clauses() and lookup_notes() methods to Admin\Notes\DataStore.
For use by internal code to bypass woocommerce_note_where_clauses filter.

* Changelog for 8385/8387.

* Add some linter whitelist notation to preexisting warnings in class-wc-test-notes-data-store.

* Add unit tests for the differences between lookup_notes() and get_notes().

* Minor text fix in changelog for 8385/8387.

* Better explanation in pagination tests in test_lookup_notes_versus_get_notes().

* All Notes created by WC_Tests_Notes_Data_Store should have source and name values.

* Add tearDown method to WC_Tests_Notes_Data_Store to delete test-created Notes.
This commit is contained in:
Jacob Sewell 2022-03-15 14:24:09 -05:00 committed by GitHub
parent f37af20b5f
commit 463394f3db
3 changed files with 134 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce-admin/changelogs/add-8385-lookup_notes-method Normal file
View File

@ -0,0 +1,4 @@
Significance: minor
Type: Enhancement
Add internal methods to Notes DataStore to retrieve notes without paging or application of woocommerce_note_where_clauses filter. #8387

56
plugins/woocommerce-admin/src/Notes/DataStore.php
View File

@ -353,6 +353,29 @@ class DataStore extends \WC_Data_Store_WP implements \WC_Object_Data_Store_Inter
return $wpdb->get_results( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
}
/**
* Return an ordered list of notes, without paging or applying the 'woocommerce_note_where_clauses' filter.
* INTERNAL: This method is not intended to be used by external code, and may change without notice.
*
* @param array $args Query arguments.
* @return array An array of database records.
*/
public function lookup_notes( $args = array() ) {
global $wpdb;
$defaults = array(
'order' => 'DESC',
'orderby' => 'date_created',
);
$args = wp_parse_args( $args, $defaults );
$where_clauses = $this->args_to_where_clauses( $args );
$query = "SELECT * FROM {$wpdb->prefix}wc_admin_notes WHERE 1=1{$where_clauses} ORDER BY {$args['orderby']} {$args['order']}";
return $wpdb->get_results( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
}
/**
* Return a count of notes.
*
@ -402,11 +425,34 @@ class DataStore extends \WC_Data_Store_WP implements \WC_Object_Data_Store_Inter
/**
* Return where clauses for getting notes by status and type. For use in both the count and listing queries.
* Applies woocommerce_note_where_clauses filter.
*
* @uses args_to_where_clauses
* @param array $args Array of args to pass.
* @return string Where clauses for the query.
*/
public function get_notes_where_clauses( $args = array() ) {
$where_clauses = $this->args_to_where_clauses( $args );
/**
* Filter the notes WHERE clause before retrieving the data.
*
* Allows modification of the notes select criterial.
*
* @param string $where_clauses The generated WHERE clause.
* @param array $args The original arguments for the request.
*/
return apply_filters( 'woocommerce_note_where_clauses', $where_clauses, $args );
}
/**
* Return where clauses for notes queries without applying woocommerce_note_where_clauses filter.
* INTERNAL: This method is not intended to be used by external code, and may change without notice.
*
* @param array $args Array of arguments for query conditionals.
* @return string Where clauses.
*/
protected function args_to_where_clauses( $args = array() ) {
$allowed_types = Note::get_allowed_types();
$where_type_array = $this->get_escaped_arguments_array_by_key( $args, 'type', $allowed_types );
@ -451,15 +497,7 @@ class DataStore extends \WC_Data_Store_WP implements \WC_Object_Data_Store_Inter
$where_clauses .= $escaped_is_deleted ? ' AND is_deleted = 1' : ' AND is_deleted = 0';
/**
* Filter the notes WHERE clause before retrieving the data.
*
* Allows modification of the notes select criterial.
*
* @param string $where_clauses The generated WHERE clause.
* @param array $args The original arguments for the request.
*/
return apply_filters( 'woocommerce_note_where_clauses', $where_clauses, $args );
return $where_clauses;
}
/**

85
plugins/woocommerce-admin/tests/notes/class-wc-tests-notes-data-store.php
View File

@ -59,6 +59,8 @@ class WC_Tests_Notes_Data_Store extends WC_Unit_Test_Case {
$data_store = WC_Data_Store::load( 'admin-note' );
$note = new Note();
$note->set_name( 'PHPUNIT_TEST_NOTE_NAME' );
$note->set_source( 'PHPUNIT_TEST' );
$note->set_title( 'PHPUNIT_TEST_NOTE' );
$note->set_content( 'PHPUNIT_TEST_NOTE_CONTENT' );
$note->save();
@ -109,6 +111,7 @@ class WC_Tests_Notes_Data_Store extends WC_Unit_Test_Case {
for ( $i = 0; $i < 3; $i++ ) {
$note = new Note();
$note->set_name( $note_name );
$note->set_source( 'PHPUNIT_TEST' );
$note->set_title( 'PHPUNIT_TEST_NOTE' );
$note->set_content( 'PHPUNIT_TEST_NOTE_CONTENT' );
$note->save();
@ -160,6 +163,7 @@ class WC_Tests_Notes_Data_Store extends WC_Unit_Test_Case {
for ( $i = 0; $i < 3; $i++ ) {
$note = new Note();
$note->set_name( $note_name );
$note->set_source( 'PHPUNIT_TEST' );
$note->set_title( 'PHPUNIT_TEST_NOTE' );
$note->set_content( 'PHPUNIT_TEST_NOTE_CONTENT' );
$note->save();
@ -210,6 +214,7 @@ class WC_Tests_Notes_Data_Store extends WC_Unit_Test_Case {
// Create a test note.
$note = new Note();
$note->set_name( 'PHPUNIT_TEST_NOTE_NAME' );
$note->set_source( 'PHPUNIT_TEST' );
$note->set_title( 'PHPUNIT_TEST_NOTE_TITLE' );
$note->set_content( 'PHPUNIT_TEST_NOTE_CONTENT' );
$note->save();
@ -223,7 +228,7 @@ class WC_Tests_Notes_Data_Store extends WC_Unit_Test_Case {
$mock_datastore->method( 'read' )->will( $this->throwException( new \Exception() ) );
// Suppress deliberately caused errors.
$log_file = ini_set( 'error_log', '/dev/null' );
$log_file = ini_set( 'error_log', '/dev/null' ); // phpcs:ignore WordPress.PHP.IniSet.Risky
$filter_datastore = function() use ( $mock_datastore ) {
return $mock_datastore;
@ -236,7 +241,7 @@ class WC_Tests_Notes_Data_Store extends WC_Unit_Test_Case {
remove_filter( 'woocommerce_admin-note_data_store', $filter_datastore );
ini_set( 'error_log', $log_file );
ini_set( 'error_log', $log_file ); // phpcs:ignore WordPress.PHP.IniSet.Risky
$this->assertFalse( $note );
$this->assertEquals( 1, did_action( 'woocommerce_caught_exception' ) );
@ -272,4 +277,80 @@ class WC_Tests_Notes_Data_Store extends WC_Unit_Test_Case {
$where_clause
);
}
/**
* Test the differences between lookup_notes() and get_notes()
*/
public function test_lookup_notes_versus_get_notes() {
// Create two test notes.
for ( $i = 0; $i < 2; $i++ ) {
$note = new Note();
$note->set_title( 'PHPUNIT_PAGING_TEST_NOTE_' . $i );
$note->set_content( 'PHPUNIT_PAGING_TEST_NOTE_CONTENT' );
$note->set_type( Note::E_WC_ADMIN_NOTE_INFORMATIONAL );
$note->set_name( 'PHPUNIT_PAGING_TEST_NOTE_NAME' );
$note->set_source( 'PHPUNIT_TEST' );
$note->set_is_snoozable( false );
$note->set_layout( 'plain' );
$note->set_image( '' );
$note->add_action(
'PHPUNIT_TEST_ACTION_SLUG',
'PHPUNIT_TEST_ACTION_LABEL',
'?s=PHPUNIT_TEST_ACTION_URL'
);
$note->set_is_deleted( false );
$note->save();
}
// Add filter for 'woocommerce_note_where_clauses' that should be called only once.
$filter_hit_count = 0;
$filter_callback = function( $arg ) use ( &$filter_hit_count ) {
$filter_hit_count++;
return $arg;
};
add_filter( 'woocommerce_note_where_clauses', $filter_callback, 1 );
// Retrieve test notes by lookup_notes and get_notes.
$data_store = WC_Data_Store::load( 'admin-note' );
$args = array(
'source' => array( 'PHPUNIT_TEST' ),
'name' => array( 'PHPUNIT_PAGING_TEST_NOTE_NAME' ),
'per_page' => 1, // lookup_notes should ignore this.
);
$lookup_result = $data_store->lookup_notes( $args );
$get_result = $data_store->get_notes( $args );
// We should have hit the filter exactly once.
$this->assertEquals( $filter_hit_count, 1 );
// We should have two notes in the lookup_result, because lookup_notes() ignores the 'per_page' arg.
$this->assertEquals( count( $lookup_result ), 2 );
// We should have one note in the get_result, because get_notes() respects the 'per_page' arg.
$this->assertEquals( count( $get_result ), 1 );
// Lookup and get should return well-formed Notes.
$lookup_note_zero = new Note();
$lookup_note_zero->set_id( $lookup_result[0]->note_id );
$data_store->read( $lookup_note_zero );
$get_note_zero = new Note();
$get_note_zero->set_id( $get_result[0]->note_id );
$data_store->read( $get_note_zero );
// The first note in each result set should be the same.
$this->assertEquals( $lookup_note_zero->get_id(), $get_note_zero->get_id() );
}
/**
* Delete notes created by this class's tests.
*/
public function tearDown() {
global $wpdb;
parent::tearDown();
$wpdb->query( $wpdb->prepare( 'DELETE n.*, a.* FROM ' . $wpdb->prefix . 'wc_admin_notes n JOIN ' . $wpdb->prefix . 'wc_admin_note_actions a ON n.note_id = a.note_id WHERE n.source = %s', 'PHPUNIT_TEST' ) );
}
}