Mercurial > hg > ngx_http_delay_body_filter_module

changeset 0:a386f95c5ae9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial module skeleton. Mostly based on catch body filter. Does not work yet.
author Maxim Dounin <mdounin@mdounin.ru>
date Tue, 17 Aug 2021 22:51:56 +0300
parents
children 7c2d64d9c656
files LICENSE README config ngx_http_delay_body_filter_module.c t/delay_body.t
diffstat 5 files changed, 297 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,26 @@
+/* 
+ * Copyright (C) 2021 Maxim Dounin
+ * Copyright (C) 2021 Nginx, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
new file mode 100644
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+Delay body filter module for nginx.
+
+This is a test module, to check request body filters buffering
+mechanism to be introduced.
+
+Example:
+
+    location / {
+        delay_body 1s;
+    }
+
+The module will delay the request body processing for the configured time.
+
+To compile nginx with the delay body module, use the "--add-module <path>"
+option of nginx configure.
new file mode 100644
--- /dev/null
+++ b/config
@@ -0,0 +1,10 @@
+# (C) Maxim Dounin
+# Configuration for ngx_http_delay_body_filter_module.
+
+ngx_addon_name="ngx_http_delay_body_filter_module"
+
+HTTP_MODULES="$HTTP_MODULES \
+		ngx_http_delay_body_filter_module"
+
+NGX_ADDON_SRCS="$NGX_ADDON_SRCS \
+		$ngx_addon_dir/ngx_http_delay_body_filter_module.c"
new file mode 100644
--- /dev/null
+++ b/ngx_http_delay_body_filter_module.c
@@ -0,0 +1,134 @@
+
+/*
+ * Copyright (C) Maxim Dounin
+ */
+
+#include <ngx_config.h>
+#include <ngx_core.h>
+#include <ngx_http.h>
+
+
+typedef struct {
+    ngx_msec_t  delay;
+} ngx_http_delay_body_conf_t;
+
+
+static void *ngx_http_delay_body_create_conf(ngx_conf_t *cf);
+static char *ngx_http_delay_body_merge_conf(ngx_conf_t *cf, void *parent,
+    void *child);
+static ngx_int_t ngx_http_delay_body_init(ngx_conf_t *cf);
+
+
+static ngx_command_t  ngx_http_delay_body_commands[] = {
+
+    { ngx_string("delay_body"),
+      NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG,
+      ngx_conf_set_msec_slot,
+      NGX_HTTP_LOC_CONF_OFFSET,
+      offsetof(ngx_http_delay_body_conf_t, delay),
+      NULL },
+
+      ngx_null_command
+};
+
+
+static ngx_http_module_t  ngx_http_delay_body_module_ctx = {
+    NULL,                          /* preconfiguration */
+    ngx_http_delay_body_init,      /* postconfiguration */
+
+    NULL,                          /* create main configuration */
+    NULL,                          /* init main configuration */
+
+    NULL,                          /* create server configuration */
+    NULL,                          /* merge server configuration */
+
+    ngx_http_delay_body_create_conf, /* create location configuration */
+    ngx_http_delay_body_merge_conf   /* merge location configuration */
+};
+
+
+ngx_module_t  ngx_http_delay_body_filter_module = {
+    NGX_MODULE_V1,
+    &ngx_http_delay_body_module_ctx, /* module context */
+    ngx_http_delay_body_commands,  /* module directives */
+    NGX_HTTP_MODULE,               /* module type */
+    NULL,                          /* init master */
+    NULL,                          /* init module */
+    NULL,                          /* init process */
+    NULL,                          /* init thread */
+    NULL,                          /* exit thread */
+    NULL,                          /* exit process */
+    NULL,                          /* exit master */
+    NGX_MODULE_V1_PADDING
+};
+
+
+static ngx_http_request_body_filter_pt   ngx_http_next_request_body_filter;
+
+
+static ngx_int_t
+ngx_http_delay_body_filter(ngx_http_request_t *r, ngx_chain_t *in)
+{
+    ngx_chain_t                 *cl;
+    ngx_http_delay_body_conf_t  *conf;
+
+    conf = ngx_http_get_module_loc_conf(r, ngx_http_delay_body_filter_module);
+
+    if (!conf->delay) {
+        return ngx_http_next_request_body_filter(r, in);
+    }
+
+    ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
+                   "delay request body filter");
+
+    /* TODO: delay */
+
+    for (cl = in; cl; cl = cl->next) {
+
+        if (cl->buf->last_buf) {
+            ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
+                           "delay body: last buf");
+        }
+
+    }
+
+    return ngx_http_next_request_body_filter(r, in);
+}
+
+
+static void *
+ngx_http_delay_body_create_conf(ngx_conf_t *cf)
+{
+    ngx_http_delay_body_conf_t  *conf;
+
+    conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_delay_body_conf_t));
+    if (conf == NULL) {
+        return NULL;
+    }
+
+    conf->delay = NGX_CONF_UNSET_MSEC;
+
+    return conf;
+}
+
+
+static char *
+ngx_http_delay_body_merge_conf(ngx_conf_t *cf, void *parent, void *child)
+{
+    ngx_http_delay_body_conf_t *prev = parent;
+    ngx_http_delay_body_conf_t *conf = child;
+
+    ngx_conf_merge_msec_value(conf->delay, prev->delay, 0);
+
+    return NGX_CONF_OK;
+}
+
+
+static ngx_int_t
+ngx_http_delay_body_init(ngx_conf_t *cf)
+{
+    ngx_http_next_request_body_filter = ngx_http_top_request_body_filter;
+    ngx_http_top_request_body_filter = ngx_http_delay_body_filter;
+
+    return NGX_OK;
+}
new file mode 100644
--- /dev/null
+++ b/t/delay_body.t
@@ -0,0 +1,112 @@
+#!/usr/bin/perl
+
+# (C) Maxim Dounin
+
+# Tests for delay body filter module.
+
+###############################################################################
+
+use warnings;
+use strict;
+
+use Test::More;
+use Test::Nginx;
+
+use Socket qw/ CRLF /;
+
+###############################################################################
+
+select STDERR; $| = 1;
+select STDOUT; $| = 1;
+
+my $t = Test::Nginx->new()->has(qw/http proxy rewrite/)
+	->write_file_expand('nginx.conf', <<'EOF');
+
+%%TEST_GLOBALS%%
+
+daemon off;
+
+events {
+}
+
+http {
+    %%TEST_GLOBALS_HTTP%%
+
+    server {
+        listen       127.0.0.1:8080;
+        server_name  localhost;
+        location / {
+            delay_body 1s;
+            add_header X-Time $request_time;
+            proxy_pass http://127.0.0.1:8080/empty;
+        }
+        location /empty {
+            return 200 "test response body\n";
+        }
+    }
+}
+
+EOF
+
+$t->try_run('no delay_body')->plan(4);
+
+###############################################################################
+
+like(get_body('/', '123456'), qr/200 OK.*X-Time: 1/ms, 'delay');
+like(get_body('/empty', '123456'), qr/200 OK.*X-Time: 0/ms, 'no delay');
+
+# pipelining
+
+like(get_body('/', '123456', '12345X'),
+	qr/200 OK.*X-Time: 1.*200 OK.*X-Time: 1/ms,
+	'pipelining delay');
+
+# pipelining with chunked
+
+like(get_chunked('/', '123456', '12345X'),
+	qr/200 OK.*X-Time: 1.*200 OK.*X-Time: 1/ms,
+	'pipelining chunked delay');
+
+###############################################################################
+
+sub get_body {
+	my $uri = shift;
+	my $last = pop;
+	return http( join '', (map {
+		my $body = $_;
+		"GET $uri HTTP/1.1" . CRLF
+		. "Host: localhost" . CRLF
+		. "Content-Length: " . (length $body) . CRLF . CRLF
+		. $body
+	} @_),
+		"GET $uri HTTP/1.1" . CRLF
+		. "Host: localhost" . CRLF
+		. "Connection: close" . CRLF
+		. "Content-Length: " . (length $last) . CRLF . CRLF
+		. $last
+	);
+}
+
+sub get_chunked {
+	my $uri = shift;
+	my $last = pop;
+	return http( join '', (map {
+		my $body = $_;
+		"GET $uri HTTP/1.1" . CRLF
+		. "Host: localhost" . CRLF
+		. "Transfer-Encoding: chunked" . CRLF . CRLF
+		. sprintf("%x", length $body) . CRLF
+		. $body . CRLF
+		. "0" . CRLF . CRLF
+	} @_),
+		"GET $uri HTTP/1.1" . CRLF
+		. "Host: localhost" . CRLF
+		. "Connection: close" . CRLF
+		. "Transfer-Encoding: chunked" . CRLF . CRLF
+		. sprintf("%x", length $last) . CRLF
+		. $last . CRLF
+		. "0" . CRLF . CRLF
+	);
+}
+
+###############################################################################