Merge pull request #6 from psf/track_by_pull_number_not_ref

Track PendingSignatures by Pull Request number directly

Author: ewdurbin

cla/admin.py

@@ -82,6 +82,7 @@ class PendingSignatureAdmin(admin.ModelAdmin):
         "get_repository_display",
         "github_repository_id",
         "ref",
+        "pull_number",
         "email_address",
         "normalized_email",
         "created_at",

cla/migrations/0004_pendingsignature_pull_number.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2 on 2025-04-18 11:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cla", "0003_signature_signing_email_address"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="pendingsignature",
+            name="pull_number",
+            field=models.IntegerField(null=True),
+        ),
+    ]

cla/models.py

@@ -110,6 +110,7 @@ class PendingSignature(models.Model):
     agreement = models.ForeignKey(Agreement, on_delete=models.PROTECT)
     github_repository_id = models.IntegerField()
     ref = models.CharField(max_length=512)
+    pull_number = models.IntegerField(null=True)
     email_address = models.EmailField(max_length=512)
     objects = PendingSignatureManager()
 

cla/tasks.py

@@ -144,6 +144,7 @@ async def check_pull_request(
                     github_repository_id=target_repository_id,
                     email_address=author.email,
                     ref=pull_request_head_sha,
+                    defaults={"pull_number": pull_request_number},
                 )
                 needs_signing.add(author)
             elif signature.github_id is None or signature.github_node_id is None:

cla/tests/test_models.py

@@ -26,7 +26,7 @@ def test_pending_signature_python_and_pg_normailzed(self, email, normalized_emai
         pending_signature = PendingSignature.objects.create(
             agreement=agreement,
             github_repository_id=1,
-            ref="deadbeef",
+            pull_number=1,
             email_address=email,
         )
         assert (

clabot/views.py

@@ -144,37 +144,36 @@ async def sign(request):
                 normalized_email=normalize_email(email_address),
             ).all()
         ):
-            to_resolve[pending_signature.github_repository_id].add(pending_signature.ref)
+            to_resolve[pending_signature.github_repository_id].add(pending_signature.pull_number)
             found_to_resolve += 1
         logging.info(
             f"Found {found_to_resolve} pending signatures "
             f"across {len(to_resolve)} repositories "
-            "to resolve for {email_address}"
+            f"to resolve for {email_address}"
         )
 
-        for repository_id, refs in to_resolve.items():
+        for repository_id, pull_numbers in to_resolve.items():
+            logging.info(repository_id)
             repository = await Repository.objects.select_related("installation").aget(
                 repository_id=repository_id
             )
             installation = repository.installation
             async with AsyncGitHubAPI("clabot", installation=installation) as gh:
-                for ref in refs:
-                    async for pull in gh.getiter(
-                        f"/repos/{repository.full_name}/commits/{ref}/pulls"
-                    ):
-                        logging.info(f"Updating {repository.full_name} #{pull['number']}")
-                        await handle_pull_request(
-                            namedtuple("Event", "data")(
-                                {
-                                    "pull_request": pull,
-                                    "repository": {
-                                        "id": repository.repository_id,
-                                        "full_name": repository.full_name,
-                                    },
-                                }
-                            ),
-                            None,
-                        )
+                for pull_number in pull_numbers:
+                    pull = await gh.getitem(f"/repos/{repository.full_name}/pulls/{pull_number}")
+                    logging.info(f"Updating {repository.full_name} #{pull_number}")
+                    await handle_pull_request(
+                        namedtuple("Event", "data")(
+                            {
+                                "pull_request": pull,
+                                "repository": {
+                                    "id": repository.repository_id,
+                                    "full_name": repository.full_name,
+                                },
+                            }
+                        ),
+                        None,
+                    )
 
         logging.info("Cleaning up PendingSignature(s)")
         await PendingSignature.objects.filter(