starlette: Remove maximum version constraint #3456

MattiasDC · 2025-04-29T20:05:16Z

Description

Remove maximum version constraint on starlette, by fixing unit tests. Fixed some warnings in unit tests.

Problem was that the environment was patched only during the setUp execution, and not during the tests themselves. By putting the patch decorator on the class itself, the environment variables are patched during the test class, as is done in another place in the same file.

This PR also includes some small changes to reduce the amount of warnings encountered in the unit tests.

Get rid of deprecated calls to the route and route_websocket decorators
As StarletteInstrumentor._uninstrument can clear all instrumented apps, use a discard i.s.o. remove in the deletor of _InstrumentedStarlette to prevent a KeyError being raised

Fixes #3317

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

All existing unit tests pass with the newest version of starlette (0.46.2)

Does This PR Require a Core Repo Change?

Yes. - Link to PR:
No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

Followed the style guidelines of this project
Changelogs have been updated
Unit tests have been added
Documentation has been updated

… unit tests. Fixed some warnings in unit tests.

linux-foundation-easycla · 2025-04-29T20:05:19Z

The committers listed above are authorized under a signed CLA.

✅ login: emdneto / name: Emídio Neto (d1e3239, 9b37f7e, c133155, b58f246, 28ec515, cf76f7c, 844f149, 5959e1e, fb1b65d, 8180df4)
✅ login: MattiasDC / name: Mattias De Charleroy (82d860b, 8135dc5, b473e8e, b6ac320, 4d4e2de, 695c345, 92ef8a0, 49e3120, 08df2be)

MattiasDC · 2025-04-29T20:11:42Z

@Kludex you mentioned you were interested in doing a review for #3317. If this is a bad time, would it be possible for you appoint someone else?

MattiasDC · 2025-04-29T20:28:18Z

@aabmass could you review as well and are you able to upgrade the requirements? I'm not comfortable enough to update the lockfiles.

instrumentation/opentelemetry-instrumentation-starlette/tests/test_starlette_instrumentation.py

...entelemetry-instrumentation-starlette/src/opentelemetry/instrumentation/starlette/package.py

instrumentation/opentelemetry-instrumentation-starlette/pyproject.toml

…trap/test-requirements. Use setUp/tearDown iso decorator on test class

Kludex · 2025-05-02T15:03:17Z

We should test the min version.

MattiasDC · 2025-05-02T15:11:30Z

We should test the min version.

Hi @Kludex thanks for joining,

Do you mean something else than this test:
'instrumentation-starlette-oldest 3.8 Ubuntu', which uses

opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-starlette/test-requirements.oldest.txt

Line 75 in e6869cd

starlette==0.13.8

Or am I missing something?

…ldest' tests.

MattiasDC · 2025-05-02T15:51:54Z

@Kludex those oldest tests were indeed failing. I've increased the minimal version to 0.37.2. This one is a year old and didn't cause any problems with me. Is this acceptable? Older versions were causing this issue for me Kludex/starlette#2770

This reverts commit 08df2be.

…time keyword

MattiasDC · 2025-05-04T15:19:59Z

PR is ready to be reviewed again @emdneto, if anything needs a change, feel free to put me to work again ;)

CHANGELOG.md

instrumentation/opentelemetry-instrumentation-starlette/test-requirements.oldest.txt

xrmx · 2025-05-05T14:24:07Z

@Kludex those oldest tests were indeed failing. I've increased the minimal version to 0.37.2. This one is a year old and didn't cause any problems with me. Is this acceptable? Older versions were causing this issue for me encode/starlette#2770

That maybe be fixed by using an older httpx in the requirements.

MattiasDC · 2025-05-06T17:55:09Z

@Kludex those oldest tests were indeed failing. I've increased the minimal version to 0.37.2. This one is a year old and didn't cause any problems with me. Is this acceptable? Older versions were causing this issue for me encode/starlette#2770

That maybe be fixed by using an older httpx in the requirements.

Conditional dependencies are not supported in requirements.in files. Do you propose to add a .in file for latest and one for oldest?

Signed-off-by: emdneto <[email protected]>

…-contrib into issue/3317

Signed-off-by: emdneto <[email protected]>

CHANGELOG.md

uv.lock

Signed-off-by: emdneto <[email protected]>

Co-authored-by: Riccardo Magliocchetti <[email protected]>

CHANGELOG.md

xrmx

With the changelog fixed

