Merge pull request #63 from topcoder-platform/prod2172_try2

eisbilir · web-flow · commit 1ba8c4a20c09 · 2022-07-19T20:07:43.000+03:00
uploading non-project changes to new branch
diff --git a/src/main/java/com/topcoder/onlinereview/component/project/payment/calculator/DefaultProjectPaymentCalculator.java b/src/main/java/com/topcoder/onlinereview/component/project/payment/calculator/DefaultProjectPaymentCalculator.java
@@ -13,10 +13,7 @@
 import java.math.BigDecimal;
 import java.math.RoundingMode;
 import java.sql.SQLException;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Optional;
+import java.util.*;
 
 import static com.google.common.collect.Lists.newArrayList;
 import static com.topcoder.onlinereview.component.util.CommonUtils.executeSqlWithParam;
@@ -294,7 +291,7 @@ public class DefaultProjectPaymentCalculator implements ProjectPaymentCalculator
      * </p>
      */
     public static final String DEFAULT_CONFIG_NAMESPACE =
-        "com.topcoder.management.payment.calculator.impl.DefaultProjectPaymentCalculator";
+            "com.topcoder.management.payment.calculator.impl.DefaultProjectPaymentCalculator";
 
     /**
      * <p>
@@ -466,8 +463,18 @@ public class DefaultProjectPaymentCalculator implements ProjectPaymentCalculator
      * </p>
      */
     private static final String GET_DEFAULT_PAYMENT_QUERY =
-        "SELECT fixed_amount, base_coefficient, incremental_coefficient " + "FROM default_project_payment "
-            + "WHERE project_category_id = ? and resource_role_id = ?";
+            "SELECT fixed_amount, base_coefficient, incremental_coefficient " + "FROM default_project_payment "
+                    + "WHERE project_category_id = ? and resource_role_id = ?";
+
+    /**
+     * <p>
+     * The SQL query to retrieve metadata for a challenge to determine if it should skip payments calc
+     * </p>
+     */
+    private static final String SKIP_PAYMENTS_FIELD = "skip_payments";
+    private static final String SKIP_PAYMENTS_METADATA_TYPE_ID = "skip_OR_payment_calcs"; // shared with challenge-api
+    private static final String GET_METADATA_QUERY =
+            "SELECT pi.value " + SKIP_PAYMENTS_FIELD + " FROM project_info pi WHERE pi.project_id=? AND pi.project_info_type_id='" + SKIP_PAYMENTS_METADATA_TYPE_ID + "'";
 
     /**
      * <p>
@@ -476,30 +483,50 @@ public class DefaultProjectPaymentCalculator implements ProjectPaymentCalculator
      * </p>
      */
     private static final String GET_DEFAULT_PAYMENTS_QUERY =
