tutor builder limiter

Author: ornicar

app/controllers/Clas.scala

@@ -121,7 +121,7 @@ final class Clas(env: Env, authC: Auth) extends LilaController(env):
       orDefault: Context => Fu[Result] = notFound(using _)
   )(using ctx: Context, me: Me): Fu[Result] =
     env.clas.api.clas
-      .isTeacherOf(me, id)
+      .isTeacherIn(me, id)
       .flatMap:
         if _ then forTeacher
         else

app/controllers/Tutor.scala

@@ -29,7 +29,7 @@ final class Tutor(env: Env) extends LilaController(env):
         case TutorAvailability.Available(home) =>
           home.previews.headOption.ifTrue(getBool("waiting") && home.awaiting.isEmpty) match
             case Some(done) => Redirect(done.config.url.root).toFuccess
-            case None => Ok.page(views.tutor.home(home, form))
+            case None => Ok.page(views.tutor.home(home, form, env.tutor.limit.status(user.id)))
     yield res
 
   def report(username: UserStr, range: String) = TutorReport(username, range) { _ ?=> full =>
@@ -73,9 +73,10 @@ final class Tutor(env: Env) extends LilaController(env):
             .get(config)
             .flatMap:
               case Some(report) => Redirect(report.url.root).toFuccess
-              case None =>
+              case _ if env.tutor.limit.zero(user.id)(true) =>
                 for _ <- env.tutor.queue.enqueue(config)
                 yield Redirect(routes.Tutor.user(user.username))
+              case _ => Redirect(routes.Tutor.user(user.username)).toFuccess
       )
   }
 

modules/clas/src/main/ClasApi.scala

@@ -94,7 +94,7 @@ final class ClasApi(
     def teachers(clas: Clas): Fu[List[User]] =
       userRepo.byOrderedIds(clas.teachers.toList, readPref = _.sec)
 
-    def isTeacherOf(teacher: User, clasId: ClasId): Fu[Boolean] =
+    def isTeacherIn(teacher: User, clasId: ClasId): Fu[Boolean] =
       Granter
         .of(_.Teacher)(teacher)
         .so:

modules/memo/src/main/RateLimit.scala

@@ -53,6 +53,8 @@ final class RateLimit[K](
   def zero[A](k: K, cost: Cost = 1, msg: => String = "")(op: => A)(using default: Zero[A]): A =
     apply[A](k, default.zero, cost, msg)(op)
 
+  def status(k: K) = Status(storage.getIfPresent(k).so(_._1), credits)
+
   def isLimited(k: K): Option[Instant] =
     enforce.yes
       .so(storage.getIfPresent(k))
@@ -75,6 +77,9 @@ object RateLimit:
 
   case class Limited(key: String, msg: String, until: Instant)
 
+  case class Status(used: Int, max: Int):
+    def reached = used >= max
+
   trait RateLimiter[K]:
     def apply[A](k: K, default: => A, cost: Cost = 1, msg: => String = "")(op: => A): A
     def chargeable[A](k: K, default: => A, cost: Cost = 1, msg: => String = "")(op: ChargeWith => A): A

modules/tutor/src/main/Env.scala

@@ -5,7 +5,7 @@ import com.softwaremill.tagging.*
 
 import lila.core.config
 import lila.core.fishnet.{ AnalysisAwaiter, FishnetRequest }
-import lila.memo.CacheApi
+import lila.memo.{ RateLimit, CacheApi }
 import lila.game.core.insight.InsightDb
 import lila.db.AsyncColl
 
@@ -23,7 +23,7 @@ final class Env(
     lightUserApi: lila.core.user.LightUserApi,
     msgApi: lila.core.msg.MsgApi,
     routeUrl: config.RouteUrl
-)(using Executor, Scheduler, play.api.Mode):
+)(using Executor, Scheduler, play.api.Mode, config.RateLimit):
 
   private val colls =
     TutorColls(insightDb(config.CollName("tutor_report")), insightDb(config.CollName("tutor_queue")))
@@ -46,6 +46,8 @@ final class Env(
 
   val api = wire[TutorApi]
 
+  val limit = RateLimit[UserId](credits = 1, duration = 24.hour, key = "tutor.user")
+
 final private class TutorColls(val report: AsyncColl, val queue: AsyncColl)
 trait NbAnalysis
 trait Parallelism

modules/tutor/src/main/ui/TutorHomeUi.scala

@@ -5,11 +5,12 @@ import play.api.data.Form
 
 import lila.ui.*
 import lila.ui.ScalatagsTemplate.{ *, given }
+import lila.memo.RateLimit
 
 final class TutorHomeUi(helpers: Helpers, bits: TutorBits, q: TutorQueueUi, rps: TutorReportsUi):
   import helpers.{ *, given }
 
-  def apply(home: TutorHome, form: Form[?])(using Context) =
+  def apply(home: TutorHome, form: Form[?], limit: RateLimit.Status)(using Context) =
     Page("Lichess Tutor")
       .css("tutor.home")
       .js(Esm("bits.flatpickr"))
@@ -18,7 +19,7 @@ final class TutorHomeUi(helpers: Helpers, bits: TutorBits, q: TutorQueueUi, rps:
         main(cls := "page page-small tutor tutor-home"):
           if home.previews.isEmpty
           then newUser(home)
-          else withReports(home, form)
+          else withReports(home, form, limit)
 
   private def newUser(home: TutorHome)(using Context) =
     import home.*
@@ -35,7 +36,7 @@ final class TutorHomeUi(helpers: Helpers, bits: TutorBits, q: TutorQueueUi, rps:
         )
     )
 
-  private def withReports(home: TutorHome, form: Form[?])(using Context) =
+  private def withReports(home: TutorHome, form: Form[?], limit: RateLimit.Status)(using Context) =
     import home.*
     awaiting match
       case Some(a) =>
@@ -58,7 +59,7 @@ final class TutorHomeUi(helpers: Helpers, bits: TutorBits, q: TutorQueueUi, rps:
               )
             )
           ),
