Fix display (#88)

* Fix problems when not enough lines to display
* Fix out-of-order events that cause problems on the client the display
This commit is contained in:
Guillaume Nodet
2020-10-09 17:19:02 +02:00
committed by GitHub
parent c59623e393
commit f57105875e
6 changed files with 314 additions and 18 deletions

View File

@@ -0,0 +1,166 @@
/*
* Copyright 2019 the original author or authors.
*
* 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.
*/
package org.apache.maven.cli.logging;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
import org.codehaus.plexus.logging.Logger;
import org.jboss.fuse.mvnd.logging.smart.ProjectBuildLogAppender;
import org.slf4j.MDC;
/**
* Adapt an SLF4J logger to a Plexus logger, ignoring Plexus logger API parts that are not classical and
* probably not really used.
*
* <p>
* Adapted from https://github.com/apache/maven/blob/maven-3.6.3/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLogger.java
*
* @author Jason van Zyl
*/
public class Slf4jLogger
implements Logger {
private static final ThreadLocal<String> PROJECT_ID = new ThreadLocal<>();
private org.slf4j.Logger logger;
private String projectId;
public Slf4jLogger(org.slf4j.Logger logger) {
this.logger = logger;
this.projectId = PROJECT_ID.get();
}
public static void setCurrentProject(String projectId) {
PROJECT_ID.set(projectId);
}
public void debug(String message) {
setMdc();
logger.debug(message);
}
public void debug(String message, Throwable throwable) {
setMdc();
logger.debug(message, throwable);
}
public boolean isDebugEnabled() {
return logger.isDebugEnabled();
}
public void info(String message) {
setMdc();
logger.info(message);
}
public void info(String message, Throwable throwable) {
setMdc();
logger.info(message, throwable);
}
public boolean isInfoEnabled() {
return logger.isInfoEnabled();
}
public void warn(String message) {
setMdc();
logger.warn(message);
}
public void warn(String message, Throwable throwable) {
setMdc();
logger.warn(message, throwable);
}
public boolean isWarnEnabled() {
return logger.isWarnEnabled();
}
public void error(String message) {
setMdc();
logger.error(message);
}
public void error(String message, Throwable throwable) {
setMdc();
logger.error(message, throwable);
}
public boolean isErrorEnabled() {
return logger.isErrorEnabled();
}
public void fatalError(String message) {
setMdc();
logger.error(message);
}
public void fatalError(String message, Throwable throwable) {
setMdc();
logger.error(message, throwable);
}
public boolean isFatalErrorEnabled() {
return logger.isErrorEnabled();
}
/**
* <b>Warning</b>: ignored (always return <code>0 == Logger.LEVEL_DEBUG</code>).
*/
public int getThreshold() {
return 0;
}
/**
* <b>Warning</b>: ignored.
*/
public void setThreshold(int threshold) {
}
/**
* <b>Warning</b>: ignored (always return <code>null</code>).
*/
public Logger getChildLogger(String name) {
return null;
}
public String getName() {
return logger.getName();
}
private void setMdc() {
if (projectId != null) {
MDC.put(ProjectBuildLogAppender.KEY_PROJECT_ID, projectId);
}
}
}

View File

@@ -0,0 +1,117 @@
/*
* Copyright 2019 the original author or authors.
*
* 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.
*/
package org.apache.maven.cli.logging;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
import org.codehaus.plexus.logging.Logger;
import org.codehaus.plexus.logging.LoggerManager;
import org.slf4j.ILoggerFactory;
import org.slf4j.LoggerFactory;
/**
* Use an SLF4J {@link ILoggerFactory} as a backing for a Plexus
* {@link LoggerManager},
* ignoring Plexus logger API parts that are not classical and probably not really used.
*
* <p>
* Adapted from https://github.com/apache/maven/blob/maven-3.6.3/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLoggerManager.java
*
* @author Jason van Zyl
*/
public class Slf4jLoggerManager
implements LoggerManager {
private ILoggerFactory loggerFactory;
public Slf4jLoggerManager() {
loggerFactory = LoggerFactory.getILoggerFactory();
}
public Logger getLoggerForComponent(String role) {
return new Slf4jLogger(loggerFactory.getLogger(role));
}
/**
* The logger name for a component with a non-null hint is <code>role.hint</code>.
* <b>Warning</b>: this does not conform to logger name as class name convention.
* (and what about <code>null</code> and <code>default</code> hint equivalence?)
*/
public Logger getLoggerForComponent(String role, String hint) {
return (null == hint
? getLoggerForComponent(role)
: new Slf4jLogger(loggerFactory.getLogger(role + '.' + hint)));
}
//
// Trying to give loggers back is a bad idea. Ceki said so :-)
// notice to self: what was this method supposed to do?
//
/**
* <b>Warning</b>: ignored.
*/
public void returnComponentLogger(String role) {
}
/**
* <b>Warning</b>: ignored.
*/
public void returnComponentLogger(String role, String hint) {
}
/**
* <b>Warning</b>: ignored (always return <code>0</code>).
*/
public int getThreshold() {
return 0;
}
/**
* <b>Warning</b>: ignored.
*/
public void setThreshold(int threshold) {
}
/**
* <b>Warning</b>: ignored.
*/
public void setThresholds(int threshold) {
}
/**
* <b>Warning</b>: ignored (always return <code>0</code>).
*/
public int getActiveLoggerCount() {
return 0;
}
}

View File

@@ -439,11 +439,8 @@ public class Server implements AutoCloseable, Runnable {
int getClassOrder(Message m) {
if (m instanceof BuildRequest) {
return 0;
} else if (m instanceof BuildEvent) {
BuildEvent be = (BuildEvent) m;
return be.getType() == Type.BuildStopped ? 98 : 1;
} else if (m instanceof BuildMessage) {
return 2;
} else if (m instanceof BuildEvent || m instanceof BuildMessage) {
return 1;
} else if (m instanceof BuildException) {
return 97;
} else if (m == STOP) {

View File

@@ -17,6 +17,7 @@ package org.jboss.fuse.mvnd.logging.smart;
import java.util.List;
import java.util.Map;
import org.apache.maven.cli.logging.Slf4jLogger;
import org.apache.maven.eventspy.AbstractEventSpy;
import org.apache.maven.execution.ExecutionEvent;
import org.apache.maven.plugin.MojoExecution;
@@ -115,19 +116,24 @@ public abstract class AbstractLoggingSpy extends AbstractEventSpy {
}
protected void onStopProject(String projectId, String display) {
MDC.put(KEY_PROJECT_ID, projectId);
update();
MDC.remove(KEY_PROJECT_ID);
}
protected void onStartMojo(String projectId, String display) {
Slf4jLogger.setCurrentProject(projectId);
MDC.put(KEY_PROJECT_ID, projectId);
update();
}
protected void onStopMojo(String projectId, String display) {
MDC.put(KEY_PROJECT_ID, projectId);
update();
}
protected void onProjectLog(String projectId, String message) {
MDC.put(KEY_PROJECT_ID, projectId);
update();
}