feat(Hackathon): Submit a GitHub issue to clean up a stale feature (#6691)

Author: emyller

api/app/settings/common.py

@@ -1030,6 +1030,7 @@
 GITHUB_PEM = env.str("GITHUB_PEM", default="")
 GITHUB_APP_ID: int = env.int("GITHUB_APP_ID", default=0)
 GITHUB_WEBHOOK_SECRET = env.str("GITHUB_WEBHOOK_SECRET", default="")
+FEATURE_LIFECYCLE_GITHUB_PAT = env.str("FEATURE_LIFECYCLE_GITHUB_PAT", default="")
 
 # Additional functionality for using SAML in Flagsmith SaaS
 SAML_INSTALLED = importlib.util.find_spec("saml") is not None

api/integrations/github/client.py

@@ -98,6 +98,28 @@ def build_paginated_response(
     return data
 
 
+def create_github_issue(
+    github_pat: str,
+    api_url: str,
+    owner: str,
+    repo: str,
+    title: str,
+    body: str,
+) -> dict[str, Any]:
+    url = f"{api_url}repos/{owner}/{repo}/issues"
+    headers = {
+        "X-GitHub-Api-Version": GITHUB_API_VERSION,
+        "Accept": "application/vnd.github.v3+json",
+        "Authorization": f"token {github_pat}",
+    }
+    payload = {"title": title, "body": body}
+    response = requests.post(
+        url, json=payload, headers=headers, timeout=GITHUB_API_CALLS_TIMEOUT
+    )
+    response.raise_for_status()
+    return response.json()  # type: ignore[no-any-return]
+
+
 def post_comment_to_github(
     installation_id: str, owner: str, repo: str, issue: str, body: str
 ) -> dict[str, Any]:

api/integrations/github/constants.py

@@ -21,6 +21,15 @@
 FEATURE_ENVIRONMENT_URL = "%s/project/%s/environment/%s/features?feature=%s&tab=%s"
 GITHUB_API_CALLS_TIMEOUT = 10
 
+CLEANUP_ISSUE_TITLE = "Remove stale feature flag: %s"
+CLEANUP_ISSUE_BODY = """\
+We need to clean up feature flag usage in the code.
+Our goal is to delete references of the "%s" feature.
+We need to delete the feature flag check so that the code path \
+is no longer guarded by the feature flag.
+These are the occurrences of this feature flag in this repository:
+%s"""
+
 GITHUB_TAG_COLOR = "#838992"
 GITHUB_FLAGSMITH_LABEL = "Flagsmith Flag"
 GITHUB_FLAGSMITH_LABEL_DESCRIPTION = (

api/integrations/github/serializers.py

@@ -35,6 +35,10 @@ class Meta:
         )
 
 
+class CreateCleanupIssueSerializer(serializers.Serializer):  # type: ignore[type-arg]
+    feature_id = serializers.IntegerField()
+
+
 class PaginatedQueryParamsSerializer(DataclassSerializer):  # type: ignore[type-arg]
     class Meta:
         dataclass = PaginatedQueryParams

api/integrations/github/views.py

@@ -3,6 +3,7 @@
 import re
 from functools import wraps
 from typing import Any, Callable
+from urllib.parse import urlparse
 
 import requests
 from django.conf import settings
@@ -13,14 +14,26 @@
 from rest_framework.permissions import AllowAny, IsAuthenticated
 from rest_framework.response import Response
 
+from features.feature_external_resources.models import (
+    FeatureExternalResource,
+)
+from features.feature_external_resources.models import (
+    ResourceType as ExternalResourceType,
+)
+from features.models import Feature
 from integrations.github.client import (
     ResourceType,
     create_flagsmith_flag_label,
+    create_github_issue,
     delete_github_installation,
     fetch_github_repo_contributors,
     fetch_github_repositories,
     fetch_search_github_resource,
 )
+from integrations.github.constants import (
+    CLEANUP_ISSUE_BODY,
+    CLEANUP_ISSUE_TITLE,
+)
 from integrations.github.exceptions import DuplicateGitHubIntegration
 from integrations.github.github import (
     handle_github_webhook_event,
@@ -30,13 +43,15 @@
 from integrations.github.models import GithubConfiguration, GitHubRepository
 from integrations.github.permissions import HasPermissionToGithubConfiguration
 from integrations.github.serializers import (
+    CreateCleanupIssueSerializer,
     GithubConfigurationSerializer,
     GithubRepositorySerializer,
     IssueQueryParamsSerializer,
     PaginatedQueryParamsSerializer,
     RepoQueryParamsSerializer,
 )
 from organisations.permissions.permissions import GithubIsAdminOrganisation
+from projects.code_references.services import get_code_references_for_feature_flag
 
 logger = logging.getLogger(__name__)
 
@@ -270,6 +285,107 @@ def fetch_repo_contributors(request, organisation_pk) -> Response:  # type: igno
     )
 
 
+def _get_github_api_url(repository_url: str) -> str:
+    """Derive the GitHub API base URL from a repository URL.
+
+    For github.com: https://api.github.com/
+    For enterprise: https://{host}/api/v3/
+    """
+    parsed = urlparse(repository_url)
+    if parsed.hostname == "github.com":
+        return "https://api.github.com/"
+    return f"{parsed.scheme}://{parsed.hostname}/api/v3/"
+
+
+@api_view(["POST"])
+@permission_classes([IsAuthenticated, HasPermissionToGithubConfiguration])
+@github_api_call_error_handler(error="Failed to create GitHub cleanup issue.")
+def create_cleanup_issue(request, organisation_pk: int) -> Response:  # type: ignore[no-untyped-def]
+    serializer = CreateCleanupIssueSerializer(data=request.data)
+    if not serializer.is_valid():
+        return Response(
+            {"error": serializer.errors}, status=status.HTTP_400_BAD_REQUEST
+        )
+
+    github_pat: str = settings.FEATURE_LIFECYCLE_GITHUB_PAT
+    if not github_pat:
+        return Response(
+            data={"detail": "GitHub PAT is not configured."},
+            status=status.HTTP_400_BAD_REQUEST,
+        )
+
+    feature_id: int = serializer.validated_data["feature_id"]
+
+    # Validate the feature exists and belongs to this org.
+    try:
+        feature = Feature.objects.get(
+            id=feature_id,
+            project__organisation_id=organisation_pk,
+        )
+    except Feature.DoesNotExist:
+        return Response(
+            data={"detail": "Feature not found in this organisation."},
+            status=status.HTTP_404_NOT_FOUND,
+        )
+
+    # Get code references for the feature across all repositories.
+    summaries = [
+        summary
+        for summary in get_code_references_for_feature_flag(feature)
+        if summary.code_references
+    ]
+    if not summaries:
+        return Response(
+            data={"detail": "No code references found for this feature."},
+            status=status.HTTP_400_BAD_REQUEST,
+        )
+
+    issue_title = CLEANUP_ISSUE_TITLE % feature.name
+
+    for summary in summaries:
+        # Format code references as markdown list.
+        references_text = "\n".join(
+            f"- [`{ref.file_path}#L{ref.line_number}`]({ref.permalink})"
+            for ref in summary.code_references
+        )
+        issue_body = CLEANUP_ISSUE_BODY % (feature.name, references_text)
+
+        # Parse owner/name from repository_url.
+        url_parts = summary.repository_url.rstrip("/").split("/")
+        owner = url_parts[-2]
+        repo = url_parts[-1]
+
+        api_url = _get_github_api_url(summary.repository_url)
+        github_response = create_github_issue(
+            github_pat=github_pat,
+            api_url=api_url,
+            owner=owner,
+            repo=repo,
+            title=issue_title,
+            body=issue_body,
+        )
+
+        # Link the issue to the feature.
+        issue_url: str = github_response["html_url"]
+        metadata = json.dumps(
+            {
+                "title": github_response["title"],
+                "state": github_response["state"],
+            }
+        )
+        try:
+            FeatureExternalResource.objects.create(
+                url=issue_url,
+                type=ExternalResourceType.GITHUB_ISSUE,
+                feature=feature,
+                metadata=metadata,
+            )
+        except IntegrityError:
+            pass
+
+    return Response(status=status.HTTP_204_NO_CONTENT)
+
+
 @api_view(["POST"])
 @permission_classes([AllowAny])
 def github_webhook(request) -> Response:  # type: ignore[no-untyped-def]

api/organisations/urls.py

@@ -11,6 +11,7 @@
 from integrations.github.views import (
     GithubConfigurationViewSet,
     GithubRepositoryViewSet,
+    create_cleanup_issue,
     fetch_issues,
     fetch_pull_requests,
     fetch_repo_contributors,
@@ -147,6 +148,11 @@
         fetch_repositories,
         name="get-github-installation-repos",
     ),
+    path(
+        "<int:organisation_pk>/github/create-cleanup-issue/",
+        create_cleanup_issue,
+        name="create-github-cleanup-issue",
+    ),
     path(
         "<int:organisation_pk>/api-usage-notification/",
         OrganisationAPIUsageNotificationView.as_view(),