fix(httpx): manually construct removed `URL.raw` property #4595

Yun-Kim · 2022-11-18T19:03:23Z

Description

As of httpx==0.23.1, the URL.raw property was removed, which broke our _url_to_str() helper that uses that property to construct the raw URL.

However, the removed property was simply a combination of already existing (and still existing) properties in the URL object, which we can use to manually consturct the raw URL. I've version gated it such that nothing's changed for previous versions of httpx, but moving forward we'll manually construct the raw URL.

Checklist

Add additional sections for feat and fix pull requests.
Library documentation and/or Datadog's documentation site is updated. Link to doc PR in description.

Motivation

Design

Testing strategy

Relevant issue(s)

Testing strategy

Reviewer Checklist

Title is accurate.
Description motivates each change.
No unnecessary changes were introduced in this PR.
Avoid breaking API changes unless absolutely necessary.
Tests provided or description of manual testing performed is included in the code or PR.
Release note has been added for fixes and features, or else changelog/no-changelog label added.
All relevant GitHub issues are correctly linked.
Backports are identified and tagged with Mergifyio.

brettlangdon

one thought, but other lgtm

ddtrace/contrib/httpx/patch.py

codecov-commenter · 2022-11-18T20:46:39Z

Codecov Report

Merging #4595 (8c55117) into 1.x (0ea7b6a) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##              1.x    #4595   +/-   ##
=======================================
  Coverage   77.95%   77.96%           
=======================================
  Files         759      759           
  Lines       60125    60131    +6     
=======================================
+ Hits        46872    46879    +7     
+ Misses      13253    13252    -1

Impacted Files	Coverage Δ
ddtrace/contrib/httpx/patch.py	`95.50% <100.00%> (+0.32%)`	⬆️
tests/utils.py	`90.58% <0.00%> (+0.23%)`	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

brettlangdon · 2022-11-21T13:23:03Z

@Mergifyio backport 1.6

brettlangdon · 2022-11-21T13:23:32Z

@Mergifyio refresh

mergify · 2022-11-21T13:23:37Z

backport 1.6

✅ Backports have been created

#4596 fix(httpx): manually construct removed URL.raw property (backport #4595) has been created for branch 1.6

mergify · 2022-11-21T13:23:40Z

refresh

✅ Pull request refreshed

## Description [As of `httpx==0.23.1`](encode/httpx#2241), the `URL.raw` property was removed, which broke our `_url_to_str()` helper that uses that property to construct the raw URL. However, the removed property was simply a combination of already existing (and still existing) properties in the `URL` object, which we can use to manually consturct the raw URL. I've version gated it such that nothing's changed for previous versions of `httpx`, but moving forward we'll manually construct the raw URL. ## Checklist - [x] Add additional sections for `feat` and `fix` pull requests. - [x] [Library documentation](https://github.com/DataDog/dd-trace-py/tree/1.x/docs) and/or [Datadog's documentation site](https://github.com/DataDog/documentation/) is updated. Link to doc PR in description. ## Motivation ## Design ## Testing strategy ## Relevant issue(s) ## Testing strategy ## Reviewer Checklist - [ ] Title is accurate. - [ ] Description motivates each change. - [ ] No unnecessary changes were introduced in this PR. - [ ] Avoid breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [ ] Tests provided or description of manual testing performed is included in the code or PR. - [ ] Release note has been added for fixes and features, or else `changelog/no-changelog` label added. - [ ] All relevant GitHub issues are correctly linked. - [ ] Backports are identified and tagged with Mergifyio. (cherry picked from commit 6a1948d)

brettlangdon · 2022-11-21T13:26:00Z

Fixes #4593

## Description #4595 should have included a release note, this is the note for that PR. ## Reviewer Checklist - [x] Title is accurate. - [x] Description motivates each change. - [x] No unnecessary changes were introduced in this PR. - [x] Avoid breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Tests provided or description of manual testing performed is included in the code or PR. - [x] Release note has been added for fixes and features, or else `changelog/no-changelog` label added. - [x] All relevant GitHub issues are correctly linked. - [x] Backports are identified and tagged with Mergifyio.

