test(parametric): decouple nodejs stable-config assertions from renamable tracer internals (#7196)

Author: BridgeAR

manifests/nodejs.yml

@@ -2026,7 +2026,6 @@ manifest:
     - declaration: missing_feature (Implemented in 5.38.0)
       component_version: <5.38.0
   tests/parametric/test_config_consistency.py::Test_Config_Dogstatsd: *ref_5_29_0
-  tests/parametric/test_config_consistency.py::Test_Config_Dogstatsd::test_dogstatsd_default: incomplete_test_app (PHP parameteric app can not access the dogstatsd default values, this logic is internal to the tracer)
   tests/parametric/test_config_consistency.py::Test_Config_RateLimit: *ref_5_25_0
   tests/parametric/test_config_consistency.py::Test_Config_Tags: *ref_5_41_0
   tests/parametric/test_config_consistency.py::Test_Config_TraceAgentURL: *ref_5_25_0

tests/parametric/conftest.py

@@ -1,5 +1,6 @@
 import base64
 from collections.abc import Generator
+import json
 from pathlib import Path
 import shutil
 import subprocess
@@ -131,3 +132,60 @@ def write_stable_config_content(self, stable_config_content: str, path: str, tes
             cmd = "sudo " + cmd
         success, message = test_library.container_exec_run(cmd)
         assert success, message
+
+
+# dd_* keys whose canonical telemetry name is not simply the upper-cased key. The tracer
+# reports the canonical name (e.g. DD_TRACE_LOG_LEVEL); DD_LOG_LEVEL is only an alias.
+_TELEMETRY_NAME_OVERRIDES = {"dd_log_level": "DD_TRACE_LOG_LEVEL"}
+
+
+def _telemetry_name(dd_key: str) -> str:
+    return _TELEMETRY_NAME_OVERRIDES.get(dd_key, dd_key.upper())
+
+
+def nodejs_telemetry_value(test_agent: TestAgentAPI, dd_key: str) -> str | int | float | bool | None:
+    """Return the effective nodejs telemetry value for a dd_* config key.
+
+    dd-trace-js builds /trace/config from internal property paths that a series of config
+    PRs is renaming to canonical names; the telemetry keeps reporting the stable canonical
+    names, so asserting there stays decoupled from those refactors. The effective value is
+    the highest-seq_id entry (already sorted first).
+    """
+    name = _telemetry_name(dd_key)
+    configuration_by_name = test_agent.wait_for_telemetry_configurations()
+    entries = configuration_by_name.get(name)
+    assert entries, f"No telemetry configuration '{name}'"
+    return entries[0].get("value")
+
+
+def assert_nodejs_telemetry_config(test_agent: TestAgentAPI, expected: dict) -> None:
+    """Assert expected dd_* config values against the nodejs telemetry configuration."""
+    configuration_by_name = test_agent.wait_for_telemetry_configurations()
+    for dd_key, expected_value in expected.items():
+        name = _telemetry_name(dd_key)
+        entries = configuration_by_name.get(name)
+        assert entries, f"No telemetry configuration '{name}'"
+        actual = entries[0].get("value")
+        if dd_key == "dd_tags":
+            actual_tags = "" if actual is None else str(actual)
+            expected_tags = expected_value if isinstance(expected_value, list) else str(expected_value).split(",")
+            for tag in expected_tags:
+                assert tag in actual_tags, f"Expected tag '{tag}' not found in telemetry tags: {actual_tags}"
+        else:
+            assert str(actual).lower() == str(expected_value).lower(), f"Expected {name}={expected_value}, got {actual}"
+
+
+def nodejs_startup_config(test_library: APMLibrary) -> dict:
+    """Parse the tracer's published `DATADOG TRACER CONFIGURATION - {json}` startup line.
+
+    Some facts have no telemetry signal: an unreachable agent never delivers telemetry (so the
+    resolved agent URL is unobservable that way), and OTEL_LOG_LEVEL=debug toggles debug logging
+    without a DD_TRACE_DEBUG telemetry entry. The startup diagnostic is a published, user-facing
+    log line that carries them, so it is the non-internal source for those cases.
+    """
+    marker = "DATADOG TRACER CONFIGURATION - "
+    for line in test_library.get_logs().splitlines():
+        index = line.find(marker)
+        if index != -1:
+            return json.loads(line[index + len(marker) :])
+    raise AssertionError("No 'DATADOG TRACER CONFIGURATION' line found in container logs")

tests/parametric/test_config_consistency.py

@@ -13,7 +13,7 @@
 )
 from utils.docker_fixtures.spec.trace import find_span_in_traces, find_only_span
 from utils.docker_fixtures import TestAgentAPI
-from .conftest import APMLibrary, StableConfigWriter
+from .conftest import APMLibrary, StableConfigWriter, assert_nodejs_telemetry_config, nodejs_startup_config
 
 parametrize = pytest.mark.parametrize
 
@@ -136,6 +136,7 @@ class Test_Config_TraceAgentURL:
         "library_env",
         [
             {
+                "DD_TRACE_STARTUP_LOGS": "true",
                 "DD_TRACE_AGENT_URL": "unix:///var/run/datadog/apm.socket",
                 "DD_AGENT_HOST": "localhost",
                 "DD_TRACE_AGENT_PORT": "8126",
@@ -144,9 +145,9 @@ class Test_Config_TraceAgentURL:
     )
     def test_dd_trace_agent_unix_url_nonexistent(self, test_library: APMLibrary):
         with test_library as t:
-            resp = t.config()
+            agent_url = _trace_agent_url(t)
 
-        url = urlparse(resp["dd_trace_agent_url"])
+        url = urlparse(agent_url)
         assert "unix" in url.scheme
         assert url.path == "/var/run/datadog/apm.socket"
 
@@ -155,6 +156,7 @@ def test_dd_trace_agent_unix_url_nonexistent(self, test_library: APMLibrary):
         "library_env",
         [
             {
+                "DD_TRACE_STARTUP_LOGS": "true",
                 "DD_TRACE_AGENT_URL": "http://random-host:9999/",
                 "DD_AGENT_HOST": "localhost",
                 "DD_TRACE_AGENT_PORT": "8126",
@@ -163,9 +165,9 @@ def test_dd_trace_agent_unix_url_nonexistent(self, test_library: APMLibrary):
     )
     def test_dd_trace_agent_http_url_nonexistent(self, test_library: APMLibrary):
         with test_library as t:
-            resp = t.config()
+            agent_url = _trace_agent_url(t)
 
-        url = urlparse(resp["dd_trace_agent_url"])
+        url = urlparse(agent_url)
         assert url.scheme == "http"
         assert url.hostname == "random-host"
         assert url.port == 9999
@@ -174,6 +176,7 @@ def test_dd_trace_agent_http_url_nonexistent(self, test_library: APMLibrary):
         "library_env",
         [
             {
+                "DD_TRACE_STARTUP_LOGS": "true",
                 "DD_TRACE_AGENT_URL": "http://[::1]:5000",
                 "DD_AGENT_HOST": "localhost",
                 "DD_TRACE_AGENT_PORT": "8126",
@@ -182,9 +185,9 @@ def test_dd_trace_agent_http_url_nonexistent(self, test_library: APMLibrary):
     )
     def test_dd_trace_agent_http_url_ipv6(self, test_library: APMLibrary):
         with test_library as t:
-            resp = t.config()
+            agent_url = _trace_agent_url(t)
 
-        url = urlparse(resp["dd_trace_agent_url"])
+        url = urlparse(agent_url)
         assert url.scheme == "http"
         assert url.hostname == "::1"
         assert url.port == 5000
@@ -193,6 +196,7 @@ def test_dd_trace_agent_http_url_ipv6(self, test_library: APMLibrary):
         "library_env",
         [
             {
+                "DD_TRACE_STARTUP_LOGS": "true",
                 "DD_TRACE_AGENT_URL": "",  # Empty string passed to make sure conftest.py does not set trace agent url
                 "DD_AGENT_HOST": "[::1]",
                 "DD_TRACE_AGENT_PORT": "5000",
@@ -201,9 +205,9 @@ def test_dd_trace_agent_http_url_ipv6(self, test_library: APMLibrary):
     )
     def test_dd_agent_host_ipv6(self, test_library: APMLibrary):
         with test_library as t:
-            resp = t.config()
+            agent_url = _trace_agent_url(t)
 
-        url = urlparse(resp["dd_trace_agent_url"])
+        url = urlparse(agent_url)
         assert url.scheme == "http"
         assert url.hostname == "::1"
         assert url.port == 5000
@@ -217,8 +221,11 @@ class Test_Config_RateLimit:
     # which would be unreliable for testing and require significant effort for each tracer's weblog application.
     # The feature is mainly tested in the second test case, where the rate limit is set to 1 to ensure it works as expected.
     @parametrize("library_env", [{"DD_TRACE_SAMPLE_RATE": "1"}])
-    def test_default_trace_rate_limit(self, test_library: APMLibrary):
+    def test_default_trace_rate_limit(self, test_agent: TestAgentAPI, test_library: APMLibrary):
         with test_library as t:
+            if t.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, {"dd_trace_rate_limit": "100"})
+                return
             resp = t.config()
         assert resp["dd_trace_rate_limit"] == "100"
 
@@ -359,27 +366,41 @@ class Test_Config_Dogstatsd:
     @parametrize(
         "library_env", [{"DD_AGENT_HOST": "localhost"}]
     )  # Adding DD_AGENT_HOST because some SDKs use DD_AGENT_HOST to set the dogstatsd host if unspecified
-    def test_dogstatsd_default(self, test_library: APMLibrary):
+    def test_dogstatsd_default(self, test_agent: TestAgentAPI, test_library: APMLibrary):
         with test_library as t:
+            if t.lang == "nodejs":
+                assert_nodejs_telemetry_config(
+                    test_agent, {"dd_dogstatsd_host": "localhost", "dd_dogstatsd_port": "8125"}
+                )
+                return
             resp = t.config()
         assert resp["dd_dogstatsd_host"] == "localhost"
         assert resp["dd_dogstatsd_port"] == "8125"
 
     @parametrize("library_env", [{"DD_DOGSTATSD_HOST": "192.168.10.1"}])
-    def test_dogstatsd_custom_ip_address(self, test_library: APMLibrary):
+    def test_dogstatsd_custom_ip_address(self, test_agent: TestAgentAPI, test_library: APMLibrary):
         with test_library as t:
+            if t.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, {"dd_dogstatsd_host": "192.168.10.1"})
+                return
             resp = t.config()
         assert resp["dd_dogstatsd_host"] == "192.168.10.1"
 
     @parametrize("library_env", [{"DD_DOGSTATSD_HOST": "127.0.0.1"}])
-    def test_dogstatsd_custom_hostname(self, test_library: APMLibrary):
+    def test_dogstatsd_custom_hostname(self, test_agent: TestAgentAPI, test_library: APMLibrary):
         with test_library as t:
+            if t.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, {"dd_dogstatsd_host": "127.0.0.1"})
+                return
             resp = t.config()
         assert resp["dd_dogstatsd_host"] == "127.0.0.1"
 
     @parametrize("library_env", [{"DD_DOGSTATSD_PORT": "8150"}])
-    def test_dogstatsd_custom_port(self, test_library: APMLibrary):
+    def test_dogstatsd_custom_port(self, test_agent: TestAgentAPI, test_library: APMLibrary):
         with test_library as t:
+            if t.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, {"dd_dogstatsd_port": "8150"})
+                return
             resp = t.config()
         assert resp["dd_dogstatsd_port"] == "8150"
 
@@ -406,6 +427,17 @@ def test_dogstatsd_custom_port(self, test_library: APMLibrary):
 }
 
 
