refactor: extract _send_windows_request to the named_pipe_helper.py
#32
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
Honglichenn
force-pushed
the
honglich/refactor_request
branch
4 times, most recently
from
c967552
to
c435098
Compare
Signed-off-by: Hongli Chen <[email protected]>
Honglichenn
force-pushed
the
honglich/refactor_request
branch
from
c435098
to
5364702
Compare
Honglichenn
commented
Dec 5, 2023
| @@ -82,6 +82,9 @@ def instance_thread(self) -> None: | |||
| f"Encountered an error while sending the error response: {traceback.format_exc()}." | |||
| ) | |||
| try: | |||
| # Flush the pipe to allow the client to read the pipe's contents before disconnecting. | |||
| # Then disconnect the pipe, and close the handle to this pipe instance. | |||
| win32file.FlushFileBuffers(self.pipe_handle) | |||
There was a problem hiding this comment.
This is not related to the code refactoring but just one line change so I put it here. This is required and I missed this before. Reference: https://learn.microsoft.com/en-us/windows/win32/ipc/multithreaded-pipe-server
| return f"{self.message} (Error code: {self.error_code})" | ||
|
|
||
|
|
||
| class NamedPipeHelper: |
There was a problem hiding this comment.
send_named_pipe_request and establish_named_pipe_connection are two new methods. The code is copied fro m the _send_windows_request, Other code exists in the old file. Due to renaming, all text have green background
roblutt
approved these changes
Dec 5, 2023
AWS-Samuel
approved these changes
Dec 6, 2023
Honglichenn
pushed a commit
that referenced
this pull request
Jan 17, 2024
Signed-off-by: Robert Luttrell <[email protected]>
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.
What was the problem/requirement? (What/Why)
Need to send request in the Adaptor Server client and the Background client. There are some common code could be reused.
What was the solution? (How)
named_pipe_helper.pyto the_named_pipefolder_send_windows_requestto thenamed_pipe_helperand rename it tosend_named_pipe_requestwin32file.FlushFileBuffers(self.pipe_handle)before closing the named pipe to ensure that all messages are read by the client.What is the impact of this change?
Just refactoring. Nothing is changed.
How was this change tested?
All tests are passed.
Was this change documented?
No
Is this a breaking change?
No
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.