http

Cache (RFC7234) middleware [WIP]

Cache middleware implements http-caching RFC 7234 (not fully yet).
It handles the following headers:

• Cache-Control
• max-age

Responses:

• Age

HTTP codes:

• OK (200)

Available backends:

• memory

Available methods:

• GET

Configuration

http:
  address: 127.0.0.1:44933
  middleware: ["cache"]
  # ...
  cache:
    driver: memory
    cache_methods: ["GET", "HEAD", "POST"] # only GET by default
    config: {}

For the worker sample and other docs, please, refer to the http plugin

• GZIP HTTP middleware

http:
  address: 127.0.0.1:55555
  max_request_size: 1024
  access_logs: false
  middleware: ["gzip"]

  pool:
    num_workers: 2
    max_jobs: 0
    allocate_timeout: 60s
    destroy_timeout: 60s

Used to compress incoming or outgoing data with the default gzip compression level.

Headers and CORS HTTP middleware

RoadRunner can automatically set up request/response headers and control CORS for your application.

CORS

To enable CORS headers add the following section to your configuration.

http:
  address: 127.0.0.1:44933
  middleware: ["headers"]
  # ...
  headers:
    cors:
      allowed_origin: "*"
      allowed_headers: "*"
      allowed_methods: "GET,POST,PUT,DELETE"
      allow_credentials: true
      exposed_headers: "Cache-Control,Content-Language,Content-Type,Expires,Last-Modified,Pragma"
      max_age: 600

Make sure to declare "headers" middleware.

Custom headers for Response or Request

You can control additional headers to be set for outgoing responses and headers to be added to the request sent to your application.

http:
  # ...
  headers:
      # Automatically add headers to every request passed to PHP.
      request:
        Example-Request-Header: "Value"
    
      # Automatically add headers to every response.
      response:
        X-Powered-By: "RoadRunner"

• NewRelic

http:
  address: 127.0.0.1:55555
  max_request_size: 1024
  access_logs: false
  middleware: [ "new_relic" ]
  new_relic:
    app_name: "app"
    license_key: "key"

  pool:
    num_workers: 2
    max_jobs: 0
    allocate_timeout: 60s
    destroy_timeout: 60s

License key and application name could be set via environment variables: (leave app_name and license_key empty)

• license_key: NEW_RELIC_LICENSE_KEY.
• app_name: NEW_RELIC_APP_NAME.

To set the New Relic attributes, the PHP worker should send headers values witing the rr_newrelic header key. Attributes should be separated by the :, for example foo:bar, where foo is a key and bar is a value. New Relic attributes sent from the worker will not appear in the HTTP response, they will be sent directly to the New Relic.

To see the sample of the PHP library, see the @arku31 implementation: https://github.com/arku31/roadrunner-newrelic

The special key which PHP may set to overwrite the transaction name is: transaction_name. For example: transaction_name:foo means: set transaction name as foo. By default, RequestURI is used as the transaction name.

Custom PHP Response

        $resp = new \Nyholm\Psr7\Response();
        $rrNewRelic = [
            'shopId:1', //custom data
            'auth:password', //custom data
            'transaction_name:test_transaction' //name - special key to override the name. By default it will use requestUri.
        ];

        $resp = $resp->withHeader('rr_newrelic', $rrNewRelic);

Where:

• shopId:1, auth:password - is a custom data that should be attached to the RR New Relic transaction.
• transaction_name - is a special header type to overwrite the default transaction name (RequestURI).

• X-Sendfile

http:
  address: 127.0.0.1:55555
  max_request_size: 1024
  access_logs: false
  middleware: ["sendfile"]

  pool:
    num_workers: 2
    max_jobs: 0
    allocate_timeout: 60s
    destroy_timeout: 60s

HTTP middleware to handle X-Sendfile header Middleware reads the file in 10MB chunks. So, for example for the 5Gb file, only 10MB of RSS will be used. If the file size is smaller than 10MB, the middleware fits the buffer to the file size.

Serving static content

It is possible to serve static content using RoadRunner.

Enable HTTP Middleware

To enable static content serving use the configuration inside the http section:

http:
  # host and port separated by semicolon
  address: 127.0.0.1:44933
  # ...
    static:
      dir: "."
      forbid: [""]
      allow: [".txt", ".php"]
      calculate_etag: false
      weak: false
      request:
        input: "custom-header"
      response:
        output: "output-header"

Where:

1. dir: path to the directory.
2. forbid: file extensions that should not be served.
3. allow: file extensions which should be served (empty - serve all except forbidden). If extension presented in both (allow and forbid) hashmaps - that treated as we should forbid file extension.
4. calculate_etag: turn on etag computation for the static file.
5. weak: use a weak generator (/W), it uses only filename to generate a CRC32 sum. If false - all file content used to generate CRC32 sum.
6. request/response: custom headers for the static files.

To combine static content with other middleware, use the following sequence (static will always be the last in the row, file server will apply headers and gzip plugins):

http:
  # host and port separated by semicolon
  address: 127.0.0.1:44933
  # ...
  middleware: [ "headers", "gzip" ]
  # ...
  headers:
    # ...
    static:
      dir: "."
      forbid: [""]
      allow: [".txt", ".php"]
      calculate_etag: false
      weak: false
      request:
        input: "custom-header"
      response:
        output: "output-header"