Merge pull request #3 from pme123/provide-simple-store

Provide simple store

Author: pme123

README.md

@@ -70,6 +70,9 @@ case class AdapterNotRunning(logReport: Option[LogReport]) extends AdapterMsg
 // each LogEntry that is created by the AdapterProcess
 case class LogEntryMsg(logEntry: LogEntry) extends AdapterMsg
 
+// sent when the Adapter Process is started
+case object RunStarted extends AdapterMsg
+
 // sent when the Adapter Process finished
 case class RunFinished(logReport: LogReport) extends AdapterMsg
 
@@ -87,7 +90,8 @@ The client is split in 3 classes:
 ### AdapterClient
 The whole web page is here composed with `Binding.scala data-binding expressions`. 
 
-It is more or less HTML-snippets that contain dynamic content provided by `Binding.scala data sources`:
+It is more or less HTML-snippets that contain dynamic content provided by `Binding.scala data sources`.
+They are encapsulated in the **UIState**:
 
 * `logData: Vars[LogEntry]` a list of LogEntries that from the active- or last Adapter run.
 * `isRunning: Var[Boolean]` is true if the Adapter process is running at the moment.
@@ -112,6 +116,16 @@ My solution is taken from here: [github.com/vmunier/play-scalajs.g8](https://git
 * add to the end of the `routes`-file `->         /webjars                      webjars.Routes`
 * now you can use them like `<img src={"" + g.jsRoutes.controllers.Assets.versioned("images/favicon.png").url}></img>`
 Don't forget `import scala.scalajs.js.Dynamic.{global => g}` 
+
+### UIStore
+I like the concepts of Redux. 
+However with `Binding.scala` most of the patterns are obsolete.
+What I wanted to achieve was to manipulate the UIState in just one place.
+My solution (for now) is to have a UIStore trait, that provides for each manipulation-action
+a function.
+To have a general reducer seems to be an unnecessary overhead and even worse 
+the payload is not type safe.
+
 ### ClientWebsocket
 Encapsulates the communication with the server. The internal communication with the AdapterClient
 is done via the `Binding.scala data sources`.
@@ -207,3 +221,14 @@ $ sbt
 > run
 ```
 open [http://localhost:9000](http://localhost:9000) in a browser.
+
+# This is the end;)
+
+Please create an issue, if you...
+ 
+* have some suggestions
+* find a bug
+* don't understand a part
+* have a question
+
+ 

client/src/main/scala/client/AdapterClient.scala

@@ -1,6 +1,6 @@
 package client
 
-import com.thoughtworks.binding.Binding.{Constants, Var, Vars}
+import com.thoughtworks.binding.Binding.Constants
 import com.thoughtworks.binding.{Binding, dom}
 import org.scalajs.dom.document
 import org.scalajs.dom.raw._
@@ -11,18 +11,17 @@ import scala.language.implicitConversions
 import scala.scalajs.js
 import scala.scalajs.js.Dynamic.{global => g}
 
-object AdapterClient extends js.JSApp {
+object AdapterClient
+  extends js.JSApp
+    with UIStore {
 
-  private val logData = Vars[LogEntry]()
-  private val isRunning = Var[Boolean](false)
-  private val filterText = Var[String]("")
-  private val filterLevel = Var[LogLevel](LogLevel.DEBUG)
-  private val lastLogLevel = Var[Option[LogLevel]](None)
-  private lazy val socket = ClientWebsocket(logData, isRunning, filterText, filterLevel, lastLogLevel)
+  val uiState = UIState()
+
+  private lazy val socket = ClientWebsocket(uiState)
 
   def main(): Unit = {
     dom.render(document.body, render)
-    socket.connectWS() // initial population
+    socket.connectWS()
     import SemanticUI.jq2semantic
     jQuery(".ui.dropdown").dropdown(js.Dynamic.literal(on = "hover"))
   }
@@ -54,7 +53,7 @@ object AdapterClient extends js.JSApp {
 
   @dom
   private def lastLevel = {
-    val logLevel = lastLogLevel.bind
+    val logLevel = uiState.lastLogLevel.bind
 
     @dom
     def logImage(levelClass: String): Binding[HTMLElement] =
@@ -89,7 +88,8 @@ object AdapterClient extends js.JSApp {
         <input id="filterInput"
                type="text"
                placeholder="Filter..."
-               onkeyup={event: Event => filterText.value = s"${filterInput.value}"}>
+               onkeyup={_: Event =>
+                 changeFilterText(s"${filterInput.value}")}>
         </input>
       </div>
     </div>
@@ -106,8 +106,8 @@ object AdapterClient extends js.JSApp {
          data:data-position="bottom right">
       <select id="filterSelect"
               class="ui compact dropdown"
-              onchange={event: Event =>
-                filterLevel.value = LogLevel.fromLevel(s"${filterSelect.value}").get}>
+              onchange={_: Event =>
+                changeFilterLevel(LogLevel.fromLevel(s"${filterSelect.value}").get)}>
         <option value="ERROR">ERROR</option>
         <option value="WARN">WARN</option>
         <option value="INFO">INFO</option>
@@ -118,7 +118,7 @@ object AdapterClient extends js.JSApp {
 
   @dom
   private def runAdapterButton = {
-    val runDisabled = isRunning.bind
+    val runDisabled = uiState.isRunning.bind
 
     <div class="ui item">
       <button class="ui basic icon button"
@@ -135,7 +135,7 @@ object AdapterClient extends js.JSApp {
   private def clearButton = {
     <div class="ui item">
       <button class="ui basic icon button"
-              onclick={_: Event => logData.value.clear()}
+              onclick={_: Event => clearLogData()}
               data:data-tooltip="Clear the console"
               data:data-position="bottom right">
         <i class="remove circle outline icon large"></i>
@@ -145,9 +145,9 @@ object AdapterClient extends js.JSApp {
 
   @dom
   private def adapterContainer = {
-    val logEntries = logData.bind
-    val text = filterText.bind
-    val level = filterLevel.bind
+    val logEntries = uiState.logData.bind
+    val text = uiState.filterText.bind
+    val level = uiState.filterLevel.bind
     val filteredLE =
       logEntries
         .filter(le => le.level >= level)

client/src/main/scala/client/ClientWebsocket.scala

@@ -1,18 +1,14 @@
 package client
 
-import com.thoughtworks.binding.Binding.{Var, Vars}
 import org.scalajs.dom.raw._
 import org.scalajs.dom.{document, window}
 import play.api.libs.json.{JsError, JsSuccess, Json}
 import shared._
 
 import scala.scalajs.js.timers.setTimeout
 
-case class ClientWebsocket(logData: Vars[LogEntry]
-                           , isRunning: Var[Boolean]
-                           , filterText: Var[String]
-                           , filterLevel: Var[LogLevel]
-                           , lastLogLevel: Var[Option[LogLevel]]) {
+case class ClientWebsocket(uiState: UIState)
+  extends UIStore {
 
   private lazy val wsURL = s"ws://${window.location.host}/ws"
 
@@ -25,21 +21,21 @@ case class ClientWebsocket(logData: Vars[LogEntry]
         val message = Json.parse(e.data.toString)
         message.validate[AdapterMsg] match {
           case JsSuccess(AdapterRunning(logReport), _) =>
-            println(s"Adapter running")
-            isRunning.value = true
-            addLogEntries(logReport)
+            changeIsRunning(true)
+            newLogEntries(logReport)
           case JsSuccess(AdapterNotRunning(logReport), _) =>
-            println(s"Adapter NOT running")
-            isRunning.value = false
-            lastLogLevel.value = logReport.map(_.maxLevel())
-            logReport.foreach(addLogEntries)
+            changeIsRunning(false)
+            logReport.foreach { lr =>
+              changeLastLogLevel(lr)
+              newLogEntries(lr)
+            }
           case JsSuccess(LogEntryMsg(le), _) =>
-            isRunning.value = true
-            addLogEntry(le)
+            newLogEntry(le)
+          case JsSuccess(RunStarted, _) =>
+            changeIsRunning(true)
           case JsSuccess(RunFinished(logReport), _) =>
-            println("Run Finished")
-            isRunning.value = false
-            lastLogLevel.value = Some(logReport.maxLevel())
+            changeIsRunning(false)
+            changeLastLogLevel(logReport)
           case JsSuccess(other, _) =>
             println(s"Other message: $other")
           case JsError(errors) =>
@@ -50,9 +46,9 @@ case class ClientWebsocket(logData: Vars[LogEntry]
       println(s"exception with websocket: ${e.message}!")
       socket.close(0, e.message)
     }
-    socket.onopen = { (e: Event) =>
+    socket.onopen = { (_: Event) =>
       println("websocket open!")
-      logData.value.clear()
+      clearLogData()
     }
     socket.onclose = { (e: CloseEvent) =>
       println("closed socket" + e.reason)
@@ -67,15 +63,12 @@ case class ClientWebsocket(logData: Vars[LogEntry]
     socket.send(Json.toJson(RunAdapter()).toString())
   }
 
-  private def addLogEntries(logReport: LogReport): Unit = {
-    logReport.logEntries.foreach(addLogEntry)
+  private def newLogEntries(logReport: LogReport) {
+    logReport.logEntries.foreach(newLogEntry)
   }
 
-  private def addLogEntry(logEntry: LogEntry): Unit = {
-    logData.value += logEntry
-    logData.value
-      .filter(le => le.level >= filterLevel.value)
-      .filter(le => le.msg.contains(filterText.value))
+  private def newLogEntry(logEntry: LogEntry) {
+    addLogEntry(logEntry)
 
     val objDiv = document.getElementById("log-panel")
     objDiv.scrollTop = objDiv.scrollHeight - 20

client/src/main/scala/client/UIStore.scala

@@ -0,0 +1,45 @@
+package client
+
+import com.thoughtworks.binding.Binding.{Var, Vars}
+import shared.{LogEntry, LogLevel, LogReport}
+
+trait UIStore {
+  protected def uiState: UIState
+
+  protected def clearLogData() {
+    println("UIStore: clearLogData")
+    uiState.logData.value.clear()
+  }
+
+  protected def addLogEntry(logEntry: LogEntry) {
+    println(s"UIStore: addLogEntry $logEntry")
+    uiState.logData.value += logEntry
+  }
+
+  protected def changeFilterText(text: String) {
+    println(s"UIStore: changeFilterText $text")
+    uiState.filterText.value = text
+  }
+
+  protected def changeFilterLevel(logLevel: LogLevel) {
+    println(s"UIStore: changeFilterLevel $logLevel")
+    uiState.filterLevel.value = logLevel
+  }
+
+  protected def changeIsRunning(running: Boolean) {
+    println(s"UIStore: changeIsRunning $running")
+    uiState.isRunning.value = running
+  }
+
+  protected def changeLastLogLevel(report: LogReport) {
+    println(s"UIStore: changeLastLogLevel ${report.maxLevel()}")
+    uiState.lastLogLevel.value = Some(report.maxLevel())
+  }
+}
+
+case class UIState(logData: Vars[LogEntry] = Vars[LogEntry]()
+                   , isRunning: Var[Boolean] = Var[Boolean](false)
+                   , filterText: Var[String] = Var[String]("")
+                   , filterLevel: Var[LogLevel] = Var[LogLevel](LogLevel.DEBUG)
+                   , lastLogLevel: Var[Option[LogLevel]] = Var[Option[LogLevel]](None)
+                  )

server/app/actors/AdapterActor.scala

@@ -67,6 +67,7 @@ class AdapterActor @Inject()(implicit mat: Materializer, ec: ExecutionContext)
     logService = LogService("Demo Adapter Process", user)
     isRunning = true
     Future {
+      sendToSubscriber(RunStarted)
       sendToSubscriber(logService.startLogging())
       for (i <- 0 to 10) {
         Thread.sleep(750)

shared/src/main/scala/shared/SharedMessages.scala

@@ -28,6 +28,9 @@ case class AdapterNotRunning(logReport: Option[LogReport]) extends AdapterMsg
 // each LogEntry that is created by the AdapterProcess
 case class LogEntryMsg(logEntry: LogEntry) extends AdapterMsg
 
+// sent when the Adapter Process is started
+case object RunStarted extends AdapterMsg
+
 // sent when the Adapter Process finished
 case class RunFinished(logReport: LogReport) extends AdapterMsg