Skip to content

Latest commit

 

History

History
204 lines (155 loc) · 7.08 KB

Changes.md

File metadata and controls

204 lines (155 loc) · 7.08 KB
Raw

Changes for Simple_httpd

Changes

Author: Christophe Raffalli better copying in vfs_path (no more use of Sys.command and do not copy if mtime says so)

Author: Christophe Raffalli add --exclude option to vfs_path

Author: Christophe Raffalli better header for caching

Author: Christophe Raffalli Dir: avoid redirection for index.html when dowloading folder

Author: Christophe Raffalli Add in Server and Host a redirect_https function

Author: Christophe Raffalli SSL protocol in Address is now the min version. Max version is the max supported version (TLS 1.3)

Author: Christophe Raffalli Manage in Dir module (and therefore VFS) the header If-Modified-Since

Initial announce (tag 1.0-alpha2)

I am pleased to announce the first alpha release of Simple_httpd, available on github and opam. It is a library to produce web server and sites.

Documentation: https://raffalli.eu/simple_httpd/simple_httpd Github : https://github.com/craff/simple_httpd

WARNING: currently we need the latest master of ocaml-ssl. It requires Linux and OCaml 5.0, if you have this, you can install with:

  opam pin add https://github.com/savonet/ocaml-ssl#master -k git
  opam pin add https://github.com/craff/simple_httpd -k git

And test the template site (very simple, as it is an empty shell to start from) with

  cd source_dir/template
  dune exec -- ./server.exe --log-folder ./log

The template is also documented at https://raffalli.eu/simple_httpd/simple_httpd/template.html

It aims at

  • Being simple to use and rather complete (support ssl, chaml: an equivalent of php, but in OCaml and compiled, status and statistics, authentication, cookies, ...).

  • Being fast: our latencies and number of requests per seconds are very good, thanks to using linux epoll, eventfd, OCaml's effects and domains, ... The first page of the documentation shows some graphics, but here is a small comparison of latencies for a small 1kb file:

                 min        mean      50%       90%       95%      99%      max
  Simple_httpd  79.478µs 242.006µs 237.576µs 294.802µs 305.68µs 329.352µs  3.049ms
  Nginx        170.551µs 328.904µs 309.577µs 384.313µs 400.51µs 482.987µs 42.003ms
  Apaches      196.321µs 466.439µs 452.265µs 545.121µs 590.05µs 913.527µs  6.372ms

And a small chaml (our equivalent of php) against php-fpm from apache and nginx:

  Simple_httpd 146.944µs 285.044µs 280.552µs 341.175µs 356.497µs 507.305µs  8.069ms
  Nginx        411.151µs 793.437µs 653.131µs 796.300µs 882.268µs     2.9ms 44.504ms
  Apache       688.765µs   2.342ms 950.647µs   1.201ms   1.321ms   5.844ms   1.171s

These were obtained with vegeta at 1000 requests/s. Simple_httpd offers much more stable latencies under charge than nginx or apache.

If you want your own measurments, you need to setup nginx/php on ports 7080 and 7443, an apache/php on port 80 and 443. Then, you can run [./bench.sh] from the [tests] folder of the source tree. I would be happy to have measurments for a big server with more than 20 cores.

  • Currently only linux is supported.

Help, comments, bug reports, ... would be greatly appreciated, as this is alpha release, it is time for you to propose change in the design of the library.

My website https://raffalli.eu and therefore simple_httpd documentation are powered by simple_httpd (do we name this bootstrap ;-) ?

============================== OLD CHANGES DURING INITIAL DEV

0.12

  • add dep on seq
  • add a Html module with combinators to produce html
  • add Tiny_httpd_dir.VFS to emulate file systems
  • add a small program, tiny-httpd-vfs-pack, to pack directories and files (local or behind a URL) into a OCaml module using VFS
  • show small example of socket activation

0.11

  • breaking: remove deprecated path handlers based on scanf

  • breaking: more getter/setters for request/response, change signatures, make request/response private aliases

  • fix: release semaphore in case of exception in accept

  • feat: add a notion of Middleware

  • feat: add ?middlewares param to create

  • feat: add ?get_time_s param to create

  • feat: close connection if response's headers contains connection

  • feat: store start_time in request

  • feat: implement connection timeout using socket options Default is max_keep_alive = -1.0 which preserves the original behaviour.

  • feat: in server-sent-events, add a close() function

  • refactor(zip): compression is now a middleware

  • perf: pass buf_size in many places, set default buf_size to 16kb

  • example: update echo to provide a /stats/ endpoint using a middleware

0.10

  • feat: allow socket activation by passing a raw unix socket to create
  • fix: Unix.accept may raise an exception (typicall Unix.EINTR, even with sigpipe blocked ?), prevent the server from stopping

0.9

  • support handlers that stream server-sent events to client

0.8

  • bump to ocaml 4.04

  • Validate header key's character set (#15)

  • perf: simpler parsing of headers

  • fix: workaround for css/js in http_of_dir (#16)

  • fix(urlencode): encode non ascii chars

0.7

  • feat: add rest_of_path_urlencoded and rename rest to rest_of_path
  • feat: http_of_dir: redirect to index.html if present
  • fix: http_of_dir: do not url-encode '/' in paths
  • feat: add Route.rest to match the rest of the path
  • feat: printing routes

0.6

  • feat: add Route.t construct, deprecate scanf, add more structured path

  • feat: use chunked encoding for large string responses, in addition to streams

  • refactor(echo): simplify code, use gzip aggressively

  • accept http1.0

  • fix: do not output a content-length for a chunked response

  • fix: set transfer-encoding header when returning a chunked stream

  • fix(zip): handle case where camlzip consumes 0 bytes

  • feat(zip): also compress string responses if they're big

  • add more debug msg

0.5

  • new tiny_httpd_camlzip library for handling deflate compression
  • feat: expose Headers.empty
  • fix: use the non-query path for routing
  • feat(util): add some query related utils

0.4

  • easy accessor to the query parameters in path
  • fix: header field names are case insensitive
  • doc: add note on jemalloc in the readme
  • log error when closing client socket

0.3

  • feat(http_of_dir): use file to guess mime type of file

  • feat: allow handlers to take streams

  • feat(bin): disable uploading by default

  • feat: add Tiny_httpd_util.parse_query for query decoding

  • feat(bin): set charset to utf8

  • feat: autodetect ipv6 address

  • feat: support ipv6 address

  • fix: missing crlf between chunks

  • fix: read_all must return rather than blocking when done

  • fix: proper amortized O(1) push in Buf.push

  • fix: %X for percent_encode; use percent_decode in parse_query

0.2

  • feat(bin): count number of hidden files
  • feat(bin): use details for hiding hidden files by default
  • fix: improved percent encoding of paths
  • feat: add percent encoding/decoding
  • feat(bin): better human-size display
  • feat: in http_of_dir, sort entries and display their size
  • fix(http_of_dir): handle bad symlinks
  • improve docs and opam, tidy up for 0.1