feat(integrations): align request middleware configuration by hpouillot · Pull Request #1040 · PostHog/posthog-python

hpouillot · 2026-10-08T15:09:19Z

💡 Motivation and Context

Public API change: align ASGI, Flask, and Django request integration options so request enrichment can be used independently of error tracking. This follows the ASGI/Flask integrations in #1037 and #1038. The matching DRF handler update is in #1036.

ASGI and Flask default capture_exceptions to None, inheriting the effective client's enable_exception_autocapture; explicit True/False overrides remain available. Inheritance is resolved when exceptions occur, including when global client setup happens after middleware registration.
Add trust_tracing_headers=False to Flask and POSTHOG_MW_TRUST_TRACING_HEADERS=False to Django, matching ASGI. Browser identity/session attribution now requires explicit opt-in; these identifiers are analytics context, never authentication.
Django adds POSTHOG_MW_EXTRA_PROPERTIES, POSTHOG_MW_PROPERTIES_MAP, and property-named extraction methods. Existing settings, attributes, and methods remain aliases, with new settings taking precedence.
Django preserves its historical capture-on default when the setting is omitted. Set POSTHOG_MW_CAPTURE_EXCEPTIONS=None to inherit the client, or False for context-only behavior.
Document shared options, filter behavior, client routing, context lifetime, and compatibility changes in references/middleware_configuration.md. The integration client routes automatic exceptions only; manually captured events keep their chosen destination and inherit request context independently.

Behavior changes: ASGI/Flask no longer enable integration error tracking by default on clients with autocapture disabled. Django/Flask no longer accept tracing identity/session headers unless explicitly enabled.

💚 How did you test it?

Integration suite: 127 passed, including sync/async Django, client inheritance and overrides, late global client initialization, secure header defaults, request exclusions, and actual event enrichment through a different client in context-only mode.
Full suite: 4,554 passed, 16 skipped, 48 subtests passed.
Full Ruff format/check and full mypy baseline passed.
Regenerated and checked the public API snapshot.
Warning-as-error SDK/integration imports passed.

📝 Checklist

I reviewed the submitted code.
I added tests to verify the changes.
I updated the docs if needed.
No breaking change or entry added to the changelog.

If releasing new changes

Ran sampo add to generate a changeset file

Added .sampo/changesets/consistent-request-integration-api.md manually.

🤖 Agent context

Autonomy: Human-driven (agent-assisted)

Implemented with the pi coding agent and Cockpit child sessions, using local file/command tools and the GitHub CLI. The human-directed API keeps one integration per framework rather than introducing ordering-sensitive middleware layers. Shared semantics use the existing private client-default resolver and preserve Django's capture default and old property-setting aliases for compatibility. Session: 344b8733-8056-4f90-b182-7535cf8db88b.

Human review is required; this PR has not been auto-approved or merged.

github-actions · 2026-10-08T15:12:27Z

posthog-python Compliance Report

Date: 2026-10-08T15:14:31.996902+00:00
Duration: 259908ms

✅ All Tests Passed!

121/121 tests passed

Capture_V1 Tests

✅ 95/95 tests passed

View Details

