Skip to content

Add optional title field to Topic case class on /device/register endpoint #1525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
michaelclapham merged 1 commit into from
Nov 17, 2025
Merged

Add optional title field to Topic case class on /device/register endpoint #1525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion common/src/main/scala/models/Topic.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import play.api.libs.json._
import cats.syntax.all._


case class Topic(`type`: TopicType, name: String) {
case class Topic(`type`: TopicType, name: String, title: Option[String] = None) {
override def toString: String = fullName
def toFirebaseString: String = toString.replaceAll("/", "%")
lazy val id: String = md5Hex(toString)
Expand Down
13 changes: 13 additions & 0 deletions registration/test/registration/controllers/MainControllerSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,19 @@ class MainControllerSpec extends PlaySpecification with JsonMatchers with Mockit
val Some(register) = route(app, FakeRequest(POST, "/legacy/device/register").withJsonBody(Json.parse(legacyAndroidRegistrationJson)))
status(register) must equalTo(BAD_REQUEST)
}

////// NEW ENDPOINT ///////

"new /device/register endpoint returns expected response" in new RegistrationsContext {
val Some(result) = route(app, FakeRequest(POST, "/device/register").withJsonBody(Json.parse(newRegistrationJson)))
println(Json.prettyPrint(Json.parse(contentAsString(result))))

status(result) must equalTo(OK)
contentAsString(result) must /("provider" -> "Guardian")
contentAsString(result) must /("deviceId" -> "TEST-TOKEN-ID")
contentAsString(result) must /("platform" -> "ios")
contentAsString(result) must (/("topics") andHave size(4))
}
}

trait RegistrationsContext extends RegistrationsBase with withMockedWSClient {
Expand Down
33 changes: 31 additions & 2 deletions registration/test/registration/controllers/RegistrationsFixtures.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@ import cats.syntax.all._
import com.gu.DevIdentity
import db.{DatabaseConfig, JdbcConfig, RegistrationService}
import doobie.util.transactor.Transactor
import error.NotificationsError
import models.Provider.Unknown
import models.TopicTypes.{Breaking, FootballMatch}
import models._
import play.api.ApplicationLoader.Context
import play.api.{BuiltInComponents, Logger, Configuration => PlayConfig}
import play.api.libs.ws.WSClient
import providers.ProviderError
import registration.RegistrationApplicationComponents
import registration.services.NotificationRegistrar.RegistrarResponse
import registration.services.topic.{TopicValidator, TopicValidatorError}
Expand Down Expand Up @@ -165,6 +163,37 @@ trait RegistrationsJson {
|}
""".stripMargin

val newRegistrationJson =
"""
|{
| "deviceToken": "TEST-TOKEN-ID",
| "platform": "ios",
| "buildTier": "debug",
| "appVersion": "1.0.0",
| "topics": [
| {
| "name": "4501006",
| "title": "Burnley vs Leeds (2025-10-18)",
| "type": "football-match"
| },
| {
| "name": "profile/jane-doe",
| "title": "Jane Doe",
| "type": "tag-contributor"
| },
| {
| "name": "uk-sport",
| "title": "UK sport notifications",
| "type": "breaking"
| },
| {
| "name": "uk",
| "type": "breaking"
| }
| ]
|}
""".stripMargin

val registrationJson =
"""
|{
Expand Down