refactor(#5179): simplify Janitor to wipe cache on every SNAPSHOT build

volodya-lombrozo · volodya-lombrozo · commit e5a521f86a3f · 2026-06-04T14:17:34.000+03:00
diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/Cache.java b/eo-maven-plugin/src/main/java/org/eolang/maven/Cache.java
@@ -5,7 +5,6 @@
 package org.eolang.maven;
 
 import java.io.IOException;
-import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -164,6 +163,4 @@ private String dirSha(final Path dir) {
             );
         }
     }
-
-
 }
diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/Janitor.java b/eo-maven-plugin/src/main/java/org/eolang/maven/Janitor.java
@@ -7,17 +7,17 @@
 import com.jcabi.log.Logger;
 import java.io.IOException;
 import java.net.URISyntaxException;
-import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Comparator;
 import java.util.stream.Stream;
 
 /**
- * Invalidates the local EO cache when the plugin code changes.
- * Only applies to SNAPSHOT versions — released versions use version-keyed
- * cache directories that never collide.
+ * Invalidates the local EO cache on every SNAPSHOT build.
+ * Released versions use version-keyed cache directories that never collide,
+ * so no invalidation is needed for them.
+ * @see <a href="https://github.com/objectionary/eo/issues/5179">issue #5179</a>
  * @since 0.62.0
  */
 final class Janitor {
@@ -53,41 +53,57 @@ final class Janitor {
     }
 
     /**
-     * Wipes all SNAPSHOT stage caches if the plugin code has changed since last build.
+     * Wipes all SNAPSHOT stage caches on every build.
+     * Does nothing for released versions.
      */
-    void exec() {
-        if (!this.version.contains("SNAPSHOT")) {
-            return;
-        }
-        try {
-            final String current = String.valueOf(Janitor.mtime());
-            final Path fingerprint = this.cache.resolve(Janitor.FINGERPRINT);
-            if (Files.exists(fingerprint)
-                && new String(Files.readAllBytes(fingerprint), StandardCharsets.UTF_8)
-                    .equals(current)) {
-                return;
-            }
-            for (final String stage : Janitor.STAGES) {
-                final Path dir = this.cache.resolve(stage).resolve(this.version);
-                if (Files.exists(dir)) {
-                    Logger.info(
-                        this,
-                        "Plugin code changed, invalidating SNAPSHOT cache at %[file]s",
-                        dir
-                    );
-                    Janitor.wipe(dir);
-                }
+    void clean() {
+        if (this.version.contains("SNAPSHOT")) {
+            try {
+                this.invalidate();
+            } catch (final IOException | URISyntaxException ex) {
+                throw new IllegalStateException("Failed to clean SNAPSHOT cache", ex);
             }
+        }
+    }
+
+    /**
+     * Checks the fingerprint and wipes caches if it has changed.
+     * @throws IOException If an IO operation fails
+     * @throws URISyntaxException If the code source location URI is malformed
+     */
+    private void invalidate() throws IOException, URISyntaxException {
+        final String current = String.valueOf(Janitor.mtime());
+        final Path fingerprint = this.cache.resolve(Janitor.FINGERPRINT);
+        if (!Files.exists(fingerprint)
+            || !Files.readString(fingerprint).equals(current)) {
+            this.wipeCaches();
             new Saved(current, fingerprint).value();
-        } catch (final IOException | URISyntaxException ex) {
-            throw new IllegalStateException("Failed to clean SNAPSHOT cache", ex);
         }
     }
 
     /**
-     * Returns the newest modification time across all files at the plugin code source location.
-     * Works for both a JAR file (production) and a classes directory (development).
-     * @return Newest last-modified timestamp in milliseconds
+     * Deletes the versioned cache directory for each stage if it exists.
+     * @throws IOException If deletion fails
+     */
+    private void wipeCaches() throws IOException {
+        for (final String stage : Janitor.STAGES) {
+            final Path dir = this.cache.resolve(stage).resolve(this.version);
+            if (Files.exists(dir)) {
+                Logger.info(
+                    this,
+                    "Plugin code changed, invalidating SNAPSHOT cache at %[file]s",
+                    dir
+                );
+                Janitor.wipe(dir);
+            }
+        }
+    }
+
+    /**
+     * Returns the modification time of the plugin JAR or classes directory.
+     * Used as a build fingerprint: changes on every build, so comparing it
+     * to the stored value always detects a new build.
+     * @return Last-modified timestamp in milliseconds
      * @throws URISyntaxException If the code source location URI is malformed
      * @throws IOException If reading the directory fails
      */
diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/MjSafe.java b/eo-maven-plugin/src/main/java/org/eolang/maven/MjSafe.java
@@ -487,7 +487,7 @@ public final void execute() throws MojoFailureException {
         } else {
             try {
                 final long start = System.nanoTime();
-                new Janitor(this.cache.toPath(), this.plugin.getVersion()).exec();
+                this.invalidate();
                 this.execWithTimeout();
                 if (Logger.isDebugEnabled(this)) {
                     Logger.debug(
@@ -622,6 +622,16 @@ Proxy[] proxies() {
             ).toArray(Proxy[]::new);
     }
 
+    /**
+     * Invalidates the SNAPSHOT cache if the plugin descriptor is available.
+     * The descriptor is absent in some test scenarios that use minimal setup.
+     */
+    private void invalidate() {
+        if (this.plugin != null) {
+            new Janitor(this.cache.toPath(), this.plugin.getVersion()).clean();
+        }
+    }
+
     /**
      * Runs exec command with timeout if needed.
      * @throws ExecutionException If unexpected exception happened during execution
diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/Sha.java b/eo-maven-plugin/src/main/java/org/eolang/maven/Sha.java
@@ -34,10 +34,6 @@ final class Sha {
         this.path = path;
     }
 
-    /**
-     * Returns Base64-encoded SHA-256 hash.
-     * @return Base64-encoded SHA-256 hash
-     */
     @Override
     public String toString() {
         try {
@@ -59,8 +55,7 @@ private static String hash(final Path path) throws IOException, NoSuchAlgorithmE
         final MessageDigest digest = MessageDigest.getInstance("SHA-256");
         try (Stream<Path> walk = Files.walk(path)) {
             walk.filter(Files::isRegularFile)
-                .sorted(Comparator.comparing(Path::toString))
-                .forEach(
+                .sorted(Comparator.comparing(Path::toString)).forEach(
                     file -> {
                         try (InputStream input = Files.newInputStream(file)) {
                             final byte[] buffer = new byte[8192];
diff --git a/eo-maven-plugin/src/test/java/org/eolang/maven/JanitorTest.java b/eo-maven-plugin/src/test/java/org/eolang/maven/JanitorTest.java
@@ -23,7 +23,7 @@ final class JanitorTest {
 
     @Test
     void doesNothingForReleasedVersion(@Mktmp final Path temp) {
-        new Janitor(temp, "1.0").exec();
+        new Janitor(temp, "1.0").clean();
         MatcherAssert.assertThat(
             "Fingerprint must not be created for released versions",
             Files.exists(temp.resolve(".snapshot-fingerprint")),
@@ -32,18 +32,22 @@ void doesNothingForReleasedVersion(@Mktmp final Path temp) {
     }
 
     @Test
-    void wipesStageDirsAndWritesFingerprintOnFirstRun(@Mktmp final Path temp) throws Exception {
+    void wipesStageDirsOnFirstRun(@Mktmp final Path temp) throws Exception {
         final String version = "1.0-SNAPSHOT";
-        Files.createDirectories(temp.resolve("transpiled").resolve(version));
-        Files.createFile(
-            temp.resolve("transpiled").resolve(version).resolve("stale.xmir")
-        );
-        new Janitor(temp, version).exec();
+        new Saved("", JanitorTest.staleFile(temp, version)).value();
+        new Janitor(temp, version).clean();
         MatcherAssert.assertThat(
             "Stale SNAPSHOT cache must be wiped on first run",
-            Files.exists(temp.resolve("transpiled").resolve(version).resolve("stale.xmir")),
+            Files.exists(JanitorTest.staleFile(temp, version)),
             Matchers.is(false)
         );
+    }
+
+    @Test
+    void writesFingerprintOnFirstRun(@Mktmp final Path temp) throws Exception {
+        final String version = "1.0-SNAPSHOT";
+        new Saved("", JanitorTest.staleFile(temp, version)).value();
+        new Janitor(temp, version).clean();
         MatcherAssert.assertThat(
             "Fingerprint file must be written after wipe",
             Files.exists(temp.resolve(".snapshot-fingerprint")),
@@ -54,11 +58,10 @@ void wipesStageDirsAndWritesFingerprintOnFirstRun(@Mktmp final Path temp) throws
     @Test
     void doesNothingWhenFingerprintMatches(@Mktmp final Path temp) throws Exception {
         final String version = "1.0-SNAPSHOT";
-        new Janitor(temp, version).exec();
-        Files.createDirectories(temp.resolve("transpiled").resolve(version));
+        new Janitor(temp, version).clean();
         final Path kept = temp.resolve("transpiled").resolve(version).resolve("valid.xmir");
-        Files.createFile(kept);
-        new Janitor(temp, version).exec();
+        new Saved("", kept).value();
+        new Janitor(temp, version).clean();
         MatcherAssert.assertThat(
             "Cache must not be wiped when fingerprint matches",
             Files.exists(kept),
@@ -73,15 +76,22 @@ void wipesStageDirsWhenFingerprintDiffers(@Mktmp final Path temp) throws Excepti
             temp.resolve(".snapshot-fingerprint"),
             "outdated-hash".getBytes(StandardCharsets.UTF_8)
         );
-        Files.createDirectories(temp.resolve("transpiled").resolve(version));
-        Files.createFile(
-            temp.resolve("transpiled").resolve(version).resolve("stale.xmir")
-        );
-        new Janitor(temp, version).exec();
+        new Saved("", JanitorTest.staleFile(temp, version)).value();
+        new Janitor(temp, version).clean();
         MatcherAssert.assertThat(
             "Stale cache must be wiped when fingerprint differs",
-            Files.exists(temp.resolve("transpiled").resolve(version).resolve("stale.xmir")),
+            Files.exists(JanitorTest.staleFile(temp, version)),
             Matchers.is(false)
         );
     }
+
+    /**
+     * Builds the path to the stale transpiled file used in cache-wipe tests.
+     * @param temp Temporary directory
+     * @param version Plugin version
+     * @return Path to the stale file inside the transpiled stage cache
+     */
+    private static Path staleFile(final Path temp, final String version) {
+        return temp.resolve("transpiled").resolve(version).resolve("stale.xmir");
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`package org.eolang.maven;`
`6`	`6`
`7`	`7`	`import java.io.IOException;`
`8`		`-import java.io.InputStream;`
`9`	`8`	`import java.nio.charset.StandardCharsets;`
`10`	`9`	`import java.nio.file.Files;`
`11`	`10`	`import java.nio.file.Path;`
`@@ -164,6 +163,4 @@ private String dirSha(final Path dir) {`
`164`	`163`	`);`
`165`	`164`	`}`
`166`	`165`	`}`
`167`		`-`
`168`		`-`
`169`	`166`	`}`