Support sorting by completionTime

src/rest-server/docs/swagger.yaml

@@ -14,6 +14,7 @@ info:
     Version 2.2.1: a user can add/delete tags to/from his/her own jobs
     version 2.2.2: add get task logs api
     version 2.2.3: set .jobStatus.appId nullable in get jobAttempt schema
+    version 2.2.4: support sorting by completionTime in get the list of jobs
   license:
     name: MIT License
     url: "https://github.com/microsoft/pai/blob/master/LICENSE"
@@ -1158,7 +1159,10 @@ paths:
             type: number
         - name: order
           in: query
-          description: 'order of job list. It follows the format <field>,<ASC|DESC>, default value is "submissionTime,DESC". Available fields include: jobName, submissionTime, username, vc, retries, totalTaskNumber, totalGpuNumber, state'
+          description: 'order of job list.
+          It follows the format <field>,<ASC|DESC>, default value is "submissionTime,DESC".
+          Available fields include: jobName, submissionTime, username, vc, retries, totalTaskNumber, totalGpuNumber, state, completionTime.
+          CompletionTime maybe null for some jobs, these jobs will be returned at the end of the list when sorting by ASC order & at the beginning when sorting by DESC order.'
           schema:
             type: string
         - name: withTotalCount

src/rest-server/src/controllers/v2/job.js

@@ -93,6 +93,7 @@ const list = asyncHandler(async (req, res) => {
           'totalTaskNumber',
           'totalGpuNumber',
           'state',
+          'completionTime',
         ].includes(field)
       ) {
         if (ordering === 'ASC' || ordering === 'DESC') {
@@ -101,6 +102,10 @@ const list = asyncHandler(async (req, res) => {
             order.push(['userName', ordering]);
           } else if (field === 'vc') {
             order.push(['virtualCluster', ordering]);
+          } else if (field === 'completionTime') {
+            const orderingWithNulls =
+              ordering === 'ASC' ? 'ASC NULLS LAST' : 'DESC NULLS FIRST';
+            order.push(['completionTime', orderingWithNulls]);
           } else {
             order.push([field, ordering]);
           }