Merge branch 'dev' of github.com:topcoder-platform/challenge-api into dev

Author: jmgasper

.circleci/config.yml

@@ -86,6 +86,7 @@ workflows:
           branches:
             only:
             - dev
+            - feature/top-262-projectid-non-mandatory
 
     - "build-qa":
         context: org-global

config/default.js

@@ -92,6 +92,7 @@ module.exports = {
     UPDATE: process.env.SCOPE_CHALLENGES_UPDATE || "update:challenges",
     DELETE: process.env.SCOPE_CHALLENGES_DELETE || "delete:challenges",
     ALL: process.env.SCOPE_CHALLENGES_ALL || "all:challenges",
+    PAYMENT: process.env.SCOPE_PAYMENT || "create:payments",
   },
 
   DEFAULT_CONFIDENTIALITY_TYPE: process.env.DEFAULT_CONFIDENTIALITY_TYPE || "public",
@@ -129,5 +130,8 @@ module.exports = {
   GRPC_CHALLENGE_SERVER_HOST: process.env.GRPC_DOMAIN_CHALLENGE_SERVER_HOST || "localhost",
   GRPC_CHALLENGE_SERVER_PORT: process.env.GRPC_DOMAIN_CHALLENGE_SERVER_PORT || 8888,
   GRPC_ACL_SERVER_HOST: process.env.GRPC_ACL_SERVER_HOST || "localhost",
-  GRPC_ACL_SERVER_PORT: process.env.GRPC_ACL_SERVER_PORT || 8889,
+  GRPC_ACL_SERVER_PORT: process.env.GRPC_ACL_SERVER_PORT || 40020,
+
+  SKIP_PROJECT_ID_BY_TIMLINE_TEMPLATE_ID:
+    process.env.SKIP_PROJECT_ID_BY_TIMLINE_TEMPLATE_ID || "517e76b0-8824-4e72-9b48-a1ebde1793a8",
 };

package.json

@@ -8,6 +8,8 @@
     "dev": "nodemon app.js",
     "lint": "prettier src/**/*.js",
     "lint:fix": "prettier --write src/**/*.js",
+    "standard-lint": "standard",
+    "standard-lint:fix": "standard --fix",
     "init-es": "node src/init-es.js",
     "init-db": "node src/init-db.js",
     "sync-es": "node src/scripts/sync-es.js",
@@ -37,13 +39,14 @@
     "mocha-prepare": "^0.1.0",
     "nodemon": "^2.0.20",
     "nyc": "^14.0.0",
