Merge branch 'master' into dmehala/send-integration-errors

Author: dmehala

.circleci/continue_config.yml

@@ -294,7 +294,7 @@ jobs:
                 name: Move the module to the system-tests directory
                 working_directory: ./system-tests
             - run:
-                command: ./build.sh cpp
+                command: ./build.sh cpp_nginx
                 name: Build test targets
                 working_directory: ./system-tests
             - run:
@@ -460,7 +460,7 @@ workflows:
                             - amd64
                             - arm64
                         version:
-                            - 1.12.0
+                            - 1.12.1
                 name: build ingress-nginx-<< matrix.version >> on << matrix.arch >>
             - coverage:
                 name: Coverage on 1.27.0 with WAF ON
@@ -538,7 +538,7 @@ workflows:
                         base-image:
                             - registry.k8s.io/ingress-nginx/controller
                         nginx-version:
-                            - 1.12.0
+                            - 1.12.1
                 name: test ingress-nginx-<< matrix.nginx-version >> on << matrix.arch >>
                 requires:
                     - build ingress-nginx-<< matrix.nginx-version >> on << matrix.arch >>
@@ -562,7 +562,9 @@ workflows:
                             - amd64
                             - arm64
                         version:
+                            - 1.12.1
                             - 1.12.0
+                            - 1.11.5
                             - 1.11.4
                             - 1.11.3
                             - 1.11.2
@@ -587,7 +589,9 @@ workflows:
                         base-image:
                             - registry.k8s.io/ingress-nginx/controller
                         nginx-version:
+                            - 1.12.1
                             - 1.12.0
+                            - 1.11.5
                             - 1.11.4
                             - 1.11.3
                             - 1.11.2

.circleci/src/@jobs.yml

@@ -250,7 +250,7 @@ jobs:
       - run:
           name: Build test targets
           working_directory: ./system-tests
-          command: ./build.sh cpp
+          command: ./build.sh cpp_nginx
       - run:
           name: Run DEFAULT scenarios
           working_directory: ./system-tests

.circleci/src/workflows/build-and-test-all.yml

@@ -14,7 +14,9 @@
             - 'amd64'
             - 'arm64'
             version:
+            - 1.12.1
             - 1.12.0
+            - 1.11.5
             - 1.11.4
             - 1.11.3
             - 1.11.2
@@ -41,7 +43,9 @@
             base-image:
             - registry.k8s.io/ingress-nginx/controller
             nginx-version:
+            - 1.12.1
             - 1.12.0
+            - 1.11.5
             - 1.11.4
             - 1.11.3
             - 1.11.2

.circleci/src/workflows/build-and-test.yml

@@ -47,7 +47,7 @@ jobs:
         - 'amd64'
         - 'arm64'
         version:
-        - 1.12.0
+        - 1.12.1
 - coverage:
     name: Coverage on 1.27.0 with WAF ON
 - test:
@@ -131,7 +131,7 @@ jobs:
         base-image:
         - registry.k8s.io/ingress-nginx/controller
         nginx-version:
-        - 1.12.0
+        - 1.12.1
 - system_tests:
     name: Run system tests
     requires:

CMakeLists.txt

