feat: implemented the lua_load_resty_core directive. #1501

thibaultcha · 2019-04-03T21:59:11Z

I hereby granted the copyright of the changes in this pull request
to the authors of this lua-nginx-module project.

lua_load_resty_core [on|off]; # on by default

Sister PRs:

misc: updated calls to 'error()' to be thrown from the user's stack level. lua-resty-core#238
feat: implemented the lua_load_resty_core directive which loads resty.core by default. meta-lua-nginx-module#68
feat: implemented the lua_load_resty_core directive which loads resty.core by default. stream-lua-nginx-module#159

src/ngx_http_lua_util.c

README.markdown

….core by default.

…core.

thibaultcha · 2019-04-09T20:43:26Z

Manually merged

chobits · 2019-04-24T08:30:31Z

Hi @thibaultcha ,

The default on value of lua_load_resty_core directive makes starting Nginx failed without lua-resty-core.

See this issue: #1509 (comment)

thibaultcha · 2019-04-24T15:28:19Z

@chobits Indeed. lua-resty-core is to become a dependency of this module. For now, you can still turn this directive off. In an upcoming release, all CFunction APIs will be removed and lua-resty-core will become mandatory.

chobits · 2019-04-25T01:56:52Z

@thibaultcha OK. Let me try lua-resty-core!

ElvinEfendi · 2019-05-26T01:12:01Z

src/ngx_http_lua_util.c

+                          "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));


Does this mean lua-nginx-module can not be used outside of OpenResty bundle anymore? In one of our projects we compile lua-nginx-module manually and also include lua-resty-core and set lua package path correctly. Since this PR Nginx fails when starting with this error. When I turn off lua_load_resty_core and do just require("resty.core") it works as expected.

Note that the error does not recur when I reload Nginx.

@ElvinEfendi It still can, just a little bit harder as you found out. If you want to add Lua library search paths to your own nginx build at build time, then just override the values of the macros LUA_DEFAULT_PATH and LUA_DEFAULT_CPATH to include your own installation paths of lua-resty-core (and lua-resty-lrucache). The OpenResty distribution's build system does exactly that.

Hmm, it should also work if the user specify the lua_package_path and lua_package_cpath directives. @thibaultcha The lua_code_resty_core directive does not run after these search path nginx directives?

@agentzh the project I'm talking about is https://github.com/kubernetes/ingress-nginx/, and we are actually considering to use OpenResty as base image instead of Nginx.

--

I replicated CI image in this repository and renamed lua-resty-core and lua-resty-lrucache folders to something else. I then edited t/161-load-resty-core.t added ONLY to the first test and also added lua_package_path "/lua-resty-corexxx/lib/?.lua;/lua-resty-lrucachexxx/lib/?.lua;;"; using --- http_config.
/lua-resty-corexxx and /lua-resty-lrucachexxx are what I renamed lua-resty-core and lua-resty-lrucache folders to. Then running test it succeeds. So that tells me it respects lua_package_path in this case. Not sure yet why it does not work in https://github.com/kubernetes/ingress-nginx though. The only difference between the Nginx we use in ingress-nginx and 1.15.8 (also the version I used in the above test: https://github.com/ElvinEfendi/lua-nginx-module/pull/1/files#diff-3254677a7917c6c01f55212f86c57fbfR7) that OpenResty uses is that we use Nginx 1.17.0.

@ElvinEfendi Then it's not something on our side? For OpenResty, then it already includes lua-resty-core or lua-resty-lrucache in its default search paths.

@ElvinEfendi For us to support you, you need to prepare a minimal and self-contained example. We are not maintaining that ingress-nginx project anyway, not to mention your own setup.

@agentzh all I wanted to clarify was "Does this mean lua-nginx-module can not be used outside of OpenResty bundle anymore?" :) Because the error message implies that. But I got my answer, which is it should be possible.

I co-maintain ingress-nginx project - will look into this further on our side to see what's going on and will also potentially switch to OpenResty as base image for that project if the dependencies we need play well with OpenResty bundle.

Thanks for taking time to look into this though!

Well, that's a recommendation. Not a requirement.

@ElvinEfendi The lua_load_resty_core directive respects the LUA_PATH environment variable and the lua_package_path directive. In fact, I just pushed a new test asserting this behavior: 4102b82