-    "prettier": "^2.8.1"
+    "prettier": "^2.8.1",
+    "standard": "^17.1.0"
   },
   "dependencies": {
     "@grpc/grpc-js": "^1.8.12",
     "@opensearch-project/opensearch": "^2.2.0",
-    "@topcoder-framework/domain-challenge": "^0.24.1",
     "@topcoder-framework/domain-acl": "^0.24.0",
+    "@topcoder-framework/domain-challenge": "^0.24.1",
     "@topcoder-framework/lib-common": "^0.24.1",
     "aws-sdk": "^2.1145.0",
     "axios": "^0.19.0",

src/common/challenge-helper.js

@@ -169,7 +169,11 @@ class ChallengeHelper {
 
   async validateCreateChallengeRequest(currentUser, challenge) {
     // projectId is required for non self-service challenges
-    if (challenge.legacy.selfService == null && challenge.projectId == null) {
+    if (
+      challenge.legacy.selfService == null &&
+      challenge.projectId == null &&
+      this.isProjectIdRequired(challenge.timelineTemplateId)
+    ) {
       throw new errors.BadRequestError("projectId is required for non self-service challenges.");
     }
 
@@ -524,6 +528,12 @@ class ChallengeHelper {
       delete overview.totalPrizesInCents;
     }
   }
+
+  isProjectIdRequired(timelineTemplateId) {
+    const template = _.get(config, "SKIP_PROJECT_ID_BY_TIMLINE_TEMPLATE_ID", '517e76b0-8824-4e72-9b48-a1ebde1793a8');
+
+    return template !== timelineTemplateId;
+  }
 }
 
 module.exports = new ChallengeHelper();

src/controllers/ChallengeController.js

@@ -104,6 +104,26 @@ async function updateChallenge(req, res) {
   res.send(result);
 }
 
+/**
+ * Update Legacy Payout (Updates informixoltp:payment_detail)
+ * This has no effect other than to keep DW in sync for looker with
+ * Updates that happen in Wallet
+ */
+async function updateLegacyPayout(req, res) {
+  logger.debug(
+    `updateLegacyPayout User: ${JSON.stringify(req.authUser)} - ChallengeID: ${
+      req.params.challengeId
+    } - Body: ${JSON.stringify(req.body)}`
+  );
+  const result = await service.updateLegacyPayout(
+    req,
+    req.authUser,
+    req.params.challengeId,
+    req.body
+  );
+  res.send(result);
+}
+
 /**
  * Delete challenge
  * @param {Object} req the request
@@ -152,6 +172,7 @@ module.exports = {
   createChallenge,
   getChallenge,
   updateChallenge,
+  updateLegacyPayout,
   deleteChallenge,
   getChallengeStatistics,
   sendNotifications,

src/routes.js

@@ -4,7 +4,7 @@
 
 const constants = require("../app-constants");
 const {
-  SCOPES: { READ, CREATE, UPDATE, DELETE, ALL },
+  SCOPES: { PAYMENT, READ, CREATE, UPDATE, DELETE, ALL },
 } = require("config");
 
 module.exports = {
@@ -112,6 +112,14 @@ module.exports = {
       scopes: [UPDATE, ALL],
     },
   },
+  "/challenges/:challengeId/legacy-payment": {
+    patch: {
+      controller: "ChallengeController",
+      method: "updateLegacyPayout",
+      auth: "jwt",
+      scopes: [PAYMENT],
+    },
+  },
   "/challenges/:challengeId/statistics": {
     get: {
       controller: "ChallengeController",

src/services/ChallengeService.js

@@ -941,7 +941,7 @@ async function createChallenge(currentUser, challenge, userToken) {
   console.log("TYPE", prizeTypeTmp);
   if (challenge.legacy.selfService) {
     // if self-service, create a new project (what about if projectId is provided in the payload? confirm with business!)
-    if (!challenge.projectId) {
+    if (!challenge.projectId && challengeHelper.isProjectIdRequired(challenge.timelineTemplateId)) {
       const selfServiceProjectName = `Self service - ${currentUser.handle} - ${challenge.name}`;
       challenge.projectId = await helper.createSelfServiceProject(
         selfServiceProjectName,
@@ -963,14 +963,18 @@ async function createChallenge(currentUser, challenge, userToken) {
   }
 
   /** Ensure project exists, and set direct project id, billing account id & markup */
-  const { projectId } = challenge;
+  if (challengeHelper.isProjectIdRequired(challenge.timelineTemplateId)) {
+    const { projectId } = challenge;
 
-  const { directProjectId } = await projectHelper.getProject(projectId, currentUser);
-  const { billingAccountId, markup } = await projectHelper.getProjectBillingInformation(projectId);
+    const { directProjectId } = await projectHelper.getProject(projectId, currentUser);
+    const { billingAccountId, markup } = await projectHelper.getProjectBillingInformation(
+      projectId
+    );
 
-  _.set(challenge, "legacy.directProjectId", directProjectId);
-  _.set(challenge, "billing.billingAccountId", billingAccountId);
-  _.set(challenge, "billing.markup", markup || 0);
+    _.set(challenge, "legacy.directProjectId", directProjectId);
+    _.set(challenge, "billing.billingAccountId", billingAccountId);
+    _.set(challenge, "billing.markup", markup || 0);
+  }
 
   if (!_.isUndefined(_.get(challenge, "legacy.reviewType"))) {
     _.set(challenge, "legacy.reviewType", _.toUpper(_.get(challenge, "legacy.reviewType")));
@@ -1510,19 +1514,22 @@ async function updateChallenge(currentUser, challengeId, data) {
     convertPrizeSetValuesToDollars(challenge.prizeSets, challenge.overview);
   }
 
-  const projectId = _.get(challenge, "projectId");
+  let projectId, billingAccountId, markup;
+  if (challengeHelper.isProjectIdRequired(challenge.timelineTemplateId)) {
+    projectId = _.get(challenge, "projectId");
 
-  const { billingAccountId, markup } = await projectHelper.getProjectBillingInformation(projectId);
+    ({ billingAccountId, markup } = await projectHelper.getProjectBillingInformation(projectId));
 
-  if (billingAccountId && _.isUndefined(_.get(challenge, "billing.billingAccountId"))) {
-    _.set(data, "billing.billingAccountId", billingAccountId);
-    _.set(data, "billing.markup", markup || 0);
-  }
+    if (billingAccountId && _.isUndefined(_.get(challenge, "billing.billingAccountId"))) {
+      _.set(data, "billing.billingAccountId", billingAccountId);
+      _.set(data, "billing.markup", markup || 0);
+    }
 
-  // Make sure the user cannot change the direct project ID
-  if (data.legacy) {
-    data.legacy = _.assign({}, challenge.legacy, data.legacy);
-    _.set(data, "legacy.directProjectId", challenge.legacy.directProjectId);
+    // Make sure the user cannot change the direct project ID
+    if (data.legacy) {
+      data.legacy = _.assign({}, challenge.legacy, data.legacy);
+      _.set(data, "legacy.directProjectId", challenge.legacy.directProjectId);
+    }
   }
 
   // Remove fields from data that are not allowed to be updated and that match the existing challenge
@@ -1565,7 +1572,8 @@ async function updateChallenge(currentUser, challengeId, data) {
     if (
       (data.status === constants.challengeStatuses.Approved ||
         data.status === constants.challengeStatuses.Active) &&
-      challenge.status !== constants.challengeStatuses.Active
+      challenge.status !== constants.challengeStatuses.Active &&
+      challengeHelper.isProjectIdRequired(challenge.timelineTemplateId)
     ) {
       try {
         const selfServiceProjectName = `Self service - ${challenge.createdBy} - ${challenge.name}`;
@@ -1601,7 +1609,10 @@ async function updateChallenge(currentUser, challengeId, data) {
       }
     }
 
-    if (data.status === constants.challengeStatuses.Draft) {
+    if (
+      data.status === constants.challengeStatuses.Draft &&
+      challengeHelper.isProjectIdRequired(challenge.timelineTemplateId)
+    ) {
       try {
         await helper.updateSelfServiceProjectInfo(
           projectId,
@@ -1614,8 +1625,9 @@ async function updateChallenge(currentUser, challengeId, data) {
     }
 
     if (
-      data.status === constants.challengeStatuses.CancelledRequirementsInfeasible ||
-      data.status === constants.challengeStatuses.CancelledPaymentFailed
+      (data.status === constants.challengeStatuses.CancelledRequirementsInfeasible ||
+        data.status === constants.challengeStatuses.CancelledPaymentFailed) &&
+      challengeHelper.isProjectIdRequired(challenge.timelineTemplateId)
     ) {
       try {
         await helper.cancelProject(challenge.projectId, data.cancelReason, currentUser);
@@ -1635,7 +1647,8 @@ async function updateChallenge(currentUser, challengeId, data) {
       // if activating a challenge, the challenge must have a billing account id
       if (
         (!billingAccountId || billingAccountId === null) &&
-        challenge.status === constants.challengeStatuses.Draft
+        challenge.status === constants.challengeStatuses.Draft &&
+        challengeHelper.isProjectIdRequired(challenge.timelineTemplateId)
       ) {
         throw new errors.BadRequestError(
           "Cannot Activate this project, it has no active billing account."
@@ -2152,7 +2165,7 @@ updateChallenge.schema = {
             .unknown(true)
         )
         .optional(),
-      overview: Joi.any().forbidden(),
+      overview: Joi.any().forbidden()      
     })
     .unknown(true)
     .required(),
@@ -2479,6 +2492,128 @@ async function indexChallengeAndPostToKafka(updatedChallenge, track, type) {
   });
 }
 
+async function updateLegacyPayout(currentUser, challengeId, data) {
+  console.log(`Update legacy payment data for challenge: ${challengeId} with data: `, data);
+  const challenge = await challengeDomain.lookup(getLookupCriteria("id", challengeId));
+
+  // SQL qurey to fetch the payment and payment_detail record
+  let sql = `SELECT * FROM informixoltp:payment p
+    INNER JOIN informixoltp:payment_detail pd ON p.most_recent_detail_id = pd.payment_detail_id
+    WHERE p.user_id = ${data.userId} AND`;
+
+  if (challenge.legacyId != null) {
+    sql += ` pd.component_project_id = ${challenge.legacyId}`;
+  } else {
+    sql += ` pd.jira_issue_id = \'${challengeId}\'`;
+  }
+
+  sql += " ORDER BY pd.payment_detail_id ASC";
+
+  console.log("Fetch legacy payment detail: ", sql);
+
+  const result = await aclQueryDomain.rawQuery({ sql });
+  let updateClauses = [`date_modified = current`];
+
+  const statusMap = {
+    Paid: 53,
+    OnHold: 55,
+    OnHoldAdmin: 55,
+    Owed: 56,
+    Cancelled: 65,
+    EnteredIntoPaymentSystem: 70,
+  };
+
+  if (data.status != null) {
+    updateClauses.push(`payment_status_id = ${statusMap[data.status]}`);
+    if (data.status === "Paid") {
+      updateClauses.push(`date_paid = '${data.datePaid}'`);
+    } else {
+      updateClauses.push("date_paid = null");
+    }
+  }
+
+  if (data.releaseDate != null) {
+    updateClauses.push(`date_due = '${data.releaseDate}'`);
+  }
+
+  const paymentDetailIds = result.rows.map(
+    (row) => row.fields.find((field) => field.key === "payment_detail_id").value
+  );
+
+  if (data.amount != null) {
+    updateClauses.push(`total_amount = ${data.amount}`);
+    if (paymentDetailIds.length === 1) {
+      updateClauses.push(`net_amount = ${data.amount}`);
+      updateClauses.push(`gross_amount = ${data.amount}`);
+    }
+  }
+
+  if (paymentDetailIds.length === 0) {
+    return {
+      success: false,
+      message: "No payment detail record found",
+    };
+  }
+
+  const whereClause = [`payment_detail_id IN (${paymentDetailIds.join(",")})`];
+
+  const updateQuery = `UPDATE informixoltp:payment_detail SET ${updateClauses.join(
+    ", "
+  )} WHERE ${whereClause.join(" AND ")}`;
+
+  console.log("Update Clauses", updateClauses);
+  console.log("Update Query", updateQuery);
+
+  await aclQueryDomain.rawQuery({ sql: updateQuery });
+
+  if (data.amount != null) {
+    if (paymentDetailIds.length > 1) {
+      const amountInCents = data.amount * 100;
+
+      const split1Cents = Math.round(amountInCents * 0.75);
+      const split2Cents = amountInCents - split1Cents;
+
+      const split1Dollars = Number((split1Cents / 100).toFixed(2));
+      const split2Dollars = Number((split2Cents / 100).toFixed(2));
+
+      const paymentUpdateQueries = paymentDetailIds.map((paymentDetailId, index) => {
+        let amt = 0;
+        if (index === 0) {
+          amt = split1Dollars;
+        }
+        if (index === 1) {
+          amt = split2Dollars;
+        }
+
+        return `UPDATE informixoltp:payment_detail SET date_modified = CURRENT, net_amount = ${amt}, gross_amount = ${amt} WHERE payment_detail_id = ${paymentDetailId}`;
+      });
+
+      console.log("Payment Update Queries", paymentUpdateQueries);
+
+      await Promise.all(
+        paymentUpdateQueries.map((query) => aclQueryDomain.rawQuery({ sql: query }))
+      );
+    }
+  }
+
+  return {
+    success: true,
+    message: "Successfully updated legacy payout",
+  };
+}
+updateLegacyPayout.schema = {
+  currentUser: Joi.any(),
+  challengeId: Joi.id(),
+  data: Joi.object()
+    .keys({
+      userId: Joi.number().integer().positive().required(),
+      amount: Joi.number().allow(null),
+      status: Joi.string().allow(null),
+      datePaid: Joi.string().allow(null),
+      releaseDate: Joi.string().allow(null),
+    })
+};
+
 /**
  * Get SRM Schedule
  * @param {Object} criteria the criteria
@@ -2543,6 +2678,7 @@ module.exports = {
   getChallenge,
   updateChallenge,
   deleteChallenge,
+  updateLegacyPayout,
   getChallengeStatistics,
   sendNotifications,
   advancePhase,