From 8079d2531e561ad5dbbfe9e8dc4b818d694d57a6 Mon Sep 17 00:00:00 2001
From: Mark Payne <markap14@hotmail.com>
Date: Wed, 23 Oct 2019 20:14:35 -0400
Subject: [PATCH] NIFI-6805, NIFI-6806: Updated toString() of
 StandardControllerServiceNode so that it includes the component's type and
 UUID, updated the more generic Exception Mappers to include stack traces
 regardless of the log level that is enabled

This closes #3840

Signed-off-by: Mike Thomsen <mthomsen@apache.org>
---
 .../StandardControllerServiceNode.java        | 21 +++++++------------
 .../IllegalArgumentExceptionMapper.java       |  9 ++++----
 .../config/IllegalStateExceptionMapper.java   | 13 ++++--------
 .../api/config/NiFiCoreExceptionMapper.java   | 15 +++++--------
 .../config/WebApplicationExceptionMapper.java | 13 +++++-------
 5 files changed, 26 insertions(+), 45 deletions(-)

diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/service/StandardControllerServiceNode.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/service/StandardControllerServiceNode.java
index f2ce848ec5..1ce13c3837 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/service/StandardControllerServiceNode.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/service/StandardControllerServiceNode.java
@@ -420,9 +420,9 @@ public class StandardControllerServiceNode extends AbstractComponentNode impleme
 
                     final ValidationStatus validationStatus = getValidationStatus();
                     if (validationStatus != ValidationStatus.VALID) {
-                        LOG.debug("Cannot enable {} because it is not currently valid. Will try again in 5 seconds", StandardControllerServiceNode.this);
-                        scheduler.schedule(this, 5, TimeUnit.SECONDS);
-                        future.completeExceptionally(new ControllerServiceNotValidException(this + " cannot be enabled because it is not currently valid. Will try again in 5 seconds."));
+                        LOG.debug("Cannot enable {} because it is not currently valid. (Validation State is {}). Will try again in 1 second", StandardControllerServiceNode.this, getValidationState());
+                        scheduler.schedule(this, 1, TimeUnit.SECONDS);
+                        future.complete(null);
                         return;
                     }
 
@@ -569,19 +569,14 @@ public class StandardControllerServiceNode extends AbstractComponentNode impleme
 
     @Override
     public String toString() {
-        String bundleCoordinate;
-        try {
-            bundleCoordinate = controllerServiceHolder.get().getBundleCoordinate().toString();
-        } catch (NullPointerException e) {
-            bundleCoordinate = "null";
-        }
-        return "StandardControllerServiceNode{" +
-                "controllerServiceHolder=" + bundleCoordinate +
+        final ControllerServiceDetails details = controllerServiceHolder.get();
+        final String bundleCoordinate = details == null ? "null" : String.valueOf(details.getBundleCoordinate());
+        return "StandardControllerServiceNode[" +
+                "service=" + super.toString() +
                 ", versionedComponentId=" + versionedComponentId +
-                ", comment='" + comment + '\'' +
                 ", processGroup=" + processGroup +
                 ", active=" + active +
-                '}';
+                ']';
     }
 
     @Override
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/IllegalArgumentExceptionMapper.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/IllegalArgumentExceptionMapper.java
index e9edd8f092..5151a41f76 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/IllegalArgumentExceptionMapper.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/IllegalArgumentExceptionMapper.java
@@ -16,12 +16,12 @@
  */
 package org.apache.nifi.web.api.config;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import javax.ws.rs.core.Response;
 import javax.ws.rs.ext.ExceptionMapper;
 import javax.ws.rs.ext.Provider;
