Fix class loader issue for notifications response

src/main/kotlin/org/opensearch/commons/notifications/NotificationsPluginInterface.kt

@@ -27,8 +27,11 @@
 package org.opensearch.commons.notifications
 
 import org.opensearch.action.ActionListener
+import org.opensearch.action.ActionResponse
 import org.opensearch.client.node.NodeClient
+import org.opensearch.common.io.stream.Writeable
 import org.opensearch.commons.ConfigConstants.OPENSEARCH_SECURITY_USER_INFO_THREAD_CONTEXT
+import org.opensearch.commons.notifications.action.BaseResponse
 import org.opensearch.commons.notifications.action.CreateNotificationConfigRequest
 import org.opensearch.commons.notifications.action.CreateNotificationConfigResponse
 import org.opensearch.commons.notifications.action.DeleteNotificationConfigRequest
@@ -56,6 +59,7 @@ import org.opensearch.commons.notifications.action.UpdateNotificationConfigRespo
 import org.opensearch.commons.notifications.model.ChannelMessage
 import org.opensearch.commons.notifications.model.EventSource
 import org.opensearch.commons.utils.SecureClientWrapper
+import org.opensearch.commons.utils.recreateObject
 
 /**
  * All the transport action plugin interfaces for the Notification plugin
@@ -76,7 +80,7 @@ object NotificationsPluginInterface {
         client.execute(
             CREATE_NOTIFICATION_CONFIG_ACTION_TYPE,
             request,
-            listener
+            wrapActionListener(listener) { response -> recreateObject(response) { CreateNotificationConfigResponse(it) } }
         )
     }
 
@@ -94,7 +98,7 @@ object NotificationsPluginInterface {
         client.execute(
             UPDATE_NOTIFICATION_CONFIG_ACTION_TYPE,
             request,
-            listener
+            wrapActionListener(listener) { response -> recreateObject(response) { UpdateNotificationConfigResponse(it) } }
         )
     }
 
@@ -112,7 +116,7 @@ object NotificationsPluginInterface {
         client.execute(
             DELETE_NOTIFICATION_CONFIG_ACTION_TYPE,
             request,
-            listener
+            wrapActionListener(listener) { response -> recreateObject(response) { DeleteNotificationConfigResponse(it) } }
         )
     }
 
@@ -130,7 +134,7 @@ object NotificationsPluginInterface {
         client.execute(
             GET_NOTIFICATION_CONFIG_ACTION_TYPE,
             request,
-            listener
+            wrapActionListener(listener) { response -> recreateObject(response) { GetNotificationConfigResponse(it) } }
         )
     }
 
@@ -148,7 +152,7 @@ object NotificationsPluginInterface {
         client.execute(
             GET_NOTIFICATION_EVENT_ACTION_TYPE,
             request,
-            listener
+            wrapActionListener(listener) { response -> recreateObject(response) { GetNotificationEventResponse(it) } }
         )
     }
 
@@ -166,7 +170,7 @@ object NotificationsPluginInterface {
         client.execute(
             GET_PLUGIN_FEATURES_ACTION_TYPE,
             request,
-            listener
+            wrapActionListener(listener) { response -> recreateObject(response) { GetPluginFeaturesResponse(it) } }
         )
     }
 
@@ -184,7 +188,7 @@ object NotificationsPluginInterface {
         client.execute(
             GET_FEATURE_CHANNEL_LIST_ACTION_TYPE,
             request,
-            listener
+            wrapActionListener(listener) { response -> recreateObject(response) { GetFeatureChannelListResponse(it) } }
         )
     }
 
@@ -209,7 +213,30 @@ object NotificationsPluginInterface {
         wrapper.execute(
             SEND_NOTIFICATION_ACTION_TYPE,
             SendNotificationRequest(eventSource, channelMessage, channelIds, threadContext),
-            listener
+            wrapActionListener(listener) { response -> recreateObject(response) { SendNotificationResponse(it) } }
         )
     }
+
+    /**
+     * Wrap action listener on concrete response class by a new created one on ActionResponse.
+     * This is required because the response may be loaded by different classloader across plugins.
+     * The onResponse(ActionResponse) avoids type cast exception and give a chance to recreate
+     * the response object.
+     */
+    @Suppress("UNCHECKED_CAST")
+    private fun <Response : BaseResponse> wrapActionListener(
+        listener: ActionListener<Response>,
+        recreate: (Writeable) -> Response
+    ): ActionListener<Response> {
+        return object : ActionListener<ActionResponse> {
+            override fun onResponse(response: ActionResponse) {
+                val recreated = response as? Response ?: recreate(response)
+                listener.onResponse(recreated)
+            }
+
+            override fun onFailure(exception: java.lang.Exception) {
+                listener.onFailure(exception)
+            }
+        } as ActionListener<Response>
+    }
 }

