Merge pull request #270 from bbc/conal/merge_guardian_changes-180424

Merge latest Guardian changes as of 18-04-2024

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
   push:
     branches:
       - main
-      - 'pr**'
+      - pr*
 jobs:
   CI:
     runs-on: ubuntu-latest

.github/workflows/push-pr.yml

@@ -1,4 +1,5 @@
 name: push-pr
+run-name: Create/Update pr${{ inputs.prNumber }} branch
 on:
   workflow_dispatch:
     inputs:

common-lib/src/main/scala/com/gu/mediaservice/lib/elasticsearch/MappingTest.scala

@@ -175,7 +175,8 @@ object MappingTest {
         composerUrl = Some(new URI("https://composer/api/2345678987654321345678"))
       )),
       syndicationUsageMetadata = Some(SyndicationUsageMetadata(
-        partnerName = "friends of ours"
+        partnerName = "friends of ours",
+        syndicatedBy = Some("Bob")
       )),
       frontUsageMetadata = Some(FrontUsageMetadata(
         addedBy = "me",

common-lib/src/main/scala/com/gu/mediaservice/lib/elasticsearch/Mappings.scala

@@ -281,7 +281,8 @@ object Mappings {
   ))
 
   def syndicationUsageMetadata(name: String): ObjectField = nonDynamicObjectField(name).copy(properties = Seq(
-    keywordField("partnerName")
+    keywordField("partnerName"),
+    keywordField("syndicatedBy")
   ))
 
   def frontUsageMetadata(name: String): ObjectField = nonDynamicObjectField(name).copy(properties = Seq(
@@ -293,7 +294,7 @@ object Mappings {
     keywordField("downloadedBy")
   ))
 
-  def usagesMapping(name: String): NestedField = nestedField(name).copy( properties = Seq(
+  def usagesMapping(name: String): NestedField = nestedField(name).copy(properties = Seq(
     keywordField("id"),
     sStemmerAnalysed("title"),
     usageReference("references"),

common-lib/src/main/scala/com/gu/mediaservice/lib/usage/ItemToMediaUsage.scala

@@ -1,7 +1,6 @@
 package com.gu.mediaservice.lib.usage
 
 import java.net.URI
-
 import com.amazonaws.services.dynamodbv2.document.Item
 import com.gu.mediaservice.model.usage._
 import org.joda.time.DateTime
@@ -52,7 +51,8 @@ object ItemToMediaUsage {
   private def buildSyndication(metadataMap: Map[String, Any]): Option[SyndicationUsageMetadata] = {
     Try {
       SyndicationUsageMetadata(
-        metadataMap("partnerName").asInstanceOf[String]
+        metadataMap("partnerName").asInstanceOf[String],
+        metadataMap.get("syndicatedBy").map(x => x.asInstanceOf[String])
       )
     }.toOption
   }

common-lib/src/main/scala/com/gu/mediaservice/lib/usage/UsageBuilder.scala

@@ -64,7 +64,7 @@ object UsageBuilder {
   private def buildSyndicationUsageReference(usage: MediaUsage): List[UsageReference] = usage.syndicationUsageMetadata.map (metadata => {
     List(
       UsageReference(
-        SyndicationUsageReference, None, Some(metadata.partnerName)
+        SyndicationUsageReference, None, metadata.syndicatedBy.map(_ => s"${metadata.partnerName}, ${metadata.syndicatedBy.get}").orElse(Some(metadata.partnerName))
       )
     )
   }).getOrElse(

common-lib/src/main/scala/com/gu/mediaservice/model/ThrallMessage.scala

@@ -76,6 +76,7 @@ object ExternalThrallMessage{
   implicit val updateImagePhotoshootMetadataMessage = Json.format[UpdateImagePhotoshootMetadataMessage]
   implicit val deleteUsagesMessage = Json.format[DeleteUsagesMessage]
   implicit val deleteSingleUsageMessage = Json.format[DeleteSingleUsageMessage]
+  implicit val updateUsageStatusMessage = Json.format[UpdateUsageStatusMessage]
   implicit val updateImageUsagesMessage = Json.format[UpdateImageUsagesMessage]
   implicit val addImageLeaseMessage = Json.format[AddImageLeaseMessage]
   implicit val removeImageLeaseMessage = Json.format[RemoveImageLeaseMessage]
@@ -124,6 +125,8 @@ case class DeleteSingleUsageMessage(id: String, lastModified: DateTime, usageId:
 
 case class DeleteUsagesMessage(id: String, lastModified: DateTime) extends ExternalThrallMessage
 
+case class UpdateUsageStatusMessage(id: String, usageNotice: UsageNotice, lastModified: DateTime) extends ExternalThrallMessage
+
 object DeleteUsagesMessage {
   implicit val yourJodaDateReads = JodaReads.DefaultJodaDateTimeReads.map(d => d.withZone(DateTimeZone.UTC))
   implicit val yourJodaDateWrites = JodaWrites.JodaDateTimeWrites

common-lib/src/main/scala/com/gu/mediaservice/model/usage/SyndicationUsageMetadata.scala

@@ -3,11 +3,12 @@ package com.gu.mediaservice.model.usage
 import play.api.libs.json._
 
 case class SyndicationUsageMetadata(
-  partnerName: String
+  partnerName: String,
+  syndicatedBy: Option[String] = None
 ) extends UsageMetadata {
   override def toMap: Map[String, Any] = Map(
     "partnerName" -> partnerName
-  )
+  ) ++ syndicatedBy.map("syndicatedBy" -> _)
 }
 
 object SyndicationUsageMetadata {

common-lib/src/main/scala/com/gu/mediaservice/model/usage/UsageStatus.scala

@@ -9,6 +9,7 @@ sealed trait UsageStatus {
     case RemovedUsageStatus => "removed"
     case SyndicatedUsageStatus => "syndicated"
     case DownloadedUsageStatus => "downloaded"
+    case FailedUsageStatus => "failed"
     case UnknownUsageStatus => "unknown"
   }
 }
@@ -20,7 +21,9 @@ object UsageStatus {
     case "removed" => RemovedUsageStatus
     case "syndicated" => SyndicatedUsageStatus
     case "downloaded" => DownloadedUsageStatus
+    case "failed" => FailedUsageStatus
     case "unknown" => UnknownUsageStatus
+    case _ => throw new IllegalArgumentException("Invalid usage status")
   }
 
   implicit val reads: Reads[UsageStatus] = JsPath.read[String].map(UsageStatus(_))
@@ -35,6 +38,7 @@ object PublishedUsageStatus extends UsageStatus
 object RemovedUsageStatus extends UsageStatus
 object SyndicatedUsageStatus extends UsageStatus
 object DownloadedUsageStatus extends UsageStatus
+object FailedUsageStatus extends UsageStatus
 
 // For Fronts usages as we don't know if a front is in draft or is live
 // TODO remove this once we do!

common-lib/src/main/scala/com/gu/mediaservice/syntax/MessageSubjects.scala

@@ -16,6 +16,7 @@ trait MessageSubjects {
   val AddImageLease = "add-image-lease"
   val RemoveImageLease = "remove-image-lease"
   val SetImageCollections = "set-image-collections"
+  val UpdateUsageStatus = "update-usage-status"
   val DeleteUsages = "delete-usages"
   val DeleteSingleUsage = "delete-single-usage"
   val UpdateImageSyndicationMetadata = "update-image-syndication-metadata"

kahuna/public/js/components/gr-image-metadata/gr-image-metadata.html

@@ -104,6 +104,7 @@
                             <dd class="image-info__title"
                                 ng-if="!ctrl.hasMultipleValues(ctrl.rawMetadata.title)">
                                 <a ui-sref="search.results({query: (ctrl.metadata.title | queryFilter:'title'), nonFree: ctrl.srefNonfree()})"
+                                   ng-click="ctrl.searchWithModifiers($event, 'title', ctrl.metadata.title)"
                                    aria-label="Search images by {{ctrl.metadata.title}} title">{{ctrl.metadata.title}}</a>
                             </dd>
                         </div>
@@ -112,6 +113,7 @@
                             <dd class="image-info__title"
                                 ng-if="!ctrl.hasMultipleValues(ctrl.rawMetadata.title)">
                                 <a ui-sref="search.results({query: (ctrl.metadata.title | queryFilter:'title'), nonFree: ctrl.srefNonfree()})"
+                                   ng-click="ctrl.searchWithModifiers($event, 'title', ctrl.metadata.title)"
                                    aria-label="Search images by {{ctrl.metadata.title}} title">{{ctrl.metadata.title}}</a>
                             </dd>
                         </div>
@@ -322,6 +324,7 @@
                         <span class="metadata-line__info" ng-if="!ctrl.hasMultipleValues(ctrl.rawMetadata.byline)">
                             <span ng-if="ctrl.metadata.byline">
                                 <a ui-sref="search.results({query: (ctrl.metadata.byline | queryFilter:'by'), nonFree: ctrl.srefNonfree()})"
+                                   ng-click="ctrl.searchWithModifiers($event, 'by', ctrl.metadata.byline)"
                                    aria-label="Search images by {{ctrl.metadata.byline}} byline">{{ctrl.metadata.byline}}</a>
                             </span>
 
@@ -370,6 +373,7 @@
                         <span class="metadata-line__info" ng-if="!ctrl.hasMultipleValues(ctrl.rawMetadata.credit)">
                             <span ng-if="ctrl.metadata.credit">
                                 <a ui-sref="search.results({query: (ctrl.metadata.credit | queryFilter:'credit'), nonFree: ctrl.srefNonfree()})"
+                                   ng-click="ctrl.searchWithModifiers($event, 'credit', ctrl.metadata.credit)"
                                    aria-label="Search images by {{ctrl.metadata.credit}} credit">{{ctrl.metadata.credit}}</a>
                             </span>
 
@@ -400,6 +404,7 @@
                         <a
                             ng-if="!ctrl.hasMultipleValues(ctrl.rawMetadata[prop])"
                             ui-sref="search.results({query: (ctrl.metadata[prop] | queryFilter:ctrl.locationFieldMap[prop]), nonFree: ctrl.srefNonfree()})"
+                            ng-click="ctrl.searchWithModifiers($event, ctrl.locationFieldMap[prop], ctrl.metadata[prop])"
                             aria-label="Search images by {{ctrl.metadata[prop]}} {{prop}}"
                         >{{ctrl.metadata[prop]}}</a><span
                             ng-if="ctrl.hasMultipleValues(ctrl.rawMetadata[prop])"
@@ -538,6 +543,7 @@
                         <span class="metadata-line__info" ng-if="!ctrl.hasMultipleValues(ctrl.rawMetadata.copyright)">
                             <span ng-if="ctrl.metadata.copyright">
                                 <a ui-sref="search.results({query: (ctrl.metadata.copyright | queryFilter:'copyright'), nonFree: ctrl.srefNonfree()})"
+                                   ng-click="ctrl.searchWithModifiers($event, 'copyright', ctrl.metadata.copyright)"
                                    aria-label="Search images by {{ctrl.metadata.copyright}} copyright">{{ctrl.metadata.copyright}}</a>
                             </span>
 
@@ -559,6 +565,7 @@
             <dd ng-if="!ctrl.hasMultipleValues(ctrl.extraInfo.uploadedBy)" class="image-info__wrap metadata-line metadata-line__info image-info__group--dl__value--panel">
                 <span class="metadata-line__info">
                     <a ui-sref="search.results({query: (ctrl.extraInfo.uploadedBy | queryFilter:'uploader'), nonFree: ctrl.srefNonfree()})"
+                       ng-click="ctrl.searchWithModifiers($event, 'uploader', ctrl.extraInfo.uploadedBy)"
                        aria-label="Search images uploaded by {{ctrl.extraInfo.uploadedBy}}">{{ctrl.extraInfo.uploadedBy | stripEmailDomain}}</a>
                 </span>
             </dd>
@@ -639,6 +646,7 @@
                 <dt class="metadata-line__key image-info__group--dl__key--full-metadata">{{key | spaceWords}}</dt>
                 <dd class="metadata-line__info image-info__group--dl__value--full-metadata">
                 <a ui-sref="search.results({query: (value | queryFilter:'{{key}}'), nonFree: ctrl.srefNonfree()})"
+                ng-click="ctrl.searchWithModifiers($event, key, value)"
                 aria-label="Search images with {{key}} '{{value}}'">{{value}}</a>
                 </dd>
             </dl>
@@ -647,6 +655,7 @@
                 <dt class="metadata-line__key image-info__group--dl__key--full-metadata">{{key}}</dt>
                 <dd class="metadata-line__info image-info__group--dl__value--full-metadata">
                 <a ui-sref="search.results({query: (metadata.value | queryFilter:'{{metadata.alias}}'), nonFree: ctrl.srefNonfree()})"
+                ng-click="ctrl.searchWithModifiers($event, metadata.alias, metadata.value)"
                 aria-label="Search images with {{key}} '{{metadata.value}}'">{{metadata.value}}</a>
                 </dd>
             </dl>
@@ -832,6 +841,7 @@
                   ng-repeat="collection in ctrl.singleImage.data.collections"
                   ng-switch-default>
                 <a ui-sref="search.results({query: (collection.data.pathId | queryCollectionFilter), nonFree: ctrl.srefNonfree()})"
+                   ng-click="ctrl.searchWithModifiers($event, 'collection', collection.data.pathId)"
                    aria-label="Search images by {{collection.data.description}} collection">
                     {{collection.data.path.join(' ▸ ')}}
                 </a>