Add Live Activity topics (#1773)

When a user is subscribed to a team, we will offer them a live activity
whenever that team is playing a match, as an alternative to push
notifications throughout the match. This live activity will be provided
via a single notification when the match starts, and users with app
versions that can support live activities will receive it by subscribing
to topics of type `FootballTeamLiveActivity`. Users with app versions
that do not support live activities will instead be subscribing to
topics of type `FootballTeam`, which will deliver notifications
throughout the match.

A user may visit a match info page before a live activity for that match
is available, as we only create it a couple of hours before the match
starts. We still want them to be able to subscribe and get that live
activity when it's ready, so we'll allow them to sign up to this
notification topic instead. The live activity will then be provided via
a single notification when the match starts. Users with app versions
that do not support live activities will instead be subscribing to
topics of type `FootballMatch`, which will deliver notifications
throughout the match.

This change adds two new `TopicType`s, `FootballTeamLiveActivity`
and `FootballMatchLiveActivity`, and includes them in the notification
payload for kick-off events only.

Author: JamieB-gu

api-models/src/main/scala/com/gu/mobile.notifications.client/models/Topic.scala

@@ -20,7 +20,30 @@ object TopicTypes {
   case object TagSeries extends TopicType { override val toString = "tag-series" }
   case object TagBlog extends TopicType { override val toString = "tag-blog" }
   case object FootballTeam extends TopicType { override val toString = "football-team" }
+  /**
+    * When a user is subscribed to a team, we will offer them a live activity
+    * whenever that team is playing a match, as an alternative to push
+    * notifications throughout the match. This live activity will be provided
+    * via a single notification when the match starts, and users with app
+    * versions that can support live activities will receive it by subscribing
+    * to topics of type `FootballTeamLiveActivity`. Users with app versions that
+    * do not support live activities will instead be subscribing to topics of
+    * type `FootballTeam`, which will deliver notifications throughout the
+    * match.
+    */
+  case object FootballTeamLiveActivity extends TopicType { override val toString = "football-team-live-activity" }
   case object FootballMatch extends TopicType { override val toString = "football-match" }
+  /**
+    * A user may visit a match info page before a live activity for that match
+    * is available, as we only create it a couple of hours before the match
+    * starts. We still want them to be able to subscribe and get that live
+    * activity when it's ready, so we'll allow them to sign up to this
+    * notification topic instead. The live activity will then be provided via a
+    * single notification when the match starts. Users with app versions that do
+    * not support live activities will instead be subscribing to topics of type
+    * `FootballMatch`, which will deliver notifications throughout the match.
+    */
+  case object FootballMatchLiveActivity extends TopicType { override val toString = "football-match-live-activity" }
   case object User extends TopicType { override val toString = "user-type" }
   case object Newsstand extends TopicType { override val toString = "newsstand" }
 }

football/src/main/scala/com/gu/mobile/notifications/football/notificationbuilders/MatchStatusNotificationBuilder.scala

@@ -17,11 +17,20 @@ class MatchStatusNotificationBuilder(mapiHost: String) {
     previousEvents: List[FootballMatchEvent],
     articleId: Option[String]
   ): FootballMatchStatusPayload = {
+    val liveActivityTopics =
+      if (triggeringEvent.isInstanceOf[KickOff])
+        List(
+          Topic(TopicTypes.FootballTeamLiveActivity, matchInfo.homeTeam.id),
+          Topic(TopicTypes.FootballTeamLiveActivity, matchInfo.awayTeam.id),
+          Topic(TopicTypes.FootballMatchLiveActivity, matchInfo.id)
+        )
+      else Nil
+  
     val topics = List(
       Topic(TopicTypes.FootballTeam, matchInfo.homeTeam.id),
       Topic(TopicTypes.FootballTeam, matchInfo.awayTeam.id),
       Topic(TopicTypes.FootballMatch, matchInfo.id)
-    )
+    ) ++ liveActivityTopics
 
     val allEvents = triggeringEvent :: previousEvents
     val goals = allEvents.collect { case g: Goal => g }

football/src/test/scala/com/gu/mobile/notifications/football/lib/EventConsumerSpec.scala

@@ -3,7 +3,7 @@ package com.gu.mobile.notifications.football.lib
 import java.net.URI
 import com.gu.mobile.notifications.client.models._
 import com.gu.mobile.notifications.client.models.Importance.{Major, Minor}
-import com.gu.mobile.notifications.client.models.TopicTypes.{FootballMatch, FootballTeam}
+import com.gu.mobile.notifications.client.models.TopicTypes.{FootballMatch, FootballTeam, FootballTeamLiveActivity, FootballMatchLiveActivity}
 import com.gu.mobile.notifications.client.models.liveActitivites.{CreateChannelEvent, EndLiveActivityEvent, LiveActivityPayload, StartLiveActivityEvent}
 import com.gu.mobile.notifications.football.models.{MatchDataWithArticle, PenaltyShootoutKick}
 import com.gu.mobile.notifications.football.notificationbuilders.{MatchStatusLiveActivityPayloadBuilder, MatchStatusNotificationBuilder}
@@ -47,7 +47,10 @@ class EventConsumerSpec(implicit ev: ExecutionEnv)
         topic = List(
           Topic(FootballTeam, "1006"),
           Topic(FootballTeam, "29"),
-          Topic(FootballMatch, "4011135")
+          Topic(FootballMatch, "4011135"),
+          Topic(FootballTeamLiveActivity, "1006"),
+          Topic(FootballTeamLiveActivity, "29"),
+          Topic(FootballMatchLiveActivity, "4011135"),
         ),
         matchStatus = "1st",
         eventId = "7e730fbe-b013-3a0e-89cb-12b46260d7be",