Skip to content

Commit 15d3016

Browse files
zhumin8zhumin8
committed
update logging messages to rm 'auth'.
1 parent fb8889a commit 15d3016

File tree

7 files changed

+37
-46
lines changed

7 files changed

+37
-46
lines changed

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

Lines changed: 10 additions & 11 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, "Response from refresh access token payload");
303303
String accessToken =
304304
OAuth2Utils.validateString(responseData, "access_token", PARSE_ERROR_PREFIX);
305305
int expiresInSeconds =
@@ -369,16 +369,16 @@ private HttpResponse getMetadataResponse(
369369
String requestMessage;
370370
String responseMessage;
371371
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";
372+
requestMessage = "Sending request for id token";
373+
responseMessage = "Received response for id token";
374374
} 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";
375+
requestMessage = "Sending request for access token";
376+
responseMessage = "Received response for access token";
377377
} else {
378378
// TODO: this includes get universe domain and get default sa.
379379
// refactor for more clear logging message.
380-
requestMessage = "Auth get metadata sending request";
381-
responseMessage = "Auth get metadata received response";
380+
requestMessage = "Sending request for universe domain/default service account";
381+
responseMessage = "Received response for universe domain/default service account";
382382
}
383383
LoggingUtils.logRequest(request, SLF4JLOGGER, requestMessage);
384384
response = request.execute();
@@ -483,10 +483,9 @@ private static boolean pingComputeEngineMetadata(
483483
MetricsUtils.getGoogleCredentialsMetricsHeader(
484484
RequestType.METADATA_SERVER_PING, CredentialTypeForMetrics.DO_NOT_SEND));
485485

486-
LoggingUtils.logRequest(request, SLF4JLOGGER, "Pin auth Metadata Server");
486+
LoggingUtils.logRequest(request, SLF4JLOGGER, "Pinging Metadata Server");
487487
HttpResponse response = request.execute();
488-
LoggingUtils.logResponse(
489-
response, SLF4JLOGGER, "Received auth response from Metadata Server");
488+
LoggingUtils.logResponse(response, SLF4JLOGGER, "Received response from Metadata Server");
490489
try {
491490
// Internet providers can return a generic response to all requests, so it is necessary
492491
// to check that metadata header is present also.
@@ -659,7 +658,7 @@ private String getDefaultServiceAccount() throws IOException {
659658
}
660659
GenericData responseData = response.parseAs(GenericData.class);
661660
LoggingUtils.logGenericData(
662-
responseData, SLF4JLOGGER, "Auth get default service account payload");
661+
responseData, SLF4JLOGGER, "Received default service account payload");
663662
Map<String, Object> defaultAccount =
664663
OAuth2Utils.validateMap(responseData, "default", PARSE_ERROR_ACCOUNT);
665664
return OAuth2Utils.validateString(defaultAccount, "email", PARSE_ERROR_ACCOUNT);

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

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

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

177175
GenericData responseData = response.parseAs(GenericData.class);
178-
LoggingUtils.logGenericData(responseData, LOGGER, "Auth response payload for sign blob");
176+
LoggingUtils.logGenericData(responseData, LOGGER, "Response payload for sign blob");
179177
return OAuth2Utils.validateString(responseData, "signedBlob", PARSE_ERROR_SIGNATURE);
180178
}
181179

@@ -227,10 +225,10 @@ static IdToken getIdToken(
227225
MetricsUtils.getGoogleCredentialsMetricsHeader(
228226
RequestType.ID_TOKEN_REQUEST, credentialTypeForMetrics));
229227

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

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

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

‎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, "Sending auth request to refresh access token");
551+
LoggingUtils.logRequest(request, LOGGER, "Sending request to refresh access token");
552552
response = request.execute();
553-
LoggingUtils.logResponse(response, LOGGER, "Received auth response for access token");
553+
LoggingUtils.logResponse(response, LOGGER, "Received 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 for access token");
559+
LoggingUtils.logGenericData(responseData, LOGGER, "Response payload for access token");
560560
response.disconnect();
561561

