Skip to content

Improved error management for jobs controller #486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SivaParvathi3112 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Improved error management for jobs controller #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a51b44a
feat:Improved error management for jobs controller.
SivaParvathi3112 Apr 20, 2026
9318390
feat: Modified jobManager function signature in catalog,catalog_mana…
SivaParvathi3112 May 4, 2026
e51bab9
feat:Changed GetUser func with diagnostics.
SivaParvathi3112 May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/basecontext/api_context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ import (
"context"

"github.com/Parallels/prl-devops-service/models"
"github.com/Parallels/prl-devops-service/errors"
log "github.com/cjlapao/common-go-logger"
)

type ApiContext interface {
Context() context.Context
GetAuthorizationContext() *AuthorizationContext
GetRequestId() string
GetUser() *models.ApiUser
GetUser(diag *errors.Diagnostics) *models.ApiUser
Verbose() bool
EnableLog()
DisableLog()
Expand Down
9 changes: 7 additions & 2 deletions src/basecontext/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"net/http"

"github.com/Parallels/prl-devops-service/constants"
"github.com/Parallels/prl-devops-service/errors"
"github.com/Parallels/prl-devops-service/models"
log "github.com/cjlapao/common-go-logger"
)
Expand Down Expand Up @@ -98,11 +99,15 @@ func (c *BaseContext) GetRequestId() string {
return id.(string)
}