## Description #4595 should have included a release note, this is the note for that PR. ## Reviewer Checklist - [x] Title is accurate. - [x] Description motivates each change. - [x] No unnecessary changes were introduced in this PR. - [x] Avoid breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Tests provided or description of manual testing performed is included in the code or PR. - [x] Release note has been added for fixes and features, or else `changelog/no-changelog` label added. - [x] All relevant GitHub issues are correctly linked. - [x] Backports are identified and tagged with Mergifyio. (cherry picked from commit 7dd5f6a)

) ## Description [As of `httpx==0.23.1`](encode/httpx#2241), the `URL.raw` property was removed, which broke our `_url_to_str()` helper that uses that property to construct the raw URL. However, the removed property was simply a combination of already existing (and still existing) properties in the `URL` object, which we can use to manually consturct the raw URL. I've version gated it such that nothing's changed for previous versions of `httpx`, but moving forward we'll manually construct the raw URL. ## Checklist - [x] Add additional sections for `feat` and `fix` pull requests. - [x] [Library documentation](https://github.com/DataDog/dd-trace-py/tree/1.x/docs) and/or [Datadog's documentation site](https://github.com/DataDog/documentation/) is updated. Link to doc PR in description. ## Motivation ## Design ## Testing strategy ## Relevant issue(s) ## Testing strategy ## Reviewer Checklist - [ ] Title is accurate. - [ ] Description motivates each change. - [ ] No unnecessary changes were introduced in this PR. - [ ] Avoid breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [ ] Tests provided or description of manual testing performed is included in the code or PR. - [ ] Release note has been added for fixes and features, or else `changelog/no-changelog` label added. - [ ] All relevant GitHub issues are correctly linked. - [ ] Backports are identified and tagged with Mergifyio. (cherry picked from commit 6a1948d) Co-authored-by: Yun Kim <35776586+Yun-Kim@users.noreply.github.com>

## Description #4595 should have included a release note, this is the note for that PR. ## Reviewer Checklist - [x] Title is accurate. - [x] Description motivates each change. - [x] No unnecessary changes were introduced in this PR. - [x] Avoid breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Tests provided or description of manual testing performed is included in the code or PR. - [x] Release note has been added for fixes and features, or else `changelog/no-changelog` label added. - [x] All relevant GitHub issues are correctly linked. - [x] Backports are identified and tagged with Mergifyio. (cherry picked from commit 7dd5f6a) Co-authored-by: Brett Langdon <brett.langdon@datadoghq.com> Co-authored-by: Yun Kim <35776586+Yun-Kim@users.noreply.github.com>

## Description [As of `httpx==0.23.1`](encode/httpx#2241), the `URL.raw` property was removed, which broke our `_url_to_str()` helper that uses that property to construct the raw URL. However, the removed property was simply a combination of already existing (and still existing) properties in the `URL` object, which we can use to manually consturct the raw URL. I've version gated it such that nothing's changed for previous versions of `httpx`, but moving forward we'll manually construct the raw URL. ## Checklist - [x] Add additional sections for `feat` and `fix` pull requests. - [x] [Library documentation](https://github.com/DataDog/dd-trace-py/tree/1.x/docs) and/or [Datadog's documentation site](https://github.com/DataDog/documentation/) is updated. Link to doc PR in description. ## Motivation ## Design ## Testing strategy ## Relevant issue(s) ## Testing strategy ## Reviewer Checklist - [ ] Title is accurate. - [ ] Description motivates each change. - [ ] No unnecessary changes were introduced in this PR. - [ ] Avoid breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [ ] Tests provided or description of manual testing performed is included in the code or PR. - [ ] Release note has been added for fixes and features, or else `changelog/no-changelog` label added. - [ ] All relevant GitHub issues are correctly linked. - [ ] Backports are identified and tagged with Mergifyio.