Test	Status	Duration
Endpoint And Method.Targets V1 Endpoint	✅	517ms
Endpoint And Method.Does Not Use Legacy Endpoints	✅	511ms
Required Headers.Has Authorization Bearer Header	✅	511ms
Required Headers.Has Content Type Json	✅	511ms
Required Headers.Has Posthog Sdk Info Format	✅	511ms
Required Headers.Has Posthog Attempt Header	✅	510ms
Required Headers.Has Posthog Request Id	✅	510ms
Required Headers.Has Posthog Request Timestamp	✅	510ms
Required Headers.Has User Agent	✅	510ms
Body Format.Body Has Created At And Batch	✅	510ms
Body Format.No Api Key In Body	✅	510ms
Body Format.No Sent At In Body	✅	511ms
Event Format.Event Has Required Root Fields	✅	510ms
Event Format.Event Uuid Is Valid	✅	510ms
Event Format.Event Timestamp Is Rfc3339	✅	510ms
Event Format.Non Utc Event Timestamp Is Converted To Utc	✅	515ms
Event Format.Distinct Id Is String	✅	510ms
Event Format.Distinct Id At Root Not Properties	✅	511ms
Event Format.Custom Properties Preserved	✅	510ms
Event Format.Set Properties Preserved	✅	510ms
Event Format.Set Once Properties Preserved	✅	510ms
Event Format.Groups Properties Preserved	✅	511ms
Event Format.Sdk Generates Uuid If Not Provided	✅	509ms
Event Format.Event Has Required Root Fields Batch	✅	514ms
Event Format.Event Uuid Is Valid Batch	✅	514ms
Event Format.Event Timestamp Is Rfc3339 Batch	✅	514ms
Event Format.Distinct Id Is String Batch	✅	513ms
Event Format.Distinct Id At Root Not Properties Batch	✅	514ms
Event Format.Custom Properties Preserved Batch	✅	514ms
Event Format.Set Properties Preserved Batch	✅	514ms
Event Format.Set Once Properties Preserved Batch	✅	513ms
Event Format.Groups Properties Preserved Batch	✅	514ms
Event Format.Sdk Generates Uuid If Not Provided Batch	✅	514ms
Batch Behavior.Multiple Events In Single Batch	✅	518ms
Batch Behavior.Batch Envelope Smoke	✅	516ms
Batch Behavior.Flush With No Events Sends Nothing	✅	506ms
Batch Behavior.Flush At Triggers Batch	✅	1011ms
Batch Behavior.Created At Reflects Batch Creation Time	✅	510ms
Deduplication.Generates Unique Uuids	✅	518ms
Deduplication.Different Events Same Content Different Uuids	✅	513ms
Deduplication.Preserves Uuid On Retry	✅	6518ms
Deduplication.Preserves Timestamp On Retry	✅	6519ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry	✅	6522ms
Deduplication.No Duplicate Events In Batch	✅	518ms
Header Behavior On Retry.Attempt Header Starts At One	✅	511ms
Header Behavior On Retry.Attempt Header Increments On Retry	✅	13527ms
Header Behavior On Retry.Request Id Preserved On Retry	✅	6520ms
Header Behavior On Retry.Different Requests Have Different Request Ids	✅	3021ms
Header Behavior On Retry.Request Timestamp Changes On Retry	✅	6520ms
Response Format Validation.Success Response Has Uuid Keyed Results	✅	510ms
Response Format Validation.Success Response Has Ok For Each Event	✅	515ms
Response Format Validation.Success No Retry After When All Ok	✅	513ms
Response Format Validation.Success Retry After Present When Retry Events	✅	1516ms
Response Format Validation.Success No Retry After When Drop Only	✅	513ms
Response Format Validation.Response Echoes Request Id	✅	511ms
Retry Behavior.Retries On 408	✅	6520ms
Retry Behavior.Retries On 500	✅	6520ms
Retry Behavior.Retries On 503	✅	8525ms
Retry Behavior.Retries On 504	✅	6521ms
Retry Behavior.Retryable Errors Have Retry After	✅	3517ms
Retry Behavior.Respects Retry After On Retryable Error	✅	11524ms
Retry Behavior.Does Not Retry On 400	✅	2514ms
Retry Behavior.Does Not Retry On 401	✅	2514ms
Retry Behavior.Does Not Retry On 402	✅	2514ms
Retry Behavior.Does Not Retry On 413	✅	2515ms
Retry Behavior.Does Not Retry On 415	✅	2513ms
Retry Behavior.Non Retryable Errors Have No Retry After	✅	2514ms
Retry Behavior.Implements Backoff	✅	22526ms
Retry Behavior.Max Retries Respected	✅	22538ms
Partial Batch Handling.Handles 200 Full Success	✅	2513ms
Partial Batch Handling.Handles 200 With All Ok	✅	3517ms
Partial Batch Handling.Does Not Retry Dropped Events	✅	3513ms
Partial Batch Handling.Does Not Retry Limited Events	✅	3514ms
Partial Batch Handling.Prunes Ok Events On Partial Retry	✅	6521ms
Partial Batch Handling.Prunes Dropped Events On Partial Retry	✅	6522ms
Partial Batch Handling.Retries Only Retry Events From Partial	✅	6523ms
Partial Batch Handling.Partial Retry Preserves Uuids	✅	6517ms
Partial Batch Handling.Partial Retry Attempt Header Increments	✅	6521ms
Partial Batch Handling.Partial Retry Request Id Preserved	✅	6521ms
Partial Batch Handling.Respects Retry After On Partial	✅	8517ms
Partial Batch Handling.Unknown Result Treated As Terminal	✅	3516ms
Partial Batch Handling.Mixed Ok Drop Limited No Retry	✅	3519ms
Compression.Sends Gzip Content Encoding	✅	510ms
Compression.No Content Encoding When Disabled	✅	511ms
Compression.Compressed Body Is Decompressible	✅	510ms
Error Handling.Does Not Retry On Unknown 4Xx	✅	2512ms
Event Options.Cookieless Mode Override	✅	510ms
Event Options.Disable Skew Correction Override	✅	510ms
Event Options.Process Person Profile Override	✅	510ms
Event Options.Product Tour Id Override	✅	511ms
Event Options.Unset Options Omitted	✅	509ms
Event Options.Options Override In Batch	✅	514ms
Geoip And Historical Migration.Geoip Disable Injected Into Properties	✅	510ms
Geoip And Historical Migration.Historical Migration Set In Body	✅	510ms
Geoip And Historical Migration.Historical Migration Absent By Default	✅	510ms

