wyrihaximus/react-http-middleware-response-cache

Response caching middleware for @reactphp's HTTP server

3.1.0 2019-07-12 18:59 UTC

Requires

• php: ^7.2
• lcobucci/clock: ^1.1
• psr/http-message: ^1.0
• react/cache: ^1.0 || 0.6 || ^0.5.0
• react/http: ^0.8.0
• react/promise: ^2.7
• wyrihaximus/msgpack: ^1.0

Requires (Dev)

• ringcentral/psr7: ^1.2
• wyrihaximus/async-test-utilities: ^1.1

MIT

• Cees-Jan Kiewiet

README

Install

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/react-http-middleware-response-cache

This middleware caches the response code and body from a list of given URL's. Note that not headers will be cached at this point. The middleware accepts a cache configuration implementing CacheConfigurationInterface as first argument which will decide when to store something in the cache and what. As second argument it accepts a cache implementing CacheInterface so either ArrayCache shipping with react/cache or any cache implementing CacheInterface from the cache implementations listed at the ReactPHP users wiki.

Usage

$server = new Server([
    /** Other middleware */
    new ResponseCacheMiddleware(
        new CacheConfiguration(
            [
                '/',
                '/robots.txt',
                '/favicon.ico',
                '/cache/***', // Anything that starts with /cache/ in the path will be cached
                '/api/???', // Anything that starts with /cache/ in the path will be cached (query is included in the cache key)
            ],
            [ // Optional, array with headers to include in the cache
                'Content-Type',
            ]
        ),
        new ArrayCache() // Optional, will default to ArrayCache but any CacheInterface cache will work. 
    ),
    /** Other middleware */
]);

Sessions

Using this middleware together with wyrihaximus/react-http-middleware-session then please take a look at wyrihaximus/react-http-middleware-response-cache-session-cache-configuration to ensure you don't serve cached responses to users with active sessions.

License

The MIT License (MIT)

Copyright (c) 2018 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.