-
-
Notifications
You must be signed in to change notification settings - Fork 170
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ Enhance JS service deploy/undeploy mechanism: Trigger on any file m…
…odification for more efficient updates #529
- Loading branch information
Showing
9 changed files
with
270 additions
and
64 deletions.
There are no files selected for viewing
147 changes: 147 additions & 0 deletions
147
commons/src/main/java/org/restheart/utils/DirectoryWatcher.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| /*- | ||
| * ========================LICENSE_START================================= | ||
| * restheart-polyglot | ||
| * %% | ||
| * Copyright (C) 2020 - 2024 SoftInstigate | ||
| * %% | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * =========================LICENSE_END================================== | ||
| */ | ||
| package org.restheart.utils; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.FileSystems; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import static java.nio.file.StandardWatchEventKinds.ENTRY_CREATE; | ||
| import static java.nio.file.StandardWatchEventKinds.ENTRY_DELETE; | ||
| import static java.nio.file.StandardWatchEventKinds.ENTRY_MODIFY; | ||
| import java.nio.file.WatchEvent; | ||
| import java.nio.file.WatchEvent.Kind; | ||
| import java.nio.file.WatchKey; | ||
| import java.nio.file.WatchService; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.function.BiConsumer; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class DirectoryWatcher implements Runnable { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(DirectoryWatcher.class); | ||
|
|
||
| private final WatchService watchService; | ||
| private final Map<WatchKey, Path> keys; | ||
| private final BiConsumer<Path, Kind<Path>> onEvent; | ||
|
|
||
| public DirectoryWatcher(Path rootDir, BiConsumer<Path, Kind<Path>> onEvent) throws IOException { | ||
| this.watchService = FileSystems.getDefault().newWatchService(); | ||
| this.keys = new HashMap<>(); // Mapping WatchKeys to the corresponding directory | ||
| this.onEvent = onEvent; | ||
| registerDirectoryAndSubdirectories(rootDir); | ||
| } | ||
|
|
||
| private void registerDirectoryAndSubdirectories(Path dir) throws IOException { | ||
| // Skip directories named "node_modules" | ||
| if (dir.getFileName().toString().equals("node_modules")) { | ||
| LOGGER.debug("Skipping directory: {}", dir); | ||
| return; | ||
| } | ||
|
|
||
| // Register the directory itself | ||
| WatchKey key = dir.register(watchService, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY); | ||
| keys.put(key, dir); | ||
|
|
||
| // Walk through and register all subdirectories except "node_modules" | ||
| Files.walk(dir).filter(Files::isDirectory).forEach(d -> { | ||
| try { | ||
| if (!d.getFileName().toString().equals("node_modules")) { | ||
| WatchKey subKey = d.register(watchService, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY); | ||
| keys.put(subKey, d); | ||
| } | ||
| } catch (IOException e) { | ||
| LambdaUtils.throwsSneakyException(e); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| @Override | ||
| public void run() { | ||
| while (true) { | ||
| WatchKey key; | ||
|
|
||
| try { | ||
| key = watchService.take(); // This will block until an event occurs | ||
| } catch (InterruptedException e) { | ||
| return; | ||
| } | ||
|
|
||
| var dir = keys.get(key); | ||
|
|
||
| if (dir == null) { | ||
| LOGGER.debug("WatchKey not recognized!"); | ||
| continue; | ||
| } | ||
|
|
||
| for (WatchEvent<?> event : key.pollEvents()) { | ||
| var kind = event.kind(); | ||
|
|
||
| // Context for the event is the file or directory that was affected | ||
| var ev = (WatchEvent<Path>) event; | ||
| var name = ev.context(); | ||
| var child = dir.resolve(name); | ||
|
|
||
| if (kind.equals(ENTRY_CREATE) && Files.isDirectory(child)) { | ||
| LOGGER.debug("Directory created: {}", child); | ||
| try { | ||
| if (!child.getFileName().toString().equals("node_modules")) { | ||
| registerDirectoryAndSubdirectories(child); | ||
| } | ||
| } catch (IOException e) { | ||
| LambdaUtils.throwsSneakyException(e); | ||
| } | ||
| this.onEvent.accept(child, ENTRY_CREATE); | ||
| } else if (kind.equals(ENTRY_MODIFY) && Files.isRegularFile(child)) { | ||
| LOGGER.debug("File modified: {}", child); | ||
| this.onEvent.accept(child, ENTRY_MODIFY); | ||
| } else if (kind.equals(ENTRY_DELETE)) { | ||
| LOGGER.debug("File or directory deleted: {}", child); | ||
| this.onEvent.accept(child, ENTRY_DELETE); | ||
|
|
||
| // If a directory is deleted, we should stop watching it | ||
| if (Files.isDirectory(child)) { | ||
| var childKey = keys.entrySet().stream() | ||
| .filter(entry -> entry.getValue().equals(child)) | ||
| .map(Map.Entry::getKey) | ||
| .findFirst().orElse(null); | ||
|
|
||
| if (childKey != null) { | ||
| childKey.cancel(); | ||
| keys.remove(childKey); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Reset the key -- this step is critical to receive further watch events | ||
| boolean valid = key.reset(); | ||
| if (!valid) { | ||
| keys.remove(key); // Remove the key if it is no longer valid | ||
| if (keys.isEmpty()) { | ||
| break; // Exit if there are no more directories to watch | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,24 +2,19 @@ | |
| "name": "restheart-example-js-plugins", | ||
| "version": "1.0.0", | ||
| "description": "example JavaScript Plugins for RESTHeart", | ||
| "main": "index.mjs", | ||
| "dependencies": { | ||
| "moment": "^2.29.4", | ||
| "one-liner-joke": "^1.2.0" | ||
| }, | ||
| "devDependencies": {}, | ||
| "scripts": { | ||
| "test": "echo \"Error: no test specified\" && exit 1" | ||
| }, | ||
| "author": "", | ||
| "author": "Andrea Di Cesare [email protected]", | ||
| "license": "Apache-2.0", | ||
| "rh:services": [ | ||
| "hello.mjs", | ||
| "sub/hello.mjs", | ||
| "require-module-service.mjs", | ||
| "mclient-service.mjs", | ||
| "http-client.mjs", | ||
| "test.mjs" | ||
| "test.mjs", | ||
| "require-module-service.mjs" | ||
| ], | ||
| "rh:interceptors": [ | ||
| "hello-interceptor.mjs", | ||
|
|
||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.