feat: added GetDeployInformationUseCase

Author: mvegter

lib/application/usecases/server/GetDeployInformationUseCase.js

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+const { IUseCase } = require('../../interfaces');
+
+const START_TIME = new Date();
+
+/**
+ * GetDeployInformationUseCase
+ */
+class GetDeployInformationUseCase extends IUseCase {
+    /**
+     * Executes this use case.
+     *
+     * @returns {Promise} Promise object represents the result of this use case.
+     */
+    async execute() {
+        return Promise.resolve({
+            age: Math.round((new Date() - START_TIME) / 1000),
+            start: START_TIME.getTime(),
+        });
+    }
+}
+
+module.exports = GetDeployInformationUseCase;

lib/application/usecases/server/index.js

@@ -11,8 +11,10 @@
  * or submit itself to any jurisdiction.
  */
 
+const GetDeployInformationUseCase = require('./GetDeployInformationUseCase');
 const GetServerInformationUseCase = require('./GetServerInformationUseCase');
 
 module.exports = {
+    GetDeployInformationUseCase,
     GetServerInformationUseCase,
 };

lib/server/controllers/home.controller.js

@@ -11,7 +11,7 @@
  * or submit itself to any jurisdiction.
  */
 
-const { server: { GetServerInformationUseCase } } = require('../../application/usecases');
+const { server: { GetDeployInformationUseCase, GetServerInformationUseCase } } = require('../../application/usecases');
 
 /**
  * Basic api information controller.
@@ -36,6 +36,30 @@ const getServerInfo = async (request, response, next) => {
     response.status(200).json(serverInfo);
 };
 
+/**
+ * Basic deploy information controller.
+ *
+ * @param {Object} request The *request* object represents the HTTP request and has properties for the request query
+ *                         string, parameters, body, HTTP headers, and so on.
+ * @param {Object} response The *response* object represents the HTTP response that an Express app sends when it gets an
+ *                          HTTP request.
+ * @param {Function} next The *next* object represents the next middleware function which is used to pass control to the
+ *                        next middleware function.
+ * @returns {undefined}
+ */
+const getDeployInfo = async (request, response, next) => {
+    let deployInfo;
+    try {
+        deployInfo = await new GetDeployInformationUseCase().execute();
+    } catch (error) {
+        next(error);
+        return;
+    }
+
+    response.status(200).json(deployInfo);
+};
+
 module.exports = {
+    getDeployInfo,
     getServerInfo,
 };

lib/server/routers/home.router.js

@@ -18,4 +18,11 @@ module.exports = {
     path: '/',
     controller: HomeController.getServerInfo,
     args: { public: true },
+    children: [
+        {
+            method: 'get',
+            path: 'status',
+            controller: HomeController.getDeployInfo,
+        },
+    ],
 };