-          rps.newForm(user, form),
+          rps.newForm(user, form, limit),
           rps.list(previews)
         )
 

modules/tutor/src/main/ui/TutorReportsUi.scala

@@ -7,17 +7,24 @@ import play.api.data.{ Form, Field }
 import lila.ui.*
 import lila.ui.ScalatagsTemplate.{ *, given }
 import lila.insight.MeanRating
+import lila.memo.RateLimit
 
 final class TutorReportsUi(helpers: Helpers, bits: TutorBits):
   import helpers.{ *, given }
 
-  def newForm(user: UserId, form: Form[?])(using Context) =
+  def newForm(user: UserId, form: Form[?], limit: RateLimit.Status)(using Context) =
     postForm(cls := "form3 tutor__report-form", action := routes.Tutor.compute(user.id)):
       form3.fieldset("Request a new Tutor report", toggle = form.globalError.isDefined.some)(
         form3.split(
           form3.group(form("from"), "Start date")(datePickr)(cls := "form-third"),
           form3.group(form("to"), "End date")(datePickr)(cls := "form-third"),
-          form3.submit("Compute my tutor report", icon = none)
+          div(cls := "form-group")(
+            span(cls := "tutor__report-form__limit")(s"${limit.used} / ${limit.max} daily reports used."),
+            form3.submit("Compute my tutor report", icon = none)(
+              limit.reached.option(disabled),
+              cls := limit.reached.option("disabled")
+            )
+          )
         ),
         form3.globalError(form)
       )

ui/tutor/css/_form.scss

@@ -9,4 +9,10 @@
   .form-group {
     margin: 0;
   }
+  &__limit {
+    display: block;
+    margin: 0 0 0.5em 0;
+    font-size: 0.9em;
+    color: $c-font-dim;
+  }
 }