Merge pull request #21 from gabrielreid/20_plugin_support

Add support for query plugins #20

Author: brunoballekens

src/main/scala/io/waylay/kairosdb/driver/models/Models.scala

@@ -173,6 +173,7 @@ object KairosQuery {
   * @param order Orders the returned data points. This sorting is done before any aggregators are executed.
   * @param excludeTags By default, the result of the query includes tags and tag values associated with the data points.
   *                    If `excludeTags` is set to true, the tags will be excluded from the response.
+  * @param plugins optional plugin references to customize the behavior of the query on this metric
   */
 case class Query(
   metricName: MetricName,
@@ -181,16 +182,30 @@ case class Query(
   aggregators: Seq[Aggregator] = Seq.empty,
   limit: Option[Int] = None,
   order: Order = Order.defaultOrder,
-  excludeTags: Boolean = false)
+  excludeTags: Boolean = false,
+  plugins: Seq[QueryPlugin] = Seq.empty)
 
 /** @param timeZone The time zone for the time range of the query. If not specified, UTC is used. tz format, e.g. "Europe/Brussels"
   * @param cacheTime The amount of time in seconds to re use the cache from a previous query. When a query is made,
   *                  Kairos looks for the cache file for the query. If a cache file is found and the timestamp of the
   *                  cache file is within cache_time seconds from the current query, the cache is used.
   *                  Sending a query with a cacheTime set to 0 will always refresh the cache with new data from Cassandra.
+  * @param plugins optional plugin references to custom the behavior of this query
   */
 case class QueryMetrics(
   metrics: Seq[Query],
   timeSpan: TimeSpan,
   timeZone: Option[String] = None,
-  cacheTime: Option[Int] = None)
+  cacheTime: Option[Int] = None,
+  plugins: Seq[QueryPlugin] = Seq.empty)
+
+
+/**
+  * Reference to a plugin which can customize the behavior of a query.
+  *
+  * @param name published name of the plugin
+  * @param properties properties for the plugin within the query invocation
+  */
+case class QueryPlugin(
+  name: String,
+  properties: Map[String,Any] = Map.empty)

src/main/scala/io/waylay/kairosdb/driver/models/json/Formats.scala

@@ -305,14 +305,20 @@ object Formats {
 
   implicit val queryMetricsWrites: Writes[QueryMetrics] = new Writes[QueryMetrics] {
     override def writes(queryMetrics: QueryMetrics): JsValue = {
+      val plugins: Seq[(String, JsValue)] = if (queryMetrics.plugins.nonEmpty) {
+        Seq("plugins" -> Json.toJson(queryMetrics.plugins))
+      } else {
+        Seq.empty
+      }
+
       val fields: Seq[(String, JsValue)] = Seq(
         queryMetrics.timeSpan.startTime.fieldName -> Json.toJson(queryMetrics.timeSpan.startTime),
         "metrics" -> JsArray(queryMetrics.metrics.map(x => Json.toJson(x)))
       ) ++ Seq(
         queryMetrics.timeSpan.endTime.map(x => x.fieldName -> Json.toJson(x)),
         queryMetrics.timeZone.map("time_zone" -> JsString(_)),
         queryMetrics.cacheTime.map("cache_time" -> JsNumber(_))
-      ).flatten
+      ).flatten ++ plugins
 
       JsObject(fields)
     }
@@ -324,6 +330,20 @@ object Formats {
 
   implicit val queryTagFormat = Json.format[QueryTag]
 
+  implicit val queryPluginWrites: Writes[QueryPlugin] = (plugin: QueryPlugin) => {
+    JsObject(Seq("name" -> JsString(plugin.name)) ++ plugin.properties.map(
+      prop => {
+        val propValue: JsValue = prop._2 match {
+          case s: String => Json.toJson(s)
+          case l: Long => Json.toJson(l)
+          case i: Integer => Json.toJson(i.longValue())
+          case d: Double => Json.toJson(d)
+          case stringSeq: Seq[String] => Json.toJson(stringSeq)
+        }
+        prop._1 -> propValue
+      }))
+  }
+
   implicit val queryWrites: Writes[Query] = new Writes[Query] {
     override def writes(query: Query): JsValue = {
       val tags = if (query.tags.isEmpty) {
@@ -380,7 +400,13 @@ object Formats {
         "name" -> query.metricName.name
       )
 
-      name ++ limit ++ tags ++ aggregators ++ groupBys ++ excludeTags ++ order
+      val plugins = if (query.plugins.isEmpty) {
+        Json.obj()
+      } else {
+        Json.obj("plugins" -> query.plugins)
+      }
+
+      name ++ limit ++ tags ++ aggregators ++ groupBys ++ excludeTags ++ order ++ plugins
     }
   }
 
@@ -445,7 +471,6 @@ object Formats {
   implicit val responseTagsReads = Json.reads[TagsResponse]
   implicit val tagResponseReads = Json.reads[TagQueryResponse]
 
-
   private def instant2kairosLong(instant: Instant): Long = instant.toEpochMilli
 
   private def unitName(unit: TimeUnit): String = {

src/test/scala/unit/QueryWritesSpec.scala

@@ -341,5 +341,44 @@ class QueryWritesSpec extends Specification {
           |}
         """.stripMargin)
     }
+
+    "Correctly serialize a minimal QueryPlugin" in {
+      val queryPlugin = QueryPlugin("testPlugin")
+      Json.toJson(queryPlugin) must be equalTo Json.obj("name" -> "testPlugin")
+    }
+
+    "Correctly serialize a QueryPlugin with properties" in {
+      val queryPlugin = QueryPlugin("testPlugin",
+        Map(
+          "stringProp" -> "stringVal",
+          "intProp" -> 123,
+          "doubleProp" -> 1.23d,
+          "stringListProp" -> List("one", "two", "three")))
+      Json.toJson(queryPlugin) must be equalTo Json.obj(
+        "name" -> "testPlugin",
+        "stringProp" -> "stringVal",
+        "intProp" -> 123,
+        "doubleProp" -> 1.23,
+        "stringListProp" -> Json.arr("one", "two", "three"))
+    }
+
+    "Correctly serialize a query with plugins configured at the Query level" in {
+      val query = Query(MetricName("mymetric"), plugins = Seq(QueryPlugin("testPlugin", Map("propA" -> "valA"))))
+      Json.toJson(query) must be equalTo Json.obj("name" -> "mymetric", "plugins" -> Json.arr(Json.obj("name" -> "testPlugin", "propA" -> "valA")))
+    }
+
+    "Correctly serialize a query with plugins configured at the QueryMetric level" in {
+      val qm = QueryMetrics(Seq(Query(MetricName("mymetric"))),
+        TimeSpan(AbsoluteStartTime(Instant.ofEpochSecond(1470052425L))),
+        plugins = Seq(QueryPlugin("testPlugin", Map("propA" -> "valA"))))
+
+      Json.toJson(qm) should be equalTo Json.obj(
+        "start_absolute" -> 1470052425000L,
+        "metrics" -> Seq(Json.obj("name" -> "mymetric")),
+        "plugins" -> Json.arr(Json.obj("name" -> "testPlugin", "propA" -> "valA"))
+      )
+
+    }
+
   }
 }