You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2024/04/19 13:57:32 UTC
(maven-site-plugin) branch MSITE-1006 updated (337f4525 -> 2a34e8a6)
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a change to branch MSITE-1006
in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git
discard 337f4525 Fix exception message
discard bc035197 Magic
discard 4c160ac5 Foo
new 2a34e8a6 [MSITE-1006] MSITE-723 causes duplicate document rendering and log output
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (337f4525)
\
N -- N -- N refs/heads/MSITE-1006 (2a34e8a6)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
(maven-site-plugin) 01/01: [MSITE-1006] MSITE-723 causes duplicate document rendering and log output
Posted by mi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch MSITE-1006
in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git
commit 2a34e8a6b8808971c7b18a8e22c93718afa68dd9
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Thu Apr 18 21:02:42 2024 +0200
[MSITE-1006] MSITE-723 causes duplicate document rendering and log output
---
pom.xml | 4 +-
.../site/render/AbstractSiteRenderingMojo.java | 9 ++-
.../apache/maven/plugins/site/render/SiteMojo.java | 92 ++++++++++++----------
.../apache/maven/plugins/site/run/DoxiaBean.java | 15 +---
.../apache/maven/plugins/site/run/DoxiaFilter.java | 22 ------
.../apache/maven/plugins/site/run/SiteRunMojo.java | 12 +--
6 files changed, 62 insertions(+), 92 deletions(-)
diff --git a/pom.xml b/pom.xml
index 2d9b24e7..b9f49b47 100644
--- a/pom.xml
+++ b/pom.xml
@@ -198,8 +198,8 @@ under the License.
<javaVersion>8</javaVersion>
<!-- for dependencies -->
<jettyVersion>9.4.53.v20231009</jettyVersion>
- <doxiaVersion>2.0.0-M8</doxiaVersion>
- <doxiaSitetoolsVersion>2.0.0-M16</doxiaSitetoolsVersion>
+ <doxiaVersion>2.0.0-M10</doxiaVersion>
+ <doxiaSitetoolsVersion>2.0.0-M18-SNAPSHOT</doxiaSitetoolsVersion>
<wagonVersion>3.5.3</wagonVersion>
<slf4jVersion>1.7.36</slf4jVersion>
<!-- for ITs -->
diff --git a/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java b/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
index 8906cbc8..c74ab234 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
@@ -40,6 +40,7 @@ import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
import org.apache.maven.doxia.siterenderer.RendererException;
import org.apache.maven.doxia.siterenderer.SiteRenderer;
import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
+import org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory;
import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.doxia.tools.SiteToolException;
import org.apache.maven.execution.MavenSession;
@@ -312,9 +313,11 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
// Generate static site
context.setRootDirectory(project.getBasedir());
if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
- context.addSiteDirectory(new File(siteDirectory, locale.toString()));
+ context.addSiteDirectory(new SiteDirectory(new File(siteDirectory, locale.toString()), true));
+ context.addSiteDirectory(new SiteDirectory(new File(generatedSiteDirectory, locale.toString()), false));
} else {
- context.addSiteDirectory(siteDirectory);
+ context.addSiteDirectory(new SiteDirectory(siteDirectory, true));
+ context.addSiteDirectory(new SiteDirectory(generatedSiteDirectory, false));
}
if (moduleExcludes != null) {
@@ -425,7 +428,7 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
protected Map<String, DocumentRenderer> locateDocuments(
SiteRenderingContext context, List<MavenReportExecution> reports, Locale locale)
throws IOException, RendererException {
- Map<String, DocumentRenderer> documents = siteRenderer.locateDocumentFiles(context, true);
+ Map<String, DocumentRenderer> documents = siteRenderer.locateDocumentFiles(context);
Map<String, MavenReport> reportsByOutputName = locateReports(reports, documents, locale);
diff --git a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
index 7b261ac7..5a787b06 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
@@ -21,6 +21,7 @@ package org.apache.maven.plugins.site.render;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
+import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
@@ -114,7 +115,7 @@ public class SiteMojo extends AbstractSiteRenderingMojo {
// issue caused by report, not really by Doxia Site Renderer
throw new MojoExecutionException(e.getMessage(), e.getCause());
}
- throw new MojoExecutionException("Failed to render reports", e);
+ throw new MojoExecutionException("Failed to render site", e);
} catch (IOException e) {
throw new MojoExecutionException("Error during site generation", e);
}
@@ -125,12 +126,6 @@ public class SiteMojo extends AbstractSiteRenderingMojo {
throws IOException, RendererException, MojoFailureException, MojoExecutionException {
SiteRenderingContext context = createSiteRenderingContext(locale);
context.addSiteLocales(supportedLocales);
- if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
- context.addSiteDirectory(new File(generatedSiteDirectory, locale.toString()));
- } else {
- context.addSiteDirectory(generatedSiteDirectory);
- }
-
context.setInputEncoding(getInputEncoding());
context.setOutputEncoding(getOutputEncoding());
context.setValidate(validate);
@@ -138,32 +133,17 @@ public class SiteMojo extends AbstractSiteRenderingMojo {
getLog().info("Validation is switched on, xml input documents will be validated!");
}
+ // locate all Doxia documents first
Map<String, DocumentRenderer> documents = locateDocuments(context, reports, locale);
// copy resources
siteRenderer.copyResources(context, outputDirectory);
- // 1. render Doxia documents first
- List<DocumentRenderer> nonDoxiaDocuments = renderDoxiaDocuments(documents, context, outputDirectory, false);
+ // and finally render Doxia documents
+ List<DocumentRenderer> nonDoxiaDocuments = renderDoxiaDocuments(documents.values(), context, outputDirectory);
- // 2. then non-Doxia documents (e.g., reports)
+ // then non-Doxia documents (e.g. reports)
renderNonDoxiaDocuments(nonDoxiaDocuments, context, outputDirectory);
-
- // 3. Generated docs must be (re-)done afterwards as they are often generated by reports
- context.getSiteDirectories().clear();
- if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
- context.addSiteDirectory(new File(generatedSiteDirectory, locale.toString()));
- } else {
- context.addSiteDirectory(generatedSiteDirectory);
- }
-
- Map<String, DocumentRenderer> generatedDocuments =
- siteRenderer.locateDocumentFiles(context, false /* not editable */);
-
- renderDoxiaDocuments(generatedDocuments, context, outputDirectory, true);
-
- // copy generated resources also
- siteRenderer.copyResources(context, outputDirectory);
}
/**
@@ -173,33 +153,43 @@ public class SiteMojo extends AbstractSiteRenderingMojo {
* @return the sublist of documents that are not Doxia source files
*/
private List<DocumentRenderer> renderDoxiaDocuments(
- Map<String, DocumentRenderer> documents,
+ Collection<DocumentRenderer> documents,
SiteRenderingContext context,
- File outputDirectory,
- boolean generated)
+ File outputDirectory)
throws RendererException, IOException {
- Map<String, DocumentRenderer> doxiaDocuments = new TreeMap<>();
+ List<DocumentRenderer> doxiaDocuments = new ArrayList<>();
+ List<DocumentRenderer> generatedDoxiaDocuments = new ArrayList<>();
List<DocumentRenderer> nonDoxiaDocuments = new ArrayList<>();
Map<String, Integer> counts = new TreeMap<>();
+ Map<String, Integer> generatedCounts = new TreeMap<>();
- for (Map.Entry<String, DocumentRenderer> entry : documents.entrySet()) {
- DocumentRenderer doc = entry.getValue();
-
+ for (DocumentRenderer doc : documents) {
if (doc instanceof DoxiaDocumentRenderer) {
- doxiaDocuments.put(entry.getKey(), doc);
-
DoxiaDocumentRenderer doxia = (DoxiaDocumentRenderer) doc;
+ boolean editable = doxia.getRenderingContext().isEditable();
+
+ if (editable) {
+ doxiaDocuments.add(doc);
+ } else {
+ generatedDoxiaDocuments.add(doc);
+ }
// count documents per parserId
String parserId = doxia.getRenderingContext().getParserId();
- Integer count = counts.get(parserId);
+ Map<String, Integer> actualCounts;
+ if (editable) {
+ actualCounts = counts;
+ } else {
+ actualCounts = generatedCounts;
+ }
+ Integer count = actualCounts.get(parserId);
if (count == null) {
count = 1;
} else {
count++;
}
- counts.put(parserId, count);
+ actualCounts.put(parserId, count);
} else {
nonDoxiaDocuments.add(doc);
}
@@ -208,7 +198,7 @@ public class SiteMojo extends AbstractSiteRenderingMojo {
if (doxiaDocuments.size() > 0) {
MessageBuilder mb = buffer();
mb.a("Rendering ");
- mb.strong(doxiaDocuments.size() + (generated ? " generated" : "") + " Doxia document"
+ mb.strong(doxiaDocuments.size() + " Doxia document"
+ (doxiaDocuments.size() > 1 ? "s" : ""));
mb.a(": ");
@@ -224,7 +214,29 @@ public class SiteMojo extends AbstractSiteRenderingMojo {
getLog().info(mb.toString());
- siteRenderer.render(doxiaDocuments.values(), context, outputDirectory);
+ siteRenderer.render(doxiaDocuments, context, outputDirectory);
+ }
+
+ if (generatedDoxiaDocuments.size() > 0) {
+ MessageBuilder mb = buffer();
+ mb.a("Rendering ");
+ mb.strong(generatedDoxiaDocuments.size() + " generated Doxia document"
+ + (generatedDoxiaDocuments.size() > 1 ? "s" : ""));
+ mb.a(": ");
+
+ boolean first = true;
+ for (Map.Entry<String, Integer> entry : generatedCounts.entrySet()) {
+ if (first) {
+ first = false;
+ } else {
+ mb.a(", ");
+ }
+ mb.strong(entry.getValue() + " " + entry.getKey());
+ }
+
+ getLog().info(mb.toString());
+
+ siteRenderer.render(generatedDoxiaDocuments, context, outputDirectory);
}
return nonDoxiaDocuments;
@@ -236,7 +248,7 @@ public class SiteMojo extends AbstractSiteRenderingMojo {
* @param documents a collection of documents containing non-Doxia source files
*/
private void renderNonDoxiaDocuments(
- List<DocumentRenderer> documents, SiteRenderingContext context, File outputDirectory)
+ Collection<DocumentRenderer> documents, SiteRenderingContext context, File outputDirectory)
throws RendererException, IOException {
Map<String, Integer> counts = new TreeMap<>();
diff --git a/src/main/java/org/apache/maven/plugins/site/run/DoxiaBean.java b/src/main/java/org/apache/maven/plugins/site/run/DoxiaBean.java
index 34f97a9f..01eaef4a 100644
--- a/src/main/java/org/apache/maven/plugins/site/run/DoxiaBean.java
+++ b/src/main/java/org/apache/maven/plugins/site/run/DoxiaBean.java
@@ -34,20 +34,15 @@ public class DoxiaBean {
private Map<String, DocumentRenderer> documents;
- private SiteRenderingContext generatedSiteContext;
-
/**
* @param context context
* @param documents documents
- * @param generatedSiteContext context of generated content
*/
public DoxiaBean(
SiteRenderingContext context,
- Map<String, DocumentRenderer> documents,
- SiteRenderingContext generatedSiteContext) {
+ Map<String, DocumentRenderer> documents) {
this.context = context;
this.documents = documents;
- this.generatedSiteContext = generatedSiteContext;
}
public SiteRenderingContext getContext() {
@@ -65,12 +60,4 @@ public class DoxiaBean {
public void setDocuments(Map<String, DocumentRenderer> documents) {
this.documents = documents;
}
-
- public SiteRenderingContext getGeneratedSiteContext() {
- return generatedSiteContext;
- }
-
- public void setGeneratedSiteContext(SiteRenderingContext generatedSiteContext) {
- this.generatedSiteContext = generatedSiteContext;
- }
}
diff --git a/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java b/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java
index 508744b3..9fce1cc3 100644
--- a/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java
+++ b/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java
@@ -108,7 +108,6 @@ public class DoxiaFilter implements Filter {
// Handle locale request
SiteRenderingContext context;
Map<String, DocumentRenderer> documents;
- SiteRenderingContext generatedSiteContext;
String localeWanted = "";
for (Locale locale : localesList) {
@@ -132,7 +131,6 @@ public class DoxiaFilter implements Filter {
}
context = doxiaBean.getContext();
documents = doxiaBean.getDocuments();
- generatedSiteContext = doxiaBean.getGeneratedSiteContext();
// ----------------------------------------------------------------------
// Handle report and documents
@@ -164,26 +162,6 @@ public class DoxiaFilter implements Filter {
} catch (RendererException e) {
throw new ServletException(e);
}
- } else if (generatedSiteContext != null) {
- try {
- Map<String, DocumentRenderer> locateDocuments =
- siteRenderer.locateDocumentFiles(generatedSiteContext, false);
-
- if (locateDocuments.containsKey(path)) {
- DocumentRenderer docRenderer = locateDocuments.get(path);
- logDocumentRenderer(path, localeWanted, docRenderer);
- String outputName = docRenderer.getOutputName();
- String contentType = MimeTypes.getDefaultMimeByExtension(outputName);
- if (contentType != null) {
- servletResponse.setContentType(contentType);
- }
- docRenderer.renderDocument(servletResponse.getWriter(), siteRenderer, generatedSiteContext);
-
- return;
- }
- } catch (RendererException e) {
- throw new ServletException(e);
- }
}
filterChain.doFilter(servletRequest, servletResponse);
diff --git a/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java b/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java
index f5430e00..266909c4 100644
--- a/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java
@@ -133,21 +133,11 @@ public class SiteRunMojo extends AbstractSiteRenderingMojo {
i18nContext.setInputEncoding(getInputEncoding());
i18nContext.setOutputEncoding(getOutputEncoding());
- SiteRenderingContext i18nGeneratedSiteContext = createSiteRenderingContext(locale);
- i18nGeneratedSiteContext.setInputEncoding(getInputEncoding());
- i18nGeneratedSiteContext.setOutputEncoding(getOutputEncoding());
- i18nGeneratedSiteContext.getSiteDirectories().clear();
-
File outputDirectory = getOutputDirectory(locale);
List<MavenReportExecution> reports = getReports(outputDirectory);
Map<String, DocumentRenderer> i18nDocuments = locateDocuments(i18nContext, reports, locale);
- if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
- i18nGeneratedSiteContext.addSiteDirectory(new File(generatedSiteDirectory, locale.toString()));
- } else {
- i18nGeneratedSiteContext.addSiteDirectory(generatedSiteDirectory);
- }
- DoxiaBean doxiaBean = new DoxiaBean(i18nContext, i18nDocuments, i18nGeneratedSiteContext);
+ DoxiaBean doxiaBean = new DoxiaBean(i18nContext, i18nDocuments);
if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
i18nDoxiaContexts.put(locale.toString(), doxiaBean);