Merge pull request #341 from nl-portal/feature/add-pagesize-to-openzaak

Feature/add pagesize to openzaak

Author: flinden68

gradle.properties

@@ -10,8 +10,8 @@ benManesVersionsVersion=0.51.0
 ktlintVersion=12.1.2
 spotlessVersion=6.25.0
 gradleDockerComposeVersion=0.17.12
-dokkaVersion=1.9.20
+dokkaVersion=2.0.0
 
 org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2048m
 org.gradle.workers.max=10
-version=1.4.35-SNAPSHOT
+version=1.4.36-SNAPSHOT

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

product/src/main/kotlin/nl/nlportal/product/domain/Product.kt

@@ -44,7 +44,8 @@ class Product(
     val eigenschappen: ObjectNode?,
     val parameters: ObjectNode?,
     @GraphQLIgnore
-    val taken: List<UUID>,
+    @Deprecated("will be removed in a future release.")
+    val taken: List<UUID>?,
     @GraphQLIgnore
     val zaken: List<UUID>,
     val documenten: List<String>,

product/src/main/kotlin/nl/nlportal/product/graphql/ProductQuery.kt

@@ -95,7 +95,8 @@ class ProductQuery(
             productName = productName,
             pageNumber = 1,
             isOpen = isOpen,
-        ).take(pageSize ?: 20)
+            pageSize = pageSize,
+        )
     }
 
     @GraphQLDescription("Get list of taken by product name ")

product/src/main/kotlin/nl/nlportal/product/service/ProductService.kt

