Add async interface for finalization to acme.client.ClientV2 #9622
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
Add `begin_order_finalization()`/`poll_finalization()` to `acme.client.ClientV2`, which are directly analogous to `answer_challenge()`/`poll_authorizations()`. This allows us to finalize an order and then later poll for its completion as separate steps.
|
@alexzorin , this is ready for review at your convenience. |
alexzorin
requested changes
Mar 22, 2023
certbot/CHANGELOG.md
Outdated
Comment on lines
11
to
13
| * `acme.client.ClientV2` now provides an asynchronous interface for | ||
| order finalization (`begin_order_finalization()` and | ||
| `poll_finalization()`) |
There was a problem hiding this comment.
There is a small potential ambiguity here with Python's async, and it would be good to mention that these relate to finalize_order. Maybe something like:
acme.client.ClientV2now provides separatebegin_order_finalizationandpoll_finalizationmethods, in addition to the existingfinalize_ordermethod.
acme/acme/client.py
Outdated
| def finalize_order(self, orderr: messages.OrderResource, deadline: datetime.datetime, | ||
| fetch_alternative_chains: bool = False) -> messages.OrderResource: | ||
| """Finalize an order and obtain a certificate. | ||
| def begin_order_finalization(self, orderr: messages.OrderResource |
There was a problem hiding this comment.
It would be good to align this name either with poll_finalization or finalize_order. Perhaps submit_finalization or begin_finalization.
Rename `begin_order_finalization` -> `begin_finalization` and tweak wording of changelog entry
|
OK, renamed the method and adopted your proposed wording for the changelog entry. Anything else? |
alexzorin
approved these changes
Mar 23, 2023
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.
Add
begin_order_finalization()/poll_finalization()toacme.client.ClientV2, which are directly analogous toanswer_challenge()/poll_authorizations(). This allows us to finalize an order and then later poll for its completion as separate steps. Also rewritefinalize_order()to call these two methods (which are just the previous body offinalize_order()split in two.)I've not added new test cases because the existing test cases for
finalize_order()exercise all of the same code paths, but I can if we want to belt-and-suspenders this.Fixes #9620
Pull Request Checklist
mastersection ofcertbot/CHANGELOG.mdto include a description of the change being made.AUTHORS.mdif you like.