Capture_Ai Tests

✅ 5/5 tests passed

View Details

Test	Status	Duration
Routing.Capture Ai Posts To Ai Endpoint	✅	511ms
Routing.Capture Does Not Reroute Ai Named Events	✅	510ms
Identity.Capture Ai Event Has Uuid	✅	510ms
Identity.Capture Ai Keeps Supplied Uuid	✅	510ms
Timestamp Format.Non Utc Event Timestamp Is Converted To Utc	✅	511ms

Feature_Flags Tests

✅ 17/17 tests passed

View Details

Test	Status	Duration
Request Payload.Request With Person Properties Device Id	✅	11ms
Request Payload.Flags Request Uses V2 Query Param	✅	9ms
Request Payload.Flags Request Hits Flags Path Not Decide	✅	9ms
Request Payload.Flags Request Omits Authorization Header	✅	9ms
Request Payload.Token In Flags Body Matches Init	✅	10ms
Request Payload.Groups Round Trip	✅	9ms
Request Payload.Groups Default To Empty Object	✅	10ms
Request Payload.Disable Geoip False Propagates As Geoip Disable False	✅	9ms
Request Payload.Disable Geoip Omitted Defaults To False	✅	9ms
Request Payload.Flag Keys To Evaluate Contains Only Requested Key	✅	10ms
Request Lifecycle.No Flags Request On Init Alone	✅	4ms
Request Lifecycle.No Flags Request On Normal Capture	✅	509ms
Request Lifecycle.Two Flag Calls Produce Two Remote Requests	✅	15ms
Request Lifecycle.Mock Response Value Is Returned To Caller	✅	9ms
Retry Behavior.Retries Flags On 502	✅	313ms
Retry Behavior.Retries Flags On 504	✅	313ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event	✅	512ms

Feature_Flags_Local_Evaluation Tests

✅ 4/4 tests passed

View Details

Test	Status	Duration
Versioned Boolean Matching.Matching Version Missing	✅	71ms
Versioned Boolean Matching.Matching Version 1	✅	68ms
Versioned Boolean Matching.Matching Version 2	✅	69ms
Versioned Boolean Matching.Version Only Reload 1 2 1 2 Missing	✅	35ms

* Align ASGI and Flask integration defaults * feat(integrations): align request middleware configuration (cherry picked from commit 2f0d67d)

