0.19.0
CHANGES:
This release is a complete rewrite of the Opium's internal that switches from Cohttp to Httpaf.
As demonstrated in several benchmarks, Httpaf's latency is much lower than Cohttp's in stress tests, so it is expected that Opium will perform better in these high pressure situations with this change.
The underlying HTTP server implementation is now contained in the rock
package, that provides a Service and Filter implementation, inspired by Finagle's. The architecture is similar to Ruby's Rack library (hence the name), so one can compose complex web applications by combining Rock applications.
The rock
package offers a very slim API, with very few dependencies, so it should be an attractive option for other Web framework to build on, which would allow the re-usability of middlewares and handlers, independently of the framework used (e.g. one could use Sihl middlewares with Opium, and vice versa).
Apart from the architectural changes, this release comes with a lot of additionnal utilities and middlewares which should make Opium a better candidate for complex web applications, without having to re-write a lot of common Web server functionnalities.
The Request and Response modules now provide:
- JSON encoders/decoders with
Yojson
- HTML encoders/decoders with
Tyxml
- XML encoders/decoders with
Tyxml
- SVG encoders/decoders with
Tyxml
- multipart/form encoders/decoders with
multipart_form_data
- urlencoded encoders/decoders with
Uri
And the following middlewares are now built-in:
debugger
to display an HTML page with the errors in case of failureslogger
to log requests and responses, with a timerallow_cors
to add CORS headersstatic
to serve static content given a custom read function (e.g. read from S3)static_unix
to to serve static content from the local filesystemcontent_length
to add theContent-Length
header to responsesmethod_override
to replace the HTTP method with the one found in the_method
field ofapplication/x-www-form-urlencoded
encodedPOST
requests.etag
to addETag
header to the responses and send an HTTP code304
when the computed ETag matches the one specified in the request.method_required
to filter the requests by method and respond with an HTTP code405
if the method is not allowed.head
to add supports forHEAD
request for handlers that receiveGET
requests.
Lastly, this release also adds a package opium-testing
that can be used to test Opium applications with Alcotest
. It provides Testable
modules for every Opium types, and implements helper functions to easily get an Opium.Response
from an Opium.Request
.