Skip to content

Conversation

4383
Copy link
Member

@4383 4383 commented Jul 3, 2024

This is the beginning of the implementation of the migration guide proposed here:

https://review.opendev.org/c/openstack/governance/+/902585

The goal is to centralize all the materials we have to help users to safely migrate off of Eventlet.
It document patterns and methodology.

It will be followed by other pull requests that will reflect the other points made into the proposal.

Copy link

codecov bot commented Jul 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56%. Comparing base (c4f4e69) to head (44186e9).

Additional details and impacted files
@@          Coverage Diff          @@
##           master   #971   +/-   ##
=====================================
  Coverage      56%    56%           
=====================================
  Files          89     89           
  Lines        9791   9791           
  Branches     1826   1826           
=====================================
+ Hits         5491   5499    +8     
+ Misses       3929   3919   -10     
- Partials      371    373    +2     
Flag Coverage Δ
ipv6 23% <ø> (ø)
py310asyncio 52% <ø> (ø)
py310epolls 53% <ø> (+<1%) ⬆️
py310poll 53% <ø> (+<1%) ⬆️
py310selects 53% <ø> (-1%) ⬇️
py311asyncio 52% <ø> (+<1%) ⬆️
py311epolls 53% <ø> (+<1%) ⬆️
py312asyncio 51% <ø> (+<1%) ⬆️
py312epolls 51% <ø> (-1%) ⬇️
py37asyncio 50% <ø> (ø)
py37epolls 51% <ø> (-1%) ⬇️
py38asyncio 51% <ø> (ø)
py38epolls 53% <ø> (+<1%) ⬆️
py38openssl 51% <ø> (+<1%) ⬆️
py38poll 53% <ø> (+<1%) ⬆️
py38selects 53% <ø> (+<1%) ⬆️
py39asyncio 51% <ø> (-1%) ⬇️
py39dnspython1 51% <ø> (-1%) ⬇️
py39epolls 53% <ø> (-1%) ⬇️
py39poll 53% <ø> (-1%) ⬇️
py39selects 52% <ø> (-1%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@4383 4383 force-pushed the migration-guide branch from 9e8105d to 0f40ffe Compare July 3, 2024 15:51
@4383 4383 requested a review from itamarst July 4, 2024 07:13
@4383 4383 force-pushed the migration-guide branch 6 times, most recently from 01bb9aa to dbe5809 Compare July 4, 2024 16:16
@4383
Copy link
Member Author

4383 commented Jul 5, 2024

related to #972

@4383 4383 changed the title Migration guide Describes Eventlet's Alternatives to and AsyncIO Patterns Into the Migration Guide Jul 5, 2024
Copy link
Contributor

@itamarst itamarst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much of this is fine, but the facade pattern document seems either incomplete or very misleading, it's unclear what it's proposing and it's unclear if people reading it will interpret it consistently.

I have a vague sense of what it's aiming at, maybe ("here's how to make a library that works with both asyncio and blocking threads"), but I could be wrong! And even if I'm right, it leaves out key points ("you'll have to drop eventlet completely" and "this is for libraries only").

@4383
Copy link
Member Author

4383 commented Jul 16, 2024

Thanks @itamarst for your previous review, I'll rework my copy

4383 added 3 commits July 17, 2024 15:57
This is the beginning of the implementation of the migration
guide proposed here:

https://review.opendev.org/c/openstack/governance/+/902585

The goal is to centralize all the materials we have to help
users to safely migrate off of Eventlet.
@4383 4383 force-pushed the migration-guide branch from dbe5809 to 86d3437 Compare July 17, 2024 14:04
@4383
Copy link
Member Author

4383 commented Jul 17, 2024

I decided to temporarely remove the facade pattern from this PR.
I prefer to split this proposal to a more digest subset of content.

I'll rework the pattern stuffs in a second time. I'll address your comment related to the pattern, but I also think that I'll more speak about it like a "going further with asyncio" once the migration is done, @itamarst what do you think about this semantic?

@4383
Copy link
Member Author

4383 commented Jul 17, 2024

I also amended our glossary with new definitions.
I think their places are legit in this document and I think they can be useful in the eventlet context.

@4383 4383 requested a review from itamarst July 17, 2024 14:20
@4383 4383 changed the title Describes Eventlet's Alternatives to and AsyncIO Patterns Into the Migration Guide Describes Eventlet's Alternatives Into the Migration Guide Jul 17, 2024
@itamarst
Copy link
Contributor

Explaining that the facade is useful after completely migrating off of Eventlet makes sense, yeah. "You're no longer using Eventlet at all, how do you have libraries that provide both async and non-async APIs"


For the second use case, we believe this is a fundamentally unsustainable approach and encourage the upstream frameworks to come up with different solutions.
For the second use case, we believe this is a fundamentally unsustainable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existence of awaitlet suggests we should direct people there, maybe?

@4383 4383 merged commit 8bac9b2 into eventlet:master Jul 19, 2024
28 checks passed
@4383 4383 mentioned this pull request Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants