Add JobIds to /jobs endpoint:30185451

Author: dengjun

docs/Topcoder-bookings-api.postman_collection.json

@@ -1,6 +1,6 @@
 {
 	"info": {
-		"_postman_id": "3f80d93d-6ca3-4645-970d-a9e533394e2e",
+		"_postman_id": "4b866040-1336-427b-9e20-56d809b87519",
 		"name": "Topcoder-bookings-api",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
 	},
@@ -491,6 +491,113 @@
 					},
 					"response": []
 				},
+				{
+					"name": "search jobs with request body",
+					"protocolProfileBehavior": {
+						"disableBodyPruning": true
+					},
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "Authorization",
+								"type": "text",
+								"value": "Bearer {{token_bookingManager}}"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\r\n    \"jobIds\": [\"{{jobId}}\",\"{{jobIdCreatedByM2M}}\"]\r\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "{{URL}}/jobs",
+							"host": [
+								"{{URL}}"
+							],
+							"path": [
+								"jobs"
+							],
+							"query": [
+								{
+									"key": "page",
+									"value": "0",
+									"disabled": true
+								},
+								{
+									"key": "perPage",
+									"value": "3",
+									"disabled": true
+								},
+								{
+									"key": "sortBy",
+									"value": "id",
+									"disabled": true
+								},
+								{
+									"key": "sortOrder",
+									"value": "asc",
+									"disabled": true
+								},
+								{
+									"key": "projectId",
+									"value": "21",
+									"disabled": true
+								},
+								{
+									"key": "externalId",
+									"value": "1212",
+									"disabled": true
+								},
+								{
+									"key": "description",
+									"value": "Dummy",
+									"disabled": true
+								},
+								{
+									"key": "startDate",
+									"value": "2020-09-27T04:17:23.131Z",
+									"disabled": true
+								},
+								{
+									"key": "resourceType",
+									"value": "Dummy Resource Type",
+									"disabled": true
+								},
+								{
+									"key": "skill",
+									"value": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+									"disabled": true
+								},
+								{
+									"key": "rateType",
+									"value": "hourly",
+									"disabled": true
+								},
+								{
+									"key": "status",
+									"value": "sourcing",
+									"disabled": true
+								},
+								{
+									"key": "workload",
+									"value": "full-time",
+									"disabled": true
+								},
+								{
+									"key": "title",
+									"value": "dummy",
+									"disabled": true
+								}
+							]
+						}
+					},
+					"response": []
+				},
 				{
 					"name": "search jobs with with m2m all",
 					"request": {

docs/swagger.yaml

@@ -181,6 +181,11 @@ paths:
             type: string
             enum: ["sourcing", "in-review", "assigned", "closed", "cancelled"]
           description: The rate type.
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/JobSearchBody"
       responses:
         "200":
           description: OK
@@ -3317,6 +3322,15 @@ components:
           type: string
           example: "topcoder user"
           description: "The user who updated the job last time.(Will get the user info from the token)"
+    JobSearchBody:
+      properties:
+        jobIds:
+          type: array
+          items:
+            type: string
+            format: uuid
+            description: "The array of job ids"
+
     JobRequestBody:
       required:
         - projectId
@@ -3517,7 +3531,18 @@ components:
           description: "The user id."
         status:
           type: string
-          enum: ["open", "placed", "selected", "client rejected - screening", "client rejected - interview", "rejected - other", "cancelled", "interview", "topcoder-rejected"]
+          enum:
+            [
+              "open",
+              "placed",
+              "selected",
+              "client rejected - screening",
+              "client rejected - interview",
+              "rejected - other",
+              "cancelled",
+              "interview",
+              "topcoder-rejected",
+            ]
           description: "The job candidate status."
           default: open
         externalId:
@@ -3632,7 +3657,15 @@ components:
           description: "Interview end time."
         status:
           type: string
-          enum: ["Scheduling", "Scheduled", "Requested for reschedule", "Rescheduled", "Completed", "Cancelled"]
+          enum:
+            [
+              "Scheduling",
+              "Scheduled",
+              "Requested for reschedule",
+              "Rescheduled",
+              "Completed",
+              "Cancelled",
+            ]
           description: "The interview status."
         rescheduleUrl:
           type: string
@@ -3678,7 +3711,15 @@ components:
             format: email
         status:
           type: string
-          enum: ["Scheduling", "Scheduled", "Requested for reschedule", "Rescheduled", "Completed", "Cancelled"]
+          enum:
+            [
+              "Scheduling",
+              "Scheduled",
+              "Requested for reschedule",
+              "Rescheduled",
+              "Completed",
+              "Cancelled",
+            ]
           default: "Scheduling"
           description: "The interview status."
     UpdateInterviewRequestBody:
@@ -3737,7 +3778,15 @@ components:
           description: "Interview end time."
         status:
           type: string
-          enum: ["Scheduling", "Scheduled", "Requested for reschedule", "Rescheduled", "Completed", "Cancelled"]
+          enum:
+            [
+              "Scheduling",
+              "Scheduled",
+              "Requested for reschedule",
+              "Rescheduled",
+              "Completed",
+              "Cancelled",
+            ]
           description: "The interview status."
         rescheduleUrl:
           type: string
@@ -3845,7 +3894,7 @@ components:
         billingAccountId:
           type: integer
           example: 80000071
-          description: 'the billing account id for payments'
+          description: "the billing account id for payments"
         createdAt:
           type: string
           format: date-time
@@ -3913,7 +3962,7 @@ components:
         billingAccountId:
           type: integer
           example: 80000071
-          description: 'the billing account id for payments'
+          description: "the billing account id for payments"
     ResourceBookingPatchRequestBody:
       properties:
         status:
@@ -3946,7 +3995,7 @@ components:
         billingAccountId:
           type: integer
           example: 80000071
-          description: 'the billing account id for payments'
+          description: "the billing account id for payments"
     WorkPeriod:
       required:
         - id
@@ -4130,7 +4179,7 @@ components:
         billingAccountId:
           type: integer
           example: 80000071
-          description: 'the billing account id for payments'
+          description: "the billing account id for payments"
         createdAt:
           type: string
           format: date-time

src/controllers/JobController.js

@@ -57,6 +57,9 @@ async function deleteJob (req, res) {
  * @param res the response
  */
 async function searchJobs (req, res) {
+  if (req.body && req.body.jobIds) {
+    req.query.jobIds = req.body.jobIds
+  }
   const result = await service.searchJobs(req.authUser, req.query)
   helper.setResHeaders(req, res, result)
   res.send(result.result)

src/services/JobService.js

@@ -344,7 +344,8 @@ async function searchJobs (currentUser, criteria, options = { returnAll: false }
       body: {
         query: {
           bool: {
-            must: []
+            must: [],
+            filter: []
           }
         },
         from: (page - 1) * perPage,
@@ -393,11 +394,19 @@ async function searchJobs (currentUser, criteria, options = { returnAll: false }
     })
     // If criteria contains projectIds, filter projectId with this value
     if (criteria.projectIds) {
-      esQuery.body.query.bool.filter = [{
+      esQuery.body.query.bool.filter.push({
         terms: {
           projectId: criteria.projectIds
         }
-      }]
+      })
+    }
+    // if criteria contains jobIds, filter jobIds with this value
+    if (criteria.jobIds && criteria.jobIds.length > 0) {
+      esQuery.body.query.bool.filter.push({
+        terms: {
+          _id: criteria.jobIds
+        }
+      })
     }
     logger.debug({ component: 'JobService', context: 'searchJobs', message: `Query: ${JSON.stringify(esQuery)}` })
 
@@ -422,7 +431,7 @@ async function searchJobs (currentUser, criteria, options = { returnAll: false }
     logger.logFullError(err, { component: 'JobService', context: 'searchJobs' })
   }
   logger.info({ component: 'JobService', context: 'searchJobs', message: 'fallback to DB query' })
-  const filter = {}
+  const filter = { [Op.and]: [] }
   _.each(_.pick(criteria, [
     'projectId',
     'externalId',
@@ -449,6 +458,9 @@ async function searchJobs (currentUser, criteria, options = { returnAll: false }
       [Op.contains]: [criteria.skills]
     }
   }
+  if (criteria.jobIds && criteria.jobIds.length > 0) {
+    filter[Op.and].push({ id: criteria.jobIds })
+  }
   const jobs = await Job.findAll({
     where: filter,
     offset: ((page - 1) * perPage),
@@ -486,7 +498,8 @@ searchJobs.schema = Joi.object().keys({
     rateType: Joi.rateType(),
     workload: Joi.workload(),
     status: Joi.jobStatus(),
-    projectIds: Joi.array().items(Joi.number().integer()).single()
+    projectIds: Joi.array().items(Joi.number().integer()).single(),
+    jobIds: Joi.array().items(Joi.string().uuid())
   }).required(),
   options: Joi.object()
 }).required()