instrumentation/opentelemetry-instrumentation-starlette/tests/test_starlette_instrumentation.py

Kludex · 2025-05-23T12:27:30Z

I know this is not the right place, so please don't ask me to create an issue... But can't we somehow modify the starlette instrumentation to work with FastAPI and just have one instead of 2? It's a subclass anyway, and it seems it covers the same points.

Happy to talk or hack this at PyCon IT (cc @xrmx)

xrmx · 2025-05-23T14:09:37Z

I know this is not the right place, so please don't ask me to create an issue... But can't we somehow modify the starlette instrumentation to work with FastAPI and just have one instead of 2? It's a subclass anyway, and it seems it covers the same points.

Happy to talk or hack this at PyCon IT (cc @xrmx)

Sure, we can discuss it at PyCon IT.

…58b0 This PR updates the upstream OpenTelemetry Python dependency to its September 2025 release, upgrading from version 1.33.1/0.54b1 to 1.37.0/0.58b0. It also resolves several conflicts between the following OTel PRs and existing ADOT patches: starlette: Remove maximum version constraint open-telemetry/opentelemetry-python-contrib#3456 Make a BatchProcessor class which both BatchSpanRecordProcessor and BatchLogRecordProcessor can use open-telemetry/opentelemetry-python#4562 Make exporter timeout encompass retries/backoffs, add jitter to backoffs, cleanup code a bit open-telemetry/opentelemetry-python#4564 Update BatchSpanProcessor to use new BatchProcessor class open-telemetry/opentelemetry-python#4580 Fix issue where deadlock can occur over logging._lock open-telemetry/opentelemetry-python#4636 Tests Performed tox -e lint tox -e spellcheck tox -e 3.9-test-aws-opentelemetry-distro tox -e 3.10-test-aws-opentelemetry-distro tox -e 3.11-test-aws-opentelemetry-distro tox -e 3.12-test-aws-opentelemetry-distro tox -e 3.13-test-aws-opentelemetry-distro Smoke/contract tests: ./gradlew appsignals-tests:contract-tests:contractTests

