Merge pull request #186 from Ghost141/challenges_api_improvement

Challenges api improvement

Author: wenhui-wd

actions/challengeRegistration.js

@@ -3,14 +3,17 @@
  *
  * The APIs to register a challenge (studio category or software category) for the current logged-in user.
  *
- * @version 1.2
- * @author ecnu_haozi, xjtufreeman, TCSASSEMBLER
+ * @version 1.3
+ * @author ecnu_haozi, xjtufreeman, bugbuka
  *
  * changes in 1.1:
  * Combine Challenge Registration API(BUGR-11058)
  *
  * changes in 1.2:
  * Integrate the forums operation(Module Assembly - Integrating Forums Wrapper with Challenge Registration API)
+ *
+ * changes in 1.3:
+ * move common function getForumWrapper, aduitResourceAddition to challengeHelper.js
  */
 "use strict";
 
@@ -26,25 +29,6 @@ var ForbiddenError = require('../errors/ForbiddenError');
  */
 var forumWrapper = null;
 
-/**
- * Get forum wrapper. It is initialized only once.
- * @param {Object} api The api object that is used to access the infrastructure.
- * @param {Function<err, forumWrapper>} callback the callback function
- */
-var getForumWrapper = function (api, callback) {
-    if (forumWrapper) {
-        callback(null, forumWrapper);
-    } else {
-        try {
-            forumWrapper = new ForumWrapper(api.config.general.devForumJNDI);
-            callback(null, forumWrapper);
-        } catch (ex) {
-            api.log('Failed to connect to forum: ' + ex + " " + (ex.stack || ''), 'error');
-            callback(new Error('Failed to connect to forum'));
-        }
-    }
-};
-
 //constants
 var DESIGN_PROJECT_TYPE = 1,
     DEVELOPMENT_PROJECT_TYPE = 2,
@@ -162,27 +146,6 @@ var persistResource = function (api, resourceId, userId, challengeId, dbConnecti
         });
 };
 
-/**
- * Audit the challenge registration on table 'tcs_catalog.project_user_audit'.
- *
- * @param {Object} api The api object that is used to access the infrastructure.
- * @param {Number} userId The current logged-in user's id.
- * @param {Number} challengeId The id of the challenge to register.
- * @param {Object} dbConnectionMap The database connection map for the current request.
- * @param {Function<err, data>} next The callback to be called after this function is done.
- */
-var aduitResourceAddition = function (api, userId, challengeId, dbConnectionMap, next) {
-    api.dataAccess.executeQuery("audit_challenge_registration", {
-        projectId: challengeId,
-        resourceUserId: userId,
-        resourceRoleId: SUBMITTER_RESOURCE_ROLE_ID,
-        auditActionTypeId: PROJECT_USER_AUDIT_CREATE_TYPE,
-        actionUserId: userId
-    },
-        dbConnectionMap,
-        next);
-};
-
 /**
  * Check if the rating suit for software category contests. 
  * The code logic is duplicated from server-side java code.
@@ -282,7 +245,7 @@ var projectTrack = function (api, userId, challengeId, componentInfo, dbConnecti
         function (resourceId, callback) {
             async.parallel([
                 function (cb) {
-                    aduitResourceAddition(api, userId, challengeId, dbConnectionMap, cb);
+                    api.challengeHelper.aduitResourceAddition(api, userId, challengeId, SUBMITTER_RESOURCE_ROLE_ID, PROJECT_USER_AUDIT_CREATE_TYPE, dbConnectionMap, cb);
                 },
                 function (cb) {
                     prepareProjectResult(
@@ -487,7 +450,7 @@ var grantForumAccess = function (api, userId, activeForumCategoryId, next) {
     api.log('start to grant user ' + userId + ' forum category ' +  activeForumCategoryId + ' access.');
     async.waterfall([
         function (cb) {
-            getForumWrapper(api, cb);
+            api.challengeHelper.getForumWrapper(api, cb);
         }, function (forumWrapper, cb) {
             forumWrapper.assignRole(userId, "Software_Users_" + activeForumCategoryId, function (err) {
                 if (err) {
@@ -646,8 +609,8 @@ var timelineNotification = function (api, userId, challengeId, dbConnectionMap,
                     dbConnectionMap,
                     cb);
             } else {
-				cb(null);
-			}
+                cb(null);
+            }
         }
     ], next);
 };
@@ -685,23 +648,23 @@ var registerSoftwareChallengeAction = function (api, connection, next) {
     if (connection.dbConnectionMap) {
         api.log("Execute registerSoftwareChallengeAction#run", 'debug');
 
-        var challengeId = Number(connection.params.challengeId);
-        var sqlParams = {
-            challengeId: challengeId,
-            user_id: connection.caller.userId
-        };
-        var execQuery = function (name) {
-            return function (cbx) {
-                api.dataAccess.executeQuery(name, sqlParams, connection.dbConnectionMap, cbx);
+        var challengeId = Number(connection.params.challengeId),
+            sqlParams = {
+                challengeId: challengeId,
+                user_id: connection.caller.userId
+            },
+            execQuery = function (name) {
+                return function (cbx) {
+                    api.dataAccess.executeQuery(name, sqlParams, connection.dbConnectionMap, cbx);
+                };
             };
-        };
         async.waterfall([
-            function(cb) {
+            function (cb) {
                 async.parallel({
                     isCopilotPosting: execQuery('check_challenge_is_copilot_posting'),
                     isCopilot: execQuery('check_is_copilot')
                 }, cb);
-            }, function(res, cb) {
+            }, function (res, cb) {
                 if (res.isCopilotPosting.length > 0 && res.isCopilotPosting[0].challenge_is_copilot) {
                     if (res.isCopilot.length === 0 || !res.isCopilot[0].user_is_copilot) {
                         cb(new ForbiddenError('You should be a copilot before register a copilot posting.'));
@@ -713,6 +676,7 @@ var registerSoftwareChallengeAction = function (api, connection, next) {
                     connection,
                     challengeId,
                     "Submitter", //optional value. Here we don't need to provide such value.
+                    true,
                     connection.dbConnectionMap,
                     cb
                 );
@@ -763,6 +727,7 @@ var registerStudioChallengeAction = function (api, connection, next) {
                     connection,
                     challengeId,
                     "Submitter",
+                    true,
                     connection.dbConnectionMap,
                     cb
                 );