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

Add inbox WP admin link support for remote inbox notifications (#33237) 

* Add support for admin url in remote inbox notifications

* Add unit tests for the spec runner action url

* Add changelog
This commit is contained in:
louwie17 2022-05-31 13:32:13 -03:00 committed by GitHub
parent 7590663f3b
commit c0999d4cf8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 98 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce/changelog/add-32129_remove_inbox_wp_admin_link_support Normal file
View File

@ -0,0 +1,4 @@
Significance: minor
Type: add
Add support to remote inbox notification actions to link to other wp-admin pages. #33237

5
plugins/woocommerce/src/Admin/RemoteInboxNotifications/SpecRunner.php
View File

@ -101,7 +101,10 @@ class SpecRunner {
}
if ( isset( $action->url_is_admin_query ) && $action->url_is_admin_query ) {
return wc_admin_url( $action->url );
if ( strpos( $action->url, '&path' ) === 0 ) {
return wc_admin_url( $action->url );
}
return admin_url( $action->url );
}
return $action->url;

90
plugins/woocommerce/tests/legacy/unit-tests/woocommerce-admin/remote-inbox-notifications/spec-runner.php Normal file
View File

@ -0,0 +1,90 @@
<?php
/**
* Spec runner tests.
*
* @package WooCommerce\Admin\Tests\RemoteInboxNotifications
*/
use Automattic\WooCommerce\Admin\Notes\Notes;
use Automattic\WooCommerce\Admin\RemoteInboxNotifications\SpecRunner;
use Automattic\WooCommerce\Admin\RemoteInboxNotifications\RemoteInboxNotificationsEngine;
/**
* class WC_Admin_Tests_RemoteInboxNotifications_SpecRunner
*/
class WC_Admin_Tests_RemoteInboxNotifications_SpecRunner extends WC_Unit_Test_Case {
/**
* Build up a spec given the supplied parameters.
*
* @param string $url url for the action.
* @param bool $url_is_admin_query is_admin_query boolean for the action.
*
* @return object The spec object.
*/
private function get_spec( $url, $url_is_admin_query ) {
return json_decode(
'{
"slug": "test",
"status": "unactioned",
"type": "info",
"locales": [{
"locale": "en_US",
"title": "Title",
"content": "Content"
}],
"rules": [],
"actions": [ {
"name": "test-action",
"locales": [
{
"locale": "en_US",
"label": "Action label"
}],
"url": "' . $url . '",
"url_is_admin_query": ' . ( $url_is_admin_query ? 'true' : 'false' ) . ',
"status": "unactioned"
}]
}'
);
}
/**
* Tests get_url function with wp-admin url
*
* @group fast
*/
public function test_get_url_with_wp_admin_url() {
$spec = $this->get_spec( 'plugins.php', true );
SpecRunner::run_spec( $spec, RemoteInboxNotificationsEngine::get_stored_state() );
$note = Notes::get_note_by_name( $spec->slug );
$action = $note->get_action( 'test-action' );
$this->assertEquals( admin_url( 'plugins.php' ), $action->query );
}
/**
* Tests get url function with WooCommerce Admin url.
*
* @group fast
*/
public function test_get_url_with_wc_admin_url() {
$spec = $this->get_spec( '&path=wc-addons', true );
SpecRunner::run_spec( $spec, RemoteInboxNotificationsEngine::get_stored_state() );
$note = Notes::get_note_by_name( $spec->slug );
$action = $note->get_action( 'test-action' );
$this->assertEquals( wc_admin_url( '&path=wc-addons' ), $action->query );
}
/**
* Tests get url with external url.
*
* @group fast
*/
public function test_get_url_with_external_url() {
$spec = $this->get_spec( 'http://test.com', false );
SpecRunner::run_spec( $spec, RemoteInboxNotificationsEngine::get_stored_state() );
$note = Notes::get_note_by_name( $spec->slug );
$action = $note->get_action( 'test-action' );
$this->assertEquals( 'http://test.com', $action->query );
}
}