wbrawner/server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #9641 from nextcloud/techdep/noid/caching_explicit_in_response

Browse source 
Move caching logic to response
This commit is contained in:
Morris Jobke 2018-06-04 15:25:17 +02:00 committed by GitHub
commit 2794d62f60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 26 additions and 102 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
apps/theming/lib/Controller/IconController.php
View file

@ -101,11 +101,6 @@ class IconController extends Controller {
if ($iconFile !== false) { if ($iconFile !== false) {
$response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/svg+xml']); $response = new FileDisplayResponse($iconFile, Http::STATUS_OK, ['Content-Type' => 'image/svg+xml']);
$response->cacheFor(86400); $response->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$response->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$response->addHeader('Pragma', 'cache');
return $response; return $response;
} }
@ -146,11 +141,6 @@ class IconController extends Controller {
$response = new DataDisplayResponse($this->fileAccessHelper->file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/x-icon']); $response = new DataDisplayResponse($this->fileAccessHelper->file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
} }
$response->cacheFor(86400); $response->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$response->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$response->addHeader('Pragma', 'cache');
return $response; return $response;
} }
@ -187,11 +177,6 @@ class IconController extends Controller {
$response = new DataDisplayResponse($this->fileAccessHelper->file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/png']); $response = new DataDisplayResponse($this->fileAccessHelper->file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/png']);
} }
$response->cacheFor(86400); $response->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$response->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$response->addHeader('Pragma', 'cache');
return $response; return $response;
} }
} }

14
apps/theming/lib/Controller/ThemingController.php
View file

@ -368,11 +368,6 @@ class ThemingController extends Controller {
$response = new FileDisplayResponse($file); $response = new FileDisplayResponse($file);
$response->cacheFor(3600); $response->cacheFor(3600);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$response->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$response->addHeader('Pragma', 'cache');
$response->addHeader('Content-Type', $this->config->getAppValue($this->appName, $key . 'Mime', '')); $response->addHeader('Content-Type', $this->config->getAppValue($this->appName, $key . 'Mime', ''));
$response->addHeader('Content-Disposition', 'attachment; filename="' . $key . '"'); $response->addHeader('Content-Disposition', 'attachment; filename="' . $key . '"');
return $response; return $response;
@ -403,11 +398,6 @@ class ThemingController extends Controller {
$cssFile = $this->scssCacher->getCachedCSS('theming', 'theming.css'); $cssFile = $this->scssCacher->getCachedCSS('theming', 'theming.css');
$response = new FileDisplayResponse($cssFile, Http::STATUS_OK, ['Content-Type' => 'text/css']); $response = new FileDisplayResponse($cssFile, Http::STATUS_OK, ['Content-Type' => 'text/css']);
$response->cacheFor(86400); $response->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$response->addHeader('Expires', $expires->format(\DateTime::RFC1123));
$response->addHeader('Pragma', 'cache');
return $response; return $response;
} catch (NotFoundException $e) { } catch (NotFoundException $e) {
return new NotFoundResponse(); return new NotFoundResponse();
@ -435,8 +425,6 @@ class ThemingController extends Controller {
}; };
})();'; })();';
$response = new DataDownloadResponse($responseJS, 'javascript', 'text/javascript'); $response = new DataDownloadResponse($responseJS, 'javascript', 'text/javascript');
$response->addHeader('Expires', date(\DateTime::RFC2822, $this->timeFactory->getTime()));
$response->addHeader('Pragma', 'cache');
$response->cacheFor(3600); $response->cacheFor(3600);
return $response; return $response;
} }
@ -470,8 +458,6 @@ class ThemingController extends Controller {
'display' => 'standalone' 'display' => 'standalone'
]; ];
$response = new Http\JSONResponse($responseJS); $response = new Http\JSONResponse($responseJS);
$response->addHeader('Expires', date(\DateTime::RFC2822, $this->timeFactory->getTime()));
$response->addHeader('Pragma', 'cache');
$response->cacheFor(3600); $response->cacheFor(3600);
return $response; return $response;
} }

