WordPress / openverse-api

The Openverse API allows programmatic access to search for CC-licensed and public domain digital media.
https://api.openverse.engineering/v1
MIT License
77 stars 51 forks source link

Handle `asyncio.TimeoutError` for link validation code #1051

Closed sarayourfriend closed 1 year ago

sarayourfriend commented 1 year ago

Fixes

Fixes https://sentry.io/share/issue/bc0a4a1acfba45b6a8daca58a8e39ef2/ (which originated from #1027)

Description

Handles the TimeoutError when it is raised as it is not part of ClientError.

We tested the timeout configuration in ipython manually to confirm that it works in actual network scenarios:

In [3]: import aiohttp

In [4]: timeout = aiohttp.ClientTimeout(total=2)

In [5]: async with aiohttp.ClientSession(timeout=timeout) as session:
   ...:     await session.get("https://httpbin.org/delay/3")
   ...: 
---------------------------------------------------------------------------
TimeoutError                              Traceback (most recent call last)
Cell In[5], line 2
      1 async with aiohttp.ClientSession(timeout=timeout) as session:
----> 2     await session.get("https://httpbin.org/delay/3")

File ~venv/lib/python3.10/site-packages/aiohttp/client.py:560, in ClientSession._request(self, method, str_or_url, params, data, json, cookies, headers, skip_auto_headers, auth, allow_redirects, max_redirects, compress, chunked, expect100, raise_for_status, read_until_eof, proxy, proxy_auth, timeout, verify_ssl, fingerprint, ssl_context, ssl, proxy_headers, trace_request_ctx, read_bufsize)
    558 resp = await req.send(conn)
    559 try:
--> 560     await resp.start(conn)
    561 except BaseException:
    562     resp.close()

File ~venv/lib/python3.10/site-packages/aiohttp/client_reqrep.py:894, in ClientResponse.start(self, connection)
    891 self._protocol = connection.protocol
    892 self._connection = connection
--> 894 with self._timer:
    895     while True:
    896         # read response
    897         try:

File ~venv/lib/python3.10/site-packages/aiohttp/helpers.py:720, in TimerContext.__exit__(self, exc_type, exc_val, exc_tb)
    717     self._tasks.pop()
    719 if exc_type is asyncio.CancelledError and self._cancelled:
--> 720     raise asyncio.TimeoutError from None
    721 return None

TimeoutError: 

Testing Instructions

Check out the new unit test and confirm that it makes sense. Also check out the ipython above and try it out yourself if you want to confirm that the timeout configuration actually works in real network situations.

Checklist

[best_practices]: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines

Developer Certificate of Origin

Developer Certificate of Origin ``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```
github-actions[bot] commented 1 year ago

API Developer Docs Preview: Ready

https://wordpress.github.io/openverse-api/_preview/1051

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.