mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #8652 from nextcloud/navigation-controller-etag 

Add ETag to NavigationController
This commit is contained in:
Morris Jobke 2018-03-07 10:03:00 +01:00 committed by GitHub
parent 65cc155a11 16ac8eaac9
commit 3156d95e14
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 62 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
core/Controller/NavigationController.php
View File

@ -22,6 +22,7 @@
*/ */
namespace OC\Core\Controller; namespace OC\Core\Controller;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCSController; use OCP\AppFramework\OCSController;
use OCP\INavigationManager; use OCP\INavigationManager;
@ -54,7 +55,14 @@ class NavigationController extends OCSController {
if ($absolute) { if ($absolute) {
$navigation = $this->rewriteToAbsoluteUrls($navigation); $navigation = $this->rewriteToAbsoluteUrls($navigation);
} }
return new DataResponse($navigation);
$etag = $this->generateETag($navigation);
if ($this->request->getHeader('If-None-Match') === $etag) {
return new DataResponse([], Http::STATUS_NOT_MODIFIED);
}
$response = new DataResponse($navigation);
$response->setETag($etag);
return $response;
} }
/** /**
@ -69,7 +77,28 @@ class NavigationController extends OCSController {
if ($absolute) { if ($absolute) {
$navigation = $this->rewriteToAbsoluteUrls($navigation); $navigation = $this->rewriteToAbsoluteUrls($navigation);
} }
return new DataResponse($navigation); $etag = $this->generateETag($navigation);
if ($this->request->getHeader('If-None-Match') === $etag) {
return new DataResponse([], Http::STATUS_NOT_MODIFIED);
}
$response = new DataResponse($navigation);
$response->setETag($etag);
return $response;
}
/**
* Generate an ETag for a list of navigation entries
*
* @param array $navigation
* @return string
*/
private function generateETag(array $navigation): string {
foreach ($navigation as &$nav) {
if ($nav['id'] === 'logout') {
$nav['href'] = 'logout';
}
}
return md5(json_encode($navigation));
} }
/** /**

31
tests/Core/Controller/NavigationControllerTest.php
View File

@ -23,6 +23,7 @@
namespace Tests\Core\Controller; namespace Tests\Core\Controller;
use OC\Core\Controller\NavigationController; use OC\Core\Controller\NavigationController;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Http\DataResponse;
use OCP\INavigationManager; use OCP\INavigationManager;
use OCP\IRequest; use OCP\IRequest;
@ -126,4 +127,34 @@ class NavigationControllerTest extends TestCase {
} }
} }
public function testGetAppNavigationEtagMatch() {
$navigation = [ ['id' => 'files', 'href' => '/index.php/apps/files', 'icon' => 'icon' ] ];
$this->request->expects($this->once())
->method('getHeader')
->with('If-None-Match')
->willReturn(md5(json_encode($navigation)));
$this->navigationManager->expects($this->once())
->method('getAll')
->with('link')
->willReturn($navigation);
$actual = $this->controller->getAppsNavigation();
$this->assertInstanceOf(DataResponse::class, $actual);
$this->assertEquals(Http::STATUS_NOT_MODIFIED, $actual->getStatus());
}
public function testGetSettingsNavigationEtagMatch() {
$navigation = [ ['id' => 'logout', 'href' => '/index.php/apps/files', 'icon' => 'icon' ] ];
$this->request->expects($this->once())
->method('getHeader')
->with('If-None-Match')
->willReturn(md5(json_encode([ ['id' => 'logout', 'href' => 'logout', 'icon' => 'icon' ] ])));
$this->navigationManager->expects($this->once())
->method('getAll')
->with('settings')
->willReturn($navigation);
$actual = $this->controller->getSettingsNavigation();
$this->assertInstanceOf(DataResponse::class, $actual);
$this->assertEquals(Http::STATUS_NOT_MODIFIED, $actual->getStatus());
}
} }