iss #12: frontend pipeline with babel js, less; dev mode; build info

.gitignore

@@ -27,3 +27,5 @@ lib_managed/
 src_managed/
 project/boot/
 project/plugins/project/
+
+node_modules/

.travis.yml

@@ -4,12 +4,19 @@ cache:
     - $HOME/.m2/repository
     - $HOME/.sbt
     - $HOME/.ivy2
+    - $HOME/.nvm
 language: scala
 jdk:
   - oraclejdk8
 scala:
   - 2.11.7
 script:
+  - nvm --version
+  - nvm install 4
+  - nvm use 4
+  - npm install -g npm@'>=2.5'
+  - node --version
+  - npm --version
   - sbt ++$TRAVIS_SCALA_VERSION clean coverage test coverageReport
   - sbt ++$TRAVIS_SCALA_VERSION coverageAggregate
 after_success:

README.md

@@ -9,9 +9,19 @@ _TBA_
 
 `sbt test`
 
-## Start the server
 
-`sbt server/run`
+## Start the server in dev mode
+
+Dev requirements: node 4.1+, npm 2.5+.
+
+Run server in dev mode
+`sbt -DassetsMode=dev server/run`
+
+Compile assets:
+`sbt server/compile:assets`
+
+or start in the watch mode (after any changes happens assets will be automatically recompiled):
+`sbt ~server/compile:assets`
 
 
 ## Compile all artifacts

build.sbt

@@ -4,4 +4,5 @@ version := "0.0.1"
 scalaVersion := "2.11.7"
 
 lazy val api = project.in(file("api"))
+
 lazy val server = project.in(file("server")).dependsOn(api)

project/plugins.sbt

@@ -1,6 +1,7 @@
-logLevel := Level.Warn
+logLevel := Level.Info
 
 resolvers += "sonatype-releases" at "https://oss.sonatype.org/content/repositories/releases/"
+resolvers += "Typesafe repository" at "http://repo.typesafe.com/typesafe/releases/"
 
 addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.1")
 
@@ -11,3 +12,7 @@ addSbtPlugin("org.scalastyle" %% "scalastyle-sbt-plugin" % "0.8.0")
 addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.3.5")
 
 addSbtPlugin("org.scoverage" % "sbt-coveralls" % "1.1.0")
+
+addSbtPlugin("io.teamscala.sbt" % "sbt-babel" % "1.0.3")
+
+addSbtPlugin("com.typesafe.sbt" % "sbt-less" % "1.1.0")

server/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015", "react"]
+}

server/build.sbt

@@ -1,4 +1,4 @@
-enablePlugins(JavaServerAppPackaging)
+enablePlugins(JavaServerAppPackaging, SbtWeb)
 
 name := "cheesecake-server"
 organization := "ru.maizy"
@@ -8,6 +8,10 @@ scalaVersion := "2.11.7"
 val akkaVersion = "2.4.2"
 val akkaStreamsVersion = akkaVersion
 
