apply suggestions

Author: Revolyssup

src/ngx_http_apisix_module.c

@@ -41,11 +41,11 @@ static ngx_command_t ngx_http_apisix_cmds[] = {
       offsetof(ngx_http_apisix_loc_conf_t, delay_client_max_body_check),
       NULL },
     {
-        ngx_string("apisix_request_id_var"),
+        ngx_string("lua_error_log_request_id"),
         NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
         ngx_http_apisix_error_log_request_id,
         NGX_HTTP_LOC_CONF_OFFSET,
-        offsetof(ngx_http_apisix_loc_conf_t, request_id_var_index),
+        offsetof(ngx_http_apisix_loc_conf_t, apisix_request_id_var_index),
         NULL
     },
     ngx_null_command
@@ -112,7 +112,7 @@ ngx_http_apisix_create_loc_conf(ngx_conf_t *cf)
     }
 
     conf->delay_client_max_body_check = NGX_CONF_UNSET;
-    conf->request_id_var_index = NGX_CONF_UNSET;
+    conf->apisix_request_id_var_index = NGX_CONF_UNSET;
     return conf;
 }
 
@@ -123,7 +123,7 @@ ngx_http_apisix_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
     ngx_http_apisix_loc_conf_t *prev = parent;
     ngx_http_apisix_loc_conf_t *conf = child;
 
-    ngx_conf_merge_value(conf->request_id_var_index, prev->request_id_var_index, NGX_CONF_UNSET);
+    ngx_conf_merge_value(conf->apisix_request_id_var_index, prev->apisix_request_id_var_index, NGX_CONF_UNSET);
     ngx_conf_merge_value(conf->delay_client_max_body_check,
                          prev->delay_client_max_body_check, 0);
 
@@ -843,7 +843,7 @@ ngx_http_apisix_is_ntls_enabled(ngx_http_conf_ctx_t *conf_ctx)
 /*
  * This function contains the logic to append the Request ID to
  * the error log line when being called.
- * Get the location configuration from helper function. Find indexed variable with the loc_conf->request_id_var_index. and add that to buffer.
+ * Get the location configuration from helper function. Find indexed variable with the loc_conf->apisix_request_id_var_index. and add that to buffer.
  */
 static u_char*
 ngx_http_apisix_error_log_handler(ngx_http_request_t *r, u_char *buf, size_t len)
@@ -852,11 +852,11 @@ ngx_http_apisix_error_log_handler(ngx_http_request_t *r, u_char *buf, size_t len
     ngx_http_apisix_loc_conf_t *loc_conf;
 
     loc_conf = ngx_http_get_module_loc_conf(r, ngx_http_apisix_module);
-    if (loc_conf->request_id_var_index == NGX_CONF_UNSET) {
+    if (loc_conf->apisix_request_id_var_index == NGX_CONF_UNSET) {
         return buf;
     }
 
-    request_id_var = ngx_http_get_indexed_variable(r, loc_conf->request_id_var_index);
+    request_id_var = ngx_http_get_indexed_variable(r, loc_conf->apisix_request_id_var_index);
     if (request_id_var == NULL || request_id_var->not_found) {
         return buf;
     }
@@ -959,8 +959,8 @@ ngx_http_apisix_error_log_request_id(ngx_conf_t *cf, ngx_command_t *cmd, void *c
     value[1].len--;
     value[1].data++;
 
-    loc_conf->request_id_var_index = ngx_http_get_variable_index(cf, &value[1]);
-    if (loc_conf->request_id_var_index == NGX_ERROR) {
+    loc_conf->apisix_request_id_var_index = ngx_http_get_variable_index(cf, &value[1]);
+    if (loc_conf->apisix_request_id_var_index == NGX_ERROR) {
         return NGX_CONF_ERROR;
     }
 

src/ngx_http_apisix_module.h

@@ -6,7 +6,7 @@
 
 typedef struct {
     ngx_flag_t      delay_client_max_body_check;
-    ngx_int_t       request_id_var_index;
+    ngx_int_t       apisix_request_id_var_index;
 
 } ngx_http_apisix_loc_conf_t;
 

t/request-id-err-log.t

@@ -7,8 +7,8 @@ __DATA__
 === TEST 1: request_id in error log set
 --- config
     location /t {
-		set $request_id_new 1234;
-        apisix_request_id_var $request_id_new;
+        set $request_id_new 1234;
+        lua_error_log_request_id $request_id_new;
         content_by_lua_block {
             ngx.log(ngx.INFO, "log_msg")
             ngx.exit(200)
@@ -28,8 +28,8 @@ qr/log_msg.*request_id: "1234"$/
 === TEST 2: request_id in error log set when a runtime error occurs
 --- config
     location /t {
-		set $request_id_new 1234;
-        apisix_request_id_var $request_id_new;
+        set $request_id_new 1234;
+        lua_error_log_request_id $request_id_new;
         content_by_lua_block {
             error("error_message")
         }
@@ -46,16 +46,15 @@ qr/.*request_id: "1234".*$/
 --- config
     location = /append_method {
         set $req_id_b 654321;
-        apisix_request_id_var $req_id_b;
-
+        lua_error_log_request_id $req_id_b;
         content_by_lua_block {
             ngx.log(ngx.INFO, "log_msg")
             ngx.exit(200)
         }
     }
     location = /append_req_id {
         set $req_id_a 123456;
-        apisix_request_id_var $req_id_a;
+        lua_error_log_request_id $req_id_a;
         content_by_lua_block {
             ngx.log(ngx.INFO, "log_msg")
             ngx.exit(200)
@@ -88,7 +87,7 @@ qr/log_msg.*request_id: "123456"$/
 --- config
     location /append {
         set $req_id 123456;
-        apisix_request_id_var $req_id;
+        lua_error_log_request_id $req_id;
         content_by_lua_block {
             ngx.log(ngx.ERR, "log_msg")
             ngx.exit(200)
@@ -110,7 +109,7 @@ qr/log_msg.*request_id/
 
 === TEST 6: scoping: value is appended correctly to error logs when the directive is in the main configuration
 --- http_config
-    apisix_request_id_var $req_id;
+    lua_error_log_request_id $req_id;
 --- config
     set $req_id 123456;
     location = /test {
@@ -133,13 +132,13 @@ qr/log_msg.*request_id: "123456"$/
 
 === TEST 7: scoping: value is appended correctly to error logs and the local directive overrides the global one
 --- http_config
-    apisix_request_id_var $req_id_global;
+    lua_error_log_request_id $req_id_global;
 --- config
     set $req_id_global global;
     set $req_id_local local;
 
     location = /test {
-        apisix_request_id_var $req_id_local;
+        lua_error_log_request_id $req_id_local;
         content_by_lua_block {
             ngx.log(ngx.INFO, "log_msg")
             ngx.exit(200)
@@ -159,7 +158,7 @@ qr/log_msg.*request_id: "global"$/
 --- config
     location = /test {
         set $my_var "";
-        apisix_request_id_var $my_var;
+        lua_error_log_request_id $my_var;
         rewrite_by_lua_block {
             ngx.log(ngx.INFO, "rewrite_0")
             ngx.var.my_var = "changed_in_rewrite"