refactor: Wrapped id cc into Wrapper with companion objects

EpamLifeSciencesTeam · Mar 1, 2022 · 2f628d2 · 2f628d2
1 parent ac85bbc
commit 2f628d2
Show file tree

Hide file tree

Showing 54 changed files with 234 additions and 180 deletions.
diff --git a/controllers/src/main/scala/cromwell/pipeline/controller/ProjectConfigurationController.scala b/controllers/src/main/scala/cromwell/pipeline/controller/ProjectConfigurationController.scala
@@ -6,9 +6,10 @@ import akka.http.scaladsl.server.{ ExceptionHandler, Route }
 import cromwell.pipeline.controller.ProjectConfigurationController._
 import cromwell.pipeline.controller.utils.FromStringUnmarshallers._
 import cromwell.pipeline.controller.utils.FromUnitMarshaller._
-import cromwell.pipeline.controller.utils.PathMatchers.{ Path, ProjectId }
+import cromwell.pipeline.controller.utils.PathMatchers.{ Path, ProjectId => ProjectIdPM }
 import cromwell.pipeline.datastorage.dto._
 import cromwell.pipeline.datastorage.dto.auth.AccessTokenContent
+import cromwell.pipeline.model.wrapper.ProjectId
 import cromwell.pipeline.service.ProjectConfigurationService
 import cromwell.pipeline.service.ProjectConfigurationService.Exceptions._
 import de.heikoseeberger.akkahttpplayjson.PlayJsonSupport._
