feat: implemented the lua_load_resty_core directive which loads resty.core by default.

Author: thibaultcha

README.markdown

@@ -1004,6 +1004,7 @@ See Also
 Directives
 ==========
 
+* [lua_load_resty_core](#lua_load_resty_core)
 * [lua_capture_error_log](#lua_capture_error_log)
 * [lua_use_default_type](#lua_use_default_type)
 * [lua_malloc_trim](#lua_malloc_trim)
@@ -1079,6 +1080,38 @@ how the result will be used. Below is a diagram showing the order in which direc
 
 [Back to TOC](#table-of-contents)
 
+lua_load_resty_core
+-------------------
+
+**syntax:** *lua_load_resty_core on|off*
+
+**default:** *lua_load_resty_core on*
+
+**context:** *http*
+
+Controls whether the `resty.core` module (from
+[lua-resty-core](https://github.com/openresty/lua-resty-core)) should be loaded
+or not. When enabled, this directive is equivalent to executing the following
+when the Lua VM is created:
+
+```lua
+
+ require "resty.core"
+```
+
+Note that usage of the `resty.core` module is recommended, as its
+FFI implementation is both faster, safer, and more complete than the Lua C API
+of the ngx_lua module.
+
+It must also be noted that the Lua C API of the ngx_lua module will eventually
+be removed, and usage of the FFI-based API (i.e. the `resty.core`
+module) will become mandatory. This directive only aims at providing a
+temporary backwards-compatibility mode in case of edge-cases.
+
+This directive was first introduced in the `v0.10.15` release.
+
+[Back to TOC](#directives)
+
 lua_capture_error_log
 ---------------------
 **syntax:** *lua_capture_error_log size*

doc/HttpLuaModule.wiki

@@ -835,6 +835,34 @@ how the result will be used. Below is a diagram showing the order in which direc
 
 ![Lua Nginx Modules Directives](https://cloud.githubusercontent.com/assets/2137369/15272097/77d1c09e-1a37-11e6-97ef-d9767035fc3e.png)
 
+== lua_load_resty_core ==
+
+'''syntax:''' ''lua_load_resty_core on|off''
+
+'''default:''' ''lua_load_resty_core on''
+
+'''context:''' ''http''
+
+Controls whether the <code>resty.core</code> module (from
+[https://github.com/openresty/lua-resty-core lua-resty-core]) should be loaded
+or not. When enabled, this directive is equivalent to executing the following
+when the Lua VM is created:
+
+<geshi lang="lua">
+    require "resty.core"
+</geshi>
+
+Note that usage of the <code>resty.core</code> module is recommended, as its
+FFI implementation is both faster, safer, and more complete than the Lua C API
+of the ngx_lua module.
+
+It must also be noted that the Lua C API of the ngx_lua module will eventually
+be removed, and usage of the FFI-based API (i.e. the <code>resty.core</code>
+module) will become mandatory. This directive only aims at providing a
+temporary backwards-compatibility mode in case of edge-cases.
+
+This directive was first introduced in the <code>v0.10.15</code> release.
+
 == lua_capture_error_log ==
 '''syntax:''' ''lua_capture_error_log size''
 

src/ngx_http_lua_common.h

@@ -182,6 +182,8 @@ struct ngx_http_lua_main_conf_s {
     ngx_cycle_t         *cycle;
     ngx_pool_t          *pool;
 
+    ngx_flag_t           load_resty_core;
+
     ngx_int_t            max_pending_timers;
     ngx_int_t            pending_timers;
 

src/ngx_http_lua_module.c

@@ -77,6 +77,13 @@ static ngx_conf_bitmask_t  ngx_http_lua_ssl_protocols[] = {
 
 static ngx_command_t ngx_http_lua_cmds[] = {
 
+    { ngx_string("lua_load_resty_core"),
+      NGX_HTTP_MAIN_CONF|NGX_CONF_FLAG,
+      ngx_conf_set_flag_slot,
+      NGX_HTTP_MAIN_CONF_OFFSET,
+      offsetof(ngx_http_lua_main_conf_t, load_resty_core),
+      NULL },
+
     { ngx_string("lua_max_running_timers"),
       NGX_HTTP_MAIN_CONF|NGX_CONF_TAKE1,
       ngx_conf_set_num_slot,
@@ -877,6 +884,7 @@ ngx_http_lua_create_main_conf(ngx_conf_t *cf)
      */
 
     lmcf->pool = cf->pool;
+    lmcf->load_resty_core = NGX_CONF_UNSET;
     lmcf->max_pending_timers = NGX_CONF_UNSET;
     lmcf->max_running_timers = NGX_CONF_UNSET;
 #if (NGX_PCRE)
@@ -910,6 +918,10 @@ ngx_http_lua_init_main_conf(ngx_conf_t *cf, void *conf)
 {
     ngx_http_lua_main_conf_t *lmcf = conf;
 
+    if (lmcf->load_resty_core == NGX_CONF_UNSET) {
+        lmcf->load_resty_core = 1;
+    }
+
 #if (NGX_PCRE)
     if (lmcf->regex_cache_max_entries == NGX_CONF_UNSET) {
         lmcf->regex_cache_max_entries = 1024;

src/ngx_http_lua_util.c

@@ -147,6 +147,13 @@ static int ngx_http_lua_get_raw_phase_context(lua_State *L);
 #define LUA_PATH_SEP ";"
 #endif
 
+
+#if !defined(LUA_DEFAULT_PATH) && (NGX_DEBUG)
+#define LUA_DEFAULT_PATH "../lua-resty-core/lib/?.lua;"                      \
+                         "../lua-resty-lrucache/lib/?.lua"
+#endif
+
+
 #define AUX_MARK "\1"
 
 
@@ -3813,6 +3820,7 @@ ngx_http_lua_init_vm(lua_State *parent_vm, ngx_cycle_t *cycle,
     ngx_pool_t *pool, ngx_http_lua_main_conf_t *lmcf, ngx_log_t *log,
     ngx_pool_cleanup_t **pcln)
 {
+    int                              rc;
     lua_State                       *L;
     ngx_uint_t                       i;
     ngx_pool_cleanup_t              *cln;
@@ -3880,6 +3888,21 @@ ngx_http_lua_init_vm(lua_State *parent_vm, ngx_cycle_t *cycle,
         lua_pop(L, 2);
     }
 
+    if (lmcf->load_resty_core) {
+        lua_getglobal(L, "require");
+        lua_pushstring(L, "resty.core");
+
+        rc = lua_pcall(L, 1, 1, 0);
+        if (rc != 0) {
+            ngx_log_error(NGX_LOG_ERR, log, 0,
+                          "lua_load_resty_core failed to load the resty.core "
+                          "module from https://github.com/openresty/lua-resty"
+                          "-core; ensure you are using an OpenResty release "
+                          "from https://openresty.org/en/download.html "
+                          "(rc: %i, reason: %s)", rc, lua_tostring(L, -1));
+        }
+    }
+
     return L;
 }
 

t/161-load-resty-core.t

@@ -0,0 +1,68 @@
+use Test::Nginx::Socket::Lua;
+
+repeat_each(2);
+
+plan tests => repeat_each() * (blocks() * 3);
+
+add_block_preprocessor(sub {
+    my $block = shift;
+
+    if (!defined $block->request) {
+        $block->set_value("request", "GET /t");
+    }
+
+    if (!defined $block->no_error_log) {
+        $block->set_value("no_error_log", "[error]");
+    }
+});
+
+no_long_string();
+run_tests();
+
+__DATA__
+
+=== TEST 1: lua_load_resty_core is enabled by default
+--- config
+    location = /t {
+        content_by_lua_block {
+            local loaded_resty_core = package.loaded["resty.core"]
+            local resty_core = require "resty.core"
+
+            ngx.say("resty.core loaded: ", loaded_resty_core == resty_core)
+        }
+    }
+--- response_body
+resty.core loaded: true
+
+
+
+=== TEST 2: lua_load_resty_core can be disabled
+--- http_config
+    lua_load_resty_core off;
+--- config
+    location = /t {
+        content_by_lua_block {
+            local loaded_resty_core = package.loaded["resty.core"]
+
+            ngx.say("resty.core loaded: ", loaded_resty_core ~= nil)
+        }
+    }
+--- response_body
+resty.core loaded: false
+
+
+
+=== TEST 3: lua_load_resty_core is effective when using lua_shared_dict
+--- http_config
+    lua_shared_dict dogs 128k;
+--- config
+    location = /t {
+        content_by_lua_block {
+            local loaded_resty_core = package.loaded["resty.core"]
+            local resty_core = require "resty.core"
+
+            ngx.say("resty.core loaded: ", loaded_resty_core == resty_core)
+        }
+    }
+--- response_body
+resty.core loaded: true