+val immutableJsVersion = "3.8.1"
+val reactVersion = "15.0.1"
+val bootstrapVersion = "3.3.6"
+
 libraryDependencies ++= Seq(
   "ch.qos.logback" % "logback-classic" % "1.1.3",
   "com.github.scopt" %% "scopt" % "3.3.0",
@@ -40,3 +44,27 @@ testScalastyle := org.scalastyle.sbt.ScalastylePlugin.scalastyle.in(Test).toTask
 testScalastyleInCompile := org.scalastyle.sbt.ScalastylePlugin.scalastyle.in(Compile).toTask("").value
 (test in Test) <<= (test in Test) dependsOn (testScalastyle, testScalastyleInCompile)
 scalastyleFailOnError := true
+
+// Build info
+resourceGenerators in Compile += Def.task {
+  val file = (resourceManaged in Compile).value / "buildinfo.properties"
+  val contents = Seq(
+    s"version=${version.value}",
+    s"name=${name.value}",
+    s"buildTime=${System.currentTimeMillis()}",
+    s"frontend.immutable=$immutableJsVersion",
+    s"frontend.react=$reactVersion",
+    s"frontend.bootstrap=$bootstrapVersion"
+  ).mkString("\n")
+  IO.write(file, contents)
+  Seq(file)
+}.taskValue
+
+// Frontend settings
+JsEngineKeys.engineType := JsEngineKeys.EngineType.Node
+libraryDependencies ++= Seq(
+  "org.webjars.npm" % "immutable" % immutableJsVersion,
+  "org.webjars.npm" % "react" % reactVersion,
+  "org.webjars.npm" % "react-dom" % reactVersion,
+  "org.webjars.npm" % "bootstrap" % bootstrapVersion
+)

server/package.json

@@ -0,0 +1,7 @@
+{
+  "devDependencies": {
+    "babel-core": "6.7.7",
+    "babel-preset-es2015": "6.6.0",
+    "babel-preset-react": "6.5.0"
+  }
+}

server/src/main/assets/js/test-react.jsx

@@ -0,0 +1,15 @@
+// tutorial1.js
+var CommentBox = React.createClass({
+  render: function() {
+    return (
+      <div className="commentBox">
+        Hello, world! I am a CommentBox.
+      </div>
+    );
+  }
+});
+
+ReactDOM.render(
+  <CommentBox />,
+  document.getElementById('content')
+);

server/src/main/assets/js/test.es6

@@ -0,0 +1,3 @@
+{
+    var test = [1, 2, 3].map(x => x * 2);
+}

server/src/main/assets/stylesheets/main.less

@@ -0,0 +1,3 @@
+body {
+  background: #ddd;
+}

server/src/main/resources/web-ui/index.html → server/src/main/public/index.html

@@ -1,18 +1,20 @@
-<!DOCTYPE HTML>
+<!DOCTYPE html>
 <html lang="ru">
 <head>
     <title>cheesecake</title>
     <meta charset="utf-8"/>
+    <link href="/assets/stylesheets/main.css" rel="stylesheet" type="text/css"/>
 </head>
 
 <body>
 
 <h1>State</h1>
 
-<div id="container"/>
+<div id="container"></div>
 
 <script src="/assets/js/http-utils.js"></script>
 <script src="/assets/js/results.js"></script>
+<script src="/libs/immutable/dist/immutable.min.js"></script>
 <script>
     cheesecake.results = new cheesecake.ResultsComponent({
         container: document.getElementById("container"),

server/src/main/scala/ru/maizy/cheesecake/server/BuildInfo.scala

@@ -0,0 +1,32 @@
+package ru.maizy.cheesecake.server
+
+import java.time.{ Instant, ZoneId, ZonedDateTime }
+import java.util.Properties
+
+/**
+ * Copyright (c) Nikita Kovaliov, maizy.ru, 2016
+ * See LICENSE.txt for details.
+ */
+case object BuildInfo {
+
+  private val buildProperties: Map[String, Option[String]] = {
+    val props = new Properties
+    Option(getClass.getClassLoader.getResourceAsStream("buildinfo.properties"))
+      .foreach(props.load)
+    Map(
+      "version" -> Option(props.getProperty("version")),
+      "name" -> Option(props.getProperty("name")),
+      "buildTime" -> Option(props.getProperty("buildTime"))
+    )
+  }
+
+  def version: String = buildProperties("version").getOrElse("0.0.0")
+  def projectName: String = buildProperties("name").getOrElse("cheesecake-server")
+  def buildTime: ZonedDateTime = {
+    val utc = ZoneId.of("UTC")
+    buildProperties("buildTime")
+      .map { t => ZonedDateTime.ofInstant(Instant.ofEpochMilli(t.toLong), utc) }
+      .getOrElse(ZonedDateTime.now().withZoneSameInstant(utc))
+  }
+
+}

server/src/main/scala/ru/maizy/cheesecake/server/Version.scala

@@ -1,14 +1,17 @@
 package ru.maizy.cheesecake.server
 
+import java.util.Properties
+
 /**
  * Copyright (c) Nikita Kovaliov, maizy.ru, 2016
  * See LICENSE.txt for details.
  */
 
 
 object Version {
-  val asSeq: Seq[Int] = Seq(0, 0, 1)
-  val literal: String = asSeq.mkString(".")
+
+  val literal: String = BuildInfo.version
+  val asSeq: Seq[Int] = literal.split(".").map(_.toInt)
 
   override def toString: String = literal
 }

server/src/main/scala/ru/maizy/cheesecake/server/WebUI.scala

@@ -6,31 +6,59 @@ package ru.maizy.cheesecake.server
  */
 
 
+import java.nio.file.{ Path, Paths }
 import akka.actor.ActorSystem
 import akka.http.scaladsl.server.Directives._
 import akka.http.scaladsl.server.Route
 
 
 class WebUI(system: ActorSystem) {
 
-  val routes: Route =
-    pathSingleSlash {
-      encodeResponse {
-        getFromResource("web-ui/index.html")
-      }
-    } ~
-    pathPrefix("assets") {
-      encodeResponse {
-        get {
-          getFromResourceDirectory("web-ui/assets")
+  val WEBJARS = "webjars"
+  val ASSETS = "assets"
+  val LIBS = "libs"
+
+  private val staticRoutes: Route = {
+    val devMode = System.getProperty("assetsMode") == "dev"
+    if (devMode) {
+      // TODO: is there any way to compile assets to the same dir as in an assemblied jar?
+      val webRoot = Paths.get("server/target/web").toAbsolutePath
+      val compiledStatic = s"${webRoot.toString}/public/main"
+      pathSingleSlash {
+        encodeResponse {
+          getFromFile(s"$compiledStatic/index.html")
+        }
+      } ~
+      pathPrefix(ASSETS) {
+        encodeResponse {
+          get(getFromDirectory(compiledStatic))
+        }
+      } ~
+      pathPrefix(LIBS) {
+        encodeResponse {
+          get(getFromDirectory(s"${webRoot.toString}/node-modules/main/$WEBJARS"))
         }
       }
-    } ~
-    path("ping") {
-      get {
-        complete {
-          "pong"
+    } else {
+      val projectWebjar = s"$WEBJARS/${BuildInfo.projectName}/$Version"
+      pathSingleSlash {
+        encodeResponse {
+          getFromResource(s"$projectWebjar/index.html")
+        }
+      } ~
+      pathPrefix(ASSETS) {
+        encodeResponse {
+          get(getFromResourceDirectory(s"$projectWebjar"))
+        }
+      } ~
+      // TODO: find better solution
+      pathPrefix(s"$LIBS/immutable") {
+        encodeResponse {
+          get(getFromResourceDirectory(s"$WEBJARS/immutable/3.7.5"))
         }
       }
     }
+  }
+
+  val routes: Route = staticRoutes
 }

server/src/main/scala/ru/maizy/cheesecake/server/jsonapi/JsonApi.scala

@@ -12,8 +12,9 @@ import akka.pattern.ask
 import akka.http.scaladsl.server.Directives._
 import akka.http.scaladsl.server.Route
 import akka.util.Timeout
+import ru.maizy.cheesecake.server.{ BuildInfo, Version }
 import ru.maizy.cheesecake.server.checker.CheckStatus
-import ru.maizy.cheesecake.server.jsonapi.models.{ AppConfigs, FullView }
+import ru.maizy.cheesecake.server.jsonapi.models.{ AppConfigs, AppVersion, FullView }
 import ru.maizy.cheesecake.server.resultsstorage.{ AggregateType, AggregatedResults, AllEndpoints }
 import ru.maizy.cheesecake.server.resultsstorage.{ GetAggregatedResults, GetAllEndpoints, LastResultAggregate }
 import ru.maizy.cheesecake.server.resultsstorage.SimpleAggregate
@@ -38,17 +39,28 @@ class JsonApi(system: ActorSystem, host: String, port: Int) extends JsonApiMarsh
     path("configs") {
       get {
         complete {
-          // TODO: build from app config
           AppConfigs(wsStateUrl = "/ws/state")
         }
       }
     }
 
+  private val status: Route =
+    path("version") {
+      get {
+        complete {
+          AppVersion(Version.literal, BuildInfo.buildTime)
+        }
+      }
+    } ~ path("status") {
+      get {
+        complete("ok")
+      }
+    }
+
   val routes: Route = logRequestResult("cheesecake-json-api") {
     configs ~
-      pathPrefix("services") {
-        services
-      }
+    status ~
+    pathPrefix("services")(services)
   }
 
   def storageRef: Future[ActorRef] =

server/src/main/scala/ru/maizy/cheesecake/server/jsonapi/JsonApiMarshallers.scala

@@ -5,14 +5,17 @@ package ru.maizy.cheesecake.server.jsonapi
  * See LICENSE.txt for details.
  */
 
-import ru.maizy.cheesecake.server.jsonapi.models.AppConfigs
-import ru.maizy.cheesecake.server.marshallers.{ FullViewJsonMarshallers, JsonMarshaller, ServiceJsonMarshallers }
+import ru.maizy.cheesecake.server.jsonapi.models.{ AppConfigs, AppVersion }
+import ru.maizy.cheesecake.server.marshallers.{ DateTimeMarshallers, FullViewJsonMarshallers, JsonMarshaller }
+import ru.maizy.cheesecake.server.marshallers.ServiceJsonMarshallers
 
 
 trait JsonApiMarshallers
   extends ServiceJsonMarshallers
   with FullViewJsonMarshallers
+  with DateTimeMarshallers
   with JsonMarshaller
 {
   implicit val configFormat = jsonFormat1(AppConfigs)
+  implicit val versionFormat = jsonFormat2(AppVersion)
 }

server/src/main/scala/ru/maizy/cheesecake/server/jsonapi/models/AppConfigs.scala

@@ -1,7 +1,10 @@
 package ru.maizy.cheesecake.server.jsonapi.models
 
+import java.time.ZonedDateTime
+
 /**
  * Copyright (c) Nikita Kovaliov, maizy.ru, 2016
  * See LICENSE.txt for details.
  */
 case class AppConfigs(wsStateUrl: String)
+case class AppVersion(version: String, buildTime: ZonedDateTime)