[
https://issues.apache.org/jira/browse/JAMES-2171?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16732774#comment-16732774
]
ASF GitHub Bot commented on JAMES-2171:
---------------------------------------
Github user chibenwa commented on a diff in the pull request:
https://github.com/apache/james-project/pull/145#discussion_r244937449
--- Diff:
mailet/standard/src/main/java/org/apache/james/transport/mailets/LogMessage.java
---
@@ -86,12 +103,27 @@ public String getMailetInfo() {
@Override
public void service(Mail mail) {
- logger.info("Logging mail {}", mail.getName());
- logComment();
+ StringBuilder logs = new StringBuilder();
+ logs.append(logComment());
try {
- MimeMessage message = mail.getMessage();
- logHeaders(message);
- logBody(message);
+ logs.append(logHeaders(mail) + logBody(mail) +
logAttribute(mail));
+ switch (logLevel) {
--- End diff --
I would suggest extracting this siwttch case to ease the reading of this
method.
We can define a `LogWriter` interface:
```
private interface LogWritter extends BiConsumer<Logger, String> {}
```
Then a `selectLogWritter` method can be introduced:
```
private LogWritter selectlogWritter(LogLevel logLevel) {
switch(logLevel) {
case INFO:
return (logger, message) -> logger.info(message);
// etc..
}
}
```
The code here then become:
```
selectLogWritter(logLevel).apply(logger, logs.toString));
```
Rational: long methods is a code smell pointing out a piece of code have
too much responsibilities.
Extracting shorter methods helps clearly dispatching these responsibilies.
> LogMessage mailet improvments
> -----------------------------
>
> Key: JAMES-2171
> URL: https://issues.apache.org/jira/browse/JAMES-2171
> Project: James Server
> Issue Type: Improvement
> Components: Mailet Contributions
> Affects Versions: master
> Reporter: Tellier Benoit
> Priority: Major
> Labels: easyfix, newbie
>
> Today, one can use the LogMessage to generate log messages upon mail reception
> But the LogMessage have the following limits:
> - It do not let you configure the warn level
> - It does generate several logs. One would be simpler to review.
> - It does add some unneeded informations, like mail name already carried by
> the MDC
> - It does not allow logging of specific headers or specific attributeNames.
> This leads to missing information as well as "to much information".
> - The code quality of the mailet is poor.
> You will:
> - Ensure a single log message will be generated. For this you will call the
> logger one time and concatenate log messages parts.
> - Remove the log line with mail name.
> - Add a **level** configuration option. It can takes value **warn**,
> **info**, **debug** or **error**. It will be used to set the logger log level.
> - Add a **specificHeaders** configuration option. It takes a comma separated
> list of header names to include in the log message. By default it is empty.
> - Add a **specificAttributes** configuration option. It takes a comma
> separated list of attribute names to be included in the log message. By
> default it is empty.
> - **body** configuration option should be false by default
> - **header** configuration option should be false by default
> - **init** should propagate exception while initilizing (Integer parse
> exception, also passing a negative max body should throw.)
> - Remove inlined affectation for field. They can be unset on their
> declaration and set when init is called.
> Correct *LogMessageTest* accordingly.
> Don't hesitate to reach us on the *gitter* chat if you have any question.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