562562
String accessToken =

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ static void logRequest(HttpRequest request, Logger logger, String message) {
119119
if (request.getContent() != null && logger.isDebugEnabled()) {
120120
// are payload always GenericData? If so, can parse and store in json
121121
if (request.getContent() instanceof UrlEncodedContent) {
122-
122+
// this is parsed to GenericData because that is how it is constructed.
123123
GenericData data = (GenericData) ((UrlEncodedContent) request.getContent()).getData();
124124
Map<String, String> contextMap = parseGenericData(data);
125125
loggingDataMap.put("request.payload", contextMap.toString());

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

Lines changed: 5 additions & 7 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, "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 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 for refresh access token");
550+
LoggingUtils.logResponse(response, LOGGER, "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,8 +606,7 @@ private IdToken getIdTokenOauthEndpoint(String targetAudience) throws IOExceptio
606606
MetricsUtils.getGoogleCredentialsMetricsHeader(
607607
RequestType.ID_TOKEN_REQUEST, getMetricsCredentialType()));
608608

609-
LoggingUtils.logRequest(
610-
request, LOGGER, "Seding auth request to get Id token via Oauth endpoint");
609+
LoggingUtils.logRequest(request, LOGGER, "Sending request to get Id token via Oauth endpoint");
611610
HttpResponse httpResponse = executeRequest(request);
612611

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

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

660658
GenericData responseData = parseResponseAs(httpResponse);

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -282,9 +282,9 @@ private GenericData doRefreshAccessToken() throws IOException {
282282
HttpResponse response;
283283

284284
try {
285-
LoggingUtils.logRequest(request, LOGGER, "Sending auth request to refresh access token");
285+
LoggingUtils.logRequest(request, LOGGER, "Sending request to refresh access token");
286286
response = request.execute();
287-
LoggingUtils.logResponse(response, LOGGER, "Received auth respond for refresh access token");
287+
LoggingUtils.logResponse(response, LOGGER, "Received respond for refresh access token");
288288
} catch (HttpResponseException re) {
289289
throw GoogleAuthException.createWithTokenEndpointResponseException(re);
290290
} catch (IOException e) {
@@ -293,7 +293,7 @@ private GenericData doRefreshAccessToken() throws IOException {
293293

294294
GenericData data = response.parseAs(GenericData.class);
295295

296-
LoggingUtils.logGenericData(data, LOGGER, "Auth response payload for refresh access token");
296+
LoggingUtils.logGenericData(data, LOGGER, "Response payload for refresh access token");
297297
return data;
298298
}
299299

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public void userCredentials_getRequestMetadata_fromRefreshToken_hasAccessToken()
109109
assertEquals(
110110
"com.google.auth.oauth2.UserCredentials", testAppender.events.get(0).getLoggerName());
111111
assertEquals(
112-
"Sending auth request to refresh access token", jsonMessage.get("message").getAsString());
112+
"Sending request to refresh access token", jsonMessage.get("message").getAsString());
113113
testAppender.stop();
114114
}
115115

@@ -128,7 +128,7 @@ public void serviceAccountCredentials_getRequestMetadata_hasAccessToken() throws
128128
gson.fromJson(testAppender.events.get(0).getFormattedMessage(), JsonObject.class);
129129

130130
assertEquals(
131-
"Sending auth request to refresh access token", jsonMessage.get("message").getAsString());
131+
"Sending request to refresh access token", jsonMessage.get("message").getAsString());
132132
testAppender.stop();
133133
}
134134

@@ -171,9 +171,9 @@ public void serviceAccountCredentials_idTokenWithAudience_iamFlow_targetAudience
171171
JsonObject jsonMessage2 =
172172
gson.fromJson(testAppender.events.get(1).getFormattedMessage(), JsonObject.class);
173173
assertEquals(
174-
"Sending Auth request to get id token via Iam Endpoint",
174+
"Sending request to get id token via Iam Endpoint",
175175
jsonMessage1.get("message").getAsString());
176-
assertEquals("Auth response payload", jsonMessage2.get("message").getAsString());
176+
assertEquals("Response payload", jsonMessage2.get("message").getAsString());
177177

178178
testAppender.stop();
179179
}
@@ -215,7 +215,7 @@ public void impersonatedCredentials_refreshAccessToken_success()
215215
"com.google.auth.oauth2.ImpersonatedCredentials",
216216
testAppender.events.get(0).getLoggerName());
217217
assertEquals(
218-
"Sending auth request to refresh access token", jsonMessage.get("message").getAsString());
218+
"Sending request to refresh access token", jsonMessage.get("message").getAsString());
219219
assertEquals(4, testAppender.events.get(0).getMDCPropertyMap().size());
220220
testAppender.stop();
221221
}
@@ -258,7 +258,7 @@ public void idTokenWithAudience_withEmail() throws IOException {
258258
gson.fromJson(testAppender.events.get(0).getFormattedMessage(), JsonObject.class);
259259

260260
assertEquals("com.google.auth.oauth2.IamUtils", testAppender.events.get(0).getLoggerName());
261-
assertEquals("Sending auth request to get id token", jsonMessage.get("message").getAsString());
261+
assertEquals("Sending request to get id token", jsonMessage.get("message").getAsString());
262262
assertEquals(4, testAppender.events.get(0).getMDCPropertyMap().size());
263263
testAppender.stop();
264264
}
@@ -294,7 +294,7 @@ public void sign_sameAs() throws IOException {
294294

295295
assertEquals("com.google.auth.oauth2.IamUtils", testAppender.events.get(0).getLoggerName());
296296
assertEquals(
297-
"Sending auth request to get signature to sign the blob",
297+
"Sending request to get signature to sign the blob",
298298
jsonMessage.get("message").getAsString());
299299
assertEquals(4, testAppender.events.get(0).getMDCPropertyMap().size());
300300
assertEquals(1, testAppender.events.get(2).getMDCPropertyMap().size());
@@ -318,9 +318,7 @@ public void getRequestMetadata_hasAccessToken() throws IOException {
318318
assertEquals(
319319
"com.google.auth.oauth2.ComputeEngineCredentials",
320320
testAppender.events.get(0).getLoggerName());
321-
assertEquals(
322-
"Auth get metadata sending request for access token",
323-
jsonMessage.get("message").getAsString());
321+
assertEquals("Sending request for access token", jsonMessage.get("message").getAsString());
324322
assertEquals(3, testAppender.events.get(0).getMDCPropertyMap().size());
325323
assertEquals(3, testAppender.events.get(1).getMDCPropertyMap().size());
326324
assertEquals(3, testAppender.events.get(2).getMDCPropertyMap().size());
@@ -355,8 +353,7 @@ public void idTokenWithAudience_full() throws IOException {
355353
assertEquals(
356354
"com.google.auth.oauth2.ComputeEngineCredentials",
357355
testAppender.events.get(0).getLoggerName());
358-
assertEquals(
359-
"Auth get metadata sending request for id token", jsonMessage.get("message").getAsString());
356+
assertEquals("Sending request for id token", jsonMessage.get("message").getAsString());
360357
assertEquals(3, testAppender.events.get(0).getMDCPropertyMap().size());
361358
assertEquals(3, testAppender.events.get(1).getMDCPropertyMap().size());
362359
testAppender.stop();

0 commit comments

Comments
 (0)