Switch from ngx_txid to lua-resty-txid for generating request IDs.

The IDs should be functionally equivalent, this is just a pure-Lua
implementation to reduce our need for custom nginx modules.

Author: GUI

build/cmake/app-deps/core-lua-deps.cmake

@@ -30,6 +30,8 @@ set(OPM_LIBCIDR_VERSION 0.1.3)
 set(OPM_LIBCIDR_HASH 9d995b83a7d857fcdec949725711b784)
 set(OPM_RESTY_HTTP_VERSION 0.12)
 set(OPM_RESTY_HTTP_HASH edc5d6deb82c1f5f628e382290c79209)
+set(OPM_RESTY_TXID_VERSION 1.0.0)
+set(OPM_RESTY_TXID_HASH 0c2ebfef460d537316e52f696d8bbfb7)
 
 # LuaRock app dependencies
 luarocks_install(argparse ${LUAROCK_ARGPARSE_VERSION} ${LUAROCK_ARGPARSE_HASH})
@@ -45,6 +47,7 @@ luarocks_install(penlight ${LUAROCK_PENLIGHT_VERSION} ${LUAROCK_PENLIGHT_HASH})
 # OPM app dependencies
 opm_install(lua-libcidr-ffi GUI ${OPM_LIBCIDR_VERSION} ${OPM_LIBCIDR_HASH} libcidr)
 opm_install(lua-resty-http pintsized ${OPM_RESTY_HTTP_VERSION} ${OPM_RESTY_HTTP_HASH})
+opm_install(lua-resty-txid GUI ${OPM_RESTY_TXID_VERSION} ${OPM_RESTY_TXID_HASH})
 
 ExternalProject_Add(
   opm_lua-icu-date
@@ -127,6 +130,7 @@ set(
   opm_lua-icu-date
   opm_lua-libcidr-ffi
   opm_lua-resty-http
+  opm_lua-resty-txid
 )
 
 # Also depend on the internal stamp files used by ExternalProject_Add, since

build/cmake/deps/openresty.cmake

@@ -6,8 +6,6 @@ set(LUAROCKS_VERSION 2.4.4)
 set(LUAROCKS_HASH 04e8b19d565e86b1d08f745adc4b1a56)
 set(NGX_DYUPS_VERSION a5e75737e04ff3e5040a80f5f739171e96c3359c)
 set(NGX_DYUPS_HASH e16860efcd0629f38f514469052d998a)
-set(NGX_TXID_VERSION f1c197cb9c42e364a87fbb28d5508e486592ca42)
-set(NGX_TXID_HASH 408ee86eb6e42e27a51514f711c41d6b)
 set(OPENRESTY_VERSION 1.13.6.1)
 set(OPENRESTY_HASH 637f82d0b36c74aec1c01bd3b8e0289c)
 set(OPENSSL_VERSION 1.0.2o)
@@ -28,19 +26,6 @@ ExternalProject_Add(
 ExternalProject_Get_Property(ngx_dyups SOURCE_DIR)
 set(NGX_DYUPS_SOURCE_DIR ${SOURCE_DIR})
 
-# ngx_txid: Generate unique request IDs
-ExternalProject_Add(
-  ngx_txid
-  EXCLUDE_FROM_ALL 1
-  URL https://github.com/streadway/ngx_txid/archive/${NGX_TXID_VERSION}.tar.gz
-  URL_HASH MD5=${NGX_TXID_HASH}
-  CONFIGURE_COMMAND ""
-  BUILD_COMMAND ""
-  INSTALL_COMMAND ""
-)
-ExternalProject_Get_Property(ngx_txid SOURCE_DIR)
-set(NGX_TXID_SOURCE_DIR ${SOURCE_DIR})
-
 # Pull in newer version of PCRE (8.20+) for OpenResty to enable PCRE JIT.
 ExternalProject_Add(
   pcre
@@ -85,12 +70,11 @@ list(APPEND OPENRESTY_CONFIGURE_CMD --with-http_realip_module)
 list(APPEND OPENRESTY_CONFIGURE_CMD --with-http_ssl_module)
 list(APPEND OPENRESTY_CONFIGURE_CMD --with-http_stub_status_module)
 list(APPEND OPENRESTY_CONFIGURE_CMD --add-module=${NGX_DYUPS_SOURCE_DIR})
-list(APPEND OPENRESTY_CONFIGURE_CMD --add-module=${NGX_TXID_SOURCE_DIR})
 
 ExternalProject_Add(
   openresty
   EXCLUDE_FROM_ALL 1
-  DEPENDS libgeoip ngx_dyups ngx_txid openssl pcre
+  DEPENDS libgeoip ngx_dyups openssl pcre
   URL https://openresty.org/download/openresty-${OPENRESTY_VERSION}.tar.gz
   URL_HASH MD5=${OPENRESTY_HASH}
   BUILD_IN_SOURCE 1

scripts/rake/outdated_packages.rb

@@ -100,10 +100,6 @@ class OutdatedPackages
       :git => "https://github.com/yzprofile/ngx_http_dyups_module.git",
       :git_ref => "master",
     },
-    "ngx_txid" => {
-      :git => "https://github.com/streadway/ngx_txid.git",
-      :git_ref => "master",
-    },
     "nodejs" => {
       :git => "https://github.com/nodejs/node.git",
       :constraint => "~> 8.10",
@@ -128,6 +124,9 @@ class OutdatedPackages
     "opm_resty_http" => {
       :git => "https://github.com/pintsized/lua-resty-http.git",
     },
+    "opm_resty_txid" => {
+      :git => "https://github.com/GUI/lua-resty-txid.git",
+    },
     "pcre" => {
       :http => "https://ftp.pcre.org/pub/pcre/",
     },

src/api-umbrella/proxy/hooks/init.lua

@@ -1,5 +1,8 @@
 DEBUG = false
 
+-- Pre-load modules.
+require "resty.txid"
+
 inspect = require "inspect"
 
 -- Generate a unique ID to represent this group of worker processes. This value

templates/etc/nginx/gatekeeper.conf.mustache

@@ -1,5 +1,8 @@
-set $x_api_umbrella_request_id $txid;
-proxy_set_header X-Api-Umbrella-Request-ID $txid;
+set_by_lua_block $x_api_umbrella_request_id {
+  local txid = require "resty.txid"
+  return txid()
+}
+proxy_set_header X-Api-Umbrella-Request-ID $x_api_umbrella_request_id;
 
 # Normalize the Accept-Encoding header to increase cache hit rates.
 # We're not currently using TrafficServer, but this is based on what it does by