Add tests for page and page_cursor #70 (#76)

MV-GH · web-flow · commit 46a9e35a7b00 · 2024-11-05T23:51:51.000Z
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -95,6 +95,7 @@ kotlin {
             implementation("org.wiremock:wiremock:3.9.2")
             implementation("com.marcinziolo:kotlin-wiremock:2.1.1")
             implementation("ch.qos.logback:logback-classic:1.5.6")
+            implementation("io.ktor:ktor-client-mock:$ktorVersion")
         }
 
         jsMain.dependencies {
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/HttpClient.platform.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/HttpClient.platform.kt
@@ -41,7 +41,7 @@ val coreHttpClient = baseClient.config {
     }
 
     HttpResponseValidator {
-        // If a 4XX is returned we try to parse it as a "Lemmy Error"
+        // If a 4XX is returned, we try to parse it as a "Lemmy Error"
         // If it is a "Lemmy Error" we throw it as a LemmyBadRequestException
         handleResponseExceptionWithRequest { exception, _ ->
             val clientException = exception as? ClientRequestException ?: return@handleResponseExceptionWithRequest
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/GetPosts.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/GetPosts.kt
@@ -13,6 +13,7 @@ import it.vercruysse.lemmyapi.dto.PAGE_CURSOR_GUARD
 data class GetPosts(
     val type_: ListingType? /* "All" | "Local" | "Subscribed" | "ModeratorView" */ = null,
     val sort: SortType? /* "Active" | "Hot" | "New" | "Old" | "TopDay" | "TopWeek" | "TopMonth" | "TopYear" | "TopAll" | "MostComments" | "NewComments" | "TopHour" | "TopSixHour" | "TopTwelveHour" | "TopThreeMonths" | "TopSixMonths" | "TopNineMonths" | "Controversial" | "Scaled" */ = null,
+    /* starts from 1, null is considered not set, deprecated 0.19+, set to support 0.18 */
     val page: Long? = null,
     val limit: Long? = null,
     val community_id: CommunityId? = null,
@@ -21,5 +22,22 @@ data class GetPosts(
     val liked_only: Boolean? = null,
     val disliked_only: Boolean? = null,
     val show_hidden: Boolean? = null,
-    val page_cursor: PaginationCursor? = PAGE_CURSOR_GUARD,
-) : DatatypeRoot
+    /** The page cursor to the next list, null is valid and considered first list */
+    val page_cursor: PaginationCursor? = PAGE_CURSOR_GUARD, // Guard is used to detect when null is set
+) : DatatypeRoot {
+
+    internal fun toPostsForm(): GetPosts {
+        return this.copy(page_cursor = null, page = this.page)
+    }
+
+    internal fun toValidatedForm(): GetPosts {
+        val pageCursorSet = this.page_cursor != PAGE_CURSOR_GUARD
+
+        return if (pageCursorSet) {
+            this.copy(page_cursor = this.page_cursor, page = null)
+        } else {
+            this.copy(page_cursor = null, page = this.page)
+        }
+
+    }
+}
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/dto/PageCursorGuard.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/dto/PageCursorGuard.kt
@@ -1,4 +1,4 @@
 package it.vercruysse.lemmyapi.dto
 
 // There should never be a page cursor returned that is the same as this
-val PAGE_CURSOR_GUARD = "$$$$$$$$$$$$$$$$$$$$$$$$$$$"
+internal const val PAGE_CURSOR_GUARD = "$$$$$$$$$$$$$$$$$$$$$$$$$$$"
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x18/x5/LemmyApiUniWrapper.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x18/x5/LemmyApiUniWrapper.kt
@@ -239,7 +239,7 @@ internal class LemmyApiUniWrapper(client: HttpClient, actualVersion: Version, ba
     override suspend fun getPosts(
         form: it.vercruysse.lemmyapi.datatypes.GetPosts,
     ): Result<it.vercruysse.lemmyapi.datatypes.GetPostsResponse> =
-        apiV18.getPosts(transformer.fromUni(form)).map(transformer::toUni)
+        apiV18.getPosts(transformer.fromUni(form.toPostsForm())).map(transformer::toUni)
 
     /**
      * Delete a post.
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x0/LemmyApiController.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x0/LemmyApiController.kt
@@ -3,7 +3,6 @@ package it.vercruysse.lemmyapi.v0.x19.x0
 import io.ktor.client.HttpClient
 import it.vercruysse.lemmyapi.dto.ExportUserSettingsResponse
 import it.vercruysse.lemmyapi.dto.ImportUserSettings
-import it.vercruysse.lemmyapi.dto.PAGE_CURSOR_GUARD
 import it.vercruysse.lemmyapi.utils.getResult
 import it.vercruysse.lemmyapi.utils.postResult
 import it.vercruysse.lemmyapi.utils.putResult
@@ -197,7 +196,7 @@ internal class LemmyApiController(client: HttpClient, auth: String?) :
      * @GET("post/list")
      */
     override suspend fun getPosts(form: GetPosts): Result<GetPostsResponse> =
-        client.getResult("post/list", form.copy(page = if (form.page_cursor != PAGE_CURSOR_GUARD) null else form.page))
+        client.getResult("post/list", form)
 
     /**
      * Delete a post.
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x0/LemmyApiUniWrapper.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x0/LemmyApiUniWrapper.kt
@@ -230,7 +230,7 @@ internal class LemmyApiUniWrapper(client: HttpClient, actualVersion: Version, ba
     override suspend fun getPosts(
         form: it.vercruysse.lemmyapi.datatypes.GetPosts,
     ): Result<it.vercruysse.lemmyapi.datatypes.GetPostsResponse> =
-        api.getPosts(transformer.fromUni(form)).map(transformer::toUni)
+        api.getPosts(transformer.fromUni(form.toValidatedForm())).map(transformer::toUni)
 
     /**
      * Delete a post.
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x3/LemmyApiController.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x3/LemmyApiController.kt
@@ -3,7 +3,6 @@ package it.vercruysse.lemmyapi.v0.x19.x3
 import io.ktor.client.HttpClient
 import it.vercruysse.lemmyapi.dto.ExportUserSettingsResponse
 import it.vercruysse.lemmyapi.dto.ImportUserSettings
-import it.vercruysse.lemmyapi.dto.PAGE_CURSOR_GUARD
 import it.vercruysse.lemmyapi.utils.getResult
 import it.vercruysse.lemmyapi.utils.postResult
 import it.vercruysse.lemmyapi.utils.putResult
@@ -197,7 +196,7 @@ internal class LemmyApiController(client: HttpClient, auth: String?) :
      * @GET("post/list")
      */
     override suspend fun getPosts(form: GetPosts): Result<GetPostsResponse> =
-        client.getResult("post/list", form.copy(page = if (form.page_cursor != PAGE_CURSOR_GUARD) null else form.page))
+        client.getResult("post/list", form)
 
     /**
      * Delete a post.
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x3/LemmyApiUniWrapper.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x3/LemmyApiUniWrapper.kt
@@ -231,7 +231,7 @@ internal class LemmyApiUniWrapper(client: HttpClient, actualVersion: Version, ba
     override suspend fun getPosts(
         form: it.vercruysse.lemmyapi.datatypes.GetPosts,
     ): Result<it.vercruysse.lemmyapi.datatypes.GetPostsResponse> =
-        api.getPosts(transformer.fromUni(form)).map(transformer::toUni)
+        api.getPosts(transformer.fromUni(form.toValidatedForm())).map(transformer::toUni)
 
     /**
      * Delete a post.
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x4/LemmyApiController.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x4/LemmyApiController.kt
@@ -3,7 +3,6 @@ package it.vercruysse.lemmyapi.v0.x19.x4
 import io.ktor.client.HttpClient
 import it.vercruysse.lemmyapi.dto.ExportUserSettingsResponse
 import it.vercruysse.lemmyapi.dto.ImportUserSettings
-import it.vercruysse.lemmyapi.dto.PAGE_CURSOR_GUARD
 import it.vercruysse.lemmyapi.utils.getResult
 import it.vercruysse.lemmyapi.utils.postResult
 import it.vercruysse.lemmyapi.utils.putResult
@@ -197,7 +196,7 @@ internal class LemmyApiController(client: HttpClient, auth: String?) :
      * @GET("post/list")
      */
     override suspend fun getPosts(form: GetPosts): Result<GetPostsResponse> =
-        client.getResult("post/list", form.copy(page = if (form.page_cursor != PAGE_CURSOR_GUARD) null else form.page))
+        client.getResult("post/list", form)
 
     /**
      * Delete a post.
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x4/LemmyApiUniWrapper.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/v0/x19/x4/LemmyApiUniWrapper.kt
@@ -230,7 +230,7 @@ internal class LemmyApiUniWrapper(client: HttpClient, actualVersion: Version, ba
     override suspend fun getPosts(
         form: it.vercruysse.lemmyapi.datatypes.GetPosts,
     ): Result<it.vercruysse.lemmyapi.datatypes.GetPostsResponse> =
-        api.getPosts(transformer.fromUni(form)).map(transformer::toUni)
+        api.getPosts(transformer.fromUni(form.toValidatedForm())).map(transformer::toUni)
 
     /**
      * Delete a post.
diff --git a/app/src/jvmTest/kotlin/Controllers.kt b/app/src/jvmTest/kotlin/Controllers.kt
@@ -0,0 +1,6 @@
+val controllerVersions = arrayOf(
+    "0.18.5",
+    "0.19.0",
+    "0.19.3",
+    "0.19.4",
+)
diff --git a/app/src/jvmTest/kotlin/DatatypesValidation.kt b/app/src/jvmTest/kotlin/DatatypesValidation.kt
@@ -30,11 +30,11 @@ class DatatypesValidation {
         val classes: MutableList<Class<*>> = ArrayList()
         val upackage = cl.getResource(pack)
 
-        val dis = BufferedReader(InputStreamReader(upackage?.getContent() as InputStream))
+        val dis = BufferedReader(InputStreamReader(upackage?.content as InputStream))
         var line: String?
         while ((dis.readLine().also { line = it }) != null) {
             if (line!!.endsWith(".class")) {
-                classes.add(Class.forName(dottedPackage + "." + line!!.substring(0, line!!.lastIndexOf('.'))))
+                classes.add(Class.forName(dottedPackage + "." + line.substring(0, line.lastIndexOf('.'))))
             }
         }
         return classes
diff --git a/app/src/jvmTest/kotlin/PostsListPageParamTest.kt b/app/src/jvmTest/kotlin/PostsListPageParamTest.kt
@@ -0,0 +1,156 @@
+import io.ktor.client.HttpClient
+import io.ktor.client.engine.mock.MockEngine
+import io.ktor.client.engine.mock.respond
+import io.ktor.client.plugins.contentnegotiation.ContentNegotiation
+import io.ktor.client.plugins.logging.LogLevel
+import io.ktor.client.plugins.logging.Logger
+import io.ktor.client.plugins.logging.Logging
+import io.ktor.http.HttpHeaders
+import io.ktor.http.HttpStatusCode
+import io.ktor.http.headersOf
+import io.ktor.serialization.kotlinx.json.json
+import io.ktor.utils.io.ByteReadChannel
+import it.vercruysse.lemmyapi.LemmyApi
+import it.vercruysse.lemmyapi.coreHttpClient
+import it.vercruysse.lemmyapi.datatypes.GetPosts
+import it.vercruysse.lemmyapi.dto.PAGE_CURSOR_GUARD
+import it.vercruysse.lemmyapi.ktorJson
+import kotlinx.coroutines.runBlocking
+import org.junit.jupiter.api.AfterAll
+import org.junit.jupiter.api.BeforeAll
+import org.junit.jupiter.api.assertDoesNotThrow
+import kotlin.test.Test
+
+class PostsListPageParamTest {
+
+    companion object {
+        @BeforeAll
+        @JvmStatic
+        fun setUp() {
+            LemmyApi.defaultClient = getMockClient()
+        }
+
+        @AfterAll
+        @JvmStatic
+        fun tearDown() {
+            LemmyApi.defaultClient = coreHttpClient
+        }
+
+        private fun getValidationMocKEngine(): MockEngine = MockEngine { request ->
+            val url = request.url
+
+            var success = true
+
+            // Rules:
+            // never send both page and page_cursor,
+            // page_cursor takes priority
+            // never send pagination_guard
+            // work with null and value
+            if (url.encodedPath != "/api/v3/post/list") {
+                success = false
+            } else if (url.parameters.contains("page_cursor") && url.parameters.contains("page")) {
+                success = false
+            } else if (url.parameters["page_cursor"] == PAGE_CURSOR_GUARD) {
+                success = false
+            }
+
+            if (success) {
+                respond(
+                    content = ByteReadChannel("""{"posts": [], "next_page": null}"""),
+                    status = HttpStatusCode.OK,
+                    headers = headersOf(HttpHeaders.ContentType, "application/json"),
+                )
+            } else {
+                respond(
+                    content = ByteReadChannel("Failed validation"),
+                    status = HttpStatusCode.BadRequest,
+                )
+            }
+        }
+
+        private fun getMockClient(): HttpClient {
+            val apiClient = HttpClient(getValidationMocKEngine())
+            return apiClient.config {
+                expectSuccess = true
+
+                install(ContentNegotiation) {
+                    json(ktorJson)
+                }
+                install(Logging) {
+                    logger = object : Logger {
+                        override fun log(message: String) {
+                            println(message)
+                        }
+                    }
+                    level = LogLevel.ALL
+                }
+            }
+        }
+    }
+
+    @Test
+    fun `default form`() {
+        controllerVersions.forEach {
+            runBlocking {
+                val api = LemmyApi.getLemmyApi("lemmy.ml", it)
+                var resp = api.getPosts(GetPosts())
+                assertDoesNotThrow("Failed for $it") { resp.getOrThrow() }
+            }
+        }
+    }
+
+    @Test
+    fun `just page`() {
+        controllerVersions.forEach {
+            runBlocking {
+                val api = LemmyApi.getLemmyApi("lemmy.ml", it)
+                var resp = api.getPosts(GetPosts(page = 1))
+                assertDoesNotThrow("Failed for $it") { resp.getOrThrow() }
+            }
+        }
+    }
+
+    @Test
+    fun `just cursor`() {
+        controllerVersions.forEach {
+            runBlocking {
+                val api = LemmyApi.getLemmyApi("lemmy.ml", it)
+                var resp = api.getPosts(GetPosts(page_cursor = "cursor"))
+                assertDoesNotThrow("Failed for $it") { resp.getOrThrow() }
+            }
+        }
+    }
+
+    @Test
+    fun `page cursor null`() {
+        controllerVersions.forEach {
+            runBlocking {
+                val api = LemmyApi.getLemmyApi("lemmy.ml", it)
+                var resp = api.getPosts(GetPosts(page_cursor = null))
+                assertDoesNotThrow("Failed for $it") { resp.getOrThrow() }
+            }
+        }
+    }
+
+    @Test
+    fun `both page and cursor`() {
+        controllerVersions.forEach {
+            runBlocking {
+                val api = LemmyApi.getLemmyApi("lemmy.ml", it)
+                var resp = api.getPosts(GetPosts(page = 1, page_cursor = "cursor"))
+                assertDoesNotThrow("Failed for $it") { resp.getOrThrow() }
+            }
+        }
+    }
+
+    @Test
+    fun `both page and cursor null`() {
+        controllerVersions.forEach {
+            runBlocking {
+                val api = LemmyApi.getLemmyApi("lemmy.ml", it)
+                var resp = api.getPosts(GetPosts(page = 1, page_cursor = null))
+                assertDoesNotThrow("Failed for $it") { resp.getOrThrow() }
+            }
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,7 @@ kotlin {`
`95`	`95`	`implementation("org.wiremock:wiremock:3.9.2")`
`96`	`96`	`implementation("com.marcinziolo:kotlin-wiremock:2.1.1")`
`97`	`97`	`implementation("ch.qos.logback:logback-classic:1.5.6")`
	`98`	`+ implementation("io.ktor:ktor-client-mock:$ktorVersion")`
`98`	`99`	`}`
`99`	`100`
`100`	`101`	`jsMain.dependencies {`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ val coreHttpClient = baseClient.config {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`HttpResponseValidator {`
`44`		`- // If a 4XX is returned we try to parse it as a "Lemmy Error"`
	`44`	`+ // If a 4XX is returned, we try to parse it as a "Lemmy Error"`
`45`	`45`	`// If it is a "Lemmy Error" we throw it as a LemmyBadRequestException`
`46`	`46`	`handleResponseExceptionWithRequest { exception, _ ->`
`47`	`47`	`val clientException = exception as? ClientRequestException ?: return@handleResponseExceptionWithRequest`