Merge branch 'main' into eng-291-improve-startup-time-by-optimizing-i…

…mds-access

pkg/orchestrator/endpoint.go

@@ -110,7 +110,18 @@ func (e *BaseEndpoint) SubmitJob(ctx context.Context, request *SubmitJobRequest)
 }
 
 func (e *BaseEndpoint) StopJob(ctx context.Context, request *StopJobRequest) (StopJobResponse, error) {
-	job, err := e.store.GetJob(ctx, request.JobID)
+	txContext, err := e.store.BeginTx(ctx)
+	if err != nil {
+		return StopJobResponse{}, jobstore.NewJobStoreError(err.Error())
+	}
+
+	defer func() {
+		if err != nil {
+			_ = txContext.Rollback()
+		}
+	}()
+
+	job, err := e.store.GetJob(txContext, request.JobID)
 	if err != nil {
 		return StopJobResponse{}, err
 	}
@@ -124,21 +135,10 @@ func (e *BaseEndpoint) StopJob(ctx context.Context, request *StopJobRequest) (St
 		// continue
 	}
 
-	txContext, err := e.store.BeginTx(ctx)
-	if err != nil {
-		return StopJobResponse{}, jobstore.NewJobStoreError(err.Error())
-	}
-
-	defer func() {
-		if err != nil {
-			_ = txContext.Rollback()
-		}
-	}()
-
 	// update the job state, except if the job is already completed
 	// we allow marking a failed job as canceled
 	if err = e.store.UpdateJobState(txContext, jobstore.UpdateJobStateRequest{
-		JobID: request.JobID,
+		JobID: job.ID, // use the job ID from the store in case the request had a short ID
 		Condition: jobstore.UpdateJobCondition{
 			UnexpectedStates: []models.JobStateType{
 				models.JobStateTypeCompleted,
@@ -161,7 +161,7 @@ func (e *BaseEndpoint) StopJob(ctx context.Context, request *StopJobRequest) (St
 		now := time.Now().UTC().UnixNano()
 		eval := &models.Evaluation{
 			ID:          uuid.NewString(),
-			JobID:       request.JobID,
+			JobID:       job.ID,
 			TriggeredBy: models.EvalTriggerJobCancel,
 			Type:        job.Type,
 			Status:      models.EvalStatusPending,

pkg/publicapi/apimodels/error.go

@@ -45,13 +45,20 @@ type APIError struct {
 
 	// Component is the component that caused the error.
 	Component string `json:"Component"`
+
+	// Hint is a string providing additional context or suggestions related to the error.
+	Hint string `json:"Hint,omitempty"`
+
+	// Details is a map of string key-value pairs providing additional error context.
+	Details map[string]string `json:"Details,omitempty"`
 }
 
 // NewAPIError creates a new APIError with the given HTTP status code and message.
 func NewAPIError(statusCode int, message string) *APIError {
 	return &APIError{
 		HTTPStatusCode: statusCode,
 		Message:        message,
+		Details:        make(map[string]string),
 	}
 }
 
@@ -106,14 +113,22 @@ func FromBacError(err bacerrors.Error) *APIError {
 		Message:        err.Error(),
 		Code:           string(err.Code()),
 		Component:      err.Component(),
+		Hint:           err.Hint(),
+		Details:        err.Details(),
 	}
 }
 
 // ToBacError converts an APIError to a bacerror.Error
 func (e *APIError) ToBacError() bacerrors.Error {
+	details := e.Details
+	if details == nil {
+		details = make(map[string]string)
+	}
+	details["request_id"] = e.RequestID
 	return bacerrors.New(e.Error()).
 		WithHTTPStatusCode(e.HTTPStatusCode).
 		WithCode(bacerrors.Code(e.Code)).
 		WithComponent(e.Component).
-		WithDetails(map[string]string{"request_id": e.RequestID})
+		WithHint(e.Hint).
+		WithDetails(details)
 }