Support moving folders

Author: gunnarvelle

myndla-api/src/main/scala/no/ndla/myndlaapi/model/api/FolderDTO.scala

@@ -20,6 +20,7 @@ import sttp.tapir.Schema.annotations.description
 
 import java.util.UUID
 import no.ndla.common.DeriveHelpers
+import no.ndla.common.model.api.UpdateOrDelete
 
 case class OwnerDTO(
     @description("Name of the owner")
@@ -124,6 +125,8 @@ case class NewFolderDTO(
 )
 
 case class UpdatedFolderDTO(
+    @description("Id of parent folder")
+    parentId: UpdateOrDelete[String],
     @description("Folder name")
     name: Option[String],
     @description("Status of the folder (private, shared)")

myndla-api/src/main/scala/no/ndla/myndlaapi/service/FolderConverterService.scala

@@ -13,6 +13,7 @@ import com.typesafe.scalalogging.StrictLogging
 import no.ndla.common.{Clock, model}
 import no.ndla.common.errors.ValidationException
 import no.ndla.common.implicits.*
+import no.ndla.common.model.api.{Delete, Missing, UpdateWith}
 import no.ndla.common.model.api.myndla.UpdatedMyNDLAUserDTO
 import no.ndla.common.model.domain.myndla
 import no.ndla.common.model.domain.myndla.{
@@ -74,6 +75,14 @@ class FolderConverterService(using clock: Clock) extends StrictLogging {
   }
 
   def mergeFolder(existing: domain.Folder, updated: api.UpdatedFolderDTO): domain.Folder = {
+    val parentId = updated.parentId match {
+      case Delete            => None
+      case Missing           => existing.parentId
+      case UpdateWith(value) => toUUIDValidated(Some(value), "parentId") match {
+          case Success(uuid) => Some(uuid)
+          case failure       => throw failure.failed.get
+        }
+    }
     val name        = updated.name.getOrElse(existing.name)
     val status      = updated.status.flatMap(FolderStatus.valueOf).getOrElse(existing.status)
     val description = updated.description.orElse(existing.description)
@@ -90,7 +99,7 @@ class FolderConverterService(using clock: Clock) extends StrictLogging {
       resources = existing.resources,
       subfolders = existing.subfolders,
       feideId = existing.feideId,
-      parentId = existing.parentId,
+      parentId = parentId,
       name = name,
       status = status,
       rank = existing.rank,

myndla-api/src/test/scala/no/ndla/myndlaapi/service/FolderConverterServiceTest.scala

@@ -9,6 +9,7 @@
 package no.ndla.myndlaapi.service
 
 import no.ndla.common.model.NDLADate
+import no.ndla.common.model.api.{Delete, Missing, UpdateWith}
 import no.ndla.common.model.api.myndla.{MyNDLAGroupDTO, MyNDLAUserDTO, UpdatedMyNDLAUserDTO}
 import no.ndla.common.model.domain.ResourceType
 import no.ndla.common.model.domain.myndla.{FolderStatus, MyNDLAGroup, MyNDLAUser, UserRole}
@@ -253,14 +254,27 @@ class FolderConverterServiceTest extends UnitTestSuite with TestEnvironment {
       description = Some("hei"),
       user = None,
     )
-    val updatedWithData =
-      UpdatedFolderDTO(name = Some("newNamae"), status = Some("shared"), description = Some("halla"))
-    val updatedWithoutData     = UpdatedFolderDTO(name = None, status = None, description = None)
+    val updatedWithData = UpdatedFolderDTO(
+      parentId = Missing,
+      name = Some("newNamae"),
+      status = Some("shared"),
+      description = Some("halla"),
+    )
+    val updatedWithoutData     = UpdatedFolderDTO(parentId = Missing, name = None, status = None, description = None)
     val updatedWithGarbageData = UpdatedFolderDTO(
+      parentId = Missing,
       name = Some("huehueuheasdasd+++"),
       status = Some("det å joike er noe kult"),
       description = Some("jog ska visa deg garbage jog"),
     )
+    val newParentUUID        = UUID.randomUUID()
+    val updatedWithNewParent = UpdatedFolderDTO(
+      parentId = UpdateWith[String](newParentUUID.toString),
+      name = None,
+      status = None,
+      description = None,
+    )
+    val updatedWithNoParent = UpdatedFolderDTO(parentId = Delete, name = None, status = None, description = None)
 
     val expected1 =
       existing.copy(name = "newNamae", status = FolderStatus.SHARED, shared = Some(shared), description = Some("halla"))
@@ -270,14 +284,20 @@ class FolderConverterServiceTest extends UnitTestSuite with TestEnvironment {
       status = FolderStatus.PRIVATE,
       description = Some("jog ska visa deg garbage jog"),
     )
+    val expected4 = existing.copy(parentId = Some(newParentUUID))
+    val expected5 = existing.copy(parentId = None)
 
     val result1 = service.mergeFolder(existing, updatedWithData)
     val result2 = service.mergeFolder(existing, updatedWithoutData)
     val result3 = service.mergeFolder(existing, updatedWithGarbageData)
+    val result4 = service.mergeFolder(existing, updatedWithNewParent)
+    val result5 = service.mergeFolder(existing, updatedWithNoParent)
 
     result1 should be(expected1)
     result2 should be(expected2)
     result3 should be(expected3)
+    result4 should be(expected4)
+    result5 should be(expected5)
   }
 
   test("that mergeFolder works correctly for shared field and folder status update") {
@@ -302,8 +322,8 @@ class FolderConverterServiceTest extends UnitTestSuite with TestEnvironment {
     )
     val existingShared  = existingBase.copy(status = FolderStatus.SHARED, shared = Some(sharedBefore))
     val existingPrivate = existingBase.copy(status = FolderStatus.PRIVATE, shared = None)
-    val updatedShared   = UpdatedFolderDTO(name = None, status = Some("shared"), description = None)
-    val updatedPrivate  = UpdatedFolderDTO(name = None, status = Some("private"), description = None)
+    val updatedShared   = UpdatedFolderDTO(parentId = Missing, name = None, status = Some("shared"), description = None)
+    val updatedPrivate  = UpdatedFolderDTO(parentId = Missing, name = None, status = Some("private"), description = None)
     val expected1       = existingBase.copy(status = FolderStatus.SHARED, shared = Some(sharedBefore))
     val expected2       = existingBase.copy(status = FolderStatus.PRIVATE, shared = None)
     val expected3       = existingBase.copy(status = FolderStatus.SHARED, shared = Some(sharedNow))

myndla-api/src/test/scala/no/ndla/myndlaapi/service/FolderWriteServiceTest.scala

@@ -10,6 +10,7 @@ package no.ndla.myndlaapi.service
 
 import no.ndla.common.errors.{AccessDeniedException, ValidationException}
 import no.ndla.common.model.NDLADate
+import no.ndla.common.model.api.Missing
 import no.ndla.common.model.domain.ResourceType
 import no.ndla.common.model.domain.myndla.{FolderStatus, UserRole}
 import no.ndla.myndlaapi.TestData.{emptyDomainFolder, emptyDomainResource, emptyMyNDLAUser}
@@ -679,7 +680,7 @@ class FolderWriteServiceTest extends UnitTestSuite with TestEnvironment {
     val feideId      = "FEIDE"
     val folderId     = UUID.randomUUID()
     val parentId     = UUID.randomUUID()
-    val updateFolder = api.UpdatedFolderDTO(name = Some("asd"), status = None, description = None)
+    val updateFolder = api.UpdatedFolderDTO(parentId = Missing, name = Some("asd"), status = None, description = None)
 
     val existingFolder = domain.Folder(
       id = folderId,
@@ -742,7 +743,8 @@ class FolderWriteServiceTest extends UnitTestSuite with TestEnvironment {
     val feideId      = "FEIDE"
     val folderId     = UUID.randomUUID()
     val parentId     = UUID.randomUUID()
-    val updateFolder = api.UpdatedFolderDTO(name = None, status = Some("shared"), description = None)
+    val updateFolder =
+      api.UpdatedFolderDTO(parentId = Missing, name = None, status = Some("shared"), description = None)
 
     val existingFolder = domain.Folder(
       id = folderId,
@@ -981,7 +983,8 @@ class FolderWriteServiceTest extends UnitTestSuite with TestEnvironment {
     val myNDLAUser = emptyMyNDLAUser.copy(userRole = UserRole.STUDENT)
     when(userService.getOrCreateMyNDLAUserIfNotExist(any, any)(using any)).thenReturn(Success(myNDLAUser))
 
-    val updatedFolder   = api.UpdatedFolderDTO(name = None, status = Some("shared"), description = None)
+    val updatedFolder =
+      api.UpdatedFolderDTO(parentId = Missing, name = None, status = Some("shared"), description = None)
     val Failure(result) =
       service.isOperationAllowedOrAccessDenied("feideid", Some("accesstoken"), updatedFolder): @unchecked
     result.getMessage should be("You do not have necessary permissions to share folders.")
@@ -994,7 +997,7 @@ class FolderWriteServiceTest extends UnitTestSuite with TestEnvironment {
     when(userService.getOrCreateMyNDLAUserIfNotExist(any, any)(using any)).thenReturn(Success(myNDLAUser))
     when(configService.isMyNDLAWriteRestricted).thenReturn(Success(true))
 
-    val updatedFolder   = api.UpdatedFolderDTO(name = Some("asd"), status = None, description = None)
+    val updatedFolder   = api.UpdatedFolderDTO(parentId = Missing, name = Some("asd"), status = None, description = None)
     val Failure(result) =
       service.isOperationAllowedOrAccessDenied("feideid", Some("accesstoken"), updatedFolder): @unchecked
     result.getMessage should be("You do not have write access while write restriction is active.")
@@ -1005,7 +1008,7 @@ class FolderWriteServiceTest extends UnitTestSuite with TestEnvironment {
     when(userService.getOrCreateMyNDLAUserIfNotExist(any, any)(using any)).thenReturn(Success(myNDLAUser))
     when(configService.isMyNDLAWriteRestricted).thenReturn(Success(false))
 
-    val updatedFolder = api.UpdatedFolderDTO(name = Some("asd"), status = None, description = None)
+    val updatedFolder = api.UpdatedFolderDTO(parentId = Missing, name = Some("asd"), status = None, description = None)
     val result        = service.isOperationAllowedOrAccessDenied("feideid", Some("accesstoken"), updatedFolder)
     result.isSuccess should be(true)
   }
@@ -1015,10 +1018,12 @@ class FolderWriteServiceTest extends UnitTestSuite with TestEnvironment {
     when(userService.getOrCreateMyNDLAUserIfNotExist(any, any)(using any)).thenReturn(Success(myNDLAUser))
     when(configService.isMyNDLAWriteRestricted).thenReturn(Success(true))
 
-    val folderWithUpdatedName   = api.UpdatedFolderDTO(name = Some("asd"), status = None, description = None)
-    val folderWithUpdatedStatus = api.UpdatedFolderDTO(name = None, status = Some("shared"), description = None)
-    val result1                 = service.isOperationAllowedOrAccessDenied("feideid", Some("accesstoken"), folderWithUpdatedName)
-    val result2                 = service.isOperationAllowedOrAccessDenied("feideid", Some("accesstoken"), folderWithUpdatedStatus)
+    val folderWithUpdatedName =
+      api.UpdatedFolderDTO(parentId = Missing, name = Some("asd"), status = None, description = None)
+    val folderWithUpdatedStatus =
+      api.UpdatedFolderDTO(parentId = Missing, name = None, status = Some("shared"), description = None)
+    val result1 = service.isOperationAllowedOrAccessDenied("feideid", Some("accesstoken"), folderWithUpdatedName)
+    val result2 = service.isOperationAllowedOrAccessDenied("feideid", Some("accesstoken"), folderWithUpdatedStatus)
     result1.isSuccess should be(true)
     result2.isSuccess should be(true)
   }