expose new parentAndChildDetails property on an image response, which contains a map of the various relationships the image has with other images (with detail for each such as thumbnail)

Author: twrichards

media-api/app/controllers/MediaApi.scala

@@ -2,6 +2,7 @@ package controllers
 
 import org.apache.pekko.stream.scaladsl.StreamConverters
 import com.google.common.net.HttpHeaders
+import com.gu.mediaservice.lib.ImageStorageProps
 import com.gu.mediaservice.{GridClient, JsonDiff}
 import com.gu.mediaservice.lib.argo._
 import com.gu.mediaservice.lib.argo.model.{Action, _}
@@ -15,6 +16,7 @@ import com.gu.mediaservice.lib.logging.{LogMarker, MarkerMap}
 import com.gu.mediaservice.lib.metadata.SoftDeletedMetadataTable
 import com.gu.mediaservice.lib.play.RequestLoggingFilter
 import com.gu.mediaservice.model._
+import com.gu.mediaservice.model.usage.{DerivativeUsageStatus, ReplacedUsageStatus}
 import com.gu.mediaservice.syntax.MessageSubjects
 import lib._
 import lib.elasticsearch._
@@ -573,6 +575,14 @@ class MediaApi(
         val deleteImagePermission = authorisation.isUploaderOrHasPermission(request.user, source.instance.uploadedBy, DeleteImagePermission)
         val deleteCropsOrUsagePermission = canUserDeleteCropsOrUsages(request.user)
 
+        val getRelationDetails = elasticSearch.getRelationDetails(id, imageResponse.getSecureThumbUrl)_
+        val relationDetails = Map(
+          "Replacement for" -> source.instance.identifiers.get(ImageStorageProps.replacesMediaIdIdentifierKey).map(getRelationDetails),
+          "Replaced by" -> source.instance.usages.filter(_.status == ReplacedUsageStatus).flatMap(_.childUsageMetadata.map(_.childMediaId)).map(getRelationDetails),
+          "Derivative of" -> source.instance.identifiers.get(ImageStorageProps.derivativeOfMediaIdsIdentifierKey).toList.flatMap(_.split(",").map(_.trim)).map(getRelationDetails),
+          "Derivatives" -> source.instance.usages.filter(_.status == DerivativeUsageStatus).flatMap(_.childUsageMetadata.map(_.childMediaId)).map(getRelationDetails)
+        ).view.mapValues(_.iterator.toMap).toMap
+
         val (imageData, imageLinks, imageActions) = imageResponse.create(
           id,
           source,
@@ -583,8 +593,12 @@ class MediaApi(
           request.user.accessor.tier
         )
 
-        Some((source.instance, imageData, imageLinks, imageActions))
-
+        Some((
+          source.instance,
+          imageData.asInstanceOf[JsObject] + ("parentAndChildDetails" -> Json.toJson(relationDetails)),
+          imageLinks,
+          imageActions
+        ))
       case _ => None
     }
   }

media-api/app/lib/ImageResponse.scala

@@ -75,17 +75,11 @@ class ImageResponse(config: MediaApiConfig, s3Client: S3Client, usageQuota: Usag
 
     val pngFileUri = image.optimisedPng.map(_.file)
 
-    val fileUri = image.source.file
-
-    val imageUrl = s3Client.signUrl(config.imageBucket, fileUri, image, imageType = Source)
+    val imageUrl = s3Client.signUrl(config.imageBucket, image.source.file, image, imageType = Source)
     val pngUrl: Option[String] = pngFileUri
       .map(s3Client.signUrl(config.imageBucket, _, image, imageType = OptimisedPng))
 
-    def s3SignedThumbUrl = s3Client.signUrl(config.thumbBucket, fileUri, image, imageType = Thumbnail)
-
-    val thumbUrl = config.cloudFrontDomainThumbBucket
-      .flatMap(s3Client.signedCloudFrontUrl(_, fileUri.getPath.drop(1)))
-      .getOrElse(s3SignedThumbUrl)
+    val thumbUrl: String = getSecureThumbUrl(image)
 
     val validityMap = checkUsageRestrictions(source, ImageExtras.validityMap(image, withWritePermission))
     val valid = ImageExtras.isValid(validityMap)
@@ -130,6 +124,16 @@ class ImageResponse(config: MediaApiConfig, s3Client: S3Client, usageQuota: Usag
     (data, links, actions)
   }
 
+  def getSecureThumbUrl(image: Image) = {
+    val fileUri: URI = image.source.file
+
+    def s3SignedThumbUrl = s3Client.signUrl(config.thumbBucket, fileUri, image, imageType = Thumbnail)
+
+    config.cloudFrontDomainThumbBucket
+      .flatMap(s3Client.signedCloudFrontUrl(_, fileUri.getPath.drop(1)))
+      .getOrElse(s3SignedThumbUrl)
+  }
+
   private def downloadLink(id: String) = Link("download", s"${config.rootUri}/images/$id/download")
   private def downloadOptimisedLink(id: String) = Link("downloadOptimised", s"${config.rootUri}/images/$id/downloadOptimised?{&width,height,quality}")
 

media-api/app/lib/elasticsearch/ElasticSearch.scala

@@ -27,8 +27,8 @@ import scalaz.NonEmptyList
 import scalaz.syntax.std.list._
 
 import java.util.concurrent.TimeUnit
-import scala.concurrent.duration.FiniteDuration
-import scala.concurrent.{ExecutionContext, Future}
+import scala.concurrent.duration.{DurationInt, FiniteDuration}
+import scala.concurrent.{Await, ExecutionContext, Future, TimeoutException}
 
 class ElasticSearch(
   val config: MediaApiConfig,
@@ -280,6 +280,21 @@ class ElasticSearch(
     }
   }
 
+  def getRelationDetails(mediaIdThisIsFor: String, getSecureThumbUrl: Image => String)(
+    id: String
+  )(implicit ex: ExecutionContext, request: AuthenticatedRequest[AnyContent, Principal], logMarker:MarkerMap = MarkerMap()): (String, Option[Map[String, String]]) = {
+    try {
+      id -> Await.result(getImageById(id), 5.seconds).map(image => Map(
+        "thumbnail" -> getSecureThumbUrl(image),
+        "addedBy" -> image.uploadedBy
+      ))
+    } catch {
+      case e: TimeoutException =>
+        logger.error(logMarker, s"Timeout getting image $id (when finding relation details for $mediaIdThisIsFor)", e)
+        id -> None
+    }
+  }
+
   def usageForSupplier(id: String, numDays: Int)(implicit ex: ExecutionContext, logMarker: LogMarker): Future[SupplierUsageSummary] = {
     val supplier = Agencies.get(id)
     val supplierName = supplier.supplier