ti2 1.0.47 → 1.0.48

package/controllers/user.js

@@ -23,7 +23,11 @@ const getAllFuncs = toCheck => {
   } while (obj = Object.getPrototypeOf(obj));
 
   return props.sort().filter((e, i, arr) => {
-    if (e !== arr[i + 1] && typeof toCheck[e] === 'function') return true;
+    try {
+      if (e !== arr[i + 1] && typeof toCheck[e] === 'function') return true;
+    } catch {
+      return undefined;
+    }
     return undefined;
   });
 };
@@ -42,6 +46,7 @@ const getAppMethods = plugins => async (req, res, next) => {
 };
 
 module.exports = plugins => ({
-  userAppList,
+  getAllFuncs,
   getAppMethods: getAppMethods(plugins),
+  userAppList,
 });

package/index.js

@@ -8,6 +8,7 @@ const { pickBy } = require('ramda');
 const bb = require('bluebird');
 const { Op } = require('sequelize');
 const R = require('ramda');
+const { v4: uuidv4 } = require('uuid');
 
 const schema = yaml.load(fs.readFileSync(`${__dirname}/api.yml`));
 
@@ -29,8 +30,6 @@ const isNumber = value => !Number.isNaN(Number(value));
 
 module.exports = async ({
   apiDocs = true,
-  elasticLogIndex = 'apilog_ti2',
-  elasticLogsClient,
   plugins: pluginsParam = {},
   port: portParam,
   startServer = true,
@@ -129,77 +128,15 @@ module.exports = async ({
       notFound: (req, res) => res.sendStatus(404),
       notImplemented: (req, res) => res.sendStatus(501),
     });
-    if (elasticLogsClient) { // API request logs are saved on elastic
-      const mappings = {
-        dynamic: true,
-        properties: {
-          body: { type: 'object' },
-          client: { type: 'keyword' },
-          date: { type: 'long' },
-          method: { type: 'keyword' },
-          operationId: { type: 'keyword' },
-          params: { type: 'object' },
-          query: { type: 'object' },
-          url: { type: 'text' },
-          responseStatusCode: { type: 'long' },
-          responseTimeInMs: { type: 'long' },
-        },
-      };
-      // setup the index
-      elasticLogsClient.indices.existsTemplate({
-        name: 'apilog',
-      }).then(async ({ body }) => {
-        if (!body) {
-          // the template has to be created
-          console.log('=- creating index template -=');
-          await elasticLogsClient.indices.putTemplate({
-            name: 'apilog',
-            body: {
-              index_patterns: [`${elasticLogIndex}*`],
-              settings: {
-                number_of_shards: 1,
-              },
-              mappings,
-            },
-          });
-          console.log('index template created');
-        } else {
-          // index exists, we might have to updated it
-          const current = R.path(
-            ['body', 'apilog', 'mappings'],
-            await elasticLogsClient.indices.getTemplate({
-              name: 'apilog',
-            }),
-          );
-          if (!R.equals(current, mappings)) {
-            console.log('=- updating index template -=');
-            await elasticLogsClient.indices.putTemplate({
-              name: 'apilog',
-              body: {
-                index_patterns: [`${elasticLogIndex}*`],
-                settings: {
-                  number_of_shards: 1,
-                },
-                mappings,
-              },
-            });
-            console.log('updated');
-          }
-        }
-        const exists = await elasticLogsClient.indices.exists({
-          index: elasticLogIndex,
-        });
-        if (!exists || !exists.body) {
-          console.log('=- creating index =-');
-          await elasticLogsClient.indices.create({
-            index: elasticLogIndex,
-          });
-          console.log('index created');
-        }
-      }).catch(console.log);
+    const onRequestStartPlugins = plugins.filter(currentPlugin => (api.getAllFuncs(currentPlugin).indexOf('onRequestStart') > -1));
+    const onRequestEndPlugins = plugins.filter(currentPlugin => (api.getAllFuncs(currentPlugin).indexOf('onRequestEnd') > -1));
+
+    if (onRequestStartPlugins.length > 0) {
       app.use((req, res, next) => {
         const startHrTime = process.hrtime();
+        const requestId = uuidv4();
         const body = {
+          requestId,
           date: Math.floor(Date.now() / 1e3),
           url: req.url,
           // body: req.body,
@@ -210,29 +147,37 @@ module.exports = async ({
           operationId: R.path(['openapi', 'operation', 'operationId'], req),
           client: req.headers['x-forwarded-for'] || req.connection.remoteAddress,
         };
-        elasticLogsClient.index({
-          index: elasticLogIndex,
-          body,
-        }).then(({ body: { _id } }) => {
+        bb.each(onRequestStartPlugins, async startPlugin => {
+          try {
+            await startPlugin.onRequestStart(body);
+          } catch (err) {
+            console.log(`unable to log to ${startPlugin.name}`, err);
+          }
+        }).then();
+        if (onRequestEndPlugins.length > 0) {
           res.on('finish', () => {
             const elapsedHrTime = process.hrtime(startHrTime);
-            const responseTimeInMs = parseInt(elapsedHrTime[0] * 1e3 + elapsedHrTime[1] / 1e6, 10);
-            elasticLogsClient.index({
-              index: elasticLogIndex,
-              id: _id,
-              body: {
-                ...body,
-                ...{
+            const responseTimeInMs = parseInt(
+              elapsedHrTime[0] * 1e3 + elapsedHrTime[1] / 1e6,
+              10,
+            );
+            bb.each(onRequestEndPlugins, async endPlugin => {
+              try {
+                await endPlugin.onRequestEnd({
+                  ...body,
                   responseTimeInMs,
                   responseStatusCode: res.statusCode,
-                },
-              },
-            }).catch((err, response) => console.log(err, response));
+                });
+              } catch (err) {
+                console.log(`unable to log to ${endPlugin.name}`, err);
+              }
+            }).then();
           });
-        }).catch((err, response) => console.log(err, response));
+        }
         next();
       });
     }
+
     connect(app);
     app.use(middleware.mock());
     // global error Handling

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ti2",
-  "version": "1.0.47",
+  "version": "1.0.48",
   "description": "Tourist Industry Exchange (TI2)",
   "main": "index.js",
   "scripts": {
@@ -44,7 +44,7 @@
     "swagger-ui-express": "4.3.0",
     "throng": "^5.0.0",
     "umzug": "^3.1.1",
-    "uninstall": "^0.0.0"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@salvador/minami": "^1.2.3",