…58b0 (#524) This PR updates the upstream OpenTelemetry Python dependency to its September 2025 release; Upgrading from version 1.33.1/0.54b1 to 1.37.0/0.58b0. It also resolves several conflicts between the following OTel PRs and existing ADOT patches: starlette: Remove maximum version constraint open-telemetry/opentelemetry-python-contrib#3456 Make a BatchProcessor class which both BatchSpanRecordProcessor and BatchLogRecordProcessor can use open-telemetry/opentelemetry-python#4562 Make exporter timeout encompass retries/backoffs, add jitter to backoffs, cleanup code a bit open-telemetry/opentelemetry-python#4564 Update BatchSpanProcessor to use new BatchProcessor class open-telemetry/opentelemetry-python#4580 Fix issue where deadlock can occur over logging._lock open-telemetry/opentelemetry-python#4636 Tests Performed tox -e lint tox -e spellcheck tox -e 3.9-test-aws-opentelemetry-distro tox -e 3.10-test-aws-opentelemetry-distro tox -e 3.11-test-aws-opentelemetry-distro tox -e 3.12-test-aws-opentelemetry-distro tox -e 3.13-test-aws-opentelemetry-distro Smoke/contract tests: ./gradlew appsignals-tests:contract-tests:contractTests By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

ISSUE-3317: Remove maximum version constraint on starlette, by fixing…

695c345

… unit tests. Fixed some warnings in unit tests.

Updae changelog

8135dc5

MattiasDC requested a review from a team as a code owner April 29, 2025 20:06

emdneto reviewed Apr 29, 2025

View reviewed changes

MattiasDC force-pushed the issue/3317 branch from 8abc437 to 6f3633a Compare May 2, 2025 14:45

Implement code review remarks: update starlette dependencies in boots…

b6ac320

…trap/test-requirements. Use setUp/tearDown iso decorator on test class

MattiasDC force-pushed the issue/3317 branch from 6f3633a to b6ac320 Compare May 2, 2025 14:46

Increase minimal version of starlette to 0.37.2 to have functional 'o…

4d4e2de

…ldest' tests.

MattiasDC force-pushed the issue/3317 branch from bf196d1 to 4d4e2de Compare May 2, 2025 15:47

Merge branch 'main' into issue/3317

b473e8e

add uv.lock

08df2be

MattiasDC changed the title ~~ISSUE-3317: Remove maximum version constraint on starlette, by fixing unit tests~~ ISSUE-3317: Remove maximum version constraint, increase minimum version on starlette by fixing unit tests May 2, 2025

MattiasDC added 2 commits May 4, 2025 16:58

Revert "add uv.lock"

92ef8a0

This reverts commit 08df2be.

Prevent massive changes of uv.lock due to newer uv which adds upload-…

82d860b

…time keyword

xrmx reviewed May 5, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

instrumentation/opentelemetry-instrumentation-starlette/test-requirements.oldest.txt Outdated Show resolved Hide resolved

instrumentation/opentelemetry-instrumentation-starlette/test-requirements.oldest.txt Outdated Show resolved Hide resolved

xrmx added this to @xrmx's Python PR digest May 5, 2025

xrmx moved this to Reviewed PR that needs fixing in @xrmx's Python PR digest May 5, 2025

Update test-requirements.in file of starlette instrumentation

49e3120

anuraaga mentioned this pull request May 22, 2025

opentelemetry-instrumentation-starlette: fix memory leak and double middleware #3529

Merged

7 tasks

emdneto added 2 commits May 22, 2025 10:45

fixes

28ec515

Signed-off-by: emdneto <[email protected]>

Merge branch 'main' into issue/3317

d1e3239

emdneto added 4 commits May 22, 2025 11:16

Merge branch 'main' of github.com:open-telemetry/opentelemetry-python…

844f149

…-contrib into issue/3317

fix tests

fb1b65d

Signed-off-by: emdneto <[email protected]>

increase delta

9b37f7e

Signed-off-by: emdneto <[email protected]>

using same delta as fastapi

c133155

Signed-off-by: emdneto <[email protected]>

emdneto changed the title ~~ISSUE-3317: Remove maximum version constraint, increase minimum version on starlette by fixing unit tests~~ starlette: Remove maximum version constraint May 22, 2025

xrmx reviewed May 22, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

xrmx reviewed May 22, 2025

View reviewed changes

uv.lock Show resolved Hide resolved

emdneto and others added 2 commits May 22, 2025 12:26

commit uv.lock back

cf76f7c

Signed-off-by: emdneto <[email protected]>

Update CHANGELOG.md

8180df4

Co-authored-by: Riccardo Magliocchetti <[email protected]>

xrmx reviewed May 23, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

xrmx approved these changes May 23, 2025

View reviewed changes

MattiasDC commented May 23, 2025

View reviewed changes

instrumentation/opentelemetry-instrumentation-starlette/tests/test_starlette_instrumentation.py Show resolved Hide resolved

emdneto added 2 commits May 23, 2025 09:18

Update CHANGELOG.md

b58f246

Merge branch 'main' into issue/3317

5959e1e

xrmx requested a review from emdneto May 23, 2025 12:20

emdneto approved these changes May 23, 2025

View reviewed changes

xrmx enabled auto-merge (squash) May 23, 2025 12:21

xrmx merged commit e2ba6d4 into open-telemetry:main May 23, 2025
720 checks passed

github-project-automation bot moved this from Reviewed PR that needs fixing to Done in @xrmx's Python PR digest May 23, 2025

lukeina2z mentioned this pull request Oct 29, 2025

Bump ADOT Python version to 0.13.0 and OTel dependencies to 1.37.0/0.58b0 aws-observability/aws-otel-python-instrumentation#524

Merged

starlette: Remove maximum version constraint #3456

starlette: Remove maximum version constraint #3456

Uh oh!

Conversation

MattiasDC commented Apr 29, 2025 • edited by xrmx Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How Has This Been Tested?

Does This PR Require a Core Repo Change?

Checklist:

Uh oh!

linux-foundation-easycla bot commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MattiasDC commented Apr 29, 2025

Uh oh!

MattiasDC commented Apr 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kludex commented May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MattiasDC commented May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MattiasDC commented May 2, 2025

Uh oh!

MattiasDC commented May 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xrmx commented May 5, 2025

Uh oh!

MattiasDC commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xrmx left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Kludex commented May 23, 2025

Uh oh!

xrmx commented May 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MattiasDC commented Apr 29, 2025 •

edited by xrmx

Loading

linux-foundation-easycla bot commented Apr 29, 2025 •

edited

Loading

Kludex commented May 2, 2025 •

edited

Loading

MattiasDC commented May 2, 2025 •

edited

Loading

MattiasDC commented May 6, 2025 •

edited

Loading