Skip to content

refactor: Adopt the common.SetupHandler for more handlers #231

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

Merged
chet merged 2 commits into from
Mar 11, 2026
Merged

refactor: Adopt the common.SetupHandler for more handlers #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d26e824
refactor: Adopt the common.SetupHandler for all handlers
chet Mar 11, 2026
9abd66a
Correct handler name in SetupHandler for GetAuditEntry
thossain-nv Mar 11, 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
118 changes: 10 additions & 108 deletions api/pkg/api/handler/allocation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import (

validation "github.com/go-ozzo/ozzo-validation/v4"
"github.com/google/uuid"
"github.com/rs/zerolog/log"

"github.com/labstack/echo/v4"

Expand Down Expand Up @@ -86,30 +85,11 @@ func NewCreateAllocationHandler(dbSession *cdb.Session, tc temporalClient.Client
// @Success 201 {object} model.APIAllocation
// @Router /v2/org/{org}/carbide/allocation [post]
func (cah CreateAllocationHandler) Handle(c echo.Context) error {
// Get context
ctx := c.Request().Context()

// Get org
org := c.Param("orgName")

// Initialize logger
logger := log.With().Str("Model", "Allocation").Str("Handler", "Create").Str("Org", org).Logger()

logger.Info().Msg("started API handler")

// Create a child span and set the attributes for current request
newctx, handlerSpan := cah.tracerSpan.CreateChildInContext(ctx, "CreateAllocationHandler", logger)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Allocation", "Create", c, cah.tracerSpan)
if handlerSpan != nil {
// Set newly created span context as a current context
ctx = newctx

defer handlerSpan.End()

cah.tracerSpan.SetAttribute(handlerSpan, attribute.String("org", org), logger)
}

dbUser, logger, err := common.GetUserAndEnrichLogger(c, logger, cah.tracerSpan, handlerSpan)
if err != nil {
if dbUser == nil {
return cutil.NewAPIErrorResponse(c, http.StatusInternalServerError, "Failed to retrieve current user", nil)
}

Expand Down Expand Up @@ -538,30 +518,11 @@ func NewGetAllAllocationHandler(dbSession *cdb.Session, tc temporalClient.Client
// @Success 200 {object} []model.APIAllocation
// @Router /v2/org/{org}/carbide/allocation [get]
func (gaah GetAllAllocationHandler) Handle(c echo.Context) error {
// Get context
ctx := c.Request().Context()

// Get org
org := c.Param("orgName")

// Initialize logger
logger := log.With().Str("Model", "Allocation").Str("Handler", "GetAll").Str("Org", org).Logger()

logger.Info().Msg("started API handler")

// Create a child span and set the attributes for current request
newctx, handlerSpan := gaah.tracerSpan.CreateChildInContext(ctx, "GetAllAllocationHandler", logger)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Allocation", "GetAll", c, gaah.tracerSpan)
if handlerSpan != nil {
// Set newly created span context as a current context
ctx = newctx

defer handlerSpan.End()

gaah.tracerSpan.SetAttribute(handlerSpan, attribute.String("org", org), logger)
}

dbUser, logger, err := common.GetUserAndEnrichLogger(c, logger, gaah.tracerSpan, handlerSpan)
if err != nil {
if dbUser == nil {
return cutil.NewAPIErrorResponse(c, http.StatusInternalServerError, "Failed to retrieve current user", nil)
}

Expand Down Expand Up @@ -906,30 +867,11 @@ func NewGetAllocationHandler(dbSession *cdb.Session, tc temporalClient.Client, c
// @Success 200 {object} model.APIAllocation
// @Router /v2/org/{org}/carbide/allocation/{id} [get]
func (gah GetAllocationHandler) Handle(c echo.Context) error {
// Get context
ctx := c.Request().Context()

// Get org
org := c.Param("orgName")

// Initialize logger
logger := log.With().Str("Model", "Allocation").Str("Handler", "Get").Str("Org", org).Logger()

logger.Info().Msg("started API handler")

// Create a child span and set the attributes for current request
newctx, handlerSpan := gah.tracerSpan.CreateChildInContext(ctx, "GetAllocationHandler", logger)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Allocation", "Get", c, gah.tracerSpan)
if handlerSpan != nil {
// Set newly created span context as a current context
ctx = newctx

defer handlerSpan.End()

gah.tracerSpan.SetAttribute(handlerSpan, attribute.String("org", org), logger)
}

dbUser, logger, err := common.GetUserAndEnrichLogger(c, logger, gah.tracerSpan, handlerSpan)
if err != nil {
if dbUser == nil {
return cutil.NewAPIErrorResponse(c, http.StatusInternalServerError, "Failed to retrieve current user", nil)
}

Expand Down Expand Up @@ -1123,30 +1065,11 @@ func NewUpdateAllocationHandler(dbSession *cdb.Session, tc temporalClient.Client
// @Success 200 {object} model.APIAllocation
// @Router /v2/org/{org}/carbide/allocation/{id} [patch]
func (uah UpdateAllocationHandler) Handle(c echo.Context) error {
// Get context
ctx := c.Request().Context()

// Get org
org := c.Param("orgName")

// Initialize logger
logger := log.With().Str("Model", "Allocation").Str("Handler", "Update").Str("Org", org).Logger()

logger.Info().Msg("started API handler")

// Create a child span and set the attributes for current request
newctx, handlerSpan := uah.tracerSpan.CreateChildInContext(ctx, "UpdateAllocationHandler", logger)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Allocation", "Update", c, uah.tracerSpan)
if handlerSpan != nil {
// Set newly created span context as a current context
ctx = newctx

defer handlerSpan.End()

uah.tracerSpan.SetAttribute(handlerSpan, attribute.String("org", org), logger)
}

dbUser, logger, err := common.GetUserAndEnrichLogger(c, logger, uah.tracerSpan, handlerSpan)
if err != nil {
if dbUser == nil {
return cutil.NewAPIErrorResponse(c, http.StatusInternalServerError, "Failed to retrieve current user", nil)
}

Expand Down Expand Up @@ -1346,32 +1269,11 @@ func NewDeleteAllocationHandler(dbSession *cdb.Session, tc temporalClient.Client
// @Success 202
// @Router /v2/org/{org}/carbide/allocation/{id} [delete]
func (dah DeleteAllocationHandler) Handle(c echo.Context) error {
// Get context
ctx := c.Request().Context()

// Get org
org := c.Param("orgName")

// Initialize logger
logger := log.With().Str("Model", "Allocation").Str("Handler", "Delete").Str("Org", org).Logger()

logger.Info().Msg("started API handler")

// Create a child spanner and set the attribute
newctx, handlerSpan := dah.tracerSpan.CreateChildInContext(ctx, "DeleteAllocationHandler", logger)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Allocation", "Delete", c, dah.tracerSpan)
if handlerSpan != nil {
// Set newly created span context as a current context
ctx = newctx

defer handlerSpan.End()

// dah.tracerSpan.SetAttribute(handlerSpan, attribute.String("org", org), logger)
dah.tracerSpan.SetAttribute(handlerSpan, attribute.String("org", org), logger)

}

dbUser, logger, err := common.GetUserAndEnrichLogger(c, logger, dah.tracerSpan, handlerSpan)
if err != nil {
if dbUser == nil {
return cutil.NewAPIErrorResponse(c, http.StatusInternalServerError, "Failed to retrieve current user", nil)
}

Expand Down
24 changes: 2 additions & 22 deletions api/pkg/api/handler/allocationconstraint.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import (
temporalClient "go.temporal.io/sdk/client"

"github.com/google/uuid"
"github.com/rs/zerolog/log"

"github.com/labstack/echo/v4"

Expand Down Expand Up @@ -77,30 +76,11 @@ func NewUpdateAllocationConstraintHandler(dbSession *cdb.Session, tc temporalCli
// @Success 200 {object} model.APIAllocationConstraint
// @Router /v2/org/{org}/carbide/allocation/{allocation_id}/constraint/{id} [patch]
func (uach UpdateAllocationConstraintHandler) Handle(c echo.Context) error {
// Get context
ctx := c.Request().Context()

// Get org
org := c.Param("orgName")

// Initialize logger
logger := log.With().Str("Model", "AllocationConstraint").Str("Handler", "Update").Str("Org", org).Logger()

logger.Info().Msg("started API handler")

// Create a child span and set the attributes for current request
newctx, handlerSpan := uach.tracerSpan.CreateChildInContext(ctx, "UpdateAllocationConstraintHandler", logger)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("AllocationConstraint", "Update", c, uach.tracerSpan)
if handlerSpan != nil {
// Set newly created span context as a current context
ctx = newctx

defer handlerSpan.End()

uach.tracerSpan.SetAttribute(handlerSpan, attribute.String("org", org), logger)
}

dbUser, logger, err := common.GetUserAndEnrichLogger(c, logger, uach.tracerSpan, handlerSpan)
if err != nil {
if dbUser == nil {
return cutil.NewAPIErrorResponse(c, http.StatusInternalServerError, "Failed to retrieve current user", nil)
}

Expand Down
47 changes: 4 additions & 43 deletions api/pkg/api/handler/audit_entry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ import (
cdb "github.com/nvidia/bare-metal-manager-rest/db/pkg/db"
cdbm "github.com/nvidia/bare-metal-manager-rest/db/pkg/db/model"
"github.com/nvidia/bare-metal-manager-rest/db/pkg/db/paginator"
"github.com/rs/zerolog/log"
"go.opentelemetry.io/otel/attribute"
)

Expand Down Expand Up @@ -63,30 +62,11 @@ func NewGetAllAuditEntryHandler(dbSession *cdb.Session) GetAllAuditEntryHandler
// @Success 200 {array} []model.APIAuditEntry
// @Router /v2/org/{org}/carbide/audit [get]
func (gaaeh GetAllAuditEntryHandler) Handle(c echo.Context) error {
// Get context
ctx := c.Request().Context()

// Get org
orgName := c.Param("orgName")

// Initialize logger
logger := log.With().Str("Model", "AuditEntry").Str("Handler", "GetAll").Str("Org", orgName).Logger()

logger.Info().Msg("started API handler")

// Create a child span and set the attributes for current request
newctx, handlerSpan := gaaeh.tracerSpan.CreateChildInContext(ctx, "GetAllAuditEntryHandler", logger)
orgName, dbUser, ctx, logger, handlerSpan := common.SetupHandler("AuditEntry", "GetAll", c, gaaeh.tracerSpan)
if handlerSpan != nil {
// Set newly created span context as a current context
ctx = newctx

defer handlerSpan.End()

gaaeh.tracerSpan.SetAttribute(handlerSpan, attribute.String("org", orgName), logger)
}

dbUser, logger, err := common.GetUserAndEnrichLogger(c, logger, gaaeh.tracerSpan, handlerSpan)
if err != nil {
if dbUser == nil {
return cutil.NewAPIErrorResponse(c, http.StatusInternalServerError, "Failed to retrieve current user", nil)
}

Expand Down Expand Up @@ -218,30 +198,11 @@ func NewGetAuditEntryHandler(dbSession *cdb.Session) GetAuditEntryHandler {
// @Success 200 {object} model.APIAuditEntry
// @Router /v2/org/{org}/carbide/audit/{id} [get]
func (gaeh GetAuditEntryHandler) Handle(c echo.Context) error {
// Get context
ctx := c.Request().Context()

// Get org
orgName := c.Param("orgName")

// Initialize logger
logger := log.With().Str("Model", "AuditEntry").Str("Handler", "GetAll").Str("Org", orgName).Logger()

logger.Info().Msg("started API handler")

// Create a child span and set the attributes for current request
newctx, handlerSpan := gaeh.tracerSpan.CreateChildInContext(ctx, "GetAuditEntryHandler", logger)
orgName, dbUser, ctx, logger, handlerSpan := common.SetupHandler("AuditEntry", "Get", c, gaeh.tracerSpan)
if handlerSpan != nil {
// Set newly created span context as a current context
ctx = newctx

defer handlerSpan.End()

gaeh.tracerSpan.SetAttribute(handlerSpan, attribute.String("org", orgName), logger)
}

dbUser, logger, err := common.GetUserAndEnrichLogger(c, logger, gaeh.tracerSpan, handlerSpan)
if err != nil {
if dbUser == nil {
return cutil.NewAPIErrorResponse(c, http.StatusInternalServerError, "Failed to retrieve current user", nil)
}

Expand Down
14 changes: 7 additions & 7 deletions api/pkg/api/handler/expectedmachine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ func NewCreateExpectedMachineHandler(dbSession *cdb.Session, tc tclient.Client,
// @Success 201 {object} model.APIExpectedMachine
// @Router /v2/org/{org}/carbide/expected-machine [post]
func (cemh CreateExpectedMachineHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Create", "ExpectedMachine", c, cemh.tracerSpan)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("ExpectedMachine", "Create", c, cemh.tracerSpan)
if handlerSpan != nil {
defer handlerSpan.End()
}
Expand Down Expand Up @@ -352,7 +352,7 @@ func NewGetAllExpectedMachineHandler(dbSession *cdb.Session, tc tclient.Client,
// @Success 200 {object} []model.APIExpectedMachine
// @Router /v2/org/{org}/carbide/expected-machine [get]
func (gaemh GetAllExpectedMachineHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("GetAll", "ExpectedMachine", c, gaemh.tracerSpan)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("ExpectedMachine", "GetAll", c, gaemh.tracerSpan)
if handlerSpan != nil {
defer handlerSpan.End()
}
Expand Down Expand Up @@ -511,7 +511,7 @@ func NewGetExpectedMachineHandler(dbSession *cdb.Session, tc tclient.Client, cfg
// @Success 200 {object} model.APIExpectedMachine
// @Router /v2/org/{org}/carbide/expected-machine/{id} [get]
func (gemh GetExpectedMachineHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Get", "ExpectedMachine", c, gemh.tracerSpan)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("ExpectedMachine", "Get", c, gemh.tracerSpan)
if handlerSpan != nil {
defer handlerSpan.End()
}
Expand Down Expand Up @@ -617,7 +617,7 @@ func NewUpdateExpectedMachineHandler(dbSession *cdb.Session, tc tclient.Client,
// @Success 200 {object} model.APIExpectedMachine
// @Router /v2/org/{org}/carbide/expected-machine/{id} [patch]
func (uemh UpdateExpectedMachineHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Update", "ExpectedMachine", c, uemh.tracerSpan)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("ExpectedMachine", "Update", c, uemh.tracerSpan)
if handlerSpan != nil {
defer handlerSpan.End()
}
Expand Down Expand Up @@ -837,7 +837,7 @@ func NewDeleteExpectedMachineHandler(dbSession *cdb.Session, tc tclient.Client,
// @Success 204
// @Router /v2/org/{org}/carbide/expected-machine/{id} [delete]
func (demh DeleteExpectedMachineHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("Delete", "ExpectedMachine", c, demh.tracerSpan)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("ExpectedMachine", "Delete", c, demh.tracerSpan)
if handlerSpan != nil {
defer handlerSpan.End()
}
Expand Down Expand Up @@ -982,7 +982,7 @@ func NewCreateExpectedMachinesHandler(dbSession *cdb.Session, tc tclient.Client,
// @Success 201 {object} model.APIExpectedMachineBatchResponse
// @Router /v2/org/{org}/carbide/expected-machine/batch [post]
func (cemh CreateExpectedMachinesHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("CreateMultiple", "ExpectedMachine", c, cemh.tracerSpan)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("ExpectedMachine", "CreateMultiple", c, cemh.tracerSpan)
if handlerSpan != nil {
defer handlerSpan.End()
}
Expand Down Expand Up @@ -1321,7 +1321,7 @@ func NewUpdateExpectedMachinesHandler(dbSession *cdb.Session, tc tclient.Client,
// @Success 200 {object} model.APIExpectedMachineBatchResponse
// @Router /v2/org/{org}/carbide/expected-machine/batch [patch]
func (uemh UpdateExpectedMachinesHandler) Handle(c echo.Context) error {
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("UpdateMultiple", "ExpectedMachine", c, uemh.tracerSpan)
org, dbUser, ctx, logger, handlerSpan := common.SetupHandler("ExpectedMachine", "UpdateMultiple", c, uemh.tracerSpan)
if handlerSpan != nil {
defer handlerSpan.End()
}
Expand Down
Loading
Loading