1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2018 Make.org
4  *
5  * This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU Affero General Public License as
7  *  published by the Free Software Foundation, either version 3 of the
8  *  License, or (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU Affero General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Affero General Public License
16  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
17  *
18  */
19 
20 package org.make.api.technical.job
21 
22 import java.time.ZonedDateTime
23 import akka.http.scaladsl.server.{Directives, PathMatcher1, Route}
24 import enumeratum.{Circe, Enum, EnumEntry}
25 import io.circe.Encoder
26 import io.circe.generic.semiauto.deriveEncoder
27 import io.swagger.annotations._
28 import org.make.api.operation.OperationServiceComponent
29 import org.make.api.question.QuestionServiceComponent
30 
31 import javax.ws.rs.Path
32 import org.make.api.technical.MakeDirectives.MakeDirectivesDependencies
33 import org.make.api.technical.MakeAuthenticationDirectives
34 import org.make.api.technical.directives.FutureDirectivesExtensions._
35 import org.make.core.auth.UserRights
36 import org.make.core.job.Job
37 import org.make.core.job.Job.JobId
38 import org.make.core.job.Job.JobStatus._
39 import org.make.core.{CirceFormatters, HttpCodes}
40 import scalaoauth2.provider.AuthInfo
41 
42 import scala.annotation.meta.field
43 
44 @Api(value = "Admin Job")
45 @Path(value = "/admin/jobs")
46 trait JobApi extends Directives {
47 
48   @ApiOperation(
49     value = "get-job-status",
50     httpMethod = "GET",
51     code = HttpCodes.OK,
52     authorizations = Array(
53       new Authorization(
54         value = "MakeApi",
55         scopes = Array(new AuthorizationScope(scope = "admin", description = "BO Admin"))
56       )
57     )
58   )
59   @ApiImplicitParams(
60     value = Array(
61       new ApiImplicitParam(
62         name = "jobId",
63         paramType = "path",
64         dataType = "string",
65         allowableValues = JobId.swaggerAllowableValues
66       )
67     )
68   )
69   @ApiResponses(value = Array(new ApiResponse(code = HttpCodes.OK, message = "Ok", response = classOf[JobResponse])))
70   @Path(value = "/{jobId}")
71   def status: Route
72 
73   def routes: Route = status
74 
75 }
76 
77 trait JobApiComponent {
78   def jobApi: JobApi
79 }
80 
81 trait DefaultJobApiComponent extends JobApiComponent with MakeAuthenticationDirectives {
82   self: MakeDirectivesDependencies
83     with JobCoordinatorServiceComponent
84     with QuestionServiceComponent
85     with OperationServiceComponent =>
86   override lazy val jobApi: JobApi = new DefaultJobApi
87 
88   class DefaultJobApi extends JobApi {
89 
90     val jobId: PathMatcher1[JobId] = Segment.map(id => JobId(id))
91 
92     override def status: Route = get {
93       path("admin" / "jobs" / jobId) { id =>
94         makeOperation("GetJobStatus") { _ =>
95           makeOAuth2 { userAuth: AuthInfo[UserRights] =>
96             requireAdminRole(userAuth.user) {
97               jobCoordinatorService.get(id).asDirectiveOrNotFound { job =>
98                 complete(JobResponse(job))
99               }
100             }
101           }
102         }
103       }
104     }
105   }
106 }
107 
108 final case class JobResponse(
109   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
110   id: JobId,
111   createdAt: Option[ZonedDateTime],
112   updatedAt: Option[ZonedDateTime],
113   @(ApiModelProperty @field)(
114     dataType = "string",
115     allowableValues = JobResponse.Status.swaggerAllowableValues,
116     required = true
117   )
118   status: JobResponse.Status,
119   details: Option[String]
120 )
121 
122 object JobResponse extends CirceFormatters {
123 
124   def apply(job: Job): JobResponse = {
125     val (status, details) = job.status match {
126       case Running(progress) =>
127         (if (job.isStuck(Job.defaultHeartRate)) Status.Stuck else Status.Running, Some(s"progress = $progress%"))
128       case Finished(error @ Some(_)) =>
129         (Status.Failure, error)
130       case Finished(_) =>
131         (Status.Success, None)
132     }
133     JobResponse(job.id, job.createdAt, job.updatedAt, status, details)
134   }
135 
136   sealed abstract class Status extends EnumEntry with Product with Serializable
137 
138   object Status extends Enum[Status] {
139 
140     case object Running extends Status
141     case object Stuck extends Status
142     case object Success extends Status
143     case object Failure extends Status
144 
145     override val values: IndexedSeq[Status] = findValues
146     final val swaggerAllowableValues = "Running,Stuck,Success,Failure"
147 
148     implicit val encoder: Encoder[Status] = Circe.encoderLowercase(this)
149   }
150 
151   implicit val encoder: Encoder[JobResponse] = deriveEncoder
152 
153 }