Fix #89: Remove an inputs listeners from the connector when shutting down

Author: J0B10

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/discord/DiscordChatConnector.scala

@@ -47,6 +47,21 @@ class DiscordChatConnector(override val sourceIdentifier: String) extends Connec
   def addReactionDelEventListener(listener: MessageReactionRemoveEvent => Unit): Unit =
     discordChatListener.addReactionDelEventListener(listener)
 
+  def removeMessageReceivedListener(listener: MessageReceivedEvent => Unit): Unit =
+    discordChatListener.removeMessageReceivedListener(listener)
+
+  def removeMessageUpdateListener(listener: MessageUpdateEvent => Unit): Unit =
+    discordChatListener.removeMessageUpdateEventListener(listener)
+
+  def removeMessageDeleteListener(listener: MessageDeleteEvent => Unit): Unit =
+    discordChatListener.removeMessageDeleteEventListener(listener)
+
+  def removeReactionAddEventListener(listener: MessageReactionAddEvent => Unit): Unit =
+    discordChatListener.removeReactionAddEventListener(listener)
+
+  def removeReactionDelEventListener(listener: MessageReactionRemoveEvent => Unit): Unit =
+    discordChatListener.removeReactionDelEventListener(listener)
+
   /**
     * Connects to discord
     */

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/discord/DiscordChatListener.scala