25
apps/theming/tests/Controller/IconControllerTest.php
View file

@ -102,11 +102,6 @@ class IconControllerTest extends TestCase {
->willReturn($file); ->willReturn($file);
$expected = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'image/svg+xml']); $expected = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'image/svg+xml']);
$expected->cacheFor(86400); $expected->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$expected->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$expected->addHeader('Pragma', 'cache');
$this->assertEquals($expected, $this->iconController->getThemedIcon('core', 'filetypes/folder.svg')); $this->assertEquals($expected, $this->iconController->getThemedIcon('core', 'filetypes/folder.svg'));
} }
@ -139,11 +134,6 @@ class IconControllerTest extends TestCase {
$expected = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'image/x-icon']); $expected = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
$expected->cacheFor(86400); $expected->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$expected->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$expected->addHeader('Pragma', 'cache');
$this->assertEquals($expected, $this->iconController->getFavicon()); $this->assertEquals($expected, $this->iconController->getFavicon());
} }
@ -162,11 +152,6 @@ class IconControllerTest extends TestCase {
->willReturn(file_get_contents($fallbackLogo)); ->willReturn(file_get_contents($fallbackLogo));
$expected = new DataDisplayResponse(file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/x-icon']); $expected = new DataDisplayResponse(file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/x-icon']);
$expected->cacheFor(86400); $expected->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$expected->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$expected->addHeader('Pragma', 'cache');
$this->assertEquals($expected, $this->iconController->getFavicon()); $this->assertEquals($expected, $this->iconController->getFavicon());
} }
@ -196,11 +181,6 @@ class IconControllerTest extends TestCase {
$expected = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'image/png']); $expected = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'image/png']);
$expected->cacheFor(86400); $expected->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$expected->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$expected->addHeader('Pragma', 'cache');
$this->assertEquals($expected, $this->iconController->getTouchIcon()); $this->assertEquals($expected, $this->iconController->getTouchIcon());
} }
@ -219,11 +199,6 @@ class IconControllerTest extends TestCase {
->willReturn(file_get_contents($fallbackLogo)); ->willReturn(file_get_contents($fallbackLogo));
$expected = new DataDisplayResponse(file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/png']); $expected = new DataDisplayResponse(file_get_contents($fallbackLogo), Http::STATUS_OK, ['Content-Type' => 'image/png']);
$expected->cacheFor(86400); $expected->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$expected->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$expected->addHeader('Pragma', 'cache');
$this->assertEquals($expected, $this->iconController->getTouchIcon()); $this->assertEquals($expected, $this->iconController->getTouchIcon());
} }

26
apps/theming/tests/Controller/ThemingControllerTest.php
View file

