feat: admin endpoint to fix metadata for ES

Author: maxceem

migrations/fixMetadataForES.js

@@ -61,17 +61,19 @@ function updateScope(scope) {
 /**
  * Fix all projectTemplates.
  *
- * @returns {undefined}
+ * @param {Object} logger logger
+ *
+ * @returns {Promise} resolved when dene
  */
-async function fixProjectTemplates() {
+async function fixProjectTemplates(logger) {
   const projectTemplates = await models.ProjectTemplate.findAll();
   for (const projectTemplate of projectTemplates) {
     if (projectTemplate.scope) {
       const updatedScope = updateScope(JSON.parse(JSON.stringify(projectTemplate.scope)));
       if (!_.isEqual(updatedScope, projectTemplate.scope)) {
         projectTemplate.scope = updatedScope;
         await projectTemplate.save();
-        console.log(`updated record of ProjectTemplate with id ${projectTemplate.id}`);
+        logger.info(`updated record of ProjectTemplate with id ${projectTemplate.id}`);
       }
     }
   }
@@ -81,6 +83,7 @@ async function fixProjectTemplates() {
  * Update the required property of an object.
  *
  * @param {Object} data any object
+ *
  * @returns {undefined}
  */
 function updateRequiredProperty(data) {
@@ -125,9 +128,11 @@ function updateTemplate(template) {
 /**
  * Fix all productTemplates.
  *
- * @returns {undefined}
+ * @param {Object} logger logger
+ *
+ * @returns {Promise} resolved when dene
  */
-async function fixProductTemplates() {
+async function fixProductTemplates(logger) {
   const productTemplates = await models.ProductTemplate.findAll();
 
   for (const productTemplate of productTemplates) {
@@ -136,7 +141,7 @@ async function fixProductTemplates() {
       if (!_.isEqual(updatedTemplate, productTemplate.template)) {
         productTemplate.template = updatedTemplate;
         await productTemplate.save();
-        console.log(`updated record of ProductTemplate with id ${productTemplate.id}`);
+        logger.info(`updated record of ProductTemplate with id ${productTemplate.id}`);
       }
     }
   }
@@ -145,18 +150,26 @@ async function fixProductTemplates() {
 /**
  * Fix all metadata models.
  *
+ * @param {Object} logger logger
+ *
  * @returns {undefined}
  */
-async function fixMetadataForES() {
-  await fixProjectTemplates();
-  await fixProductTemplates();
+async function fixMetadataForES(logger) {
+  await fixProjectTemplates(logger);
+  await fixProductTemplates(logger);
+}
+
+if (!module.parent) {
+  fixMetadataForES(console)
+    .then(() => {
+      console.log('done!');
+      process.exit();
+    }).catch((err) => {
+      console.error('Error syncing database', err);
+      process.exit(1);
+    });
 }
 
-fixMetadataForES()
-  .then(() => {
-    console.log('done!');
-    process.exit();
-  }).catch((err) => {
-    console.error('Error syncing database', err);
-    process.exit(1);
-  });
+module.exports = {
+  fixMetadataForES,
+};

src/routes/admin/es-fix-metadata-for-es.js

@@ -0,0 +1,54 @@
+/**
+ * Admin endpoint to fix metadata in DB to be indexed in ES.
+ *
+ * Waits until the operation is completed and returns result.
+ */
+import { middleware as tcMiddleware } from 'tc-core-library-js';
+import { fixMetadataForES } from '../../../migrations/fixMetadataForES';
+
+const permissions = tcMiddleware.permissions;
+
+/**
+ * Create a simple logger to log into an array.
+ *
+ * @returns {Object} logger
+ */
+const createArrayLogger = () => {
+  const loggerMethods = ['trace', 'debug', 'info', 'warn', 'error'];
+  const log = [];
+  const logger = {};
+
+  loggerMethods.forEach((method) => {
+    logger[method] = (message) => {
+      log.push({
+        level: method,
+        message,
+      });
+    };
+  });
+
+  logger.getLog = () => log;
+
+  return logger;
+};
+
+module.exports = [
+  permissions('project.admin'),
+  (req, res, next) => {
+    try {
+      const logger = req.log;
+      logger.debug('Entered Admin#fixMetadataForEs');
+
+      const arrayLogger = createArrayLogger();
+
+      fixMetadataForES(arrayLogger)
+        .then(() => {
+          arrayLogger.info('Data has been successfully fixed in DB.');
+          res.status(200).json(arrayLogger.getLog());
+        })
+        .catch(next);
+    } catch (err) {
+      next(err);
+    }
+  },
+];

src/routes/index.js

@@ -87,6 +87,8 @@ router.route('/v5/projects/admin/es/deleteIndex')
   .delete(require('./admin/es-delete-index'));
 router.route('/v5/projects/admin/es/migrateFromDb')
   .patch(require('./admin/es-migrate-from-db'));
+router.route('/v5/projects/admin/es/fixMetadataForEs')
+  .patch(require('./admin/es-fix-metadata-for-es'));
 router.route('/v5/projects/admin/es/project/index')
   .post(require('./admin/project-index-create'));
 router.route('/v5/projects/admin/es/project/remove')