Make sure that you also clone lua-resty-lrucache which is itself a dependency of lua-resty-core.
Or maybe you set your Lua path in Lua-land (e.g. package.path = "...;" .. package.path)? In which case, that'd be too late for this directive to honor the change.

Providing a minimally reproducible example with error logs may be useful here, but again as @agentzh said, this isn't really an issue with this module.

This module can still be used independently but the margin for error is high for most users, hence the warnings and other logs (e.g. lua-resty-core, LuaJIT's fork, etc...) asking to prefer the formal OpenResty releases.

Where can I set package.path?

Start from commit openresty/lua-nginx-module@60736e6 'resty.core' is now mandatorily loaded, and the 'lua_load_resty_core' directive is deprecated. See also openresty/lua-nginx-module#1501 If nginx is built with USE="nginx_modules_http_lua", there must have resty.core (OpenResty or a module with name 'resty') exist, otherwise nginx will fail to start w/ messages like bellow: nginx: [alert] failed to load the 'resty.core' module (https://github.com/openresty/lua-resty-core); ensure you are using an OpenResty release from https://openresty.org/en/download.html (reason: module 'resty.core' not found: no field package.preload['resty.core'] no file './resty/core.lua' no file '/usr/share/luajit-2.1.0-beta3/resty/core.lua' no file '/usr/local/share/lua/5.1/resty/core.lua' no file '/usr/local/share/lua/5.1/resty/core/init.lua' no file '/usr/share/lua/5.1/resty/core.lua' no file '/usr/share/lua/5.1/resty/core/init.lua' no file './resty/core.so' no file '/usr/local/lib/lua/5.1/resty/core.so' no file '/usr/lib64/lua/5.1/resty/core.so' no file '/usr/local/lib/lua/5.1/loadall.so' no file './resty.so' no file '/usr/local/lib/lua/5.1/resty.so' no file '/usr/lib64/lua/5.1/resty.so' no file '/usr/local/lib/lua/5.1/loadall.so') in /etc/nginx/nginx.conf:47 Closes: https://bugs.gentoo.org/726728 Signed-off-by: Z. Liu <[email protected]>

Start from commit openresty/lua-nginx-module@60736e6 'resty.core' is now mandatorily loaded, and the 'lua_load_resty_core' directive is deprecated. See also openresty/lua-nginx-module#1501 If nginx is built with USE="nginx_modules_http_lua", there must have resty.core (OpenResty or a module named 'resty') exist, otherwise nginx will fail to start w/ messages like bellow: nginx: [alert] failed to load the 'resty.core' module (https://github.com/openresty/lua-resty-core); ensure you are using an OpenResty release from https://openresty.org/en/download.html (reason: module 'resty.core' not found: no field package.preload['resty.core'] no file './resty/core.lua' no file '/usr/share/luajit-2.1.0-beta3/resty/core.lua' no file '/usr/local/share/lua/5.1/resty/core.lua' no file '/usr/local/share/lua/5.1/resty/core/init.lua' no file '/usr/share/lua/5.1/resty/core.lua' no file '/usr/share/lua/5.1/resty/core/init.lua' no file './resty/core.so' no file '/usr/local/lib/lua/5.1/resty/core.so' no file '/usr/lib64/lua/5.1/resty/core.so' no file '/usr/local/lib/lua/5.1/loadall.so' no file './resty.so' no file '/usr/local/lib/lua/5.1/resty.so' no file '/usr/lib64/lua/5.1/resty.so' no file '/usr/local/lib/lua/5.1/loadall.so') in /etc/nginx/nginx.conf:47 Closes: https://bugs.gentoo.org/726728 Signed-off-by: Z. Liu <[email protected]>

Start from commit openresty/lua-nginx-module@60736e6 'resty.core' is now mandatorily loaded, and the 'lua_load_resty_core' directive is deprecated. See also openresty/lua-nginx-module#1501 If nginx is built with USE="nginx_modules_http_lua", there must have resty.core (OpenResty or a module named 'resty') exist, otherwise nginx will fail to start w/ messages like bellow: nginx: [alert] failed to load the 'resty.core' module (https://github.com/openresty/lua-resty-core); ensure you are using an OpenResty release from https://openresty.org/en/download.html (reason: module 'resty.core' not found: no field package.preload['resty.core'] no file './resty/core.lua' no file '/usr/share/luajit-2.1.0-beta3/resty/core.lua' no file '/usr/local/share/lua/5.1/resty/core.lua' no file '/usr/local/share/lua/5.1/resty/core/init.lua' no file '/usr/share/lua/5.1/resty/core.lua' no file '/usr/share/lua/5.1/resty/core/init.lua' no file './resty/core.so' no file '/usr/local/lib/lua/5.1/resty/core.so' no file '/usr/lib64/lua/5.1/resty/core.so' no file '/usr/local/lib/lua/5.1/loadall.so' no file './resty.so' no file '/usr/local/lib/lua/5.1/resty.so' no file '/usr/lib64/lua/5.1/resty.so' no file '/usr/local/lib/lua/5.1/loadall.so') in /etc/nginx/nginx.conf:47 Closes: https://bugs.gentoo.org/726728 Signed-off-by: Z. Liu <[email protected]> Closes: #39823 Signed-off-by: Sam James <[email protected]>

thibaultcha force-pushed the feat/lua-load-resty-core branch 2 times, most recently from a1ded3b to 2babfcb Compare April 3, 2019 22:28

agentzh requested changes Apr 3, 2019

View reviewed changes

src/ngx_http_lua_util.c Outdated Show resolved Hide resolved

src/ngx_http_lua_util.c Outdated Show resolved Hide resolved

thibaultcha force-pushed the feat/lua-load-resty-core branch from 2babfcb to 98f0747 Compare April 3, 2019 23:18

agentzh requested changes Apr 4, 2019

View reviewed changes

README.markdown Outdated Show resolved Hide resolved

thibaultcha force-pushed the feat/lua-load-resty-core branch from 98f0747 to 10a7534 Compare April 4, 2019 21:17

thibaultcha added 4 commits April 9, 2019 11:52

feat: implemented the lua_load_resty_core directive which loads resty…

e052887

….core by default.

tests: fixed default lua path to load resty.core from many test cases.

08f3959

tests: fixed a few failing test cases due to loading resty.core.

36ab412

[removeme] travis: switched to the contributor's branch of lua-resty-…

3d3ce00

…core.

thibaultcha force-pushed the feat/lua-load-resty-core branch from 10a7534 to 3d3ce00 Compare April 9, 2019 18:52

thibaultcha closed this Apr 9, 2019

thibaultcha deleted the feat/lua-load-resty-core branch April 9, 2019 20:43

spacewander mentioned this pull request May 6, 2019

nginx 1.16.0重启提示缺少文件 openresty/lua-resty-core#248

Closed

spacewander mentioned this pull request May 24, 2019

nginx: [error] lua_load_resty_core failed to load the resty.core module #1533

Closed

ElvinEfendi reviewed May 26, 2019

View reviewed changes

clan mentioned this pull request Dec 23, 2024

www-servers/nginx: add lua config if USE="nginx_modules_http_lua" gentoo/gentoo#39823

Closed

4 tasks

feat: implemented the lua_load_resty_core directive. #1501

feat: implemented the lua_load_resty_core directive. #1501

Uh oh!

Conversation

thibaultcha commented Apr 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thibaultcha commented Apr 9, 2019

Uh oh!

chobits commented Apr 24, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thibaultcha commented Apr 24, 2019

Uh oh!

chobits commented Apr 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ElvinEfendi May 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agentzh May 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agentzh May 27, 2019

Choose a reason for hiding this comment

Uh oh!

ElvinEfendi May 27, 2019

Choose a reason for hiding this comment

Uh oh!

agentzh May 28, 2019

Choose a reason for hiding this comment

Uh oh!

agentzh May 28, 2019

Choose a reason for hiding this comment

Uh oh!

ElvinEfendi May 28, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agentzh May 28, 2019

Choose a reason for hiding this comment

Uh oh!

thibaultcha May 28, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yjfvictor Mar 30, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

thibaultcha commented Apr 3, 2019 •

edited

Loading

chobits commented Apr 24, 2019 •

edited

Loading

chobits commented Apr 25, 2019 •

edited

Loading

ElvinEfendi May 26, 2019 •

edited

Loading

agentzh May 27, 2019 •

edited

Loading

ElvinEfendi May 28, 2019 •

edited

Loading

thibaultcha May 28, 2019 •

edited

Loading