func (c *BaseContext) GetUser() *models.ApiUser {
if c.authContext != nil {
func (c *BaseContext) GetUser(diag *errors.Diagnostics) *models.ApiUser {
if c.authContext != nil && c.authContext.User != nil {
return c.authContext.User
}

if diag != nil {
diag.AddError("401", "User not found or session expired", "GetUser")
}

return nil
}

Expand Down
3 changes: 2 additions & 1 deletion src/basecontext/test/mock_base_context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"strings"

"github.com/Parallels/prl-devops-service/basecontext"
"github.com/Parallels/prl-devops-service/errors"
"github.com/Parallels/prl-devops-service/models"
log "github.com/cjlapao/common-go-logger"
)
Expand Down Expand Up @@ -69,7 +70,7 @@ func (m *MockBaseContext) GetRequestId() string {
return m.MockRequestID
}

func (m *MockBaseContext) GetUser() *models.ApiUser {
func (m *MockBaseContext) GetUser(diag *errors.Diagnostics) *models.ApiUser {
if m.callbackFunctions["GetUser"] != nil {
m.callbackFunctions["GetUser"]()
}
Expand Down
55 changes: 29 additions & 26 deletions src/controllers/catalog.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (
"github.com/Parallels/prl-devops-service/config"
"github.com/Parallels/prl-devops-service/constants"
data_models "github.com/Parallels/prl-devops-service/data/models"
prlerrors "github.com/Parallels/prl-devops-service/errors"
"github.com/Parallels/prl-devops-service/helpers"
"github.com/Parallels/prl-devops-service/jobs"
"github.com/Parallels/prl-devops-service/mappers"
Expand Down Expand Up @@ -1883,6 +1884,7 @@ func PushCatalogManifestHandler() restapi.ControllerHandler {
defer r.Body.Close()
ctx := GetBaseContext(r)
defer Recover(ctx, r, w)
pushCatalogManifestDiag := prlerrors.NewDiagnostics("/v1/catalog/push")
var request catalog_models.PushCatalogManifestRequest
if err := http_helper.MapRequestBody(r, &request); err != nil {
ReturnApiError(ctx, w, models.ApiErrorResponse{
Expand Down Expand Up @@ -1911,9 +1913,9 @@ func PushCatalogManifestHandler() restapi.ControllerHandler {
return
}

userContext := ctx.GetUser()
if userContext == nil {
ReturnApiError(ctx, w, models.ApiErrorResponse{Code: http.StatusUnauthorized, Message: "User not found"})
userContext := ctx.GetUser(pushCatalogManifestDiag)
if pushCatalogManifestDiag.HasErrors() {
ReturnApiErrorWithDiagnostics(ctx, w, models.NewDiagnosticsWithCode(pushCatalogManifestDiag, http.StatusUnauthorized))
return
}

Expand All @@ -1923,9 +1925,9 @@ func PushCatalogManifestHandler() restapi.ControllerHandler {
return
}

job, err := jobManager.CreateNewJob(userContext.ID, "catalog", "push", "Initializing catalog push")
if err != nil {
ReturnApiError(ctx, w, models.NewFromErrorWithCode(err, http.StatusInternalServerError))
job := jobManager.CreateNewJob(userContext.ID, "catalog", "push", "Initializing catalog push", pushCatalogManifestDiag)
if pushCatalogManifestDiag.HasErrors() {
ReturnApiErrorWithDiagnostics(ctx, w, models.NewDiagnosticsWithCode(pushCatalogManifestDiag, http.StatusInternalServerError))
return
}

Expand Down Expand Up @@ -1994,10 +1996,10 @@ func AsyncPushCatalogManifestHandler() restapi.ControllerHandler {
defer r.Body.Close()
ctx := GetBaseContext(r)
defer Recover(ctx, r, w)

userContext := ctx.GetUser()
if userContext == nil {
ReturnApiError(ctx, w, models.ApiErrorResponse{Code: http.StatusUnauthorized, Message: "User not found"})
asyncPushCatalogManifestDiag := prlerrors.NewDiagnostics("/v1/catalog/push/async")
userContext := ctx.GetUser(asyncPushCatalogManifestDiag)
if asyncPushCatalogManifestDiag.HasErrors() {
ReturnApiErrorWithDiagnostics(ctx, w, models.NewDiagnosticsWithCode(asyncPushCatalogManifestDiag, http.StatusUnauthorized))
return
}

Expand Down Expand Up @@ -2035,9 +2037,9 @@ func AsyncPushCatalogManifestHandler() restapi.ControllerHandler {
return
}

job, err := jobManager.CreateNewJob(userContext.ID, "catalog", "push", "Initializing catalog push")
if err != nil {
ReturnApiError(ctx, w, models.NewFromErrorWithCode(err, http.StatusInternalServerError))
job := jobManager.CreateNewJob(userContext.ID, "catalog", "push", "Initializing catalog push", asyncPushCatalogManifestDiag)
if asyncPushCatalogManifestDiag.HasErrors() {
ReturnApiErrorWithDiagnostics(ctx, w, models.NewDiagnosticsWithCode(asyncPushCatalogManifestDiag, http.StatusInternalServerError))
return
}

Expand Down Expand Up @@ -2069,6 +2071,7 @@ func PullCatalogManifestHandler() restapi.ControllerHandler {
defer r.Body.Close()
ctx := GetBaseContext(r)
defer Recover(ctx, r, w)
pullCatalogManifestDiag := prlerrors.NewDiagnostics("/v1/catalog/pull")
var request catalog_models.PullCatalogManifestRequest
if err := http_helper.MapRequestBody(r, &request); err != nil {
ReturnApiError(ctx, w, models.ApiErrorResponse{
Expand Down Expand Up @@ -2136,9 +2139,9 @@ func PullCatalogManifestHandler() restapi.ControllerHandler {
}
}

userContext := ctx.GetUser()
if userContext == nil {
ReturnApiError(ctx, w, models.ApiErrorResponse{Code: http.StatusUnauthorized, Message: "User not found"})
userContext := ctx.GetUser(pullCatalogManifestDiag)
if pullCatalogManifestDiag.HasErrors() {
ReturnApiErrorWithDiagnostics(ctx, w, models.NewDiagnosticsWithCode(pullCatalogManifestDiag, http.StatusUnauthorized))
return
}

Expand All @@ -2148,9 +2151,9 @@ func PullCatalogManifestHandler() restapi.ControllerHandler {
return
}

job, err := jobManager.CreateNewJob(userContext.ID, "catalog", "pull", "Initializing repository pull")
if err != nil {
ReturnApiError(ctx, w, models.NewFromErrorWithCode(err, http.StatusInternalServerError))
job := jobManager.CreateNewJob(userContext.ID, "catalog", "pull", "Initializing repository pull", pullCatalogManifestDiag)
if pullCatalogManifestDiag.HasErrors() {
ReturnApiErrorWithDiagnostics(ctx, w, models.NewDiagnosticsWithCode(pullCatalogManifestDiag, http.StatusInternalServerError))
return
}

Expand Down Expand Up @@ -2207,10 +2210,10 @@ func AsyncPullCatalogManifestHandler() restapi.ControllerHandler {
defer r.Body.Close()
ctx := GetBaseContext(r)
defer Recover(ctx, r, w)

userContext := ctx.GetUser()
if userContext == nil {
ReturnApiError(ctx, w, models.ApiErrorResponse{Code: http.StatusUnauthorized, Message: "User not found"})
asyncPullCatalogManifestDiag := prlerrors.NewDiagnostics("/v1/catalog/pull/async")
userContext := ctx.GetUser(asyncPullCatalogManifestDiag)
if asyncPullCatalogManifestDiag.HasErrors() {
ReturnApiErrorWithDiagnostics(ctx, w, models.NewDiagnosticsWithCode(asyncPullCatalogManifestDiag, http.StatusUnauthorized))
return
}

Expand Down Expand Up @@ -2258,9 +2261,9 @@ func AsyncPullCatalogManifestHandler() restapi.ControllerHandler {
return
}

job, err := jobManager.CreateNewJob(userContext.ID, "catalog", "pull", "Initializing repository pull")
if err != nil {
ReturnApiError(ctx, w, models.NewFromErrorWithCode(err, http.StatusInternalServerError))
job := jobManager.CreateNewJob(userContext.ID, "catalog", "pull", "Initializing repository pull", asyncPullCatalogManifestDiag)
if asyncPullCatalogManifestDiag.HasErrors() {
ReturnApiErrorWithDiagnostics(ctx, w, models.NewDiagnosticsWithCode(asyncPullCatalogManifestDiag, http.StatusInternalServerError))
return
}

Expand Down
29 changes: 15 additions & 14 deletions src/controllers/catalog_managers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"github.com/Parallels/prl-devops-service/config"
"github.com/Parallels/prl-devops-service/constants"
data_models "github.com/Parallels/prl-devops-service/data/models"
prlerrors "github.com/Parallels/prl-devops-service/errors"
"github.com/Parallels/prl-devops-service/helpers"
"github.com/Parallels/prl-devops-service/jobs"
"github.com/Parallels/prl-devops-service/mappers"
Expand Down Expand Up @@ -378,7 +379,7 @@ func GetCatalogManagersHandler() restapi.ControllerHandler {
return
}

user := ctx.GetUser()
user := ctx.GetUser(nil)
if user == nil {
ReturnApiError(ctx, w, models.NewFromErrorWithCode(errors.New("User not contextually found"), http.StatusUnauthorized))
return
Expand Down Expand Up @@ -475,7 +476,7 @@ func GetCatalogManagerByIdHandler() restapi.ControllerHandler {
vars := mux.Vars(r)
id := vars["id"]

user := ctx.GetUser()
user := ctx.GetUser(nil)
if user == nil {
ReturnApiError(ctx, w, models.NewFromErrorWithCode(errors.New("User not contextually found"), http.StatusUnauthorized))
return
Expand Down Expand Up @@ -556,7 +557,7 @@ func CreateCatalogManagerHandler() restapi.ControllerHandler {
}
defer r.Body.Close()

user := ctx.GetUser()
user := ctx.GetUser(nil)

newMgr := mappers.FromCatalogManagerRequest(&req)
newMgr.OwnerID = user.ID
Expand Down Expand Up @@ -642,7 +643,7 @@ func UpdateCatalogManagerHandler() restapi.ControllerHandler {
return
}

user := ctx.GetUser()
user := ctx.GetUser(nil)
authCtxUpdate := ctx.GetAuthorizationContext()
effectiveClaimsUpdate := authCtxUpdate.GetEffectiveClaims()
effectiveRolesUpdate := authCtxUpdate.GetEffectiveRoles()
Expand Down Expand Up @@ -721,7 +722,7 @@ func DeleteCatalogManagerHandler() restapi.ControllerHandler {
return
}

user := ctx.GetUser()
user := ctx.GetUser(nil)
authCtxDelete := ctx.GetAuthorizationContext()
effectiveClaimsDelete := authCtxDelete.GetEffectiveClaims()
effectiveRolesDelete := authCtxDelete.GetEffectiveRoles()
Expand Down Expand Up @@ -766,10 +767,10 @@ func AsyncPushCatalogManifestToCatalogManagerHandler() restapi.ControllerHandler
defer r.Body.Close()
ctx := GetBaseContext(r)
defer Recover(ctx, r, w)

userContext := ctx.GetUser()
if userContext == nil {
ReturnApiError(ctx, w, models.ApiErrorResponse{Code: http.StatusUnauthorized, Message: "User not found"})
asyncPushCatalogManifestDiag := prlerrors.NewDiagnostics("AsyncPushCatalogManifestToCatalogManagerHandler")
userContext := ctx.GetUser(asyncPushCatalogManifestDiag)
if asyncPushCatalogManifestDiag.HasErrors() {
ReturnApiErrorWithDiagnostics(ctx, w, models.NewDiagnosticsWithCode(asyncPushCatalogManifestDiag, http.StatusUnauthorized))
return
}

Expand Down Expand Up @@ -833,9 +834,9 @@ func AsyncPushCatalogManifestToCatalogManagerHandler() restapi.ControllerHandler
return
}

localJob, err := jobManager.CreateNewJob(userContext.ID, "catalog", "push", "Initializing catalog push to manager "+mgr.Name)
if err != nil {
ReturnApiError(ctx, w, models.NewFromErrorWithCode(err, http.StatusInternalServerError))
localJob := jobManager.CreateNewJob(userContext.ID, "catalog", "push", "Initializing catalog push to manager "+mgr.Name, asyncPushCatalogManifestDiag)
if asyncPushCatalogManifestDiag.HasErrors() {
ReturnApiErrorWithDiagnostics(ctx, w, models.NewDiagnosticsWithCode(asyncPushCatalogManifestDiag, http.StatusInternalServerError))
return
}

Expand Down Expand Up @@ -936,7 +937,7 @@ func getAuthorizedCatalogManagerForUse(ctx basecontext.ApiContext, managerID str
return nil, &apiErr
}

user := ctx.GetUser()
user := ctx.GetUser(nil)
if user == nil {
apiErr := models.NewFromErrorWithCode(errors.New("User not contextually found"), http.StatusUnauthorized)
return nil, &apiErr
Expand Down Expand Up @@ -1298,7 +1299,7 @@ func forwardCatalogManagerRequest(ctx basecontext.ApiContext, w http.ResponseWri
// Inject the current user's effective claims and roles so the downstream
// catalog service can filter results using the calling user's permissions
// rather than the stored catalog-manager credentials.
if fwdUser := ctx.GetUser(); fwdUser != nil {
if fwdUser := ctx.GetUser(nil); fwdUser != nil {
fwdAuthCtx := ctx.GetAuthorizationContext()
claims := fwdAuthCtx.GetEffectiveClaims()
roles := fwdAuthCtx.GetEffectiveRoles()
Expand Down
7 changes: 5 additions & 2 deletions src/controllers/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ import (
// orchestrator-to-host calls, there is no user account on the target, so
// "system" is used as a fallback owner. Returns ("", false) when the request
// is not authenticated at all.
func getEffectiveCallerID(ctx *basecontext.BaseContext) (string, bool) {
if user := ctx.GetUser(); user != nil {
func getEffectiveCallerID(ctx *basecontext.BaseContext, diag *errors.Diagnostics) (string, bool) {
if user := ctx.GetUser(nil); user != nil {
return user.ID, true
}
authCtx := ctx.GetAuthorizationContext()
Expand All @@ -35,6 +35,9 @@ func getEffectiveCallerID(ctx *basecontext.BaseContext) (string, bool) {
return currentUser, true
}

if diag != nil {
diag.AddError("401", "Caller identity not found", "getEffectiveCallerID")
}
return "", false
}

Expand Down
Loading
Loading