src/test/kotlin/org/opensearch/commons/notifications/NotificationsPluginInterfaceTests.kt

@@ -0,0 +1,268 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+package org.opensearch.commons.notifications
+
+import com.nhaarman.mockitokotlin2.whenever
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.extension.ExtendWith
+import org.mockito.Answers
+import org.mockito.ArgumentMatchers.eq
+import org.mockito.Mock
+import org.mockito.Mockito.any
+import org.mockito.Mockito.doAnswer
+import org.mockito.Mockito.mock
+import org.mockito.Mockito.times
+import org.mockito.Mockito.verify
+import org.mockito.junit.jupiter.MockitoExtension
+import org.opensearch.action.ActionListener
+import org.opensearch.action.ActionType
+import org.opensearch.client.node.NodeClient
+import org.opensearch.commons.notifications.action.CreateNotificationConfigRequest
+import org.opensearch.commons.notifications.action.CreateNotificationConfigResponse
+import org.opensearch.commons.notifications.action.DeleteNotificationConfigRequest
+import org.opensearch.commons.notifications.action.DeleteNotificationConfigResponse
+import org.opensearch.commons.notifications.action.GetFeatureChannelListRequest
+import org.opensearch.commons.notifications.action.GetFeatureChannelListResponse
+import org.opensearch.commons.notifications.action.GetNotificationConfigRequest
+import org.opensearch.commons.notifications.action.GetNotificationConfigResponse
+import org.opensearch.commons.notifications.action.GetNotificationEventRequest
+import org.opensearch.commons.notifications.action.GetNotificationEventResponse
+import org.opensearch.commons.notifications.action.GetPluginFeaturesRequest
+import org.opensearch.commons.notifications.action.GetPluginFeaturesResponse
+import org.opensearch.commons.notifications.action.SendNotificationResponse
+import org.opensearch.commons.notifications.action.UpdateNotificationConfigRequest
+import org.opensearch.commons.notifications.action.UpdateNotificationConfigResponse
+import org.opensearch.commons.notifications.model.ChannelMessage
+import org.opensearch.commons.notifications.model.ConfigType
+import org.opensearch.commons.notifications.model.DeliveryStatus
+import org.opensearch.commons.notifications.model.EventSource
+import org.opensearch.commons.notifications.model.EventStatus
+import org.opensearch.commons.notifications.model.Feature
+import org.opensearch.commons.notifications.model.FeatureChannel
+import org.opensearch.commons.notifications.model.FeatureChannelList
+import org.opensearch.commons.notifications.model.NotificationConfig
+import org.opensearch.commons.notifications.model.NotificationConfigInfo
+import org.opensearch.commons.notifications.model.NotificationConfigSearchResult
+import org.opensearch.commons.notifications.model.NotificationEvent
+import org.opensearch.commons.notifications.model.NotificationEventInfo
+import org.opensearch.commons.notifications.model.NotificationEventSearchResult
+import org.opensearch.commons.notifications.model.SeverityType
+import org.opensearch.commons.notifications.model.Slack
+import org.opensearch.rest.RestStatus
+import java.time.Instant
+import java.util.EnumSet
+
+@Suppress("UNCHECKED_CAST")
+@ExtendWith(MockitoExtension::class)
+internal class NotificationsPluginInterfaceTests {
+
+    @Mock(answer = Answers.RETURNS_DEEP_STUBS)
+    private lateinit var client: NodeClient
+
+    @Test
+    fun createNotificationConfig() {
+        val request = mock(CreateNotificationConfigRequest::class.java)
+        val response = CreateNotificationConfigResponse("configId")
+        val listener: ActionListener<CreateNotificationConfigResponse> =
+            mock(ActionListener::class.java) as ActionListener<CreateNotificationConfigResponse>
+
+        doAnswer {
+            (it.getArgument(2) as ActionListener<CreateNotificationConfigResponse>)
+                .onResponse(response)
+        }.whenever(client).execute(any(ActionType::class.java), any(), any())
+
+        NotificationsPluginInterface.createNotificationConfig(client, request, listener)
+        verify(listener, times(1)).onResponse(eq(response))
+    }
+
+    @Test
+    fun updateNotificationConfig() {
+        val request = mock(UpdateNotificationConfigRequest::class.java)
+        val response = UpdateNotificationConfigResponse("configId")
+        val listener: ActionListener<UpdateNotificationConfigResponse> =
+            mock(ActionListener::class.java) as ActionListener<UpdateNotificationConfigResponse>
+
+        doAnswer {
+            (it.getArgument(2) as ActionListener<UpdateNotificationConfigResponse>)
+                .onResponse(response)
+        }.whenever(client).execute(any(ActionType::class.java), any(), any())
+
+        NotificationsPluginInterface.updateNotificationConfig(client, request, listener)
+        verify(listener, times(1)).onResponse(eq(response))
+    }
+
+    @Test
+    fun deleteNotificationConfig() {
+        val request = mock(DeleteNotificationConfigRequest::class.java)
+        val response = DeleteNotificationConfigResponse(mapOf(Pair("sample_config_id", RestStatus.OK)))
+        val listener: ActionListener<DeleteNotificationConfigResponse> =
+            mock(ActionListener::class.java) as ActionListener<DeleteNotificationConfigResponse>
+
+        doAnswer {
+            (it.getArgument(2) as ActionListener<DeleteNotificationConfigResponse>)
+                .onResponse(response)
+        }.whenever(client).execute(any(ActionType::class.java), any(), any())
+
+        NotificationsPluginInterface.deleteNotificationConfig(client, request, listener)
+        verify(listener, times(1)).onResponse(eq(response))
+    }
+
+    @Test
+    fun getNotificationConfig() {
+        val request = mock(GetNotificationConfigRequest::class.java)
+        val response = mockGetNotificationConfigResponse()
+        val listener: ActionListener<GetNotificationConfigResponse> =
+            mock(ActionListener::class.java) as ActionListener<GetNotificationConfigResponse>
+
+        doAnswer {
+            (it.getArgument(2) as ActionListener<GetNotificationConfigResponse>)
+                .onResponse(response)
+        }.whenever(client).execute(any(ActionType::class.java), any(), any())
+
+        NotificationsPluginInterface.getNotificationConfig(client, request, listener)
+        verify(listener, times(1)).onResponse(eq(response))
+    }
+
+    @Test
+    fun getNotificationEvent() {
+        val request = mock(GetNotificationEventRequest::class.java)
+        val response = mockGetNotificationEventResponse()
+        val listener: ActionListener<GetNotificationEventResponse> =
+            mock(ActionListener::class.java) as ActionListener<GetNotificationEventResponse>
+
+        doAnswer {
+            (it.getArgument(2) as ActionListener<GetNotificationEventResponse>)
+                .onResponse(response)
+        }.whenever(client).execute(any(ActionType::class.java), any(), any())
+
+        NotificationsPluginInterface.getNotificationEvent(client, request, listener)
+        verify(listener, times(1)).onResponse(eq(response))
+    }
+
+    @Test
+    fun getPluginFeatures() {
+        val request = mock(GetPluginFeaturesRequest::class.java)
+        val response = GetPluginFeaturesResponse(
+            listOf("config_type_1", "config_type_2", "config_type_3"),
+            mapOf(
+                Pair("FeatureKey1", "FeatureValue1"),
+                Pair("FeatureKey2", "FeatureValue2"),
+                Pair("FeatureKey3", "FeatureValue3")
+            )
+        )
+        val listener: ActionListener<GetPluginFeaturesResponse> =
+            mock(ActionListener::class.java) as ActionListener<GetPluginFeaturesResponse>
+
+        doAnswer {
+            (it.getArgument(2) as ActionListener<GetPluginFeaturesResponse>)
+                .onResponse(response)
+        }.whenever(client).execute(any(ActionType::class.java), any(), any())
+
+        NotificationsPluginInterface.getPluginFeatures(client, request, listener)
+        verify(listener, times(1)).onResponse(eq(response))
+    }
+
+    @Test
+    fun getFeatureChannelList() {
+        val sampleConfig = FeatureChannel(
+            "config_id",
+            "name",
+            "description",
+            ConfigType.SLACK
+        )
+
+        val request = mock(GetFeatureChannelListRequest::class.java)
+        val response = GetFeatureChannelListResponse(FeatureChannelList(sampleConfig))
+        val listener: ActionListener<GetFeatureChannelListResponse> =
+            mock(ActionListener::class.java) as ActionListener<GetFeatureChannelListResponse>
+
+        doAnswer {
+            (it.getArgument(2) as ActionListener<GetFeatureChannelListResponse>)
+                .onResponse(response)
+        }.whenever(client).execute(any(ActionType::class.java), any(), any())
+
+        NotificationsPluginInterface.getFeatureChannelList(client, request, listener)
+        verify(listener, times(1)).onResponse(eq(response))
+    }
+
+    @Test
+    fun sendNotification() {
+        val notificationInfo = EventSource(
+            "title",
+            "reference_id",
+            Feature.REPORTS,
+            SeverityType.HIGH,
+            listOf("tag1", "tag2")
+        )
+        val channelMessage = ChannelMessage(
+            "text_description",
+            "<b>htmlDescription</b>",
+            null
+        )
+
+        val response = SendNotificationResponse("configId")
+        val listener: ActionListener<SendNotificationResponse> =
+            mock(ActionListener::class.java) as ActionListener<SendNotificationResponse>
+
+        doAnswer {
+            (it.getArgument(2) as ActionListener<SendNotificationResponse>)
+                .onResponse(response)
+        }.whenever(client).execute(any(ActionType::class.java), any(), any())
+
+        NotificationsPluginInterface.sendNotification(
+            client, notificationInfo, channelMessage, listOf("channelId1", "channelId2"), listener
+        )
+        verify(listener, times(1)).onResponse(eq(response))
+    }
+
+    private fun mockGetNotificationConfigResponse(): GetNotificationConfigResponse {
+        val sampleSlack = Slack("https://domain.com/sample_url#1234567890")
+        val sampleConfig = NotificationConfig(
+            "name",
+            "description",
+            ConfigType.SLACK,
+            EnumSet.of(Feature.REPORTS),
+            configData = sampleSlack
+        )
+        val configInfo = NotificationConfigInfo(
+            "config_id",
+            Instant.now(),
+            Instant.now(),
+            "tenant",
+            sampleConfig
+        )
+        return GetNotificationConfigResponse(NotificationConfigSearchResult(configInfo))
+    }
+
+    private fun mockGetNotificationEventResponse(): GetNotificationEventResponse {
+        val sampleEventSource = EventSource(
+            "title",
+            "reference_id",
+            Feature.ALERTING,
+            severity = SeverityType.INFO
+        )
+        val sampleStatus = EventStatus(
+            "config_id",
+            "name",
+            ConfigType.SLACK,
+            deliveryStatus = DeliveryStatus("404", "invalid recipient")
+        )
+        val sampleEvent = NotificationEvent(sampleEventSource, listOf(sampleStatus))
+        val eventInfo = NotificationEventInfo(
+            "event_id",
+            Instant.now(),
+            Instant.now(),
+            "tenant",
+            sampleEvent
+        )
+        return GetNotificationEventResponse(NotificationEventSearchResult(eventInfo))
+    }
+}

src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker

@@ -0,0 +1 @@
+mock-maker-inline