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

Retry request once on server disconnect #1369

Closed
wants to merge 1 commit into from
Closed
Changes from all 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
46 changes: 45 additions & 1 deletion src/zeep/transports.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import logging
import os
from contextlib import contextmanager
from typing import Any, Callable, TypeVar
from urllib.parse import urlparse

import requests
Expand All @@ -19,6 +20,46 @@

__all__ = ["AsyncTransport", "Transport"]

WrapFuncType = TypeVar("WrapFuncType", bound=Callable[..., Any])


def retry_server_disconnect(func: WrapFuncType) -> WrapFuncType:
"""Retry once if the server disconnects the connection.

An HTTP/1.1 is allowed to disconnect the connection at any time.
We need to retry ONCE if this happens.

http://datatracker.ietf.org/doc/html/rfc2616#section-8.1.4

A client, server, or proxy MAY close the transport connection at any
time. For example, a client might have started to send a new request
at the same time that the server has decided to close the "idle"
connection. From the server's point of view, the connection is being
closed while it was idle, but from the client's point of view, a
request is in progress.

This means that clients, servers, and proxies MUST be able to recover
from asynchronous close events. Client software SHOULD reopen the
transport connection and retransmit the aborted sequence of requests
without user interaction so long as the request sequence is
idempotent (see section 9.1.2). Non-idempotent methods or sequences
MUST NOT be automatically retried, although user agents MAY offer a
human operator the choice of retrying the request(s). Confirmation by
user-agent software with semantic understanding of the application
MAY substitute for user confirmation. The automatic retry SHOULD NOT
be repeated if the second sequence of requests fails.
"""

def _retry_server_disconnect_wrapper(self, *args: Any, **kwargs: Any) -> Any:
if httpx is None:
return func(self, *args, **kwargs)
try:
return func(self, *args, **kwargs)
except httpx.RemoteProtocolError:
return func(self, *args, **kwargs)

return _retry_server_disconnect_wrapper


class Transport:
"""The transport object handles all communication to the SOAP server.
Expand All @@ -44,6 +85,7 @@ def __init__(self, cache=None, timeout=300, operation_timeout=None, session=None
get_version()
)

@retry_server_disconnect
def get(self, address, params, headers):
"""Proxy to requests.get()

Expand All @@ -57,6 +99,7 @@ def get(self, address, params, headers):
)
return response

@retry_server_disconnect
def post(self, address, message, headers):
"""Proxy to requests.posts()

Expand Down Expand Up @@ -114,7 +157,6 @@ def load(self, url):

scheme = urlparse(url).scheme
if scheme in ("http", "https", "file"):

if self.cache:
response = self.cache.get(url)
if response:
Expand Down Expand Up @@ -215,6 +257,7 @@ def _load_remote_data(self, url):
raise TransportError(status_code=response.status_code)
return result

@retry_server_disconnect
async def post(self, address, message, headers):
self.logger.debug("HTTP Post to %s:\n%s", address, message)
response = await self.client.post(
Expand All @@ -235,6 +278,7 @@ async def post_xml(self, address, envelope, headers):
response = await self.post(address, message, headers)
return self.new_response(response)

@retry_server_disconnect
async def get(self, address, params, headers):
response = await self.client.get(
address,
Expand Down