@@ -145,6 +145,7 @@ class ProductService(
         productTypeId: UUID?,
         productName: String,
         pageNumber: Int,
+        pageSize: Int? = null,
         isOpen: Boolean? = null,
     ): List<Zaak> {
         val productType = getProductType(productTypeId, productName)
@@ -159,7 +160,7 @@ class ProductService(
                 .page(pageNumber)
                 .withAuthentication(authentication)
                 .ofZaakTypes(productType.zaaktypen.map { it })
-
+        pageSize?.let { request.pageSize(it) }
         isOpen?.let {
             request.isOpen(isOpen)
         }
@@ -195,10 +196,10 @@ class ProductService(
 
         val zaken =
             getProductZaken(
-                authentication,
-                productTypeId,
-                productName,
-                pageNumber,
+                authentication = authentication,
+                productTypeId = productTypeId,
+                productName = productName,
+                pageNumber = pageNumber,
             )
 
         val producten =

zgw/objectenapi/src/main/kotlin/nl/nlportal/zgw/objectenapi/domain/ObjectSearchParameter.kt

@@ -38,4 +38,5 @@ enum class Comparator(val value: String) {
     LOWER_THAN("lt"),
     LOWER_THAN_OR_EQUAL_TO("lte"),
     STRING_CONTAINS("icontains"),
+    IN_LIST("in"),
 }

zgw/zaken-api/src/main/kotlin/nl/nlportal/zakenapi/client/request/PagedRetrieve.kt

@@ -5,6 +5,8 @@ import nl.nlportal.zakenapi.domain.ResultPage
 interface PagedRetrieve<O : PagedRetrieve<O, T>, T> : Retrieve<ResultPage<T>> {
     fun page(page: Int): O
 
+    fun pageSize(pageSize: Int): O
+
     suspend fun retrieveAll(): List<T> {
         val results = mutableListOf<T>()
         do {

zgw/zaken-api/src/main/kotlin/nl/nlportal/zakenapi/client/request/ZaakObjectenImpl.kt

@@ -47,6 +47,11 @@ class SearchZaakObjectenImpl(val zakenApiClient: ZakenApiClient) : SearchZaakObj
         return this
     }
 
+    override fun pageSize(pageSize: Int): SearchZaakObjecten {
+        queryParams.add("pageSize", pageSize.toString())
+        return this
+    }
+
     override suspend fun retrieve(): ResultPage<ZaakObject> {
         return this.zakenApiClient.webClient.get()
             .uri { it.path("/zaken/api/v1/zaakobjecten").queryParams(queryParams).build() }

zgw/zaken-api/src/main/kotlin/nl/nlportal/zakenapi/client/request/ZaakRollenImpl.kt

@@ -67,6 +67,11 @@ class SearchRollenImpl(val zakenApiClient: ZakenApiClient) : SearchZaakRollen {
         return this
     }
 
+    override fun pageSize(page: Int): SearchZaakRollen {
+        queryParams.add("pageSize", page.toString())
+        return this
+    }
+
     override suspend fun retrieve(): ResultPage<ZaakRol> {
         return this.zakenApiClient.webClient.get()
             .uri { it.path("/zaken/api/v1/rollen").queryParams(queryParams).build() }

zgw/zaken-api/src/main/kotlin/nl/nlportal/zakenapi/client/request/ZaakStatussenImpl.kt

@@ -52,6 +52,11 @@ class SearchZaakStatussenImpl(val zakenApiClient: ZakenApiClient) : SearchZaakSt
         return this
     }
 
+    override fun pageSize(page: Int): SearchZaakStatussen {
+        queryParams.add("pageSize", page.toString())
+        return this
+    }
+
     override suspend fun retrieve(): ResultPage<ZaakStatus> {
         return this.zakenApiClient.webClient.get()
             .uri { it.path("/zaken/api/v1/statussen").queryParams(queryParams).build() }

zgw/zaken-api/src/main/kotlin/nl/nlportal/zakenapi/client/request/ZakenImpl.kt

@@ -77,6 +77,11 @@ class SearchZakenImpl(val zakenApiClient: ZakenApiClient) : SearchZaken {
         return this
     }
 
+    override fun pageSize(pageSize: Int): SearchZaken {
+        queryParams.add("pageSize", pageSize.toString())
+        return this
+    }
+
     override suspend fun retrieve(): ResultPage<Zaak> {
         return this.zakenApiClient.webClient.get()
             .uri { it.path("/zaken/api/v1/zaken").queryParams(queryParams).build() }

zgw/zaken-api/src/main/kotlin/nl/nlportal/zakenapi/client/request/ZoekenImpl.kt

@@ -22,6 +22,7 @@ class ZoekenImpl(val zakenApiClient: ZakenApiClient) : Zaken {
 
 class SearchZoekenImpl(val zakenApiClient: ZakenApiClient) : SearchZaken {
     val bodyValue: MultiValueMap<String, Any> = LinkedMultiValueMap()
+    val queryParams: MultiValueMap<String, String> = LinkedMultiValueMap()
 
     override fun withBsn(bsn: String): SearchZaken {
         bodyValue.add("rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn", bsn)
@@ -68,15 +69,22 @@ class SearchZoekenImpl(val zakenApiClient: ZakenApiClient) : SearchZaken {
         return this
     }
 
+    // needs to be added as querystring parameter
     override fun page(page: Int): SearchZaken {
-        bodyValue.add("page", page.toString())
+        queryParams.add("page", page.toString())
+        return this
+    }
+
+    // needs to be added as querystring parameter
+    override fun pageSize(pageSize: Int): SearchZaken {
+        queryParams.add("pageSize", pageSize.toString())
         return this
     }
 
     override suspend fun retrieve(): ResultPage<Zaak> {
         return this.zakenApiClient.webClient
             .post()
-            .uri("/zaken/api/v1/zaken/_zoek")
+            .uri { it.path("/zaken/api/v1/zaken/_zoek").queryParams(queryParams).build() }
             .contentType(MediaType.APPLICATION_JSON)
             .accept(MediaType.APPLICATION_JSON)
             .bodyValue(bodyValue)

zgw/zaken-api/src/main/kotlin/nl/nlportal/zakenapi/graphql/ZaakPage.kt

@@ -13,13 +13,14 @@ class ZaakPage(
     companion object {
         fun fromResultPage(
             pageNumber: Int,
+            pageSize: Int,
             resultPage: ResultPage<Zaak>,
         ): ZaakPage {
             val zaken = resultPage.results.map { it }
 
             return ZaakPage(
                 number = pageNumber,
-                size = 100,
+                size = pageSize,
                 content = zaken,
                 totalElements = resultPage.count,
             )

zgw/zaken-api/src/main/kotlin/nl/nlportal/zakenapi/graphql/ZaakQuery.kt

@@ -35,12 +35,14 @@ open class ZaakQuery(val zakenApiService: ZakenApiService) : Query {
     open suspend fun getZaken(
         dfe: DataFetchingEnvironment,
         page: Int? = 1,
+        pageSize: Int? = 20,
         zaakTypeUrl: String? = null,
         isOpen: Boolean? = null,
         identificatie: String? = null,
     ): ZaakPage {
         return zakenApiService.getZaken(
-            page = page!!,
+            page = page ?: 1,
+            pageSize = pageSize,
             authentication = dfe.graphQlContext[AUTHENTICATION_KEY],
             zaakTypeUrl = zaakTypeUrl,
             isOpen = isOpen,

zgw/zaken-api/src/main/kotlin/nl/nlportal/zakenapi/service/ZakenApiService.kt

@@ -45,16 +45,19 @@ class ZakenApiService(
 ) {
     suspend fun getZaken(
         page: Int,
+        pageSize: Int? = null,
         authentication: CommonGroundAuthentication,
         zaakTypeUrl: String?,
         isOpen: Boolean?,
         identificatie: String?,
     ): ZaakPage {
         val request =
-            zakenApiClient.zaken()
+            zakenApiClient.zoeken()
                 .search()
+                .page(page)
                 .withAuthentication(authentication)
 
+        pageSize?.let { request.pageSize(it) }
         zaakTypeUrl?.let { request.ofZaakType(it) }
         isOpen?.let {
             request.isOpen(isOpen)
@@ -69,7 +72,7 @@ class ZakenApiService(
         }
 
         return request.retrieve().let {
-            ZaakPage.fromResultPage(page, it)
+            ZaakPage.fromResultPage(page, pageSize ?: 100, it)
         }
     }
 

zgw/zaken-api/src/test/kotlin/nl/nlportal/zakenapi/graphql/ZaakQueryIT.kt

@@ -638,10 +638,11 @@ internal class ZaakQueryIT(
                 override fun dispatch(request: RecordedRequest): MockResponse {
                     val path = request.path?.substringBefore('?')
                     val queryParams = request.path?.substringAfter('?')?.split('&') ?: emptyList()
+                    val bodyContent = request.body.readUtf8()
                     val response =
                         when (path) {
-                            "/zaken/api/v1/zaken" -> {
-                                if (queryParams.any { it.contains("ZAAK-2024-0000000001") }) {
+                            "/zaken/api/v1/zaken/_zoek" -> {
+                                if (bodyContent.contains("ZAAK-2024-0000000001")) {
                                     handleZaakListRequestOfIdentificatie()
                                 } else {
                                     handleZaakListRequest()

zgw/zaken-api/src/test/kotlin/nl/nlportal/zakenapi/graphql/ZaakQueryTest.kt

@@ -48,14 +48,14 @@ internal class ZaakQueryTest {
     fun getZaken() =
         runTest {
             zaakQuery.getZaken(environment, 3, null)
-            verify(zakenApiService).getZaken(3, authentication, null, null, null)
+            verify(zakenApiService).getZaken(3, null, authentication, null, null, null)
         }
 
     @Test
     fun `getZaken no page`() =
         runTest {
             zaakQuery.getZaken(environment)
-            verify(zakenApiService).getZaken(1, authentication, null, null, null)
+            verify(zakenApiService).getZaken(1, 20, authentication, null, null, null)
         }
 
     @Test