feat: versioned responses via transformer

Author: liuliquan

package.json

@@ -49,6 +49,7 @@
     "axios-retry": "^3.4.0",
     "bluebird": "^3.5.1",
     "body-parser": "^1.15.1",
+    "compare-versions": "^6.1.0",
     "config": "^3.0.1",
     "cors": "^2.8.5",
     "decimal.js": "^10.4.3",

src/common/transformer.js

@@ -0,0 +1,81 @@
+const _ = require("lodash");
+const { compareVersions } = require("compare-versions");
+const challengeService = require("../services/ChallengeService");
+
+function transformData(data, fieldsToDelete) {
+  if (!fieldsToDelete || !fieldsToDelete.length) {
+    return data;
+  }
+
+  if (_.isArray(data)) {
+    return data.map((item) => transformData(item, fieldsToDelete));
+  } else if (_.isObject(data)) {
+    const clonedData = { ...data };
+    for (const field of fieldsToDelete) {
+      delete clonedData[field];
+    }
+    if (clonedData.result) {
+      clonedData.result = transformData(clonedData.result, fieldsToDelete);
+    }
+    return clonedData;
+  }
+
+  return data;
+}
+
+function transformServices() {
+  _.each(services, (service, serviceName) => {
+    const serviceConfig = servicesConfig[serviceName];
+    if (!serviceConfig) {
+      return;
+    }
+
+    _.each(service, (method, methodName) => {
+      service[methodName] = async function () {
+        const args = Array.prototype.slice.call(arguments);
+        const data = await method.apply(this, args.slice(1));
+
+        // No transform need for this method
+        if (!serviceConfig.methods.includes(methodName)) {
+          return data;
+        }
+
+        // args[0] is request, get version header
+        const apiVersion = args[0].headers["challenge-api-version"] || "1.0.0";
+
+        const fieldsToDelete = [];
+        _.each(serviceConfig.fieldsVersion, (version, field) => {
+          // If input version less than required version, delete fields from response
+          if (compareVersions(apiVersion, version) < 0) {
+            fieldsToDelete.push(field);
+          }
+        });
+
+        // Transform response data by deleting fields
+        return transformData(data, fieldsToDelete);
+      };
+      service[methodName].params = ["req", ...method.params];
+    });
+  });
+}
+
+// Define the version config for services
+const servicesConfig = {
+  challengeService: {
+    methods: ["searchChallenges", "getChallenge", "createChallenge", "updateChallenge"],
+    fieldsVersion: {
+      skills: "1.1.0",
+      payments: "2.0.0",
+    },
+  },
+};
+
+// Define the services to export
+const services = {
+  challengeService,
+};
+
+// Transform services before export
+transformServices();
+
+module.exports = services;

src/controllers/ChallengeController.js

@@ -2,7 +2,7 @@
  * Controller for challenge endpoints
  */
 const HttpStatus = require("http-status-codes");
-const service = require("../services/ChallengeService");
+const { challengeService: service } = require("../common/transformer");
 const helper = require("../common/helper");
 const logger = require("../common/logger");
 
@@ -12,7 +12,7 @@ const logger = require("../common/logger");
  * @param {Object} res the response
  */
 async function searchChallenges(req, res) {
-  let result = await service.searchChallenges(req.authUser, {
+  let result = await service.searchChallenges(req, req.authUser, {
     ...req.query,
     ...req.body,
   });
@@ -23,7 +23,7 @@ async function searchChallenges(req, res) {
       logger.debug(`Staring to get mm challengeId`);
       const legacyId = await helper.getProjectIdByRoundId(req.query.legacyId);
       logger.debug(`Get mm challengeId successfully ${legacyId}`);
-      result = await service.searchChallenges(req.authUser, {
+      result = await service.searchChallenges(req, req.authUser, {
         ...req.query,
         ...req.body,
         legacyId,
@@ -50,7 +50,7 @@ async function createChallenge(req, res) {
   logger.debug(
     `createChallenge User: ${JSON.stringify(req.authUser)} - Body: ${JSON.stringify(req.body)}`
   );
-  const result = await service.createChallenge(req.authUser, req.body, req.userToken);
+  const result = await service.createChallenge(req, req.authUser, req.body, req.userToken);
   res.status(HttpStatus.CREATED).send(result);
 }
 
@@ -60,7 +60,7 @@ async function createChallenge(req, res) {
  * @param {Object} res the response
  */
 async function sendNotifications(req, res) {
-  const result = await service.sendNotifications(req.authUser, req.params.challengeId);
+  const result = await service.sendNotifications(req, req.authUser, req.params.challengeId);
   res.status(HttpStatus.CREATED).send(result);
 }
 
@@ -71,6 +71,7 @@ async function sendNotifications(req, res) {
  */
 async function getChallenge(req, res) {
   const result = await service.getChallenge(
+    req,
     req.authUser,
     req.params.challengeId,
     req.query.checkIfExists
@@ -84,7 +85,7 @@ async function getChallenge(req, res) {
  * @param {Object} res the response
  */
 async function getChallengeStatistics(req, res) {
-  const result = await service.getChallengeStatistics(req.authUser, req.params.challengeId);
+  const result = await service.getChallengeStatistics(req, req.authUser, req.params.challengeId);
   res.send(result);
 }
 
@@ -99,7 +100,7 @@ async function updateChallenge(req, res) {
       req.params.challengeId
     } - Body: ${JSON.stringify(req.body)}`
   );
-  const result = await service.updateChallenge(req.authUser, req.params.challengeId, req.body);
+  const result = await service.updateChallenge(req, req.authUser, req.params.challengeId, req.body);
   res.send(result);
 }
 
@@ -112,7 +113,7 @@ async function deleteChallenge(req, res) {
   logger.debug(
     `deleteChallenge User: ${JSON.stringify(req.authUser)} - ChallengeID: ${req.params.challengeId}`
   );
-  const result = await service.deleteChallenge(req.authUser, req.params.challengeId);
+  const result = await service.deleteChallenge(req, req.authUser, req.params.challengeId);
   res.send(result);
 }
 
@@ -122,7 +123,7 @@ async function deleteChallenge(req, res) {
  * @param {Object} res the response
  */
 async function advancePhase(req, res) {
-  res.send(await service.advancePhase(req.authUser, req.params.challengeId, req.body));
+  res.send(await service.advancePhase(req, req.authUser, req.params.challengeId, req.body));
 }
 
 module.exports = {

yarn.lock

@@ -978,6 +978,11 @@ commondir@^1.0.1:
   resolved "https://registry.yarnpkg.com/commondir/-/commondir-1.0.1.tgz#ddd800da0c66127393cca5950ea968a3aaf1253b"
   integrity sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg==
 
+compare-versions@^6.1.0:
+  version "6.1.0"
+  resolved "https://registry.yarnpkg.com/compare-versions/-/compare-versions-6.1.0.tgz#3f2131e3ae93577df111dba133e6db876ffe127a"
+  integrity sha512-LNZQXhqUvqUTotpZ00qLSaify3b4VFD588aRr8MKFw4CMUr98ytzCW5wDH5qx/DEY5kCDXcbcRuCqL0szEf2tg==
+
 component-emitter@^1.2.0, component-emitter@^1.3.0:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/component-emitter/-/component-emitter-1.3.0.tgz#16e4070fba8ae29b679f2215853ee181ab2eabc0"