+def _trace_agent_url(test_library: APMLibrary) -> str:
+    """Resolve dd_trace_agent_url from the tracer's startup log (nodejs) or /trace/config (others).
+
+    These tests point the tracer at an unreachable agent, so telemetry never arrives; the
+    published startup-config line is the non-internal source for the resolved URL.
+    """
+    if test_library.lang == "nodejs":
+        return str(nodejs_startup_config(test_library)["agent_url"])
+    return test_library.config()["dd_trace_agent_url"] or ""
+
+
 class QuotedStr(str):
     __slots__ = ()
 
@@ -489,6 +521,7 @@ class Test_Stable_Config_Default(StableConfigWriter):
     )
     def test_default_config(
         self,
+        test_agent: TestAgentAPI,
         test_library: APMLibrary,
         path: str,
         name: str,
@@ -505,8 +538,11 @@ def test_default_config(
                 test_library,
             )
             test_library.container_restart()
-            config = test_library.config()
-            assert expected.items() <= config.items()
+            if test_library.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, expected)
+            else:
+                config = test_library.config()
+                assert expected.items() <= config.items()
 
     @pytest.mark.parametrize("library_env", [{}])
     @pytest.mark.parametrize(
@@ -538,6 +574,7 @@ def test_default_config(
     )
     def test_extended_configs(
         self,
+        test_agent: TestAgentAPI,
         test_library: APMLibrary,
         path: str,
         name: str,
@@ -561,6 +598,10 @@ def test_extended_configs(
                 test_library,
             )
             test_library.container_restart()
+            if test_library.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, expected)
+                return
+
             config = test_library.config()
 
             # Special handling for dd_tags: check if expected tags are present in actual tags
@@ -605,7 +646,7 @@ def test_extended_configs(
             "/etc/datadog-agent/application_monitoring.yaml",
         ],
     )
