Skip to content

Truncate response body on cache hits #55

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
akrabat merged 7 commits into from
Nov 5, 2025
Merged

Truncate response body on cache hits #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dd956e4
Testing for empty body on cache hit
JimTools Mar 7, 2024
674fd7d
Replace response body on cache hit
JimTools Mar 7, 2024
5693234
Removing unused import
JimTools Aug 8, 2024
71b139e
Merge branch '1.x' into bug/cache-hit-still-sends-body
akrabat Nov 2, 2025
2821e9f
Make StreamFactory optional
akrabat Nov 2, 2025
0634048
Move private method to bottom of class
akrabat Nov 2, 2025
5dd9ddd
Fix formatting of use statements in CacheTest
akrabat Nov 2, 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
34 changes: 27 additions & 7 deletions src/Cache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;

Expand Down Expand Up @@ -45,18 +46,29 @@ class Cache implements MiddlewareInterface
*/
protected $mustRevalidate;

/**
* @var StreamFactoryInterface|null
*/
protected $streamFactory;

/**
* Create new HTTP cache
*
* @param string $type The cache type: "public" or "private"
* @param int $maxAge The maximum age of client-side cache
* @param bool $mustRevalidate must-revalidate
* @param string $type The cache type: "public" or "private"
* @param int $maxAge The maximum age of client-side cache
* @param bool $mustRevalidate must-revalidate
* @param StreamFactoryInterface|null $streamFactory Will clear body of a 304 if provided
*/
public function __construct(string $type = 'private', int $maxAge = 86400, bool $mustRevalidate = false)
{
public function __construct(
string $type = 'private',
int $maxAge = 86400,
bool $mustRevalidate = false,
?StreamFactoryInterface $streamFactory = null
) {
$this->type = $type;
$this->maxAge = $maxAge;
$this->mustRevalidate = $mustRevalidate;
$this->streamFactory = $streamFactory;
Copy link
Contributor Author

@JimTools JimTools Apr 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe for now it's better to add slim/psr7 and call StreamFactory this would make it easier for anyone already using this package?

Copy link
Contributor

@flavioheleno flavioheleno Jul 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather require psr/http-factory (and likely psr/http-factory-implementation) than slim/psr7 as it keeps interoperable with other psr7 implementation packages

Copy link
Contributor

@odan odan Jul 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only the user should decide which StreamFactoryInterface implementation should be used in their application.

Copy link
Contributor Author

@JimTools JimTools Jul 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flavioheleno @odan thank you for taken the time to review the PR I’ll update when I get some time.

}

/**
Expand Down Expand Up @@ -101,7 +113,11 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
if ($ifNoneMatch) {
$etagList = preg_split('@\s*,\s*@', $ifNoneMatch);
if (is_array($etagList) && (in_array($etag, $etagList) || in_array('*', $etagList))) {
return $response->withStatus(304);
$response = $response->withStatus(304);
if ($this->streamFactory) {
$response = $response->withBody($this->streamFactory->createStream(''));
}
return $response;
}
}
}
Expand All @@ -118,7 +134,11 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
$ifModifiedSince = $request->getHeaderLine('If-Modified-Since');

if ($ifModifiedSince && $lastModified <= strtotime($ifModifiedSince)) {
return $response->withStatus(304);
$response = $response->withStatus(304);
if ($this->streamFactory) {
$response = $response->withBody($this->streamFactory->createStream(''));
}
return $response;
}
}

Expand Down
62 changes: 52 additions & 10 deletions tests/CacheTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use Slim\HttpCache\Cache;
use Slim\Psr7\Factory\ResponseFactory;
use Slim\Psr7\Factory\ServerRequestFactory;
use Slim\Psr7\Factory\StreamFactory;

use function gmdate;
use function time;
Expand Down Expand Up @@ -64,7 +65,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface

public function testCacheControlHeader()
{
$cache = new Cache('public', 86400);
$cache = $this->createCache('public', 86400, false, false);
$req = $this->requestFactory();

$res = $cache->process($req, $this->createRequestHandler(null));
Expand All @@ -76,7 +77,7 @@ public function testCacheControlHeader()

public function testCacheControlHeaderWithMustRevalidate()
{
$cache = new Cache('private', 86400, true);
$cache = $this->createCache('private', 86400, true, false);
$req = $this->requestFactory();

$res = $cache->process($req, $this->createRequestHandler(null));
Expand All @@ -88,7 +89,7 @@ public function testCacheControlHeaderWithMustRevalidate()

public function testCacheControlHeaderWithZeroMaxAge()
{
$cache = new Cache('private', 0, false);
$cache = $this->createCache('private', 0, false, false);
$req = $this->requestFactory();

$res = $cache->process($req, $this->createRequestHandler(null));
Expand All @@ -100,7 +101,7 @@ public function testCacheControlHeaderWithZeroMaxAge()

public function testCacheControlHeaderDoesNotOverrideExistingHeader()
{
$cache = new Cache('public', 86400);
$cache = $this->createCache('public', 86400, false, false);
$req = $this->requestFactory();

$res = $this->createResponse()->withHeader('Cache-Control', 'no-cache,no-store');
Expand All @@ -116,22 +117,24 @@ public function testLastModifiedWithCacheHit()
$now = time();
$lastModified = gmdate('D, d M Y H:i:s T', $now + 86400);
$ifModifiedSince = gmdate('D, d M Y H:i:s T', $now + 86400);
$cache = new Cache('public', 86400);
$cache = $this->createCache('public', 86400, false, false);

$req = $this->requestFactory()->withHeader('If-Modified-Since', $ifModifiedSince);

$res = $this->createResponse()->withHeader('Last-Modified', $lastModified);
$res->getBody()->write('payload data');
$res = $cache->process($req, $this->createRequestHandler($res));

$this->assertEquals(304, $res->getStatusCode());
self::assertSame('payload data', (string) $res->getBody());
}

public function testLastModifiedWithCacheHitAndNewerDate()
{
$now = time();
$lastModified = gmdate('D, d M Y H:i:s T', $now + 86400);
$ifModifiedSince = gmdate('D, d M Y H:i:s T', $now + 172800); // <-- Newer date
$cache = new Cache('public', 86400);
$cache = $this->createCache('public', 86400, false, false);
$req = $this->requestFactory()->withHeader('If-Modified-Since', $ifModifiedSince);

$res = $this->createResponse()->withHeader('Last-Modified', $lastModified);
Expand All @@ -145,7 +148,7 @@ public function testLastModifiedWithCacheHitAndOlderDate()
$now = time();
$lastModified = gmdate('D, d M Y H:i:s T', $now + 86400);
$ifModifiedSince = gmdate('D, d M Y H:i:s T', $now); // <-- Older date
$cache = new Cache('public', 86400);
$cache = $this->createCache('public', 86400, false, false);
$req = $this->requestFactory()->withHeader('If-Modified-Since', $ifModifiedSince);

$res = $this->createResponse()->withHeader('Last-Modified', $lastModified);
Expand All @@ -159,7 +162,7 @@ public function testLastModifiedWithCacheMiss()
$now = time();
$lastModified = gmdate('D, d M Y H:i:s T', $now + 86400);
$ifModifiedSince = gmdate('D, d M Y H:i:s T', $now - 86400);
$cache = new Cache('public', 86400);
$cache = $this->createCache('public', 86400, false, false);
$req = $this->requestFactory()->withHeader('If-Modified-Since', $ifModifiedSince);

$res = $this->createResponse()->withHeader('Last-Modified', $lastModified);
Expand All @@ -172,25 +175,64 @@ public function testETagWithCacheHit()
{
$etag = 'abc';
$ifNoneMatch = 'abc';
$cache = new Cache('public', 86400);
$cache = $this->createCache('public', 86400, false, false);
$req = $this->requestFactory()->withHeader('If-None-Match', $ifNoneMatch);

$res = $this->createResponse()->withHeader('Etag', $etag);
$res->getBody()->write('payload data');
$res = $cache->process($req, $this->createRequestHandler($res));

$this->assertEquals(304, $res->getStatusCode());
self::assertSame('payload data', (string) $res->getBody());
}

public function testETagWithCacheMiss()
{
$etag = 'abc';
$ifNoneMatch = 'xyz';
$cache = new Cache('public', 86400);
$cache = $this->createCache('public', 86400, false, false);
$req = $this->requestFactory()->withHeader('If-None-Match', $ifNoneMatch);

$res = $this->createResponse()->withHeader('Etag', $etag);
$res = $cache->process($req, $this->createRequestHandler($res));

$this->assertEquals(200, $res->getStatusCode());
}

public function testETagReturnsNoBodyOnCacheHitWhenAStreamFactoryIsProvided(): void
{
$etag = 'abc';
$cache = $this->createCache('private', 86400, false, true);
$req = $this->requestFactory()->withHeader('If-None-Match', $etag);

$res = $this->createResponse()->withHeader('Etag', $etag);
$res->getBody()->write('payload data');
$res = $cache->process($req, $this->createRequestHandler($res));

self::assertSame(304, $res->getStatusCode());
self::assertSame('', (string) $res->getBody());
}

public function testLastModifiedReturnsNoBodyOnCacheHitWhenAStreamFactoryIsProvided(): void
{
$now = time() + 86400;
$lastModified = gmdate('D, d M Y H:i:s T', $now);
$ifModifiedSince = gmdate('D, d M Y H:i:s T', $now);
$cache = $this->createCache('private', 86400, false, true);

$req = $this->requestFactory()->withHeader('If-Modified-Since', $ifModifiedSince);
$res = $this->createResponse()->withHeader('Last-Modified', $lastModified);
$res->getBody()->write('payload data');

$res = $cache->process($req, $this->createRequestHandler($res));

self::assertEquals(304, $res->getStatusCode());
self::assertSame('', (string) $res->getBody());
}

private function createCache(string $type, int $maxAge, bool $mustRevalidate, bool $withStreamFactory): Cache
{
$streamFactory = $withStreamFactory ? new StreamFactory() : null;
return new Cache($type, $maxAge, $mustRevalidate, $streamFactory);
}
}