feat(dao): Apply a hierarchy filter when listing organizations

Extend the `OrganizationRepository.list()` function to support a
`HierarchyFiler`. This allows to query a specific set of organizations;
for instance, all those a user can access.

Signed-off-by: Oliver Heger <[email protected]>

Author: oheger-bosch

dao/src/main/kotlin/repositories/organization/DaoOrganizationRepository.kt

@@ -21,16 +21,20 @@ package org.eclipse.apoapsis.ortserver.dao.repositories.organization
 
 import org.eclipse.apoapsis.ortserver.dao.blockingQuery
 import org.eclipse.apoapsis.ortserver.dao.entityQuery
+import org.eclipse.apoapsis.ortserver.dao.utils.apply
 import org.eclipse.apoapsis.ortserver.dao.utils.applyRegex
+import org.eclipse.apoapsis.ortserver.dao.utils.extractIds
 import org.eclipse.apoapsis.ortserver.dao.utils.listQuery
+import org.eclipse.apoapsis.ortserver.model.CompoundHierarchyId
 import org.eclipse.apoapsis.ortserver.model.repositories.OrganizationRepository
 import org.eclipse.apoapsis.ortserver.model.util.FilterParameter
+import org.eclipse.apoapsis.ortserver.model.util.HierarchyFilter
 import org.eclipse.apoapsis.ortserver.model.util.ListQueryParameters
 import org.eclipse.apoapsis.ortserver.model.util.OptionalValue
 
 import org.jetbrains.exposed.sql.Database
 import org.jetbrains.exposed.sql.Op
-import org.jetbrains.exposed.sql.and
+import org.jetbrains.exposed.sql.SqlExpressionBuilder
 
 /**
  * An implementation of [OrganizationRepository] that stores organizations in [OrganizationsTable].
@@ -45,17 +49,17 @@ class DaoOrganizationRepository(private val db: Database) : OrganizationReposito
 
     override fun get(id: Long) = db.entityQuery { OrganizationDao[id].mapToModel() }
 
-    override fun list(parameters: ListQueryParameters, filter: FilterParameter?) =
+    override fun list(parameters: ListQueryParameters, nameFilter: FilterParameter?, hierarchyFilter: HierarchyFilter) =
         db.blockingQuery {
-            OrganizationDao.listQuery(parameters, OrganizationDao::mapToModel) {
-                var condition: Op<Boolean> = Op.TRUE
-                 filter?.let {
-                    condition = condition and OrganizationsTable.name.applyRegex(
-                       it.value
-                    )
-                }
-                condition
+            val nameCondition = nameFilter?.let {
+                OrganizationsTable.name.applyRegex(it.value)
+            } ?: Op.TRUE
+
+            val builder = hierarchyFilter.apply(nameCondition) { level, ids, filter ->
+                generateHierarchyCondition(level, ids, filter)
             }
+
+            OrganizationDao.listQuery(parameters, OrganizationDao::mapToModel, builder)
         }
 
     override fun update(id: Long, name: OptionalValue<String>, description: OptionalValue<String?>) = db.blockingQuery {
@@ -69,3 +73,21 @@ class DaoOrganizationRepository(private val db: Database) : OrganizationReposito
 
     override fun delete(id: Long) = db.blockingQuery { OrganizationDao[id].delete() }
 }
+
+/**
+ * Generate a condition defined by a [filter] for the given [level] and [ids].
+ */
+private fun SqlExpressionBuilder.generateHierarchyCondition(
+    level: Int,
+    ids: List<CompoundHierarchyId>,
+    filter: HierarchyFilter
+): Op<Boolean> =
+    when (level) {
+        CompoundHierarchyId.ORGANIZATION_LEVEL ->
+            OrganizationsTable.id inList (
+                ids.extractIds(CompoundHierarchyId.ORGANIZATION_LEVEL) +
+                    filter.nonTransitiveIncludes[CompoundHierarchyId.ORGANIZATION_LEVEL].orEmpty()
+                        .extractIds(CompoundHierarchyId.ORGANIZATION_LEVEL)
+            )
+        else -> Op.FALSE
+    }

dao/src/test/kotlin/repositories/organization/DaoOrganizationRepositoryTest.kt

@@ -25,8 +25,11 @@ import io.kotest.matchers.nulls.shouldNotBeNull
 import io.kotest.matchers.shouldBe
 
 import org.eclipse.apoapsis.ortserver.dao.test.DatabaseTestExtension
