Merge remote-tracking branch 'origin/main' into use-actual-time-in-code

Author: vlbee

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" }
 }

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

@@ -33,30 +33,57 @@ case object PreMatch extends MatchStatus { val status = "PRE_MATCH" }
 case object FirstHalf extends MatchStatus { val status = "FIRST_HALF" }
 case object HalfTime extends MatchStatus { val status = "HALF_TIME" }
 case object SecondHalf extends MatchStatus { val status = "SECOND_HALF" }
+case object ExtraTimeToBePlayed extends MatchStatus { val status = "EXTRA_TIME_TO_BE_PLAYED" }
 case object ExtraTimeFirstHalf extends MatchStatus { val status = "EXTRA_TIME_FIRST_HALF" }
 case object ExtraTimeHalfTime extends MatchStatus { val status = "EXTRA_TIME_HALF_TIME" }
 case object ExtraTimeSecondHalf extends MatchStatus { val status = "EXTRA_TIME_SECOND_HALF" }
+case object PenaltiesToBePlayed extends MatchStatus { val status = "PENALTIES_TO_BE_PLAYED" }
 case object Penalties extends MatchStatus { val status = "PENALTIES" }
 case object FullTime extends MatchStatus { val status = "FULL_TIME" }
 case object Postponed extends MatchStatus { val status = "POSTPONED" }
+case object Suspended extends MatchStatus { val status = "SUSPENDED" }
 case object Abandoned extends MatchStatus { val status = "ABANDONED" }
