Skip to content

Commit 88bbe12

Browse files
asafshenasafshen
authored
Logging and error capitalisation alignment (#228)
* Logging and error capitalisation alignment * test
1 parent 7e3ece1 commit 88bbe12

File tree

9 files changed

+32
-32
lines changed

9 files changed

+32
-32
lines changed

‎descope/api/client.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -648,10 +648,10 @@ func (c *Client) DoRequest(method, uriPath string, body io.Reader, options *HTTP
648648
req.Header.Set(AuthorizationHeaderName, BearerAuthorizationPrefix+bearer)
649649
c.addDescopeHeaders(req)
650650

651-
logger.LogDebug("sending request to [%s]", url)
651+
logger.LogDebug("Sending request to [%s]", url)
652652
response, err := c.httpClient.Do(req)
653653
if err != nil {
654-
logger.LogError("failed sending request to [%s]", err, url)
654+
logger.LogError("Failed sending request to [%s]", err, url)
655655
return nil, err
656656
}
657657

@@ -660,19 +660,19 @@ func (c *Client) DoRequest(method, uriPath string, body io.Reader, options *HTTP
660660
}
661661
if !isResponseOK(response) {
662662
err = c.parseDescopeError(response).WithInfo(descope.ErrorInfoKeys.HTTPResponseStatusCode, response.StatusCode)
663-
logger.LogInfo("failed sending request to [%s], error: [%s]", url, err)
663+
logger.LogInfo("Failed sending request to [%s], error: [%s]", url, err)
664664
return nil, err
665665
}
666666

667667
resBytes, err := c.parseBody(response)
668668
if err != nil { // notest
669-
logger.LogError("failed processing body from request to [%s]", err, url)
669+
logger.LogError("Failed processing body from request to [%s]", err, url)
670670
return nil, descope.ErrInvalidResponse
671671
}
672672

673673
if options.ResBodyObj != nil {
674674
if err = utils.Unmarshal(resBytes, &options.ResBodyObj); err != nil {
675-
logger.LogError("failed parsing body from request to [%s]", err, url)
675+
logger.LogError("Failed parsing body from request to [%s]", err, url)
676676
return nil, descope.ErrInvalidResponse
677677
}
678678
}
@@ -697,13 +697,13 @@ func (c *Client) parseBody(response *http.Response) (resBytes []byte, err error)
697697
func (c *Client) parseDescopeError(response *http.Response) *descope.Error {
698698
body, err := c.parseBody(response)
699699
if err != nil { // notest
700-
logger.LogError("failed to process error from server response", err)
700+
logger.LogError("Failed to process error from server response", err)
701701
return descope.ErrInvalidResponse
702702
}
703703

704704
var descopeErr *descope.Error
705705
if err := json.Unmarshal(body, &descopeErr); err != nil || descopeErr.Code == "" {
706-
logger.LogError("failed to parse error from server response", err)
706+
logger.LogError("Failed to parse error from server response", err)
707707
return descope.ErrInvalidResponse
708708
}
709709

‎descope/client/client.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ func NewWithConfig(config *Config) (*DescopeClient, error) {
4242
logger.Init(config.LogLevel, config.Logger)
4343

4444
if strings.TrimSpace(config.setProjectID()) == "" {
45-
return nil, descope.ErrMissingProjectID.WithMessage("project id is missing, make sure to add it in the Config struct or the environment variable \"%s\"", descope.EnvironmentVariableProjectID)
45+
return nil, descope.ErrMissingProjectID.WithMessage("Project ID is missing, make sure to add it in the Config struct or the environment variable \"%s\"", descope.EnvironmentVariableProjectID)
4646
}
4747
if config.setPublicKey() != "" {
48-
logger.LogInfo("provided public key is set, forcing only provided public key validation")
48+
logger.LogInfo("Provided public key is set, forcing only provided public key validation")
4949
}
5050
config.setManagementKey()
5151

‎descope/client/client_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ func TestConcurrentClients(t *testing.T) {
6161
func TestEmptyProjectID(t *testing.T) {
6262
_, err := New()
6363
require.Error(t, err)
64-
assert.Contains(t, err.Error(), "project id is missing")
64+
assert.Contains(t, err.Error(), "Project ID is missing")
6565
}
6666

6767
func TestEmptyConfig(t *testing.T) {

‎descope/internal/auth/auth.go

+14-14
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,13 @@ func (auth *authenticationService) Logout(request *http.Request, w http.Response
9292

9393
_, refreshToken := provideTokens(request)
9494
if refreshToken == "" {
95-
logger.LogDebug("unable to find tokens from cookies")
95+
logger.LogDebug("Unable to find tokens from cookies")
9696
return descope.ErrRefreshToken.WithMessage("Unable to find tokens from cookies")
9797
}
9898

9999
_, err := auth.validateJWT(refreshToken)
100100
if err != nil {
101-
logger.LogDebug("invalid refresh token")
101+
logger.LogDebug("Invalid refresh token")
102102
return descope.ErrRefreshToken.WithMessage("Invalid refresh token")
103103
}
104104

@@ -145,13 +145,13 @@ func (auth *authenticationService) LogoutAll(request *http.Request, w http.Respo
145145

146146
_, refreshToken := provideTokens(request)
147147
if refreshToken == "" {
148-
logger.LogDebug("unable to find tokens from cookies")
148+
logger.LogDebug("Unable to find tokens from cookies")
149149
return descope.ErrRefreshToken.WithMessage("Unable to find tokens from cookies")
150150
}
151151

152152
_, err := auth.validateJWT(refreshToken)
153153
if err != nil {
154-
logger.LogDebug("invalid refresh token")
154+
logger.LogDebug("Invalid refresh token")
155155
return descope.ErrRefreshToken.WithMessage("Invalid refresh token")
156156
}
157157

@@ -198,13 +198,13 @@ func (auth *authenticationService) Me(request *http.Request) (*descope.UserRespo
198198

199199
_, refreshToken := provideTokens(request)
200200
if refreshToken == "" {
201-
logger.LogDebug("unable to find tokens from cookies")
201+
logger.LogDebug("Unable to find tokens from cookies")
202202
return nil, descope.ErrRefreshToken.WithMessage("Unable to find tokens from cookies")
203203
}
204204

205205
_, err := auth.validateJWT(refreshToken)
206206
if err != nil {
207-
logger.LogDebug("invalid refresh token")
207+
logger.LogDebug("Invalid refresh token")
208208
return nil, descope.ErrRefreshToken.WithMessage("Invalid refresh token")
209209
}
210210

@@ -317,7 +317,7 @@ func (auth *authenticationService) validateAndRefreshSessionWithTokens(sessionTo
317317
func (auth *authenticationService) ExchangeAccessKey(accessKey string) (success bool, SessionToken *descope.Token, err error) {
318318
httpResponse, err := auth.client.DoPostRequest(api.Routes.ExchangeAccessKey(), nil, &api.HTTPRequest{}, accessKey)
319319
if err != nil {
320-
logger.LogError("failed to exchange access key", err)
320+
logger.LogError("Failed to exchange access key", err)
321321
return false, nil, err
322322
}
323323

@@ -369,7 +369,7 @@ func (auth *authenticationsBase) extractJWTResponse(bodyStr string) (*descope.JW
369369
jRes := descope.JWTResponse{}
370370
err := utils.Unmarshal([]byte(bodyStr), &jRes)
371371
if err != nil {
372-
logger.LogError("unable to parse jwt response", err)
372+
logger.LogError("Unable to parse jwt response", err)
373373
return nil, err
374374
}
375375
return &jRes, nil
@@ -382,7 +382,7 @@ func (auth *authenticationsBase) extractUserResponse(bodyStr string) (*descope.U
382382
res := descope.UserResponse{}
383383
err := utils.Unmarshal([]byte(bodyStr), &res)
384384
if err != nil {
385-
logger.LogError("unable to parse user response", err)
385+
logger.LogError("Unable to parse user response", err)
386386
return nil, err
387387
}
388388
return &res, nil
@@ -518,7 +518,7 @@ func (auth *authenticationsBase) generateAuthenticationInfoWithRefreshToken(http
518518
}
519519
tokens, err := auth.extractTokens(jwtResponse)
520520
if err != nil {
521-
logger.LogError("unable to extract tokens from request [%s]", err, httpResponse.Req.URL)
521+
logger.LogError("Unable to extract tokens from request [%s]", err, httpResponse.Req.URL)
522522
return nil, err
523523
}
524524

@@ -548,7 +548,7 @@ func (auth *authenticationsBase) generateAuthenticationInfoWithRefreshToken(http
548548
if cookies[i].Name == descope.RefreshCookieName {
549549
refreshToken, err = auth.validateJWT(cookies[i].Value)
550550
if err != nil {
551-
logger.LogDebug("validation of refresh token failed: %s", err.Error())
551+
logger.LogDebug("Validation of refresh token failed: %s", err.Error())
552552
return nil, err
553553
}
554554
}
@@ -562,7 +562,7 @@ func (auth *authenticationsBase) generateAuthenticationInfoWithRefreshToken(http
562562
func getValidRefreshToken(r *http.Request) (string, error) {
563563
_, refreshToken := provideTokens(r)
564564
if refreshToken == "" {
565-
logger.LogDebug("unable to find tokens from cookies")
565+
logger.LogDebug("Unable to find tokens from cookies")
566566
return "", descope.ErrRefreshToken.WithMessage("Unable to find tokens from cookies")
567567
}
568568
return refreshToken, nil
@@ -667,7 +667,7 @@ func getAuthorizationClaimItems(token *descope.Token, tenant string, claim strin
667667

668668
// warn if it seems like programmer forgot the tenant ID
669669
if len(items) == 0 && tenant == "" && len(token.GetTenants()) != 0 {
670-
logger.LogDebug("no authorization items found but tenant might need to be specified")
670+
logger.LogDebug("No authorization items found but tenant might need to be specified")
671671
}
672672

673673
return items
@@ -676,7 +676,7 @@ func getAuthorizationClaimItems(token *descope.Token, tenant string, claim strin
676676
func getPendingRefFromResponse(httpResponse *api.HTTPResponse) (*descope.EnchantedLinkResponse, error) {
677677
var response *descope.EnchantedLinkResponse
678678
if err := utils.Unmarshal([]byte(httpResponse.BodyStr), &response); err != nil {
679-
logger.LogError("failed to load pending reference from response", err)
679+
logger.LogError("Failed to load pending reference from response", err)
680680
return response, descope.ErrUnexpectedResponse.WithMessage("Failed to load pending reference")
681681
}
682682
return response, nil

‎descope/internal/auth/jwt.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ func (p *provider) requestKeys() error {
7878
tempKeySet[pk.KeyID()] = pk
7979
}
8080

81-
logger.LogDebug("refresh keys set with %d key(s)", len(tempKeySet))
81+
logger.LogDebug("Refresh keys set with %d key(s)", len(tempKeySet))
8282
p.keySet = tempKeySet
8383
return nil
8484
}
@@ -91,7 +91,7 @@ func (p *provider) providedPublicKey() (jwk.Key, error) {
9191
if p.conf.PublicKey != "" {
9292
jk, err := jwk.ParseKey([]byte(p.conf.PublicKey))
9393
if err != nil {
94-
logger.LogDebug("unable to parse key")
94+
logger.LogDebug("Unable to parse key")
9595
return nil, err
9696
}
9797
p.providedKey, _ = jk.PublicKey()
@@ -115,7 +115,7 @@ func (p *provider) findKey(kid string) (jwk.Key, error) {
115115
}
116116

117117
if err := p.requestKeys(); err != nil {
118-
logger.LogDebug("failed to retrieve public keys from API [%s]", err)
118+
logger.LogDebug("Failed to retrieve public keys from API [%s]", err)
119119
return nil, err
120120
}
121121

@@ -133,7 +133,7 @@ func (p *provider) FetchKeys(_ context.Context, sink jws.KeySink, sig *jws.Signa
133133
wantedKid := sig.ProtectedHeaders().KeyID()
134134
v, ok := p.keySet[wantedKid]
135135
if !ok {
136-
logger.LogDebug("key was not found, looking for key id [%s]", wantedKid)
136+
logger.LogDebug("Key was not found, looking for key id [%s]", wantedKid)
137137
if key, err := p.findKey(wantedKid); key != nil {
138138
v = key
139139
} else {

‎descope/internal/auth/oauth.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func (auth *oauth) Start(provider descope.OAuthProvider, redirectURL string, r *
4141
res := &oauthStartResponse{}
4242
err = utils.Unmarshal([]byte(httpResponse.BodyStr), res)
4343
if err != nil {
44-
logger.LogError("failed to parse location from response for [%s]", err, provider)
44+
logger.LogError("Failed to parse location from response for [%s]", err, provider)
4545
return "", err
4646
}
4747
url = res.URL

‎descope/internal/auth/saml.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ func (auth *saml) Start(tenant string, redirectURL string, r *http.Request, logi
4343
res := &samlStartResponse{}
4444
err = utils.Unmarshal([]byte(httpResponse.BodyStr), res)
4545
if err != nil {
46-
logger.LogError("failed to parse saml location from response for [%s]", err, tenant)
46+
logger.LogError("Failed to parse saml location from response for [%s]", err, tenant)
4747
return "", err
4848
}
4949
url = res.URL

‎descope/internal/mgmt/mgmt.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,6 @@ func (mgmt *managementService) Group() sdk.Group {
8686

8787
func (mgmt *managementService) ensureManagementKey() {
8888
if mgmt.conf.ManagementKey == "" {
89-
logger.LogInfo("management key is missing, make sure to add it in the Config struct or the environment variable \"%s\"", descope.EnvironmentVariableManagementKey) // notest
89+
logger.LogInfo("Management key is missing, make sure to add it in the Config struct or the environment variable \"%s\"", descope.EnvironmentVariableManagementKey) // notest
9090
}
9191
}

‎descope/sdk/middleware.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ func AuthenticationMiddleware(auth Authentication, onFailure func(http.ResponseW
2525
}
2626
} else {
2727
if err != nil {
28-
logger.LogError("request failed because token is invalid", err)
28+
logger.LogError("Request failed because token is invalid", err)
2929
}
3030
if onFailure != nil {
3131
onFailure(w, r, err)

0 commit comments

Comments
 (0)