[scd] factor out parameter validation for oir upsert method #1089
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Shastick
force-pushed
the
oir-upsert-refactor-0-param-validation
branch
from
bc92dcc to
8524493
Compare
mickmis
reviewed
Aug 30, 2024
| subscriptionID dssmodels.ID | ||
| } | ||
|
|
||
| func (a *Server) validateAndReturnUpsertParams( |
There was a problem hiding this comment.
Pass AllowHTTPBaseUrls as a param to avoid attaching this to Server?
Comment on lines
483
to
491
| upsertParams, err := a.validateAndReturnUpsertParams(authorizedManager, entityid, ovn, params) | ||
| if err != nil { | ||
| // Important note: | ||
| // - stacktrace.Propagate sets NoCode as the code for the error | ||
| // - subsequently, stacktrace.GetCode(err) only looks into the first error in the stack and returns NoCode if the error has no code | ||
| // - therefore, we need to explicitly use stacktrace.PropagateWithCode if we want the calling logic | ||
| // to be able to retrieve the code of the error | ||
| // TODO we can consider fixing this in the stacktrace library | ||
| return nil, nil, stacktrace.PropagateWithCode(err, stacktrace.GetCode(err), "Failed to validate Operational Intent Reference upsert parameters") |
There was a problem hiding this comment.
Here I suggest making validateAndReturnUpsertParams purely a validation function by:
- move out of
validateAndReturnUpsertParamsthe two cases of errorsdsserr.PermissionDenied - never returning any code within
validateAndReturnUpsertParams - if
err != nilset the codedsserr.BadRequest
That makes it clear this function validates the input to create the op intent and any error implies bad input. That should also enable passing the manager instead of the whole authorizedManager.
Shastick
force-pushed
the
oir-upsert-refactor-0-param-validation
branch
4 times, most recently
from
eb4a8b5 to
9030146
Compare
Shastick
force-pushed
the
oir-upsert-refactor-0-param-validation
branch
from
9030146 to
f041be8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A first small step towards #1088.
This takes care of moving the parameter validation to a submethod. It is not yet improving anything with respect to the core business logic, but allows readers to more directly focus on the code of what
upsertOperationalIntentReferencedoes.Note about the usage of the
stacktracelibrary and our dependency on error codes: as we use the error codes to decide what HTTP response to send back, it is important that we properly propagate them when we move logic one or several layers of method calls.