Skip to content

fix: Remove unneccesary etag check #52546

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

Merged
kesselb merged 2 commits into from
Apr 30, 2025
Merged

fix: Remove unneccesary etag check #52546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1addd35
fix: Remove unneccesary etag check
SystemKeeper Apr 29, 2025
ddd9179
fix: Add etag tests to NavigationControllerTest
SystemKeeper Apr 30, 2025
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
12 changes: 2 additions & 10 deletions core/Controller/NavigationController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,8 @@ public function getAppsNavigation(bool $absolute = false): DataResponse {
$navigation = $this->rewriteToAbsoluteUrls($navigation);
}
$navigation = array_values($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);
$response->setETag($this->generateETag($navigation));
return $response;
}

Expand All @@ -74,12 +70,8 @@ public function getSettingsNavigation(bool $absolute = false): DataResponse {
$navigation = $this->rewriteToAbsoluteUrls($navigation);
}
$navigation = array_values($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);
$response->setETag($this->generateETag($navigation));
return $response;
}

Expand Down
53 changes: 27 additions & 26 deletions tests/Core/Controller/NavigationControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
namespace Tests\Core\Controller;

use OC\Core\Controller\NavigationController;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\INavigationManager;
use OCP\IRequest;
Expand Down Expand Up @@ -104,33 +103,35 @@ public function testGetSettingsNavigation(bool $absolute): void {
}
}

public function testGetAppNavigationEtagMatch(): void {
$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())
public function testEtagIgnoresLogout(): void {
$navigation1 = [
['id' => 'files', 'href' => '/index.php/apps/files', 'icon' => 'icon' ],
['id' => 'logout', 'href' => '/index.php/logout?requesttoken=abcd', 'icon' => 'icon' ],
];
$navigation2 = [
['id' => 'files', 'href' => '/index.php/apps/files', 'icon' => 'icon' ],
['id' => 'logout', 'href' => '/index.php/logout?requesttoken=1234', 'icon' => 'icon' ],
];
$navigation3 = [
['id' => 'files', 'href' => '/index.php/apps/files/test', 'icon' => 'icon' ],
['id' => 'logout', 'href' => '/index.php/logout?requesttoken=1234', 'icon' => 'icon' ],
];
$this->navigationManager->expects($this->exactly(3))
->method('getAll')
->with('link')
->willReturn($navigation);
$actual = $this->controller->getAppsNavigation();
$this->assertInstanceOf(DataResponse::class, $actual);
$this->assertEquals(Http::STATUS_NOT_MODIFIED, $actual->getStatus());
}
->willReturnOnConsecutiveCalls(
$navigation1,
$navigation2,
$navigation3,
);

public function testGetSettingsNavigationEtagMatch(): void {
$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());
// Changes in the logout url should not change the ETag
$request1 = $this->controller->getAppsNavigation();
$request2 = $this->controller->getAppsNavigation();
$this->assertEquals($request1->getETag(), $request2->getETag());

// Changes in non-logout urls should result in a different ETag
$request3 = $this->controller->getAppsNavigation();
$this->assertNotEquals($request2->getETag(), $request3->getETag());
}
}
Loading