Add new models to support worklfow integrations #349

tdruez · tdruez · commit 1f3bd8813f5a · 2025-07-16T18:37:40.000+04:00
Signed-off-by: tdruez &lt;tdruez@nexb.com&gt;
diff --git a/dejacode/settings.py b/dejacode/settings.py
@@ -458,6 +458,9 @@ def gettext_noop(s):
 daily_at_3am = "0 3 * * *"
 DEJACODE_VULNERABILITIES_CRON = env.str("DEJACODE_VULNERABILITIES_CRON", default=daily_at_3am)
 
+# Workflow integrations
+DEJACODE_GITHUB_INTEGRATION_TOKEN = env.str("DEJACODE_GITHUB_INTEGRATION_TOKEN", default="")
+
 
 def enable_rq_eager_mode():
     """
diff --git a/workflow/integrations/__init__.py b/workflow/integrations/__init__.py
@@ -0,0 +1,7 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# DejaCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: AGPL-3.0-only
+# See https://github.com/aboutcode-org/dejacode for support or download.
+# See https://aboutcode.org for more information about AboutCode FOSS projects.
+#
diff --git a/workflow/integrations/github.py b/workflow/integrations/github.py
@@ -0,0 +1,76 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# DejaCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: AGPL-3.0-only
+# See https://github.com/aboutcode-org/dejacode for support or download.
+# See https://aboutcode.org for more information about AboutCode FOSS projects.
+#
+
+
+from urllib.parse import urlparse
+
+from django.conf import settings
+
+from github import Github
+
+
+def handle_integration(request):
+    github_token = settings.DEJACODE_GITHUB_INTEGRATION_TOKEN
+    if not github_token:
+        raise Exception("DEJACODE_GITHUB_INTEGRATION_TOKEN is not set.")
+
+    github_api = Github(github_token)
+    repo_id = extract_github_repo_path(request.request_template.issue_tracker_id)
+    repo = github_api.get_repo(repo_id)
+
+    labels = []
+    if request.priority:
+        labels.append(str(request.priority))
+
+    external_issue = request.external_issue
+
+    if external_issue:  # Update existing issue on GitHib
+        issue = repo.get_issue(number=int(external_issue.issue_id))
+        state = "closed" if request.is_closed else "open"
+        issue.edit(
+            title=make_issue_title(request),
+            body=make_issue_body(request),
+            state=state,
+        )
+    else:
+        issue = repo.create_issue(
+            title=make_issue_title(request),
+            body=make_issue_body(request),
+            labels=labels,
+        )
+        # Create an ExternalIssueLink instance and assign to the Request.
+        request.link_external_issue(platform="github", repo=repo_id, issue_id=issue.number)
+
+
+def make_issue_title(request):
+    return f"[DEJACODE] {request.title}"
+
+
+def make_issue_body(request):
+    body = f"""
+    - Request template: {request.request_template}
+    - Product context: {request.product_context}
+    - Applies to: {request.content_object}
+    - Submitted by: {request.requester}
+    - Assigned to: {request.assignee}
+    - Priority: {request.priority}
+    """
+    return body
+
+
+def extract_github_repo_path(url):
+    """Extract 'username/repo-name' from a GitHub URL."""
+    parsed = urlparse(url)
+    if "github.com" not in parsed.netloc:
+        raise ValueError("Not a GitHub URL")
+
+    path_parts = [part for part in parsed.path.split("/") if part]
+    if len(path_parts) < 2:
+        raise ValueError("Invalid GitHub repository URL")
+
+    return f"{path_parts[0]}/{path_parts[1]}"
diff --git a/workflow/migrations/0002_requesttemplate_issue_tracker_id_externalissuelink_and_more.py b/workflow/migrations/0002_requesttemplate_issue_tracker_id_externalissuelink_and_more.py
@@ -0,0 +1,40 @@
+# Generated by Django 5.2.4 on 2025-07-16 14:34
+
+import django.db.models.deletion
+import uuid
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('dje', '0007_dejacodeuser_timezone'),
+        ('workflow', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='requesttemplate',
+            name='issue_tracker_id',
+            field=models.CharField(blank=True, help_text='Link to associated issue in a tracking application, provided by the integration when the issue is created.', max_length=1000, verbose_name='Issue Tracker ID'),
+        ),
+        migrations.CreateModel(
+            name='ExternalIssueLink',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, verbose_name='UUID')),
+                ('platform', models.CharField(choices=[('github', 'GitHub'), ('gitlab', 'GitLab'), ('jira', 'Jira')], help_text='External issue tracking platform.', max_length=20)),
+                ('repo', models.CharField(help_text="Repository or project identifier (e.g., 'user/repo-name').", max_length=100)),
+                ('issue_id', models.CharField(help_text='ID or key of the issue on the external platform.', max_length=100)),
+                ('dataspace', models.ForeignKey(editable=False, help_text='A Dataspace is an independent, exclusive set of DejaCode data, which can be either nexB master reference data or installation-specific data.', on_delete=django.db.models.deletion.PROTECT, to='dje.dataspace')),
+            ],
+            options={
+                'unique_together': {('dataspace', 'platform', 'repo', 'issue_id'), ('dataspace', 'uuid')},
+            },
+        ),
+        migrations.AddField(
+            model_name='request',
+            name='external_issue',
+            field=models.ForeignKey(blank=True, help_text='Link to external issue (GitHub, GitLab, Jira, etc.)', null=True, on_delete=django.db.models.deletion.SET_NULL, to='workflow.externalissuelink'),
+        ),
+    ]
diff --git a/workflow/models.py b/workflow/models.py
@@ -39,6 +39,7 @@
 from dje.models import HistoryDateFieldsMixin
 from dje.models import HistoryFieldsMixin
 from dje.models import get_unsecured_manager
+from workflow.integrations import github
 from workflow.notification import request_comment_slack_payload
 from workflow.notification import request_slack_payload
 
@@ -88,13 +89,51 @@ def __str__(self):
         return self.label
 
 
+class ExternalIssueLink(DataspacedModel):
+    class Platform(models.TextChoices):
+        GITHUB = "github", _("GitHub")
+        GITLAB = "gitlab", _("GitLab")
+        JIRA = "jira", _("Jira")
+
+    platform = models.CharField(
+        max_length=20, choices=Platform.choices, help_text="External issue tracking platform."
+    )
+
+    repo = models.CharField(
+        max_length=100, help_text="Repository or project identifier (e.g., 'user/repo-name')."
+    )
+
+    issue_id = models.CharField(
+        max_length=100, help_text="ID or key of the issue on the external platform."
+    )
+
+    class Meta:
+        unique_together = (
+            ("dataspace", "platform", "repo", "issue_id"),
+            ("dataspace", "uuid"),
+        )
+
+    def __str__(self):
+        return f"{self.get_platform_display()}:{self.repo}#{self.issue_id}"
+
+    @property
+    def issue_url(self):
+        if self.platform == self.Platform.GITHUB:
+            return f"https://github.com/{self.repo}/issues/{self.issue_id}"
+        elif self.platform == self.Platform.GITLAB:
+            return f"https://gitlab.com/{self.repo}/-/issues/{self.issue_id}"
+        elif self.platform == self.Platform.JIRA:
+            return f"https://{self.repo}/browse/{self.issue_id}"
+
+
 class RequestQuerySet(DataspacedQuerySet):
     BASE_SELECT_RELATED = [
         "request_template",
         "requester",
         "assignee",
         "priority",
         "product_context",
+        "external_issue",
         "last_modified_by",
     ]
 
@@ -348,6 +387,14 @@ class Status(models.TextChoices):
         ),
     )
 
+    external_issue = models.ForeignKey(
+        to="workflow.ExternalIssueLink",
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        help_text=_("Link to external issue (GitHub, GitLab, Jira, etc.)"),
+    )
+
     last_modified_by = LastModifiedByField()
 
     objects = DataspacedManager.from_queryset(RequestQuerySet)()
@@ -397,6 +444,8 @@ def save(self, *args, **kwargs):
                 return
             previous_object.update_request_count()
 
+        self.handle_integrations()
+
     def get_absolute_url(self):
         return reverse("workflow:request_details", args=[self.uuid])
 
@@ -520,6 +569,29 @@ def serialize_hook(self, hook):
             "data": serializer.data,
         }
 
+    def link_external_issue(self, platform, repo, issue_id):
+        """Create or return an ExternalIssueLink associated with this Request."""
+        if self.external_issue:
+            return self.external_issue
+
+        external_issue = ExternalIssueLink.objects.create(
+            dataspace=self.dataspace,
+            platform=platform,
+            repo=repo,
+            issue_id=str(issue_id),
+        )
+        self.update(external_issue=external_issue)
+
+        return external_issue
+
+    def handle_integrations(self):
+        issue_tracker_id = self.request_template.issue_tracker_id
+        if not issue_tracker_id:
+            return
+
+        if "github.com" in issue_tracker_id:
+            github.handle_integration(request=self)
+
 
 @receiver(models.signals.post_delete, sender=Request)
 def update_request_count_on_delete(sender, instance=None, **kwargs):
@@ -723,6 +795,16 @@ class RequestTemplate(HistoryFieldsMixin, DataspacedModel):
         ),
     )
 
+    issue_tracker_id = models.CharField(
+        verbose_name=_("Issue Tracker ID"),
+        max_length=1000,
+        blank=True,
+        help_text=_(
+            "Link to associated issue in a tracking application, "
+            "provided by the integration when the issue is created."
+        ),
+    )
+
     objects = DataspacedManager.from_queryset(RequestTemplateQuerySet)()
 
     class Meta:
diff --git a/workflow/templates/workflow/includes/request_list_table.html b/workflow/templates/workflow/includes/request_list_table.html
@@ -46,6 +46,15 @@
                     <strong style="font-size: 115%;">
                       <a href="{% inject_preserved_filters req.get_absolute_url %}">#{{ req.id }} {{ req.title }}</a>
                     </strong>
+                    {% if req.external_issue %}
+                      <div>
+                        <a href="{{ req.external_issue.issue_url }}" target="_blank">
+                          <i class="fa-brands fa-github"></i>
+                          {{ req.external_issue }}
+                          <i class="fa-solid fa-up-right-from-square mini"></i>
+                        </a>
+                      </div>
+                    {% endif %}
                     <div>
                       {% if filter.form.request_template %}
                         <a href="?{{ filter.form.request_template.name }}={{ req.request_template.uuid }}" class="text-muted-light" title="Form: {{ req.request_template.name }}">{{ req.request_template.name }}</a>
diff --git a/workflow/templates/workflow/request_details.html b/workflow/templates/workflow/request_details.html
@@ -22,6 +22,15 @@
           <h1 class="header-title">
             {{ request_instance }} {{ request_instance.title }}
           </h1>
+          {% if request_instance.external_issue %}
+            <div class="h4 mb-0">
+              <a href="{{ request_instance.external_issue.issue_url }}" target="_blank">
+                <i class="fa-brands fa-github"></i>
+                {{ request_instance.external_issue }}
+                <i class="fa-solid fa-up-right-from-square mini"></i>
+              </a>
+            </div>
+          {% endif %}
         </div>
         <div class="col-auto">
           <a href="{{ request_instance.request_template.get_absolute_url }}" class="btn btn-success" data-bs-toggle="tooltip" title="Add a new Request of the same type">
diff --git a/workflow/templates/workflow/request_form.html b/workflow/templates/workflow/request_form.html
@@ -21,6 +21,15 @@
           <h1 class="header-title">
             {% if request_instance %}{# Edition #}
               Edit: <a href="{{ request_instance.get_absolute_url }}">{{ request_instance }} {{ request_instance.title }}</a>
+              {% if request_instance.external_issue %}
+                <span>&bull;
+                  <a href="{{ request_instance.external_issue.issue_url }}" target="_blank">
+                    <i class="fa-brands fa-github"></i>
+                    {{ request_instance.external_issue }}
+                    <i class="fa-solid fa-up-right-from-square mini"></i>
+                  </a>
+                </span>
+              {% endif %}
             {% else %}{# Addition #}
               New Request
             {% endif %}
