add "bookmarked" field to round mobile API - for lichess-org/mobile#15773

Author: ornicar

modules/bookmark/src/main/BookmarkApi.scala

@@ -17,20 +17,18 @@ final class BookmarkApi(
   private def exists(gameId: GameId, userId: UserId): Fu[Boolean] =
     coll.exists(selectId(gameId, userId))
 
-  def exists(game: Game, user: User): Fu[Boolean] =
-    if game.bookmarks > 0 then exists(game.id, user.id)
-    else fuFalse
+  def exists(game: Game, userId: UserId): Fu[Boolean] =
+    (game.bookmarks > 0).so(exists(game.id, userId))
 
-  def exists(game: Game, user: Option[User]): Fu[Boolean] =
+  def exists(game: Game, user: Option[UserId]): Fu[Boolean] =
     user.so { exists(game, _) }
 
   def filterGameIdsBookmarkedBy(games: Seq[Game], user: Option[User]): Fu[Set[GameId]] =
     user.so: u =>
       val candidateIds = games.collect { case g if g.bookmarks > 0 => g.id }
-      candidateIds.nonEmpty.so(
+      candidateIds.nonEmpty.so:
         coll.secondaryPreferred
           .distinctEasy[GameId, Set]("g", userIdQuery(u.id) ++ $doc("g".$in(candidateIds)))
-      )
 
   def removeByGameId(gameId: GameId): Funit =
     coll.delete.one($doc("g" -> gameId)).void

modules/bookmark/src/main/Env.scala

@@ -18,5 +18,7 @@ final class Env(
 
   lazy val api = wire[BookmarkApi]
 
+  def exists: lila.core.bookmark.BookmarkExists = api.exists
+
   lila.common.Bus.subscribeFun("roundUnplayed"):
     case lila.core.round.DeleteUnplayed(gameId) => api.removeByGameId(gameId)

modules/core/src/main/bookmark.scala

@@ -0,0 +1,4 @@
+package lila.core
+package bookmark
+
+type BookmarkExists = (game.Game, Option[userId.UserId]) => Fu[Boolean]

modules/round/src/main/Env.scala

@@ -47,6 +47,7 @@ final class Env(
     socketKit: lila.core.socket.ParallelSocketKit,
     userLagPut: lila.core.socket.userLag.Put,
     lightUserApi: lila.user.LightUserApi,
+    bookmarkExists: lila.core.bookmark.BookmarkExists,
     simulApiCircularDep: => lila.core.simul.SimulApi,
     settingStore: lila.memo.SettingStore.Builder,
     shutdown: akka.actor.CoordinatedShutdown

modules/round/src/main/RoundMobile.scala

@@ -12,12 +12,17 @@ import lila.round.RoundGame.*
 
 object RoundMobile:
 
-  enum UseCase(val socketStatus: Option[SocketStatus], val chat: Boolean, val prefs: Boolean):
+  enum UseCase(
+      val socketStatus: Option[SocketStatus],
+      val chat: Boolean,
+      val prefs: Boolean,
+      val bookmark: Boolean
+  ):
     // full round for every-day use
-    case Online(socket: SocketStatus) extends UseCase(socket.some, chat = true, prefs = true)
+    case Online(socket: SocketStatus) extends UseCase(socket.some, chat = true, prefs = true, bookmark = true)
     // correspondence game sent through firebase data
     // https://github.com/lichess-org/mobile/blob/main/lib/src/model/correspondence/offline_correspondence_game.dart
-    case Offline extends UseCase(none, chat = false, prefs = false)
+    case Offline extends UseCase(none, chat = false, prefs = false, bookmark = false)
 
 final class RoundMobile(
     lightUserGet: LightUser.Getter,
@@ -28,7 +33,8 @@ final class RoundMobile(
     takebacker: Takebacker,
     moretimer: Moretimer,
     isOfferingRematch: lila.core.round.IsOfferingRematch,
-    chatApi: lila.chat.ChatApi
+    chatApi: lila.chat.ChatApi,
+    bookmarkExists: lila.core.bookmark.BookmarkExists
 )(using Executor, lila.core.user.FlairGetMap):
 
   import RoundMobile.*
@@ -58,6 +64,7 @@ final class RoundMobile(
       moretimeable <- moretimer.isAllowedIn(game, Preload(prefs))
       chat         <- use.chat.so(getPlayerChat(game, myPlayer.exists(_.hasUser)))
       chatLines    <- chat.map(_.chat).soFu(lila.chat.JsonView.asyncLines)
+      bookmarked   <- use.bookmark.so(bookmarkExists(game, myPlayer.flatMap(_.userId)))
     yield
       def playerJson(color: Color) =
         val pov = Pov(game, color)
@@ -98,6 +105,7 @@ final class RoundMobile(
               .obj("lines" -> chatLines)
               .add("restricted", c.restricted)
         )
+        .add("bookmarked", bookmarked)
 
   private def prefsJson(game: Game, pref: Pref): JsObject = Json
     .obj(