Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NGINX: Migrate server redirects to NJS. #12448

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion images/nginx/rootfs/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,9 @@ export OPENTELEMETRY_CPP_VERSION="v1.11.0"
# Check on https://github.com/open-telemetry/opentelemetry-proto
export OPENTELEMETRY_PROTO_VERSION="v1.1.0"

# http://hg.nginx.org/njs
export NGINX_NJS_VERSION="0.8.4"

export BUILD_PATH=/tmp/build

ARCH=$(uname -m)
Expand Down Expand Up @@ -270,6 +273,9 @@ get_src efb767487ea3f6031577b9b224467ddbda2ad51a41c5867a47582d4ad85d609e \
get_src d74f86ada2329016068bc5a243268f1f555edd620b6a7d6ce89295e7d6cf18da \
"https://github.com/microsoft/mimalloc/archive/${MIMALOC_VERSION}.tar.gz" "mimalloc"

get_src 8191bff8491af9169a92e30e383ef8614717b0c6d40913d83b95051031e92321 \
"http://hg.nginx.org/njs/archive/${NGINX_NJS_VERSION}.tar.gz" "njs"

# improve compilation times
CORES=$(($(grep -c ^processor /proc/cpuinfo) - 1))

Expand Down Expand Up @@ -489,7 +495,8 @@ WITH_MODULES=" \
--add-dynamic-module=$BUILD_PATH/nginx-http-auth-digest \
--add-dynamic-module=$BUILD_PATH/ModSecurity-nginx \
--add-dynamic-module=$BUILD_PATH/ngx_http_geoip2_module \
--add-dynamic-module=$BUILD_PATH/ngx_brotli"
--add-dynamic-module=$BUILD_PATH/ngx_brotli \
--add-dynamic-module=$BUILD_PATH/njs/nginx"

./configure \
--prefix=/usr/local/nginx \
Expand Down
16 changes: 16 additions & 0 deletions rootfs/etc/nginx/js/nginx/ngx_srv_redirect.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
function srv_redirect(req) {
const redirectTo = req.variables.tmp_redirect_to;

const requestUri = req.variables.request_uri.replace(/\/$/, '');

const useForwardedHeaders = req.variables.forwarded_headers
const xForwardedProto = req.variables.http_x_forwarded_proto;
const xForwardedPort = req.variables.http_x_forwarded_port;

const redirectScheme = useForwardedHeaders && xForwardedProto ? xForwardedProto : req.variables.scheme;
const redirectPort = useForwardedHeaders && xForwardedPort ? xForwardedPort : req.variables.server_port;

return `${redirectScheme}://${redirectTo}:${redirectPort}${requestUri}`;
}

export default { srv_redirect };
11 changes: 9 additions & 2 deletions rootfs/etc/nginx/template/nginx.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
# setup custom paths that do not require root access
pid {{ .PID }};

load_module modules/ngx_http_js_module.so;

{{ if $cfg.UseGeoIP2 }}
load_module /etc/nginx/modules/ngx_http_geoip2_module.so;
{{ end }}
Expand Down Expand Up @@ -74,6 +76,10 @@ http {

init_worker_by_lua_file /etc/nginx/lua/ngx_conf_init_worker.lua;

js_import /etc/nginx/js/nginx/ngx_srv_redirect.js;

js_set $njs_srv_redirect ngx_srv_redirect.srv_redirect;

{{/* Enable the real_ip module only if we use either X-Forwarded headers or Proxy Protocol. */}}
{{/* we use the value of the real IP for the geo_ip module */}}
{{ if or (or $cfg.UseForwardedHeaders $cfg.UseProxyProtocol) $cfg.EnableRealIP }}
Expand Down Expand Up @@ -572,9 +578,10 @@ http {
}
{{ end }}

set_by_lua_file $redirect_to /etc/nginx/lua/nginx/ngx_srv_redirect.lua {{ $redirect.To }};
set $tmp_redirect_to '{{ $redirect.To }}';
set $tmp_forwarded_headers '{{ $cfg.UseForwardedHeaders }}';

return {{ $all.Cfg.HTTPRedirectCode }} $redirect_to;
return {{ $all.Cfg.HTTPRedirectCode }} $njs_srv_redirect;
}
## end server {{ $redirect.From }}
{{ end }}
Expand Down
4 changes: 2 additions & 2 deletions test/e2e/annotations/fromtowwwredirect.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ var _ = framework.DescribeAnnotation("from-to-www-redirect", func() {
f.WaitForNginxConfiguration(
func(cfg string) bool {
return strings.Contains(cfg, `server_name www.fromtowwwredirect.bar.com;`) &&
strings.Contains(cfg, `return 308 $redirect_to;`)
strings.Contains(cfg, `return 308 $njs_srv_redirect;`)
})

ginkgo.By("sending request to www.fromtowwwredirect.bar.com")
Expand Down Expand Up @@ -88,7 +88,7 @@ var _ = framework.DescribeAnnotation("from-to-www-redirect", func() {
f.WaitForNginxServer(toHost,
func(server string) bool {
return strings.Contains(server, fmt.Sprintf(`server_name %v;`, toHost)) &&
strings.Contains(server, `return 308 $redirect_to;`)
strings.Contains(server, `return 308 $njs_srv_redirect;`)
})

ginkgo.By("sending request to www should redirect to domain")
Expand Down
Loading