feat: github integration (#315)

* feat: initiate integrations

* feat: initiate github integration create models for the same

* feat: github integration views

* fix: update workspace integration view to create bot users

* refactor: rename repository model

* refactor: update github repo sync endpoint to create repo and sync in one go

* refactor: update issue activities to post the updates to segway hook

* refactor: update endpoints to get project id and add actor as a member of project in repo sync

* fix: make is bot as a read only field

* fix: remove github repo imports

* fix: url mapping

* feat: repo views

* refactor: update webhook request endpoint

* refactor: rename repositories table to github_repositories

* fix: workpace integration actor

* feat: label for github integration

* refactor: issue activity on create issue

* refactor: repo create endpoint and add db constraints for repo sync and issues

* feat: create api token on workpsace integration and avatar_url for integrations

* refactor: add uuid primary key for Audit model

* refactor: remove id from auditfield to maintain integrity and make avatar blank if none supplied

* feat: track comments on an issue

* feat: comment syncing from plane to github

* fix: prevent activities created by bot to be sent to webhook

* feat: github app installation id retrieve

* feat: github app installation id saved into db

* feat: installation_id for the github integragation and unique provider and project base integration for repo

* refactor: remove actor logic from activity task

* feat: saving github metadata using installation id in workspace integration table

* feat: github repositories endpoint

* feat: github and project repos synchronisation

* feat: delete issue and delete comment activity

* refactor: remove print logs

* FIX: reading env names for github app while installation

* refactor: update bot user firstname with title

* fix: add is_bot value in field

---------

Co-authored-by: venplane <venkatesh@plane.so>

apiserver/plane/db/mixins.py

@@ -1,3 +1,7 @@
+# Python imports
+import uuid
+
+# Django imports
 from django.db import models
 
 

apiserver/plane/db/models/__init__.py

@@ -10,7 +10,13 @@ from .workspace import (
     TeamMember,
 )
 
-from .project import Project, ProjectMember, ProjectBaseModel, ProjectMemberInvite, ProjectIdentifier
+from .project import (
+    Project,
+    ProjectMember,
+    ProjectBaseModel,
+    ProjectMemberInvite,
+    ProjectIdentifier,
+)
 
 from .issue import (
     Issue,
@@ -38,6 +44,15 @@ from .shortcut import Shortcut
 
 from .view import View
 
-from .module import Module, ModuleMember, ModuleIssue, ModuleLink 
+from .module import Module, ModuleMember, ModuleIssue, ModuleLink
 
-from .api_token import APIToken
+from .api_token import APIToken
+
+from .integration import (
+    WorkspaceIntegration,
+    Integration,
+    GithubRepository,
+    GithubRepositorySync,
+    GithubIssueSync,
+    GithubCommentSync,
+)

apiserver/plane/db/models/integration/__init__.py

@@ -0,0 +1,2 @@
+from .base import Integration, WorkspaceIntegration
+from .github import GithubRepository, GithubRepositorySync, GithubIssueSync, GithubCommentSync

apiserver/plane/db/models/integration/base.py

@@ -0,0 +1,68 @@
+# Python imports
+import uuid
+
+# Django imports
+from django.db import models
+
+# Module imports
+from plane.db.models import BaseModel
+from plane.db.mixins import AuditModel
+
+
+class Integration(AuditModel):
+    id = models.UUIDField(
+        default=uuid.uuid4, unique=True, editable=False, db_index=True, primary_key=True
+    )
+    title = models.CharField(max_length=400)
+    provider = models.CharField(max_length=400, unique=True)
+    network = models.PositiveIntegerField(
+        default=1, choices=((1, "Private"), (2, "Public"))
+    )
+    description = models.JSONField(default=dict)
+    author = models.CharField(max_length=400, blank=True)
+    webhook_url = models.TextField(blank=True)
+    webhook_secret = models.TextField(blank=True)
+    redirect_url = models.TextField(blank=True)
+    metadata = models.JSONField(default=dict)
+    verified = models.BooleanField(default=False)
+    avatar_url = models.URLField(blank=True, null=True)
+
+    def __str__(self):
+        """Return provider of the integration"""
+        return f"{self.provider}"
+
+    class Meta:
+        verbose_name = "Integration"
+        verbose_name_plural = "Integrations"
+        db_table = "integrations"
+        ordering = ("-created_at",)
+
+
+class WorkspaceIntegration(BaseModel):
+    workspace = models.ForeignKey(
+        "db.Workspace", related_name="workspace_integrations", on_delete=models.CASCADE
+    )
+    # Bot user
+    actor = models.ForeignKey(
+        "db.User", related_name="integrations", on_delete=models.CASCADE
+    )
+    integration = models.ForeignKey(
+        "db.Integration", related_name="integrated_workspaces", on_delete=models.CASCADE
+    )
+    api_token = models.ForeignKey(
+        "db.APIToken", related_name="integrations", on_delete=models.CASCADE
+    )
+    metadata = models.JSONField(default=dict)
+
+    config = models.JSONField(default=dict)
+
+    def __str__(self):
+        """Return name of the integration and workspace"""
+        return f"{self.workspace.name} <{self.integration.provider}>"
+
+    class Meta:
+        unique_together = ["workspace", "integration"]
+        verbose_name = "Workspace Integration"
+        verbose_name_plural = "Workspace Integrations"
+        db_table = "workspace_integrations"
+        ordering = ("-created_at",)

apiserver/plane/db/models/integration/github.py

@@ -0,0 +1,99 @@
+# Python imports
+import uuid
+
+# Django imports
+from django.db import models
+
+# Module imports
+from plane.db.models import ProjectBaseModel
+from plane.db.mixins import AuditModel
+
+
+class GithubRepository(ProjectBaseModel):
+    name = models.CharField(max_length=500)
+    url = models.URLField(null=True)
+    config = models.JSONField(default=dict)
+    repository_id = models.BigIntegerField()
+    owner = models.CharField(max_length=500)
+
+    def __str__(self):
+        """Return the repo name"""
+        return f"{self.name}"
+
+    class Meta:
+        verbose_name = "Repository"
+        verbose_name_plural = "Repositories"
+        db_table = "github_repositories"
+        ordering = ("-created_at",)
+
+
+class GithubRepositorySync(ProjectBaseModel):
+    repository = models.OneToOneField(
+        "db.GithubRepository", on_delete=models.CASCADE, related_name="syncs"
+    )
+    credentials = models.JSONField(default=dict)
+    # Bot user
+    actor = models.ForeignKey(
+        "db.User", related_name="user_syncs", on_delete=models.CASCADE
+    )
+    workspace_integration = models.ForeignKey(
+        "db.WorkspaceIntegration", related_name="github_syncs", on_delete=models.CASCADE
+    )
+    label = models.ForeignKey(
+        "db.Label", on_delete=models.SET_NULL, null=True, related_name="repo_syncs"
+    )
+
+    def __str__(self):
+        """Return the repo sync"""
+        return f"{self.repository.name} <{self.project.name}>"
+
+    class Meta:
+        unique_together = ["project", "repository"]
+        verbose_name = "Github Repository Sync"
+        verbose_name_plural = "Github Repository Syncs"
+        db_table = "github_repository_syncs"
+        ordering = ("-created_at",)
+
+
+class GithubIssueSync(ProjectBaseModel):
+    repo_issue_id = models.BigIntegerField()
+    github_issue_id = models.BigIntegerField()
+    issue_url = models.URLField(blank=False)
+    issue = models.ForeignKey(
+        "db.Issue", related_name="github_syncs", on_delete=models.CASCADE
+    )
+    repository_sync = models.ForeignKey(
+        "db.GithubRepositorySync", related_name="issue_syncs", on_delete=models.CASCADE
+    )
+
+    def __str__(self):
+        """Return the github issue sync"""
+        return f"{self.repository.name}-{self.project.name}-{self.issue.name}"
+
+    class Meta:
+        unique_together = ["repository_sync", "issue"]
+        verbose_name = "Github Issue Sync"
+        verbose_name_plural = "Github Issue Syncs"
+        db_table = "github_issue_syncs"
+        ordering = ("-created_at",)
+
+
+class GithubCommentSync(ProjectBaseModel):
+    repo_comment_id = models.BigIntegerField()
+    comment = models.ForeignKey(
+        "db.IssueComment", related_name="comment_syncs", on_delete=models.CASCADE
+    )
+    issue_sync = models.ForeignKey(
+        "db.GithubIssueSync", related_name="comment_syncs", on_delete=models.CASCADE
+    )
+
+    def __str__(self):
+        """Return the github issue sync"""
+        return f"{self.comment.id}"
+
+    class Meta:
+        unique_together = ["issue_sync", "comment"]
+        verbose_name = "Github Comment Sync"
+        verbose_name_plural = "Github Comment Syncs"
+        db_table = "github_comment_syncs"
+        ordering = ("-created_at",)

apiserver/plane/db/models/issue.py

@@ -187,7 +187,7 @@ class IssueLink(ProjectBaseModel):
 
 class IssueActivity(ProjectBaseModel):
     issue = models.ForeignKey(
-        Issue, on_delete=models.CASCADE, related_name="issue_activity"
+        Issue, on_delete=models.SET_NULL, null=True, related_name="issue_activity"
     )
     verb = models.CharField(max_length=255, verbose_name="Action", default="created")
     field = models.CharField(