Skip to content
This repository has been archived by the owner on Aug 4, 2023. It is now read-only.

Add ConnectionError to acceptable flaky exceptions for Freesound #413

Merged
merged 1 commit into from
Mar 18, 2022

Conversation

AetherUnbound
Copy link
Contributor

Fixes

Fixes WordPress/openverse#1634 by @stacimc

Description

Similar to #330, this PR adds ConnectionError to the list of potentially flaky exceptions from Freesound that should be retried. These exceptions occur when attempting to get the file size for the previews, and aren't strictly necessary data to have. We've found that retrying with a delay fixes most of these occurrences. In cases where it does not, we exclude the file size information and continue iterating through the API.

I did a bit of refactoring to make this easier for us to change if we needed to down the line. Previously there were 3 locations we had to update to add a new exception, now there's only 1!

Testing Instructions

just test! (I love that that's a full sentence too 😁)

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

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.

@AetherUnbound AetherUnbound requested a review from a team as a code owner March 16, 2022 02:09
@dhruvkb dhruvkb added 💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon labels Mar 16, 2022
Copy link
Contributor

@stacimc stacimc left a comment

Choose a reason for hiding this comment

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

Looks great, and I appreciate the refactor 💯

# These are fine
*freesound.FLAKY_EXCEPTIONS,
# This should raise immediately
pytest.param(ValueError, marks=pytest.mark.raises(exception=ValueError)),
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea! The raises mark isn't something that comes baked into pytest but fortunately there's a plugin for it that we use!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It used to be even easier/with less boilerplate but unfortunately that was deprecated 😭

Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

LGTM! So concise and well handled ✨

@AetherUnbound AetherUnbound merged commit e8400cd into main Mar 18, 2022
@AetherUnbound AetherUnbound deleted the bugfix/freesound-audio-size#389 branch March 18, 2022 00:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Freesound pull_data task fails when getting audio file size
4 participants