* feat(mcp): set $mcp_interface on mcp analytics events (#1032) feat(mcp): add interface property to server events Generated-By: PostHog Desktop Task-Id: 651bf7d9-01f4-4d75-8583-868e29fdd314 (cherry picked from commit a3bd254) * chore: Release v7.67.1 [skip ci] (cherry picked from commit 4ae3d26) * Update generated references (cherry picked from commit 492d71b) * feat(integrations): align request middleware configuration (#1040) * Align ASGI and Flask integration defaults * feat(integrations): align request middleware configuration (cherry picked from commit 2f0d67d) * chore: Release v7.68.0 [skip ci] (cherry picked from commit ad553de) * Update generated references (cherry picked from commit 90f8d69) * chore(deps): bump the uv group across 2 directories with 3 updates (#1042) Bumps the uv group with 1 update in the /examples/example-ai-llamaindex directory: [banks](https://github.com/masci/banks). Bumps the uv group with 2 updates in the /examples/example-ai-pydantic-ai directory: [pydantic-ai](https://github.com/pydantic/pydantic-ai) and [pydantic-ai-slim](https://github.com/pydantic/pydantic-ai). Updates `banks` from 2.4.5 to 2.5.1 - [Release notes](https://github.com/masci/banks/releases) - [Commits](masci/banks@v2.4.5...v2.5.1) Updates `pydantic-ai` from 1.102.0 to 1.107.7 - [Release notes](https://github.com/pydantic/pydantic-ai/releases) - [Changelog](https://github.com/pydantic/pydantic-ai/blob/main/docs/changelog.md) - [Commits](pydantic/pydantic-ai@v1.102.0...v1.107.7) Updates `pydantic-ai-slim` from 1.102.0 to 1.107.7 - [Release notes](https://github.com/pydantic/pydantic-ai/releases) - [Changelog](https://github.com/pydantic/pydantic-ai/blob/main/docs/changelog.md) - [Commits](pydantic/pydantic-ai@v1.102.0...v1.107.7) --- updated-dependencies: - dependency-name: banks dependency-version: 2.5.1 dependency-type: indirect dependency-group: uv - dependency-name: pydantic-ai dependency-version: 1.107.7 dependency-type: direct:production dependency-group: uv - dependency-name: pydantic-ai-slim dependency-version: 1.107.7 dependency-type: indirect dependency-group: uv ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> (cherry picked from commit ee686ff) * test(django): read the middleware context test's event after defaults fill On v1, context properties are filled inside _enqueue, before before_send. The test patched _enqueue itself, so it saw the event before the fill and lost $request_path and role. It now records the event in before_send. The assertions are unchanged. Co-Authored-By: Claude Opus 5.5 <[email protected]> * fix: redirect origin and logging fixes from review; scope AI routing docs - Compare redirect origins as requests sends them, so a Unicode host matches its IDNA form. - Log a refused or exhausted capture redirect at debug; failed-batch reporting owns warnings. - The migration guide says the OpenTelemetry integration still exports to /i/v0/ai/otel. Co-Authored-By: Claude Opus 5.5 <[email protected]> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Georgis Andonis <[email protected]> Co-authored-by: releaser-posthog-python[bot] <262414804+releaser-posthog-python[bot]@users.noreply.github.com> Co-authored-by: Hugues Pouillot <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 <[email protected]>

hpouillot added 2 commits October 8, 2026 17:03

Align ASGI and Flask integration defaults

24b1710

feat(integrations): align request middleware configuration

7953c08

hpouillot requested a review from a team as a code owner October 8, 2026 15:09

hpouillot self-assigned this Oct 8, 2026

hpouillot requested review from a team and ablaszkiewicz October 8, 2026 15:09

hpouillot marked this pull request as draft October 8, 2026 16:21

hpouillot marked this pull request as ready for review October 8, 2026 16:26

ablaszkiewicz approved these changes Oct 10, 2026

View reviewed changes

hpouillot merged commit 2f0d67d into main Oct 12, 2026
48 checks passed

hpouillot deleted the feat/consistent-middleware-api branch October 12, 2026 14:45

This was referenced Oct 12, 2026

chore: sync main into v1 (7.67.1–7.68.0) #1051

Merged

fix!: group_identify and alias never guess a distinct id #1053

Merged

dustinbyrne mentioned this pull request Oct 16, 2026

fix(integrations): align tracing-header capture across frameworks #1061

Merged

5 tasks done

eli-r-ph pushed a commit that referenced this pull request Oct 20, 2026

feat(integrations): align request middleware configuration (#1040)

a9cc978

* Align ASGI and Flask integration defaults * feat(integrations): align request middleware configuration (cherry picked from commit 2f0d67d)

Navigation Menu

Repository navigation

feat(integrations): align request middleware configuration - #1040

feat(integrations): align request middleware configuration#1040
hpouillot merged 2 commits into
mainfrom
feat/consistent-middleware-api

hpouillot commented Oct 8, 2026

Uh oh!

github-actions Bot commented Oct 8, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

hpouillot commented Oct 8, 2026

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

If releasing new changes

🤖 Agent context

Uh oh!

github-actions Bot commented Oct 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

posthog-python Compliance Report

✅ All Tests Passed!

Capture_V1 Tests

Capture_Ai Tests

Feature_Flags Tests

Feature_Flags_Local_Evaluation Tests

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Oct 8, 2026 •

edited

Loading