feat: extend ConnitNotification (#225)

* feat: extend ConnitNotification

These changes extend the `CommitNotification` model to include an optional
field: the github app that emitted a check / comment.

ticket: codecov/engineering-team#1737

* improve README with instructions on how to run migrations

* chore: include instance ID in GithubInstallationInfo

Up to this point we didn't pass the GithubAppInstallation ID to
the Torngit adapter. This was in part because the info was not needed,
and in part because `Owner.integration_id` doesn't have an ID.

It would be useful to have this info now, though. As it will allow
us to pin down an app to a specific app installation more easily.

README.md

@@ -47,6 +47,25 @@ In order to run tests from within your docker container, run:
 make test
 ```
 
+## Running migrations
+
+If you make changes to the models in `shared/django_apps/` you will need to create migrations to reflect those changes in the database.
+
+Make sure the shared container is running and shell into it
+```bash
+$ docker compose up
+$ docker compose exec -it shared /bin/bash
+```
+
+Now you can create a migration (from within the container)
+
+```bash
+$ cd shared/django_apps/
+$ python manage.py makemigrations
+```
+
+To learn more about migrations visit [Django Docs](https://docs.djangoproject.com/en/5.0/topics/migrations/)
+
 ## Managing shared dependencies
 
 As a normal python package, `shared` can include dependencies of its own.

shared/django_apps/core/migrations/0050_commitnotification_gh_app_and_more.py

@@ -0,0 +1,57 @@
+# Generated by Django 4.2.13 on 2024-05-21 19:33
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("codecov_auth", "0055_session_login_session"),
+        ("core", "0049_increment_version"),
+    ]
+
+    # BEGIN;
+    # --
+    # -- Add field gh_app to commitnotification
+    # --
+    # ALTER TABLE "commit_notifications" ADD COLUMN "gh_app_id" bigint NULL CONSTRAINT "commit_notifications_gh_app_id_8714fedd_fk_codecov_a" REFERENCES "codecov_auth_githubappinstallation"("id") DEFERRABLE INITIALLY DEFERRED; SET CONSTRAINTS "commit_notifications_gh_app_id_8714fedd_fk_codecov_a" IMMEDIATE;
+    # --
+    # -- Alter field notification_type on commitnotification
+    # --
+    # -- (no-op)
+    # CREATE INDEX "commit_notifications_gh_app_id_8714fedd" ON "commit_notifications" ("gh_app_id");
+    # COMMIT;
+
+    operations = [
+        migrations.AddField(
+            model_name="commitnotification",
+            name="gh_app",
+            field=models.ForeignKey(
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="commit_notifications",
+                to="codecov_auth.githubappinstallation",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="commitnotification",
+            name="notification_type",
+            field=models.TextField(
+                choices=[
+                    ("comment", "Comment"),
+                    ("gitter", "Gitter"),
+                    ("hipchat", "Hipchat"),
+                    ("irc", "Irc"),
+                    ("slack", "Slack"),
+                    ("status_changes", "Status Changes"),
+                    ("status_patch", "Status Patch"),
+                    ("status_project", "Status Project"),
+                    ("webhook", "Webhook"),
+                    ("codecov_slack_app", "Codecov Slack App"),
+                    ("checks_project", "Checks Project"),
+                    ("checks_changes", "Checks Changes"),
+                    ("checks_patch", "Checks Patch"),
+                ]
+            ),
+        ),
+    ]

shared/django_apps/core/models.py

@@ -451,6 +451,9 @@ class NotificationTypes(models.TextChoices):
         STATUS_PROJECT = "status_project"
         WEBHOOK = "webhook"
         CODECOV_SLACK_APP = "codecov_slack_app"
+        CHECKS_PROJECT = "checks_project"
+        CHECKS_CHANGES = "checks_changes"
+        CHECKS_PATCH = "checks_patch"
 
     class DecorationTypes(models.TextChoices):
         STANDARD = "standard"
@@ -469,6 +472,12 @@ class States(models.TextChoices):
     commit = models.ForeignKey(
         "core.Commit", on_delete=models.CASCADE, related_name="notifications"
     )
+    gh_app = models.ForeignKey(
+        "codecov_auth.GithubAppInstallation",
+        on_delete=models.CASCADE,
+        related_name="commit_notifications",
+        null=True,
+    )
     notification_type = models.TextField(
         choices=NotificationTypes.choices
     )  # Really an ENUM in db

shared/typings/torngit.py

@@ -18,6 +18,7 @@ class RepoInfo(TypedDict):
 class GithubInstallationInfo(TypedDict):
     """Required info to get a token from Github for a given installation"""
 
+    id: int
     installation_id: int
     # The default app (configured via yaml) doesn't need this info.
     # All other apps need app_id and pem_path