-
Notifications
You must be signed in to change notification settings - Fork 308
fix(auth): skip expected missing-header telemetry #2645
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.
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
Draft
tvi
wants to merge
1
commit into
main
Choose a base branch
from
t/auth-log-fix
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+7
−5
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -74,11 +74,13 @@ func (a *CommonAuthenticator[T]) GetHeaderKeysFromRequest(req *http.Request) (st | |||||
| func (a *CommonAuthenticator[T]) Authenticate(ctx context.Context, ginCtx *gin.Context, input *openapi3filter.AuthenticationInput) error { | ||||||
| headerKey, err := a.GetHeaderKeysFromRequest(input.RequestValidationInput.Request) | ||||||
| if err != nil { | ||||||
| telemetry.ReportError(ctx, | ||||||
| "authorization header is missing", | ||||||
| err, | ||||||
| attribute.String("error.message", a.ErrorMessage), | ||||||
| ) | ||||||
| if !errors.Is(err, ErrNoAuthHeader) { | ||||||
| telemetry.ReportError(ctx, | ||||||
| "authorization header is missing", | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The telemetry message "authorization header is missing" is incorrect because the preceding check ensures the error is not ErrNoAuthHeader. The message should be updated to "authorization header is invalid" to correctly reflect the state when ErrInvalidAuthHeader is returned.
Suggested change
|
||||||
| err, | ||||||
| attribute.String("error.message", a.ErrorMessage), | ||||||
| ) | ||||||
| } | ||||||
|
|
||||||
| ginCtx.Status(http.StatusUnauthorized) | ||||||
|
|
||||||
|
|
||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Telemetry message misleading after conditional skip
Low Severity
The
telemetry.ReportErrormessage"authorization header is missing"now only fires forErrInvalidAuthHeader(malformed header), sinceErrNoAuthHeaderis explicitly excluded by the new guard. The telemetry event description no longer matches the actual error condition — it will misleadingly report "missing" when the header was present but malformed.Reviewed by Cursor Bugbot for commit 1c01dff. Configure here.