Merge branch 'main' into mattcreaser/publishing-convention

Author: mattcreaser

appsync/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [Release 1.0.1](https://github.com/aws-amplify/amplify-android/releases/tag/release_events_v1.0.1)
+
+### Bug Fixes
+- **events:** Ensure WebSocket connection error notifies client ([#3127](https://github.com/aws-amplify/amplify-android/issues/3127))
+
+[See all changes between 1.0.0 and 1.1.0](https://github.com/aws-amplify/amplify-android/compare/release_events_v1.0.0...release_events_v1.0.1)
+
 # Release 1.0.0
 
 Initial Release

appsync/aws-sdk-appsync-events/src/androidTest/java/com/amazonaws/sdk/appsync/events/EventsWebSocketClientTests.kt

@@ -18,6 +18,7 @@ import androidx.test.platform.app.InstrumentationRegistry
 import app.cash.turbine.test
 import app.cash.turbine.turbineScope
 import com.amazonaws.sdk.appsync.core.authorizers.ApiKeyAuthorizer
+import com.amazonaws.sdk.appsync.events.data.ConnectException
 import com.amazonaws.sdk.appsync.events.data.InvalidInputException
 import com.amazonaws.sdk.appsync.events.data.PublishResult
 import com.amazonaws.sdk.appsync.events.data.UnauthorizedException
@@ -47,6 +48,7 @@ import org.junit.Test
 internal class EventsWebSocketClientTests {
     private val eventsConfig = getEventsConfig(InstrumentationRegistry.getInstrumentation().targetContext)
     private val apiKeyAuthorizer = ApiKeyAuthorizer(eventsConfig.apiKey)
+    private val badApiKeyAuthorizer = ApiKeyAuthorizer("bad-api-key")
     private val webSocketLogCapture = EventsLibraryLogCapture()
     private val defaultChannel = "default/${UUID.randomUUID()}"
     private val customChannel = "custom/${UUID.randomUUID()}"
@@ -60,6 +62,12 @@ internal class EventsWebSocketClientTests {
             loggerProvider = { _ -> webSocketLogCapture }
         )
     )
+
+    private val badWebSocketClient = events.createWebSocketClient(
+        badApiKeyAuthorizer,
+        badApiKeyAuthorizer,
+        badApiKeyAuthorizer
+    )
     private val backgroundScope = CoroutineScope(Dispatchers.IO)
 
     @After
@@ -109,6 +117,15 @@ internal class EventsWebSocketClientTests {
         )
     }
 
+    @Test
+    fun testConnectionFailure() = runBlockingWithTimeout {
+        turbineScope(timeout = 10.seconds) {
+            badWebSocketClient.subscribe(defaultChannel).test(timeout = 10.seconds) {
+                awaitError() shouldBe ConnectException(UnauthorizedException())
+            }
+        }
+    }
+
     @Test
     fun testPublishWithBadAuth(): Unit = runBlockingWithTimeout {
         // Publish the message

appsync/aws-sdk-appsync-events/src/main/java/com/amazonaws/sdk/appsync/events/data/WebSocketMessage.kt

@@ -97,7 +97,10 @@ internal sealed class WebSocketMessage {
 
         @Serializable
         @SerialName("connection_error")
-        internal data class ConnectionError(val errors: List<EventsError>) : Received()
+        internal data class ConnectionError(
+            override val id: String? = null,
+            override val errors: List<EventsError>
+        ) : Received(), ErrorContainer
 
         @Serializable
         internal sealed class Subscription : Received() {
@@ -189,7 +192,8 @@ internal sealed class WebSocketMessage {
 
     internal data class Closed(val reason: WebSocketDisconnectReason) : WebSocketMessage()
 
-    // All errors contain an id and errors list
+    // All errors contain an errors list
+    // Most events contain an id, which is either a channel id or a publish id
     internal interface ErrorContainer {
         val id: String?
         val errors: List<EventsError>

appsync/aws-sdk-appsync-events/src/test/java/com/amazonaws/sdk/appsync/events/EventsWebSocketTest.kt

@@ -22,6 +22,7 @@ import com.amazonaws.sdk.appsync.events.mocks.TestAuthorizer
 import com.amazonaws.sdk.appsync.events.utils.JsonUtils
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.matchers.shouldBe
+import io.kotest.matchers.string.shouldStartWith
 import io.mockk.every
 import io.mockk.mockk
 import io.mockk.slot
@@ -92,7 +93,7 @@ internal class EventsWebSocketTest {
         capturedRequest.headers.size shouldBe 4
         capturedRequest.headers["Sec-WebSocket-Protocol"] shouldBe "aws-appsync-event-ws"
         capturedRequest.headers["host"] shouldBe "11111111111111111111111111.appsync-api.us-east-1.amazonaws.com"
-        capturedRequest.headers["x-amz-user-agent"] shouldBe "aws-appsync-events-android#1.0.0"
+        capturedRequest.headers["x-amz-user-agent"] shouldStartWith "aws-appsync-events-android#1."
         capturedRequest.headers["testKey"] shouldBe "default"
         capturedRequest.body shouldBe null
     }

appsync/aws-sdk-appsync-events/src/test/java/com/amazonaws/sdk/appsync/events/data/WebSocketMessageTest.kt

@@ -112,7 +112,7 @@ class WebSocketMessageTest {
 
         val deserialized = json.decodeFromString<WebSocketMessage.Received>(jsonString)
         deserialized shouldBe WebSocketMessage.Received.ConnectionError(
-            listOf(
+            errors = listOf(
                 EventsError("UnauthorizedException", "Test error message")
             )
         )

appsync/version.properties

@@ -1 +1 @@
-VERSION_NAME=1.0.0
+VERSION_NAME=1.0.1