-        "SELECT dpp.resource_role_id, dpp.fixed_amount, dpp.base_coefficient, dpp.incremental_coefficient,"
-            + "max(pr.prize_amount) as prize,"
-            + "sum(case when s.submission_type_id = 1 then 1 else 0 end) as total_contest_submissions,"
-            + "sum(case when s.submission_type_id = 1 and s.submission_status_id != 2 then 1 else 0 end) "
-            + "as passed_contest_submissions,"
-            + "sum(case when s.submission_type_id = 3 then 1 else 0 end) as total_checkpoint_submissions,"
-            + "sum(case when s.submission_type_id = 3 and s.submission_status_id != 6 then 1 else 0 end) "
-            + "as passed_checkpoint_submissions, "
-            + "sum(case when s.submission_type_id = 1 and exists (select 1 from review r "
-            + "where r.submission_id = s.submission_id and r.committed = 1) then 1 else 0 end) "
-            + "as total_reviewed_contest_submissions "
-            + "FROM default_project_payment dpp "
-            + "INNER JOIN project p ON dpp.project_category_id = p.project_category_id and p.project_id=? "
-            + "LEFT OUTER JOIN prize pr ON pr.project_id=p.project_id and pr.prize_type_id=15 and pr.place=1 "
-            + "LEFT OUTER JOIN upload u ON u.project_id = p.project_id and u.upload_type_id = 1 "
-            + "LEFT OUTER JOIN submission s ON s.submission_type_id in (1,3) and s.upload_id = u.upload_id "
-            + "and s.submission_status_id in (1,2,3,4,6,7) "
-            + "WHERE dpp.resource_role_id in (2,4,5,6,7,8,9,14,18,19,20,21) "
-            + "GROUP BY dpp.resource_role_id, dpp.fixed_amount, dpp.base_coefficient, dpp.incremental_coefficient";
+            "SELECT dpp.resource_role_id, dpp.fixed_amount, dpp.base_coefficient, dpp.incremental_coefficient,"
+                    + "max(pr.prize_amount) as prize,"
+                    + "sum(case when s.submission_type_id = 1 then 1 else 0 end) as total_contest_submissions,"
+                    + "sum(case when s.submission_type_id = 1 and s.submission_status_id != 2 then 1 else 0 end) "
+                    + "as passed_contest_submissions,"
+                    + "sum(case when s.submission_type_id = 3 then 1 else 0 end) as total_checkpoint_submissions,"
+                    + "sum(case when s.submission_type_id = 3 and s.submission_status_id != 6 then 1 else 0 end) "
+                    + "as passed_checkpoint_submissions, "
+                    + "sum(case when s.submission_type_id = 1 and exists (select 1 from review r "
+                    + "where r.submission_id = s.submission_id and r.committed = 1) then 1 else 0 end) "
+                    + "as total_reviewed_contest_submissions "
+                    + "FROM default_project_payment dpp "
+                    + "INNER JOIN project p ON dpp.project_category_id = p.project_category_id and p.project_id=? "
+                    + "LEFT OUTER JOIN prize pr ON pr.project_id=p.project_id and pr.prize_type_id=15 and pr.place=1 "
+                    + "LEFT OUTER JOIN upload u ON u.project_id = p.project_id and u.upload_type_id = 1 "
+                    + "LEFT OUTER JOIN submission s ON s.submission_type_id in (1,3) and s.upload_id = u.upload_id "
+                    + "and s.submission_status_id in (1,2,3,4,6,7) "
+                    + "WHERE dpp.resource_role_id in (2,4,5,6,7,8,9,14,18,19,20,21) "
+                    + "GROUP BY dpp.resource_role_id, dpp.fixed_amount, dpp.base_coefficient, dpp.incremental_coefficient";
 
     @Autowired
     @Qualifier("tcsJdbcTemplate")
     private JdbcTemplate jdbcTemplate;
 
+    /**
+     * This contains a list of roles for which payment calculation should be skipped
+     * when the skip payment flag is set by the self-service app.
+     */
+    private List<Long> reviewerRoles;
+
+    public DefaultProjectPaymentCalculator() {
+        super();
+        // create list of reviewer roles
+        reviewerRoles = new ArrayList<Long>();
+        reviewerRoles.add(REVIEWER_RESOURCE_ROLE_ID);
+        reviewerRoles.add(ACCURACY_REVIEWER_RESOURCE_ROLE_ID);
+        reviewerRoles.add(FAILURE_REVIEWER_RESOURCE_ROLE_ID);
+        reviewerRoles.add(STRESS_REVIEWER_RESOURCE_ROLE_ID);
+        reviewerRoles.add(FINAL_REVIEWER_RESOURCE_ROLE_ID);
+        reviewerRoles.add(SPECIFICATION_REVIEWER_RESOURCE_ROLE_ID);
+        reviewerRoles.add(CHECKPOINT_REVIEWER_RESOURCE_ROLE_ID);
+        reviewerRoles.add(ITERATIVE_REVIEWER_RESOURCE_ROLE_ID);
+    }
+
     /**
      * <p>
      * This method is a concrete implementation of the namesake method defined in the interface.
@@ -539,33 +566,29 @@ public class DefaultProjectPaymentCalculator implements ProjectPaymentCalculator
      *             If any error occurred during the operation.
      */
     public Map<Long, BigDecimal> getDefaultPayments(long projectId, List<Long> resourceRoleIDs)
