Merge pull request #40 from tlisonbee/trace-id-fix

Fixing issue where traceId was missing in the logs
Nike-Inc · May 11, 2017 · 56bb91e · 56bb91e
2 parents 0074453 + 575d888
commit 56bb91e
Show file tree

Hide file tree

Showing 24 changed files with 165 additions and 82 deletions.
diff --git a/gradle/dependencies.gradle b/gradle/dependencies.gradle
@@ -19,7 +19,7 @@ repositories {
     jcenter()
 }
 
-def riposteVersion = '0.8.1'
+def riposteVersion = '0.9.4'
 def logbackVersion = '1.1.7'
 // Request version 4 for full java 8 support
 def guiceVersion = '4.0'

diff --git a/src/main/java/com/nike/cerberus/endpoints/admin/GetSDBMetadata.java b/src/main/java/com/nike/cerberus/endpoints/admin/GetSDBMetadata.java
@@ -25,6 +25,8 @@
 import com.nike.cerberus.service.MetadataService;
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
+import com.nike.riposte.server.http.impl.FullResponseInfo;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.HttpMethod;
@@ -57,15 +59,20 @@ public CompletableFuture<ResponseInfo<SDBMetadataResult>> doExecute(final Reques
                                                                         final Executor longRunningTaskExecutor,
                                                                         final ChannelHandlerContext ctx,
                                                                         final SecurityContext securityContext) {
-
         return CompletableFuture.supplyAsync(
-                () -> ResponseInfo.newBuilder(metadataService.getSDBMetadata(getLimit(request), getOffset(request)))
-                        .build(), longRunningTaskExecutor
+                AsyncNettyHelper.supplierWithTracingAndMdc(() -> getMetadata(request), ctx),
+                longRunningTaskExecutor
         );
     }
 
+    private FullResponseInfo<SDBMetadataResult> getMetadata(RequestInfo<Void> request) {
+        return ResponseInfo.newBuilder(metadataService.getSDBMetadata(getLimit(request), getOffset(request)))
+                .build();
+    }
+
     /**
      * Parses and validates limit query param
+     *
      * @param request The request
      * @return default or parsed vaule
      */
