thrift icon indicating copy to clipboard operation
thrift copied to clipboard

THRIFT-5777: python fix mismatched timeout exceptions.

Open bwangelme opened this issue 10 months ago • 0 comments

What error occurred?

When the Python client times out while reading content from the server, the exception thrown is not "read timeout," but rather "unexpected exception."

Why did this error occur?

the socket.timeout error doesn't includes the errno parameter in its args attribute.

I try to make a timeout error on my pc, it only contains the error string.

Python 3.11.1 (main, Jan  5 2023, 14:25:08) [GCC 11.3.0]
Type 'copyright', 'credits' or 'license' for more information
IPython 8.13.2 -- An enhanced Interactive Python. Type '?' for help.

In [1]: import socket
   ...: from urllib.request import urlopen
   ...:
   ...: url = 'http://httpbin.org/get'
   ...:
   ...: socket.setdefaulttimeout(0.01)
   ...: try:
   ...:     urlopen(url)
   ...: except Exception as e:
   ...:     err1 = e.reason
   ...:
   ...:

In [2]: type(err1)
Out[2]: TimeoutError

In [3]: err1.args
Out[3]: ('timed out',)

And my system is ubuntu 22.04

ø> uname -a
Linux Macmini 6.2.0-36-generic #37~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Mon Oct  9 15:34:04 UTC 2 x86_64 x86_64 x86_64 GNU/Linux

TSocket.read handle exception error

Because socket.error.args == ('timed out',), the condition elif e.args[0] == errno.ETIMEDOUT cannot be True, resulting in the throwing of the wrong exception TTransportException(message="unexpected exception", inner=e).

How to fix it

I determine whether a timeout has occurred by checking if the exception is a socket.timeout, no longer relying on e.args.

  • [x] Did you create an Apache Jira ticket? (Request account here, not required for trivial changes)
    • https://issues.apache.org/jira/browse/THRIFT-5777
  • [x] If a ticket exists: Does your pull request title follow the pattern "THRIFT-NNNN: describe my issue"?
  • [X] Did you squash your changes to a single commit? (not required, but preferred)
  • [X] Did you do your best to avoid breaking changes? If one was needed, did you label the Jira ticket with "Breaking-Change"?
  • [X] If your change does not involve any code, include [skip ci] anywhere in the commit message to free up build resources.

bwangelme avatar Apr 15 '24 05:04 bwangelme