-import org.apache.nifi.util.StringUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * Maps web application exceptions into client responses.
@@ -34,8 +34,7 @@ public class IllegalArgumentExceptionMapper implements ExceptionMapper<IllegalAr
     @Override
     public Response toResponse(IllegalArgumentException exception) {
         // log the error
-        logger.info(String.format("%s. Returning %s response.", exception, Response.Status.BAD_REQUEST));
-        logger.debug(StringUtils.EMPTY, exception);
+        logger.info("{}}. Returning {}} response.", exception, Response.Status.BAD_REQUEST, exception);
 
         return Response.status(Response.Status.BAD_REQUEST).entity(exception.getMessage()).type("text/plain").build();
     }
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/IllegalStateExceptionMapper.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/IllegalStateExceptionMapper.java
index 2a116a7a37..482125993e 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/IllegalStateExceptionMapper.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/IllegalStateExceptionMapper.java
@@ -16,12 +16,12 @@
  */
 package org.apache.nifi.web.api.config;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import javax.ws.rs.core.Response;
 import javax.ws.rs.ext.ExceptionMapper;
 import javax.ws.rs.ext.Provider;
-import org.apache.nifi.util.StringUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * Maps web application exceptions into client responses.
@@ -34,12 +34,7 @@ public class IllegalStateExceptionMapper implements ExceptionMapper<IllegalState
     @Override
     public Response toResponse(IllegalStateException exception) {
         // log the error
-        logger.info(String.format("%s. Returning %s response.", exception, Response.Status.CONFLICT));
-
-        if (logger.isDebugEnabled()) {
-            logger.debug(StringUtils.EMPTY, exception);
-        }
-
+        logger.warn("{}. Returning {} response.", exception, Response.Status.CONFLICT, exception);
         return Response.status(Response.Status.CONFLICT).entity(exception.getMessage()).type("text/plain").build();
     }
 
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NiFiCoreExceptionMapper.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NiFiCoreExceptionMapper.java
index c084ea1de2..4b1880adb0 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NiFiCoreExceptionMapper.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NiFiCoreExceptionMapper.java
@@ -16,14 +16,14 @@
  */
 package org.apache.nifi.web.api.config;
 
-import javax.ws.rs.core.Response;
-import javax.ws.rs.ext.ExceptionMapper;
-import javax.ws.rs.ext.Provider;
-import org.apache.nifi.util.StringUtils;
 import org.apache.nifi.web.NiFiCoreException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import javax.ws.rs.core.Response;
+import javax.ws.rs.ext.ExceptionMapper;
+import javax.ws.rs.ext.Provider;
+
 /**
  * Maps NiFi core exceptions into client responses.
  */
@@ -35,12 +35,7 @@ public class NiFiCoreExceptionMapper implements ExceptionMapper<NiFiCoreExceptio
     @Override
     public Response toResponse(NiFiCoreException exception) {
         // log the error
-        logger.info(String.format("%s. Returning %s response.", exception, Response.Status.CONFLICT));
-
-        if (logger.isDebugEnabled()) {
-            logger.debug(StringUtils.EMPTY, exception);
-        }
-
+        logger.warn("{}. Returning {} response.", exception, Response.Status.CONFLICT, exception);
         return Response.status(Response.Status.CONFLICT).entity(exception.getMessage()).type("text/plain").build();
     }
 
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/WebApplicationExceptionMapper.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/WebApplicationExceptionMapper.java
index a961a0a040..0ae454029c 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/WebApplicationExceptionMapper.java
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/WebApplicationExceptionMapper.java
@@ -16,13 +16,14 @@
  */
 package org.apache.nifi.web.api.config;
 
+import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import javax.ws.rs.WebApplicationException;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.ext.ExceptionMapper;
 import javax.ws.rs.ext.Provider;
-import org.apache.commons.lang3.StringUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * Maps web application exceptions into client responses.
@@ -50,11 +51,7 @@ public class WebApplicationExceptionMapper implements ExceptionMapper<WebApplica
         final Response response = exception.getResponse();
 
         // log the error
-        logger.info(String.format("%s. Returning %s response.", exception, response.getStatus()));
-
-        if (logger.isDebugEnabled()) {
-            logger.debug(StringUtils.EMPTY, exception);
-        }
+        logger.warn("{}. Returning {} response.", exception, response.getStatus(), exception);
 
         // generate the response
         return Response.status(response.getStatus()).entity(message).type("text/plain").build();