Skip to content

Commit

Permalink
refactor: Move Group update from responder to services (DEV-3292) (#3194
Browse files Browse the repository at this point in the history 
)
  • Loading branch information
@mpro7
mpro7 authored Apr 17, 2024
1 parent 7a1ae2c commit 682f5b6
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 44 deletions.
46 changes: 23 additions & 23 deletions integration/src/test/scala/org/knora/webapi/responders/admin/GroupsResponderADMSpec.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,9 @@ class GroupsResponderADMSpec extends CoreSpec {

"UPDATE a group" in {
val response = UnsafeZioRun.runOrThrow(
ZIO.serviceWithZIO[GroupsResponderADM](
_.updateGroup(
groupIri = GroupIri.unsafeFrom(newGroupIri.get),
groupRestService(
_.putGroup(
GroupIri.unsafeFrom(newGroupIri.get),
GroupUpdateRequest(
name = Some(GroupName.unsafeFrom("UpdatedGroupName")),
descriptions = Some(
Expand All @@ -140,26 +140,26 @@ class GroupsResponderADMSpec extends CoreSpec {
status = Some(GroupStatus.active),
selfjoin = Some(GroupSelfJoin.disabled),
),
UUID.randomUUID,
rootUser,
),
),
)
val updatedGroupInfo = response.group
updatedGroupInfo.name should equal("UpdatedGroupName")
updatedGroupInfo.descriptions should equal(
val group = response.group
group.name should equal("UpdatedGroupName")
group.descriptions should equal(
Seq(StringLiteralV2.from("""UpdatedDescription with "quotes" and <html tag>""", Some("en"))),
)
updatedGroupInfo.project should equal(Some(imagesProject))
updatedGroupInfo.status should equal(true)
updatedGroupInfo.selfjoin should equal(false)
group.project should equal(Some(imagesProjectExternal))
group.status should equal(true)
group.selfjoin should equal(false)
}

"return 'NotFound' if a not-existing group IRI is submitted during update" in {
val groupIri = "http://rdfh.ch/groups/0000/notexisting"
val exit = UnsafeZioRun.run(
ZIO.serviceWithZIO[GroupsResponderADM](
_.updateGroup(
groupIri = GroupIri.unsafeFrom(groupIri),
groupRestService(
_.putGroup(
GroupIri.unsafeFrom(groupIri),
GroupUpdateRequest(
name = Some(GroupName.unsafeFrom("UpdatedGroupName")),
descriptions = Some(
Expand All @@ -169,21 +169,21 @@ class GroupsResponderADMSpec extends CoreSpec {
status = Some(GroupStatus.active),
selfjoin = Some(GroupSelfJoin.disabled),
),
UUID.randomUUID,
rootUser,
),
),
)
assertFailsWithA[NotFoundException](
exit,
s"Group <$groupIri> not found. Aborting update request.",
s"Group <$groupIri> not found.",
)
}

"return 'BadRequest' if the new group name already exists inside the project" in {
"return 'DuplicateValueException' if the new group name already exists inside the project" in {
val groupName = GroupName.unsafeFrom("Image reviewer")
val exit = UnsafeZioRun.run(
ZIO.serviceWithZIO[GroupsResponderADM](
_.updateGroup(
groupRestService(
_.putGroup(
GroupIri.unsafeFrom(newGroupIri.get),
GroupUpdateRequest(
name = Some(groupName),
Expand All @@ -194,23 +194,23 @@ class GroupsResponderADMSpec extends CoreSpec {
status = Some(GroupStatus.active),
selfjoin = Some(GroupSelfJoin.disabled),
),
UUID.randomUUID,
rootUser,
),
),
)
assertFailsWithA[BadRequestException](
assertFailsWithA[DuplicateValueException](
exit,
s"Group with name: '${groupName.value}' already exists.",
)
}

"return 'BadRequest' if nothing would be changed during the update" in {
val exit = UnsafeZioRun.run(
ZIO.serviceWithZIO[GroupsResponderADM](
_.updateGroup(
groupRestService(
_.putGroup(
GroupIri.unsafeFrom(newGroupIri.get),
GroupUpdateRequest(None, None, None, None),
UUID.randomUUID,
rootUser,
),
),
)
Expand Down
19 changes: 0 additions & 19 deletions webapi/src/main/scala/org/knora/webapi/responders/admin/GroupsResponderADM.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,25 +181,6 @@ final case class GroupsResponderADM(
def groupMembersGetRequest(iri: GroupIri, user: User): Task[GroupMembersGetResponseADM] =
groupMembersGetADM(iri.value, user).map(GroupMembersGetResponseADM.apply)

/**
* Change group's basic information.
*
* @param groupIri the IRI of the group we want to change.
* @param request the change request.
* @param apiRequestID the unique request ID.
* @return a [[GroupGetResponseADM]].
*/
def updateGroup(
groupIri: GroupIri,
request: GroupUpdateRequest,
apiRequestID: UUID,
): Task[GroupGetResponseADM] = {
val task = for {
result <- updateGroupHelper(groupIri, request)
} yield result
IriLocker.runWithIriLock(apiRequestID, groupIri.value, task)
}

/**
* Change group's status.
*
Expand Down
10 changes: 8 additions & 2 deletions webapi/src/main/scala/org/knora/webapi/slice/admin/api/service/GroupRestService.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ package org.knora.webapi.slice.admin.api.service

import zio._

import dsp.errors.BadRequestException
import dsp.errors.NotFoundException
import org.knora.webapi.messages.admin.responder.groupsmessages._
import org.knora.webapi.messages.admin.responder.usersmessages.GroupMembersGetResponseADM
Expand Down Expand Up @@ -61,9 +62,14 @@ final case class GroupRestService(

def putGroup(iri: GroupIri, request: GroupUpdateRequest, user: User): Task[GroupGetResponseADM] =
for {
_ <- ZIO
.fail(BadRequestException("No data would be changed. Aborting update request."))
.when(List(request.name, request.descriptions, request.status, request.selfjoin).flatten.isEmpty)
groupToUpdate <- groupService
.findById(iri)
.someOrFail(NotFoundException(s"Group <${iri.value}> not found."))
_ <- auth.ensureSystemAdminOrProjectAdminOfGroup(user, iri)
uuid <- Random.nextUUID
internal <- responder.updateGroup(iri, request, uuid)
internal <- groupService.updateGroup(groupToUpdate, request).map(GroupGetResponseADM.apply)
external <- format.toExternalADM(internal)
} yield external

Expand Down
19 changes: 19 additions & 0 deletions webapi/src/main/scala/org/knora/webapi/slice/admin/domain/service/GroupService.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,16 @@ import zio.ZIO
import zio._

import org.knora.webapi.slice.admin.api.GroupsRequests.GroupCreateRequest
import org.knora.webapi.slice.admin.api.GroupsRequests.GroupUpdateRequest
import org.knora.webapi.slice.admin.domain.model.Group
import org.knora.webapi.slice.admin.domain.model.GroupDescriptions
import org.knora.webapi.slice.admin.domain.model.GroupIri
import org.knora.webapi.slice.admin.domain.model.GroupName
import org.knora.webapi.slice.admin.domain.model.GroupSelfJoin
import org.knora.webapi.slice.admin.domain.model.GroupStatus
import org.knora.webapi.slice.admin.domain.model.KnoraGroup
import org.knora.webapi.slice.admin.domain.model.KnoraProject
import org.knora.webapi.slice.admin.domain.model.KnoraProject.ProjectIri

final case class GroupService(
private val knoraGroupService: KnoraGroupService,
Expand All @@ -39,8 +45,21 @@ final case class GroupService(
selfjoin = knoraGroup.hasSelfJoinEnabled.value,
)

private def toKnoraGroup(group: Group): KnoraGroup =
KnoraGroup(
id = GroupIri.unsafeFrom(group.id),
groupName = GroupName.unsafeFrom(group.name),
groupDescriptions = GroupDescriptions.unsafeFrom(group.descriptions),
status = GroupStatus.from(group.status),
belongsToProject = group.project.map(it => ProjectIri.unsafeFrom(it.id)),
hasSelfJoinEnabled = GroupSelfJoin.from(group.selfjoin),
)

def createGroup(request: GroupCreateRequest, project: KnoraProject): Task[Group] =
knoraGroupService.createGroup(request, project).flatMap(toGroup)

def updateGroup(groupToUpdate: Group, request: GroupUpdateRequest): Task[Group] =
knoraGroupService.updateGroup(toKnoraGroup(groupToUpdate), request).flatMap(toGroup)
}

object GroupService {
Expand Down
19 changes: 19 additions & 0 deletions webapi/src/main/scala/org/knora/webapi/slice/admin/domain/service/KnoraGroupService.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import zio.ZLayer
import dsp.errors.DuplicateValueException
import org.knora.webapi.responders.IriService
import org.knora.webapi.slice.admin.api.GroupsRequests.GroupCreateRequest
import org.knora.webapi.slice.admin.api.GroupsRequests.GroupUpdateRequest
import org.knora.webapi.slice.admin.domain.model.GroupIri
import org.knora.webapi.slice.admin.domain.model.GroupName
import org.knora.webapi.slice.admin.domain.model.KnoraGroup
Expand Down Expand Up @@ -47,6 +48,24 @@ case class KnoraGroupService(
_ <- knoraGroupRepo.save(group)
} yield group

def updateGroup(groupToUpdate: KnoraGroup, request: GroupUpdateRequest): Task[KnoraGroup] =
for {
_ <- request.name match {
case Some(value) => ensureGroupNameIsUnique(value)
case None => ZIO.unit
}

updatedGroup <-
knoraGroupRepo.save(
groupToUpdate.copy(
groupName = request.name.getOrElse(groupToUpdate.groupName),
groupDescriptions = request.descriptions.getOrElse(groupToUpdate.groupDescriptions),
status = request.status.getOrElse(groupToUpdate.status),
hasSelfJoinEnabled = request.selfjoin.getOrElse(groupToUpdate.hasSelfJoinEnabled),
),
)
} yield updatedGroup

private def ensureGroupNameIsUnique(name: GroupName) =
ZIO.whenZIO(knoraGroupRepo.existsByName(name)) {
ZIO.fail(DuplicateValueException(s"Group with name: '${name.value}' already exists."))
Expand Down

0 comments on commit 682f5b6

Please sign in to comment.