Allow websocket retries with backoff time in between #341
Conversation
lgarc15
changed the title
|
|
||
| # Errors unrelated to websocket connection, not worth retrying. | ||
| except (WebsocketIBMQProtocolError, WebsocketTimeoutError) as ex: | ||
| raise ex |
There was a problem hiding this comment.
You don't need to except the errors if you're just going to raise it? Or are you trying to document the possible exceptions?
There was a problem hiding this comment.
I agree! I think it would be much cleaner to simply remove them, since they are going to be raised regardless.
lgarc15
changed the title
…iskit-ibmq-provider into retry-websocket-backoff
lgarc15
changed the title
| @@ -101,6 +104,8 @@ def _connect(self, url: str) -> Generator[Any, None, Connect]: | |||
| was established, but the authentication failed. | |||
| WebsocketIBMQProtocolError: if the connection to the websocket | |||
| server was established, but the answer was unexpected. | |||
| SSLError: if the connection to the websocket server could not | |||
| be established due to SSL certificate errors. | |||
There was a problem hiding this comment.
nit - an SSLError might not be related to certificates; it could be other SSL errors. Also I don't know if you really need to document the SSLError, since exceptions thrown by the underlying services are generally not documented. For example, websocket.send() on line 131 can throw exceptions that are not caught nor documented.
|
|
||
| def __init__(self, websocket_url: str, access_token: str) -> None: | ||
| self.websocket_url = websocket_url.rstrip('/') | ||
| self.access_token = access_token | ||
|
|
||
| @asyncio.coroutine | ||
| def _connect(self, url: str) -> Generator[Any, None, Connect]: | ||
| def _connect(self, url: str) -> Generator[Any, None, WebSocketClientProtocol]: |
There was a problem hiding this comment.
Can you also update the docstring for the return type (from Connect to WebSocketClientProtocol)?
Summary
Fixes #331
Details and comments
The
WebsocketClientclass methodget_job_statuscurrently allows retrying once in the case of a connection closing. This PR allows the method to retry up to five times, with time in between.