Skip to content

Commit

Permalink
Dev mode: fix HotDeploymentWatchedFileBuildItem predicate
Browse files Browse the repository at this point in the history 
- also mention the glob pattern in HotDeploymentWatchedFileBuildItem
javadoc and optimize glob pattern processing
- fixes quarkusio#36472
  • Loading branch information
@mkouba
mkouba committed Oct 24, 2023
1 parent d5602cb commit ff9191a
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 29 deletions.
9 changes: 8 additions & 1 deletion ...ment/src/main/java/io/quarkus/deployment/builditem/HotDeploymentWatchedFileBuildItem.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,15 @@
* {@link io.quarkus.bootstrap.devmode.DependenciesFilter#getReloadableModules(io.quarkus.bootstrap.model.ApplicationModel)
* reloadable module} that, if modified, may result in a hot redeployment when in the dev mode.
* <p>
* A file may be identified with an exact location or a matching predicate. See {@link Builder#setLocation(String)} and
* A file may be identified with an location or a matching predicate. See {@link Builder#setLocation(String)} and
* {@link Builder#setLocationPredicate(Predicate)}.
*
* The location may be:
* <ul>
* <li>a relative file path; e.g. {@code foo/bar.sample}</li>
* <li>an absolute file path; e.g. {@code /home/foo/bar.sample}</li>
* <li>a glob pattern as defined in {@link java.nio.file.FileSystem#getPathMatcher(String)}; e.g. {@code *.sample}</li>
* </ul>
* <p>
* If multiple build items match the same file then the final value of {@code restartNeeded} is computed as a logical OR of all
* the {@link #isRestartNeeded()} values.
Expand Down
97 changes: 69 additions & 28 deletions core/deployment/src/main/java/io/quarkus/deployment/dev/RuntimeUpdatesProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -944,9 +944,8 @@ Set<String> checkForFileChange(Function<DevModeContext.ModuleInfo, DevModeContex
}
}

for (String watchedFilePath : timestampSet.watchedFilePaths.keySet()) {
Path watchedFile = Paths.get(watchedFilePath);
boolean isAbsolute = watchedFile.isAbsolute();
for (Path watchedFilePath : timestampSet.watchedFileTimestamps.keySet()) {
boolean isAbsolute = watchedFilePath.isAbsolute();
List<Path> watchedRoots = roots;
if (isAbsolute) {
// absolute files are assumed to be read directly from the project root.
Expand All @@ -961,15 +960,15 @@ Set<String> checkForFileChange(Function<DevModeContext.ModuleInfo, DevModeContex
boolean pathPreviouslyExisting = false;
for (Path root : watchedRoots) {
Path file = root.resolve(watchedFilePath);
if (file.toFile().exists()) {
if (Files.exists(file)) {
pathCurrentlyExisting = true;
try {
long value = Files.getLastModifiedTime(file).toMillis();
Long existing = timestampSet.watchedFileTimestamps.get(file);
//existing can be null when running tests
//as there is both normal and test resources, but only one set of watched timestampts
if (existing != null && value > existing) {
ret.add(watchedFilePath);
ret.add(file.toString());
//a write can be a 'truncate' + 'write'
//if the file is empty we may be seeing the middle of a write
if (Files.size(file) == 0) {
Expand Down Expand Up @@ -1004,7 +1003,7 @@ Set<String> checkForFileChange(Function<DevModeContext.ModuleInfo, DevModeContex
}
if (!pathCurrentlyExisting) {
if (pathPreviouslyExisting) {
ret.add(watchedFilePath);
ret.add(watchedFilePath.toString());
}

if (!isAbsolute) {
Expand Down Expand Up @@ -1085,19 +1084,22 @@ public RuntimeUpdatesProcessor setWatchedFilePaths(Map<String, Boolean> watchedF
List<Entry<Predicate<String>, Boolean>> watchedFilePredicates, boolean isTest) {
if (isTest) {
setWatchedFilePathsInternal(watchedFilePaths, test,
s -> s.getTest().isPresent() ? asList(s.getTest().get(), s.getMain()) : singletonList(s.getMain()));
s -> s.getTest().isPresent() ? asList(s.getTest().get(), s.getMain()) : singletonList(s.getMain()),
watchedFilePredicates);
} else {
main.watchedFileTimestamps.clear();
main.watchedFilePredicates = watchedFilePredicates;
setWatchedFilePathsInternal(watchedFilePaths, main, s -> singletonList(s.getMain()));
setWatchedFilePathsInternal(watchedFilePaths, main, s -> singletonList(s.getMain()), watchedFilePredicates);
}
return this;
}

private RuntimeUpdatesProcessor setWatchedFilePathsInternal(Map<String, Boolean> watchedFilePaths,
TimestampSet timestamps, Function<DevModeContext.ModuleInfo, List<DevModeContext.CompilationUnit>> cuf) {
TimestampSet timestamps, Function<DevModeContext.ModuleInfo, List<DevModeContext.CompilationUnit>> cuf,
List<Entry<Predicate<String>, Boolean>> watchedFilePredicates) {
timestamps.watchedFilePaths = watchedFilePaths;
Map<String, Boolean> extraWatchedFilePaths = new HashMap<>();
Set<String> watchedRootPaths = new HashSet<>();
for (DevModeContext.ModuleInfo module : context.getAllModules()) {
List<DevModeContext.CompilationUnit> compilationUnits = cuf.apply(module);
for (DevModeContext.CompilationUnit unit : compilationUnits) {
Expand All @@ -1110,24 +1112,48 @@ private RuntimeUpdatesProcessor setWatchedFilePathsInternal(Map<String, Boolean>
rootPaths = PathList.of(Path.of(rootPath));
}
for (Path root : rootPaths) {
for (String path : watchedFilePaths.keySet()) {
Path config = root.resolve(path);
if (config.toFile().exists()) {
try {
FileTime lastModifiedTime = Files.getLastModifiedTime(config);
timestamps.watchedFileTimestamps.put(config, lastModifiedTime.toMillis());
} catch (IOException e) {
throw new UncheckedIOException(e);
// First find all matching paths from the root
try (final Stream<Path> walk = Files.walk(root)) {
walk.forEach(path -> {
if (path.equals(root)) {
return;
}
// Use the relative path to match the watched file
// /some/more/complex/path/src/main/resources/foo/bar.txt -> foo/bar.txt
Path relativePath = root.relativize(path);
String relativePathStr = relativePath.toString();
if (watchedFilePaths.containsKey(relativePathStr)
|| watchedFilePredicates.stream().anyMatch(e -> e.getKey().test(relativePathStr))) {
log.debugf("Watch %s from: %s", relativePathStr, root);
watchedRootPaths.add(relativePathStr);
putLastModifiedTime(path, relativePath, timestamps);
}
});
} catch (IOException e) {
throw new UncheckedIOException(e);
}

// Then process watched paths that are not matched with a path from a resource root,
// for example absolute paths and glob patterns
for (String watchedFilePath : watchedFilePaths.keySet()) {
Path path = Paths.get(watchedFilePath);
if (path.isAbsolute()) {
if (Files.exists(path)) {
log.debugf("Watch %s", path);
putLastModifiedTime(path, path, timestamps);
}
} else {
timestamps.watchedFileTimestamps.put(config, 0L);
Map<Path, Long> extraWatchedFileTimestamps = expandGlobPattern(root, config);
timestamps.watchedFileTimestamps.putAll(extraWatchedFileTimestamps);
for (Path extraPath : extraWatchedFileTimestamps.keySet()) {
extraWatchedFilePaths.put(root.relativize(extraPath).toString(),
timestamps.watchedFilePaths.get(path));
} else if (!watchedRootPaths.contains(watchedFilePath) && maybeGlobPattern(watchedFilePath)) {
Path resolvedPath = root.resolve(watchedFilePath);
Map<Path, Long> extraWatchedFileTimestamps = expandGlobPattern(root, resolvedPath, watchedFilePath);
if (!extraWatchedFileTimestamps.isEmpty()) {
timestamps.watchedFileTimestamps.put(resolvedPath, 0L);
timestamps.watchedFileTimestamps.putAll(extraWatchedFileTimestamps);
for (Path extraPath : extraWatchedFileTimestamps.keySet()) {
extraWatchedFilePaths.put(extraPath.toString(),
timestamps.watchedFilePaths.get(watchedFilePath));
}
timestamps.watchedFileTimestamps.putAll(extraWatchedFileTimestamps);
}
timestamps.watchedFileTimestamps.putAll(extraWatchedFileTimestamps);
}
}
}
Expand All @@ -1137,6 +1163,19 @@ private RuntimeUpdatesProcessor setWatchedFilePathsInternal(Map<String, Boolean>
return this;
}

private boolean maybeGlobPattern(String path) {
return path.contains("*") || path.contains("?");
}

private void putLastModifiedTime(Path filePath, Path keyPath, TimestampSet timestamps) {
try {
FileTime lastModifiedTime = Files.getLastModifiedTime(filePath);
timestamps.watchedFileTimestamps.put(keyPath, lastModifiedTime.toMillis());
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}

public void addHotReplacementSetup(HotReplacementSetup service) {
hotReplacementSetup.add(service);
}
Expand Down Expand Up @@ -1171,15 +1210,17 @@ public void close() throws IOException {
}
}

private Map<Path, Long> expandGlobPattern(Path root, Path configFile) {
PathMatcher pathMatcher = FileSystems.getDefault().getPathMatcher("glob:" + configFile.toString());
private Map<Path, Long> expandGlobPattern(Path root, Path path, String pattern) {
PathMatcher pathMatcher = FileSystems.getDefault().getPathMatcher("glob:" + path.toString());
Map<Path, Long> files = new HashMap<>();
try {
Files.walkFileTree(root, new SimpleFileVisitor<Path>() {
@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) {
if (pathMatcher.matches(file)) {
files.put(file, attrs.lastModifiedTime().toMillis());
Path relativePath = root.relativize(file);
log.debugf("Glob pattern [%s] matched %s from %s", pattern, relativePath, root);
files.put(relativePath, attrs.lastModifiedTime().toMillis());
}
return FileVisitResult.CONTINUE;
}
Expand Down
4 changes: 4 additions & 0 deletions ...s/devmode/src/test/java/io/quarkus/test/reload/AdditionalWatchedResourcesDevModeTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ public void globWatch() {
TEST.modifyResourceFile(SAMPLE_FILE, oldSource -> MODIFIED);

RestAssured.get("/content/{name}", SAMPLE_FILE).then().body(is(MODIFIED));

TEST.modifyResourceFile(SAMPLE_FILE, oldSource -> INITIAL);

RestAssured.get("/content/{name}", SAMPLE_FILE).then().body(is(INITIAL));
}

@Test
Expand Down

0 comments on commit ff9191a

Please sign in to comment.