From 01f57ad65d7c75fb455f48e354bb3a328c472ce4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 7 Jan 2013 22:42:16 +0100 Subject: Add optional automatic response body compression This behavior can be enabled with the `compress` protocol option. See the `compress_response` example for more details. All tests are now ran with and without compression for both HTTP and HTTPS. --- examples/README.md | 3 ++ examples/compress_response/README.md | 62 ++++++++++++++++++++++ examples/compress_response/rebar.config | 4 ++ .../src/compress_response.app.src | 15 ++++++ .../compress_response/src/compress_response.erl | 14 +++++ .../src/compress_response_app.erl | 26 +++++++++ .../src/compress_response_sup.erl | 23 ++++++++ examples/compress_response/src/toppage_handler.erl | 31 +++++++++++ examples/compress_response/start.sh | 3 ++ 9 files changed, 181 insertions(+) create mode 100644 examples/compress_response/README.md create mode 100644 examples/compress_response/rebar.config create mode 100644 examples/compress_response/src/compress_response.app.src create mode 100644 examples/compress_response/src/compress_response.erl create mode 100644 examples/compress_response/src/compress_response_app.erl create mode 100644 examples/compress_response/src/compress_response_sup.erl create mode 100644 examples/compress_response/src/toppage_handler.erl create mode 100755 examples/compress_response/start.sh (limited to 'examples') diff --git a/examples/README.md b/examples/README.md index c0e1f41..d50ebc9 100644 --- a/examples/README.md +++ b/examples/README.md @@ -4,6 +4,9 @@ Cowboy Examples * [chunked_hello_world](./examples/chunked_hello_world): demonstrates chunked data transfer with two one-second delays + * [compress_response](./examples/compress_response) + send a response body compressed if the client supports it + * [cookie](./examples/cookie): set cookies from server and client side diff --git a/examples/compress_response/README.md b/examples/compress_response/README.md new file mode 100644 index 0000000..8afbe65 --- /dev/null +++ b/examples/compress_response/README.md @@ -0,0 +1,62 @@ +Cowboy Compress Response +======================== + +To compile this example you need rebar in your PATH. + +Type the following command: +``` +$ rebar get-deps compile +``` + +You can then start the Erlang node with the following command: +``` +./start.sh +``` + +Then point your browser to the indicated URL. + +Example +------- + +``` bash +$ curl -i http://localhost:8080 +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Mon, 07 Jan 2013 18:42:29 GMT +content-length: 909 + +A cowboy is an animal herder who tends cattle on ranches in North America, +traditionally on horseback, and often performs a multitude of other ranch- +related tasks. The historic American cowboy of the late 19th century arose +from the vaquero traditions of northern Mexico and became a figure of special +significance and legend. A subtype, called a wrangler, specifically tends the +horses used to work cattle. In addition to ranch work, some cowboys work for +or participate in rodeos. Cowgirls, first defined as such in the late 19th +century, had a less-well documented historical role, but in the modern world +have established the ability to work at virtually identical tasks and obtained +considerable respect for their achievements. There are also cattle handlers +in many other parts of the world, particularly South America and Australia, +who perform work similar to the cowboy in their respective nations. + +$ curl -i --compressed http://localhost:8080 +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Mon, 07 Jan 2013 18:42:30 GMT +content-encoding: gzip +content-length: 510 + +A cowboy is an animal herder who tends cattle on ranches in North America, +traditionally on horseback, and often performs a multitude of other ranch- +related tasks. The historic American cowboy of the late 19th century arose +from the vaquero traditions of northern Mexico and became a figure of special +significance and legend. A subtype, called a wrangler, specifically tends the +horses used to work cattle. In addition to ranch work, some cowboys work for +or participate in rodeos. Cowgirls, first defined as such in the late 19th +century, had a less-well documented historical role, but in the modern world +have established the ability to work at virtually identical tasks and obtained +considerable respect for their achievements. There are also cattle handlers +in many other parts of the world, particularly South America and Australia, +who perform work similar to the cowboy in their respective nations. +``` diff --git a/examples/compress_response/rebar.config b/examples/compress_response/rebar.config new file mode 100644 index 0000000..6ad3062 --- /dev/null +++ b/examples/compress_response/rebar.config @@ -0,0 +1,4 @@ +{deps, [ + {cowboy, ".*", + {git, "git://github.com/extend/cowboy.git", "master"}} +]}. diff --git a/examples/compress_response/src/compress_response.app.src b/examples/compress_response/src/compress_response.app.src new file mode 100644 index 0000000..3512084 --- /dev/null +++ b/examples/compress_response/src/compress_response.app.src @@ -0,0 +1,15 @@ +%% Feel free to use, reuse and abuse the code in this file. + +{application, compress_response, [ + {description, "Cowboy Compress Response example."}, + {vsn, "1"}, + {modules, []}, + {registered, []}, + {applications, [ + kernel, + stdlib, + cowboy + ]}, + {mod, {compress_response_app, []}}, + {env, []} +]}. diff --git a/examples/compress_response/src/compress_response.erl b/examples/compress_response/src/compress_response.erl new file mode 100644 index 0000000..ac2636c --- /dev/null +++ b/examples/compress_response/src/compress_response.erl @@ -0,0 +1,14 @@ +%% Feel free to use, reuse and abuse the code in this file. + +-module(compress_response). + +%% API. +-export([start/0]). + +%% API. + +start() -> + ok = application:start(crypto), + ok = application:start(ranch), + ok = application:start(cowboy), + ok = application:start(compress_response). diff --git a/examples/compress_response/src/compress_response_app.erl b/examples/compress_response/src/compress_response_app.erl new file mode 100644 index 0000000..b5f3054 --- /dev/null +++ b/examples/compress_response/src/compress_response_app.erl @@ -0,0 +1,26 @@ +%% Feel free to use, reuse and abuse the code in this file. + +%% @private +-module(compress_response_app). +-behaviour(application). + +%% API. +-export([start/2]). +-export([stop/1]). + +%% API. + +start(_Type, _Args) -> + Dispatch = [ + {'_', [ + {[], toppage_handler, []} + ]} + ], + {ok, _} = cowboy:start_http(http, 100, [{port, 8080}], [ + {compress, true}, + {env, [{dispatch, Dispatch}]} + ]), + compress_response_sup:start_link(). + +stop(_State) -> + ok. diff --git a/examples/compress_response/src/compress_response_sup.erl b/examples/compress_response/src/compress_response_sup.erl new file mode 100644 index 0000000..d1bc312 --- /dev/null +++ b/examples/compress_response/src/compress_response_sup.erl @@ -0,0 +1,23 @@ +%% Feel free to use, reuse and abuse the code in this file. + +%% @private +-module(compress_response_sup). +-behaviour(supervisor). + +%% API. +-export([start_link/0]). + +%% supervisor. +-export([init/1]). + +%% API. + +-spec start_link() -> {ok, pid()}. +start_link() -> + supervisor:start_link({local, ?MODULE}, ?MODULE, []). + +%% supervisor. + +init([]) -> + Procs = [], + {ok, {{one_for_one, 10, 10}, Procs}}. diff --git a/examples/compress_response/src/toppage_handler.erl b/examples/compress_response/src/toppage_handler.erl new file mode 100644 index 0000000..68d0e09 --- /dev/null +++ b/examples/compress_response/src/toppage_handler.erl @@ -0,0 +1,31 @@ +%% Feel free to use, reuse and abuse the code in this file. + +%% @doc Compress response handler. +-module(toppage_handler). + +-export([init/3]). +-export([handle/2]). +-export([terminate/2]). + +init(_Transport, Req, []) -> + {ok, Req, undefined}. + +handle(Req, State) -> + BigBody = +<<"A cowboy is an animal herder who tends cattle on ranches in North America, +traditionally on horseback, and often performs a multitude of other ranch- +related tasks. The historic American cowboy of the late 19th century arose +from the vaquero traditions of northern Mexico and became a figure of special +significance and legend. A subtype, called a wrangler, specifically tends the +horses used to work cattle. In addition to ranch work, some cowboys work for +or participate in rodeos. Cowgirls, first defined as such in the late 19th +century, had a less-well documented historical role, but in the modern world +have established the ability to work at virtually identical tasks and obtained +considerable respect for their achievements. There are also cattle handlers +in many other parts of the world, particularly South America and Australia, +who perform work similar to the cowboy in their respective nations.\n">>, + {ok, Req2} = cowboy_req:reply(200, [], BigBody, Req), + {ok, Req2, State}. + +terminate(_Req, _State) -> + ok. diff --git a/examples/compress_response/start.sh b/examples/compress_response/start.sh new file mode 100755 index 0000000..2e79031 --- /dev/null +++ b/examples/compress_response/start.sh @@ -0,0 +1,3 @@ +#!/bin/sh +erl -pa ebin deps/*/ebin -s compress_response \ + -eval "io:format(\"Point your browser at http://localhost:8080~n\")." -- cgit v1.2.3