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.

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

IBX-111: Injected RequestStack into ExposedRoutesExtractor #3105

Merged
merged 3 commits into from
Jun 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
"liip/imagine-bundle": "^2.1",
"oneup/flysystem-bundle": "^3.0",
"friendsofsymfony/http-cache-bundle": "^1.3.13 | ^2.5.1",
"friendsofsymfony/jsrouting-bundle": "^1.6.3",
"sensio/framework-extra-bundle": "^5.2",
"jms/translation-bundle": "^1.4",
"twig/twig": "^2.10",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ services:
decorates: 'fos_js_routing.extractor'
arguments:
- '@ezpublish.js_routing.extractor.inner'
- '@=service("request_stack").getMasterRequest()'
- '@request_stack'
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,26 @@

use eZ\Publish\Core\MVC\Symfony\SiteAccess;
use FOS\JsRoutingBundle\Extractor\ExposedRoutesExtractorInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

/**
* Decorator of FOSJsRouting routes extractor.
* Ensures that base URL contains the SiteAccess part when applicable.
*
* @internal
*/
class ExposedRoutesExtractor implements ExposedRoutesExtractorInterface
{
/** @var ExposedRoutesExtractorInterface */
/** @var \FOS\JsRoutingBundle\Extractor\ExposedRoutesExtractorInterface */
private $innerExtractor;

/** @var Request */
private $masterRequest;
/** @var \Symfony\Component\HttpFoundation\RequestStack */
private $requestStack;

public function __construct(ExposedRoutesExtractorInterface $innerExtractor, Request $masterRequest)
public function __construct(ExposedRoutesExtractorInterface $innerExtractor, RequestStack $requestStack)
{
$this->innerExtractor = $innerExtractor;
$this->masterRequest = $masterRequest;
$this->requestStack = $requestStack;
}

public function getRoutes()
Expand All @@ -43,7 +45,12 @@ public function getRoutes()
public function getBaseUrl()
{
$baseUrl = $this->innerExtractor->getBaseUrl();
$siteAccess = $this->masterRequest->attributes->get('siteaccess');
$request = $this->requestStack->getMasterRequest();
if ($request === null) {
return $baseUrl;
}

$siteAccess = $request->attributes->get('siteaccess');
if ($siteAccess instanceof SiteAccess && $siteAccess->matcher instanceof SiteAccess\URILexer) {
$baseUrl .= $siteAccess->matcher->analyseLink('');
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?php

/**
* @copyright Copyright (C) eZ Systems AS. All rights reserved.
* @license For full copyright and license information view LICENSE file distributed with this source code.
*/
declare(strict_types=1);

namespace eZ\Bundle\EzPublishCoreBundle\Tests\Routing\JsRouting;

use eZ\Bundle\EzPublishCoreBundle\Routing\JsRouting\ExposedRoutesExtractor;
use eZ\Publish\Core\MVC\Symfony\SiteAccess;
use FOS\JsRoutingBundle\Extractor\ExposedRoutesExtractorInterface;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

/**
* @covers \eZ\Bundle\EzPublishCoreBundle\Routing\JsRouting\ExposedRoutesExtractor
*
* @internal
*/
final class ExposedRoutesExtractorTest extends TestCase
{
private const BASE_URL = '/foo';

public function getDataForTestGetBaseUrl(): iterable
{
yield 'CLI' => [
// no master request in a stack
null,
self::BASE_URL,
];

yield 'No SiteAccess' => [
new Request(),
self::BASE_URL,
];

$siteAccess = new SiteAccess(
'test',
SiteAccess\Matcher\HostText::class,
new SiteAccess\Matcher\HostText([])
);
yield 'SiteAccess w/o URI Lexer matcher' => [
new Request([], [], ['siteaccess' => $siteAccess]),
self::BASE_URL,
];

$siteAccess = new SiteAccess(
'test',
SiteAccess\Matcher\URIText::class,
new SiteAccess\Matcher\URIText(['prefix' => 'bar'])
);
yield 'SiteAccess with URI Lexer matcher' => [
new Request([], [], ['siteaccess' => $siteAccess]),
self::BASE_URL . '/bar/',
];
}

/**
* @dataProvider getDataForTestGetBaseUrl
*/
public function testGetBaseUrl(?Request $masterRequest, string $expectedBaseUrl): void
{
$innerExtractor = $this->createMock(ExposedRoutesExtractorInterface::class);
$requestStack = $this->createMock(RequestStack::class);

$innerExtractor->method('getBaseUrl')->willReturn(self::BASE_URL);
$requestStack->method('getMasterRequest')->willReturn($masterRequest);

$extractor = new ExposedRoutesExtractor($innerExtractor, $requestStack);

self::assertSame($expectedBaseUrl, $extractor->getBaseUrl());
}
}