[Hardik K (hardikkaurani)]

Description

This PR brings HeadersInspectionHandler into full alignment with the middleware patterns and error handling across Kiota HTTP:

1. Null Request Check:
   Validates if request is None: raise TypeError("request cannot be null") matching BodyInspectionHandler, preventing an unexpected AttributeError on invalid requests.
2. Span Lifecycle & Timing:
   Keeps the observability span open over the downstream super().send(request, transport) call and ensures span.end() is invoked within a try ... finally block (mirroring the fix in UrlReplaceHandler and BodyInspectionHandler), ensuring correct timing and preventing dropped spans on transport failures.
3. Per-Request Options Clearing:
   Clears captured request and response headers on each call on whichever option object is active (current_options), preventing headers from previous requests or retry attempts from accumulating when passing custom HeadersInspectionHandlerOption per request.
4. Preserve Multi-Valued Headers:
   Uses request.headers.get_list(header) and response.headers.get_list(header) when feeding into HeadersCollection.add, accurately preserving discrete multi-valued headers (e.g. multiple cookies or accepts) without comma concatenation.

Testing

Added comprehensive unit tests in packages/http/httpx/tests/middleware_tests/test_headers_inspection_handler.py:

• test_send_request_none_raises_type_error
• test_headers_inspection_handler_request_options_isolation_and_clearing
• test_headers_inspection_handler_multi_valued_headers
• test_span_ends_on_transport_failure

cc Vincent Biret (@baywet)

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[Hardik K (hardikkaurani)]

Hi Vincent Biret (@baywet), I've created this PR to resolve the span lifecycle, per-request option isolation, multi-valued header preservation, and null checks for HeadersInspectionHandler, complete with comprehensive regression unit tests. Ready for your review whenever convenient!

[Copilot]

🟡 Changes recommended

Request and response capture discard repeated Content-Encoding values after the first.

2 open issues

• Preserve repeated Content-Encoding values during header capture · New
• Assert span remains open during transport callback · New

_{Review effort: Balanced}

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[Hardik K (hardikkaurani)]

Hi Vincent Biret (@baywet),

The review comments have been addressed in the latest commit:

1. Preserve Repeated Single-Value Headers (\Content-Encoding):

   • In \HeadersInspectionHandler._capture_headers(), headers in \HeadersCollection.SINGLE_VALUE_HEADERS\ (such as \Content-Encoding, \Content-Type, \Content-Length) now pass the combined comma-separated string \source_headers[header]\ into \HeadersCollection.add(), preventing truncation of repeated values like \gzip, br.
   • Other multi-valued headers continue using \get_list()\ to preserve discrete header values.
   • Added unit tests covering multiple \Content-Encoding\ values on both requests and responses.

2. Assert Span Remains Open During Transport Execution:

   • Updated \ est_span_ends_on_transport_failure\ to assert \len(span_exporter.get_finished_spans()) == 0\ inside the transport callback prior to raising the error, detecting premature span termination.
   • Added \ est_span_remains_open_during_successful_transport\ to verify span lifecycle during normal transport execution.

All linters and test suites pass cleanly. Ready for review!

[Copilot]

🟢 Approval recommended

Static review found no unresolved issues, and the regression tests address prior feedback; tests were not executed.

No open issues 🎉

2 resolved since last review

• Preserve repeated Content-Encoding values during header capture
• Assert span remains open during transport callback

_{Review effort: Balanced}

[Vincent Biret (baywet)]

Thanks for the contribution!

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[Copilot]

🟢 Approval recommended

The focused changes address prior feedback and include regression coverage, with no unresolved blocking findings.

No open issues 🎉

_{Review effort: Balanced}

[Hardik K (hardikkaurani)]

Thanks for the review Vincent Biret (@baywet)

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud