-
Notifications
You must be signed in to change notification settings - Fork 227
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Closes #5279: WP Rockets picks up wrong URL as referrer while using W…
…eglot (#6197) Co-authored-by: Gael Robin <“[email protected]”> Co-authored-by: Cyrille C <[email protected]>
- Loading branch information
3 people
authored
Nov 3, 2023
1 parent
5ca0902
commit cd0e9e2
Showing
9 changed files
with
167 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <?php | ||
|
|
||
| namespace WP_Rocket\ThirdParty\Plugins\I18n; | ||
|
|
||
| use WP_Rocket\Event_Management\Subscriber_Interface; | ||
|
|
||
| /** | ||
| * Subscriber for compatibility with Weglot. | ||
| */ | ||
| class Weglot implements Subscriber_Interface { | ||
|
|
||
| /** | ||
| * Returns an array of events that this subscriber wants to listen to. | ||
| * | ||
| * @return array|string[] | ||
| */ | ||
| public static function get_subscribed_events() { | ||
| if ( ! class_exists( 'Context_Weglot' ) ) { | ||
| return []; | ||
| } | ||
|
|
||
| return [ | ||
| 'rocket_admin_bar_referer' => 'add_langs_to_referer', | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Modify the referer URL by appending the current language from Weglot as a prefix to the URL path. | ||
| * | ||
| * @param string $referer The original referer URL. | ||
| * @return string The modified referer URL with the language as a prefix. | ||
| */ | ||
| public function add_langs_to_referer( $referer ) { | ||
| if ( ! function_exists( 'weglot_get_request_url_service' ) || ! function_exists( 'weglot_get_current_full_url' ) ) { | ||
| return $referer; | ||
| } | ||
|
|
||
| return weglot_get_request_url_service()->url_to_relative( weglot_get_current_full_url() ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
tests/Fixtures/inc/ThirdParty/Plugins/I18n/Weglot/addLangsToReferer.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| <?php | ||
|
|
||
| return [ | ||
| 'shouldReturnUpdatedLangsReferer' => [ | ||
| 'noChangeHomepage' => [ | ||
| 'referer' => '/', | ||
| 'lang' => '', | ||
| 'expected' => '/' | ||
| ], | ||
| 'noChangePage' => [ | ||
| 'referer' => '/path/to/page/', | ||
| 'lang' => '', | ||
| 'expected' => '/path/to/page/' | ||
| ], | ||
| 'ChangeLanguagePage' => [ | ||
| 'referer' => '/path/to/page/', | ||
| 'lang' => 'es', | ||
| 'expected' => '/es/path/to/page/' | ||
| ], | ||
| 'ChangeLanguageWithQueryParams' => [ | ||
| 'referer' => '/path/to/page?param1=value1¶m2=value2', | ||
| 'lang' => 'fr', | ||
| 'expected' => '/fr/path/to/page?param1=value1¶m2=value2' | ||
| ], | ||
| ], | ||
| ]; |
38 changes: 38 additions & 0 deletions
38
tests/Integration/inc/ThirdParty/Plugins/I18n/Weglot/addLangsToReferer.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| <?php | ||
|
|
||
| namespace WP_Rocket\Tests\Integration\inc\ThirdParty\Plugins\I18n\Weglot; | ||
|
|
||
| use WP_Rocket\ThirdParty\Plugins\I18n\Weglot; | ||
| use WP_Rocket\Tests\Integration\TestCase; | ||
| use Brain\Monkey\Functions; | ||
|
|
||
|
|
||
| /** | ||
| * @covers \WP_Rocket\ThirdParty\Plugins\I18n\Weglot::add_langs_to_referer | ||
| * @group Weglot | ||
| */ | ||
| class Test_addLangsToReferer extends TestCase { | ||
|
|
||
| /** | ||
| * @var Weglot | ||
| */ | ||
| protected $weglot; | ||
|
|
||
| public function setUp(): void { | ||
| parent::setUp(); | ||
|
|
||
| $this->weglot = new Weglot(); | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider configTestData | ||
| */ | ||
| public function testShouldReturnAsExpected( $config, $expected ) { | ||
| Functions\expect('weglot_get_current_language')->andReturn($config['lang']); | ||
|
|
||
| $this->assertSame( | ||
| $config['expected'], | ||
| apply_filters( 'rocket_admin_bar_referer', $config['referer'] ) | ||
| ); | ||
| } | ||
| } |
37 changes: 37 additions & 0 deletions
37
tests/Unit/inc/ThirdParty/Plugins/I18n/Weglot/addLangsToReferer.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?php | ||
|
|
||
| namespace WP_Rocket\Tests\Unit\inc\ThirdParty\Plugins\I18n\Weglot; | ||
|
|
||
| use WP_Rocket\ThirdParty\Plugins\I18n\Weglot; | ||
| use WP_Rocket\Tests\Unit\TestCase; | ||
| use Brain\Monkey\Functions; | ||
|
|
||
| /** | ||
| * @covers \WP_Rocket\ThirdParty\Plugins\I18n\Weglot::add_langs_to_referer | ||
| */ | ||
| class Test_AddLangsToReferer extends TestCase { | ||
|
|
||
| /** | ||
| * @var Weglot | ||
| */ | ||
| protected $weglot; | ||
|
|
||
| public function setUp(): void { | ||
| parent::setUp(); | ||
|
|
||
| $this->weglot = new Weglot(); | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider configTestData | ||
| */ | ||
| public function testShouldReturnAsExpected($config) { | ||
| Functions\expect('weglot_get_current_language')->andReturn($config['lang']); | ||
| Functions\expect('wp_parse_url')->andReturn(parse_url($config['referer'])); | ||
|
|
||
| $this->assertSame( | ||
| $config['expected'], | ||
| $this->weglot->add_langs_to_referer($config['referer']) | ||
| ); | ||
| } | ||
| } |