-        throws ProjectPaymentCalculatorException {
+            throws ProjectPaymentCalculatorException {
         String signature = DEFAULT_CONFIG_NAMESPACE + "#getDefaultPayments(long, List<Long>)";
         Helper.logEntrance(log, signature, new String[] {"projectId", "resourceRoleIDs"},
-            new Object[] {projectId, resourceRoleIDs});
+                new Object[] {projectId, resourceRoleIDs});
 
         // arguments checking
-        try {
-            Helper.checkPositive(projectId, "projectId");
-            Helper.checkNotNullNorEmpty(resourceRoleIDs, "resourceRoleIDs");
-            Helper.checkNotNullElements(resourceRoleIDs, "resourceRoleIDs");
-        } catch (IllegalArgumentException e) {
-            throw Helper.logException(log, signature, e);
-        }
+        Helper.checkPositive(projectId, "projectId");
+        Helper.checkNotNullNorEmpty(resourceRoleIDs, "resourceRoleIDs");
+        Helper.checkNotNullElements(resourceRoleIDs, "resourceRoleIDs");
 
         try {
-          // Execute the query and get the result.
-          List<Map<String, Object>> resultSet = executeSqlWithParam(jdbcTemplate, GET_DEFAULT_PAYMENTS_QUERY, newArrayList(projectId));
-
+            // get skip payments flag for project
+            boolean skipPayments = isSkipPaymentsFlagPresentForProject(projectId);
+            // Execute the query and get the result.
+            List<Map<String, Object>> resultSet = executeSqlWithParam(jdbcTemplate, GET_DEFAULT_PAYMENTS_QUERY, newArrayList(projectId));
             Map<Long, BigDecimal> defaultPaymentsMap = new HashMap<Long, BigDecimal>();
-
             // Iterate through the supported resource roles IDs and compute the default payment for each one of the
             // requested resource role
             for (Map<String, Object> row: resultSet) {
                 long roleId = getLong(row, RESOURCE_ROLE_ID_COLUMN);
-                if (resourceRoleIDs.contains(roleId)) {
+                if (resourceRoleIDs.contains(roleId) && !(skipPayments && reviewerRoles.contains(roleId))) {
                     BigDecimal fixedAmount =
-                        new BigDecimal(getDouble(row, FIXED_AMOUNT_COLUMN)).setScale(2, RoundingMode.HALF_UP);
+                            new BigDecimal(getDouble(row, FIXED_AMOUNT_COLUMN)).setScale(2, RoundingMode.HALF_UP);
                     float baseCoefficient = ofNullable(getFloat(row, BASE_COEFFICIENT_COLUMN)).orElse(0F);
                     float incrementalCoefficient = ofNullable(getFloat(row, INCREMENTAL_COEFFICIENT_COLUMN)).orElse(0F);
                     float prize = ofNullable(getFloat(row, PRIZE_COLUMN)).orElse(0F);
@@ -575,22 +598,42 @@ public Map<Long, BigDecimal> getDefaultPayments(long projectId, List<Long> resou
 
                     // calculate the payment
                     BigDecimal augend =
-                        BigDecimal.valueOf((baseCoefficient + incrementalCoefficient * submissionsCount) * prize);
-
+                            BigDecimal.valueOf((baseCoefficient + incrementalCoefficient * submissionsCount) * prize);
                     BigDecimal payment = fixedAmount.add(augend.setScale(2, RoundingMode.HALF_UP));
 
                     // put into the map
                     defaultPaymentsMap.put(roleId, payment);
                 }
             }
-
             Helper.logExit(log, signature, new Object[] {defaultPaymentsMap});
-
             return defaultPaymentsMap;
         } catch (SQLException e) {
             throw Helper.logException(log, signature, new ProjectPaymentCalculatorException(
-                "Fails to query project payments from database", e));
+                    "Fails to query project payments from database", e));
+        }
+    }
+
+    /**
+     * Queries the project attributes table for the payment skipped flag (challenge metadata in v5)
+     *
+     * @param projectId
+     * @return true if payments are skipped, false, otherwise
+     */
+    private boolean isSkipPaymentsFlagPresentForProject(long projectId) {
+        List<Map<String, Object>> resultSet = executeSqlWithParam(jdbcTemplate, GET_METADATA_QUERY, newArrayList(projectId));
+        if (resultSet == null || resultSet.size() == 0) { return false; }
+        String skipPayments = resultSet.get(0).get(SKIP_PAYMENTS_FIELD).toString();
+        if (skipPayments == null) { return false; }
+        // assumed format
+        if ("true".equalsIgnoreCase(skipPayments.trim())) { return true; }
+        // maybe not in assumed format, try to parseBool
+        try {
+            Boolean b = Boolean.parseBoolean(skipPayments);
+            return b;
+        } catch (Throwable t) {
+            // don't care, return false;
         }
+        return false;
     }
 
     /**
@@ -633,11 +676,11 @@ public Map<Long, BigDecimal> getDefaultPayments(long projectId, List<Long> resou
      *             If any error occurred during the operation.
      */
     public BigDecimal getDefaultPayment(long projectCategoryId, long resourceRoleId, BigDecimal prize,
-        int submissionsCount) throws ProjectPaymentCalculatorException {
+                                        int submissionsCount) throws ProjectPaymentCalculatorException {
         String signature = DEFAULT_CONFIG_NAMESPACE + "#getDefaultPayment(long, long, BigDecimal, int)";
         Helper.logEntrance(log, signature, new String[] {"projectCategoryId", "resourceRoleId",
-            PRIZE_COLUMN, "submissionsCount"},
-            new Object[] {projectCategoryId, resourceRoleId, prize, submissionsCount});
+                        PRIZE_COLUMN, "submissionsCount"},
+                new Object[] {projectCategoryId, resourceRoleId, prize, submissionsCount});
 
         // arguments checking
         try {
@@ -668,9 +711,9 @@ public BigDecimal getDefaultPayment(long projectCategoryId, long resourceRoleId,
 
             BigDecimal scaledPrize = prize.setScale(2, RoundingMode.HALF_UP);
             BigDecimal multiplicandCoefficient =
-                BigDecimal.valueOf(baseCoefficient + incrementalCoefficient * count);
+                    BigDecimal.valueOf(baseCoefficient + incrementalCoefficient * count);
             payment =
-                fixedAmount.add(scaledPrize.multiply(multiplicandCoefficient)).setScale(2, RoundingMode.HALF_UP);
+                    fixedAmount.add(scaledPrize.multiply(multiplicandCoefficient)).setScale(2, RoundingMode.HALF_UP);
         }
         Helper.logExit(log, signature, new Object[] {payment});
 
@@ -701,8 +744,8 @@ private static int getSubmissionsCount(Map<String, Object> resultSet, long resou
         }
 
         if (resourceRoleId == REVIEWER_RESOURCE_ROLE_ID || resourceRoleId == ACCURACY_REVIEWER_RESOURCE_ROLE_ID
-            || resourceRoleId == FAILURE_REVIEWER_RESOURCE_ROLE_ID
-            || resourceRoleId == STRESS_REVIEWER_RESOURCE_ROLE_ID) {
+                || resourceRoleId == FAILURE_REVIEWER_RESOURCE_ROLE_ID
+                || resourceRoleId == STRESS_REVIEWER_RESOURCE_ROLE_ID) {
             submissionsCount = getInt(resultSet, "passed_contest_submissions");
         }
 
@@ -740,12 +783,12 @@ private static int getSubmissionsCount(Map<String, Object> resultSet, long resou
      */
     private static boolean isSubmissionRequired(long resourceRoleId) {
         return (resourceRoleId == PRIMARY_SCREENER_RESOURCE_ROLE_ID || resourceRoleId == REVIEWER_RESOURCE_ROLE_ID
-            || resourceRoleId == ACCURACY_REVIEWER_RESOURCE_ROLE_ID
-            || resourceRoleId == FAILURE_REVIEWER_RESOURCE_ROLE_ID
-            || resourceRoleId == STRESS_REVIEWER_RESOURCE_ROLE_ID
-            || resourceRoleId == CHECKPOINT_SCREENER_RESOURCE_ROLE_ID
-            || resourceRoleId == CHECKPOINT_REVIEWER_RESOURCE_ROLE_ID
-            || resourceRoleId == ITERATIVE_REVIEWER_RESOURCE_ROLE_ID);
+                || resourceRoleId == ACCURACY_REVIEWER_RESOURCE_ROLE_ID
+                || resourceRoleId == FAILURE_REVIEWER_RESOURCE_ROLE_ID
+                || resourceRoleId == STRESS_REVIEWER_RESOURCE_ROLE_ID
+                || resourceRoleId == CHECKPOINT_SCREENER_RESOURCE_ROLE_ID
+                || resourceRoleId == CHECKPOINT_REVIEWER_RESOURCE_ROLE_ID
+                || resourceRoleId == ITERATIVE_REVIEWER_RESOURCE_ROLE_ID);
     }
 
 
