Skip to content

Commit bde6ede

Browse files
zhumin8zhumin8
committed
update messages.
1 parent 8bc1ae7 commit bde6ede

File tree

6 files changed

+45
-37
lines changed

6 files changed

+45
-37
lines changed

‎oauth2_http/java/com/google/auth/oauth2/ComputeEngineCredentials.java‎

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ public AccessToken refreshAccessToken() throws IOException {
299299
}
300300
GenericData responseData = response.parseAs(GenericData.class);
301301
LoggingUtils.logGenericData(
302-
responseData, SLF4JLOGGER, "Auth response from refresh access token payload.");
302+
responseData, SLF4JLOGGER, "Auth response from refresh access token payload");
303303
String accessToken =
304304
OAuth2Utils.validateString(responseData, "access_token", PARSE_ERROR_PREFIX);
305305
int expiresInSeconds =
@@ -366,9 +366,23 @@ private HttpResponse getMetadataResponse(
366366
request.setThrowExceptionOnExecuteError(false);
367367
HttpResponse response;
368368
try {
369-
LoggingUtils.logRequest(request, SLF4JLOGGER, "auth get metadata sending request.");
369+
String requestMessage;
370+
String responseMessage;
371+
if (requestType.equals(RequestType.ID_TOKEN_REQUEST)) {
372+
requestMessage = "Auth get metadata sending request for id token";
373+
responseMessage = "Auth get metadata received response for id token";
374+
} else if (requestType.equals(RequestType.ACCESS_TOKEN_REQUEST)) {
375+
requestMessage = "Auth get metadata sending request for access token";
376+
responseMessage = "Auth get metadata received response for access token";
377+
} else {
378+
// TODO: this includes get universe domain and get default sa.
379+
// refactor for more clear logging message.
380+
requestMessage = "Auth get metadata sending request";
381+
responseMessage = "Auth get metadata received response";
382+
}
383+
LoggingUtils.logRequest(request, SLF4JLOGGER, requestMessage);
370384
response = request.execute();
371-
LoggingUtils.logResponse(response, SLF4JLOGGER, "auth get metadata received response.");
385+
LoggingUtils.logResponse(response, SLF4JLOGGER, responseMessage);
372386
} catch (UnknownHostException exception) {
373387
throw new IOException(
374388
"ComputeEngineCredentials cannot find the metadata server. This is"
@@ -469,9 +483,10 @@ private static boolean pingComputeEngineMetadata(
469483
MetricsUtils.getGoogleCredentialsMetricsHeader(
470484
RequestType.METADATA_SERVER_PING, CredentialTypeForMetrics.DO_NOT_SEND));
471485

472-
LoggingUtils.logRequest(request, SLF4JLOGGER, "auth pin MDS.");
486+
LoggingUtils.logRequest(request, SLF4JLOGGER, "Pin auth Metadata Server");
473487
HttpResponse response = request.execute();
474-
LoggingUtils.logResponse(response, SLF4JLOGGER, "auth received response from MDS.");
488+
LoggingUtils.logResponse(
489+
response, SLF4JLOGGER, "Received auth response from Metadata Server");
475490
try {
476491
// Internet providers can return a generic response to all requests, so it is necessary
477492
// to check that metadata header is present also.
@@ -644,7 +659,7 @@ private String getDefaultServiceAccount() throws IOException {
644659
}
645660
GenericData responseData = response.parseAs(GenericData.class);
646661
LoggingUtils.logGenericData(
647-
responseData, SLF4JLOGGER, "Auth get default service account payload.");
662+
responseData, SLF4JLOGGER, "Auth get default service account payload");
648663
Map<String, Object> defaultAccount =
649664
OAuth2Utils.validateMap(responseData, "default", PARSE_ERROR_ACCOUNT);
650665
return OAuth2Utils.validateString(defaultAccount, "email", PARSE_ERROR_ACCOUNT);

‎oauth2_http/java/com/google/auth/oauth2/IamUtils.java‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,11 @@ private static String getSignature(
144144
IamUtils.IAM_RETRYABLE_STATUS_CODES.contains(response.getStatusCode())));
145145
request.setIOExceptionHandler(new HttpBackOffIOExceptionHandler(backoff));
146146

147-
LoggingUtils.logRequest(request, LOGGER, "auth sending request to get signature.");
147+
LoggingUtils.logRequest(
148+
request, LOGGER, "Sending auth request to get signature to sign the blob");
148149
HttpResponse response = request.execute();
149-
LoggingUtils.logResponse(response, LOGGER, "auth received response for signature.");
150+
LoggingUtils.logResponse(
151+
response, LOGGER, "Received auth response for signature to sign the blob");
150152
int statusCode = response.getStatusCode();
151153
if (statusCode >= 400 && statusCode < HttpStatusCodes.STATUS_CODE_SERVER_ERROR) {
152154
GenericData responseError = response.parseAs(GenericData.class);
@@ -173,7 +175,7 @@ private static String getSignature(
173175
}
174176

175177
GenericData responseData = response.parseAs(GenericData.class);
176-
LoggingUtils.logGenericData(responseData, LOGGER, "Auth response payload.");
178+
LoggingUtils.logGenericData(responseData, LOGGER, "Auth response payload for sign blob");
177179
return OAuth2Utils.validateString(responseData, "signedBlob", PARSE_ERROR_SIGNATURE);
178180
}
179181

@@ -225,10 +227,10 @@ static IdToken getIdToken(
225227
MetricsUtils.getGoogleCredentialsMetricsHeader(
226228
RequestType.ID_TOKEN_REQUEST, credentialTypeForMetrics));
227229

228-
LoggingUtils.logRequest(request, LOGGER, "auth sending request to get id token.");
230+
LoggingUtils.logRequest(request, LOGGER, "Sending auth request to get id token");
229231
HttpResponse response = request.execute();
230232

231-
LoggingUtils.logResponse(response, LOGGER, "auth received response for id token.");
233+
LoggingUtils.logResponse(response, LOGGER, "Received auth response for id token");
232234
int statusCode = response.getStatusCode();
233235
if (statusCode >= 400 && statusCode < HttpStatusCodes.STATUS_CODE_SERVER_ERROR) {
234236
GenericData responseError = response.parseAs(GenericData.class);
@@ -253,7 +255,8 @@ static IdToken getIdToken(
253255
}
254256

255257
GenericJson responseData = response.parseAs(GenericJson.class);
256-
LoggingUtils.logGenericData(responseData, LOGGER, "response data payload.");
258+
LoggingUtils.logGenericData(
259+
responseData, LOGGER, "Auth response data payload for id token request");
257260
String rawToken = OAuth2Utils.validateString(responseData, "token", PARSE_ERROR_MESSAGE);
258261
return IdToken.create(rawToken);
259262
}

‎oauth2_http/java/com/google/auth/oauth2/ImpersonatedCredentials.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -548,15 +548,15 @@ public AccessToken refreshAccessToken() throws IOException {
548548

549549
HttpResponse response = null;
550550
try {
551-
LoggingUtils.logRequest(request, LOGGER, "auth sending refresh access token request.");
551+
LoggingUtils.logRequest(request, LOGGER, "Sending auth refresh access token request");
552552
response = request.execute();
553-
LoggingUtils.logResponse(response, LOGGER, "auth received response.");
553+
LoggingUtils.logResponse(response, LOGGER, "Received auth response for access token");
554554
} catch (IOException e) {
555555
throw new IOException("Error requesting access token", e);
556556
}
557557

558558
GenericData responseData = response.parseAs(GenericData.class);
559-
LoggingUtils.logGenericData(responseData, LOGGER, "Auth response payload.");
559+
LoggingUtils.logGenericData(responseData, LOGGER, "Auth response payload for access token");
560560
response.disconnect();
561561

562562
String accessToken =

‎oauth2_http/java/com/google/auth/oauth2/ServiceAccountCredentials.java‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,7 @@ boolean isConfiguredForDomainWideDelegation() {
493493

494494
private GenericData parseResponseAs(HttpResponse response) throws IOException {
495495
GenericData genericData = response.parseAs(GenericData.class);
496-
LoggingUtils.logGenericData(genericData, LOGGER, "Auth response payload.");
496+
LoggingUtils.logGenericData(genericData, LOGGER, "Auth response payload");
497497
return genericData;
498498
}
499499
/**
@@ -524,7 +524,7 @@ public AccessToken refreshAccessToken() throws IOException {
524524
}
525525
request.setParser(new JsonObjectParser(jsonFactory));
526526

527-
LoggingUtils.logRequest(request, LOGGER, "Sending auth request to refresh access token.");
527+
LoggingUtils.logRequest(request, LOGGER, "Sending auth request to refresh access token");
528528
ExponentialBackOff backoff =
529529
new ExponentialBackOff.Builder()
530530
.setInitialIntervalMillis(OAuth2Utils.INITIAL_RETRY_INTERVAL_MILLIS)
@@ -547,7 +547,7 @@ public AccessToken refreshAccessToken() throws IOException {
547547

548548
try {
549549
response = request.execute();
550-
LoggingUtils.logResponse(response, LOGGER, "Auth response received.");
550+
LoggingUtils.logResponse(response, LOGGER, "Auth response received for refresh access token");
551551
} catch (HttpResponseException re) {
552552
String message = String.format(errorTemplate, re.getMessage(), getIssuer());
553553
throw GoogleAuthException.createWithTokenEndpointResponseException(re, message);
@@ -606,7 +606,8 @@ private IdToken getIdTokenOauthEndpoint(String targetAudience) throws IOExceptio
606606
MetricsUtils.getGoogleCredentialsMetricsHeader(
607607
RequestType.ID_TOKEN_REQUEST, getMetricsCredentialType()));
608608

609-
LoggingUtils.logRequest(request, LOGGER, "Get IdToken via Oauth Endpoint.");
609+
LoggingUtils.logRequest(
610+
request, LOGGER, "Seding auth request to get Id token via Oauth endpoint");
610611
HttpResponse httpResponse = executeRequest(request);
611612

612613
GenericData responseData = parseResponseAs(httpResponse);
@@ -652,7 +653,8 @@ private IdToken getIdTokenIamEndpoint(String targetAudience) throws IOException
652653
// Use the Access Token from the SSJWT to request the ID Token from IAM Endpoint
653654
request.setHeaders(new HttpHeaders().set(AuthHttpConstants.AUTHORIZATION, accessToken));
654655

655-
LoggingUtils.logRequest(request, LOGGER, "Sending id token request to Iam Endpoint.");
656+
LoggingUtils.logRequest(
657+
request, LOGGER, "Sending Auth request to get id token via Iam Endpoint");
656658
HttpResponse httpResponse = executeRequest(request);
657659

658660
GenericData responseData = parseResponseAs(httpResponse);

‎oauth2_http/java/com/google/auth/oauth2/UserCredentials.java‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -193,13 +193,6 @@ public AccessToken refreshAccessToken() throws IOException {
193193
String scopes =
194194
OAuth2Utils.validateOptionalString(
195195
responseData, OAuth2Utils.TOKEN_RESPONSE_SCOPE, PARSE_ERROR_PREFIX);
196-
// if (LOGGER.isDebugEnabled()) {
197-
// Map<String, String> responseContentMap = new HashMap<>();
198-
// responseContentMap.put("access_token", accessToken);
199-
// responseContentMap.put("expires_in", String.valueOf(expiresInSeconds));
200-
// responseContentMap.put(OAuth2Utils.TOKEN_RESPONSE_SCOPE, scopes);
201-
// LoggingUtils.logWithMDC(LOGGER, Level.DEBUG, responseContentMap, "response payload.");
202-
// }
203196
return AccessToken.newBuilder()
204197
.setExpirationTime(new Date(expiresAtMilliseconds))
205198
.setTokenValue(accessToken)
@@ -224,11 +217,6 @@ public IdToken idTokenWithAudience(String targetAudience, List<Option> options)
224217
if (responseData.containsKey(idTokenKey)) {
225218
String idTokenString =
226219
OAuth2Utils.validateString(responseData, idTokenKey, PARSE_ERROR_PREFIX);
227-
// if (LOGGER.isDebugEnabled()) {
228-
// Map<String, String> responseContentMap = new HashMap<>();
229-
// responseContentMap.put("id_token", idTokenString);
230-
// LoggingUtils.logWithMDC(LOGGER, Level.DEBUG, responseContentMap, "response payload.");
231-
// }
232220
return IdToken.create(idTokenString);
233221
}
234222

@@ -294,9 +282,9 @@ private GenericData doRefreshAccessToken() throws IOException {
294282
HttpResponse response;
295283

296284
try {
297-
LoggingUtils.logRequest(request, LOGGER, "Sending auth request to refresh access token.");
285+
LoggingUtils.logRequest(request, LOGGER, "Sending auth request to refresh access token");
298286
response = request.execute();
299-
LoggingUtils.logResponse(response, LOGGER, "Received auth respond for refresh access token.");
287+
LoggingUtils.logResponse(response, LOGGER, "Received auth respond for refresh access token");
300288
} catch (HttpResponseException re) {
301289
throw GoogleAuthException.createWithTokenEndpointResponseException(re);
302290
} catch (IOException e) {
@@ -305,7 +293,7 @@ private GenericData doRefreshAccessToken() throws IOException {
305293

306294
GenericData data = response.parseAs(GenericData.class);
307295

308-
LoggingUtils.logGenericData(data, LOGGER, "Auth response payload.");
296+
LoggingUtils.logGenericData(data, LOGGER, "Auth response payload for refresh access token");
309297
return data;
310298
}
311299

‎oauth2_http/javatests/com/google/auth/oauth2/LoggingTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public void getRequestMetadata_hasAccessToken() throws IOException {
9090

9191
assertEquals(3, testAppender.events.size());
9292
assertEquals(
93-
"Sending auth request to refresh access token.",
93+
"Sending auth request to refresh access token",
9494
testAppender.events.get(0).getFormattedMessage());
9595
testAppender.stop();
9696
}
@@ -128,7 +128,7 @@ public void idTokenWithAudience_iamFlow_targetAudienceMatchesAudClaim() throws I
128128

129129
assertEquals(2, testAppender.events.size());
130130
assertEquals(
131-
"Sending id token request to Iam Endpoint.",
131+
"Sending Auth request to get id token via Iam Endpoint",
132132
testAppender.events.get(0).getFormattedMessage());
133133
assertEquals("Auth response payload.", testAppender.events.get(1).getFormattedMessage());
134134

0 commit comments

Comments
 (0)