Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct domain replacement for GraphQL fields #650

Merged
merged 1 commit into from
Nov 17, 2021
Merged

Correct domain replacement for GraphQL fields #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions plugins/faustwp/includes/replacement/graphql-callbacks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
/**
* Callback for WP GraphQL 'graphql_request_results' filter.
*
* Replaces the WordPress Site URL with the replacement domain in 'url' nodes.
* Replaces the WordPress Site URL with the replacement domain in 'url' and
* 'href' fields. Response data for RootQuery.generalSettings is intentionally
* left unaltered.
*
* @param object $response The default GraphQL query response.
*
Expand All @@ -31,20 +33,25 @@ function url_replacement( $response ) {
if (
is_object( $response ) &&
property_exists( $response, 'data' ) &&
is_array( $response->data ) &&
domain_replacement_enabled() &&
! array_key_exists( 'generalSettings', $response->data )
is_array( $response->data )
) {
array_walk_recursive(
$response->data,
function( &$value, $key ) {
if ( 'url' === $key || 'href' === $key ) {
$replacement = faustwp_get_setting( 'frontend_uri', '/' );
$value = str_replace( site_url(), $replacement, $value );
}
}
);
url_replace_recursive( $response->data );
}

return $response;
}

function url_replace_recursive( &$data ) {
foreach ( $data as $key => &$value ) {
if ( $key === 'generalSettings' ) {
continue;
}

if ( ( 'url' === $key || 'href' === $key ) && is_string( $value ) ) {
$replacement = faustwp_get_setting( 'frontend_uri', '/' );
$value = str_replace( site_url(), $replacement, $value );
} else if ( is_array( $value ) ) {
url_replace_recursive( $value );
}
}
}
136 changes: 136 additions & 0 deletions plugins/faustwp/tests/integration/replacement/test-graphql-callbacks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
<?php
/**
* Class GraphQLCallbacksTestCases
*
* @package FaustWP
*/

namespace WPE\FaustWP\Tests\Replacement;

use function WPE\FaustWP\Replacement\{ url_replacement };
use function WPE\FaustWP\Settings\faustwp_update_setting;

class GraphQLCallbacksTestCases extends \WP_UnitTestCase {

private $graphqlResponse;

private $responseData = [
'generalSettings' => [
'url' => 'http://example.org'
],
'menuItems' => [
'nodes' => [
[
'label' => 'Hello World',
'url' => 'http://example.org/hello-world/'
],
[
'label' => 'External Site',
'url' => 'http://external.site/no-replacement'
]
]
],
'menus' => [
'nodes' => [
[
'menuItems' => [
'nodes' => [
[
'label' => 'Hello World',
'url' => 'http://example.org/hello-world/'
]
]
]
]
]
],
'aThingWithHref' => [
'nodes' => [
[
'label' => "This uses href instead of url fields",
'href' => 'http://example.org/href'
]
]
]
];

private $expectedData = [
'generalSettings' => [
'url' => 'http://example.org'
],
'menuItems' => [
'nodes' => [
[
'label' => 'Hello World',
'url' => 'http://frontend/hello-world/'
],
[
'label' => 'External Site',
'url' => 'http://external.site/no-replacement'
]
]
],
'menus' => [
'nodes' => [
[
'menuItems' => [
'nodes' => [
[
'label' => 'Hello World',
'url' => 'http://frontend/hello-world/'
]
]
]
]
]
],
'aThingWithHref' => [
'nodes' => [
[
'label' => "This uses href instead of url fields",
'href' => 'http://frontend/href'
]
]
]
];

public function setUp() {
parent::setUp();

faustwp_update_setting( 'frontend_uri', 'http://frontend' );

$this->graphqlResponse = new \stdClass();
$this->graphqlResponse->data = $this->responseData;
}

public function test_graphql_request_results_filter() {
$this->assertSame( 10, has_action( 'graphql_request_results', 'WPE\FaustWP\Replacement\url_replacement' ) );
}

/**
* Tests url_replacement() returns original data when rewrites are not enabled.
*/
public function test_url_replacement_does_not_alter_response_when_rewrites_are_not_enabled() {
faustwp_update_setting( 'enable_rewrites', '0' );
$filteredRespone = url_replacement( $this->graphqlResponse );
$this->assertSame( $this->responseData, $filteredRespone->data );
}

/**
* Tests url_replacement() does not modify generalSettings even when rewrites are enabled.
*/
public function test_url_replacement_does_not_alter_generalSettings_when_rewrites_are_enabled() {
faustwp_update_setting( 'enable_rewrites', '1' );
$filteredRespone = url_replacement( $this->graphqlResponse );
$this->assertSame( $this->responseData['generalSettings'], $filteredRespone->data['generalSettings'] );
}

/**
* Tests url_replacement() modifies url and href fields when rewrites are enabled.
*/
public function test_url_replacement_replaces_url_fields_when_rewrites_are_enabled() {
faustwp_update_setting( 'enable_rewrites', '1' );
$filteredRespone = url_replacement( $this->graphqlResponse );
$this->assertSame( $this->expectedData, $filteredRespone->data );
}
}