## Description CI mitigation for issue addressed in this PR #4595 ## Reviewer Checklist - [ ] Title is accurate. - [ ] Description motivates each change. - [ ] No unnecessary changes were introduced in this PR. - [ ] Avoid breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [ ] Tests provided or description of manual testing performed is included in the code or PR. - [ ] Release note has been added and follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/contributing.html#Release-Note-Guidelines), or else `changelog/no-changelog` label added. - [ ] All relevant GitHub issues are correctly linked. - [ ] Backports are identified and tagged with Mergifyio. Co-authored-by: Yun Kim <35776586+Yun-Kim@users.noreply.github.com>

Fix broken URL property access after httpx upgrade

5759873

Yun-Kim added the changelog/no-changelog A changelog entry is not required for this PR. label Nov 18, 2022

Yun-Kim requested a review from a team as a code owner November 18, 2022 19:03

brettlangdon previously approved these changes Nov 18, 2022

View reviewed changes

ddtrace/contrib/httpx/patch.py Show resolved Hide resolved

Fix riot venvs to run 0.22 and latest (currently 0.23)

96b6d96

Yun-Kim dismissed brettlangdon’s stale review via 96b6d96 November 18, 2022 20:20

Kyle-Verhoog approved these changes Nov 18, 2022

View reviewed changes

Merge branch '1.x' into yunkim/fix-httpx

8c55117

Yun-Kim mentioned this pull request Nov 18, 2022

chore(ci): pin httpx tests to 0.22 #4592

Closed

10 tasks

brettlangdon approved these changes Nov 18, 2022

View reviewed changes

gnufede approved these changes Nov 21, 2022

View reviewed changes

mergify bot merged commit 6a1948d into DataDog:1.x Nov 21, 2022

mergify bot mentioned this pull request Nov 21, 2022

fix(httpx): manually construct removed URL.raw property (backport #4595) #4596

Merged

brettlangdon linked an issue Nov 21, 2022 that may be closed by this pull request

Incompatibility introduced in HTTPX 0.23.1 #4593

Closed

brettlangdon added a commit that referenced this pull request Nov 21, 2022

chore(docs): Add missing release note for #4595

a010078

brettlangdon mentioned this pull request Nov 21, 2022

chore(docs): add missing release note for #4595 #4597

Merged

8 tasks

Yun-Kim deleted the yunkim/fix-httpx branch November 21, 2022 15:27

mabdinur mentioned this pull request Dec 9, 2022

ci(httpx): pin tested version to v0.22.0 [backport 1.5] #4768

Closed

8 tasks

mabdinur mentioned this pull request Dec 9, 2022

ci(httpx): pin tested version to v0.22.0 [0.61 branch] #4769

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(httpx): manually construct removed `URL.raw` property #4595

fix(httpx): manually construct removed `URL.raw` property #4595

Yun-Kim commented Nov 18, 2022 •

edited

brettlangdon left a comment

codecov-commenter commented Nov 18, 2022 •

edited

brettlangdon commented Nov 21, 2022

brettlangdon commented Nov 21, 2022

mergify bot commented Nov 21, 2022 •

edited

mergify bot commented Nov 21, 2022

brettlangdon commented Nov 21, 2022

fix(httpx): manually construct removed URL.raw property #4595

fix(httpx): manually construct removed URL.raw property #4595

Conversation

Yun-Kim commented Nov 18, 2022 • edited

Description

Checklist

Motivation

Design

Testing strategy

Relevant issue(s)

Testing strategy

Reviewer Checklist

brettlangdon left a comment

Choose a reason for hiding this comment

codecov-commenter commented Nov 18, 2022 • edited

Codecov Report

brettlangdon commented Nov 21, 2022

brettlangdon commented Nov 21, 2022

mergify bot commented Nov 21, 2022 • edited

✅ Backports have been created

mergify bot commented Nov 21, 2022

✅ Pull request refreshed

brettlangdon commented Nov 21, 2022

fix(httpx): manually construct removed `URL.raw` property #4595

fix(httpx): manually construct removed `URL.raw` property #4595

Yun-Kim commented Nov 18, 2022 •

edited

codecov-commenter commented Nov 18, 2022 •

edited

mergify bot commented Nov 21, 2022 •

edited