@ -695,11 +695,6 @@ class ThemingControllerTest extends TestCase {
@$expected = new Http\FileDisplayResponse($file); @$expected = new Http\FileDisplayResponse($file);
$expected->cacheFor(3600); $expected->cacheFor(3600);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$expected->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$expected->addHeader('Pragma', 'cache');
$expected->addHeader('Content-Type', 'text/svg'); $expected->addHeader('Content-Type', 'text/svg');
$expected->addHeader('Content-Disposition', 'attachment; filename="logo"'); $expected->addHeader('Content-Disposition', 'attachment; filename="logo"');
@$this->assertEquals($expected, $this->themingController->getImage('logo')); @$this->assertEquals($expected, $this->themingController->getImage('logo'));
@ -728,11 +723,6 @@ class ThemingControllerTest extends TestCase {
@$expected = new Http\FileDisplayResponse($file); @$expected = new Http\FileDisplayResponse($file);
$expected->cacheFor(3600); $expected->cacheFor(3600);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$expected->addHeader('Expires', $expires->format(\DateTime::RFC2822));
$expected->addHeader('Pragma', 'cache');
$expected->addHeader('Content-Type', 'image/png'); $expected->addHeader('Content-Type', 'image/png');
$expected->addHeader('Content-Disposition', 'attachment; filename="background"'); $expected->addHeader('Content-Disposition', 'attachment; filename="background"');
@$this->assertEquals($expected, $this->themingController->getImage('background')); @$this->assertEquals($expected, $this->themingController->getImage('background'));
@ -749,11 +739,6 @@ class ThemingControllerTest extends TestCase {
$response = new Http\FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'text/css']); $response = new Http\FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'text/css']);
$response->cacheFor(86400); $response->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$response->addHeader('Expires', $expires->format(\DateTime::RFC1123));
$response->addHeader('Pragma', 'cache');
$actual = $this->themingController->getStylesheet(); $actual = $this->themingController->getStylesheet();
$this->assertEquals($response, $actual); $this->assertEquals($response, $actual);
@ -782,11 +767,6 @@ class ThemingControllerTest extends TestCase {
$response = new Http\FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'text/css']); $response = new Http\FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'text/css']);
$response->cacheFor(86400); $response->cacheFor(86400);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT24H'));
$response->addHeader('Expires', $expires->format(\DateTime::RFC1123));
$response->addHeader('Pragma', 'cache');
$actual = $this->themingController->getStylesheet(); $actual = $this->themingController->getStylesheet();
$this->assertEquals($response, $actual); $this->assertEquals($response, $actual);
@ -824,8 +804,6 @@ class ThemingControllerTest extends TestCase {
}; };
})();'; })();';
$expected = new Http\DataDownloadResponse($expectedResponse, 'javascript', 'text/javascript'); $expected = new Http\DataDownloadResponse($expectedResponse, 'javascript', 'text/javascript');
$expected->addHeader('Expires', date(\DateTime::RFC2822, $this->timeFactory->getTime()));
$expected->addHeader('Pragma', 'cache');
$expected->cacheFor(3600); $expected->cacheFor(3600);
@$this->assertEquals($expected, $this->themingController->getJavascript()); @$this->assertEquals($expected, $this->themingController->getJavascript());
} }
@ -860,8 +838,6 @@ class ThemingControllerTest extends TestCase {
}; };
})();'; })();';
$expected = new Http\DataDownloadResponse($expectedResponse, 'javascript', 'text/javascript'); $expected = new Http\DataDownloadResponse($expectedResponse, 'javascript', 'text/javascript');
$expected->addHeader('Expires', date(\DateTime::RFC2822, $this->timeFactory->getTime()));
$expected->addHeader('Pragma', 'cache');
$expected->cacheFor(3600); $expected->cacheFor(3600);
@$this->assertEquals($expected, $this->themingController->getJavascript()); @$this->assertEquals($expected, $this->themingController->getJavascript());
} }
@ -908,8 +884,6 @@ class ThemingControllerTest extends TestCase {
], ],
'display' => 'standalone' 'display' => 'standalone'
]); ]);
$response->addHeader('Expires', date(\DateTime::RFC2822, $this->timeFactory->getTime()));
$response->addHeader('Pragma', 'cache');
$response->cacheFor(3600); $response->cacheFor(3600);
$this->assertEquals($response, $this->themingController->getManifest('core')); $this->assertEquals($response, $this->themingController->getManifest('core'));
} }

8
core/Controller/AvatarController.php
View file

@ -141,16 +141,8 @@ class AvatarController extends Controller {
return $resp; return $resp;
} }
// Let cache this!
$resp->addHeader('Pragma', 'public');
// Cache for 30 minutes // Cache for 30 minutes
$resp->cacheFor(1800); $resp->cacheFor(1800);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT30M'));
$resp->addHeader('Expires', $expires->format(\DateTime::RFC1123));
return $resp; return $resp;
} }

10
core/Controller/PreviewController.php
View file

@ -174,17 +174,7 @@ class PreviewController extends Controller {
try { try {
$f = $this->preview->getPreview($node, $x, $y, !$a, $mode); $f = $this->preview->getPreview($node, $x, $y, !$a, $mode);
$response = new FileDisplayResponse($f, Http::STATUS_OK, ['Content-Type' => $f->getMimeType()]); $response = new FileDisplayResponse($f, Http::STATUS_OK, ['Content-Type' => $f->getMimeType()]);
// Let cache this!
$response->addHeader('Pragma', 'public');
// Cache previews for 24H
$response->cacheFor(3600 * 24); $response->cacheFor(3600 * 24);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('P1D'));
$response->addHeader('Expires', $expires->format(\DateTime::RFC2822));
return $response; return $response;
} catch (NotFoundException $e) { } catch (NotFoundException $e) {
return new DataResponse([], Http::STATUS_NOT_FOUND); return new DataResponse([], Http::STATUS_NOT_FOUND);

16
lib/public/AppFramework/Http/Response.php
View file

@ -35,6 +35,7 @@
namespace OCP\AppFramework\Http; namespace OCP\AppFramework\Http;
use OCP\AppFramework\Http; use OCP\AppFramework\Http;
use OCP\AppFramework\Utility\ITimeFactory;
/** /**
* Base class for responses. Also used to just send headers. * Base class for responses. Also used to just send headers.
@ -95,12 +96,23 @@ class Response {
* @return $this * @return $this
* @since 6.0.0 - return value was added in 7.0.0 * @since 6.0.0 - return value was added in 7.0.0
*/ */
public function cacheFor($cacheSeconds) { public function cacheFor(int $cacheSeconds) {
if($cacheSeconds > 0) { if($cacheSeconds > 0) {
$this->addHeader('Cache-Control', 'max-age=' . $cacheSeconds . ', must-revalidate'); $this->addHeader('Cache-Control', 'max-age=' . $cacheSeconds . ', must-revalidate');
// Old scool prama caching
$this->addHeader('Pragma', 'public');
// Set expires header
$expires = new \DateTime();
/** @var ITimeFactory $time */
$time = \OC::$server->query(ITimeFactory::class);
$expires->setTimestamp($time->getTime());
$expires->add(new \DateInterval('PT'.$cacheSeconds.'S'));
$this->addHeader('Expires', $expires->format(\DateTime::RFC2822));
} else { } else {
$this->addHeader('Cache-Control', 'no-cache, no-store, must-revalidate'); $this->addHeader('Cache-Control', 'no-cache, no-store, must-revalidate');
unset($this->headers['Expires'], $this->headers['Pragma']);
} }
return $this; return $this;

14
tests/lib/AppFramework/Http/ResponseTest.php
View file

@ -27,6 +27,7 @@ namespace Test\AppFramework\Http;
use OCP\AppFramework\Http\Response; use OCP\AppFramework\Http\Response;
use OCP\AppFramework\Http; use OCP\AppFramework\Http;
use OCP\AppFramework\Utility\ITimeFactory;
class ResponseTest extends \Test\TestCase { class ResponseTest extends \Test\TestCase {
@ -222,15 +223,24 @@ class ResponseTest extends \Test\TestCase {
$headers = $this->childResponse->getHeaders(); $headers = $this->childResponse->getHeaders();
$this->assertEquals('no-cache, no-store, must-revalidate', $headers['Cache-Control']); $this->assertEquals('no-cache, no-store, must-revalidate', $headers['Cache-Control']);
$this->assertFalse(isset($headers['Pragma']));
$this->assertFalse(isset($headers['Expires']));
} }
public function testCacheSeconds() { public function testCacheSeconds() {
$time = $this->createMock(ITimeFactory::class);
$time->method('getTime')
->willReturn('1234567');
$this->overwriteService(ITimeFactory::class, $time);
$this->childResponse->cacheFor(33); $this->childResponse->cacheFor(33);
$headers = $this->childResponse->getHeaders(); $headers = $this->childResponse->getHeaders();
$this->assertEquals('max-age=33, must-revalidate', $this->assertEquals('max-age=33, must-revalidate', $headers['Cache-Control']);
$headers['Cache-Control']); $this->assertEquals('public', $headers['Pragma']);
$this->assertEquals('Thu, 15 Jan 1970 06:56:40 +0000', $headers['Expires']);
} }