Refactor build.sbt

Change-Id: I26f35d29a9f35e9f0bacaad1641b8be5629a41bf

Author: Guillaume Bort

.flowconfig

@@ -14,6 +14,5 @@ module.file_ext=.js
 module.file_ext=.css
 module.file_ext=.less
 
-module.name_mapper='^VizSQL$' -> 'empty/object'
 module.name_mapper.extension='css' -> 'empty/object'
 module.name_mapper.extension='less' -> 'empty/object'

.gitignore

@@ -2,3 +2,5 @@ project/target
 target
 node_modules
 .idea
+dev.config.json
+.DS_Store

.pre-commit.sh

@@ -1,4 +1,20 @@
-# Langoustine++
+# Langoustine, the good parts
+
+To work on th Scala API, run sbt using `sbt -DdevMode=true` (the devMode option allows to skip webpack execution to speed up execution). You can use `~compile` or `~test` on the root project or focus on a specific project using `~timeserie/test`.
+
+To run an example application, use `example HelloWorld` where HelloWorld is the example class name.
+
+To work on the web application: 
+
+- Install **yarn** (https://yarnpkg.com/en/).
+- Create a `dev.config.json` file in your project root:
+  ```
+    {
+      "env": {
+      },
+      "example": "HelloWorld"
+    }
+  ```
+- Run, `yarn install` and `yarn start`.
 
-The time series scheduler that keeps your data fresh.
 

README.md

@@ -1,43 +1,108 @@
-val devMode = Option(System.getProperty("devMode")).exists(_ == "true")
+val devMode = taskKey[Boolean]("Some build optimization are applied in devMode.")
 
-name := "langoustinepp"
-organization := "com.criteo"
-version := "0.1.0"
-scalaVersion := "2.12.1"
+lazy val commonSettings = Seq(
+  organization := "org.criteo.langoustine",
+  version := "dev-SNAPSHOT",
+  scalaVersion := "2.11.8",
+  scalacOptions ++= Seq(
+    "-deprecation",
+    "-encoding", "UTF-8",
+    "-feature",
+    "-unchecked",
+    "-Xlint",
+    "-Yno-adapted-args",
+    "-Ywarn-dead-code",
+    "-language:postfixOps",
+    "-Xfuture",
+    "-Ywarn-unused-import"
+  ),
+  devMode := Option(System.getProperty("devMode")).exists(_ == "true"),
 
-scalacOptions := Seq("-feature", "-deprecation")
+  // Maven config
+  resolvers += "Nexus" at "http://nexus.criteo.prod/content/repositories/criteo.thirdparty/",
+  publishTo := Some("Criteo thirdparty" at "http://nexus.criteo.prod/content/repositories/criteo.thirdparty"),
+  credentials += Credentials("Sonatype Nexus Repository Manager", "nexus.criteo.prod", System.getenv("MAVEN_USER"), System.getenv("MAVEN_PASSWORD")),
 
-mainClass in(Compile, run) := Some("com.criteo.langoustinepp.LangoustinePP")
+  // Useful to run flakey tests
+  commands += Command.single("repeat") { (state, arg) =>
+    arg :: s"repeat $arg" :: state
+  },
 
-libraryDependencies ++= Seq(
-  "org.criteo.lolhttp" %% "lolhttp" % "0.2.2",
-  "org.criteo.lolhttp" %% "loljson" % "0.2.2",
-  "org.scala-stm" %% "scala-stm" % "0.8",
-  "org.scalatest" %% "scalatest" % "3.0.1" % "test",
-  "org.scalacheck" %% "scalacheck" % "1.13.4" % "provided",
-  "codes.reactive" %% "scala-time" % "0.4.1"
+  // Run an example in another JVM, and quit on key press
+  commands += Command.single("example") { (state, arg) =>
+    s"examples/test:runMain org.criteo.langoustine.examples.TestExample $arg" :: state
+  }
 )
 
-resolvers += "Nexus" at "http://nexus.criteo.prod/content/repositories/criteo.thirdparty/"
-
-resourceGenerators in Compile += Def.task {
-  if(devMode) Nil else {
-    def listFiles(dir: File): Seq[File] = {
-      IO.listFiles(dir).flatMap(f =>
-        if (f.isDirectory) listFiles(f)
-        else Seq(f)
-      )
-    }
-    val webpackOutputDir: File = (resourceManaged in Compile).value / "public"
-    val logger = new ProcessLogger {
-      override def error(s: =>String): Unit = ()
-      override def buffer[T](f: => T): T = f
-      override def info(s: => String): Unit = streams.value.log.info(s)
-    }
-    logger.info(s"Generating UI assets to $webpackOutputDir...")
-    assert("yarn install" ! logger == 0, "yarn failed")
-    logger.info("Running webpack...")
-    assert(s"./node_modules/webpack/bin/webpack.js --output-path $webpackOutputDir --bail" ! logger == 0, "webpack failed")
-    listFiles(webpackOutputDir)
-  }
-}.taskValue
+lazy val continuum = {
+  ProjectRef(uri("git://github.com/danburkert/continuum.git#b2122f1980fb69eb0d047e47e9d7de730ccbd448"), "continuum")
+}
+
+lazy val langoustine =
+  (project in file("core")).
+  settings(commonSettings: _*).
+  settings(
+    libraryDependencies ++= Seq(
+      "org.criteo.lolhttp" %% "lolhttp",
+      "org.criteo.lolhttp" %% "loljson"
+    ).map(_ % "0.2.2"),
+
+    libraryDependencies ++= Seq(
+      "org.scala-stm" %% "scala-stm" % "0.8",
+      "codes.reactive" %% "scala-time" % "0.4.1"
+    ),
+
+    libraryDependencies ++= Seq(
+      "org.scalatest" %% "scalatest" % "3.0.1"
+    ).map(_ % "test"),
+
+    resourceGenerators in Compile += Def.task {
+      if(devMode.value) {
+        streams.value.log.warn(s"Skipping webpack resource generation.")
+        Nil
+      } else {
+        def listFiles(dir: File): Seq[File] = {
+          IO.listFiles(dir).flatMap(f =>
+            if (f.isDirectory) listFiles(f)
+            else Seq(f)
+          )
+        }
+        val webpackOutputDir: File = (resourceManaged in Compile).value / "public"
+        val logger = new ProcessLogger {
+          override def error(s: =>String): Unit = ()
+          override def buffer[T](f: => T): T = f
+          override def info(s: => String): Unit = streams.value.log.info(s)
+        }
+        logger.info(s"Generating UI assets to $webpackOutputDir...")
+        assert(s"yarn install" ! logger == 0, "yarn failed")
+        logger.info("Running webpack...")
+        assert(s"./node_modules/webpack/bin/webpack.js --output-path $webpackOutputDir --bail" ! logger == 0, "webpack failed")
+        listFiles(webpackOutputDir)
+      }
+    }.taskValue
+  ).
+  dependsOn(continuum)
+
+lazy val timeserie =
+  (project in file("timeserie")).
+  settings(commonSettings: _*).
+  settings(
+  ).
+  dependsOn(langoustine % "compile->compile;test->test")
+
+lazy val examples =
+  (project in file("examples")).
+  settings(commonSettings: _*).
+  settings(
+    fork in Test := true,
+    connectInput in Test := true
+  ).
+  dependsOn(langoustine, timeserie)
+
+lazy val root =
+  (project in file(".")).
+  settings(commonSettings: _*).
+  settings(
+    publishArtifact := false
+  ).
+  aggregate(langoustine, timeserie, examples)

build.sbt

@@ -1,10 +1,6 @@
-package com.criteo.langoustinepp
+package org.criteo.langoustine
 
-import lol.http._
-
-import scala.concurrent.Future
-import scala.concurrent.ExecutionContext
-import scala.concurrent.ExecutionContext.Implicits.global
+import scala.concurrent.{ ExecutionContext }
 
 trait Scheduler[S <: Scheduling] {
   def run(graph: Graph[S])(implicit executor: ExecutionContext): Unit
@@ -15,12 +11,11 @@ trait Scheduling {
   type DependencyDescriptor
 }
 
-
 sealed trait Graph[S <: Scheduling] {
   type Dependency = (Job[S], Job[S], S#DependencyDescriptor)
 
-  private[langoustinepp] def vertices: Set[Job[S]]
-  private[langoustinepp] def edges: Set[Dependency]
+  private[langoustine] def vertices: Set[Job[S]]
+  private[langoustine] def edges: Set[Dependency]
 
   def and(otherGraph: Graph[S]): Graph[S] = {
     val graph = this
@@ -30,14 +25,14 @@ sealed trait Graph[S <: Scheduling] {
     }
   }
 
-  private[langoustinepp] lazy val roots = vertices.filter (v =>
+  private[langoustine] lazy val roots = vertices.filter (v =>
       edges.forall { case (v1, _, _) => v1 != v })
-  private[langoustinepp] lazy val leaves = vertices.filter (v =>
+  private[langoustine] lazy val leaves = vertices.filter (v =>
       edges.forall { case (_, v2, _) => v2 != v })
 
   def dependsOn(right: Graph[S])
   (implicit depDescriptor: S#DependencyDescriptor): Graph[S] =
-    dependsOn(right, depDescriptor)
+    dependsOn((right, depDescriptor))
 
   def dependsOn(right: (Graph[S], S#DependencyDescriptor)): Graph[S] = {
     val (rightGraph, depDescriptor) = right
@@ -57,26 +52,3 @@ case class Job[S <: Scheduling](name: String, scheduling: S) extends Graph[S] {
   val vertices = Set(this)
   val edges = Set.empty[Dependency]
 }
-
-/* Ping-pong stuff */
-
-object LangoustinePPServer {
-  val routes: PartialService = {
-    case GET at "/" =>
-      Redirect("/ping")
-
-    case GET at "/ping" =>
-      Ok("pong!")
-  }
-
-  def main(args: Array[String]): Unit = {
-    val httpPort = args.lift(0).map(_.toInt).getOrElse(8888)
-    Server.listen(
-      port = httpPort,
-      onError = { e =>
-        e.printStackTrace()
-        InternalServerError("LOL.")
-      })(routes)
-    println(s"Listening on http://localhost:$httpPort")
-  }
-}

src/main/html/index.html renamed to core/src/main/html/index.html

@@ -0,0 +1,25 @@
+package org.criteo.langoustine
+
+import lol.http._
+
+import scala.concurrent.ExecutionContext.Implicits.global
+
+object Langoustine {
+  val routes: PartialService = {
+    case GET at "/" =>
+      Redirect("/ping")
+
+    case GET at "/ping" =>
+      Ok("pong!!!")
+  }
+
+  def run[S <: Scheduling](worflow: Graph[S], httpPort: Int = 8888)(implicit scheduler: Scheduler[S]) = {
+    Server.listen(
+      port = httpPort,
+      onError = { e =>
+        e.printStackTrace()
+        InternalServerError("LOL.")
+      })(routes)
+    println(s"Listening on http://localhost:$httpPort")
+  }
+}

src/main/javascript/actions.js renamed to core/src/main/javascript/actions.js

@@ -1,4 +1,4 @@
-package com.criteo.langoustinepp
+package org.criteo.langoustine
 
 import org.scalatest.FunSuite
 

src/main/javascript/index.js renamed to core/src/main/javascript/index.js

@@ -1,3 +1,6 @@
+if(!require('fs').existsSync('dev.config.json')) {
+  throw new Error(`Missing dev.config.json file in your project, please check the README.`);
+}
 let config = loadJson('dev.config.json');
 
 let sbt = startSbt({
@@ -7,30 +10,39 @@ let sbt = startSbt({
 
 let compile = sbt.run({
     command: 'compile',
-    watch: ['src/**/*.scala']
+    watch: ['**/*.scala']
 });
 
 let packageDependencies = sbt.run({
-    command: 'assemblyPackageDependency'
+    command: 'examples/assemblyPackageDependency'
 });
 
 let yarn = run({
   sh: 'yarn install',
   watch: 'package.json'
-}).dependsOn(packageDependencies);
+});
 
 let front = webpack({
   watch: [
     'webpack.config.js',
-    'src/main/javascript/**/*.js',
-    'src/main/html/**/*.html',
-    'src/main/style/**/*.*'
+    'core/src/main/javascript/**/*.*',
+    'core/src/main/html/**/*.*',
+    'core/src/main/style/**/*.*'
   ]
 }).dependsOn(yarn);
 
+let classpath = [
+  'examples/target/scala-2.11/langoustine-assembly-dev-SNAPSHOT-deps.jar',
+  'core/target/scala-2.11/classes',
+  'timeserie/target/scala-2.11/classes',
+  'examples/target/scala-2.11/classes'
+];
+
+let example = config.example || 'HelloWorld';
+
 let server = runServer({
   httpPort,
-  sh: `java -cp target/scala-2.11/langoustinepp-assembly-0.1.0-deps.jar:target/scala-2.11/classes com.criteo.langoustinepp.LangoustinePPServer ${httpPort}`,
+  sh: `java -cp ${classpath.join(':')} org.criteo.langoustine.examples.${example} ${httpPort}`,
   env: config.env
 }).dependsOn(compile, packageDependencies);
 

src/main/javascript/layout/app.js renamed to core/src/main/javascript/layout/app.js

@@ -0,0 +1,18 @@
+package org.criteo.langoustine.examples
+
+import org.criteo.langoustine._
+import timeserie._
+
+object HelloWorld {
+
+  def main(args: Array[String]): Unit = {
+
+    val hello = Job("hello", hourly())
+    val world = Job("world", hourly())
+
+    Langoustine.run(
+      world dependsOn hello,
+      httpPort = args.lift(0).map(_.toInt).getOrElse(8888))
+  }
+
+}

src/main/javascript/layout/menu.js renamed to core/src/main/javascript/layout/menu.js

@@ -0,0 +1,23 @@
+package org.criteo.langoustine.examples
+
+object TestExample {
+
+  def main(args: Array[String]): Unit = {
+    val example = args.headOption.getOrElse(sys.error("Please specify the example to run as argument"))
+    val forked = new ProcessBuilder(
+      "java", "-cp",
+      System.getProperty("java.class.path"), s"org.criteo.langoustine.examples.$example").inheritIO.start()
+
+    new Thread() {
+      override def run: Unit = {
+        println(s"-- example `$example` started, press [Ctrl+D] to quit")
+        while (System.in.read != -1) ()
+        forked.destroy()
+      }
+    }.start()
+
+    forked.waitFor
+    System.exit(0)
+  }
+
+}