This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
The following commit(s) were added to refs/heads/master by this push:
new ca98fd1 Render a page again when the skin changed or its last render
failed
ca98fd1 is described below
commit ca98fd15df574a357d4c47a49a1edc2dfaf6d2a6
Author: Sylwester Lachiewicz <[email protected]>
AuthorDate: Mon Nov 2 18:43:03 2026 +0000
Render a page again when the skin changed or its last render failed
A page was rendered only when its source or the site descriptor was newer
than the output. Switching or
rebuilding the skin left every page on the old skin until target/site was
deleted, and a render that failed
half way left a truncated page that was newer than its source, so the next
build kept it as unchanged.
---
.../doxia/siterenderer/DefaultSiteRenderer.java | 11 +++-
.../siterenderer/DefaultSiteRendererTest.java | 69 ++++++++++++++++++++++
2 files changed, 79 insertions(+), 1 deletion(-)
diff --git
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
index af08050..1da9522 100644
---
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
+++
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
@@ -376,9 +376,12 @@ public class DefaultSiteRenderer implements Renderer {
File inputFile = new File(docRenderingContext.getBasedir(),
docRenderingContext.getInputName());
+ // a newer source, site descriptor (own or inherited) or skin all
change the page
+ File skinFile = siteRenderingContext.getSkinFile();
boolean modified = !outputFile.exists()
|| (inputFile.lastModified() > outputFile.lastModified())
- || (siteRenderingContext.getSiteModel().getLastModified()
> outputFile.lastModified());
+ || (siteRenderingContext.getSiteModel().getLastModified()
> outputFile.lastModified())
+ || (skinFile != null && skinFile.lastModified() >
outputFile.lastModified());
if (modified || docRenderer.isOverwrite()) {
if (!outputFile.getParentFile().exists()) {
@@ -390,14 +393,20 @@ public class DefaultSiteRenderer implements Renderer {
}
Writer writer = null;
+ boolean rendered = false;
try {
if (!docRenderer.isExternalReport()) {
writer = new OutputStreamWriter(
Files.newOutputStream(outputFile.toPath()),
siteRenderingContext.getOutputEncoding());
}
docRenderer.renderDocument(writer, this,
siteRenderingContext);
+ rendered = true;
} finally {
IOUtil.close(writer);
+ // a partly written page is newer than its source and
would be skipped as unchanged next time
+ if (!rendered && writer != null) {
+ Files.deleteIfExists(outputFile.toPath());
+ }
}
} else {
if (LOGGER.isDebugEnabled()) {
diff --git
a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
index 9704cdb..acde1b2 100644
---
a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
+++
b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
@@ -695,4 +695,73 @@ public class DefaultSiteRendererTest {
return true;
}
}
+
+ private DocumentRenderer pageRenderer(File basedir, String inputName) {
+ DocumentRenderer docRenderer = Mockito.mock(DocumentRenderer.class);
+ Mockito.when(docRenderer.getRenderingContext())
+ .thenReturn(new DocumentRenderingContext(basedir, inputName,
"markdown"));
+ Mockito.when(docRenderer.getOutputName()).thenReturn("page.html");
+ return docRenderer;
+ }
+
+ @Test
+ void newerSkinRendersUnchangedPageAgain() throws Exception {
+ File basedir = getTestFile("target/rerender/skin");
+ org.apache.commons.io.FileUtils.deleteDirectory(basedir);
+ File input = new File(basedir, "src/page.md");
+ File output = new File(basedir, "site/page.html");
+ File skin = new File(basedir, "skin.jar");
+ for (File f : new File[] {input, output, skin}) {
+ f.getParentFile().mkdirs();
+ Files.write(f.toPath(), "x".getBytes(StandardCharsets.UTF_8));
+ }
+ long now = System.currentTimeMillis();
+ assertTrue(input.setLastModified(now - 30_000));
+ assertTrue(output.setLastModified(now - 20_000));
+
+ SiteRenderingContext context = new SiteRenderingContext();
+ context.setSiteModel(new SiteModel());
+ context.setSkin(skin, "org.example:skin:1");
+
+ // skin older than the page: unchanged, not rendered
+ assertTrue(skin.setLastModified(now - 25_000));
+ DocumentRenderer unchanged = pageRenderer(basedir, "src/page.md");
+ siteRenderer.render(Collections.singletonList(unchanged), context, new
File(basedir, "site"));
+ Mockito.verify(unchanged,
Mockito.never()).renderDocument(Mockito.any(), Mockito.any(), Mockito.any());
+
+ // skin newer than the page, for example a rebuilt or switched skin:
rendered again
+ assertTrue(skin.setLastModified(now - 10_000));
+ DocumentRenderer changed = pageRenderer(basedir, "src/page.md");
+ siteRenderer.render(Collections.singletonList(changed), context, new
File(basedir, "site"));
+ Mockito.verify(changed).renderDocument(Mockito.any(), Mockito.any(),
Mockito.any());
+ }
+
+ @Test
+ void failedRenderLeavesNoPartialPage() throws Exception {
+ File basedir = getTestFile("target/rerender/failure");
+ org.apache.commons.io.FileUtils.deleteDirectory(basedir);
+ File input = new File(basedir, "src/page.md");
+ input.getParentFile().mkdirs();
+ Files.write(input.toPath(), "x".getBytes(StandardCharsets.UTF_8));
+
+ DocumentRenderer failing = pageRenderer(basedir, "src/page.md");
+ Mockito.doAnswer(invocation -> {
+ java.io.Writer writer = invocation.getArgument(0);
+ writer.write("<html><body>half");
+ writer.flush();
+ throw new RendererException("template error");
+ })
+ .when(failing)
+ .renderDocument(Mockito.any(), Mockito.any(), Mockito.any());
+
+ SiteRenderingContext context = new SiteRenderingContext();
+ context.setSiteModel(new SiteModel());
+ File outputDirectory = new File(basedir, "site");
+ assertThrows(
+ RendererException.class,
+ () -> siteRenderer.render(Collections.singletonList(failing),
context, outputDirectory));
+
+ // a partly written page would be newer than its source and skipped as
unchanged by the next run
+ assertFalse(new File(outputDirectory, "page.html").exists());
+ }
}