refactor: prefer typed key against strings

Author: cric96

frontend/src/main/scala/it/unibo/scafi/js/code/ExampleProvider.scala

@@ -13,7 +13,10 @@ trait ExampleProvider {
 }
 
 object ExampleProvider {
-  private val storeKey = "examples"
+  private val storeKey = new GlobalStore.Key {
+    override type Data = String
+    override val value: String = "examples"
+  }
   private val examplesPath = s"${dom.window.location.href}config/examples.json"
   /** Combine provider by requesting the example in order. the first provider that returns a sequence of example
     * provider successfully complete the future
@@ -27,12 +30,12 @@ object ExampleProvider {
     override def getExamples: Future[Seq[ExampleGroup]] = Ajax
       .get(examplesPath)
       .map(_.responseText)
-      .andThen { case Success(value) => GlobalStore.put(storeKey, value) }
+      .andThen { case Success(value) => GlobalStore.put(storeKey)(value) }
       .map(result => read[Seq[ExampleGroup]](result))
   }
 
   def fromGlobal()(implicit context: ExecutionContext): ExampleProvider = new ExampleProvider {
     override def getExamples: Future[Seq[ExampleGroup]] =
-      Future.fromTry(GlobalStore.get[String](storeKey).map(data => read[Seq[ExampleGroup]](data)))
+      Future.fromTry(GlobalStore.get(storeKey).map(data => read[Seq[ExampleGroup]](data)))
   }
 }

frontend/src/main/scala/it/unibo/scafi/js/controller/local/SupportConfiguration.scala

@@ -36,12 +36,16 @@ case class SupportConfiguration(
     coordinateMapping: CoordinateMapping = Identity
 )
 object SupportConfiguration {
+  val key = new GlobalStore.Key {
+    override type Data = String
+    override val value: String = "configuration"
+  }
   implicit def supportConfigurationRW: ReadWriter[SupportConfiguration] = macroRW[SupportConfiguration]
 
-  def storeGlobal(config: SupportConfiguration): Unit = GlobalStore.put("configuration", write(config))
+  def storeGlobal(config: SupportConfiguration): Unit = GlobalStore.put(key)(write(config))
 
   def loadGlobal(): Try[SupportConfiguration] =
-    GlobalStore.get[String]("configuration").flatMap(elem => Try(read[SupportConfiguration](elem)))
+    GlobalStore.get(key).flatMap(elem => Try(read[SupportConfiguration](elem)))
 }
 
 /** top level trait to describe a network configuration that tells how node are placed in the world. */

frontend/src/main/scala/it/unibo/scafi/js/utils/GlobalStore.scala

@@ -8,29 +8,37 @@ import scala.scalajs.js
 import scala.util.{Failure, Success, Try}
 
 object GlobalStore {
+  /** Express any kind of Key accepted by the global store. It piggyback the data type stored inside the store. To
+    * create a key, use anonymous class: val key = new GlobalStore.Key { type Data = Something val keyValue =
+    * "something" }
+    */
+  trait Key {
+    type Data
+    val value: String
+  }
   private val bus = new EventBus()
-  private case class GlobalData[A](name: String, value: A)
+  private case class GlobalData[A](key: String, value: A)
   private val store = window.asInstanceOf[js.Dynamic] // a non safe way, think other possibilities
-  def put(name: String, value: Any): Unit = {
-    store.updateDynamic(name)(value.asInstanceOf[js.Any])
-    bus.publish(GlobalData(name, value))
+  def put(key: Key)(value: key.Data): Unit = {
+    store.updateDynamic(key.value)(value.asInstanceOf[js.Any])
+    bus.publish(GlobalData(key.value, value))
   }
-  def listen[A](name: String)(on: A => Unit): CancelableFuture[Unit] = bus.listen { case GlobalData(`name`, value: A) =>
-    on(value)
+  def listen(key: Key)(on: key.Data => Unit): CancelableFuture[Unit] = bus.listen { case GlobalData(key.value, value) =>
+    on(value.asInstanceOf[key.Data])
   }
-  def get[A](name: String): Try[A] = {
-    Try(store.selectDynamic(name).asInstanceOf[A]).flatMap {
+  def get(key: Key): Try[key.Data] = {
+    Try(store.selectDynamic(key.value).asInstanceOf[key.Data]).flatMap {
       case obj if js.isUndefined(obj) => Failure(new IllegalArgumentException("object not in global scope"))
       case other => Success(other)
     }
   }
-  def getOrElse[A](name: String, orElse: A): A =
-    get[A](name).getOrElse(orElse)
-  def getOrElseUpdate[A](name: String, orElse: A): A = {
-    get[A](name) match {
+  def getOrElse(name: Key)(orElse: name.Data): name.Data =
+    get(name).getOrElse(orElse)
+  def getOrElseUpdate(name: Key)(orElse: name.Data): name.Data = {
+    get(name) match {
       case Success(value) => value
       case Failure(_) =>
-        put(name, orElse)
+        put(name)(orElse)
         orElse
     }
   }

frontend/src/main/scala/it/unibo/scafi/js/view/dynamic/EditorSection.scala

@@ -23,7 +23,14 @@ trait EditorSection {
 }
 
 object EditorSection {
-
+  val modeKey = new GlobalStore.Key {
+    type Data = Mode
+    override val value: String = "mode"
+  }
+  val docKey = new GlobalStore.Key {
+    override type Data = Doc
+    override val value: String = "doc"
+  }
   trait Mode extends js.Object {
     def lang: String
 
@@ -77,7 +84,7 @@ object EditorSection {
   }
 
   private class EditorSectionImpl(editorZone: Div, defaultMode: Mode = ScalaModeEasy) extends EditorSection {
-    var mode: Mode = GlobalStore.get[Mode]("mode") match {
+    var mode: Mode = GlobalStore.get(EditorSection.modeKey) match {
       case Failure(exception) => defaultMode
       case Success(mode) => mode
     }
@@ -101,7 +108,7 @@ object EditorSection {
         modeSelection.on()
       }
     )
-    val editor = GlobalStore.get[Doc]("doc") match {
+    val editor = GlobalStore.get(docKey) match {
       case Success(doc) =>
         val config = new EditorConfiguration(doc.getValue(), mode.codeMirrorMode, "native", true, "material")
         val editor = CodeMirror(editorZone, config)
@@ -114,7 +121,7 @@ object EditorSection {
     ThemeSwitcher.onDark(editor.setOption("theme", "material"))
     ThemeSwitcher.onLight(editor.setOption("theme", "default"))
 
-    GlobalStore.put("doc", editor.doc)
+    GlobalStore.put(docKey)(editor.doc)
     modeSelection.onClick = () => {
       if (mode.lang == ScalaModeEasy.lang) {
         val fullCode = ScalaModeEasy.convertToFull(this.getRaw())
@@ -132,7 +139,7 @@ object EditorSection {
         case _ =>
       }
       editor.setValue(code)
-      GlobalStore.put("mode", mode)
+      GlobalStore.put(modeKey)(mode)
       this.mode = mode
       editor.setOption("mode", mode.codeMirrorMode)
     }

frontend/src/main/scala/it/unibo/scafi/js/view/dynamic/SimulationControlsSection.scala

@@ -53,6 +53,7 @@ class SimulationControlsSection {
         simulation = Some(daemon)
         stopButton.disabled = false
         (tick :: startButton :: Nil) foreach { el => el.disabled = true }
+      case _ =>
     }
 
   tick.onclick = _ =>
@@ -115,8 +116,11 @@ class SimulationControlsSection {
   }
 
   private case class VelocitySelector(slow: Int, normal: Int, fast: Int) extends HtmlRenderable[Element] {
-    private val globalLabel = "velocitySelector"
-    val active: String = GlobalStore.getOrElseUpdate(globalLabel, "slow")
+    private val key = new GlobalStore.Key {
+      override type Data = String
+      override val value: String = "velocitySelector"
+    }
+    val active: String = GlobalStore.getOrElseUpdate(key)("slow")
     var onChangeRadio: () => Unit = () => {}
     var batchSize: Int = active match {
       case "slow" => slow
@@ -164,7 +168,7 @@ class SimulationControlsSection {
         "change",
         () => {
           batchSize = value
-          GlobalStore.put(globalLabel, name)
+          GlobalStore.put(key)(name)
           onChangeRadio()
         }
       )

frontend/src/main/scala/it/unibo/scafi/js/view/dynamic/ThemeSwitcher.scala

@@ -10,19 +10,22 @@ import scalatags.JsDom.all
 import scala.scalajs.js
 
 object ThemeSwitcher {
-
   import all._
 
+  private val keyTheme = new GlobalStore.Key {
+    override type Data = Theme
+    override val value: String = "theme"
+  }
   private val lightStyle = link(id := "light", rel := "stylesheet", href := "style/light.css").render
 
-  private var theme: Theme = GlobalStore.get[Theme]("theme").getOrElse(Dark)
+  private var theme: Theme = GlobalStore.get(keyTheme).getOrElse(Dark)
 
-  def onLight(action: => Unit): CancelableFuture[Unit] = GlobalStore.listen[Theme]("theme") {
+  def onLight(action: => Unit): CancelableFuture[Unit] = GlobalStore.listen(keyTheme) {
     case theme if theme.value == Light.value => action
     case _ =>
   }
 
-  def onDark(action: => Unit): CancelableFuture[Unit] = GlobalStore.listen[Theme]("theme") {
+  def onDark(action: => Unit): CancelableFuture[Unit] = GlobalStore.listen(keyTheme) {
     case theme if theme.value == Dark.value => action
     case _ =>
   }
@@ -43,7 +46,7 @@ object ThemeSwitcher {
   }
 
   private def install(theme: Theme): Unit = {
-    GlobalStore.put("theme", theme)
+    GlobalStore.put(keyTheme)(theme)
     theme.value match {
       case Light.value if !exist(lightStyle.id) => document.head.appendChild(lightStyle)
       case Dark.value if exist(lightStyle.id) => $(s"#${lightStyle.id}").remove()

frontend/src/main/scala/it/unibo/scafi/js/view/dynamic/VisualizationSettingsSection.scala

@@ -30,9 +30,11 @@ object VisualizationSettingsSection {
       override val sensorsMenu: SensorsMenu,
       visualizationDropMenu: Div
   ) extends VisualizationSettingsSection {
-    private val labelsEnabledGlobal = "labelEnabled"
-    private val labels = GlobalStore.getOrElseUpdate(
-      labelsEnabledGlobal,
+    private val labelsEnabledKey = new GlobalStore.Key {
+      type Data = js.Dictionary[Boolean]
+      override val value = "labelEnabled"
+    }
+    private val labels = GlobalStore.getOrElseUpdate(labelsEnabledKey)(
       js.Dictionary(
         "id" -> true,
         "neighborhood" -> true,
@@ -52,8 +54,7 @@ object VisualizationSettingsSection {
     private val minNodeSize = 4
     private val maxNodeSize = 20
     private val standardNodeSize = 7
-    val initialConfig = GlobalStore.getOrElseUpdate(
-      VisualizationSetting.globalName,
+    private val initialConfig = GlobalStore.getOrElseUpdate(VisualizationSetting.key)(
       VisualizationSetting(standardFontSize, standardNodeSize)
     )
     private val fontSizeTag = NumericVizInput(
@@ -62,8 +63,8 @@ object VisualizationSettingsSection {
       maxFontSize,
       initialConfig.fontSize,
       font => {
-        val config = GlobalStore.get[VisualizationSetting](VisualizationSetting.globalName).get
-        GlobalStore.put(VisualizationSetting.globalName, config.changeFont(font))
+        val config = GlobalStore.get(VisualizationSetting.key).get
+        GlobalStore.put(VisualizationSetting.key)(config.changeFont(font))
       }
     )
     private val nodeSizeTag = NumericVizInput(
@@ -72,8 +73,8 @@ object VisualizationSettingsSection {
       maxNodeSize,
       initialConfig.nodeSize,
       node => {
-        val config = GlobalStore.get[VisualizationSetting](VisualizationSetting.globalName).get
-        GlobalStore.put(VisualizationSetting.globalName, config.changeNode(node))
+        val config = GlobalStore.get(VisualizationSetting.key).get
+        GlobalStore.put(VisualizationSetting.key)(config.changeNode(node))
       }
     )
 
@@ -99,9 +100,9 @@ object VisualizationSettingsSection {
     settingDiv.appendChild(sensorsMenu.html)
 
     private def onLabelChange(e: MouseEvent, name: String): Unit = {
-      val labelsMap = GlobalStore.get[js.Dictionary[Boolean]](labelsEnabledGlobal).get
+      val labelsMap = GlobalStore.get(labelsEnabledKey).get
       labelsMap.put(name, !labelsMap(name))
-      GlobalStore.put(labelsEnabledGlobal, labelsMap)
+      GlobalStore.put(labelsEnabledKey)(labelsMap)
       Toggle.Repaint(e)
     }
   }

frontend/src/main/scala/it/unibo/scafi/js/view/dynamic/graph/LabelRender.scala

@@ -70,7 +70,7 @@ object LabelRender {
         world: Graph,
         scene: Scene
     ): Output = {
-      val (fontSize, width) = GlobalStore.get[VisualizationSetting](VisualizationSetting.globalName) match {
+      val (fontSize, width) = GlobalStore.get(VisualizationSetting.key) match {
         case Success(VisualizationSetting(fontSize, nodeWidth)) => (fontSize, nodeWidth: JSNumber)
         case Failure(_) => (fallBackSize, node.width)
       }
@@ -182,7 +182,7 @@ object LabelRender {
         world: Graph,
         scene: Scene
     ): Output = {
-      val fullMatrix = GlobalStore.get[VisualizationSetting](VisualizationSetting.globalName) match {
+      val fullMatrix = GlobalStore.get(VisualizationSetting.key) match {
         case Success(VisualizationSetting(_, nodeSize)) => (nodeSize: Double)
         case Failure(_) => fallBackSize
       }

frontend/src/main/scala/it/unibo/scafi/js/view/dynamic/graph/PhaserGraphSection.scala

@@ -57,7 +57,7 @@ class PhaserGraphSection(
   private lazy val sceneHandler: types.scenes.CreateSceneFromObjectConfig = types.scenes.callbacks(
     preload = scene => labelRenders.foreach(_.onInit(scene)),
     create = (scene, _) => {
-      GlobalStore.listen[Any](VisualizationSetting.globalName)(_ => PageBus.publish(ForceRepaint))
+      GlobalStore.listen(VisualizationSetting.key)(_ => PageBus.publish(ForceRepaint))
       val mainCamera = scene.cameras.main
       mainCamera.zoom = 1
       Debug("scene", scene)

frontend/src/main/scala/it/unibo/scafi/js/view/static/PageStructure.scala

@@ -44,27 +44,27 @@ object PageStructure {
     private val doubleClickEvent = (ev: js.Any) => {
       val backendSection = $("#backend-config-section")
       split.destroy()
-      val divisions = GlobalStore.get[PageDivision](sizesInGlobal).get
+      val divisions = GlobalStore.get(sizesKey).get
       if (divisions.collapsed) {
         divisions.elems(config) = configSection
         divisions.elems(visualization) =
           new SplitSection(divisions.elems(visualization).size - configSection.size, minVisualizationPortion)
         backendSection.show()
-        GlobalStore.put(sizesInGlobal, new PageDivision(false, divisions.elems))
+        GlobalStore.put(sizesKey)(new PageDivision(false, divisions.elems))
         split = createSplit(gutterCreator, sections, divisions.elems: _*)
       } else {
         backendSection.hide()
         val oldConfig = divisions.elems(config)
         divisions.elems(config) = empty
         divisions.elems(visualization) =
           new SplitSection(divisions.elems(visualization).size + oldConfig.size, minVisualizationPortion)
-        GlobalStore.put(sizesInGlobal, new PageDivision(true, divisions.elems))
+        GlobalStore.put(sizesKey)(new PageDivision(true, divisions.elems))
         split = createSplit(gutterCreator, sections, divisions.elems: _*)
       }
     }
 
     def install(): Unit = {
-      val divisions: PageDivision = GlobalStore.getOrElseUpdate(sizesInGlobal, standardConfig)
+      val divisions: PageDivision = GlobalStore.getOrElseUpdate(sizesKey)(standardConfig)
       val backendSection = $("#backend-config-section")
       if (divisions.collapsed) {
         backendSection.hide()
@@ -89,7 +89,7 @@ object PageStructure {
           "expandToMin" -> true,
           "onDrag" -> ((elems: js.Array[Double]) => {
             split.destroy()
-            val oldConfig = GlobalStore.get[PageDivision](sizesInGlobal).get
+            val oldConfig = GlobalStore.get(sizesKey).get
             val newPageDivision = new PageDivision(
               oldConfig.collapsed,
               js.Array(
@@ -105,7 +105,7 @@ object PageStructure {
               )
             )
             install()
-            GlobalStore.put(sizesInGlobal, newPageDivision)
+            GlobalStore.put(sizesKey)(newPageDivision)
           })
         )
       )
@@ -114,5 +114,8 @@ object PageStructure {
 
   class SplitSection(val size: Double, val minSize: Int) extends js.Object
   class PageDivision(val collapsed: Boolean, val elems: js.Array[SplitSection]) extends js.Object
-  val sizesInGlobal = "page-sizes"
+  val sizesKey = new GlobalStore.Key {
+    type Data = PageDivision
+    override val value = "page-sizes"
+  }
 }

frontend/src/main/scala/it/unibo/scafi/js/view/static/VisualizationSetting.scala

@@ -1,5 +1,7 @@
 package it.unibo.scafi.js.view.static
 
+import it.unibo.scafi.js.utils.GlobalStore
+
 import scala.scalajs.js
 
 class VisualizationSetting(val fontSize: Int, val nodeSize: Int) extends js.Object {
@@ -8,7 +10,10 @@ class VisualizationSetting(val fontSize: Int, val nodeSize: Int) extends js.Obje
   val vizPatternMatch: Unit = {}
 }
 object VisualizationSetting {
-  val globalName = "visualization-setting"
+  val key = new GlobalStore.Key {
+    type Data = VisualizationSetting
+    override val value = "visualization-setting"
+  }
   def apply(fontSize: Int, nodeSize: Int): VisualizationSetting = new VisualizationSetting(fontSize, nodeSize)
   def unapply(value: js.Object): Option[(Int, Int)] = if (value.hasOwnProperty("vizPatternMatch")) {
     val res = value.asInstanceOf[VisualizationSetting]