Fixes: #10 Change logic for add/remove awaiting reviews label

Author: dhruvmanila

algorithms_keeper/pull_requests.py

@@ -261,6 +261,15 @@ async def update_pr_label_for_review(
                     label=Label.CHANGES_REQUESTED,
                     pr_or_issue=pull_request,
                 )
+            # If a pull request is directly approved without asking for any changes,
+            # remove the `awaiting reviews` label as well if present. (Issue #10)
+            elif Label.AWAITING_REVIEW in pr_labels:
+                await utils.remove_label_from_pr_or_issue(
+                    gh,
+                    installation_id,
+                    label=Label.AWAITING_REVIEW,
+                    pr_or_issue=pull_request,
+                )
 
 
 @router.register("pull_request", action="labeled")
@@ -297,9 +306,9 @@ async def pr_awaiting_review_label(
                     label=Label.AWAITING_REVIEW,
                 )
     else:
-        # This label is removed only when a PR is approved, so we don't want to add the
-        # `awaiting_review` label.
-        if label == Label.CHANGES_REQUESTED:
+        # These labels are removed only when a PR is approved, so we don't want to add
+        # the `awaiting_review` label back again. (Issue #10)
+        if label == Label.CHANGES_REQUESTED or label == Label.AWAITING_REVIEW:
             return None
         # Add label only if none of the PR_NOT_READY_LABELS are present in `pr_labels`.
         if all(label not in pr_labels for label in PR_NOT_READY_LABELS):

tests/test_pull_requests.py

@@ -983,6 +983,37 @@ async def test_pr_review_approved(labels):
     assert gh.post_data == []
 
 
+@pytest.mark.asyncio
+@pytest.mark.parametrize("labels", ([], [{"name": Label.AWAITING_REVIEW}]))
+async def test_pr_review_approved_without_any_changes(labels):
+    # Issue #10
+    remove_label = urllib.parse.quote(Label.AWAITING_REVIEW)
+    data = {
+        "action": "submitted",
+        "review": {
+            "state": "approved",
+            "author_association": "member",
+        },
+        "pull_request": {
+            "labels": labels,
+            "issue_url": issue_url,
+        },
+        "installation": {"id": MOCK_INSTALLATION_ID},
+    }
+    event = sansio.Event(data, event="pull_request_review", delivery_id="1")
+    delete = {f"{labels_url}/{remove_label}": {}}
+    gh = MockGitHubAPI(delete=delete)
+    await pull_requests.router.dispatch(event, gh)
+    if labels:
+        assert f"{labels_url}/{remove_label}" in gh.delete_url
+        assert gh.delete_data == [{}]
+    else:
+        assert gh.delete_url == []
+        assert gh.delete_data == []
+    assert gh.post_url == []
+    assert gh.post_data == []
+
+
 # Test conditions for when to add and remove `Label.AWAITING_REVIEW` label:
 # NOTE: All conditions assumes the PR has been already been labeled AWAITING_REVIEW when
 #       it was opened.
@@ -1126,3 +1157,25 @@ async def test_changes_requested_label_removed():
     assert gh.post_data == []
     assert gh.delete_url == []
     assert gh.delete_data == []
+
+
+@pytest.mark.asyncio
+async def test_awaiting_review_label_removed():
+    # Issue #10
+    data = {
+        "action": "unlabeled",
+        "pull_request": {
+            "labels": [],
+            "issue_url": issue_url,
+        },
+        "label": {"name": Label.AWAITING_REVIEW},
+        "installation": {"id": MOCK_INSTALLATION_ID},
+    }
+    event = sansio.Event(data, event="pull_request", delivery_id="1")
+    gh = MockGitHubAPI()
+    await pull_requests.router.dispatch(event, gh)
+    # No label is added or removed.
+    assert gh.post_url == []
+    assert gh.post_data == []
+    assert gh.delete_url == []
+    assert gh.delete_data == []