feat: support gzip (#16)

spacewander · web-flow · commit c623044bbfbe · 2021-07-16T09:09:13.000+08:00
diff --git a/lib/resty/apisix/response.lua b/lib/resty/apisix/response.lua
@@ -0,0 +1,36 @@
+local ffi = require("ffi")
+local base = require("resty.core.base")
+local get_request = base.get_request
+local C = ffi.C
+local NGX_ERROR = ngx.ERROR
+
+
+base.allows_subsystem("http")
+
+
+ffi.cdef[[
+typedef intptr_t ngx_int_t;
+ngx_int_t
+ngx_http_apisix_set_gzip(ngx_http_request_t *r, ngx_int_t num, size_t size,
+    ngx_int_t level);
+]]
+
+
+local _M = {}
+
+
+-- opts contains
+-- * buffer_num
+-- * buffer_size
+-- * compress_level
+function _M.set_gzip(opts)
+    local r = get_request()
+    local rc = C.ngx_http_apisix_set_gzip(r, opts.buffer_num, opts.buffer_size, opts.compress_level)
+    if rc == NGX_ERROR then
+        return nil, "no memory"
+    end
+    return true
+end
+
+
+return _M
diff --git a/patch/1.19.3/nginx-gzip.patch b/patch/1.19.3/nginx-gzip.patch
@@ -0,0 +1,144 @@
+diff --git src/http/modules/ngx_http_gzip_filter_module.c src/http/modules/ngx_http_gzip_filter_module.c
+index c75169c..35b8433 100644
+--- src/http/modules/ngx_http_gzip_filter_module.c
++++ src/http/modules/ngx_http_gzip_filter_module.c
+@@ -8,6 +8,9 @@
+ #include <ngx_config.h>
+ #include <ngx_core.h>
+ #include <ngx_http.h>
++#if (NGX_HTTP_APISIX)
++#include <ngx_http_apisix_module.h>
++#endif
+ 
+ #include <zlib.h>
+ 
+@@ -225,6 +228,26 @@ ngx_http_gzip_header_filter(ngx_http_request_t *r)
+ 
+     conf = ngx_http_get_module_loc_conf(r, ngx_http_gzip_filter_module);
+ 
++#if (NGX_HTTP_APISIX)
++    if ((r->headers_out.status != NGX_HTTP_OK
++            && r->headers_out.status != NGX_HTTP_FORBIDDEN
++            && r->headers_out.status != NGX_HTTP_NOT_FOUND)
++        || (r->headers_out.content_encoding
++            && r->headers_out.content_encoding->value.len)
++        || r->header_only)
++    {
++        return ngx_http_next_header_filter(r);
++    }
++
++    if (!ngx_http_apisix_is_gzip_set(r)
++        && (!conf->enable
++            || (r->headers_out.content_length_n != -1
++                && r->headers_out.content_length_n < conf->min_length)
++            || ngx_http_test_content_type(r, &conf->types) == NULL))
++    {
++        return ngx_http_next_header_filter(r);
++    }
++#else
+     if (!conf->enable
+         || (r->headers_out.status != NGX_HTTP_OK
+             && r->headers_out.status != NGX_HTTP_FORBIDDEN
+@@ -238,6 +261,7 @@ ngx_http_gzip_header_filter(ngx_http_request_t *r)
+     {
+         return ngx_http_next_header_filter(r);
+     }
++#endif
+ 
+     r->gzip_vary = 1;
+ 
+@@ -515,7 +539,18 @@ ngx_http_gzip_filter_memory(ngx_http_request_t *r, ngx_http_gzip_ctx_t *ctx)
+          * 16-byte padding in one out of the two window-sized buffers.
+          */
+ 
++#if (NGX_HTTP_APISIX)
++        ngx_int_t       level;
++
++        level = ngx_http_apisix_get_gzip_compress_level(r);
++        if (level == NGX_DECLINED) {
++            level = conf->level;
++        }
++
++        if (level == 1) {
++#else
+         if (conf->level == 1) {
++#endif
+             wbits = ngx_max(wbits, 13);
+         }
+ 
+@@ -615,6 +650,21 @@ ngx_http_gzip_filter_deflate_start(ngx_http_request_t *r,
+     ctx->zstream.zfree = ngx_http_gzip_filter_free;
+     ctx->zstream.opaque = ctx;
+ 
++#if (NGX_HTTP_APISIX)
++    ngx_int_t           level;
++
++    level = ngx_http_apisix_get_gzip_compress_level(r);
++    if (level == NGX_DECLINED) {
++        level = conf->level;
++    }
++
++    rc = deflateInit2(&ctx->zstream, (int) level, Z_DEFLATED,
++                      ctx->wbits + 16, ctx->memlevel, Z_DEFAULT_STRATEGY);
++#else
++    rc = deflateInit2(&ctx->zstream, (int) conf->level, Z_DEFLATED,
++                      ctx->wbits + 16, ctx->memlevel, Z_DEFAULT_STRATEGY);
++#endif
++
+     rc = deflateInit2(&ctx->zstream, (int) conf->level, Z_DEFLATED,
+                       ctx->wbits + 16, ctx->memlevel, Z_DEFAULT_STRATEGY);
+ 
+@@ -705,6 +755,16 @@ ngx_http_gzip_filter_get_buf(ngx_http_request_t *r, ngx_http_gzip_ctx_t *ctx)
+ 
+     conf = ngx_http_get_module_loc_conf(r, ngx_http_gzip_filter_module);
+ 
++#if (NGX_HTTP_APISIX)
++    ngx_int_t           num;
++    size_t              size;
++
++    if (ngx_http_apisix_get_gzip_buffer_conf(r, &num, &size) == NGX_DECLINED) {
++        num = conf->bufs.num;
++        size = conf->bufs.size;
++    }
++#endif
++
+     if (ctx->free) {
+ 
+         cl = ctx->free;
+@@ -713,9 +773,15 @@ ngx_http_gzip_filter_get_buf(ngx_http_request_t *r, ngx_http_gzip_ctx_t *ctx)
+ 
+         ngx_free_chain(r->pool, cl);
+ 
++#if (NGX_HTTP_APISIX)
++    } else if (ctx->bufs < num) {
++
++        ctx->out_buf = ngx_create_temp_buf(r->pool, size);
++#else
+     } else if (ctx->bufs < conf->bufs.num) {
+ 
+         ctx->out_buf = ngx_create_temp_buf(r->pool, conf->bufs.size);
++#endif
+         if (ctx->out_buf == NULL) {
+             return NGX_ERROR;
+         }
+diff --git src/http/ngx_http_core_module.c src/http/ngx_http_core_module.c
+index b900467..160e512 100644
+--- src/http/ngx_http_core_module.c
++++ src/http/ngx_http_core_module.c
+@@ -2065,9 +2065,16 @@ ngx_http_gzip_ok(ngx_http_request_t *r)
+         return NGX_DECLINED;
+     }
+ 
++#if (NGX_HTTP_APISIX)
++    if (!ngx_http_apisix_is_gzip_set(r)
++        && r->http_version < clcf->gzip_http_version) {
++        return NGX_DECLINED;
++    }
++#else
+     if (r->http_version < clcf->gzip_http_version) {
+         return NGX_DECLINED;
+     }
++#endif
+ 
+     if (r->headers_in.via == NULL) {
+         goto ok;
diff --git a/src/ngx_http_apisix_module.c b/src/ngx_http_apisix_module.c
@@ -329,3 +329,83 @@ ngx_http_apisix_client_max_body_size(ngx_http_request_t *r)
 
     return clcf->client_max_body_size;
 }
+
+
+ngx_int_t
+ngx_http_apisix_is_gzip_set(ngx_http_request_t *r)
+{
+    ngx_http_apisix_ctx_t          *ctx;
+
+    ctx = ngx_http_apisix_get_module_ctx(r->main);
+    if (ctx == NULL || ctx->gzip == NULL) {
+        return 0;
+    }
+
+    ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0, "apisix gzip set");
+
+    return 1;
+}
+
+
+ngx_int_t
+ngx_http_apisix_get_gzip_buffer_conf(ngx_http_request_t *r, ngx_int_t *num,
+    size_t *size)
+{
+    ngx_http_apisix_ctx_t          *ctx;
+
+    ctx = ngx_http_apisix_get_module_ctx(r->main);
+    if (ctx == NULL || ctx->gzip == NULL) {
+        return NGX_DECLINED;
+    }
+
+    *num = ctx->gzip->buffer_num;
+    *size = ctx->gzip->buffer_size;
+
+    ngx_log_debug2(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
+                   "apisix gzip num:%i size:%z", *num, *size);
+
+    return NGX_OK;
+}
+
+
+ngx_int_t
+ngx_http_apisix_get_gzip_compress_level(ngx_http_request_t *r)
+{
+    ngx_http_apisix_ctx_t          *ctx;
+
+    ctx = ngx_http_apisix_get_module_ctx(r->main);
+    if (ctx == NULL || ctx->gzip == NULL) {
+        return NGX_DECLINED;
+    }
+
+    ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
+                   "apisix gzip level:%i", ctx->gzip->level);
+
+    return ctx->gzip->level;
+}
+
+
+ngx_int_t
+ngx_http_apisix_set_gzip(ngx_http_request_t *r, ngx_int_t num, size_t size,
+    ngx_int_t level)
+{
+    ngx_http_apisix_ctx_t          *ctx;
+    ngx_http_apisix_gzip_t         *gzip;
+
+    ctx = ngx_http_apisix_get_module_ctx(r->main);
+    if (ctx == NULL) {
+        return NGX_ERROR;
+    }
+
+    gzip = ngx_palloc(r->pool, sizeof(ngx_http_apisix_gzip_t));
+    if (gzip == NULL) {
+        return NGX_ERROR;
+    }
+
+    gzip->level = level;
+    gzip->buffer_num = num;
+    gzip->buffer_size = size;
+
+    ctx->gzip = gzip;
+    return NGX_OK;
+}
diff --git a/src/ngx_http_apisix_module.h b/src/ngx_http_apisix_module.h
@@ -10,12 +10,21 @@ typedef struct {
 } ngx_http_apisix_loc_conf_t;
 
 
+typedef struct {
+    ngx_int_t       buffer_num;
+    size_t          buffer_size;
+    ngx_int_t       level;
+} ngx_http_apisix_gzip_t;
+
+
 typedef struct {
     STACK_OF(X509)      *upstream_cert;
     EVP_PKEY            *upstream_pkey;
 
     off_t                client_max_body_size;
 
+    ngx_http_apisix_gzip_t *gzip;
+
     unsigned             client_max_body_size_set:1;
 } ngx_http_apisix_ctx_t;
 
@@ -25,5 +34,10 @@ void ngx_http_apisix_set_upstream_ssl(ngx_http_request_t *r, ngx_connection_t *c
 ngx_flag_t ngx_http_apisix_delay_client_max_body_check(ngx_http_request_t *r);
 off_t ngx_http_apisix_client_max_body_size(ngx_http_request_t *r);
 
+ngx_int_t ngx_http_apisix_is_gzip_set(ngx_http_request_t *r);
+ngx_int_t ngx_http_apisix_get_gzip_buffer_conf(ngx_http_request_t *r,
+    ngx_int_t *num, size_t *size);
+ngx_int_t ngx_http_apisix_get_gzip_compress_level(ngx_http_request_t *r);
+
 
 #endif /* _NGX_HTTP_APISIX_H_INCLUDED_ */
diff --git a/t/gzip.t b/t/gzip.t
@@ -0,0 +1,35 @@
+use t::APISIX_NGINX 'no_plan';
+
+run_tests();
+
+__DATA__
+
+=== TEST 1: set gzip
+--- config
+location /t {
+    content_by_lua_block {
+        ngx.say(("1024"):rep(1024))
+    }
+    header_filter_by_lua_block {
+        local response = require "resty.apisix.response"
+        local ok, err = response.set_gzip({
+            buffer_num = 4,
+            buffer_size = 8192,
+            compress_level = 2,
+        })
+        if not ok then
+            ngx.log(ngx.ERR, err)
+        end
+    }
+    log_by_lua_block {
+        ngx.log(ngx.WARN, "content-encoding: ", ngx.var.sent_http_content_encoding)
+    }
+}
+--- more_headers
+Accept-Encoding: gzip
+--- error_log
+apisix gzip level:2
+apisix gzip num:4 size:8192
+content-encoding: gzip
+--- no_error_log
+[error]
