Add base_url field on the ExternalIssueLink model #350

tdruez · tdruez · commit cf6f480db92f · 2025-08-07T18:23:43.000+04:00
Signed-off-by: tdruez &lt;tdruez@nexb.com&gt;
diff --git a/docs/index.rst b/docs/index.rst
@@ -48,10 +48,10 @@ Welcome to the very start of your DejaCode journey!
     :maxdepth: 1
     :caption: Integrations
 
+    integrations-forgejo
     integrations-github
     integrations-gitlab
     integrations-jira
-    integrations-forgejo
 
 .. toctree::
    :maxdepth: 1
diff --git a/workflow/admin.py b/workflow/admin.py
@@ -65,6 +65,7 @@ def clean_issue_tracker_id(self):
             raise ValidationError(
                 [
                     "Invalid issue tracker URL format. Supported formats include:",
+                    "• Forgejo: https://forgejo.DOMAIN.org/OR/REPO_NAME",
                     "• GitHub: https://github.com/ORG/REPO_NAME",
                     "• GitLab: https://gitlab.com/GROUP/PROJECT_NAME",
                     "• Jira: https://YOUR_DOMAIN.atlassian.net/projects/PROJECTKEY",
diff --git a/workflow/integrations/base.py b/workflow/integrations/base.py
@@ -92,6 +92,9 @@ def patch(self, url, json=None):
         """Send a PATCH request."""
         return self.request("PATCH", url, json=json)
 
+    def post_comment(self, repo_id, issue_id, comment_body, base_url=None):
+        raise NotImplementedError
+
     @staticmethod
     def make_issue_title(request):
         return f"[DEJACODE] {request.title}"
diff --git a/workflow/integrations/forgejo.py b/workflow/integrations/forgejo.py
@@ -10,7 +10,7 @@
 
 from workflow.integrations.base import BaseIntegration
 
-FORGEJO_API_URL = ""
+FORGEJO_API_PATH = "/api/v1"
 
 
 class ForgejoIntegration(BaseIntegration):
@@ -19,40 +19,46 @@ class ForgejoIntegration(BaseIntegration):
     from DejaCode requests.
     """
 
-    api_url = FORGEJO_API_URL
+    open_status = "open"
+    closed_status = "closed"
 
     def get_headers(self):
-        forgejo_token = self.dataspace.get_configuration(field_name="forgejo_token")
+        forgejo_token = self.dataspace.get_configuration("forgejo_token")
         if not forgejo_token:
             raise ValueError("The forgejo_token is not set on the Dataspace.")
         return {"Authorization": f"token {forgejo_token}"}
 
     def sync(self, request):
         """Sync the given request with Forgejo by creating or updating an issue."""
         try:
-            repo_id = self.extract_forgejo_repo_path(request.request_template.issue_tracker_id)
+            base_url, repo_path = self.extract_forgejo_info(
+                request.request_template.issue_tracker_id
+            )
         except ValueError as error:
-            raise ValueError(f"Invalid Forgejo repository URL: {error}")
+            raise ValueError(f"Invalid Forgejo tracker URL: {error}")
+
+        self.api_url = base_url.rstrip("/") + FORGEJO_API_PATH
 
         external_issue = request.external_issue
         if external_issue:
             self.update_issue(
-                repo_id=repo_id,
+                repo_id=repo_path,
                 issue_id=external_issue.issue_id,
                 title=self.make_issue_title(request),
                 body=self.make_issue_body(request),
-                state="closed" if request.is_closed else "open",
+                state=self.closed_status if request.is_closed else self.open_status,
             )
         else:
             issue = self.create_issue(
-                repo_id=repo_id,
+                repo_id=repo_path,
                 title=self.make_issue_title(request),
                 body=self.make_issue_body(request),
             )
             request.link_external_issue(
                 platform="forgejo",
-                repo=repo_id,
+                repo=repo_path,
                 issue_id=issue["number"],
+                base_url=base_url,
             )
 
     def create_issue(self, repo_id, title, body=""):
@@ -78,22 +84,28 @@ def update_issue(self, repo_id, issue_id, title=None, body=None, state=None):
 
         return self.patch(url, json=data)
 
-    def post_comment(self, repo_id, issue_id, comment_body):
+    def post_comment(self, repo_id, issue_id, comment_body, base_url=None):
         """Post a comment on an existing Forgejo issue."""
-        url = f"{self.api_url}/repos/{repo_id}/issues/{issue_id}/comments"
-        data = {"body": comment_body}
-
-        return self.post(url, json=data)
+        url = f"{base_url}/{FORGEJO_API_PATH}/repos/{repo_id}/issues/{issue_id}/comments"
+        return self.post(url, json={"body": comment_body})
 
     @staticmethod
-    def extract_forgejo_repo_path(url):
-        """Extract 'owner/repo-name' from a Forgejo URL."""
+    def extract_forgejo_info(url):
+        """
+        Extract the Forgejo base domain and repo path (org/repo) from a repo URL.
+
+        Example:
+        - https://forgejo.example.org/org/repo → ("https://forgejo.example.org", "org/repo")
+
+        """
         parsed = urlparse(url)
         if not parsed.netloc:
-            raise ValueError("URL must include a hostname.")
+            raise ValueError("Missing hostname in Forgejo URL.")
 
-        path_parts = [part for part in parsed.path.split("/") if part]
+        base_url = f"{parsed.scheme}://{parsed.netloc}"
+        path_parts = [p for p in parsed.path.split("/") if p]
         if len(path_parts) < 2:
             raise ValueError("Incomplete Forgejo repository path.")
 
-        return f"{path_parts[0]}/{path_parts[1]}"
+        repo_path = f"{path_parts[0]}/{path_parts[1]}"
+        return base_url, repo_path
diff --git a/workflow/integrations/github.py b/workflow/integrations/github.py
@@ -20,6 +20,8 @@ class GitHubIntegration(BaseIntegration):
     """
 
     api_url = GITHUB_API_URL
+    open_status = "open"
+    closed_status = "closed"
 
     def get_headers(self):
         github_token = self.dataspace.get_configuration(field_name="github_token")
@@ -45,7 +47,7 @@ def sync(self, request):
                 issue_id=external_issue.issue_id,
                 title=self.make_issue_title(request),
                 body=self.make_issue_body(request),
-                state="closed" if request.is_closed else "open",
+                state=self.closed_status if request.is_closed else self.open_status,
                 labels=labels,
             )
         else:
@@ -88,7 +90,7 @@ def update_issue(self, repo_id, issue_id, title=None, body=None, state=None, lab
 
         return self.patch(url, json=data)
 
-    def post_comment(self, repo_id, issue_id, comment_body):
+    def post_comment(self, repo_id, issue_id, comment_body, base_url=None):
         """Post a comment on an existing GitHub issue."""
         url = f"{self.api_url}/repos/{repo_id}/issues/{issue_id}/comments"
         data = {"body": comment_body}
diff --git a/workflow/integrations/gitlab.py b/workflow/integrations/gitlab.py
@@ -95,7 +95,7 @@ def update_issue(self, repo_id, issue_id, title=None, body=None, state_event=Non
 
         return self.put(url, json=data)
 
-    def post_comment(self, repo_id, issue_id, comment_body):
+    def post_comment(self, repo_id, issue_id, comment_body, base_url=None):
         """Post a comment on an existing GitLab issue."""
         project_path = quote(repo_id, safe="")
         url = f"{self.api_url}/projects/{project_path}/issues/{issue_id}/notes"
diff --git a/workflow/integrations/jira.py b/workflow/integrations/jira.py
@@ -100,7 +100,7 @@ def update_issue(self, issue_id, title=None, body=None, status=None):
 
         return {"id": issue_id}
 
-    def post_comment(self, repo_id, issue_id, comment_body):
+    def post_comment(self, repo_id, issue_id, comment_body, base_url=None):
         """Post a comment on an existing Jira issue."""
         api_url = repo_id.rstrip("/") + JIRA_API_PATH
         url = f"{api_url}/issue/{issue_id}/comment"
diff --git a/workflow/migrations/0003_externalissuelink_base_url.py b/workflow/migrations/0003_externalissuelink_base_url.py
@@ -0,0 +1,18 @@
+# Generated by Django 5.2.4 on 2025-08-07 14:07
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('workflow', '0002_requesttemplate_issue_tracker_id_externalissuelink_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='externalissuelink',
+            name='base_url',
+            field=models.URLField(blank=True, help_text='Base URL of the external issue tracker platform (e.g., https://forgejo.example.org). Used to construct API endpoints for integrations like Forgejo or Jira.', max_length=255, null=True),
+        ),
+    ]
diff --git a/workflow/models.py b/workflow/models.py
@@ -113,6 +113,16 @@ class Platform(models.TextChoices):
         help_text=_("ID or key of the issue on the external platform."),
     )
 
+    base_url = models.URLField(
+        max_length=255,
+        blank=True,
+        null=True,
+        help_text=_(
+            "Base URL of the external issue tracker platform (e.g., https://forgejo.example.org). "
+            "Used to construct API endpoints for integrations like Forgejo or Jira."
+        ),
+    )
+
     class Meta:
         unique_together = (
             ("dataspace", "platform", "repo", "issue_id"),
@@ -131,7 +141,7 @@ def issue_url(self):
         elif self.platform == self.Platform.JIRA:
             return f"{self.repo}/browse/{self.issue_id}"
         elif self.platform == self.Platform.FORGEJO:
-            return f"{self.repo}/issues/{self.issue_id}"
+            return f"{self.base_url}/{self.repo}/issues/{self.issue_id}"
 
     @property
     def icon_css_class(self):
@@ -606,16 +616,20 @@ def close(self, user, reason):
         )
         return event_instance
 
-    def link_external_issue(self, platform, repo, issue_id):
+    def link_external_issue(self, platform, repo, issue_id, base_url=None):
         """Create or return an ExternalIssueLink associated with this Request."""
         if self.external_issue:
             return self.external_issue
 
+        if base_url:
+            base_url = base_url.rstrip("/")
+
         external_issue = ExternalIssueLink.objects.create(
             dataspace=self.dataspace,
             platform=platform,
             repo=repo,
             issue_id=str(issue_id),
+            base_url=base_url,
         )
 
         # Set the external_issue on this instance without triggering the whole
@@ -710,6 +724,7 @@ def handle_integrations(self):
                 repo_id=external_issue.repo,
                 issue_id=external_issue.issue_id,
                 comment_body=self.text,
+                base_url=external_issue.base_url,
             )
 
 
@@ -792,6 +807,7 @@ def handle_integrations(self):
                 repo_id=external_issue.repo,
                 issue_id=external_issue.issue_id,
                 comment_body=self.text,
+                base_url=external_issue.base_url,
             )
 
 

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,7 @@ def clean_issue_tracker_id(self):`
`65`	`65`	`raise ValidationError(`
`66`	`66`	`[`
`67`	`67`	`"Invalid issue tracker URL format. Supported formats include:",`
	`68`	`+ "• Forgejo: https://forgejo.DOMAIN.org/OR/REPO_NAME",`
`68`	`69`	`"• GitHub: https://github.com/ORG/REPO_NAME",`
`69`	`70`	`"• GitLab: https://gitlab.com/GROUP/PROJECT_NAME",`
`70`	`71`	`"• Jira: https://YOUR_DOMAIN.atlassian.net/projects/PROJECTKEY",`