implements hello API on root path as well

Author: rishabhpoddar

CHANGELOG.md

@@ -7,6 +7,10 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [unreleased]
 
+### Added
+
+- Hello API on `/` route.
+
 ## [3.16.2] - 2022-09-02
 
 ### Bug fixes

src/main/java/io/supertokens/webserver/Webserver.java

@@ -154,7 +154,7 @@ public void start() {
     }
 
     private void setupRoutes() throws Exception {
-        addAPI(new NotFoundAPI(main));
+        addAPI(new NotFoundOrHelloAPI(main));
         addAPI(new HelloAPI(main));
         addAPI(new SessionAPI(main));
         addAPI(new VerifySessionAPI(main));

…kens/webserver/api/core/NotFoundAPI.java …bserver/api/core/NotFoundOrHelloAPI.javasrc/main/java/io/supertokens/webserver/api/core/NotFoundAPI.java renamed to src/main/java/io/supertokens/webserver/api/core/NotFoundOrHelloAPI.java src/main/java/io/supertokens/webserver/api/core/NotFoundAPI.java renamed to src/main/java/io/supertokens/webserver/api/core/NotFoundOrHelloAPI.java

@@ -18,17 +18,20 @@
 
 import io.supertokens.Main;
 import io.supertokens.output.Logging;
+import io.supertokens.pluginInterface.Storage;
+import io.supertokens.pluginInterface.exceptions.StorageQueryException;
+import io.supertokens.storageLayer.StorageLayer;
 import io.supertokens.webserver.WebserverAPI;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
 
-public class NotFoundAPI extends WebserverAPI {
+public class NotFoundOrHelloAPI extends WebserverAPI {
 
     private static final long serialVersionUID = 1L;
 
-    public NotFoundAPI(Main main) {
+    public NotFoundOrHelloAPI(Main main) {
         super(main, "");
     }
 
@@ -39,9 +42,20 @@ public String getPath() {
 
     @Override
     protected void service(HttpServletRequest req, HttpServletResponse resp) throws IOException {
-        super.sendTextResponse(404, "Not found", resp);
-
-        Logging.error(main, "Unknown API called: " + req.getRequestURL(), false);
+        if (req.getRequestURI().equals("/")) {
+            Storage storage = StorageLayer.getStorage(main);
+            try {
+                storage.getKeyValue("Test");
+                super.sendTextResponse(200, "Hello", resp);
+            } catch (StorageQueryException e) {
+                // we send 500 status code
+                throw new IOException(e);
+            }
+        } else {
+            super.sendTextResponse(404, "Not found", resp);
+
+            Logging.error(main, "Unknown API called: " + req.getRequestURL(), false);
+        }
     }
 
 }

src/test/java/io/supertokens/test/WebserverTest.java

@@ -17,10 +17,10 @@
 package io.supertokens.test;
 
 import com.google.gson.JsonObject;
-import io.supertokens.config.Config;
 import io.supertokens.ProcessState;
 import io.supertokens.ProcessState.EventAndException;
 import io.supertokens.ProcessState.PROCESS_STATE;
+import io.supertokens.config.Config;
 import io.supertokens.exceptions.QuitProgramException;
 import io.supertokens.httpRequest.HttpRequest;
 import io.supertokens.httpRequest.HttpResponseException;
@@ -490,31 +490,62 @@ public void serverHelloWithoutDB() throws Exception {
     }
 
     private void hello(String hostName, String port) throws InterruptedException, IOException, HttpResponseException {
-        String[] args = { "../" };
-        TestingProcess process = TestingProcessManager.start(args);
-        assertNotNull(process.checkOrWaitForEvent(PROCESS_STATE.STARTED));
-        try {
+        {
+            String[] args = { "../" };
+            TestingProcess process = TestingProcessManager.start(args);
+            assertNotNull(process.checkOrWaitForEvent(PROCESS_STATE.STARTED));
+            try {
 
-            String response = HttpRequest.sendGETRequest(process.getProcess(), "",
-                    "http://" + hostName + ":" + port + "/hello", null, 1000, 1000, null);
-            assertEquals("Hello", response);
+                String response = HttpRequest.sendGETRequest(process.getProcess(), "",
+                        "http://" + hostName + ":" + port + "/hello", null, 1000, 1000, null);
+                assertEquals("Hello", response);
 
-            response = HttpRequest.sendJsonPOSTRequest(process.getProcess(), "",
-                    "http://" + hostName + ":" + port + "/hello", null, 1000, 1000, null);
-            assertEquals("Hello", response);
+                response = HttpRequest.sendJsonPOSTRequest(process.getProcess(), "",
+                        "http://" + hostName + ":" + port + "/hello", null, 1000, 1000, null);
+                assertEquals("Hello", response);
 
-            response = HttpRequest.sendJsonPUTRequest(process.getProcess(), "",
-                    "http://" + hostName + ":" + port + "/hello", null, 1000, 1000, null);
-            assertEquals("Hello", response);
+                response = HttpRequest.sendJsonPUTRequest(process.getProcess(), "",
+                        "http://" + hostName + ":" + port + "/hello", null, 1000, 1000, null);
+                assertEquals("Hello", response);
 
-            response = HttpRequest.sendJsonDELETERequest(process.getProcess(), "",
-                    "http://" + hostName + ":" + port + "/hello", null, 1000, 1000, null);
-            assertEquals("Hello", response);
+                response = HttpRequest.sendJsonDELETERequest(process.getProcess(), "",
+                        "http://" + hostName + ":" + port + "/hello", null, 1000, 1000, null);
+                assertEquals("Hello", response);
 
-        } finally {
-            process.kill();
-            assertNotNull(process.checkOrWaitForEvent(PROCESS_STATE.STOPPED));
+            } finally {
+                process.kill();
+                assertNotNull(process.checkOrWaitForEvent(PROCESS_STATE.STOPPED));
+            }
+        }
+
+        {
+            String[] args = { "../" };
+            TestingProcess process = TestingProcessManager.start(args);
+            assertNotNull(process.checkOrWaitForEvent(PROCESS_STATE.STARTED));
+            try {
+
+                String response = HttpRequest.sendGETRequest(process.getProcess(), "",
+                        "http://" + hostName + ":" + port + "/", null, 1000, 1000, null);
+                assertEquals("Hello", response);
+
+                response = HttpRequest.sendJsonPOSTRequest(process.getProcess(), "", "http://" + hostName + ":" + port,
+                        null, 1000, 1000, null);
+                assertEquals("Hello", response);
+
+                response = HttpRequest.sendJsonPUTRequest(process.getProcess(), "",
+                        "http://" + hostName + ":" + port + "/", null, 1000, 1000, null);
+                assertEquals("Hello", response);
+
+                response = HttpRequest.sendJsonDELETERequest(process.getProcess(), "",
+                        "http://" + hostName + ":" + port, null, 1000, 1000, null);
+                assertEquals("Hello", response);
+
+            } finally {
+                process.kill();
+                assertNotNull(process.checkOrWaitForEvent(PROCESS_STATE.STOPPED));
+            }
         }
+
     }
 
     @Test