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

Allow no content responses from GitHub #937

Merged
merged 3 commits into from
Jan 10, 2023
Merged

Conversation

AetherUnbound
Copy link
Contributor

@AetherUnbound AetherUnbound commented Dec 29, 2022

Fixes

Fixes WordPress/openverse#1305 by @AetherUnbound

Description

This PR modifies the _make_request function to prevent an exception from being raised when GitHub returns an HTTP 204 No Content response. This is done on comment deletion responses: https://docs.github.com/en/rest/pulls/comments?apiVersion=2022-11-28#delete-a-review-comment-for-a-pull-request. I suspect this case hadn't happened yet since this was introduced in #642, which is why these only just started raising errors.

In addition to the change necessary to fix the underlying issue (9a1a992), I also changed the Variable.get calls at the top level in accordance with a discussion from WordPress/openverse#1317 and #904 (46ad685).

In order to test this I added the pook library, which @sarayourfriend added to the API in WordPress/openverse-api#1027 and seemed appropriate to use here! This will not require a deployment since it's only a testing dependency.

Testing Instructions

It's hard to test this since we need specific conditions from the API in order to actually raise the error. You can however check out the commit before the fix (1a4ad1c) and run just test - you should see exactly the error described in the issue. Running just test again on the tip of this branch should have all tests pass.

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 December 29, 2022 20:25
@openverse-bot openverse-bot added 💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents labels Dec 29, 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.

LGTM! The tests look good and do indeed fail with the error reported in #936 for me, when checked out before the fix. Thanks for the very convenient commits for testing purposes, and for the additional test cases as well! 😄

)

with dag:
PythonOperator(
task_id="pr_review_reminder_operator",
python_callable=pr_review_reminders.post_reminders,
op_kwargs={"github_pat": GITHUB_PAT, "dry_run": DRY_RUN},
op_kwargs={
"github_pat": "{{ var.value.get('GITHUB_API_KEY', 'not_set') }}",
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 Looks good!

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

LGTM!

@AetherUnbound AetherUnbound merged commit 63cd4e3 into main Jan 10, 2023
@AetherUnbound AetherUnbound deleted the fix/pr-review-reminders branch January 10, 2023 15:22
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: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PR review reminder check fails on certain PRs
4 participants