@@ -61,7 +62,7 @@ class ProjectConfigurationController(projectConfigurationService: ProjectConfigu
 
   val route: AccessTokenContent => Route = implicit accessToken =>
     handleExceptions(projectConfigurationServiceExceptionHandler) {
-      pathPrefix("projects" / ProjectId / "configurations") { projectId =>
+      pathPrefix("projects" / ProjectIdPM / "configurations") { projectId =>
         buildConfiguration(projectId) ~
         addConfiguration(projectId) ~
         getConfiguration(projectId) ~

diff --git a/controllers/src/main/scala/cromwell/pipeline/controller/ProjectFileController.scala b/controllers/src/main/scala/cromwell/pipeline/controller/ProjectFileController.scala
@@ -6,9 +6,10 @@ import akka.http.scaladsl.server.Route
 import akka.stream.Materializer
 import cromwell.pipeline.controller.utils.FieldUnmarshallers._
 import cromwell.pipeline.controller.utils.FromStringUnmarshallers._
-import cromwell.pipeline.controller.utils.PathMatchers.{ Path, ProjectId }
+import cromwell.pipeline.controller.utils.PathMatchers.{ Path, ProjectId => ProjectIdPM }
 import cromwell.pipeline.datastorage.dto._
 import cromwell.pipeline.datastorage.dto.auth.AccessTokenContent
+import cromwell.pipeline.model.wrapper.ProjectId
 import cromwell.pipeline.service.ProjectFileService
 import de.heikoseeberger.akkahttpplayjson.PlayJsonSupport._
 
@@ -99,7 +100,7 @@ class ProjectFileController(wdlService: ProjectFileService)(
 
   val route: AccessTokenContent => Route = implicit accessToken =>
     validateFile ~
-      pathPrefix("projects" / ProjectId / "files") { projectId =>
+      pathPrefix("projects" / ProjectIdPM / "files") { projectId =>
         getFile(projectId) ~
         getFiles(projectId) ~
         uploadFile(projectId) ~

diff --git a/controllers/src/main/scala/cromwell/pipeline/controller/RunController.scala b/controllers/src/main/scala/cromwell/pipeline/controller/RunController.scala
@@ -4,9 +4,10 @@ import akka.http.scaladsl.model.{ StatusCode, StatusCodes }
 import akka.http.scaladsl.server.Directives.{ entity, _ }
 import akka.http.scaladsl.server.{ ExceptionHandler, Route }
 import cromwell.pipeline.controller.RunController.runServiceExceptionHandler
-import cromwell.pipeline.controller.utils.PathMatchers.{ ProjectId, RunId }
+import cromwell.pipeline.controller.utils.PathMatchers.{ RunId, ProjectId => ProjectIdPM }
 import cromwell.pipeline.datastorage.dto._
 import cromwell.pipeline.datastorage.dto.auth.AccessTokenContent
+import cromwell.pipeline.model.wrapper.ProjectId
 import cromwell.pipeline.service.RunService
 import cromwell.pipeline.service.RunService.Exceptions.RunServiceException
 import de.heikoseeberger.akkahttpplayjson.PlayJsonSupport._
@@ -46,7 +47,7 @@ class RunController(runService: RunService) {
 
   val route: AccessTokenContent => Route = implicit accessToken =>
     handleExceptions(runServiceExceptionHandler) {
-      pathPrefix("projects" / ProjectId / "runs") { projectId =>
+      pathPrefix("projects" / ProjectIdPM / "runs") { projectId =>
         getRun(projectId) ~
         getRunsByProject(projectId) ~
         deleteRun(projectId) ~

diff --git a/controllers/src/main/scala/cromwell/pipeline/controller/utils/FromStringUnmarshallers.scala b/controllers/src/main/scala/cromwell/pipeline/controller/utils/FromStringUnmarshallers.scala
@@ -2,8 +2,9 @@ package cromwell.pipeline.controller.utils
 
 import akka.http.scaladsl.unmarshalling.Unmarshaller
 import cats.data.Validated
-import cromwell.pipeline.datastorage.dto.{ PipelineVersion, ProjectId }
-import cromwell.pipeline.model.wrapper.RunId
+import cromwell.pipeline.datastorage.dto.PipelineVersion
+import cromwell.pipeline.model.validator.Enable
+import cromwell.pipeline.model.wrapper.{ ProjectId, RunId }
 
 import java.nio.file.{ Path, Paths }
 
@@ -17,7 +18,7 @@ object FromStringUnmarshallers {
   }
   implicit val stringToProjectId: Unmarshaller[String, ProjectId] = Unmarshaller.strict[String, ProjectId] {
     projectId =>
-      ProjectId(projectId)
+      ProjectId(projectId, Enable.Unsafe)
   }
   implicit val stringToPath: Unmarshaller[String, Path] = Unmarshaller.strict[String, Path] { path =>
     Paths.get(path)

diff --git a/controllers/src/main/scala/cromwell/pipeline/controller/utils/PathMatchers.scala b/controllers/src/main/scala/cromwell/pipeline/controller/utils/PathMatchers.scala
@@ -2,13 +2,11 @@ package cromwell.pipeline.controller.utils
 
 import akka.http.scaladsl.server.PathMatcher1
 import akka.http.scaladsl.server.PathMatchers.Segment
-import cromwell.pipeline.datastorage.dto
 import cromwell.pipeline.model.wrapper
-
 import java.nio.file.{ Path, Paths }
 
 object PathMatchers {
-  val ProjectId: PathMatcher1[dto.ProjectId] = Segment.map(dto.ProjectId(_))
+  val ProjectId: PathMatcher1[wrapper.ProjectId] = Segment.flatMap(wrapper.ProjectId.from(_).toOption)
   val Path: PathMatcher1[Path] = Segment.map(Paths.get(_))
   val RunId: PathMatcher1[wrapper.RunId] = Segment.flatMap(wrapper.RunId.from(_).toOption)
   val ProjectSearchFilterId: PathMatcher1[wrapper.ProjectSearchFilterId] =

diff --git a/...lers/src/test/scala/cromwell/pipeline/controller/ProjectConfigurationControllerTest.scala b/...lers/src/test/scala/cromwell/pipeline/controller/ProjectConfigurationControllerTest.scala
@@ -5,6 +5,7 @@ import akka.http.scaladsl.testkit.ScalatestRouteTest
 import cromwell.pipeline.datastorage.dao.utils.{ TestProjectUtils, TestUserUtils }
 import cromwell.pipeline.datastorage.dto._
 import cromwell.pipeline.datastorage.dto.auth.AccessTokenContent
+import cromwell.pipeline.model.wrapper.ProjectConfigurationId
 import cromwell.pipeline.service.ProjectConfigurationService.Exceptions.{ InternalError, NotFound, ValidationError }
 import cromwell.pipeline.service.{ ProjectConfigurationService, VersioningException }
 import cromwell.pipeline.utils.URLEncoderUtils
@@ -46,21 +47,19 @@ class ProjectConfigurationControllerTest extends AsyncWordSpec with Matchers wit
 
       "return success for update configuration" in {
         when(configurationService.addConfiguration(configuration, accessToken.userId)).thenReturn(Future.unit)
-        Put(s"/projects/${projectId.value}/configurations", configurationAdditionRequest) ~> configurationController
-          .route(
-            accessToken
-          ) ~> check {
+        Put(s"/projects/$projectId/configurations", configurationAdditionRequest) ~> configurationController.route(
+          accessToken
+        ) ~> check {
           status shouldBe StatusCodes.NoContent
         }
       }
 
       "return InternalServerError when failure update configuration" in {
         val error = InternalError("Something went wrong")
         when(configurationService.addConfiguration(configuration, accessToken.userId)).thenReturn(Future.failed(error))
-        Put(s"/projects/${projectId.value}/configurations", configurationAdditionRequest) ~> configurationController
-          .route(
-            accessToken
-          ) ~> check {
+        Put(s"/projects/$projectId/configurations", configurationAdditionRequest) ~> configurationController.route(
+          accessToken
+        ) ~> check {
           status shouldBe StatusCodes.InternalServerError
           entityAs[String] shouldBe "Something went wrong"
         }
@@ -69,10 +68,9 @@ class ProjectConfigurationControllerTest extends AsyncWordSpec with Matchers wit
       "return NotFound when failure find project to update configuration" in {
         when(configurationService.addConfiguration(configuration, accessToken.userId))
           .thenReturn(Future.failed(NotFound()))
-        Put(s"/projects/${projectId.value}/configurations", configurationAdditionRequest) ~> configurationController
-          .route(
-            accessToken
-          ) ~> check {
+        Put(s"/projects/$projectId/configurations", configurationAdditionRequest) ~> configurationController.route(
+          accessToken
+        ) ~> check {
           status shouldBe StatusCodes.NotFound
         }
       }
@@ -82,18 +80,18 @@ class ProjectConfigurationControllerTest extends AsyncWordSpec with Matchers wit
       "return configuration by existing project id" in {
         when(configurationService.getLastByProjectId(projectId, accessToken.userId))
           .thenReturn(Future.successful(configuration))
-        Get(s"/projects/${projectId.value}/configurations") ~> configurationController.route(accessToken) ~> check {
+        Get(s"/projects/$projectId/configurations") ~> configurationController.route(accessToken) ~> check {
           status shouldBe StatusCodes.OK
           entityAs[ProjectConfiguration] shouldBe configuration
         }
       }
 
       "return Configuration not found message" in {
         when(configurationService.getLastByProjectId(projectId, accessToken.userId))
-          .thenReturn(Future.failed(NotFound(s"There is no configuration with project_id: ${projectId.value}")))
-        Get(s"/projects/${projectId.value}/configurations") ~> configurationController.route(accessToken) ~> check {
+          .thenReturn(Future.failed(NotFound(s"There is no configuration with project_id: $projectId")))
+        Get(s"/projects/$projectId/configurations") ~> configurationController.route(accessToken) ~> check {
           status shouldBe StatusCodes.NotFound
-          entityAs[String] shouldBe s"There is no configuration with project_id: ${projectId.value}"
+          entityAs[String] shouldBe s"There is no configuration with project_id: $projectId"
         }
       }
     }
@@ -103,15 +101,15 @@ class ProjectConfigurationControllerTest extends AsyncWordSpec with Matchers wit
 
       "return success for deactivate configuration" in {
         when(configurationService.deactivateLastByProjectId(projectId, accessToken.userId)).thenReturn(Future.unit)
-        Delete(s"/projects/${projectId.value}/configurations") ~> configurationController.route(accessToken) ~> check {
+        Delete(s"/projects/$projectId/configurations") ~> configurationController.route(accessToken) ~> check {
           status shouldBe StatusCodes.NoContent
         }
       }
 
       "return InternalServerError when failure deactivate configuration" in {
         when(configurationService.deactivateLastByProjectId(projectId, accessToken.userId))
           .thenReturn(Future.failed(error))
-        Delete(s"/projects/${projectId.value}/configurations") ~> configurationController.route(accessToken) ~> check {
+        Delete(s"/projects/$projectId/configurations") ~> configurationController.route(accessToken) ~> check {
           status shouldBe StatusCodes.InternalServerError
           entityAs[String] shouldBe "Something went wrong"
         }
@@ -120,7 +118,7 @@ class ProjectConfigurationControllerTest extends AsyncWordSpec with Matchers wit
       "return NotFound when failure find project to deactivate configuration" in {
         when(configurationService.deactivateLastByProjectId(projectId, accessToken.userId))
           .thenReturn(Future.failed(NotFound()))
-        Delete(s"/projects/${projectId.value}/configurations") ~> configurationController.route(accessToken) ~> check {
+        Delete(s"/projects/$projectId/configurations") ~> configurationController.route(accessToken) ~> check {
           status shouldBe StatusCodes.NotFound
         }
       }
@@ -131,7 +129,7 @@ class ProjectConfigurationControllerTest extends AsyncWordSpec with Matchers wit
       "return configuration for file" in {
         when(configurationService.buildConfiguration(projectId, path, versionOption, accessToken.userId))
           .thenReturn(Future.successful(configuration))
-        Get(s"/projects/${projectId.value}/configurations/files/$pathString?version=$versionString") ~>
+        Get(s"/projects/$projectId/configurations/files/$pathString?version=$versionString") ~>
         configurationController.route(accessToken) ~> check {
           status shouldBe StatusCodes.OK
           entityAs[ProjectConfiguration] shouldBe configuration
@@ -141,7 +139,7 @@ class ProjectConfigurationControllerTest extends AsyncWordSpec with Matchers wit
       "return failed for Bad request" in {
         when(configurationService.buildConfiguration(projectId, path, versionOption, accessToken.userId))
           .thenReturn(Future.failed(VersioningException.HttpException("Bad request")))
-        Get(s"/projects/${projectId.value}/configurations/files/$pathString?version=$versionString") ~>
+        Get(s"/projects/$projectId/configurations/files/$pathString?version=$versionString") ~>
         configurationController.route(accessToken) ~> check {
           status shouldBe StatusCodes.InternalServerError
           entityAs[String] shouldBe "Bad request"
@@ -151,7 +149,7 @@ class ProjectConfigurationControllerTest extends AsyncWordSpec with Matchers wit
       "return failed for invalid file" in {
         when(configurationService.buildConfiguration(projectId, path, versionOption, accessToken.userId))
           .thenReturn(Future.failed(ValidationError(List("invalid some field").mkString(","))))
-        Get(s"/projects/${projectId.value}/configurations/files/$pathString?version=$versionString") ~>
+        Get(s"/projects/$projectId/configurations/files/$pathString?version=$versionString") ~>
         configurationController.route(accessToken) ~> check {
           status shouldBe StatusCodes.UnprocessableEntity
           entityAs[String] shouldBe "invalid some field"

diff --git a/controllers/src/test/scala/cromwell/pipeline/controller/ProjectControllerTest.scala b/controllers/src/test/scala/cromwell/pipeline/controller/ProjectControllerTest.scala
@@ -60,7 +60,7 @@ class ProjectControllerTest extends AsyncWordSpec with Matchers with ScalatestRo
         when(projectService.getUserProjectById(dummyProject.projectId, accessToken.userId))
           .thenReturn(Future.successful(dummyProject))
 
-        Get(s"/projects/${dummyProject.projectId.value}") ~> projectController.route(accessToken) ~> check {
+        Get(s"/projects/${dummyProject.projectId}") ~> projectController.route(accessToken) ~> check {
           status shouldBe StatusCodes.OK
           responseAs[Project] shouldEqual dummyProject
         }
@@ -72,7 +72,7 @@ class ProjectControllerTest extends AsyncWordSpec with Matchers with ScalatestRo
         when(projectService.getUserProjectById(dummyProject.projectId, accessToken.userId))
           .thenReturn(Future.failed(error))
 
-        Get(s"/projects/${dummyProject.projectId.value}") ~> projectController.route(accessToken) ~> check {
+        Get(s"/projects/${dummyProject.projectId}") ~> projectController.route(accessToken) ~> check {
           status shouldBe StatusCodes.InternalServerError
         }
       }
@@ -131,7 +131,7 @@ class ProjectControllerTest extends AsyncWordSpec with Matchers with ScalatestRo
           projectService.deactivateProjectById(dummyProject.projectId, accessToken.userId)
         ).thenReturn(Future.successful(deactivatedProject))
 
-        Delete(s"/projects/${dummyProject.projectId.value}") ~> projectController.route(accessToken) ~> check {
+        Delete(s"/projects/${dummyProject.projectId}") ~> projectController.route(accessToken) ~> check {
           responseAs[Project] shouldBe deactivatedProject
         }
       }
@@ -142,7 +142,7 @@ class ProjectControllerTest extends AsyncWordSpec with Matchers with ScalatestRo
         when(projectService.deactivateProjectById(projectId, strangerAccessToken.userId))
           .thenReturn(Future.failed(InternalError()))
 
-        Delete(s"/projects/${projectId.value}") ~> projectController.route(strangerAccessToken) ~> check {
+        Delete(s"/projects/${projectId}") ~> projectController.route(strangerAccessToken) ~> check {
           status shouldBe StatusCodes.InternalServerError
         }
       }
@@ -155,7 +155,7 @@ class ProjectControllerTest extends AsyncWordSpec with Matchers with ScalatestRo
         when(projectService.updateProjectName(dummyProject.projectId, request, accessToken.userId))
           .thenReturn(Future.successful(dummyProject.projectId))
 
-        Put(s"/projects/${dummyProject.projectId.value}", request) ~> projectController.route(accessToken) ~> check {
+        Put(s"/projects/${dummyProject.projectId}", request) ~> projectController.route(accessToken) ~> check {
           status shouldBe StatusCodes.OK
         }
       }
@@ -166,7 +166,7 @@ class ProjectControllerTest extends AsyncWordSpec with Matchers with ScalatestRo
         when(projectService.updateProjectName(dummyProject.projectId, request, strangerAccessToken.userId))
           .thenReturn(Future.failed(InternalError()))
 
-        Put(s"/projects/${dummyProject.projectId.value}", request) ~> projectController.route(strangerAccessToken) ~> check {
+        Put(s"/projects/${dummyProject.projectId}", request) ~> projectController.route(strangerAccessToken) ~> check {
           status shouldBe StatusCodes.InternalServerError
         }
       }