refactor(frontend): remove examples from wrong place

Author: cric96

frontend/src/main/resources/config/examples.json

@@ -1,6 +1,6 @@
 package it.unibo.scafi.js
-
-import it.unibo.scafi.js.code._
+import upickle.default._
+import it.unibo.scafi.js.code.{ExampleGroup, _}
 import it.unibo.scafi.js.controller.local
 import it.unibo.scafi.js.controller.local._
 import it.unibo.scafi.js.dsl.semantics._
@@ -76,32 +76,6 @@ object Index {
     300
   )
 
-  def buildTour(controls: SimulationControlsSection): PopoverProgression.Builder = SkeletonPage.popoverTourBuilder
-    .addNextPopover(
-      attachTo = controls.loadButton.id,
-      title = "Load code",
-      text = "Every time you edit your code and want to load it onto the network, click here ...",
-      direction = Popover.Bottom
-    )
-    .addNextPopover(
-      attachTo = controls.startButton.id,
-      title = "Start the simulation",
-      text = "... and then start the simulation here"
-    )
-    .addNextPopover(
-      attachTo = controls.stopButton.id,
-      title = "Stop the simulation",
-      text = "You can stop the simulation with this button to restart it later."
-    )
-    .addNextPopover(
-      attachTo = controls.tick.id,
-      title = "Tick-by-tick progression",
-      text = "You can also progress in the simulation tick-by-tick using this button."
-    )
-    // TODO add batch description
-    // TODO add period description
-    .andFinally(() => Cookie.store("visited", "true"))
-
   def scafiInitialization(mode: EditorSection.Mode): Unit = {
     implicit val context: Scheduler = Execution.timeoutBasedScheduler
     // dynamic part configuration
@@ -129,7 +103,7 @@ object Index {
     // force repaint
     support.invalidate()
     SkeletonPage.visualizationSection.focus()
-    val tour = buildTour(controls).start()
+    val tour = Tour(controls).start()
     PopoverProgression.ResetButton.render(tour, SkeletonPage.navRightSide)
     if (!Cookie.get("visited").exists(_.toBoolean)) {
       val modal = welcomeModal
@@ -140,15 +114,14 @@ object Index {
       }
       modal.show()
     }
-
     PageBus.publish(configuration) // tell to all component the new configuration installed on the frontend
-    val example = Seq(BasicExamples(), LibraryExamples(), MatrixLedExample(), MovementExamples(), HighLevelExamples())
-    // PageStructure.static()
     PageStructure.resizable()
     if (mode == EditorSection.JavascriptMode) {
       editor.setCode("", mode)
     } else {
-      val exampleChooser = new ExampleChooser(SkeletonPage.selectionProgram, example, configurationSection, editor)
+      ExampleProvider
+        .race(ExampleProvider.fromGlobal(), ExampleProvider.fromRemote())
+        .foreach(examples => new ExampleChooser(SkeletonPage.selectionProgram, examples, configurationSection, editor))
     }
   }
   @JSExportTopLevel("ScafiBackend")

frontend/src/main/scala/it/unibo/scafi/js/Index.scala

@@ -0,0 +1,33 @@
+package it.unibo.scafi.js
+
+import it.unibo.scafi.js.utils.Cookie
+import it.unibo.scafi.js.view.dynamic.{Popover, PopoverProgression, SimulationControlsSection}
+import it.unibo.scafi.js.view.static.SkeletonPage
+
+object Tour {
+  def apply(controls: SimulationControlsSection): PopoverProgression.Builder = SkeletonPage.popoverTourBuilder
+    .addNextPopover(
+      attachTo = controls.loadButton.id,
+      title = "Load code",
+      text = "Every time you edit your code and want to load it onto the network, click here ...",
+      direction = Popover.Bottom
+    )
+    .addNextPopover(
+      attachTo = controls.startButton.id,
+      title = "Start the simulation",
+      text = "... and then start the simulation here"
+    )
+    .addNextPopover(
+      attachTo = controls.stopButton.id,
+      title = "Stop the simulation",
+      text = "You can stop the simulation with this button to restart it later."
+    )
+    .addNextPopover(
+      attachTo = controls.tick.id,
+      title = "Tick-by-tick progression",
+      text = "You can also progress in the simulation tick-by-tick using this button."
+    )
+    // TODO add batch description
+    // TODO add period description
+    .andFinally(() => Cookie.store("visited", "true"))
+}

frontend/src/main/scala/it/unibo/scafi/js/Tour.scala

@@ -1,3 +1,8 @@
 package it.unibo.scafi.js.code
 
+import upickle.default._
+
 case class ExampleGroup(groupName: String, examples: Seq[Example])
+object ExampleGroup {
+  implicit def exampleGroupRW: ReadWriter[ExampleGroup] = macroRW[ExampleGroup]
+}

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

@@ -0,0 +1,37 @@
+package it.unibo.scafi.js.code
+
+import it.unibo.scafi.js.utils.GlobalStore
+import org.scalajs.dom.ext.Ajax
+
+import scala.concurrent.{ExecutionContext, Future}
+import upickle.default._
+
+import scala.util.Success
+
+trait ExampleProvider {
+  def getExamples: Future[Seq[ExampleGroup]]
+}
+
+object ExampleProvider {
+  private val storeKey = "examples"
+  /** Combine provider by requesting the example in order. the first provider that returns a sequence of example
+    * provider successfully complete the future
+    * @param providers
+    *   the sequence of provider that tries to load examples
+    */
+  def race(providers: ExampleProvider*)(implicit context: ExecutionContext): Future[Seq[ExampleGroup]] =
+    providers.map(_.getExamples).reduce((resultingFuture, current) => resultingFuture.recoverWith { case _ => current })
+
+  def fromRemote()(implicit context: ExecutionContext): ExampleProvider = new ExampleProvider {
+    override def getExamples: Future[Seq[ExampleGroup]] = Ajax
+      .get("/config/examples.json")
+      .map(_.responseText)
+      .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)))
+  }
+}