-
Notifications
You must be signed in to change notification settings - Fork 3.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Upgrade to poem 3.x.x and poem-openapi 5.x.x #13929
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
geekflyer
approved these changes
Jul 10, 2024
Applying the do not merge label until poem-web/poem#829 is released. |
JoshLind
approved these changes
Jul 11, 2024
Okay the maintainer seems to be away, we'll just use a git dep for now. |
banool
force-pushed
the
banool/poem-3
branch
2 times, most recently
from
July 12, 2024 11:41
a450b92
to
94fb74f
Compare
I confirmed that a localnet and the spec explorer work still, let's send it. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
✅ Forge suite
|
✅ Forge suite
|
✅ Forge suite
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In this PR I upgrade us from poem 1.x.x and poem-openapi 2.x.x to poem 3.x.x and poem-openapi 5.x.x. Besides it being good in general to stay up to date, we want to upgrade specifically to get the latest opentelemetry features so we can benefit from distributed tracing throughout the API stack. There have been other instances where being pinned to a specific version caused us issues.
The new Poem traits had issues with
Box<UserTransaction>
in transaction, so I just unboxed it. I can't see why it needs to be in a Box and the original commit (3ecd8e9) doesn't explain it. Perhaps there used to be some recursive type that we had to break.Besides that, fortunately there wasn't much to change with our types or our custom derive macros.
By default this changes the spec slightly, primarily the inclusion of
charset=utf-8
in the content type. I recall this caused issues for code generators, and it'd require changes to our Accept logic, so I remove that again. It also seems to change some of the enum variants. I don't believe we make use of the OpenAPI spec anywhere anymore so it shouldn't affect us, but we should reach out to anyone who might be affected (perhaps an old Go SDK, if it's still in development).I will wait for poem-web/poem#829 to be released and then upgrade the poem deps again before releasing this PR.
Type of Change
Which Components or Systems Does This Change Impact?
How Has This Been Tested?
For now just CI, let's see how that goes first.
I run a localnet and connected the explorer to it and clicked around and everything seemed to work fine, no errors from the network tab. The spec explorer (at /v1/spec) works as before.
Key Areas to Review
Box<UserTransaction>
->UserTransaction
is valid.Checklist