-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add explicit validation for incoming JSONs
This commit adds validation for incoming JSONs from the Chat Backend. If any required fields are missing or have the wrong type, a bad request exception will be thrown on the SDK side.
- Loading branch information
Showing
7 changed files
with
278 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
172 changes: 172 additions & 0 deletions
172
chat-android/src/test/java/com/ably/chat/ChatApiTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| package com.ably.chat | ||
|
|
||
| import com.google.gson.JsonElement | ||
| import com.google.gson.JsonObject | ||
| import io.ably.lib.types.AblyException | ||
| import io.ably.lib.types.AsyncHttpPaginatedResponse | ||
| import io.mockk.every | ||
| import io.mockk.mockk | ||
| import kotlinx.coroutines.runBlocking | ||
| import kotlinx.coroutines.test.runTest | ||
| import org.junit.Assert.assertEquals | ||
| import org.junit.Assert.assertThrows | ||
| import org.junit.Assert.assertTrue | ||
| import org.junit.Test | ||
|
|
||
| class ChatApiTest { | ||
|
|
||
| private val realtime = mockk<RealtimeClient>(relaxed = true) | ||
| private val chatApi = ChatApi(realtime, "clientId") | ||
|
|
||
| @Test | ||
| fun `getMessages should ignore unknown fields for Chat Backend`() = runTest { | ||
| every { | ||
| realtime.requestAsync("GET", "/chat/v1/rooms/roomId/messages", any(), any(), any(), any()) | ||
| } answers { | ||
| val callback = lastArg<AsyncHttpPaginatedResponse.Callback>() | ||
| callback.onResponse( | ||
| buildAsyncHttpPaginatedResponse( | ||
| listOf( | ||
| JsonObject().apply { | ||
| addProperty("foo", "bar") | ||
| addProperty("timeserial", "timeserial") | ||
| addProperty("roomId", "roomId") | ||
| addProperty("clientId", "clientId") | ||
| addProperty("text", "hello") | ||
| addProperty("createdAt", 1_000_000) | ||
| }, | ||
| ), | ||
| ), | ||
| ) | ||
| } | ||
|
|
||
| val messages = chatApi.getMessages("roomId", QueryOptions()) | ||
|
|
||
| assertEquals( | ||
| listOf( | ||
| Message( | ||
| timeserial = "timeserial", | ||
| roomId = "roomId", | ||
| clientId = "clientId", | ||
| text = "hello", | ||
| createdAt = 1_000_000L, | ||
| metadata = mapOf(), | ||
| headers = mapOf(), | ||
| ), | ||
| ), | ||
| messages.items, | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun `getMessages should throws AblyException if some required fields are missing`() = runTest { | ||
| every { | ||
| realtime.requestAsync("GET", "/chat/v1/rooms/roomId/messages", any(), any(), any(), any()) | ||
| } answers { | ||
| val callback = lastArg<AsyncHttpPaginatedResponse.Callback>() | ||
| callback.onResponse( | ||
| buildAsyncHttpPaginatedResponse( | ||
| listOf( | ||
| JsonObject().apply { | ||
| addProperty("foo", "bar") | ||
| }, | ||
| ), | ||
| ), | ||
| ) | ||
| } | ||
|
|
||
| val exception = assertThrows(AblyException::class.java) { | ||
| runBlocking { chatApi.getMessages("roomId", QueryOptions()) } | ||
| } | ||
|
|
||
| assertTrue(exception.message!!.matches(""".*Required field "\w+" is missing""".toRegex())) | ||
| } | ||
|
|
||
| @Test | ||
| fun `sendMessage should ignore unknown fields for Chat Backend`() = runTest { | ||
| every { | ||
| realtime.requestAsync("POST", "/chat/v1/rooms/roomId/messages", any(), any(), any(), any()) | ||
| } answers { | ||
| val callback = lastArg<AsyncHttpPaginatedResponse.Callback>() | ||
| callback.onResponse( | ||
| buildAsyncHttpPaginatedResponse( | ||
| listOf( | ||
| JsonObject().apply { | ||
| addProperty("foo", "bar") | ||
| addProperty("timeserial", "timeserial") | ||
| addProperty("createdAt", 1_000_000) | ||
| }, | ||
| ), | ||
| ), | ||
| ) | ||
| } | ||
|
|
||
| val message = chatApi.sendMessage("roomId", SendMessageParams(text = "hello")) | ||
|
|
||
| assertEquals( | ||
| Message( | ||
| timeserial = "timeserial", | ||
| roomId = "roomId", | ||
| clientId = "clientId", | ||
| text = "hello", | ||
| createdAt = 1_000_000L, | ||
| headers = mapOf(), | ||
| metadata = mapOf(), | ||
| ), | ||
| message, | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun `sendMessage should throw exception if 'timeserial' field is not presented`() = runTest { | ||
| every { | ||
| realtime.requestAsync("POST", "/chat/v1/rooms/roomId/messages", any(), any(), any(), any()) | ||
| } answers { | ||
| val callback = lastArg<AsyncHttpPaginatedResponse.Callback>() | ||
| callback.onResponse( | ||
| buildAsyncHttpPaginatedResponse( | ||
| listOf( | ||
| JsonObject().apply { | ||
| addProperty("foo", "bar") | ||
| addProperty("createdAt", 1_000_000) | ||
| }, | ||
| ), | ||
| ), | ||
| ) | ||
| } | ||
|
|
||
| assertThrows(AblyException::class.java) { | ||
| runBlocking { chatApi.sendMessage("roomId", SendMessageParams(text = "hello")) } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `getOccupancy should throw exception if 'connections' field is not presented`() = runTest { | ||
| every { | ||
| realtime.requestAsync("GET", "/chat/v1/rooms/roomId/occupancy", any(), any(), any(), any()) | ||
| } answers { | ||
| val callback = lastArg<AsyncHttpPaginatedResponse.Callback>() | ||
| callback.onResponse( | ||
| buildAsyncHttpPaginatedResponse( | ||
| listOf( | ||
| JsonObject().apply { | ||
| addProperty("presenceMembers", 1_000) | ||
| }, | ||
| ), | ||
| ), | ||
| ) | ||
| } | ||
|
|
||
| assertThrows(AblyException::class.java) { | ||
| runBlocking { chatApi.getOccupancy("roomId") } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun buildAsyncHttpPaginatedResponse(items: List<JsonElement>): AsyncHttpPaginatedResponse { | ||
| val response = mockk<AsyncHttpPaginatedResponse>() | ||
| every { | ||
| response.items() | ||
| } returns items.toTypedArray() | ||
| return response | ||
| } |
16 changes: 0 additions & 16 deletions
16
chat-android/src/test/java/com/ably/chat/ExampleUnitTest.kt
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.