@@ -83,10 +90,11 @@ protected int getLimit(RequestInfo<Void> request) {
 
     /**
      * validates that the limit query is a valid number >= 1
+     *
      * @param limitQueryValue
      */
     protected void validateLimitQuery(String limitQueryValue) {
-        if (! StringUtils.isNumeric(limitQueryValue) || Integer.parseInt(limitQueryValue) < 1) {
+        if (!StringUtils.isNumeric(limitQueryValue) || Integer.parseInt(limitQueryValue) < 1) {
             throw ApiException.newBuilder()
                     .withApiErrors(new ApiErrorBase(
                             DefaultApiError.INVALID_QUERY_PARAMS.getName(),
@@ -99,6 +107,7 @@ protected void validateLimitQuery(String limitQueryValue) {
 
     /**
      * Parses and validates offset query param
+     *
      * @param request The request
      * @return default or parsed vaule
      */
@@ -116,10 +125,11 @@ protected int getOffset(RequestInfo<Void> request) {
 
     /**
      * Validates that the offset value is a number that is >= 0
+     *
      * @param offsetQueryValue
      */
     protected void validateOffsetQuery(String offsetQueryValue) {
-        if (! StringUtils.isNumeric(offsetQueryValue)) {
+        if (!StringUtils.isNumeric(offsetQueryValue)) {
             throw ApiException.newBuilder()
                     .withApiErrors(new ApiErrorBase(
                             DefaultApiError.INVALID_QUERY_PARAMS.getName(),

diff --git a/src/main/java/com/nike/cerberus/endpoints/admin/PutSDBMetadata.java b/src/main/java/com/nike/cerberus/endpoints/admin/PutSDBMetadata.java
@@ -23,6 +23,7 @@
 import com.nike.cerberus.service.MetadataService;
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.HttpMethod;
@@ -54,19 +55,24 @@ public CompletableFuture<ResponseInfo<Void>> doExecute(RequestInfo<SDBMetadata>
                                                            ChannelHandlerContext ctx,
                                                            SecurityContext securityContext) {
 
-        return CompletableFuture.supplyAsync(() -> {
-            VaultAuthPrincipal vaultAuthPrincipal = (VaultAuthPrincipal) securityContext.getUserPrincipal();
+        return CompletableFuture.supplyAsync(
+                AsyncNettyHelper.supplierWithTracingAndMdc(() -> restoreSdbMetadata(request, securityContext), ctx),
+                longRunningTaskExecutor
+        );
+    }
+
+    private ResponseInfo<Void> restoreSdbMetadata(RequestInfo<SDBMetadata> request, SecurityContext securityContext) {
+        VaultAuthPrincipal vaultAuthPrincipal = (VaultAuthPrincipal) securityContext.getUserPrincipal();
 
-            String principal = vaultAuthPrincipal.getName();
+        String principal = vaultAuthPrincipal.getName();
 
-            log.info("Metadata Restore Event: the principal {} is attempting to restore sdb name: '{}'", principal, request.getContent().getName());
+        log.info("Metadata Restore Event: the principal {} is attempting to restore sdb name: '{}'", principal, request.getContent().getName());
 
-            metadataService.restoreMetadata(request.getContent(), principal);
+        metadataService.restoreMetadata(request.getContent(), principal);
 
-            return ResponseInfo.<Void>newBuilder()
-                    .withHttpStatusCode(HttpResponseStatus.NO_CONTENT.code())
-                    .build();
-        }, longRunningTaskExecutor);
+        return ResponseInfo.<Void>newBuilder()
+                .withHttpStatusCode(HttpResponseStatus.NO_CONTENT.code())
+                .build();
     }
 
     @Override

diff --git a/src/main/java/com/nike/cerberus/endpoints/authentication/AuthenticateIamPrincipal.java b/src/main/java/com/nike/cerberus/endpoints/authentication/AuthenticateIamPrincipal.java
@@ -17,12 +17,13 @@
 
 package com.nike.cerberus.endpoints.authentication;
 
-import com.nike.cerberus.domain.IamRoleAuthResponse;
 import com.nike.cerberus.domain.IamPrincipalCredentials;
+import com.nike.cerberus.domain.IamRoleAuthResponse;
 import com.nike.cerberus.service.AuthenticationService;
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
 import com.nike.riposte.server.http.StandardEndpoint;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.HttpMethod;
@@ -52,13 +53,18 @@ public AuthenticateIamPrincipal(final AuthenticationService authenticationServic
     public CompletableFuture<ResponseInfo<IamRoleAuthResponse>> execute(final RequestInfo<IamPrincipalCredentials> request,
                                                                         final Executor longRunningTaskExecutor,
                                                                         final ChannelHandlerContext ctx) {
-        return CompletableFuture.supplyAsync(() -> {
-            IamPrincipalCredentials credentials = request.getContent();
-            log.info("IAM Auth Event: the IAM principal {} in attempting to authenticate in region {}",
-                    credentials.getIamPrincipalArn(), credentials.getRegion());
+        return CompletableFuture.supplyAsync(
+                AsyncNettyHelper.supplierWithTracingAndMdc(() -> authenticate(request), ctx),
+                longRunningTaskExecutor
+        );
+    }
+
+    private ResponseInfo<IamRoleAuthResponse> authenticate(RequestInfo<IamPrincipalCredentials> request) {
+        IamPrincipalCredentials credentials = request.getContent();
+        log.info("IAM Auth Event: the IAM principal {} in attempting to authenticate in region {}",
+                credentials.getIamPrincipalArn(), credentials.getRegion());
 
-            return ResponseInfo.newBuilder(authenticationService.authenticate(request.getContent())).build();
-        }, longRunningTaskExecutor);
+        return ResponseInfo.newBuilder(authenticationService.authenticate(request.getContent())).build();
     }
 
     @Override

diff --git a/src/main/java/com/nike/cerberus/endpoints/authentication/AuthenticateIamRole.java b/src/main/java/com/nike/cerberus/endpoints/authentication/AuthenticateIamRole.java
@@ -23,6 +23,7 @@
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
 import com.nike.riposte.server.http.StandardEndpoint;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.HttpMethod;
@@ -53,15 +54,20 @@ public AuthenticateIamRole(final AuthenticationService authenticationService) {
     public CompletableFuture<ResponseInfo<IamRoleAuthResponse>> execute(final RequestInfo<IamRoleCredentials> request,
                                                                         final Executor longRunningTaskExecutor,
                                                                         final ChannelHandlerContext ctx) {
-        return CompletableFuture.supplyAsync(() -> {
-            IamRoleCredentials credentials = request.getContent();
-            log.info("IAM Auth Event: the IAM principal {} in attempting to authenticate in region {}",
-                    String.format(AwsIamRoleArnParser.AWS_IAM_ROLE_ARN_TEMPLATE,
-                            credentials.getAccountId(), credentials.getRoleName()), credentials.getRegion());
+        return CompletableFuture.supplyAsync(
+                AsyncNettyHelper.supplierWithTracingAndMdc(() -> authenticate(request), ctx),
+                longRunningTaskExecutor
+        );
 
-            return ResponseInfo.newBuilder(authenticationService.authenticate(request.getContent())).build();
-        }, longRunningTaskExecutor);
+    }
+
+    private ResponseInfo<IamRoleAuthResponse> authenticate(RequestInfo<IamRoleCredentials> request) {
+        IamRoleCredentials credentials = request.getContent();
+        log.info("IAM Auth Event: the IAM principal {} in attempting to authenticate in region {}",
+                String.format(AwsIamRoleArnParser.AWS_IAM_ROLE_ARN_TEMPLATE,
+                        credentials.getAccountId(), credentials.getRoleName()), credentials.getRegion());
 
+        return ResponseInfo.newBuilder(authenticationService.authenticate(request.getContent())).build();
     }
 
     @Override

diff --git a/src/main/java/com/nike/cerberus/endpoints/authentication/AuthenticateUser.java b/src/main/java/com/nike/cerberus/endpoints/authentication/AuthenticateUser.java
@@ -24,6 +24,7 @@
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
 import com.nike.riposte.server.http.StandardEndpoint;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.HttpMethod;
@@ -57,18 +58,19 @@ public CompletableFuture<ResponseInfo<AuthResponse>> execute(final RequestInfo<V
                                                                  final Executor longRunningTaskExecutor,
                                                                  final ChannelHandlerContext ctx) {
         return CompletableFuture.supplyAsync(
-                () -> {
-                    final UserCredentials credentials =
-                            extractCredentials(request.getHeaders().get(HttpHeaders.AUTHORIZATION));
-
-                    log.info("User Auth Event: the principal: {} is attempting to authenticate", credentials.getUsername());
-
-                    return ResponseInfo.newBuilder(authenticationService.authenticate(credentials)).build();
-                },
+                AsyncNettyHelper.supplierWithTracingAndMdc(() -> authenticate(request), ctx),
                 longRunningTaskExecutor
         );
     }
 
+    private ResponseInfo<AuthResponse> authenticate(RequestInfo<Void> request) {
+        final UserCredentials credentials = extractCredentials(request.getHeaders().get(HttpHeaders.AUTHORIZATION));
+
+        log.info("User Auth Event: the principal: {} is attempting to authenticate", credentials.getUsername());
+
+        return ResponseInfo.newBuilder(authenticationService.authenticate(credentials)).build();
+    }
+
     @Override
     public Matcher requestMatcher() {
         return Matcher.match("/v2/auth/user", HttpMethod.GET);

diff --git a/src/main/java/com/nike/cerberus/endpoints/authentication/MfaCheck.java b/src/main/java/com/nike/cerberus/endpoints/authentication/MfaCheck.java
@@ -22,6 +22,7 @@
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
 import com.nike.riposte.server.http.StandardEndpoint;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.HttpMethod;
@@ -47,7 +48,10 @@ public CompletableFuture<ResponseInfo<AuthResponse>> execute(final RequestInfo<M
                                                                  final Executor longRunningTaskExecutor,
                                                                  final ChannelHandlerContext ctx) {
         return CompletableFuture.supplyAsync(
-                () -> ResponseInfo.newBuilder(authenticationService.mfaCheck(request.getContent())).build(),
+                AsyncNettyHelper.supplierWithTracingAndMdc(
+                        () -> ResponseInfo.newBuilder(authenticationService.mfaCheck(request.getContent())).build(),
+                        ctx
+                ),
                 longRunningTaskExecutor
         );
     }

diff --git a/src/main/java/com/nike/cerberus/endpoints/authentication/RefreshUserToken.java b/src/main/java/com/nike/cerberus/endpoints/authentication/RefreshUserToken.java
@@ -25,6 +25,7 @@
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
 import com.nike.riposte.server.http.StandardEndpoint;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.HttpMethod;
@@ -53,10 +54,10 @@ public RefreshUserToken(final AuthenticationService authenticationService) {
 
     @Override
     public CompletableFuture<ResponseInfo<AuthResponse>> execute(final RequestInfo<Void> request,
-                                                                      final Executor longRunningTaskExecutor,
-                                                                      final ChannelHandlerContext ctx) {
+                                                                 final Executor longRunningTaskExecutor,
+                                                                 final ChannelHandlerContext ctx) {
         return CompletableFuture.supplyAsync(
-                () -> getRefreshedUserToken(request),
+                AsyncNettyHelper.supplierWithTracingAndMdc(() -> getRefreshedUserToken(request), ctx),
                 longRunningTaskExecutor
         );
     }

diff --git a/src/main/java/com/nike/cerberus/endpoints/authentication/RevokeToken.java b/src/main/java/com/nike/cerberus/endpoints/authentication/RevokeToken.java
@@ -24,6 +24,7 @@
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
 import com.nike.riposte.server.http.StandardEndpoint;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.HttpMethod;
@@ -55,7 +56,10 @@ public RevokeToken(final AuthenticationService authenticationService) {
     public CompletableFuture<ResponseInfo<Void>> execute(final RequestInfo<Void> request,
                                                          final Executor longRunningTaskExecutor,
                                                          final ChannelHandlerContext ctx) {
-        return CompletableFuture.supplyAsync(() -> revokeToken(request), longRunningTaskExecutor);
+        return CompletableFuture.supplyAsync(
+                AsyncNettyHelper.supplierWithTracingAndMdc(() -> revokeToken(request), ctx),
+                longRunningTaskExecutor
+        );
     }
 
     public ResponseInfo<Void> revokeToken(RequestInfo<Void> request) {

diff --git a/src/main/java/com/nike/cerberus/endpoints/category/CreateCategory.java b/src/main/java/com/nike/cerberus/endpoints/category/CreateCategory.java
@@ -23,6 +23,7 @@
 import com.nike.cerberus.service.CategoryService;
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.DefaultHttpHeaders;
@@ -53,11 +54,10 @@ public CreateCategory(final CategoryService categoryService) {
     public CompletableFuture<ResponseInfo<Void>> doExecute(final RequestInfo<Category> request,
                                                            final Executor longRunningTaskExecutor,
                                                            final ChannelHandlerContext ctx,
-                                                           final SecurityContext securityContext
-    ) {
+                                                           final SecurityContext securityContext) {
         return CompletableFuture.supplyAsync(
-            () -> createCategory(request.getContent(), securityContext, CATEGORY_PATH),
-            longRunningTaskExecutor
+                AsyncNettyHelper.supplierWithTracingAndMdc(() -> createCategory(request.getContent(), securityContext, CATEGORY_PATH), ctx),
+                longRunningTaskExecutor
         );
     }
 
@@ -71,8 +71,8 @@ public ResponseInfo<Void> createCategory(final Category category,
         final String id = categoryService.createCategory(category, securityContext.getUserPrincipal().getName());
         final String location = basePathNoId + "/" + id;
         return ResponseInfo.<Void>newBuilder().withHeaders(new DefaultHttpHeaders().set(LOCATION, location))
-                                              .withHttpStatusCode(201)
-                                              .build();
+                .withHttpStatusCode(201)
+                .build();
     }
 
     @Override

diff --git a/src/main/java/com/nike/cerberus/endpoints/category/DeleteCategory.java b/src/main/java/com/nike/cerberus/endpoints/category/DeleteCategory.java
@@ -20,6 +20,7 @@
 import com.nike.cerberus.service.CategoryService;
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.HttpMethod;
@@ -48,11 +49,10 @@ public DeleteCategory(final CategoryService categoryService) {
     public CompletableFuture<ResponseInfo<Void>> doExecute(final RequestInfo<Void> request,
                                                            final Executor longRunningTaskExecutor,
                                                            final ChannelHandlerContext ctx,
-                                                           final SecurityContext securityContext
-    ) {
+                                                           final SecurityContext securityContext) {
         return CompletableFuture.supplyAsync(
-            () -> deleteCategory(request.getPathParam(PATH_PARAM_ID)),
-            longRunningTaskExecutor
+                AsyncNettyHelper.supplierWithTracingAndMdc(() -> deleteCategory(request.getPathParam(PATH_PARAM_ID)), ctx),
+                longRunningTaskExecutor
         );
     }
 

diff --git a/src/main/java/com/nike/cerberus/endpoints/category/GetAllCategories.java b/src/main/java/com/nike/cerberus/endpoints/category/GetAllCategories.java
@@ -21,6 +21,7 @@
 import com.nike.riposte.server.http.RequestInfo;
 import com.nike.riposte.server.http.ResponseInfo;
 import com.nike.riposte.server.http.StandardEndpoint;
+import com.nike.riposte.util.AsyncNettyHelper;
 import com.nike.riposte.util.Matcher;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.handler.codec.http.HttpMethod;
@@ -43,12 +44,12 @@ public GetAllCategories(final CategoryService categoryService) {
     }
 
     @Override
-    public CompletableFuture<ResponseInfo<List<Category>>> execute(
-        RequestInfo<Void> request, Executor longRunningTaskExecutor, ChannelHandlerContext ctx
-    ) {
+    public CompletableFuture<ResponseInfo<List<Category>>> execute(RequestInfo<Void> request,
+                                                                   Executor longRunningTaskExecutor,
+                                                                   ChannelHandlerContext ctx) {
         return CompletableFuture.supplyAsync(
-            this::getAllCategories,
-            longRunningTaskExecutor
+                AsyncNettyHelper.supplierWithTracingAndMdc(this::getAllCategories, ctx),
+                longRunningTaskExecutor
         );
     }