TRELLO-2881 document endpoints (and remove some unused ones)

betagouv · Jan 28, 2025 · 1713b66 · 1713b66
1 parent 8bb2140
commit 1713b66
Show file tree

Hide file tree

Showing 10 changed files with 240 additions and 353 deletions.
diff --git a/app/controllers/StaticController.scala b/app/controllers/StaticController.scala
diff --git a/app/controllers/StatisticController.scala b/app/controllers/StatisticController.scala
@@ -74,34 +74,6 @@ class StatisticController(
       )
   }
 
-  def getPublicStatCount(publicStat: PublicStat) = IpRateLimitedAction2.async {
-    ((publicStat.filter, publicStat.percentageBaseFilter) match {
-      case (filter, Some(percentageBaseFilter)) =>
-        statsOrchestrator.getReportCountPercentageWithinReliableDates(None, filter, percentageBaseFilter)
-      case (filter, _) =>
-        statsOrchestrator.getReportCount(None, filter)
-    }).map(curve => Ok(Json.toJson(curve)))
-  }
-
-  def getPublicStatCurve(publicStat: PublicStat) = IpRateLimitedAction2.async {
-    ((publicStat.filter, publicStat.percentageBaseFilter) match {
-      case (filter, Some(percentageBaseFilter)) =>
-        statsOrchestrator.getReportsCountPercentageCurve(None, filter, percentageBaseFilter)
-      case (filter, _) =>
-        statsOrchestrator.getReportsCountCurve(None, filter)
-    }).map(curve => Ok(Json.toJson(curve)))
-  }
-
-  def getDelayReportReadInHours(companyId: Option[UUID]) = SecuredAction
-    .andThen(
-      WithRole(UserRole.AdminsAndReadOnlyAndCCRF)
-    )
-    .async {
-      statsOrchestrator
-        .getReadAvgDelay(companyId)
-        .map(count => Ok(Json.toJson(StatsValue(count.map(_.toHours.toInt)))))
-    }
-
   def getDelayReportResponseInHours(companyId: Option[UUID]) = SecuredAction.async { request =>
     statsOrchestrator
       .getResponseAvgDelay(companyId: Option[UUID], request.identity.userRole)

diff --git a/app/controllers/package.scala b/app/controllers/package.scala
@@ -10,7 +10,6 @@ import play.api.mvc.PathBindable
 import play.api.mvc.QueryStringBindable
 import play.api.mvc.Request
 import cats.syntax.either._
-import models.PublicStat
 import models.extractUUID
 import models.report.ReportFileOrigin
 import models.report.ReportResponseType
@@ -91,13 +90,6 @@ package object controllers {
         reportAdminActionType => reportAdminActionType.entryName
       )
 
-  implicit val PublicStatQueryStringBindable: QueryStringBindable[PublicStat] =
-    QueryStringBindable.bindableString
-      .transform[PublicStat](
-        publicStat => PublicStat.withNameInsensitive(publicStat),
-        publicStat => publicStat.entryName
-      )
-
   implicit class RequestOps[T <: JsValue](request: Request[T])(implicit ec: ExecutionContext) {
     def parseBody[B](path: JsPath = JsPath())(implicit reads: Reads[B]) = request.body
       .validate[B](path.read[B])

diff --git a/app/loader/SignalConsoApplicationLoader.scala b/app/loader/SignalConsoApplicationLoader.scala
@@ -895,8 +895,6 @@ class SignalConsoComponents(
       controllerComponents
     )
 
-  val staticController = new StaticController(cookieAuthenticator, controllerComponents)
-
   val statisticController = new StatisticController(statsOrchestrator, cookieAuthenticator, controllerComponents)
 
   val subscriptionOrchestrator = new SubscriptionOrchestrator(subscriptionRepository)
@@ -948,38 +946,37 @@ class SignalConsoComponents(
     new _root_.router.Routes(
       httpErrorHandler,
       new HealthController(controllerComponents),
-      staticController,
-      statisticController,
-      companyAccessController,
-      reportListController,
-      reportFileController,
+      assets,
       reportController,
+      socialNetworkController,
+      barcodeController,
       reportConsumerReviewController,
-      eventsController,
+      engagementController,
+      emailValidationController,
+      ratingController,
+      constantController,
+      reportListController,
       bookmarkController,
-      reportToExternalController,
-      dataEconomieController,
-      adminController,
       asyncFileController,
-      constantController,
-      socialNetworkController,
-      mobileAppController,
+      eventsController,
+      reportFileController,
+      adminController,
+      statisticController,
+      companyAccessController,
       authController,
       accountController,
-      emailValidationController,
+      blacklistedEmailsController,
       companyController,
-      ratingController,
+      importController,
+      reportBlockedNotificationController,
       subscriptionController,
       websiteController,
-      reportedPhoneController,
-      reportBlockedNotificationController,
-      blacklistedEmailsController,
-      signalConsoReviewController,
       siretExtractorController,
-      importController,
-      barcodeController,
-      engagementController,
-      assets
+      reportedPhoneController,
+      mobileAppController,
+      reportToExternalController,
+      dataEconomieController,
+      signalConsoReviewController
     )
 
   def scheduleTasks() = {

diff --git a/app/models/Statistics.scala b/app/models/Statistics.scala
@@ -1,14 +1,5 @@
 package models
 
-import enumeratum.EnumEntry
-import enumeratum.PlayEnum
-import models.report.ReportStatus.statusReadByPro
-import models.report.ReportStatus.statusWithProResponse
-import models.report.ReportFilter
-import models.report.ReportFilter.allReportsFilter
-import models.report.ReportFilter.transmittedReportsFilter
-import models.report.ReportStatus
-
 import java.time.LocalDate
 import play.api.libs.json.Json
 import play.api.libs.json.OFormat
@@ -37,32 +28,3 @@ case class ReportReviewStats(
 object ReportReviewStats {
   implicit val format: OFormat[ReportReviewStats] = Json.format[ReportReviewStats]
 }
-
-sealed abstract class PublicStat(val filter: ReportFilter, val percentageBaseFilter: Option[ReportFilter] = None)
-    extends EnumEntry
-
-object PublicStat extends PlayEnum[PublicStat] {
-  lazy val values = findValues
-  case object PromesseAction extends PublicStat(ReportFilter(status = Seq(ReportStatus.PromesseAction)))
-  case object Reports        extends PublicStat(allReportsFilter)
-  case object TransmittedPercentage
-      extends PublicStat(
-        transmittedReportsFilter,
-        Some(allReportsFilter)
-      )
-  case object ReadPercentage
-      extends PublicStat(
-        ReportFilter(status = statusReadByPro),
-        Some(transmittedReportsFilter)
-      )
-  case object ResponsePercentage
-      extends PublicStat(
-        ReportFilter(status = statusWithProResponse),
-        Some(ReadPercentage.filter)
-      )
-  case object WebsitePercentage
-      extends PublicStat(
-        ReportFilter(hasWebsite = Some(true)),
-        Some(allReportsFilter)
-      )
-}
diff --git a/app/orchestrators/StatsOrchestrator.scala b/app/orchestrators/StatsOrchestrator.scala
@@ -13,7 +13,6 @@ import models.report.delete.ReportAdminActionType
 import models.report.review.ResponseEvaluation
 import orchestrators.StatsOrchestrator.computeStartingDate
 import orchestrators.StatsOrchestrator.formatStatData
-import orchestrators.StatsOrchestrator.restrictToReliableDates
 import orchestrators.StatsOrchestrator.toPercentage
 import repositories.accesstoken.AccessTokenRepositoryInterface
 import repositories.event.EventRepositoryInterface
@@ -126,17 +125,6 @@ class StatsOrchestrator(
       baseCount <- reportRepository.count(user, basePercentageFilter)
     } yield toPercentage(count, baseCount)
 
-  def getReportCountPercentageWithinReliableDates(
-      user: Option[User],
-      filter: ReportFilter,
-      basePercentageFilter: ReportFilter
-  ): Future[Int] =
-    getReportCountPercentage(
-      user,
-      restrictToReliableDates(filter),
-      restrictToReliableDates(basePercentageFilter)
-    )
-
   def getReportsCountCurve(
       user: Option[User],
       reportFilter: ReportFilter,
@@ -149,21 +137,6 @@ class StatsOrchestrator(
       case CurveTickDuration.Day   => reportRepository.getDailyCount(user, reportFilter, ticks)
     }
 
-  def getReportsCountPercentageCurve(
-      user: Option[User],
-      reportFilter: ReportFilter,
-      baseFilter: ReportFilter
-  ): Future[Seq[CountByDate]] =
-    for {
-      rawCurve  <- getReportsCountCurve(user, reportFilter)
-      baseCurve <- getReportsCountCurve(user, baseFilter)
-    } yield rawCurve.sortBy(_.date).zip(baseCurve.sortBy(_.date)).map { case (a, b) =>
-      CountByDate(
-        count = toPercentage(a.count, b.count),
-        date = a.date
-      )
-    }
-
   def getReportsTagsDistribution(companyId: Option[UUID], user: User): Future[Map[ReportTag, Int]] =
     reportRepository.getReportsTagsDistribution(companyId, user)
 
@@ -195,9 +168,6 @@ class StatsOrchestrator(
       }
     }
 
-  def getReadAvgDelay(companyId: Option[UUID] = None) =
-    eventRepository.getAvgTimeUntilEvent(ActionEvent.REPORT_READING_BY_PRO, companyId)
-
   def getResponseAvgDelay(companyId: Option[UUID] = None, userRole: UserRole): Future[Option[Duration]] = {
     val onlyProShareable = userRole == UserRole.Professionnel
     eventRepository.getAvgTimeUntilEvent(

diff --git a/app/views/api.scala.html b/app/views/api.scala.html
diff --git a/build.sbt b/build.sbt
@@ -39,7 +39,6 @@ routesImport ++= Seq(
   "models.report.reportfile.ReportFileId",
   "models.report.ReportResponseType",
   "models.report.delete.ReportAdminActionType",
-  "models.PublicStat",
   "controllers.IdentificationStatusQueryStringBindable",
   "controllers.WebsiteIdPathBindable",
   "controllers.UUIDPathBindable",
@@ -48,8 +47,7 @@ routesImport ++= Seq(
   "controllers.ReportFileIdPathBindable",
   "controllers.ReportResponseTypeQueryStringBindable",
   "controllers.ReportAdminActionTypeQueryStringBindable",
-  "controllers.ReportFileOriginQueryStringBindable",
-  "controllers.PublicStatQueryStringBindable"
+  "controllers.ReportFileOriginQueryStringBindable"
 )
 
 semanticdbVersion := scalafixSemanticdb.revision