+case object Resumed extends MatchStatus { val status = "RESUMED" }
+case object Cancelled extends MatchStatus { val status = "CANCELLED" }
 // @formatter:on
 
 object MatchStatus {
-  def fromString(s: String): MatchStatus = s match {
-    case "Pre-match" | "prematch"                        => PreMatch
-    case "MatchInProgress" | "1st Half" | "first_half"   => FirstHalf
-    case "HalfTime" | "Half Time" | "half_time"          => HalfTime
-    case "2nd Half" | "second_half"                      => SecondHalf
-    case "Extra Time" | "ET 1st Half"                    => ExtraTimeFirstHalf
-    case "ET Half Time"                                  => ExtraTimeHalfTime
-    case "ET 2nd Half"                                   => ExtraTimeSecondHalf
-    case "Penalties"                                     => Penalties
-    case "MatchComplete" | "MC" | "Full Time" | "Result" => FullTime
-    case "Postponed"                                     => Postponed
-    case "Abandoned"                                     => Abandoned
-    case _                                               => Scheduled
-  }
+  def fromString(s: String): MatchStatus = statuses.getOrElse(s, Scheduled)
+
+  // How PA match status are handled here differs from push notification mappings
+  private val statuses: Map[String, MatchStatus] = Map(
+    ("Fixture", PreMatch), //
+    ("-", PreMatch), // seen in the wild
+    ("New", PreMatch), //
+
+    ("KO", FirstHalf), // The Match has started (Kicked Off).
+
+    ("HT", HalfTime), // The Referee has blown the whistle for Half Time.
+
+    ("SHS", SecondHalf), // The Second Half of the Match has Started.
+
+    ("FT", FullTime), // The Referee has blown the whistle for Full Time.
+    ("Result", FullTime), // The Result is official.
+    ("MC", FullTime), // Match has been Completed.
+
+    ("FTET", ExtraTimeToBePlayed), // Full Time, Extra Time it to be played.
+    ("ETS", ExtraTimeFirstHalf), // Extra Time has Started.
+    ("ETHT", ExtraTimeHalfTime), // Extra Time Half Time has been called.
+    ("ETSHS", ExtraTimeSecondHalf), // Extra Time, Second Half has Started.
+    ("ETFT", ExtraTimeSecondHalf), // Extra Time, Full Time has been blown.
+
+    ("FTPT", PenaltiesToBePlayed), // Full Time, Penalties are To be played.
+    ("ETFTPT", PenaltiesToBePlayed), // Extra Time, Full Time, Penalties are To be played.
+    ("PT", Penalties), // Penalty ShooT Out has started.
+    ("PTFT", Penalties), // Penalty ShooT Full Time.
+
+    // edge cases
+    ("Suspended", Suspended), // Match has been Suspended.
+    ("Resumed", Resumed), // Match has been Resumed. // todo can match phase be determined by match minute?
+    ("Abandoned", Abandoned), // Match has been Abandoned.
+    ("Postponed", Postponed), // A Match has been Postponed.
+    ("Cancelled", Cancelled) // A Match has been Cancelled.
+  )
 }
 
 case class Competition(
@@ -87,13 +114,13 @@ case class FootballMatchContentState(
     awayTeam: TeamState,
     competition: Competition,
     commentary: Option[String] = None,
-    lineupsAvailable: Option[Boolean] = None,
+    lineupsAvailable: Boolean = false,
     currentMinute: Option[Int] = None,
     currentPeriodStartTime: Option[Long] = None,
-    articleUrl: Option[String] = None
+    articleUrl: Option[String] = None,
+    matchInfoUrl: String
 ) extends ContentState
 
-
 object FootballContentJsonFormats {
   // MatchStatus format must be defined first since FootballMatchContentState depends on it
   implicit val matchStatusFormat: Format[MatchStatus] = Format(
@@ -105,13 +132,18 @@ object FootballContentJsonFormats {
           case "FIRST_HALF"             => JsSuccess(FirstHalf)
           case "HALF_TIME"              => JsSuccess(HalfTime)
           case "SECOND_HALF"            => JsSuccess(SecondHalf)
+          case "EXTRA_TIME_TO_BE_PLAYED" => JsSuccess(ExtraTimeToBePlayed)
           case "EXTRA_TIME_FIRST_HALF"  => JsSuccess(ExtraTimeFirstHalf)
           case "EXTRA_TIME_HALF_TIME"   => JsSuccess(ExtraTimeHalfTime)
           case "EXTRA_TIME_SECOND_HALF" => JsSuccess(ExtraTimeSecondHalf)
+          case "PENALTIES_TO_BE_PLAYED" => JsSuccess(PenaltiesToBePlayed)
           case "PENALTIES"              => JsSuccess(Penalties)
           case "FULL_TIME"              => JsSuccess(FullTime)
+          case "SUSPENDED"              => JsSuccess(Suspended)
+          case "RESUMED"                => JsSuccess(Resumed)
           case "POSTPONED"              => JsSuccess(Postponed)
           case "ABANDONED"              => JsSuccess(Abandoned)
+          case "CANCELLED"              => JsSuccess(Cancelled)
           case other                    => JsError(s"Unknown match status: $other")
         }
       case _ => JsError("Expected a JSON string for MatchStatus")

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

@@ -11,17 +11,22 @@ import com.gu.mobile.notifications.client.models.Payload
  * Channel Manager and Broadcast lambdas.
  **/
 
-sealed trait EventSource
-case object FootballLambda extends EventSource
+sealed trait EventSource {
+  def asString: String
+}
+case object FootballLambdaEventSource extends EventSource { val asString = "football-lambda" }
+case object ChannelManagerLambdaEventSource extends EventSource { val asString = "channel-manager-lambda" }
 
 object EventSource {
   implicit val format: Format[EventSource] = new Format[EventSource] {
     def writes(source: EventSource): JsValue = source match {
-      case FootballLambda => JsString("football-lambda")
+      case FootballLambdaEventSource => JsString("football-lambda")
+      case ChannelManagerLambdaEventSource => JsString("channel-manager-lambda")
     }
 
     def reads(json: JsValue): JsResult[EventSource] = json match {
-      case JsString("football-lambda") => JsSuccess(FootballLambda)
+      case JsString("football-lambda") => JsSuccess(FootballLambdaEventSource)
+      case JsString("channel-manager-lambda") => JsSuccess(ChannelManagerLambdaEventSource)
       case JsString(other)             => JsError(s"Invalid EventSource: $other")
       case _ => JsError("EventSource must be a string")
     }

build.sbt

@@ -248,33 +248,33 @@ lazy val apiModels = {
 
 def lambda(projectName: String, directoryName: String, mainClassName: Option[String] = None): Project =
   Project(projectName, file(directoryName))
-  .enablePlugins(AssemblyPlugin)
-  .settings(
-    organization := "com.gu",
-    resolvers ++= Seq(
-      "Guardian GitHub Releases" at "https://guardian.github.com/maven/repo-releases",
-      "snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"
-    ),
-    libraryDependencies ++= Seq(
-      "com.amazonaws" % "aws-lambda-java-core" % "1.4.0",
-      "org.slf4j" % "slf4j-api" % slf4jVersion,
-      "com.gu" %% "simple-configuration-core" % simpleConfigurationVersion,
-      "com.gu" %% "simple-configuration-ssm" % simpleConfigurationVersion,
-      "ch.qos.logback" % "logback-classic" % logbackVersion,
-      "net.logstash.logback" % "logstash-logback-encoder" % "8.1",
-      specs2 % Test
-    ),
-    assemblyJarName := s"$projectName.jar",
-    assembly / assemblyMergeStrategy := {
-      case "META-INF/MANIFEST.MF" => MergeStrategy.discard
-      case _ => MergeStrategy.first
-    },
-    Test / run / fork := true,
-    scalacOptions := compilerOptions,
-    mainClass := mainClassName,
-    // Workaround Mockito causes deadlock on SBT classloaders: https://github.com/sbt/sbt/issues/3022
-    Test / parallelExecution := false
-  )
+    .enablePlugins(AssemblyPlugin)
+    .settings(
+      organization := "com.gu",
+      resolvers ++= Seq(
+        "Guardian GitHub Releases" at "https://guardian.github.com/maven/repo-releases",
+        "snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"
+      ),
+      libraryDependencies ++= Seq(
+        "com.amazonaws" % "aws-lambda-java-core" % "1.4.0",
+        "org.slf4j" % "slf4j-api" % slf4jVersion,
+        "com.gu" %% "simple-configuration-core" % simpleConfigurationVersion,
+        "com.gu" %% "simple-configuration-ssm" % simpleConfigurationVersion,
+        "ch.qos.logback" % "logback-classic" % logbackVersion,
+        "net.logstash.logback" % "logstash-logback-encoder" % "8.1",
+        specs2 % Test
+      ),
+      assemblyJarName := s"$projectName.jar",
+      assembly / assemblyMergeStrategy := {
+        case "META-INF/MANIFEST.MF" => MergeStrategy.discard
+        case _ => MergeStrategy.first
+      },
+      Test / run / fork := true,
+      scalacOptions := compilerOptions,
+      mainClass := mainClassName,
+      // Workaround Mockito causes deadlock on SBT classloaders: https://github.com/sbt/sbt/issues/3022
+      Test / parallelExecution := false
+    )
 
 lazy val schedulelambda = lambda("schedule", "schedulelambda")
   .dependsOn(commonscheduledynamodb)
@@ -301,8 +301,16 @@ lazy val schedulelambda = lambda("schedule", "schedulelambda")
     )
   }
 
-lazy val football = lambda("football", "football")
+lazy val commonEventBusPusher = project
   .dependsOn(apiModels  % "test->test", apiModels  % "compile->compile")
+  .settings(Seq(
+    libraryDependencies ++= Seq(
+      "software.amazon.awssdk" % "eventbridge" % "2.20.162"
+    ),
+  ))
+
+lazy val football = lambda("football", "football")
+  .dependsOn(commonEventBusPusher)
   .settings(
     resolvers += "Guardian GitHub Releases" at "https://guardian.github.com/maven/repo-releases",
     libraryDependencies ++= Seq(
@@ -318,7 +326,6 @@ lazy val football = lambda("football", "football")
       "io.netty" % "netty-codec-http" % nettyVersion,
       "io.netty" % "netty-codec-http2" % nettyVersion,
       "io.netty" % "netty-common" % nettyVersion,
-      "software.amazon.awssdk" % "eventbridge" % "2.20.162"
     ),
     excludeDependencies ++= Seq(
       ExclusionRule("org.playframework", "play-ahc-ws_2.13"),
@@ -432,7 +439,7 @@ lazy val notificationworkerlambda = lambda("notificationworkerlambda", "notifica
       // Hopefully this workaround can be removed once play-json-extensions either updates to Play 3.0 or is merged into play-json
       ExclusionRule(organization = "com.typesafe.play")
     ),
-)
+  )
 
 lazy val fakebreakingnewslambda = lambda("fakebreakingnewslambda", "fakebreakingnewslambda", Some("fakebreakingnews.LocalRun"))
   .dependsOn(common)
@@ -462,7 +469,7 @@ lazy val reportExtractor = lambda("reportextractor", "reportextractor", Some("co
 
 lazy val liveactivities = lambda("liveactivities", "liveactivities", Some("com.gu.liveactivities.LambdaLocalRun"))
   .dependsOn(common)
-  .dependsOn(apiModels  % "test->test", apiModels  % "compile->compile")
+  .dependsOn(commonEventBusPusher)
   .settings(LocalDynamoDBLiveActivities.settings)
   .settings(
     libraryDependencies ++= Seq(

cdk/bin/cdk.ts

@@ -194,3 +194,10 @@ export const liveActivitiesCodeProps: GuStackProps = {
 };
 
 new LiveActivities(app, 'LiveActivities-CODE', liveActivitiesCodeProps);
+
+export const liveActivitiesProdProps: GuStackProps = {
+	stack: 'mobile-notifications',
+	stage: 'PROD',
+};
+
+new LiveActivities(app, 'LiveActivities-PROD', liveActivitiesProdProps);