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

Fix hidden notes in `admin/notes` when the user is not in tasklist experiment (https://github.com/woocommerce/woocommerce-admin/pull/8328) 

* Fix hidden notes from tasklist experiment.

* Add changelog.

* Use PR number instead of issue number in the changelog.
This commit is contained in:
Jaclyn Chen 2022-02-25 08:09:49 +08:00 committed by GitHub
parent 5338ebf04a
commit cb9e6b34df
5 changed files with 143 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce-admin/changelogs/fix-admin_notes_tasklist_experiment Normal file
View File

@ -0,0 +1,4 @@
Significance: patch
Type: Fix
Fix hidden notes in `admin/notes` endpoint when the user is not in the tasklist experiment. #8328

18
plugins/woocommerce-admin/src/API/Notes.php
View File

@ -199,20 +199,8 @@ class Notes extends \WC_REST_CRUD_Controller {
$notes = NotesRepository::get_notes( 'edit', $query_args );
$is_tasklist_experiment_assigned_treatment = $this->is_tasklist_experiment_assigned_treatment();
$data = array();
foreach ( (array) $notes as $note_obj ) {
// Hide selected notes for users not in experiment.
if ( ! $is_tasklist_experiment_assigned_treatment ) {
if ( 'wc-admin-complete-store-details' === $note_obj['name'] ) {
continue;
}
if ( 'wc-admin-update-store-details' === $note_obj['name'] ) {
continue;
}
}
$note = $this->prepare_item_for_response( $note_obj, $request );
$note = $this->prepare_response_for_collection( $note );
$data[] = $note;
@ -278,6 +266,12 @@ class Notes extends \WC_REST_CRUD_Controller {
$args['orderby'] = 'date_created';
}
// Hide selected notes for users not in experiment.
$is_tasklist_experiment_assigned_treatment = $this->is_tasklist_experiment_assigned_treatment();
if ( false === $is_tasklist_experiment_assigned_treatment ) {
$args['excluded_name'] = array( 'wc-admin-complete-store-details', 'wc-admin-update-store-details' );
}
/**
* Filter the query arguments for a request.
*

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

@ -418,14 +418,16 @@ class DataStore extends \WC_Data_Store_WP implements \WC_Object_Data_Store_Inter
$escaped_is_deleted = esc_sql( $args['is_deleted'] );
}
$where_name_array = $this->get_escaped_arguments_array_by_key( $args, 'name' );
$where_source_array = $this->get_escaped_arguments_array_by_key( $args, 'source' );
$where_name_array = $this->get_escaped_arguments_array_by_key( $args, 'name' );
$where_excluded_name_array = $this->get_escaped_arguments_array_by_key( $args, 'excluded_name' );
$where_source_array = $this->get_escaped_arguments_array_by_key( $args, 'source' );
$escaped_where_types = implode( ',', $where_type_array );
$escaped_where_status = implode( ',', $where_status_array );
$escaped_where_names = implode( ',', $where_name_array );
$escaped_where_source = implode( ',', $where_source_array );
$where_clauses = '';
$escaped_where_types = implode( ',', $where_type_array );
$escaped_where_status = implode( ',', $where_status_array );
$escaped_where_names = implode( ',', $where_name_array );
$escaped_where_excluded_names = implode( ',', $where_excluded_name_array );
$escaped_where_source = implode( ',', $where_source_array );
$where_clauses = '';
if ( ! empty( $escaped_where_types ) ) {
$where_clauses .= " AND type IN ($escaped_where_types)";
@ -439,6 +441,10 @@ class DataStore extends \WC_Data_Store_WP implements \WC_Object_Data_Store_Inter
$where_clauses .= " AND name IN ($escaped_where_names)";
}
if ( ! empty( $escaped_where_excluded_names ) ) {
$where_clauses .= " AND name NOT IN ($escaped_where_excluded_names)";
}
if ( ! empty( $escaped_where_source ) ) {
$where_clauses .= " AND source IN ($escaped_where_source)";
}

99
plugins/woocommerce-admin/tests/api/admin-notes.php
View File

@ -216,6 +216,79 @@ class WC_Tests_API_Admin_Notes extends WC_REST_Unit_Test_Case {
$this->assertEquals( 4, count( $notes ) );
}
/**
* Test getting notes when the user is in tasklist experiment returns notes of size `per_page` without any filters.
*
* @since 3.5.0
*/
public function test_getting_notes_when_user_is_in_tasklist_experiment_returns_unfiltered_notes() {
// Given.
wp_set_current_user( $this->user );
WC_Helper_Admin_Notes::reset_notes_dbs();
// Notes of the following two names are hidden when the user is not in the task list experiment.
WC_Helper_Admin_Notes::add_note_for_test( 'wc-admin-complete-store-details' );
WC_Helper_Admin_Notes::add_note_for_test( 'wc-admin-update-store-details' );
// Other notes.
WC_Helper_Admin_Notes::add_note_for_test( 'winter-sales' );
WC_Helper_Admin_Notes::add_note_for_test( '2022-promo' );
$this->set_user_in_tasklist_experiment();
// When.
$request = new WP_REST_Request( 'GET', $this->endpoint );
$request->set_query_params(
array(
'page' => '1',
'per_page' => '3',
)
);
$response = $this->server->dispatch( $request );
$notes = $response->get_data();
// Then.
$this->assertEquals( 200, $response->get_status() );
$this->assertEquals( 3, count( $notes ) );
$this->assertEquals( $notes[0]['name'], 'wc-admin-complete-store-details' );
$this->assertEquals( $notes[1]['name'], 'wc-admin-update-store-details' );
$this->assertEquals( $notes[2]['name'], 'winter-sales' );
}
/**
* Test getting notes when the user is not in tasklist experiment excludes two notes.
*
* @since 3.5.0
*/
public function test_getting_notes_when_user_is_not_in_tasklist_experiment_excludes_two_notes() {
// Given.
wp_set_current_user( $this->user );
WC_Helper_Admin_Notes::reset_notes_dbs();
// Notes of the following two names are hidden when the user is not in the task list experiment.
WC_Helper_Admin_Notes::add_note_for_test( 'wc-admin-complete-store-details' );
WC_Helper_Admin_Notes::add_note_for_test( 'wc-admin-update-store-details' );
// Other notes.
WC_Helper_Admin_Notes::add_note_for_test( 'summer-sales' );
WC_Helper_Admin_Notes::add_note_for_test( '2022-promo' );
$this->set_user_out_of_tasklist_experiment();
// When.
$request = new WP_REST_Request( 'GET', $this->endpoint );
$request->set_query_params(
array(
'page' => '1',
'per_page' => '3',
)
);
$response = $this->server->dispatch( $request );
$notes = $response->get_data();
// Then.
$this->assertEquals( 200, $response->get_status() );
$this->assertEquals( 2, count( $notes ) );
$this->assertEquals( $notes[0]['name'], 'summer-sales' );
$this->assertEquals( $notes[1]['name'], '2022-promo' );
}
/**
* Test getting notes of a certain type.
*
@ -545,4 +618,30 @@ class WC_Tests_API_Admin_Notes extends WC_REST_Unit_Test_Case {
$this->assertEquals( 200, $response->get_status() );
$this->assertEquals( 2, count( $notes ) );
}
/**
* Simulates when the user is in tasklist experiment similar to `API/Notes` `is_tasklist_experiment_assigned_treatment` function.
*/
private function set_user_in_tasklist_experiment() {
// When the user is participating in either `wc-admin-complete-store-details` or `wc-admin-update-store-details` AB tests,
// the user is in tasklist experiment.
update_option( 'woocommerce_allow_tracking', 'yes' );
$date = new \DateTime();
$date->setTimeZone( new \DateTimeZone( 'UTC' ) );
$experiment_name = sprintf(
'woocommerce_tasklist_progression_headercard_%s_%s',
$date->format( 'Y' ),
$date->format( 'm' )
);
set_transient( 'abtest_variation_' . $experiment_name, 'treatment' );
}
/**
* Simulates when the user is not in tasklist experiment similar to `API/Notes` `is_tasklist_experiment_assigned_treatment` function.
*/
private function set_user_out_of_tasklist_experiment() {
// Any experiment is off when `woocommerce_allow_tracking` option is false.
update_option( 'woocommerce_allow_tracking', false );
}
}

21
plugins/woocommerce-admin/tests/framework/helpers/class-wc-helper-admin-notes.php
View File

@ -132,4 +132,25 @@ class WC_Helper_Admin_Notes {
);
$note_5->save();
}
/**
* Create a note that we can use for tests on `name` related filters
*
* @param string $name The name of the new note.
*/
public static function add_note_for_test( string $name = 'default_name' ) {
$data_store = WC_Data_Store::load( 'admin-note' );
$note = new Note();
$note->set_title( 'PHPUNIT_TEST_NOTE_TITLE' );
$note->set_content( 'PHPUNIT_TEST_NOTE_CONTENT' );
$note->set_type( Note::E_WC_ADMIN_NOTE_MARKETING );
$note->set_name( $name );
$note->set_source( 'PHPUNIT_TEST' );
$note->set_is_snoozable( false );
$note->set_layout( 'plain' );
$note->set_image( '' );
$note->save();
}
}