pass_headers_out

Author: dedok

README.md

@@ -361,15 +361,15 @@ Example
 
 tnt_pass_http_request
 ------------------
-**syntax:** *tnt_pass_http_request [on|off|parse_args|unescape|pass_body]*
+**syntax:** *tnt_pass_http_request [on|off|parse_args|unescape|pass_body|pass_headers_out]*
 
 **default:** *off*
 
 **context:** *location, location if*
 
 Allow to pass HTTP headers and queries to Tarantool stored procedures.
 
-Examples
+Examples #1
 ```nginx
   location tnt {
     # Also, tnt_pass_http_request can be used together with JSON communication
@@ -400,6 +400,30 @@ Examples
     req.body -- request body, type string
   end
 ```
+Examples #2 (pass_headers_out)
+```nginx
+  location @tnt {
+    tnt_http_rest_methods get;
+    tnt_pass_http_request on pass_headers_out;
+    tnt_method tarantool_stored_procedure_name;
+    tnt_pass 127.0.0.1:9999;
+  }
+
+  location / {
+    add_header "X-Req-time" "$request_time";
+    proxy_pass http://backend;
+    post_action @tnt;
+  }
+```
+```lua
+  function tarantool_stored_procedure_name(req, ...)
+    req.headers -- lua table
+    req.headers['X-Req-time'] -- set by add_header
+    req.query -- string
+    return true
+  end
+```
+
 ```bash
   # Call tarantool_stored_procedure_name()
   $> wget NGINX_HOST/tarantool_stored_procedure_name/some/mega/path?q=1

src/ngx_http_tnt_handlers.c

@@ -37,6 +37,49 @@
 
 extern ngx_module_t ngx_http_tnt_module;
 
+
+static inline ngx_int_t
+ngx_http_tnt_copy_headers(struct tp *tp,
+                          ngx_list_t *headers,
+                          size_t *map_items)
+{
+    size_t          i = 0;
+    ngx_table_elt_t *h;
+    ngx_list_part_t *part;
+
+    if (headers->size > 0) {
+
+        part = &headers->part;
+        h = part->elts;
+
+        for (;; i++) {
+
+            if (i >= part->nelts) {
+                if (part->next == NULL) {
+                    break;
+                }
+                part = part->next;
+                h = part->elts;
+                i = 0;
+            }
+
+            if (!tp_encode_str_map_item(tp,
+                                        (const char *) h[i].key.data,
+                                        h[i].key.len,
+                                        (const char *) h[i].value.data,
+                                        h[i].value.len) )
+            {
+                return NGX_ERROR;
+            }
+
+            ++(*map_items);
+        }
+    }
+
+    return NGX_OK;
+}
+
+
 static inline size_t
 ngx_http_tnt_get_output_size(
     ngx_http_request_t *r,
@@ -387,8 +430,6 @@ ngx_http_tnt_get_request_data(ngx_http_request_t *r,
     char            *map_place;
     size_t          root_items;
     size_t          map_items;
-    ngx_list_part_t *part;
-    ngx_table_elt_t *h;
     ngx_buf_t       *b;
     ngx_chain_t     *body;
     char            *p;
@@ -475,41 +516,24 @@ ngx_http_tnt_get_request_data(ngx_http_request_t *r,
         return NGX_ERROR;
     }
 
-    if (r->headers_in.headers.size) {
-
-        part = &r->headers_in.headers.part;
-        h = part->elts;
-
-        size_t i = 0;
-        for (;; i++) {
-
-            if (i >= part->nelts) {
-                if (part->next == NULL) {
-                    break;
-                }
-                part = part->next;
-                h = part->elts;
-                i = 0;
-            }
+    if (ngx_http_tnt_copy_headers(tp, &r->headers_in.headers, &map_items) ==
+            NGX_ERROR)
+    {
+        return NGX_ERROR;
+    }
 
-            ++map_items;
-            if (!tp_encode_str_map_item(tp,
-                                        (const char *)h[i].key.data,
-                                        h[i].key.len,
-                                        (const char *)h[i].value.data,
-                                        h[i].value.len))
-            {
-                return NGX_ERROR;
-            }
-        }
+    if ((tlcf->pass_http_request & NGX_TNT_CONF_PASS_HEADERS_OUT) &&
+        (ngx_http_tnt_copy_headers(tp, &r->headers_out.headers, &map_items) ==
+            NGX_ERROR) )
+    {
+        return NGX_ERROR;
     }
 
     *(map_place++) = 0xdf;
     *(uint32_t *) map_place = mp_bswap_u32(map_items);
 
     /* Encode body
      */
-
     if ((tlcf->pass_http_request & NGX_TNT_CONF_PASS_BODY) &&
             r->headers_in.content_length_n > 0 &&
             r->upstream->request_bufs )
@@ -521,8 +545,8 @@ ngx_http_tnt_get_request_data(ngx_http_request_t *r,
         }
 
         int sz = mp_sizeof_str(r->headers_in.content_length_n);
-	    if (tp_ensure(tp, sz) == -1) {
-		    return NGX_ERROR;
+        if (tp_ensure(tp, sz) == -1) {
+            return NGX_ERROR;
         }
 
         p = mp_encode_strl(tp->p, r->headers_in.content_length_n);

src/ngx_http_tnt_handlers.h

@@ -39,11 +39,12 @@
 
 
 typedef enum ngx_tnt_conf_states {
-    NGX_TNT_CONF_ON            = 1,
-    NGX_TNT_CONF_OFF           = 2,
-    NGX_TNT_CONF_PARSE_ARGS    = 4,
-    NGX_TNT_CONF_UNESCAPE      = 8,
-    NGX_TNT_CONF_PASS_BODY     = 16,
+    NGX_TNT_CONF_ON               = 1,
+    NGX_TNT_CONF_OFF              = 2,
+    NGX_TNT_CONF_PARSE_ARGS       = 4,
+    NGX_TNT_CONF_UNESCAPE         = 8,
+    NGX_TNT_CONF_PASS_BODY        = 16,
+    NGX_TNT_CONF_PASS_HEADERS_OUT = 32,
 } ngx_tnt_conf_states_e;
 
 /** The structure hold the nginx location variables, e.g. loc_conf.

src/ngx_http_tnt_module.c

@@ -94,6 +94,7 @@ static ngx_conf_bitmask_t  ngx_http_tnt_pass_http_request_masks[] = {
     { ngx_string("parse_args"), NGX_TNT_CONF_PARSE_ARGS },
     { ngx_string("unescape"), NGX_TNT_CONF_UNESCAPE },
     { ngx_string("pass_body"), NGX_TNT_CONF_PASS_BODY },
+    { ngx_string("pass_headers_out"), NGX_TNT_CONF_PASS_HEADERS_OUT },
     { ngx_null_string, 0 }
 };
 

test/ngx_confs/tnt_server_test.conf

@@ -204,5 +204,19 @@ http {
       tnt_method update;
       tnt_pass tnt;
     }
+
+    location @pass_headers_out {
+      tnt_pass_http_request on pass_body pass_headers_out;
+      tnt_http_rest_methods all;
+      tnt_method test_headers_out;
+      tnt_pass tnt;
+    }
+
+    location /headers_out {
+      add_header "x-added-header" $request_time;
+      post_action @pass_headers_out;
+      tnt_method update;
+      tnt_pass tnt;
+    }
    }
 }

test/test.lua

@@ -1,5 +1,6 @@
-json=require('json')
-yaml=require('yaml')
+json = require('json')
+yaml = require('yaml')
+os   = require('os')
 
 function echo_1(a)
   return {a}
@@ -128,3 +129,14 @@ function pass_body_handler(request, ...)
   end
   return { request, { ... } }
 end
+
+function touch(req, ...)
+  return {req, ... }
+end
+
+function test_headers_out(req)
+  if req.headers['x-added-header'] == nil then
+    os.exit(1)
+  end
+  return true
+end

test/v24_features.py

@@ -31,3 +31,9 @@
 preset_method_location = BASE_URL + '/dont_pass_body'
 result = post_success(preset_method_location, {"body": True}, {})
 assert (('body' in result[0]) == False), "body in result"
+
+# =============
+#
+print('[+] Headers out')
+preset_method_location = BASE_URL + '/headers_out'
+post_success(preset_method_location, {"body": True}, {})