feat: Fill in check for updates API (#97392)

noahsmartin · web-flow · commit d9466a5ebce8 · 2025-08-11T11:04:04.000-04:00
Fills in the check for updates API to find the currently running app
(using binary identifier) and the most recent update if it differs from
the current version
diff --git a/src/sentry/preprod/api/endpoints/project_preprod_artifact_install_details.py b/src/sentry/preprod/api/endpoints/project_preprod_artifact_install_details.py
@@ -1,11 +1,8 @@
 import logging
-import secrets
-from datetime import timedelta
 from typing import Any
 
 from django.http import JsonResponse
 from django.http.response import HttpResponseBase
-from django.utils import timezone
 from rest_framework.request import Request
 from rest_framework.response import Response
 
@@ -17,52 +14,12 @@
 from sentry.preprod.api.models.project_preprod_build_details_models import (
     platform_from_artifact_type,
 )
-from sentry.preprod.models import InstallablePreprodArtifact, PreprodArtifact
+from sentry.preprod.build_distribution_utils import get_download_url_for_artifact
+from sentry.preprod.models import PreprodArtifact
 
 logger = logging.getLogger(__name__)
 
 
-def create_installable_preprod_artifact(
-    preprod_artifact: PreprodArtifact, expiration_hours: int = 12
-) -> InstallablePreprodArtifact:
-    """
-    Creates a new InstallablePreprodArtifact for a given PreprodArtifact.
-
-    Args:
-        preprod_artifact: The PreprodArtifact to create an installable version for
-        expiration_hours: Number of hours until the install link expires (default: 12)
-
-    Returns:
-        The created InstallablePreprodArtifact instance
-    """
-
-    url_path = secrets.token_urlsafe(12)
-
-    # Set expiration date
-    expiration_date = timezone.now() + timedelta(hours=expiration_hours)
-
-    # Create the installable artifact
-    installable_artifact = InstallablePreprodArtifact.objects.create(
-        preprod_artifact=preprod_artifact,
-        url_path=url_path,
-        expiration_date=expiration_date,
-        download_count=0,
-    )
-
-    logger.info(
-        "Created installable preprod artifact",
-        extra={
-            "installable_artifact_id": installable_artifact.id,
-            "preprod_artifact_id": preprod_artifact.id,
-            "project_id": preprod_artifact.project.id,
-            "organization_id": preprod_artifact.project.organization.id,
-            "expiration_date": expiration_date.isoformat(),
-        },
-    )
-
-    return installable_artifact
-
-
 @region_silo_endpoint
 class ProjectPreprodInstallDetailsEndpoint(ProjectEndpoint):
     owner = ApiOwner.EMERGE_TOOLS
@@ -103,16 +60,7 @@ def get(self, request: Request, project, artifact_id) -> HttpResponseBase:
         if not preprod_artifact.installable_app_file_id:
             return Response({"error": "Installable file not available"}, status=404)
 
-        installable = create_installable_preprod_artifact(preprod_artifact)
-
-        # Only add response_format=plist for iOS apps (XCARCHIVE type)
-        url_params = ""
-        if preprod_artifact.artifact_type == PreprodArtifact.ArtifactType.XCARCHIVE:
-            url_params = "?response_format=plist"
-
-        installable_url = request.build_absolute_uri(
-            f"/api/0/projects/{project.organization.slug}/{project.slug}/files/installablepreprodartifact/{installable.url_path}/{url_params}"
-        )
+        installable_url = get_download_url_for_artifact(preprod_artifact, request)
 
         # Build response based on artifact type
         response_data: dict[str, Any] = {
diff --git a/src/sentry/preprod/api/endpoints/project_preprod_check_for_updates.py b/src/sentry/preprod/api/endpoints/project_preprod_check_for_updates.py
@@ -1,5 +1,6 @@
 import logging
 
+from packaging.version import parse as parse_version
 from pydantic import BaseModel
 from rest_framework.request import Request
 from rest_framework.response import Response
@@ -8,15 +9,23 @@
 from sentry.api.api_publish_status import ApiPublishStatus
 from sentry.api.base import region_silo_endpoint
 from sentry.api.bases.project import ProjectEndpoint, ProjectReleasePermission
-from sentry.preprod.models import PreprodArtifact
+from sentry.preprod.build_distribution_utils import (
+    get_download_url_for_artifact,
+    is_installable_artifact,
+)
+from sentry.preprod.models import PreprodArtifact, PreprodBuildConfiguration
 from sentry.types.ratelimit import RateLimit, RateLimitCategory
 
 logger = logging.getLogger(__name__)
 
 
 class InstallableBuildDetails(BaseModel):
+    id: str
     build_version: str
     build_number: int
+    download_url: str
+    app_name: str
+    created_date: str
 
 
 class CheckForUpdatesApiResponse(BaseModel):
@@ -46,22 +55,123 @@ def get(self, request: Request, project) -> Response:
         Check for updates for a preprod artifact
         """
         main_binary_identifier = request.GET.get("main_binary_identifier")
-        if not main_binary_identifier:
-            # Not implemented yet
-            return Response(CheckForUpdatesApiResponse().dict())
+        app_id = request.GET.get("app_id")
+
+        platform = request.GET.get("platform")
+        provided_version = request.GET.get("version")
+        provided_build_configuration_name = request.GET.get("build_configuration")
+
+        if not app_id or not platform or not provided_version or not main_binary_identifier:
+            return Response({"error": "Missing required parameters"}, status=400)
+
+        provided_build_configuration = None
+        if provided_build_configuration_name:
+            try:
+                provided_build_configuration = PreprodBuildConfiguration.objects.get(
+                    project=project,
+                    name=provided_build_configuration_name,
+                )
+            except PreprodBuildConfiguration.DoesNotExist:
+                return Response({"error": "Invalid build configuration"}, status=400)
+
+        preprod_artifact = None
+        current = None
+        update = None
+
+        # Common filter logic
+        def get_base_filters():
+            filter_kwargs = {
+                "project": project,
+                "app_id": app_id,
+            }
+
+            if platform == "android":
+                filter_kwargs["artifact_type__in"] = [
+                    PreprodArtifact.ArtifactType.AAB,
+                    PreprodArtifact.ArtifactType.APK,
+                ]
+            elif platform == "ios":
+                filter_kwargs["artifact_type"] = PreprodArtifact.ArtifactType.XCARCHIVE
+
+            return filter_kwargs
 
         try:
-            preprod_artifact = PreprodArtifact.objects.filter(
-                project=project, main_binary_identifier=main_binary_identifier
-            ).latest("date_added")
+            current_filter_kwargs = get_base_filters()
+            current_filter_kwargs.update(
+                {
+                    "main_binary_identifier": main_binary_identifier,
+                    "build_version": provided_version,
+                }
+            )
+
+            if provided_build_configuration:
+                current_filter_kwargs["build_configuration"] = provided_build_configuration
+
+            preprod_artifact = PreprodArtifact.objects.filter(**current_filter_kwargs).latest(
+                "date_added"
+            )
         except PreprodArtifact.DoesNotExist:
-            return Response({"error": "Not found"}, status=404)
+            logger.warning(
+                "No artifact found for binary identifier with version %s", provided_version
+            )
 
-        if preprod_artifact.build_version and preprod_artifact.build_number:
+        if preprod_artifact and preprod_artifact.build_version and preprod_artifact.build_number:
             current = InstallableBuildDetails(
+                id=str(preprod_artifact.id),
                 build_version=preprod_artifact.build_version,
                 build_number=preprod_artifact.build_number,
+                app_name=preprod_artifact.app_name,
+                download_url=get_download_url_for_artifact(preprod_artifact, request),
+                created_date=preprod_artifact.date_added.isoformat(),
             )
-        else:
-            current = None
-        return Response(CheckForUpdatesApiResponse(current=current).dict())
+
+        # Get the update object - find the highest version available
+        # Get all build versions for this app and platform
+        new_build_filter_kwargs = get_base_filters()
+        if preprod_artifact:
+            new_build_filter_kwargs["build_configuration"] = preprod_artifact.build_configuration
+        elif provided_build_configuration:
+            new_build_filter_kwargs["build_configuration"] = provided_build_configuration
+        all_versions = (
+            PreprodArtifact.objects.filter(**new_build_filter_kwargs)
+            .values_list("build_version", flat=True)
+            .distinct()
+        )
+
+        # Find the highest semver version
+        highest_version = None
+        for version in all_versions:
+            if version:
+                try:
+                    parsed_version = parse_version(version)
+                    if highest_version is None or parsed_version > parse_version(highest_version):
+                        highest_version = version
+                except Exception:
+                    # Skip invalid version strings
+                    continue
+
+        # Get all artifacts for the highest version
+        if highest_version:
+            new_build_filter_kwargs["build_version"] = highest_version
+            potential_artifacts = PreprodArtifact.objects.filter(**new_build_filter_kwargs)
+
+            # Filter for installable artifacts and get the one with highest build_number
+            installable_artifacts = [
+                artifact for artifact in potential_artifacts if is_installable_artifact(artifact)
+            ]
+            if len(installable_artifacts) > 0:
+                best_artifact = max(
+                    installable_artifacts, key=lambda a: (a.build_number, a.date_added)
+                )
+                if not preprod_artifact or preprod_artifact.id != best_artifact.id:
+                    if best_artifact.build_version and best_artifact.build_number:
+                        update = InstallableBuildDetails(
+                            id=str(best_artifact.id),
+                            build_version=best_artifact.build_version,
+                            build_number=best_artifact.build_number,
+                            app_name=best_artifact.app_name,
+                            download_url=get_download_url_for_artifact(best_artifact, request),
+                            created_date=best_artifact.date_added.isoformat(),
+                        )
+
+        return Response(CheckForUpdatesApiResponse(current=current, update=update).dict())
diff --git a/src/sentry/preprod/build_distribution_utils.py b/src/sentry/preprod/build_distribution_utils.py
@@ -1,6 +1,81 @@
-from sentry.preprod.models import PreprodArtifact
+import logging
+import secrets
+from datetime import timedelta
+
+from django.utils import timezone
+
+from sentry.preprod.models import InstallablePreprodArtifact, PreprodArtifact
+
+logger = logging.getLogger(__name__)
 
 
 def is_installable_artifact(artifact: PreprodArtifact) -> bool:
     # TODO: Adjust this logic when we have a better way to determine if an artifact is installable
-    return artifact.installable_app_file_id is not None
+    return artifact.installable_app_file_id is not None and artifact.build_number is not None
+
+
+def get_download_url_for_artifact(artifact: PreprodArtifact, request) -> str:
+    """
+    Generate a download URL for a PreprodArtifact.
+
+    Args:
+        artifact: The PreprodArtifact to generate a download URL for
+        request: The HTTP request object to build absolute URLs
+
+    Returns:
+        A download URL string for the artifact
+    """
+    # Create an installable artifact (this handles the URL path generation and expiration)
+    installable = create_installable_preprod_artifact(artifact)
+
+    # Only add response_format=plist for iOS apps (XCARCHIVE type)
+    url_params = ""
+    if artifact.artifact_type == PreprodArtifact.ArtifactType.XCARCHIVE:
+        url_params = "?response_format=plist"
+
+    download_url = request.build_absolute_uri(
+        f"/api/0/projects/{artifact.project.organization.slug}/{artifact.project.slug}/files/installablepreprodartifact/{installable.url_path}/{url_params}"
+    )
+
+    return download_url
+
+
+def create_installable_preprod_artifact(
+    preprod_artifact: PreprodArtifact, expiration_hours: int = 12
+):
+    """
+    Creates a new InstallablePreprodArtifact for a given PreprodArtifact.
+
+    Args:
+        preprod_artifact: The PreprodArtifact to create an installable version for
+        expiration_hours: Number of hours until the install link expires (default: 12)
+
+    Returns:
+        The created InstallablePreprodArtifact instance
+    """
+
+    url_path = secrets.token_urlsafe(12)
+
+    # Set expiration date
+    expiration_date = timezone.now() + timedelta(hours=expiration_hours)
+
+    # Create the installable artifact
+    installable_artifact = InstallablePreprodArtifact.objects.create(
+        preprod_artifact=preprod_artifact,
+        url_path=url_path,
+        expiration_date=expiration_date,
+        download_count=0,
+    )
+
+    logger.info(
+        "Created installable preprod artifact",
+        extra={
+            "installable_artifact_id": installable_artifact.id,
+            "preprod_artifact_id": preprod_artifact.id,
+            "project_id": preprod_artifact.project.id,
+            "organization_id": preprod_artifact.project.organization.id,
+            "expiration_date": expiration_date.isoformat(),
+        },
+    )
+
+    return installable_artifact
diff --git a/tests/sentry/preprod/api/endpoints/test_project_preprod_build_details.py b/tests/sentry/preprod/api/endpoints/test_project_preprod_build_details.py
@@ -39,7 +39,7 @@ def setUp(self) -> None:
             app_name="TestApp",
             build_version="1.0.0",
             build_number=42,
-            build_configuration_id=None,
+            build_configuration=None,
             installable_app_file_id=1234,
             commit_comparison=commit_comparison,
         )
diff --git a/tests/sentry/preprod/api/endpoints/test_project_preprod_check_for_updates.py b/tests/sentry/preprod/api/endpoints/test_project_preprod_check_for_updates.py

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ def setUp(self) -> None:`
`39`	`39`	`app_name="TestApp",`
`40`	`40`	`build_version="1.0.0",`
`41`	`41`	`build_number=42,`
`42`		`- build_configuration_id=None,`
	`42`	`+ build_configuration=None,`
`43`	`43`	`installable_app_file_id=1234,`
`44`	`44`	`commit_comparison=commit_comparison,`
`45`	`45`	`)`