[php] Enable v1 payload tests, and make trace assertions format-agnostic

[Leiyks]

Motivation

dd-trace-php is moving to the v1 (efficient) trace payload by default (DataDog/dd-trace-php#4046). Enabling the v1 tests for PHP surfaced a few assertions that only work with the v0.4 shape, and a few validators that silently skip /v1.0/traces payloads.

Changes

• manifests/php.yml: gate tests/test_v1_payloads.py on v1.26.0-dev instead of a file-level missing_feature. Test_V1SpanLinks stays missing_feature, because PHP creates no span link from conflicting contexts (same as Test_Span_Links_From_Conflicting_Contexts).
• PHP weblogs (plain apache-mod/php-fpm, laravel11x, symfony7x): add /add_event, which adds a span.event event to the root span through DDTrace\SpanEvent, like the Go weblogs. Test_V1SpanEvents needs it.
• Make these assertions work with both formats (v0.4 and v1):
  • test_automated_payment_events.py, test_trace_tagging.py and api_security/test_endpoints.py read _sampling_priority_v1 from metrics. They now use get_sampling_priority(), because v1 carries the priority on the chunk.
  • test_db_integrations_sql.py::test_span_kind now checks agent spans with get_span_kind(). In idxTracerPayloads, the kind is a top-level enum (SPAN_KIND_CLIENT), not a span.kind attribute.
• Validators that silently skipped v1 now check it:
  • Test_TraceHeaders: the diagnostic-check, trace-count and container-id checks filtered on /v0.x/traces only. They now include /v1.0/traces, and count chunks there.
  • Test_Agent::test_agent_do_not_drop_traces looked for _sampling_priority_v1 in span metrics and skipped every v1 trace.
  • Test_SamplingDeterminism only read /v0.4 and /v0.5 payloads.

I replayed the PHP CI logs of a v1 branch build (DEFAULT and INTEGRATIONS). The payment events tests, test_span_kind and the data integrity tests pass. Mutating the chunk count and the agent trace set made Test_TraceHeaders and Test_Agent fail, which shows they now really check v1 payloads.

Merge order

A master build and the v1 branch both report 1.26.0+dev.<sha>, so this version gate can't tell them apart. For that reason, this PR should land after (or together with) the dd-trace-php v1 change. If that change misses 1.26.0, the gate has to move to the next minor.

Follow-ups (not in this PR)

• The test agent still raises NotImplementedError on array attributes in v1 span and link attributes (_convert_v1_attributes, _convert_v1_span_link_attributes). This is out of scope here.
• tests/test_span_events.py is still incomplete_test_app for PHP. Now that /add_event exists, it can be evaluated.
• Test_Process_Tags, Test_Otel_Span and Test_SingleSpan are disabled for PHP because process tags and _dd.top_level are missing. PHP v1 payloads carry _dd.tags.process, so these need re-checking.

[github-actions]

CODEOWNERS have been resolved as:

utils/build/docker/php/weblogs/plain/add_event.php                      @DataDog/system-tests-reviewers
manifests/php.yml                                                       @DataDog/system-tests-reviewers
tests/appsec/api_security/test_endpoints.py                             @DataDog/asm-libraries
tests/appsec/test_automated_payment_events.py                           @DataDog/asm-libraries
tests/appsec/test_trace_tagging.py                                      @DataDog/asm-libraries
tests/integrations/test_db_integrations_sql.py                          @DataDog/system-tests-reviewers
tests/test_data_integrity.py                                            @DataDog/system-tests-reviewers
tests/test_sampling_rates.py                                            @DataDog/system-tests-reviewers
utils/build/docker/php/common/rewrite-rules.conf                        @DataDog/system-tests-reviewers
utils/build/docker/php/weblogs/laravel11x/routes/web.php                @DataDog/system-tests-reviewers
utils/build/docker/php/weblogs/symfony7x/src/Controller/AppController.php  @DataDog/system-tests-reviewers
utils/dd_types/_datadog_library_trace.py                                @DataDog/system-tests-core
utils/interfaces/_library/core.py                                       @DataDog/system-tests-core

[datadog-datadog-prod-us1]

 

✨ Unblock PR with BitsAI

❌ Errors

Your PR has failed checks. Please review the issues below and take necessary action before merging.

🚦 67 Pipeline jobs failed

Testing the test | System Tests (php, dev) / End-to-end #1 / apache-mod-7.0 1 — ❌ 3 tests failed · 🔧 Needs a code fix, caused by this PR

View more details · View in GitHub Actions

❌ tests.test_v1_payloads.Test_V1Payloads.test_field_changes[apache-mod-7.0] from system_tests_suite

AssertionError: assert False
 +  where False = isinstance([{'duration': 2606159, 'error': 1, 'meta': {'_dd.appsec.event_rules.version': '1.18.0', '_dd.appsec.fp.http.endpoint':...abled': 1.0, '_dd.appsec.waf.duration': 617.0, '_dd.appsec.waf.duration_ext': 904.346, '_dd.rule_psr': 1.0, ...}, ...}], dict)
 +    where [{'duration': 2606159, 'error': 1, 'meta': {'_dd.appsec.event_rules.version': '1.18.0', '_dd.appsec.fp.http.endpoint':...abled': 1.0, '_dd.appsec.waf.duration': 617.0, '_dd.appsec.waf.duration_ext': 904.346, '_dd.rule_psr': 1.0, ...}, ...}] = <utils.dd_types._datadog_library_trace.DataDogLibraryTraceLegacy object at 0x7f7550ba4c80>.raw_trace

self = <tests.test_v1_payloads.Test_V1Payloads object at 0x7f7570681610>

    def test_field_changes(self):
        library_traces = list(interfaces.library.get_traces(self.r))
        agent_traces = list(interfaces.agent.get_traces(self.r))
        assert len(library_traces) == 1
...

❌ tests.test_v1_payloads.Test_V1SpanEvents.test_span_event_present[apache-mod-7.0] from system_tests_suite

AssertionError: Expected at least one span event
assert 0 >= 1
 +  where 0 = len([])

self = <tests.test_v1_payloads.Test_V1SpanEvents object at 0x7f7570681310>

    def test_span_event_present(self):
        """Root span carries at least one span event in V1 format"""
        span = interfaces.library.get_root_span(self.r)
        assert span is not None
...

❌ tests.test_v1_payloads.Test_V1TopLevelSpans.test_root_span_is_top_level[apache-mod-7.0] from system_tests_suite

AssertionError: Root span must have _dd.top_level=1 in attributes, got: None
assert (None == 1 or None == 1.0)
 +  where None = <built-in method get of dict object at 0x7f75502c5e00>('_dd.top_level')
 +    where <built-in method get of dict object at 0x7f75502c5e00> = {}.get
 +  and   None = <built-in method get of dict object at 0x7f75502c5e00>('_dd.top_level')
 +    where <built-in method get of dict object at 0x7f75502c5e00> = {}.get

self = <tests.test_v1_payloads.Test_V1TopLevelSpans object at 0x7f7570683ef0>

    def test_root_span_is_top_level(self):
...

Testing the test | System Tests (php, dev) / End-to-end #1 / apache-mod-7.0-zts 1 — ❌ 3 tests failed · 🔧 Needs a code fix, caused by this PR

View more details · View in GitHub Actions

❌ tests.test_v1_payloads.Test_V1Payloads.test_field_changes[apache-mod-7.0-zts] from system_tests_suite

AssertionError: assert False
 +  where False = isinstance([{'duration': 2304332, 'error': 1, 'meta': {'_dd.appsec.event_rules.version': '1.18.0', '_dd.appsec.fp.http.endpoint':...abled': 1.0, '_dd.appsec.waf.duration': 574.0, '_dd.appsec.waf.duration_ext': 784.965, '_dd.rule_psr': 1.0, ...}, ...}], dict)
 +    where [{'duration': 2304332, 'error': 1, 'meta': {'_dd.appsec.event_rules.version': '1.18.0', '_dd.appsec.fp.http.endpoint':...abled': 1.0, '_dd.appsec.waf.duration': 574.0, '_dd.appsec.waf.duration_ext': 784.965, '_dd.rule_psr': 1.0, ...}, ...}] = <utils.dd_types._datadog_library_trace.DataDogLibraryTraceLegacy object at 0x7f9fdfa41640>.raw_trace

self = <tests.test_v1_payloads.Test_V1Payloads object at 0x7fa002dadb50>

    def test_field_changes(self):
        library_traces = list(interfaces.library.get_traces(self.r))
        agent_traces = list(interfaces.agent.get_traces(self.r))
        assert len(library_traces) == 1
...

❌ tests.test_v1_payloads.Test_V1SpanEvents.test_span_event_present[apache-mod-7.0-zts] from system_tests_suite

AssertionError: Expected at least one span event
assert 0 >= 1
 +  where 0 = len([])

self = <tests.test_v1_payloads.Test_V1SpanEvents object at 0x7fa002daf680>

    def test_span_event_present(self):
        """Root span carries at least one span event in V1 format"""
        span = interfaces.library.get_root_span(self.r)
        assert span is not None
...

❌ tests.test_v1_payloads.Test_V1TopLevelSpans.test_root_span_is_top_level[apache-mod-7.0-zts] from system_tests_suite

AssertionError: Root span must have _dd.top_level=1 in attributes, got: None
assert (None == 1 or None == 1.0)
 +  where None = <built-in method get of dict object at 0x7f9fdf17e100>('_dd.top_level')
 +    where <built-in method get of dict object at 0x7f9fdf17e100> = {}.get
 +  and   None = <built-in method get of dict object at 0x7f9fdf17e100>('_dd.top_level')
 +    where <built-in method get of dict object at 0x7f9fdf17e100> = {}.get

self = <tests.test_v1_payloads.Test_V1TopLevelSpans object at 0x7fa002daf8c0>

    def test_root_span_is_top_level(self):
...

Testing the test | System Tests (php, dev) / End-to-end #1 / apache-mod-7.1 1 — ❌ 3 tests failed · 🔧 Needs a code fix, caused by this PR

View more details · View in GitHub Actions

❌ tests.test_v1_payloads.Test_V1Payloads.test_field_changes[apache-mod-7.1] from system_tests_suite

AssertionError: assert False
 +  where False = isinstance([{'duration': 3770230, 'error': 1, 'meta': {'_dd.appsec.event_rules.version': '1.18.0', '_dd.appsec.fp.http.endpoint':...abled': 1.0, '_dd.appsec.waf.duration': 682.0, '_dd.appsec.waf.duration_ext': 951.553, '_dd.rule_psr': 1.0, ...}, ...}], dict)
 +    where [{'duration': 3770230, 'error': 1, 'meta': {'_dd.appsec.event_rules.version': '1.18.0', '_dd.appsec.fp.http.endpoint':...abled': 1.0, '_dd.appsec.waf.duration': 682.0, '_dd.appsec.waf.duration_ext': 951.553, '_dd.rule_psr': 1.0, ...}, ...}] = <utils.dd_types._datadog_library_trace.DataDogLibraryTraceLegacy object at 0x7f7a0127e5a0>.raw_trace

self = <tests.test_v1_payloads.Test_V1Payloads object at 0x7f7a294ad4c0>

    def test_field_changes(self):
        library_traces = list(interfaces.library.get_traces(self.r))
        agent_traces = list(interfaces.agent.get_traces(self.r))
        assert len(library_traces) == 1
...

❌ tests.test_v1_payloads.Test_V1SpanEvents.test_span_event_present[apache-mod-7.1] from system_tests_suite

AssertionError: Expected at least one span event
assert 0 >= 1
 +  where 0 = len([])

self = <tests.test_v1_payloads.Test_V1SpanEvents object at 0x7f7a294ae3c0>

    def test_span_event_present(self):
        """Root span carries at least one span event in V1 format"""
        span = interfaces.library.get_root_span(self.r)
        assert span is not None
...

❌ tests.test_v1_payloads.Test_V1TopLevelSpans.test_root_span_is_top_level[apache-mod-7.1] from system_tests_suite

AssertionError: Root span must have _dd.top_level=1 in attributes, got: None
assert (None == 1 or None == 1.0)
 +  where None = <built-in method get of dict object at 0x7f7a01e282c0>('_dd.top_level')
 +    where <built-in method get of dict object at 0x7f7a01e282c0> = {}.get
 +  and   None = <built-in method get of dict object at 0x7f7a01e282c0>('_dd.top_level')
 +    where <built-in method get of dict object at 0x7f7a01e282c0> = {}.get

self = <tests.test_v1_payloads.Test_V1TopLevelSpans object at 0x7f7a294ae750>

    def test_root_span_is_top_level(self):
...

View all 67 failed jobs.

ℹ️ Info

No other issues found (see more)

❄️ No new flaky tests detected

Useful? React with 👍 / 👎

_{This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 934eb96 | Docs | View more details | Give us feedback!}