Merge pull request #152 from topcoder-platform/develop

updated createReview schema for null score for queued submission

Author: Dushyant Bhalgami

package-lock.json

@@ -50,6 +50,7 @@
     "chai": "^4.1.2",
     "chai-http": "^4.0.0",
     "co-mocha": "^1.2.2",
+    "husky": "^3.0.5",
     "mocha": "^5.2.0",
     "mocha-prepare": "^0.1.0",
     "nock": "^9.4.3",
@@ -64,5 +65,10 @@
     "env": [
       "mocha"
     ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run lint"
+    }
   }
 }

package.json

@@ -33,11 +33,11 @@ function deleteDatafromES () {
 function * loadReviewTypes () {
   const promises = []
   reviewTypes.forEach((reviewType) => {
-    let record = {
+    const record = {
       index: config.get('esConfig.ES_INDEX'),
       type: config.get('esConfig.ES_TYPE'),
       id: reviewType.id,
-      body: _.extend({'resource': 'reviewType'}, reviewType)
+      body: _.extend({ resource: 'reviewType' }, reviewType)
     }
     promises.push(esClient.create(record))
   })
@@ -50,11 +50,11 @@ function * loadReviewTypes () {
 function * loadSubmissions () {
   const promises = []
   submissions.forEach((submission) => {
-    let record = {
+    const record = {
       index: config.get('esConfig.ES_INDEX'),
       type: config.get('esConfig.ES_TYPE'),
       id: submission.id,
-      body: _.extend({'resource': 'submission'}, submission)
+      body: _.extend({ resource: 'submission' }, submission)
     }
     promises.push(esClient.create(record))
   })
@@ -67,11 +67,11 @@ function * loadSubmissions () {
 function * loadReviews () {
   const promises = []
   reviews.forEach((review) => {
-    let record = {
+    const record = {
       index: config.get('esConfig.ES_INDEX'),
       type: config.get('esConfig.ES_TYPE'),
       id: review.id,
-      body: _.extend({'resource': 'review'}, review)
+      body: _.extend({ resource: 'review' }, review)
     }
     promises.push(esClient.create(record))
   })
@@ -84,11 +84,11 @@ function * loadReviews () {
 function * loadReviewSummations () {
   const promises = []
   reviewSummations.forEach((reviewSummation) => {
-    let record = {
+    const record = {
       index: config.get('esConfig.ES_INDEX'),
       type: config.get('esConfig.ES_TYPE'),
       id: reviewSummation.id,
-      body: _.extend({'resource': 'reviewSummation'}, reviewSummation)
+      body: _.extend({ resource: 'reviewSummation' }, reviewSummation)
     }
     promises.push(esClient.create(record))
   })

scripts/ESloadHelper.js

@@ -15,31 +15,31 @@ co(function * loadData () {
   logger.info('Data import started!')
   const promises = []
   reviewTypes.forEach((reviewType) => {
-    let record = {
+    const record = {
       TableName: 'ReviewType',
       Item: reviewType
     }
     promises.push(dbhelper.insertRecord(record))
   })
 
   submissions.forEach((submission) => {
-    let record = {
+    const record = {
       TableName: 'Submission',
       Item: submission
     }
     promises.push(dbhelper.insertRecord(record))
   })
 
   reviews.forEach((review) => {
-    let record = {
+    const record = {
       TableName: 'Review',
       Item: review
     }
     promises.push(dbhelper.insertRecord(record))
   })
 
   reviewSummations.forEach((reviewSummation) => {
-    let record = {
+    const record = {
       TableName: 'ReviewSummation',
       Item: reviewSummation
     }

scripts/importData.js

@@ -19,21 +19,23 @@ const esClient = helper.getEsClient()
 function * migrateRecords (tableName) {
   let promises = []
   let batchCounter = 1
-  let params = {
+  const params = {
     TableName: tableName
   }
   // Process until all the records from DB is fetched
   while (true) {
-    let records = yield dbhelper.scanRecords(params)
-    let totalRecords = records.Items.length
+    const records = yield dbhelper.scanRecords(params)
+    const totalRecords = records.Items.length
     logger.debug(`Number of ${tableName}s fetched from DB - ` + totalRecords)
     for (let i = 0; i < totalRecords; i++) {
-      let record = {
+      const record = {
         index: config.get('esConfig.ES_INDEX'),
         type: config.get('esConfig.ES_TYPE'),
         id: records.Items[i].id,
-        body: { doc: _.extend({ resource: helper.camelize(tableName) }, records.Items[i]),
-          doc_as_upsert: true }
+        body: {
+          doc: _.extend({ resource: helper.camelize(tableName) }, records.Items[i]),
+          doc_as_upsert: true
+        }
       }
       promises.push(esClient.update(record))
 

scripts/migrateFromDBToES.js

@@ -19,21 +19,21 @@ AWS.config.update({
  * @return {Object} DynamoDB Connection Instance
  */
 function getDb () {
-  if (!dbs['conn']) {
-    dbs['conn'] = new AWS.DynamoDB()
+  if (!dbs.conn) {
+    dbs.conn = new AWS.DynamoDB()
   }
-  return dbs['conn']
+  return dbs.conn
 }
 
 /**
  * Get DynamoDB Document Client
  * @return {Object} DynamoDB Document Client Instance
  */
 function getDbClient () {
-  if (!dbClients['client']) {
-    dbClients['client'] = new AWS.DynamoDB.DocumentClient()
+  if (!dbClients.client) {
+    dbClients.client = new AWS.DynamoDB.DocumentClient()
   }
-  return dbClients['client']
+  return dbClients.client
 }
 
 /**

src/common/dbhelper.js

@@ -82,10 +82,10 @@ function getBusApiClient () {
  */
 function getEsClient () {
   const esHost = config.get('esConfig.HOST')
-  if (!esClients['client']) {
+  if (!esClients.client) {
     // AWS ES configuration is different from other providers
     if (/.*amazonaws.*/.test(esHost)) {
-      esClients['client'] = elasticsearch.Client({
+      esClients.client = elasticsearch.Client({
         apiVersion: config.get('esConfig.API_VERSION'),
         hosts: esHost,
         connectionClass: require('http-aws-es'), // eslint-disable-line global-require
@@ -95,13 +95,13 @@ function getEsClient () {
         }
       })
     } else {
-      esClients['client'] = new elasticsearch.Client({
+      esClients.client = new elasticsearch.Client({
         apiVersion: config.get('esConfig.API_VERSION'),
         hosts: esHost
       })
     }
   }
-  return esClients['client']
+  return esClients.client
 }
 
 /*
@@ -135,7 +135,7 @@ function prepESFilter (query, actResource) {
   // Adding resource filter
   boolQuery.push({ match_phrase: { resource: actResource } })
   _.map(filters, (value, key) => {
-    let pair = {}
+    const pair = {}
     pair[key] = value
     if (key.indexOf('.') > -1) {
       const resKey = key.split('.')[0]
@@ -182,7 +182,7 @@ function prepESFilter (query, actResource) {
     from: (page - 1) * pageSize, // Es Index starts from 0
     body: {
       _source: {
-        exclude: [ 'resource' ] // Remove the resource field which is not required
+        exclude: ['resource'] // Remove the resource field which is not required
       },
       query: {
         bool: {
@@ -196,14 +196,14 @@ function prepESFilter (query, actResource) {
 
   if (sortBy) {
     const obj = {}
-    obj[sortBy] = { 'order': orderBy || 'asc' }
+    obj[sortBy] = { order: orderBy || 'asc' }
     esQuerySortArray.push(obj)
   }
 
   // Internal sorting by 'updated' timestamp
   if (actResource !== 'reviewType') {
     esQuerySortArray.push({
-      updated: { 'order': 'desc' }
+      updated: { order: 'desc' }
     })
   }
 
@@ -229,10 +229,12 @@ function * fetchFromES (query, resource) {
   // Extract data from hits
   const rows = _.map(docs.hits.hits, single => single._source)
 
-  const response = { 'total': docs.hits.total,
-    'pageSize': filter.size,
-    'page': query.page || 1,
-    'rows': rows }
+  const response = {
+    total: docs.hits.total,
+    pageSize: filter.size,
+    page: query.page || 1,
+    rows: rows
+  }
   return response
 }
 
@@ -283,7 +285,7 @@ function setPaginationHeaders (req, res, data) {
       'X-Per-Page': data.pageSize,
       'X-Total': data.total,
       'X-Total-Pages': totalPages,
-      'Link': link
+      Link: link
     })
   }
   // Return the data after setting pagination headers
@@ -317,9 +319,9 @@ function * getSubmissionPhaseId (challengeId) {
   }
   if (response) {
     const phases = _.get(response.body, 'result.content', [])
-    const checkPoint = _.filter(phases, {phaseType: 'Checkpoint Submission', phaseStatus: 'Open'})
-    const submissionPh = _.filter(phases, {phaseType: 'Submission', phaseStatus: 'Open'})
-    const finalFixPh = _.filter(phases, {phaseType: 'Final Fix', phaseStatus: 'Open'})
+    const checkPoint = _.filter(phases, { phaseType: 'Checkpoint Submission', phaseStatus: 'Open' })
+    const submissionPh = _.filter(phases, { phaseType: 'Submission', phaseStatus: 'Open' })
+    const finalFixPh = _.filter(phases, { phaseType: 'Final Fix', phaseStatus: 'Open' })
     if (checkPoint.length !== 0) {
       phaseId = checkPoint[0].id
     } else if (submissionPh.length !== 0) {
@@ -367,7 +369,7 @@ function * checkCreateAccess (authUser, subEntity) {
       throw new errors.HttpStatusError(403, 'You are not allowed to submit when submission phase is not open')
     }
 
-    const currPhase = _.filter(phases, {id: submissionPhaseId})
+    const currPhase = _.filter(phases, { id: submissionPhaseId })
 
     if (currPhase[0].phaseType === 'Final Fix') {
       if (!authUser.handle.equals(winner[0].handle)) {
@@ -442,33 +444,35 @@ function * checkGetAccess (authUser, submission) {
 
       // User is either a Reviewer or Screener
       if (screener.length !== 0 || reviewer.length !== 0) {
-        const screeningPhase = _.filter(phases, { phaseType: 'Screening', 'phaseStatus': 'Scheduled' })
-        const reviewPhase = _.filter(phases, { phaseType: 'Review', 'phaseStatus': 'Scheduled' })
+        const screeningPhase = _.filter(phases, { phaseType: 'Screening', phaseStatus: 'Scheduled' })
+        const reviewPhase = _.filter(phases, { phaseType: 'Review', phaseStatus: 'Scheduled' })
 
         // Neither Screening Nor Review is Opened / Closed
         if (screeningPhase.length !== 0 && reviewPhase.length !== 0) {
           throw new errors.HttpStatusError(403, 'You can access the submission only when Screening / Review is open')
         }
       } else {
-        const appealsResponse = _.filter(phases, { phaseType: 'Appeals Response', 'phaseStatus': 'Closed' })
+        const appealsResponse = _.filter(phases, { phaseType: 'Appeals Response', phaseStatus: 'Closed' })
 
         // Appeals Response is not closed yet
         if (appealsResponse.length === 0) {
           throw new errors.HttpStatusError(403, 'You cannot access other submissions before the end of Appeals Response phase')
         } else {
-          const userSubmission = yield fetchFromES({ challengeId: submission.challengeId,
-            memberId: authUser.userId }, camelize('Submission'))
+          const userSubmission = yield fetchFromES({
+            challengeId: submission.challengeId,
+            memberId: authUser.userId
+          }, camelize('Submission'))
           // User requesting submission haven't made any submission
           if (userSubmission.total === 0) {
-            throw new errors.HttpStatusError(403, `You did not submit to the challenge!`)
+            throw new errors.HttpStatusError(403, 'You did not submit to the challenge!')
           }
 
           const reqSubmission = userSubmission.rows[0]
           // Only if the requestor has passing score, allow to download other submissions
           if (reqSubmission.reviewSummation && reqSubmission.reviewSummation[0].isPassing) {
             return true
           } else {
-            throw new errors.HttpStatusError(403, `You should have passed the review to access other member submissions!`)
+            throw new errors.HttpStatusError(403, 'You should have passed the review to access other member submissions!')
           }
         }
       }
@@ -509,7 +513,7 @@ function * checkReviewGetAccess (authUser, submission) {
       logger.info('No access check for Marathon match')
       return true
     } else {
-      const appealsResponse = _.filter(phases, { phaseType: 'Appeals Response', 'phaseStatus': 'Closed' })
+      const appealsResponse = _.filter(phases, { phaseType: 'Appeals Response', phaseStatus: 'Closed' })
 
       // Appeals Response is not closed yet
       if (appealsResponse.length === 0) {
@@ -541,15 +545,15 @@ function * downloadFile (fileURL) {
  */
 function * postToBusApi (payload) {
   const busApiClient = getBusApiClient()
-  const originalTopic = payload['topic']
+  const originalTopic = payload.topic
 
   yield busApiClient.postEvent(payload)
 
   // Post to aggregate topic
-  payload['topic'] = config.get('KAFKA_AGGREGATE_TOPIC')
+  payload.topic = config.get('KAFKA_AGGREGATE_TOPIC')
 
   // Store the original topic
-  payload['payload']['originalTopic'] = originalTopic
+  payload.payload.originalTopic = originalTopic
 
   yield busApiClient.postEvent(payload)
 }

src/common/helper.js

@@ -41,8 +41,8 @@ function * _uploadToS3 (file, name) {
  */
 function * downloadArtifact (submissionId, fileName) {
   // Check the validness of Submission ID
-  yield HelperService._checkRef({submissionId})
-  const artifacts = yield s3.listObjects({Bucket: config.aws.ARTIFACT_BUCKET, Prefix: `${submissionId}/${fileName}`}).promise()
+  yield HelperService._checkRef({ submissionId })
+  const artifacts = yield s3.listObjects({ Bucket: config.aws.ARTIFACT_BUCKET, Prefix: `${submissionId}/${fileName}` }).promise()
   if (artifacts.Contents.length === 0) {
     throw new errors.HttpStatusError(400, `Artifact ${fileName} doesn't exist for ${submissionId}`)
   }
@@ -65,8 +65,8 @@ downloadArtifact.schema = {
  */
 function * listArtifacts (submissionId) {
   // Check the validness of Submission ID
-  yield HelperService._checkRef({submissionId})
-  const artifacts = yield s3.listObjects({Bucket: config.aws.ARTIFACT_BUCKET, Prefix: submissionId}).promise()
+  yield HelperService._checkRef({ submissionId })
+  const artifacts = yield s3.listObjects({ Bucket: config.aws.ARTIFACT_BUCKET, Prefix: submissionId }).promise()
   return { artifacts: _.map(artifacts.Contents, (at) => path.parse(at.Key).name) }
 }
 
@@ -93,8 +93,10 @@ function * createArtifact (files, submissionId, entity) {
     let exist
     // Check the existence of file in S3 bucket
     try {
-      exist = yield s3.headObject({ Bucket: config.aws.ARTIFACT_BUCKET,
-        Key: fileName}).promise()
+      exist = yield s3.headObject({
+        Bucket: config.aws.ARTIFACT_BUCKET,
+        Key: fileName
+      }).promise()
     } catch (err) {
       if (err.statusCode !== 404) throw err
     }
@@ -123,8 +125,8 @@ createArtifact.schema = {
  */
 function * deleteArtifact (submissionId, fileName) {
   // Check the validness of Submission ID
-  yield HelperService._checkRef({submissionId})
-  const artifacts = yield s3.listObjects({Bucket: config.aws.ARTIFACT_BUCKET, Prefix: `${submissionId}/${fileName}`}).promise()
+  yield HelperService._checkRef({ submissionId })
+  const artifacts = yield s3.listObjects({ Bucket: config.aws.ARTIFACT_BUCKET, Prefix: `${submissionId}/${fileName}` }).promise()
   if (artifacts.Contents.length === 0) {
     throw new errors.HttpStatusError(404, `Artifact ${fileName} doesn't exist for submission ID: ${submissionId}`)
   }