From 781a2c65c33a182cc1a47b66fdd7b34b3c301ac8 Mon Sep 17 00:00:00 2001
From: Cedric Beust <cedric@beust.com>
Date: Sun, 3 Jul 2016 09:24:49 -0700
Subject: [PATCH] Deprecation comments.

---
 .../com/beust/kobalt/app/remote/KobaltClient.kt       |  1 +
 .../kotlin/com/beust/kobalt/app/remote/SparkServer.kt | 11 +++++++++--
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/src/main/kotlin/com/beust/kobalt/app/remote/KobaltClient.kt b/src/main/kotlin/com/beust/kobalt/app/remote/KobaltClient.kt
index 0b4aedb5..35d9f24e 100644
--- a/src/main/kotlin/com/beust/kobalt/app/remote/KobaltClient.kt
+++ b/src/main/kotlin/com/beust/kobalt/app/remote/KobaltClient.kt
@@ -44,6 +44,7 @@ interface Api {
     @GET("/ping")
     fun ping() : Call<String>
 
+    @Deprecated(message = "Replaced with /v1/getDependencies")
     @POST("/v0/getDependencies")
     fun getDependencies(@Query("buildFile") buildFile: String) : Call<List<DependencyData.GetDependenciesData>>
 }
diff --git a/src/main/kotlin/com/beust/kobalt/app/remote/SparkServer.kt b/src/main/kotlin/com/beust/kobalt/app/remote/SparkServer.kt
index 0f3af68c..b6e9edd0 100644
--- a/src/main/kotlin/com/beust/kobalt/app/remote/SparkServer.kt
+++ b/src/main/kotlin/com/beust/kobalt/app/remote/SparkServer.kt
@@ -48,7 +48,7 @@ class SparkServer(val initCallback: (String) -> List<Project>, val cleanUpCallba
     override fun run(port: Int) {
         log.debug("RUNNING")
         Spark.port(port)
-        Spark.webSocket("/v1/getDependencies", GetDependenciesChatHandler::class.java)
+        Spark.webSocket("/v1/getDependencies", GetDependenciesHandler::class.java)
         Spark.get("/ping", { req, res -> """ { "result" : "ok" } """ })
         Spark.get("/quit", { req, res ->
             Executors.newFixedThreadPool(1).let { executor ->
@@ -60,6 +60,10 @@ class SparkServer(val initCallback: (String) -> List<Project>, val cleanUpCallba
                 KobaltServer.OK
             }
         })
+
+        //
+        // The /v0 endpoints are deprecated and will eventually be removed
+        // (replaced by /v1 which uses WebSockets
         jsonRoute("/v0/getDependencies", Route { request, response ->
             val buildFile = request.queryParams("buildFile")
             initCallback(buildFile)
@@ -89,7 +93,10 @@ class SparkServer(val initCallback: (String) -> List<Project>, val cleanUpCallba
     }
 }
 
-class GetDependenciesChatHandler : WebSocketListener {
+/**
+ * Manage the websocket endpoint "/v1/getDependencies".
+ */
+class GetDependenciesHandler : WebSocketListener {
     // The SparkJava project refused to merge https://github.com/perwendel/spark/pull/383
     // so I have to do dependency injections manually :-(
     val projectFinder = Kobalt.INJECTOR.getInstance(ProjectFinder::class.java)