From c2c680f932c6b4ed2eb622af8c7a9961afa466dd Mon Sep 17 00:00:00 2001 From: Ittay Stern Date: Mon, 26 Aug 2019 20:39:37 +0300 Subject: Log request-id even when no HttpServletRequest param or no user-session 1. Catch controllers under org.onap.vid.controller.open. 2. Get HttpServletRequest from Spring's context, if needed. 3. Fix the way SetRequestBasedDefaultsIntoGlobalLoggingContext is used. Change-Id: Iecd46dc10a458bc20d4b3e0bd72ecae37e3218cf Issue-ID: VID-598 Signed-off-by: Ittay Stern --- .../java/org/onap/vid/logging/VidLoggerAspect.java | 84 +++++++++++++++++++--- .../org/onap/vid/logging/VidLoggerAspectTest.java | 43 ----------- 2 files changed, 74 insertions(+), 53 deletions(-) delete mode 100644 vid-app-common/src/test/java/org/onap/vid/logging/VidLoggerAspectTest.java diff --git a/vid-app-common/src/main/java/org/onap/vid/logging/VidLoggerAspect.java b/vid-app-common/src/main/java/org/onap/vid/logging/VidLoggerAspect.java index 514779f49..309ead40c 100644 --- a/vid-app-common/src/main/java/org/onap/vid/logging/VidLoggerAspect.java +++ b/vid-app-common/src/main/java/org/onap/vid/logging/VidLoggerAspect.java @@ -20,6 +20,13 @@ package org.onap.vid.logging; +import static com.att.eelf.configuration.Configuration.MDC_SERVER_FQDN; +import static org.apache.commons.lang3.StringUtils.defaultIfEmpty; + +import java.net.InetAddress; +import java.net.UnknownHostException; +import java.util.Arrays; +import javax.servlet.http.HttpServletRequest; import org.apache.commons.lang3.StringUtils; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; @@ -27,13 +34,14 @@ import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.onap.portalsdk.core.logging.aspect.EELFLoggerAdvice; import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate; +import org.onap.portalsdk.core.service.AppService; import org.onap.portalsdk.core.util.SystemProperties; +import org.onap.portalsdk.core.web.support.UserUtils; +import org.onap.vid.controller.ControllersUtils; +import org.onap.vid.utils.SystemPropertiesWrapper; import org.springframework.beans.factory.annotation.Autowired; - -import java.net.InetAddress; -import java.net.UnknownHostException; - -import static com.att.eelf.configuration.Configuration.MDC_SERVER_FQDN; +import org.springframework.web.context.request.RequestContextHolder; +import org.springframework.web.context.request.ServletRequestAttributes; @Aspect @@ -41,10 +49,14 @@ import static com.att.eelf.configuration.Configuration.MDC_SERVER_FQDN; public class VidLoggerAspect { private String canonicalHostName; - @Autowired - EELFLoggerAdvice advice; + private final ControllersUtils controllersUtils; + private final String appName; + + private final EELFLoggerAdvice advice; - public VidLoggerAspect() { + @Autowired + public VidLoggerAspect(EELFLoggerAdvice advice, SystemPropertiesWrapper systemPropertiesWrapper, + AppService appService) { try { final InetAddress localHost = InetAddress.getLocalHost(); canonicalHostName = localHost.getCanonicalHostName(); @@ -52,9 +64,13 @@ public class VidLoggerAspect { // YOLO canonicalHostName = null; } + this.advice = advice; + this.controllersUtils = new ControllersUtils(systemPropertiesWrapper); + + this.appName = defaultIfEmpty(appService.getDefaultAppName(), SystemProperties.SDK_NAME); } - @Pointcut("execution(public * org.onap.vid.controller.*Controller.*(..))") + @Pointcut("execution(public * org.onap.vid.controller..*Controller.*(..))") public void vidControllers() {} @Around("vidControllers() && (" + @@ -69,7 +85,10 @@ public class VidLoggerAspect { private Object logAroundMethod(ProceedingJoinPoint joinPoint, SystemProperties.SecurityEventTypeEnum securityEventType) throws Throwable { //Before Object[] passOnArgs = new Object[] {joinPoint.getSignature().getDeclaringType().getName(),joinPoint.getSignature().getName()}; - Object[] returnArgs = advice.before(securityEventType, joinPoint.getArgs(), passOnArgs); + Object[] returnArgs = advice.before(securityEventType, fabricateArgsWithNull(), passOnArgs); + + fixSetRequestBasedDefaultsIntoGlobalLoggingContext(httpServletRequestOrNull(joinPoint), + joinPoint.getSignature().getDeclaringType().getName()); fixServerFqdnInMDC(); @@ -94,6 +113,51 @@ public class VidLoggerAspect { EELFLoggerDelegate.mdcPut(SystemProperties.STATUS_CODE, restStatus); } + /** + * Returns an array with a single entry with a null value. This will stop org.onap.portalsdk.core.logging.aspect.EELFLoggerAdvice.before + * from throwing on ArrayIndexOutOfBound, and also prevent SessionExpiredException. + */ + private Object[] fabricateArgsWithNull() { + return new Object[]{null}; + } + + /** + * Finds the first joinPoint's param which is an HttpServletRequest. If not found, use Spring's RequestContextHolder + * to retrieve it. + * + * @return null or the current httpServletRequest + */ + private HttpServletRequest httpServletRequestOrNull(ProceedingJoinPoint joinPoint) { + final Object httpServletRequest = Arrays.stream(joinPoint.getArgs()) + .filter(param -> param instanceof HttpServletRequest) + .findFirst() + .orElseGet(() -> { + try { + return ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest(); + } catch (Exception e) { // ClassCast, IllegalState, etc. + return null; + } + }); + + return (HttpServletRequest) httpServletRequest; + } + + /** + * Mimics a part from org.onap.portalsdk.core.logging.aspect.EELFLoggerAdvice.before, but with much more carefulness + * of exceptions and defaults. Main difference is that if no session, function does not throw. It just fallback to + * an empty loginId. + */ + private void fixSetRequestBasedDefaultsIntoGlobalLoggingContext(HttpServletRequest httpServletRequest, String className) { + if (httpServletRequest != null) { + + EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(className); + String requestId = UserUtils.getRequestId(httpServletRequest); + String loginId = controllersUtils.extractUserId(httpServletRequest); + + logger.setRequestBasedDefaultsIntoGlobalLoggingContext(httpServletRequest, appName, requestId, loginId); + } + } + // Override the non-canonical hostname set by EELFLoggerDelegate::setGlobalLoggingContext() // that was invoked by advice.before() (and some other SDK cases) private void fixServerFqdnInMDC() { diff --git a/vid-app-common/src/test/java/org/onap/vid/logging/VidLoggerAspectTest.java b/vid-app-common/src/test/java/org/onap/vid/logging/VidLoggerAspectTest.java deleted file mode 100644 index 82f0b85ba..000000000 --- a/vid-app-common/src/test/java/org/onap/vid/logging/VidLoggerAspectTest.java +++ /dev/null @@ -1,43 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * VID - * ================================================================================ - * Copyright (C) 2017 - 2019 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============LICENSE_END========================================================= - */ - -package org.onap.vid.logging; - -import org.aspectj.lang.ProceedingJoinPoint; -import org.junit.Test; -import org.onap.portalsdk.core.util.SystemProperties.SecurityEventTypeEnum; - - -public class VidLoggerAspectTest { - - private VidLoggerAspect createTestSubject() { - return new VidLoggerAspect(); - } - - @Test - public void testVidControllers() throws Exception { - VidLoggerAspect testSubject; - - // default test - testSubject = createTestSubject(); - testSubject.vidControllers(); - } - -} -- cgit 1.2.3-korg