@@ -32,6 +32,16 @@ class DiscordChatListener extends EventListener {
 
   def addReactionDelEventListener(listener: MessageReactionRemoveEvent => Unit): Unit = reactionDelEventListener += listener
 
+  def removeMessageReceivedListener(listener: MessageReceivedEvent => Unit): Unit = messageEventListener -= listener
+
+  def removeMessageUpdateEventListener(listener: MessageUpdateEvent => Unit): Unit = messageUpdateEventListener -= listener
+
+  def removeMessageDeleteEventListener(listener: MessageDeleteEvent => Unit): Unit = messageDeleteEventListener -= listener
+
+  def removeReactionAddEventListener(listener: MessageReactionAddEvent => Unit): Unit = reactionAddEventListener -= listener
+
+  def removeReactionDelEventListener(listener: MessageReactionRemoveEvent => Unit): Unit = reactionDelEventListener -= listener
+
   override def onEvent(event: Event): Unit = {
     event match {
       case receivedEvent: MessageReceivedEvent => messageEventListener.foreach(listener => listener(receivedEvent))

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/discord/impl/DiscordChatInputImpl.scala

@@ -81,7 +81,14 @@ class DiscordChatInputImpl extends EventInputImpl[DiscordEvent, DiscordChatConne
     *
     * @return true if stopping was successful
     */
-  override def stop(): Boolean = true
+  override def stop(): Boolean = {
+    sourceConnector.get.removeMessageReceivedListener(onMessage)
+    sourceConnector.get.removeMessageUpdateListener(onMessageUpdate)
+    sourceConnector.get.removeMessageDeleteListener(onMessageDelete)
+    sourceConnector.get.removeReactionAddEventListener(onReactionAdded)
+    sourceConnector.get.removeReactionDelEventListener(onReactionRemoved)
+    true
+  }
 
   /**
     * Listens for received messages, parses the data, adds them to the buffer and handles them over to the correct handler

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/serial/SerialConnector.scala

@@ -2,10 +2,12 @@ package org.codeoverflow.chatoverflow.requirement.service.serial
 
 import java.io.{InputStream, PrintStream}
 
-import com.fazecast.jSerialComm.{SerialPort, SerialPortInvalidPortException}
+import com.fazecast.jSerialComm.{SerialPort, SerialPortEvent, SerialPortInvalidPortException}
 import org.codeoverflow.chatoverflow.WithLogger
 import org.codeoverflow.chatoverflow.connector.Connector
 
+import scala.collection.mutable
+
 /**
   * The serial connector allows to communicate with a device connected to the pcs serial port (like an Arduino)
   *
@@ -19,6 +21,7 @@ class SerialConnector(override val sourceIdentifier: String) extends Connector(s
   private var serialPort: Option[SerialPort] = None
   private var out: Option[PrintStream] = None
   private var in: Option[InputStream] = None
+  private val inputListeners: mutable.Map[Array[Byte] => Unit, SerialPortEvent => Unit] = mutable.Map()
 
   /**
     * @throws java.lang.IllegalStateException if the serial port is not available yet
@@ -49,11 +52,20 @@ class SerialConnector(override val sourceIdentifier: String) extends Connector(s
   @throws(classOf[IllegalStateException])
   def addInputListener(listener: Array[Byte] => Unit): Unit = {
     if (serialPort.isEmpty) throw new IllegalStateException("Serial port is not available yet")
-    serialPortInputListener.addDataAvailableListener(_ => {
+    val l: SerialPortEvent => Unit = _ => {
       val buffer = new Array[Byte](serialPort.get.bytesAvailable())
       serialPort.get.readBytes(buffer, buffer.length)
       listener(buffer)
-    })
+    }
+    inputListeners += (listener -> l)
+    serialPortInputListener.addDataAvailableListener(l)
+  }
+
+  def removeInputListener(listener: Array[Byte] => Unit): Unit = {
+    inputListeners remove listener match {
+      case Some(l) => serialPortInputListener.removeDataAvailableListener(l)
+      case _ => //listener not found, do nothing
+    }
   }
 
   /**
@@ -93,6 +105,7 @@ class SerialConnector(override val sourceIdentifier: String) extends Connector(s
     * Closes the connection with the port
     */
   override def stop(): Boolean = {
+
     serialPort.foreach(_.closePort())
     true
   }

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/serial/SerialPortInputListener.scala

@@ -17,4 +17,6 @@ class SerialPortInputListener extends SerialPortDataListener {
   }
 
   def addDataAvailableListener(listener: SerialPortEvent => Unit): Unit = listeners += listener
+
+  def removeDataAvailableListener(listener: SerialPortEvent => Unit): Unit = listeners += listener
 }

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/serial/impl/SerialInputImpl.scala

@@ -13,16 +13,21 @@ import org.codeoverflow.chatoverflow.requirement.service.serial.SerialConnector
 class SerialInputImpl extends EventInputImpl[SerialEvent, SerialConnector] with SerialInput with WithLogger {
 
   override def start(): Boolean = {
-    sourceConnector.get.addInputListener(bytes => call(new SerialDataAvailableEvent(bytes)))
+    sourceConnector.get.addInputListener(onInput)
     true
   }
 
+  private def onInput(bytes: Array[Byte]): Unit = call(new SerialDataAvailableEvent(bytes))
+
   override def getInputStream: InputStream = sourceConnector.get.getInputStream
 
   /**
     * Stops the input, called before source connector will shutdown
     *
     * @return true if stopping was successful
     */
-  override def stop(): Boolean = true
+  override def stop(): Boolean = {
+    sourceConnector.get.removeInputListener(onInput)
+    true
+  }
 }

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/tipeeestream/TipeeestreamConnector.scala

@@ -86,6 +86,12 @@ class TipeeestreamConnector(override val sourceIdentifier: String) extends Conne
 
   def addFollowEventListener(listener: JSONObject => Unit): Unit = tipeeeStreamListener.addFollowEventListener(listener)
 
+  def removeSubscriptionEventListener(listener: JSONObject => Unit): Unit = tipeeeStreamListener.removeSubscriptionEventListener(listener)
+
+  def removeDonationEventListener(listener: JSONObject => Unit): Unit = tipeeeStreamListener.removeDonationEventListener(listener)
+
+  def removeFollowEventListener(listener: JSONObject => Unit): Unit = tipeeeStreamListener.removeFollowEventListener(listener)
+
   override def stop(): Boolean = {
     socket.foreach(_.close())
     true

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/tipeeestream/TipeeestreamListener.scala

@@ -23,6 +23,18 @@ class TipeeestreamListener {
     followEventListeners += listener
   }
 
+  def removeSubscriptionEventListener(listener: JSONObject => Unit): Unit = {
+    subscriptionEventListeners -= listener
+  }
+
+  def removeDonationEventListener(listener: JSONObject => Unit): Unit = {
+    donationEventListeners -= listener
+  }
+
+  def removeFollowEventListener(listener: JSONObject => Unit): Unit = {
+    followEventListeners -= listener
+  }
+
   def onSocketEvent(objects : Array[AnyRef]) : Unit = {
     val json: JSONObject = objects(0).asInstanceOf[JSONObject]
     val event: JSONObject = json.getJSONObject("event")

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/tipeeestream/impl/TipeestreamEventInputImpl.scala

@@ -83,5 +83,10 @@ class TipeestreamEventInputImpl extends EventInputImpl[TipeeestreamEvent, Tipeee
     }
   }
 
-  override def stop(): Boolean = true
+  override def stop(): Boolean = {
+    sourceConnector.get.removeFollowEventListener(onFollow)
+    sourceConnector.get.removeSubscriptionEventListener(onSubscription)
+    sourceConnector.get.removeDonationEventListener(onDonation)
+    true
+  }
 }

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/twitch/chat/TwitchChatConnector.scala

@@ -31,6 +31,14 @@ class TwitchChatConnector(override val sourceIdentifier: String) extends Connect
     twitchChatListener.addUnknownEventListener(listener)
   }
 
+  def removeMessageEventListener(listener: MessageEvent => Unit): Unit = {
+    twitchChatListener.removeMessageEventListener(listener)
+  }
+
+  def removeUnknownEventListener(listener: UnknownEvent => Unit): Unit = {
+    twitchChatListener.removeUnknownEventListener(listener)
+  }
+
   def joinChannel(channel: String): Unit = {
     bot.send().joinChannel(channel)
     channels += channel

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/twitch/chat/TwitchChatListener.scala

@@ -29,4 +29,12 @@ class TwitchChatListener extends ListenerAdapter {
     unknownEventListener += listener
   }
 
+  def removeMessageEventListener(listener: MessageEvent => Unit): Unit = {
+    messageEventListener -= listener
+  }
+
+  def removeUnknownEventListener(listener: UnknownEvent => Unit): Unit = {
+    unknownEventListener -= listener
+  }
+
 }

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/twitch/chat/impl/TwitchChatInputImpl.scala

@@ -104,5 +104,9 @@ class TwitchChatInputImpl extends EventInputImpl[TwitchEvent, chat.TwitchChatCon
     *
     * @return true if stopping was successful
     */
-  override def stop(): Boolean = true
+  override def stop(): Boolean = {
+    sourceConnector.get.removeMessageEventListener(onMessage)
+    sourceConnector.get.removeUnknownEventListener(onUnknown)
+    true
+  }
 }