Merge pull request #28197 from guardian/enrich-trail-type

add trail text and gallery count to trail type

Author: marjisound

common/app/agents/DeeplyReadAgent.scala

@@ -1,6 +1,6 @@
 package agents
 
-import com.gu.contentapi.client.model.v1.Content
+import com.gu.contentapi.client.model.v1.{Content, ElementType}
 import com.gu.contentapi.client.utils.CapiModelEnrichment.RenderingFormat
 import common._
 import contentapi.ContentApiClient
@@ -123,6 +123,9 @@ class DeeplyReadAgent(contentApiClient: ContentApiClient, ophanApi: OphanApi) ex
       avatarUrl = None,
       branding = None,
       discussion = DiscussionSettings.fromTrail(FaciaContentConvert.contentToFaciaContent(content)),
+      trailText = content.fields.flatMap(_.trailText),
+      galleryCount =
+        content.elements.map(_.count(el => el.`type` == ElementType.Image && el.relation == "gallery")).filter(_ > 0),
     )
   }
 

common/app/model/dotcomrendering/Trail.scala

@@ -5,6 +5,7 @@ import com.gu.commercial.branding.{Branding, BrandingType, Dimensions, Logo => C
 import common.{Edition, LinkTo}
 import implicits.FaciaContentFrontendHelpers.FaciaContentFrontendHelper
 import layout.{ContentCard, DiscussionSettings}
+import model.dotcomrendering.DotcomRenderingUtils.withoutNull
 import model.{Article, ContentFormat, ImageMedia, InlineImage, Pillar}
 import model.pressed.PressedContent
 import play.api.libs.json.{Json, OWrites, Writes}
@@ -33,6 +34,8 @@ case class Trail(
     avatarUrl: Option[String],
     branding: Option[Branding],
     discussion: DiscussionSettings,
+    trailText: Option[String],
+    galleryCount: Option[Int],
 )
 
 object Trail {
@@ -53,7 +56,35 @@ object Trail {
 
   implicit val discussionWrites: OWrites[DiscussionSettings] = Json.writes[DiscussionSettings]
 
-  implicit val OnwardItemWrites: OWrites[Trail] = Json.writes[Trail]
+  implicit val OnwardItemWrites: Writes[Trail] = Writes { trail =>
+    val jsObject = Json.obj(
+      "url" -> trail.url,
+      "linkText" -> trail.linkText,
+      "showByline" -> trail.showByline,
+      "byline" -> trail.byline,
+      "masterImage" -> trail.masterImage,
+      "image" -> trail.image,
+      "carouselImages" -> trail.carouselImages,
+      "ageWarning" -> trail.ageWarning,
+      "isLiveBlog" -> trail.isLiveBlog,
+      "pillar" -> trail.pillar,
+      "designType" -> trail.designType,
+      "format" -> trail.format,
+      "webPublicationDate" -> trail.webPublicationDate,
+      "headline" -> trail.headline,
+      "mediaType" -> trail.mediaType,
+      "shortUrl" -> trail.shortUrl,
+      "kickerText" -> trail.kickerText,
+      "starRating" -> trail.starRating,
+      "avatarUrl" -> trail.avatarUrl,
+      "branding" -> trail.branding,
+      "discussion" -> trail.discussion,
+      "trailText" -> trail.trailText,
+      "galleryCount" -> trail.galleryCount,
+    )
+
+    withoutNull(jsObject)
+  }
 
   private def contentCardToAvatarUrl(contentCard: ContentCard): Option[String] = {
 
@@ -99,43 +130,6 @@ object Trail {
       url <- masterImage.url
     } yield url
 
-  def contentCardToTrail(contentCard: ContentCard): Option[Trail] = {
-    for {
-      properties <- contentCard.properties
-      maybeContent <- properties.maybeContent
-      metadata = maybeContent.metadata
-      pillar <- metadata.pillar
-      url <- properties.webUrl
-      headline = contentCard.header.headline
-      isLiveBlog = properties.isLiveBlog
-      showByline = properties.showByline
-      webPublicationDate <- contentCard.webPublicationDate.map(x => x.toDateTime().toString())
-      shortUrl <- contentCard.shortUrl
-    } yield Trail(
-      url = url,
-      linkText = "",
-      showByline = showByline,
-      byline = contentCard.byline.map(x => x.get),
-      masterImage = getMasterUrl(maybeContent.trail.trailPicture),
-      image = maybeContent.trail.thumbnailPath,
-      carouselImages = getImageSources(maybeContent.trail.trailPicture),
-      ageWarning = None,
-      isLiveBlog = isLiveBlog,
-      pillar = TrailUtils.normalisePillar(Some(pillar)),
-      designType = metadata.designType.toString,
-      format = metadata.format.getOrElse(ContentFormat.defaultContentFormat),
-      webPublicationDate = webPublicationDate,
-      headline = headline,
-      mediaType = contentCard.mediaType.map(x => x.toString),
-      shortUrl = shortUrl,
-      kickerText = contentCard.header.kicker.flatMap(_.properties.kickerText),
-      starRating = contentCard.starRating,
-      avatarUrl = contentCardToAvatarUrl(contentCard),
-      branding = contentCard.branding,
-      discussion = contentCard.discussionSettings,
-    )
-  }
-
   def pressedContentToTrail(content: PressedContent)(implicit
       request: RequestHeader,
   ): Trail = {
@@ -168,6 +162,8 @@ object Trail {
       avatarUrl = None,
       branding = content.branding(Edition(request)),
       discussion = DiscussionSettings.fromTrail(content),
+      trailText = content.card.trailText,
+      galleryCount = content.card.galleryCount,
     )
   }
 }