Skip to content

feat(sanic): Gate user info behind data_collection config#6870

Open
ericapisani wants to merge 5 commits into
masterfrom
py-2583-sanic-user-info
Open

feat(sanic): Gate user info behind data_collection config#6870
ericapisani wants to merge 5 commits into
masterfrom
py-2583-sanic-user-info

Conversation

@ericapisani

@ericapisani ericapisani commented Jul 23, 2026

Copy link
Copy Markdown
Member

Apply the data_collection.user_info setting to the Sanic integration's user IP collection, giving it precedence over the legacy send_default_pii boolean when explicitly configured. This covers both the user.ip_address scope attribute applied to all spans and the client.address span attribute, mirroring the behavior already shipped for Flask, WSGI, ASGI, and Django.

The user IP span test is reparametrized with the shared DATA_COLLECTION_USER_INFO_CASES matrix from tests/integrations/utils.py, and a new test covers the previously untested client.address span attribute.

Refs PY-2583
Refs #6746

@linear-code

linear-code Bot commented Jul 23, 2026

Copy link
Copy Markdown

PY-2583

@ericapisani ericapisani changed the title py 2583 sanic user info feat(sanic): Gate user info behind data_collection config Jul 23, 2026
@ericapisani
ericapisani marked this pull request as ready for review July 23, 2026 14:44
@ericapisani
ericapisani requested a review from a team as a code owner July 23, 2026 14:44
@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Codecov Results 📊

96492 passed | ⏭️ 6410 skipped | Total: 102902 | Pass Rate: 93.77% | Execution Time: 345m 39s

📊 Comparison with Base Branch

Metric Change
Total Tests 📈 +632
Passed Tests 📈 +562
Failed Tests
Skipped Tests 📈 +70

All tests are passing successfully.

✅ Patch coverage is 100.00%. Project has 2511 uncovered lines.
✅ Project coverage is 89.69%. Comparing base (base) to head (head).

Coverage diff
@@            Coverage Diff             @@
##          main       #PR       +/-##
==========================================
+ Coverage    89.68%    89.69%    +0.01%
==========================================
  Files          193       193         —
  Lines        24321     24344       +23
  Branches      8572      8596       +24
==========================================
+ Hits         21809     21833       +24
- Misses        2512      2511        -1
- Partials      1397      1394        -3

Generated by Codecov Action

Apply the data_collection.user_info setting to Django user identity (id, email, username) collection, giving it precedence over the legacy send_default_pii boolean when explicitly configured. This mirrors the existing behavior for client IP/user info already shipped for Flask, WSGI, and ASGI.

The user extraction logic in _after_get_response is pulled into a shared helper used by both the WSGI and ASGI event processors, and the parametrized send_default_pii/data_collection test matrix is extracted into tests/integrations/django/utils.py for reuse across the WSGI and ASGI test suites.

Refs PY-2583
The new test was the only DB-touching test without @pytest.mark.forked. Running in the parent process leaked the created user into the shared in-memory sqlite DB (UNIQUE constraint failures in test_basic) and caused the parent to hold the session-scoped django_db_setup fixture, so forked children skipped postgres test DB creation but still destroyed it on teardown (database does not exist errors).
Move the identical USER_INFO_INIT_KWARGS parametrization from the flask, wsgi, and django test suites into tests/integrations/utils.py as DATA_COLLECTION_USER_INFO_CASES, documenting that the second element of each case is whether user info is expected to be collected.
Apply the data_collection.user_info setting to the Sanic integration's user IP collection, giving it precedence over the legacy send_default_pii boolean when explicitly configured. This covers both the user.ip_address scope attribute applied to all spans and the client.address span attribute, mirroring the behavior already shipped for Flask, WSGI, ASGI, and Django.

The user IP span test is reparametrized with the shared DATA_COLLECTION_USER_INFO_CASES matrix from tests/integrations/utils.py, and a new test covers the previously untested client.address span attribute.

Refs PY-2583
@ericapisani
ericapisani force-pushed the py-2583-django-user-info branch from 615580f to 4ee42d0 Compare July 23, 2026 18:15
@ericapisani
ericapisani force-pushed the py-2583-sanic-user-info branch from 4a557fc to 057caa4 Compare July 23, 2026 18:15
Base automatically changed from py-2583-django-user-info to master July 24, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants