Add support for posting comment in GitHubIntegration #349

Signed-off-by: tdruez <tdruez@nexb.com>

Author: tdruez

workflow/integrations/github.py

@@ -41,7 +41,7 @@ def sync(self, request):
         if external_issue:  # Update existing issue on GitHib
             self.update_issue(
                 repo_id=repo_id,
-                issue_number=external_issue.issue_id,
+                issue_id=external_issue.issue_id,
                 title=make_issue_title(request),
                 body=make_issue_body(request),
                 state="closed" if request.is_closed else "open",
@@ -61,6 +61,7 @@ def sync(self, request):
             )
 
     def create_issue(self, repo_id, title, body=None, labels=None):
+        """Create a new GitHub issue."""
         url = f"{self.api_url}/repos/{repo_id}/issues"
         data = {"title": title}
         if body:
@@ -76,8 +77,9 @@ def create_issue(self, repo_id, title, body=None, labels=None):
         )
         return response.json()
 
-    def update_issue(self, repo_id, issue_number, title=None, body=None, state=None):
-        url = f"{self.api_url}/repos/{repo_id}/issues/{issue_number}"
+    def update_issue(self, repo_id, issue_id, title=None, body=None, state=None):
+        """Update an existing GitHub issue."""
+        url = f"{self.api_url}/repos/{repo_id}/issues/{issue_id}"
         data = {}
         if title:
             data["title"] = title
@@ -94,6 +96,19 @@ def update_issue(self, repo_id, issue_number, title=None, body=None, state=None)
         )
         return response.json()
 
+    def post_comment(self, repo_id, issue_id, comment_body):
+        """Post a comment on an existing GitHub issue."""
+        url = f"{self.api_url}/repos/{repo_id}/issues/{issue_id}/comments"
+        data = {"body": comment_body}
+
+        response = requests.post(
+            url,
+            json=data,
+            headers=self.get_headers(),
+            timeout=self.default_timeout,
+        )
+        return response.json()
+
 
 def make_issue_title(request):
     return f"[DEJACODE] {request.title}"

workflow/models.py

@@ -425,8 +425,8 @@ def save(self, *args, **kwargs):
 
         # `previous_object_id` logic is only required on edition.
         previous_object_id = None
-        is_addition = self.pk
-        if is_addition:
+        is_change = self.pk
+        if is_change:
             previous_object_id = self.__class__.objects.get(pk=self.pk).object_id
 
         super().save(*args, **kwargs)
@@ -661,6 +661,13 @@ class Meta:
     def __str__(self):
         return f"{self.user.username}: {self.text[:50]}..."
 
+    def save(self, *args, **kwargs):
+        """Call the handle_integrations method on save, only for addition."""
+        is_addition = not self.pk
+        super().save(*args, **kwargs)
+        if is_addition:
+            self.handle_integrations()
+
     def has_delete_permission(self, user):
         """
         Only the Commenter or an administrator with the proper permissions
@@ -716,6 +723,18 @@ def serialize_hook(self, hook):
             "data": data,
         }
 
+    def handle_integrations(self):
+        external_issue = self.request.external_issue
+        if not external_issue:
+            return
+
+        if external_issue.platform == ExternalIssueLink.Platform.GITHUB:
+            GitHubIntegration(dataspace=self.dataspace).post_comment(
+                repo_id=external_issue.repo,
+                issue_id=external_issue.issue_id,
+                comment_body=self.text,
+            )
+
 
 class RequestTemplateQuerySet(DataspacedQuerySet):
     def actives(self):