+import org.eclipse.apoapsis.ortserver.model.CompoundHierarchyId
 import org.eclipse.apoapsis.ortserver.model.Organization
+import org.eclipse.apoapsis.ortserver.model.OrganizationId
 import org.eclipse.apoapsis.ortserver.model.util.FilterParameter
+import org.eclipse.apoapsis.ortserver.model.util.HierarchyFilter
 import org.eclipse.apoapsis.ortserver.model.util.ListQueryParameters
 import org.eclipse.apoapsis.ortserver.model.util.ListQueryResult
 import org.eclipse.apoapsis.ortserver.model.util.OptionalValue
@@ -147,6 +150,48 @@ class DaoOrganizationRepositoryTest : StringSpec({
         )
     }
 
+    "list should apply a hierarchy filter" {
+        val createdOrg1 = organizationRepository.create("org1", "description1")
+        val org1Id = CompoundHierarchyId.forOrganization(OrganizationId(createdOrg1.id))
+        val createdOrg2 = organizationRepository.create("org2", "description2")
+        val org2Id = CompoundHierarchyId.forOrganization(OrganizationId(createdOrg2.id))
+        organizationRepository.create("org3", "description3")
+
+        val hierarchyFilter = HierarchyFilter(
+            transitiveIncludes = mapOf(CompoundHierarchyId.ORGANIZATION_LEVEL to listOf(org1Id, org2Id)),
+            nonTransitiveIncludes = emptyMap(),
+            excludes = emptyMap()
+        )
+        val result = organizationRepository.list(hierarchyFilter = hierarchyFilter)
+
+        result shouldBe ListQueryResult(
+            data = listOf(createdOrg1, createdOrg2),
+            params = ListQueryParameters.DEFAULT,
+            totalCount = 2
+        )
+    }
+
+    "list should apply a hierarchy filter with non-transitive includes" {
+        val createdOrg1 = organizationRepository.create("org1", "description1")
+        val org1Id = CompoundHierarchyId.forOrganization(OrganizationId(createdOrg1.id))
+        val createdOrg2 = organizationRepository.create("org2", "description2")
+        val org2Id = CompoundHierarchyId.forOrganization(OrganizationId(createdOrg2.id))
+        organizationRepository.create("org3", "description3")
+
+        val hierarchyFilter = HierarchyFilter(
+            transitiveIncludes = mapOf(CompoundHierarchyId.ORGANIZATION_LEVEL to listOf(org1Id)),
+            nonTransitiveIncludes = mapOf(CompoundHierarchyId.ORGANIZATION_LEVEL to listOf(org2Id)),
+            excludes = emptyMap()
+        )
+        val result = organizationRepository.list(hierarchyFilter = hierarchyFilter)
+
+        result shouldBe ListQueryResult(
+            data = listOf(createdOrg1, createdOrg2),
+            params = ListQueryParameters.DEFAULT,
+            totalCount = 2
+        )
+    }
+
     "update should update an entity in the database" {
         val createdOrg = organizationRepository.create("name", "description")
 

model/src/commonMain/kotlin/repositories/OrganizationRepository.kt

@@ -21,6 +21,7 @@ package org.eclipse.apoapsis.ortserver.model.repositories
 
 import org.eclipse.apoapsis.ortserver.model.Organization
 import org.eclipse.apoapsis.ortserver.model.util.FilterParameter
+import org.eclipse.apoapsis.ortserver.model.util.HierarchyFilter
 import org.eclipse.apoapsis.ortserver.model.util.ListQueryParameters
 import org.eclipse.apoapsis.ortserver.model.util.ListQueryResult
 import org.eclipse.apoapsis.ortserver.model.util.OptionalValue
@@ -40,11 +41,13 @@ interface OrganizationRepository {
     fun get(id: Long): Organization?
 
     /**
-     * List all organizations according to the given [parameters].
+     * List all organizations according to the given [parameters]. Optionally, a [nameFilter] on the product name and a
+     * [hierarchyFilter] can be provided.
      */
     fun list(
         parameters: ListQueryParameters = ListQueryParameters.DEFAULT,
-        filter: FilterParameter? = null
+        nameFilter: FilterParameter? = null,
+        hierarchyFilter: HierarchyFilter = HierarchyFilter.WILDCARD
     ): ListQueryResult<Organization>
 
     /**