@@ -136,6 +136,7 @@ set_target_properties(ngx_http_datadog_objs PROPERTIES POSITION_INDEPENDENT_CODE
 target_compile_definitions(ngx_http_datadog_objs PUBLIC DD_NGINX_FLAVOR="${NGINX_DATADOG_FLAVOR}")
 target_sources(ngx_http_datadog_objs
   PRIVATE
+    src/common/variable.cpp
     src/array_util.cpp
     src/datadog_conf.cpp
     src/datadog_conf_handler.cpp

bin/ingress_nginx.py

@@ -33,7 +33,9 @@
 def get_underlying_nginx_version(controller_version: str) -> str:
     # Map an ingress-nginx version to an NGINX version
     mapping = {
+        "v1.12.1": "1.25.5",
         "v1.12.0": "1.25.5",
+        "v1.11.5": "1.25.5",
         "v1.11.4": "1.25.5",
         "v1.11.3": "1.25.5",
         "v1.11.2": "1.25.5",
@@ -73,7 +75,9 @@ def clone_nginx(version: str, out_dir: str) -> str:
 
 def get_patch_directory(version: str, ingress_rootdir: str) -> str:
     mapping = {
+        "v1.12.1": f"{ingress_rootdir}/images/nginx/rootfs/patches",
         "v1.12.0": f"{ingress_rootdir}/images/nginx/rootfs/patches",
+        "v1.11.5": f"{ingress_rootdir}/images/nginx/rootfs/patches",
         "v1.11.4": f"{ingress_rootdir}/images/nginx/rootfs/patches",
         "v1.11.3": f"{ingress_rootdir}/images/nginx/rootfs/patches",
         "v1.11.2": f"{ingress_rootdir}/images/nginx-1.25/rootfs/patches",

libddwaf

@@ -0,0 +1,46 @@
+#include "common/variable.h"
+
+#include "string_util.h"
+
+namespace datadog::common {
+
+ngx_http_complex_value_t *make_complex_value(ngx_conf_t *cf, ngx_str_t &expr) {
+  auto *cv = (ngx_http_complex_value_t *)ngx_pcalloc(
+      cf->pool, sizeof(ngx_http_complex_value_t));
+
+  ngx_http_compile_complex_value_t ccv;
+  ngx_memzero(&ccv, sizeof(ngx_http_compile_complex_value_t));
+
+  ccv.cf = cf;
+  ccv.value = &expr;
+  ccv.complex_value = cv;
+  ccv.zero = 0;
+  ccv.conf_prefix = 0;
+
+  if (ngx_http_compile_complex_value(&ccv) != NGX_OK) {
+    return nullptr;
+  }
+
+  return cv;
+}
+
+ngx_http_complex_value_t *make_complex_value(ngx_conf_t *cf,
+                                             std::string_view expr) {
+  auto ngx_expr = nginx::to_ngx_str(cf->pool, expr);
+  return make_complex_value(cf, ngx_expr);
+}
+
+std::optional<std::string> eval_complex_value(
+    ngx_http_complex_value_t *complex_value, ngx_http_request_t *request) {
+  if (complex_value == nullptr) return std::nullopt;
+
+  ngx_str_t res;
+  if (ngx_http_complex_value(request, complex_value, &res) != NGX_OK ||
+      res.len == 0) {
+    return std::nullopt;
+  }
+
+  return nginx::to_string(res);
+}
+
+}  // namespace datadog::common

src/common/variable.cpp

@@ -0,0 +1,34 @@
+#pragma once
+
+extern "C" {
+
+#include <nginx.h>
+#include <ngx_conf_file.h>
+#include <ngx_config.h>
+#include <ngx_core.h>
+#include <ngx_http.h>
+#include <ngx_log.h>
+}
+
+#include <optional>
+#include <string>
+
+namespace datadog::common {
+
+/// Extracted from NGINX Development Guide
+/// (<https://nginx.org/en/docs/dev/development_guide.html#http_complex_values>)
+///
+/// A complex value, despite its name, provides an easy way to evaluate
+/// expressions which can contain text, variables, and their combination.
+ngx_http_complex_value_t *make_complex_value(ngx_conf_t *cf,
+                                             ngx_str_t &default_value);
+
+ngx_http_complex_value_t *make_complex_value(ngx_conf_t *cf,
+                                             std::string_view default_value);
+
+/// Evaluate complex expressions. Returns the value if the evaluation is
+/// successful, otherwise returns nothing.
+std::optional<std::string> eval_complex_value(
+    ngx_http_complex_value_t *complex_value, ngx_http_request_t *request);
+
+}  // namespace datadog::common

src/common/variable.h

@@ -17,6 +17,7 @@ extern "C" {
 #endif
 
 #include <string>
+#include <unordered_map>
 #include <vector>
 
 #define DD_NGX_CONF_COMPLEX_UNSET \
@@ -25,11 +26,6 @@ extern "C" {
 namespace datadog {
 namespace nginx {
 
-struct datadog_tag_t {
-  NgxScript key_script;
-  NgxScript value_script;
-};
-
 struct conf_directive_source_location_t {
   ngx_str_t file_name;       // e.g. "nginx.conf"
   ngx_uint_t line;           // line number within the file `file_name`
@@ -61,7 +57,7 @@ struct sampling_rule_t {
 };
 
 struct datadog_main_conf_t {
-  ngx_array_t *tags;
+  std::unordered_map<std::string, ngx_http_complex_value_t *> tags;
   // `are_propagation_styles_locked` is whether the tracer's propagation styles
   // have been set, either by an explicit `datadog_propagation_styles`
   // directive, or implicitly to a default configuration by another directive.
@@ -197,7 +193,7 @@ struct datadog_loc_conf_t {
   ngx_http_complex_value_t *service_env = DD_NGX_CONF_COMPLEX_UNSET;
   // `service_version` is set by the `datadog_version` directive.
   ngx_http_complex_value_t *service_version = DD_NGX_CONF_COMPLEX_UNSET;
-  ngx_array_t *tags;
+  std::unordered_map<std::string, ngx_http_complex_value_t *> tags;
   // `parent` is the parent context (e.g. the `server` to this `location`), or
   // `nullptr` if this context has no parent.
   datadog_loc_conf_t *parent;

src/datadog_conf.h

@@ -2,21 +2,73 @@
 
 #include <cassert>
 
+#include "datadog_conf_handler.h"
+
 namespace datadog {
 namespace nginx {
 
-char *warn_deprecated_command_datadog_tracing(ngx_conf_t *cf,
-                                              ngx_command_t * /*command*/,
-                                              void * /*conf*/) noexcept {
+char *silently_ignore_command(ngx_conf_t *cf, ngx_command_t *command, void *) {
+  ngx_conf_log_error(NGX_LOG_DEBUG, cf, 0, "Directive \"%V\" ignored",
+                     &command->name);
+  return NGX_CONF_OK;
+}
+
+char *alias_directive(ngx_conf_t *cf, ngx_command_t *command, void *) noexcept {
+  if (command->post == nullptr) {
+    return static_cast<char *>(NGX_CONF_ERROR);
+  }
+
+  auto src_directive = static_cast<char *>(command->post);
+
   const auto elements = static_cast<ngx_str_t *>(cf->args->elts);
   assert(cf->args->nelts >= 1);
 
-  ngx_log_error(
-      NGX_LOG_WARN, cf->log, 0,
-      "Directive \"%V\" is deprecated. Use datadog_tracing on/off instead",
-      &elements[0]);
+  const ngx_str_t new_name_ngx{.len = strlen(src_directive),
+                               .data = (u_char *)src_directive};
+  ngx_conf_log_error(NGX_LOG_DEBUG, cf, 0, "Alias \"%V\" to \"%V\"",
+                     &command->name, &new_name_ngx);
+
+  // Rename the command and let `datadog_conf_handler` dispatch to the
+  // appropriate handler.
+  elements[0] = new_name_ngx;
+  auto rcode = datadog_conf_handler({.conf = cf, .skip_this_module = false});
+  if (rcode != NGX_OK) {
+    return static_cast<char *>(NGX_CONF_ERROR);
+  }
+
+  return NGX_CONF_OK;
+}
+
+char *warn_deprecated_command(ngx_conf_t *cf, ngx_command_t *command,
+                              void *) noexcept {
+  u_char buf[NGX_MAX_ERROR_STR] = {0};
+  u_char *last = buf + NGX_MAX_ERROR_STR;
+  u_char *p =
+      ngx_slprintf(buf, last, "Directive \"%V\" is deprecated", &command->name);
+
+  if (command->post != nullptr) {
+    auto reason = static_cast<char *>(command->post);
+    ngx_slprintf(p, last, ". %s", reason);
+  }
+
+  ngx_conf_log_error(NGX_LOG_WARN, cf, 0, "%s", buf);
+  return NGX_CONF_OK;
+}
+
+char *err_deprecated_command(ngx_conf_t *cf, ngx_command_t *command,
+                             void *) noexcept {
+  u_char buf[NGX_MAX_ERROR_STR] = {0};
+  u_char *last = buf + NGX_MAX_ERROR_STR;
+  u_char *p =
+      ngx_slprintf(buf, last, "Directive \"%V\" is deprecated", &command->name);
+
+  if (command->post != nullptr) {
+    auto reason = static_cast<char *>(command->post);
+    ngx_slprintf(p, last, ". %s", reason);
+  }
 
-  return NGX_OK;
+  ngx_conf_log_error(NGX_LOG_WARN, cf, 0, "%s", buf);
+  return static_cast<char *>(NGX_CONF_ERROR);
 }
 
 }  // namespace nginx

src/datadog_directive.cpp

@@ -72,11 +72,39 @@ constexpr auto generate_directives(const T &...directives) {
   return merge_directives(directives...);
 }
 
+#define IGNORE_COMMAND(NAME, TYPE) \
+  { NAME, TYPE, silently_ignore_command, NGX_HTTP_LOC_CONF_OFFSET, 0, nullptr }
+
+#define ALIAS_COMMAND(SRC_DIRECTIVE, TARGET_DIRECTIVE, TYPE)              \
+  {                                                                       \
+    TARGET_DIRECTIVE, TYPE, alias_directive, NGX_HTTP_LOC_CONF_OFFSET, 0, \
+        (void *)SRC_DIRECTIVE                                             \
+  }
+
+#define WARN_DEPRECATED_COMMAND(NAME, TYPE, MSG)                      \
+  {                                                                   \
+    NAME, TYPE, warn_deprecated_command, NGX_HTTP_LOC_CONF_OFFSET, 0, \
+        (void *)MSG                                                   \
+  }
+
+#define ERROR_DEPRECATED_COMMAND(NAME, TYPE, MSG)                    \
+  {                                                                  \
+    NAME, TYPE, err_deprecated_command, NGX_HTTP_LOC_CONF_OFFSET, 0, \
+        (void *)MSG                                                  \
+  }
+
+char *silently_ignore_command(ngx_conf_t *, ngx_command_t *, void *);
+
+char *alias_directive(ngx_conf_t *cf, ngx_command_t *command,
+                      void *conf) noexcept;
+
 char *set_datadog_agent_url(ngx_conf_t *, ngx_command_t *, void *conf) noexcept;
 
-char *warn_deprecated_command_datadog_tracing(ngx_conf_t *cf,
-                                              ngx_command_t * /*command*/,
-                                              void * /*conf*/) noexcept;
+char *warn_deprecated_command(ngx_conf_t *cf, ngx_command_t *command,
+                              void *conf) noexcept;
+
+char *err_deprecated_command(ngx_conf_t *cf, ngx_command_t *command,
+                             void *) noexcept;
 
 }  // namespace nginx
 }  // namespace datadog