Skip to content
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

Fix bug report request IDs being reset when using multiple KoreClients #4480

Merged
merged 18 commits into from
Jun 27, 2024
Merged
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions pyk/src/pyk/kore/rpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ def __exit__(self, *args: Any) -> None:
def close(self) -> None: ...

@abstractmethod
def command(self, bug_report_id: str, old_id: int, bug_report_request: str) -> list[str]: ...
def command(self, req_name: str, bug_report_request: str) -> list[str]: ...
tothtamas28 marked this conversation as resolved.
Show resolved Hide resolved

@abstractmethod
def description(self) -> str: ...
Expand Down Expand Up @@ -117,7 +117,7 @@ def close(self) -> None:
self._file.close()
self._sock.close()

def command(self, bug_report_id: str, old_id: int, bug_report_request: str) -> list[str]:
def command(self, req_name: str, bug_report_request: str) -> list[str]:
return [
'cat',
bug_report_request,
Expand All @@ -127,7 +127,7 @@ def command(self, bug_report_id: str, old_id: int, bug_report_request: str) -> l
self._host,
str(self._port),
'>',
f'rpc_{bug_report_id}/{old_id:03}_actual.json',
f'{req_name}_actual.json',
]

def request(self, req: str) -> str:
Expand All @@ -154,7 +154,7 @@ def __init__(self, host: str, port: int, *, timeout: int | None = None):
def close(self) -> None:
pass

def command(self, bug_report_id: str, old_id: int, bug_report_request: str) -> list[str]:
def command(self, req_name: str, bug_report_request: str) -> list[str]:
return [
'curl',
'-X',
Expand All @@ -165,7 +165,7 @@ def command(self, bug_report_id: str, old_id: int, bug_report_request: str) -> l
'@' + bug_report_request,
'http://' + self._host + ':' + str(self._port),
'>',
f'rpc_{bug_report_id}/{old_id:03}_actual.json',
f'{req_name}_actual.json',
]

def request(self, req: str) -> str:
Expand Down Expand Up @@ -259,7 +259,7 @@ class JsonRpcClient(ContextManager['JsonRpcClient']):
_transport: Transport
_req_id: int
_bug_report: BugReport | None
_bug_report_id: str
_bug_report_id: str | None

def __init__(
self,
Expand All @@ -279,7 +279,11 @@ def __init__(
raise AssertionError()
self._req_id = 1
self._bug_report = bug_report
self._bug_report_id = bug_report_id if bug_report_id is not None else str(id(self))
self._bug_report_id = bug_report_id

@property
def client_id(self) -> str:
return str(id(self))

def __enter__(self) -> JsonRpcClient:
return self
Expand All @@ -304,10 +308,12 @@ def request(self, method: str, **params: Any) -> dict[str, Any]:
server_addr = self._transport.description()
_LOGGER.info(f'Sending request to {server_addr}: {old_id} - {method}')
tothtamas28 marked this conversation as resolved.
Show resolved Hide resolved
req = json.dumps(payload)
base_name = self._bug_report_id if self._bug_report_id is not None else 'kore_rpc'
req_name = f'{base_name}/{self.client_id}/{old_id:03}'
if self._bug_report:
bug_report_request = f'rpc_{self._bug_report_id}/{old_id:03}_request.json'
bug_report_request = f'{req_name}_request.json'
self._bug_report.add_file_contents(req, Path(bug_report_request))
self._bug_report.add_command(self._transport.command(self._bug_report_id, old_id, bug_report_request))
self._bug_report.add_command(self._transport.command(req_name, bug_report_request))
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder, is it possible to pull all this logic into Transport (and its subclasses)? Then command and client_id can become private on Transport.


_LOGGER.debug(f'Sending request to {server_addr}: {req}')
resp = self._transport.request(req)
Expand All @@ -316,15 +322,15 @@ def request(self, method: str, **params: Any) -> dict[str, Any]:
_LOGGER.debug(f'Received response from {server_addr}: {resp}')

if self._bug_report:
bug_report_response = f'rpc_{self._bug_report_id}/{old_id:03}_response.json'
bug_report_response = f'{req_name}_response.json'
self._bug_report.add_file_contents(resp, Path(bug_report_response))
self._bug_report.add_command(
[
'diff',
'-b',
'-s',
f'rpc_{self._bug_report_id}/{old_id:03}_actual.json',
f'rpc_{self._bug_report_id}/{old_id:03}_response.json',
f'{req_name}_actual.json',
f'{req_name}_response.json',
]
)

Expand Down
Loading