Add cancel user to Job object

Maurice Yap · GitHub Enterprise · commit a61472082958 · 2025-02-17T10:39:17.000Z
This adds the user who cancelled a job to the job object, along with a new column in the Lookout DB.
diff --git a/internal/lookoutui/src/models/lookoutModels.tsx b/internal/lookoutui/src/models/lookoutModels.tsx
@@ -122,6 +122,7 @@ export type Job = {
   lastActiveRunId?: string
   lastTransitionTime: string
   cancelReason?: string
+  cancelUser?: string
   node?: string
   cluster?: string
   exitCode?: number
diff --git a/internal/lookoutv2/conversions/convert.go b/internal/lookoutv2/conversions/convert.go
@@ -37,6 +37,7 @@ func ToSwaggerJob(job *model.Job) *models.Job {
 		State:              job.State,
 		Submitted:          strfmt.DateTime(job.Submitted),
 		CancelReason:       job.CancelReason,
+		CancelUser:         job.CancelUser,
 		Node:               job.Node,
 		Cluster:            job.Cluster,
 		ExitCode:           job.ExitCode,
diff --git a/internal/lookoutv2/gen/models/job.go b/internal/lookoutv2/gen/models/job.go
diff --git a/internal/lookoutv2/gen/restapi/embedded_spec.go b/internal/lookoutv2/gen/restapi/embedded_spec.go
diff --git a/internal/lookoutv2/model/model.go b/internal/lookoutv2/model/model.go
@@ -40,6 +40,7 @@ type Job struct {
 	State              string
 	Submitted          time.Time
 	CancelReason       *string
+	CancelUser         *string
 	Node               *string
 	Cluster            string
 	ExitCode           *int32
diff --git a/internal/lookoutv2/repository/getjobs.go b/internal/lookoutv2/repository/getjobs.go
@@ -47,6 +47,7 @@ type jobRow struct {
 	priorityClass      sql.NullString
 	latestRunId        sql.NullString
 	cancelReason       sql.NullString
+	cancelUser         sql.NullString
 }
 
 func NewSqlGetJobsRepository(db *pgxpool.Pool) *SqlGetJobsRepository {
@@ -102,6 +103,7 @@ func (r *SqlGetJobsRepository) getJobs(ctx *armadacontext.Context, filters []*mo
 			&row.priorityClass,
 			&row.latestRunId,
 			&row.cancelReason,
+			&row.cancelUser,
 			&annotations,
 			&runs,
 		); err != nil {
@@ -170,5 +172,6 @@ func jobRowToModel(row *jobRow) *model.Job {
 		State:              string(lookout.JobStateMap[row.state]),
 		Submitted:          row.submitted,
 		CancelReason:       database.ParseNullString(row.cancelReason),
+		CancelUser:         database.ParseNullString(row.cancelUser),
 	}
 }
diff --git a/internal/lookoutv2/repository/getjobs_test.go b/internal/lookoutv2/repository/getjobs_test.go
@@ -24,13 +24,14 @@ import (
 )
 
 const (
-	jobId     = "01f3j0g1md4qx7z5qb148qnh4d"
-	queue     = "queue-1"
-	jobSet    = "job-set-1"
-	cluster   = "cluster-1"
-	owner     = "user-1"
-	namespace = "namespace-1"
-	priority  = 12
+	jobId      = "01f3j0g1md4qx7z5qb148qnh4d"
+	queue      = "queue-1"
+	jobSet     = "job-set-1"
+	cluster    = "cluster-1"
+	owner      = "user-1"
+	cancelUser = "canceluser"
+	namespace  = "namespace-1"
+	priority   = 12
 
 	userAnnotationPrefix = "armadaproject.io/"
 )
@@ -1978,13 +1979,13 @@ func TestGetJobsActiveJobSet(t *testing.T) {
 
 		inactiveJobSet1 := NewJobSimulatorWithClock(converter, store, testClock).
 			Submit("queue-1", "job-set-1", owner, namespace, baseTime, &JobOptions{}).
-			Cancelled(baseTime.Add(1 * time.Minute)).
+			Cancelled(baseTime.Add(1*time.Minute), cancelUser).
 			Build().
 			Job()
 
 		NewJobSimulatorWithClock(converter, store, testClock).
 			Submit("queue-2", "job-set-2", owner, namespace, baseTime, &JobOptions{}).
-			Cancelled(baseTime.Add(1 * time.Minute)).
+			Cancelled(baseTime.Add(1*time.Minute), cancelUser).
 			Build().
 			Job()
 
diff --git a/internal/lookoutv2/repository/querybuilder.go b/internal/lookoutv2/repository/querybuilder.go
@@ -108,6 +108,7 @@ func (qb *QueryBuilder) GetJobs(
 	selected_jobs.priority_class,
 	selected_jobs.latest_run_id,
 	selected_jobs.cancel_reason,
+	selected_jobs.cancel_user,
 	selected_jobs.annotations,
 	selected_runs.runs
 FROM (
diff --git a/internal/lookoutv2/schema/migrations/015_add_cancel_user.sql b/internal/lookoutv2/schema/migrations/015_add_cancel_user.sql
@@ -0,0 +1 @@
+ALTER TABLE job ADD COLUMN cancel_user varchar(512) NULL;
diff --git a/internal/lookoutv2/swagger.yaml b/internal/lookoutv2/swagger.yaml
@@ -1,5 +1,5 @@
 ---
-swagger: '2.0'
+swagger: "2.0"
 info:
   version: 2.0.0
   title: Lookout v2 API
@@ -116,6 +116,9 @@ definitions:
       cancelReason:
         type: string
         x-nullable: true
+      cancelUser:
+        type: string
+        x-nullable: true
       node:
         type: string
         x-nullable: true
diff --git a/internal/server/queryapi/database/models.go b/internal/server/queryapi/database/models.go
diff --git a/internal/server/queryapi/database/query.sql b/internal/server/queryapi/database/query.sql
@@ -2,7 +2,7 @@
 SELECT job_id, state FROM job WHERE job_id = ANY(sqlc.arg(job_ids)::text[]);
 
 -- name: GetJobDetails :many
-SELECT j.job_id, j.queue, j.jobset, j.namespace, j.state, j.submitted, j.cancelled, j.cancel_reason, j.last_transition_time, j.latest_run_id, COALESCE(js.job_spec, j.job_spec) FROM job j left join job_spec js on j.job_id = js.job_id WHERE j.job_id = ANY(sqlc.arg(job_ids)::text[]);
+SELECT j.job_id, j.queue, j.jobset, j.namespace, j.state, j.submitted, j.cancelled, j.cancel_reason, j.cancel_user, j.last_transition_time, j.latest_run_id, COALESCE(js.job_spec, j.job_spec) FROM job j left join job_spec js on j.job_id = js.job_id WHERE j.job_id = ANY(sqlc.arg(job_ids)::text[]);
 
 -- name: GetJobRunsByRunIds :many
 SELECT * FROM job_run WHERE run_id = ANY(sqlc.arg(run_ids)::text[]);
diff --git a/internal/server/queryapi/database/query.sql.go b/internal/server/queryapi/database/query.sql.go
diff --git a/internal/server/queryapi/query_api.go b/internal/server/queryapi/query_api.go
@@ -98,6 +98,7 @@ func (q *QueryApi) GetJobDetails(ctx context.Context, req *api.JobDetailsRequest
 				SubmittedTs:      DbTimeToTimestamp(row.Submitted),
 				CancelTs:         DbTimeToTimestamp(row.Cancelled),
 				CancelReason:     NilStringToString(row.CancelReason),
+				CancelUser:       NilStringToString(row.CancelUser),
 				LastTransitionTs: DbTimeToTimestamp(row.LastTransitionTime),
 				LatestRunId:      NilStringToString(row.LatestRunID),
 				JobSpec:          jobSpec,
diff --git a/internal/server/queryapi/query_api_test.go b/internal/server/queryapi/query_api_test.go
@@ -436,6 +436,7 @@ func newJob(jobId string, state int16, latestRunId string) database.Job {
 		PriorityClass:             nil,
 		LatestRunID:               pointer.String(latestRunId),
 		CancelReason:              nil,
+		CancelUser:                nil,
 		Namespace:                 pointer.String("testNamespace"),
 		Annotations:               annotations,
 		ExternalJobUri:            pointer.String("external-job-uri"),
@@ -482,6 +483,7 @@ func newJobDetails(jobId string, state api.JobState, latestRunId string, runs ..
 		SubmittedTs:      baseTimestamp,
 		CancelTs:         nil,
 		CancelReason:     "",
+		CancelUser:       "",
 		LastTransitionTs: baseTimestamp,
 		LatestRunId:      latestRunId,
 		JobSpec:          nil,
diff --git a/pkg/api/api.swagger.go b/pkg/api/api.swagger.go
@@ -1022,6 +1022,9 @@ func SwaggerJsonTemplate() string {
 		"          \"type\": \"string\",\n" +
 		"          \"format\": \"date-time\"\n" +
 		"        },\n" +
+		"        \"cancelUser\": {\n" +
+		"          \"type\": \"string\"\n" +
+		"        },\n" +
 		"        \"jobId\": {\n" +
 		"          \"type\": \"string\"\n" +
 		"        },\n" +
diff --git a/pkg/api/api.swagger.json b/pkg/api/api.swagger.json
@@ -1011,6 +1011,9 @@
           "type": "string",
           "format": "date-time"
         },
+        "cancelUser": {
+          "type": "string"
+        },
         "jobId": {
           "type": "string"
         },
diff --git a/pkg/api/job.pb.go b/pkg/api/job.pb.go
diff --git a/pkg/api/job.proto b/pkg/api/job.proto

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE job ADD COLUMN cancel_user varchar(512) NULL;`