Add support to use /status endoint (#259)

- Back-end status check will now be performed on the /status endpoint
  instead of /auth/checkStatus.
- Updated documentation.

Author: Anders Breid

src/main/java/com/ericsson/ei/frontend/EIRequestsController.java

@@ -71,7 +71,7 @@ public class EIRequestsController {
      */
     @CrossOrigin
     @RequestMapping(value = { "/subscriptions", "/subscriptions/*", "/information", "/download/*", "/auth", "/auth/*",
-            "/queryAggregatedObject", "/queryMissedNotifications", "/query", "/rules",
+            "/queryAggregatedObject", "/queryMissedNotifications", "/query", "/rules", "/status",
             "/rules/rule-check/testRulePageEnabled" }, method = RequestMethod.GET)
     public ResponseEntity<String> getRequests(Model model, HttpServletRequest incomingRequest) {
         String eiRequestUrl;

src/main/resources/static/js/common.js

@@ -355,7 +355,8 @@ function checkBackendSecured() {
         }
     };
     var ajaxHttpSender = new AjaxHttpSender();
-    ajaxHttpSender.sendAjax(backendEndpoints.AUTH, "GET", null, callback);
+    var data = null;
+    ajaxHttpSender.sendAjax(backendEndpoints.AUTH, "GET", data, callback);
 }
 
 function checkLoggedInUser() {

src/main/resources/static/js/global-variables.js

@@ -12,7 +12,7 @@ var usernameMaxDisplayLength = 15;
 var backendEndpoints = {
     AUTH: "/auth",
     LOGIN: "/auth/login",
-    CHECK_STATUS: "/auth/checkStatus",
+    CHECK_STATUS: "/status",
     SUBSCRIPTIONS: "/subscriptions",
     DOWNLOAD: "/download/",
     DOWNLOAD_SUBSCRIPTIONS_TEMPLATE: "/download/subscriptionsTemplate",
@@ -22,7 +22,6 @@ var backendEndpoints = {
     CHECK_AGGREGATION: "/rules/rule-check/aggregation"
 };
 
-// Status handling variables
 var PAGES_FOR_STATUS_INDICATION = "subscriptions test-rules ei-info login";
 var statusType = {
     SUCCESS: "alert-success",
@@ -31,7 +30,7 @@ var statusType = {
     DANGER: "alert-danger"
 };
 var statusText = {
-    BACKEND_DOWN: "<strong>Back-end is down!</strong> Wait for it go up or switch to another back-end before continuing!",
+    BACKEND_DOWN: "<strong>Back-end, MongoDB and/or RabbitMQ is down!</strong> Wait for them go up or switch to another back-end before continuing!",
     UNKNOWN_BACK_END_STATUS: "<strong>Back-end status is unknown!</strong> Wait for it to update or switch to another back-end before continuing!",
     TEST_RULES_DISABLED: "<strong>Test Rule service is disabled!</strong> To enable it set the backend property [testaggregated.enabled] as [true]"
 };
@@ -40,9 +39,6 @@ var backEndStatus = true;
 var backEndStatusUpdated = false;
 var previousBackEndStatus;
 var backEndStatusTimerInterval;
-// End Status variables
-
-// Start ## getters and setters
 
 function isLdapEnabled(){
     return Boolean(ldapEnabled);
@@ -69,9 +65,21 @@ function getFrontendServiceBackEndPath() {
     return frontendServiceBackEndPath;
 }
 
-// End   ## getters and setters
+function getSubscriptionNameRegex() {
+    return subscriptionNameRegex;
+}
+
+function getNotificationMetaRegex() {
+    return notificationMetaRegex;
+}
 
-// Start ## getters and setters status handling
+function getUsernameMaxDisplayLength() {
+    if (usernameMaxDisplayLength < 4) {
+        // Minimum leangth is 4 due to ellipsis being 3 long
+        return 4;
+    }
+    return usernameMaxDisplayLength;
+}
 
 function isBackEndStatusOk() {
     return Boolean(backEndStatus);
@@ -105,21 +113,3 @@ function setBackEndStatusTimerInterval() {
 function getWhiteListedPages() {
     return String(PAGES_FOR_STATUS_INDICATION);
 }
-
-function getSubscriptionNameRegex() {
-    return subscriptionNameRegex;
-}
-
-function getNotificationMetaRegex() {
-    return notificationMetaRegex;
-}
-
-function getUsernameMaxDisplayLength() {
-    if (usernameMaxDisplayLength < 4) {
-        // Minimum leangth is 4 due to ellipsis being 3 long
-        return 4;
-    }
-    return usernameMaxDisplayLength;
-}
-
-// End   ## getters and setters status handling

src/main/resources/static/js/status-handler.js

@@ -21,10 +21,10 @@ function checkBackendStatus() {
         return;
     }
 
-    if (isBackEndStatusOk()) {
-        removeStatusIndicator();
-    } else {
+    if (!isBackEndStatusOk()) {
         addStatusIndicator(statusType.DANGER, statusText.BACKEND_DOWN);
+    } else {
+        removeStatusIndicator();
     }
 
     routeSpecificFunctions(currentUrl);
@@ -79,26 +79,24 @@ function reloadIfStatusChanged(isStatusChanged) {
 function updateBackendStatus() {
     var callback = {
         error: function (XMLHttpRequest, textStatus, errorThrown) {
-            if (XMLHttpRequest.status == 401) {
-                functionsToExecuteIfUserIsLoggedOut();
+            executeIfLdapIsDeactivated();
+            setBackEndStatusOk(false);
+        },
+        success: function (data, textStatus) {
+            checkBackendSecured();
+            if (data.eiffelIntelligenceStatus == "AVAILABLE") {
                 setBackEndStatusOk(true);
             } else {
-                executeIfLdapIsDeactivated();
                 setBackEndStatusOk(false);
             }
         },
-        success: function (data, textStatus) {
-            checkBackendSecured();
-            setBackEndStatusOk(true);
-        },
         complete: function () {
             checkBackendStatus();
          }
     };
     var ajaxHttpSender = new AjaxHttpSender();
-    var contentType = "application/string; charset=utf-8";
-    var datatype = "text";
-    ajaxHttpSender.sendAjax(backendEndpoints.CHECK_STATUS, "GET", null, callback, contentType, datatype);
+    var data = null;
+    ajaxHttpSender.sendAjax(backendEndpoints.CHECK_STATUS, "GET", data, callback);
 }
 
 function addStatusIndicator(statusType, statusText) {

wiki/markdown/curl-examples.md

@@ -14,6 +14,7 @@ Most endpoints are also documented in the [Eiffel Intelligence backend repositor
 
 #### Quick access to endpoints:
 * [/auth](#auth)
+* [/status](#status)
 * [/backend](#backend)
 * [/download](#download)
 * [/information](#information)
@@ -44,7 +45,7 @@ This way of entering the `backendurl` may be the easiest way. It works with GET,
 
 <table>
     <tr>
-        <th>Context Path</th>
+        <th>Endpoint</th>
         <th>Type</th>
         <th>Explanation</th>
     </tr>
@@ -53,11 +54,6 @@ This way of entering the `backendurl` may be the easiest way. It works with GET,
         <td>GET</td>
         <td>Check if LDAP security is enabled</td>
     </tr>
-    <tr>
-        <td>/auth/checkStatus</td>
-        <td>GET</td>
-        <td>Used to check the back-end status</td>
-    </tr>
     <tr>
         <td>/auth/login</td>
         <td>GET</td>
@@ -86,12 +82,32 @@ It is possible to provide both username and password directly in the request, as
 
 More information and examples can be found in the [EI back-end documentation](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/authentication.md)
 
+## <a id="status" /> /status
+
+<table>
+    <tr>
+        <th>Endpoint</th>
+        <th>Type</th>
+        <th>Explanation</th>
+    </tr>
+    <tr>
+        <td>/status</td>
+        <td>GET</td>
+        <td>Get back-end status including status of services back-end is dependent on.</td>
+    </tr>
+</table>
+
+#### Some curl examples
+
+This command would return a JSON object containing the status of the back-end and servers back-end is dependent on..
+
+    curl -X GET -H "Content-type: application/json" http://localhost:8080/status
 
 ## <a id="backend" /> /backend
 
 <table>
     <tr>
-        <th>Context Path</th>
+        <th>Endpoint</th>
         <th>Type</th>
         <th>Explanation</th>
     </tr>
@@ -191,7 +207,7 @@ In the below command the JSON object is put in a file and sent along with the re
 
 <table>
     <tr>
-        <th>Context Path</th>
+        <th>Endpoint</th>
         <th>Type</th>
         <th>Explanation</th>
     </tr>
@@ -233,7 +249,7 @@ This command returns a list of several subscriptions. It is also possible to spe
 
 <table>
     <tr>
-        <th>Context Path</th>
+        <th>Endpoint</th>
         <th>Type</th>
         <th>Explanation</th>
     </tr>
@@ -253,7 +269,7 @@ The response is a json object containing all the connected components and data a
 
 <table>
     <tr>
-        <th>Context Path</th>
+        <th>Endpoint</th>
         <th>Type</th>
         <th>Explanation</th>
     </tr>
@@ -281,7 +297,7 @@ Example curl commands to these endpoints [can be found here](https://github.com/
 
 <table>
     <tr>
-        <th>Context Path</th>
+        <th>Endpoint</th>
         <th>Type</th>
         <th>Explanation</th>
     </tr>
@@ -314,7 +330,7 @@ Example curl commands to these endpoints [can be found here](https://github.com/
 
 <table>
     <tr>
-        <th>Context Path</th>
+        <th>Endpoint</th>
         <th>Type</th>
         <th>Explanation</th>
     </tr>