-    def test_unknown_key_skipped(self, test_library: APMLibrary, path: str, test: dict):
+    def test_unknown_key_skipped(self, test_agent: TestAgentAPI, test_library: APMLibrary, path: str, test: dict):
         with test_library:
             self.write_stable_config(
                 {
@@ -616,8 +657,11 @@ def test_unknown_key_skipped(self, test_library: APMLibrary, path: str, test: di
                 test_library,
             )
             test_library.container_restart()
-            config = test_library.config()
-            assert test["expected"].items() <= config.items()
+            if test_library.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, test["expected"])
+            else:
+                config = test_library.config()
+                assert test["expected"].items() <= config.items()
 
     @pytest.mark.parametrize(
         "path",
@@ -626,16 +670,19 @@ def test_unknown_key_skipped(self, test_library: APMLibrary, path: str, test: di
             "/etc/datadog-agent/application_monitoring.yaml",
         ],
     )
-    def test_invalid_files(self, test_library: APMLibrary, path: str):
+    def test_invalid_files(self, test_agent: TestAgentAPI, test_library: APMLibrary, path: str):
         with test_library:
             self.write_stable_config_content(
                 "?? ??; ??\t\n\n --- `??",
                 path,
                 test_library,
             )
             test_library.container_restart()
-            config = test_library.config()
-            assert SDK_DEFAULT_STABLE_CONFIG.items() <= config.items()
+            if test_library.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, SDK_DEFAULT_STABLE_CONFIG)
+            else:
+                config = test_library.config()
+                assert SDK_DEFAULT_STABLE_CONFIG.items() <= config.items()
 
     @pytest.mark.parametrize(
         ("name", "local_cfg", "library_env", "fleet_cfg", "expected"),
@@ -679,6 +726,7 @@ def test_invalid_files(self, test_library: APMLibrary, path: str):
     )
     def test_config_precedence(
         self,
+        test_agent: TestAgentAPI,
         name: str,
         test_library: APMLibrary,
         local_cfg: dict,
@@ -703,6 +751,10 @@ def test_config_precedence(
             )
 
             test_library.container_restart()
+            if test_library.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, expected)
+                return
+
             config = test_library.config()
             assert expected.items() <= config.items(), format(
                 "unexpected values for the following configurations: {}"
@@ -716,7 +768,7 @@ class Test_Stable_Config_Rules(StableConfigWriter):
     """Verify that stable config targeting rules work as intended (apm_configuration_rules)"""
 
     @pytest.mark.parametrize("library_env", [{"STABLE_CONFIG_SELECTOR": "true", "DD_SERVICE": "not-my-service"}])
-    def test_targeting_rules(self, test_library: APMLibrary):
+    def test_targeting_rules(self, test_agent: TestAgentAPI, test_library: APMLibrary):
         path = "/etc/datadog-agent/managed/datadog-agent/stable/application_monitoring.yaml"
         with test_library:
             self.write_stable_config(
@@ -739,18 +791,21 @@ def test_targeting_rules(self, test_library: APMLibrary):
                 test_library,
             )
             test_library.container_restart()
-            config = test_library.config()
-            assert config["dd_service"] == "my-service", (
-                f"Service name is '{config['dd_service']}' instead of 'my-service'"
-            )
+            if test_library.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, {"dd_service": "my-service"})
+            else:
+                config = test_library.config()
+                assert config["dd_service"] == "my-service", (
+                    f"Service name is '{config['dd_service']}' instead of 'my-service'"
+                )
 
     @pytest.mark.parametrize(
         "library_extra_command_arguments",
         [
             ["-Darg1=value"]
         ],  # Note: This test was written for Java, so if this arg is not compatible for other libs, we may need to dynamically set library_extra_command_arguments based on context.library.name
     )
-    def test_process_arguments(self, test_library: APMLibrary):
+    def test_process_arguments(self, test_agent: TestAgentAPI, test_library: APMLibrary):
         path = "/etc/datadog-agent/managed/datadog-agent/stable/application_monitoring.yaml"
         with test_library:
             config = {
@@ -772,7 +827,10 @@ def test_process_arguments(self, test_library: APMLibrary):
             stable_config_content = yaml.dump(config, Dumper=CustomDumper)
             self.write_stable_config_content(stable_config_content, path, test_library)
             test_library.container_restart()
-            lib_config = test_library.config()
-            assert lib_config["dd_service"] == "value", (
-                f"Service name is '{lib_config['dd_service']}' instead of 'value'"
-            )
+            if test_library.lang == "nodejs":
+                assert_nodejs_telemetry_config(test_agent, {"dd_service": "value"})
+            else:
+                lib_config = test_library.config()
+                assert lib_config["dd_service"] == "value", (
+                    f"Service name is '{lib_config['dd_service']}' instead of 'value'"
+                )