Skip to content

Commit

Permalink
NIFI-12076 Removed ComponentLog methods with Object[] and Throwable
Browse files Browse the repository at this point in the history 
This closes apache#7759

Signed-off-by: David Handermann <[email protected]>
  • Loading branch information
@turcsanyip @exceptionfactory
turcsanyip authored and exceptionfactory committed Sep 19, 2023
1 parent e281d13 commit 520840d
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 562 deletions.
30 changes: 0 additions & 30 deletions nifi-api/src/main/java/org/apache/nifi/documentation/init/NopComponentLog.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,6 @@ public void warn(final String msg, final Object... os) {

}

@Override
public void warn(final String msg, final Object[] os, final Throwable t) {

}

@Override
public void warn(final String msg) {

Expand All @@ -61,11 +56,6 @@ public void trace(final String msg) {

}

@Override
public void trace(final String msg, final Object[] os, final Throwable t) {

}

@Override
public void trace(LogMessage logMessage) {

Expand Down Expand Up @@ -111,11 +101,6 @@ public void info(final String msg) {

}

@Override
public void info(final String msg, final Object[] os, final Throwable t) {

}

@Override
public void info(LogMessage message) {

Expand All @@ -141,11 +126,6 @@ public void error(final String msg) {

}

@Override
public void error(final String msg, final Object[] os, final Throwable t) {

}

@Override
public void error(LogMessage message) {

Expand All @@ -161,11 +141,6 @@ public void debug(final String msg, final Object... os) {

}

@Override
public void debug(final String msg, final Object[] os, final Throwable t) {

}

@Override
public void debug(final String msg) {

Expand All @@ -191,11 +166,6 @@ public void log(final LogLevel level, final String msg) {

}

@Override
public void log(final LogLevel level, final String msg, final Object[] os, final Throwable t) {

}

@Override
public void log(LogMessage message) {

Expand Down
42 changes: 4 additions & 38 deletions nifi-api/src/main/java/org/apache/nifi/logging/ComponentLog.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,6 @@ public interface ComponentLog {

void warn(String msg, Object... os);

@Deprecated
void warn(String msg, Object[] os, Throwable t);

void warn(String msg);

default void warn(LogMessage logMessage) {
Expand All @@ -68,9 +65,6 @@ default void warn(LogMessage logMessage) {

void trace(String msg);

@Deprecated
void trace(String msg, Object[] os, Throwable t);

default void trace(LogMessage logMessage) {
log(LogLevel.TRACE, logMessage);
}
Expand All @@ -91,9 +85,6 @@ default void trace(LogMessage logMessage) {

void info(String msg);

@Deprecated
void info(String msg, Object[] os, Throwable t);

default void info(LogMessage logMessage) {
log(LogLevel.INFO, logMessage);
}
Expand All @@ -106,9 +97,6 @@ default void info(LogMessage logMessage) {

void error(String msg);

@Deprecated
void error(String msg, Object[] os, Throwable t);

default void error(LogMessage logMessage) {
log(LogLevel.ERROR, logMessage);
}
Expand All @@ -117,9 +105,6 @@ default void error(LogMessage logMessage) {

void debug(String msg, Object... os);

@Deprecated
void debug(String msg, Object[] os, Throwable t);

void debug(String msg);

default void debug(LogMessage logMessage) {
Expand Down Expand Up @@ -189,28 +174,6 @@ default void log(LogLevel level, String msg) {
}
}

@Deprecated
default void log(LogLevel level, String msg, Object[] os, Throwable t) {
switch (level) {
case DEBUG:
debug(msg, os, t);
break;
case ERROR:
case FATAL:
error(msg, os, t);
break;
case INFO:
info(msg, os, t);
break;
case TRACE:
trace(msg, os, t);
break;
case WARN:
warn(msg, os, t);
break;
}
}

default void log(LogMessage message) {
switch (message.getLogLevel()) {
case DEBUG:
Expand Down Expand Up @@ -238,7 +201,10 @@ default void log(LogLevel level, LogMessage logMessage) {
Object[] os = logMessage.getObjects();

if (os != null && t != null) {
log(level, msg, os, t);
Object[] ost = new Object[os.length + 1];
System.arraycopy(os, 0, ost, 0, os.length);
ost[ost.length - 1] = t;
log(level, msg, ost);
} else if (os != null) {
log(level, msg, os);
} else if (t != null) {
Expand Down
137 changes: 47 additions & 90 deletions nifi-mock/src/main/java/org/apache/nifi/util/MockComponentLog.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,27 +71,19 @@ private Object[] addProcessor(final Object[] originalArgs) {
return prependToArgs(originalArgs, component);
}

private Object[] addProcessorAndThrowable(final Object[] os, final Throwable t) {
final Object[] modifiedArgs = new Object[os.length + 2];
modifiedArgs[0] = component.toString();
System.arraycopy(os, 0, modifiedArgs, 1, os.length);
modifiedArgs[modifiedArgs.length - 1] = t.toString();
private Object[] addProcessorAndFormattedThrowable(final Object[] originalArgs) {
if (originalArgs != null && originalArgs.length > 0 && (originalArgs[originalArgs.length - 1] instanceof Throwable)) {
final Object[] modifiedArgs = new Object[originalArgs.length + 2];

return modifiedArgs;
}
modifiedArgs[0] = component.toString();
System.arraycopy(originalArgs, 0, modifiedArgs, 1, originalArgs.length - 1);
modifiedArgs[modifiedArgs.length - 2] = originalArgs[originalArgs.length - 1].toString();
modifiedArgs[modifiedArgs.length - 1] = originalArgs[originalArgs.length - 1];

private Object[] addProcessorAndThrowable(final Object[] os, final Throwable t, final boolean appendThrowable) {
if (!appendThrowable) {
return addProcessorAndThrowable(os, t);
return modifiedArgs;
} else {
return addProcessor(originalArgs);
}

final Object[] modifiedArgs = new Object[os.length + 3];
modifiedArgs[0] = component.toString();
System.arraycopy(os, 0, modifiedArgs, 1, os.length);
modifiedArgs[modifiedArgs.length - 2] = t.toString();
modifiedArgs[modifiedArgs.length - 1] = t;

return modifiedArgs;
}

private Object[] prependToArgs(final Object[] originalArgs, final Object... toAdd) {
Expand All @@ -101,47 +93,29 @@ private Object[] prependToArgs(final Object[] originalArgs, final Object... toAd
return newArgs;
}

private Object[] translateException(final Object[] os) {
if (os != null && os.length > 0 && (os[os.length - 1] instanceof Throwable)) {
final Object[] osCopy = new Object[os.length];
osCopy[osCopy.length - 1] = os[os.length - 1].toString();
System.arraycopy(os, 0, osCopy, 0, os.length - 1);
return osCopy;
}
return os;
}

private boolean lastArgIsException(final Object[] os) {
return (os != null && os.length > 0 && (os[os.length - 1] instanceof Throwable));
}

@Override
public void warn(final String msg, final Throwable t) {
warn("{} " + msg, new Object[]{component}, t);
warn("{} " + msg, component, t);
}

@Override
public void warn(String msg, Object... os) {
if (lastArgIsException(os)) {
warn(msg, translateException(os), (Throwable) os[os.length - 1]);
os = addProcessorAndFormattedThrowable(os);
msg = "{} " + msg + ": {}";

logger.warn(msg, os);
} else {
msg = "{} " + msg;
os = addProcessor(os);
msg = "{} " + msg;
logger.warn(msg, os);
}
}

@Override
public void warn(String msg, Object[] os, final Throwable t) {
os = addProcessorAndThrowable(os, t);
msg = "{} " + msg + ": {}";

logger.warn(msg, os);
if (logger.isDebugEnabled()) {
logger.warn("", t);
}
}

@Override
public void warn(String msg) {
msg = "{} " + msg;
Expand All @@ -157,9 +131,16 @@ public void trace(String msg, Throwable t) {

@Override
public void trace(String msg, Object... os) {
msg = "{} " + msg;
os = addProcessor(os);
logger.trace(msg, os);
if (lastArgIsException(os)) {
os = addProcessorAndFormattedThrowable(os);
msg = "{} " + msg + ": {}";

logger.trace(msg, os);
} else {
os = addProcessor(os);
msg = "{} " + msg;
logger.trace(msg, os);
}
}

@Override
Expand All @@ -169,15 +150,6 @@ public void trace(String msg) {
logger.trace(msg, os);
}

@Override
public void trace(String msg, Object[] os, Throwable t) {
os = addProcessorAndThrowable(os, t);
msg = "{} " + msg + ": {}";

logger.trace(msg, os);
logger.trace("", t);
}

@Override
public boolean isWarnEnabled() {
return logger.isWarnEnabled();
Expand Down Expand Up @@ -216,10 +188,16 @@ public void info(String msg, Throwable t) {

@Override
public void info(String msg, Object... os) {
msg = "{} " + msg;
os = addProcessor(os);
if (lastArgIsException(os)) {
os = addProcessorAndFormattedThrowable(os);
msg = "{} " + msg + ": {}";

logger.info(msg, os);
logger.info(msg, os);
} else {
os = addProcessor(os);
msg = "{} " + msg;
logger.info(msg, os);
}
}

@Override
Expand All @@ -230,17 +208,6 @@ public void info(String msg) {
logger.info(msg, os);
}

@Override
public void info(String msg, Object[] os, Throwable t) {
os = addProcessorAndThrowable(os, t);
msg = "{} " + msg + ": {}";

logger.info(msg, os);
if (logger.isDebugEnabled()) {
logger.info("", t);
}
}

@Override
public String getName() {
return logger.getName();
Expand All @@ -260,7 +227,10 @@ public void error(String msg, Throwable t) {
@Override
public void error(String msg, Object... os) {
if (lastArgIsException(os)) {
error(msg, translateException(os), (Throwable) os[os.length - 1]);
os = addProcessorAndFormattedThrowable(os);
msg = "{} " + msg + ": {}";

logger.error(msg, os);
} else {
os = addProcessor(os);
msg = "{} " + msg;
Expand All @@ -276,14 +246,6 @@ public void error(String msg) {
logger.error(msg, os);
}

@Override
public void error(String msg, Object[] os, Throwable t) {
os = addProcessorAndThrowable(os, t, true);
msg = "{} " + msg + ": {}";

logger.error(msg, os);
}

@Override
public void debug(String msg, Throwable t) {
msg = "{} " + msg;
Expand All @@ -294,20 +256,15 @@ public void debug(String msg, Throwable t) {

@Override
public void debug(String msg, Object... os) {
os = addProcessor(os);
msg = "{} " + msg;

logger.debug(msg, os);
}

@Override
public void debug(String msg, Object[] os, Throwable t) {
os = addProcessorAndThrowable(os, t);
msg = "{} " + msg + ": {}";
if (lastArgIsException(os)) {
os = addProcessorAndFormattedThrowable(os);
msg = "{} " + msg + ": {}";

logger.debug(msg, os);
if (logger.isDebugEnabled()) {
logger.debug("", t);
logger.debug(msg, os);
} else {
os = addProcessor(os);
msg = "{} " + msg;
logger.debug(msg, os);
}
}

Expand Down
Loading

0 comments on commit 520840d

Please sign in to comment.