Merge branch 'main' into fix-log-level-of-overflow-rescanner

Author: sungshik

.editorconfig

@@ -15,3 +15,6 @@ end_of_line = lf
 [*.java]
 indent_size = 4
 max_line_length = 120
+
+[*.rs]
+indent_size = 4

.github/workflows/build.yaml

@@ -1,4 +1,7 @@
 name: Build and Test
+permissions:
+  contents: read
+  pull-requests: write
 on:
   push:
     branches:
@@ -18,20 +21,24 @@ jobs:
             mac-backend: jdk
           - image: macos-latest
             mac-backend: fsevents
+          - image: macos-15-intel
+            mac-backend: fsevents
           - image: windows-latest
-        jdk: [11, 17, 21]
+        jdk: [11, 21]
 
       fail-fast: false
     runs-on: ${{ matrix.os.image }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - run: echo " " >> pom.xml # make sure the cache is slightly different for these runners
       - name: Set up JDK
-        uses: actions/setup-java@v4
+        uses: actions/setup-java@v5
         with:
           java-version: ${{ matrix.jdk }}
           distribution: 'temurin'
           cache: 'maven'
+      - run: ./update-rust-jni-libs.sh -r
+        if: startsWith(matrix.os.image, 'macos-')
 
       - name: test
         run: mvn -B clean test "-Dwatch.mac.backend=${{ matrix.os.mac-backend }}"
@@ -46,10 +53,10 @@ jobs:
   checker-framework:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - run: echo "  " >> pom.xml # make sure the cache is slightly different for the checker framework
       - name: Set up JDK 11
-        uses: actions/setup-java@v4
+        uses: actions/setup-java@v5
         with:
           java-version: 11
           distribution: 'temurin'
@@ -60,9 +67,9 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Set up JDK 11
-        uses: actions/setup-java@v4
+        uses: actions/setup-java@v5
         with:
           java-version: 11
           distribution: 'temurin'

.github/workflows/release.yaml

@@ -1,13 +1,20 @@
 name: Publish package maven
+permissions:
+  contents: read
+  pull-requests: read
 on:
   release:
     types: [created]
 jobs:
   publish:
-    runs-on: ubuntu-latest
+    runs-on: macos-latest # for now build on macos for the jni
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-java@v4
+      - uses: actions/checkout@v6
+
+      # build jni libs on osx
+      - run: ./update-rust-jni-libs.sh -r
+
+      - uses: actions/setup-java@v5
         with:
           java-version: '11'
           distribution: 'temurin'
@@ -22,4 +29,4 @@ jobs:
         env:
           MAVEN_USERNAME: ${{ secrets.MAVEN_CENTRAL_USER }}
           MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
-          GPG_PASSPHRASE: ${{ secrets.GPG_SIGNING_KEY_PASSPHRASE }}
+          GPG_PASSPHRASE: ${{ secrets.GPG_SIGNING_KEY_PASSPHRASE }}

.gitignore

@@ -27,4 +27,4 @@ replay_pid*
 
 # release plugin state files
 /pom.xml.releaseBackup
-/release.properties
+/release.properties

README.md

@@ -13,6 +13,7 @@ Features:
 - monitor a directory for changes to its direct children
 - monitor a directory for changes for all its descendants (aka recursive directory watch)
 - high-resolution events (on macOS we use the native [FSEvents](https://developer.apple.com/documentation/coreservices/file_system_events) API to circumvent the polling behavior of the JDK [WatchService](https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchService.html))
+- Java 11 and higher are supported
 - edge cases dealt with:
   - recursive watches will also continue in new directories
   - multiple watches for the same directory are merged to avoid overloading the kernel
@@ -25,8 +26,6 @@ Planned features:
 - Support single file watches natively in linux (see [#11](https://github.com/SWAT-engineering/java-watch/issues/11))
 - Monitor only specific events (such as only CREATE events)
 
-
-
 ## Usage
 
 Import dependency in pom.xml:

pom.xml

@@ -32,7 +32,7 @@
 
   <groupId>engineering.swat</groupId>
   <artifactId>java-watch</artifactId>
-  <version>0.9.2-SNAPSHOT</version>
+  <version>0.9.6-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>${project.groupId}:${project.artifactId}</name>
@@ -66,26 +66,33 @@
     <connection>scm:git:git://github.com/SWAT-engineering/java-watch.git</connection>
     <developerConnection>scm:git:ssh://git@github.com/SWAT-engineering/java-watch.git</developerConnection>
     <url>https://github.com/SWAT-engineering/java-watch/tree/main/</url>
-    <tag>v0.5.0-RC3</tag>
+    <tag>v0.9.2</tag>
   </scm>
 
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <checkerframework.version>3.49.3</checkerframework.version>
-    <junit.version>5.13.0</junit.version>
-    <log4j.version>2.24.3</log4j.version>
-    <jna.version>5.17.0</jna.version>
+    <checkerframework.version>3.52.0</checkerframework.version>
+    <junit.version>5.14.1</junit.version>
+    <log4j.version>2.25.2</log4j.version>
     <maven.compiler.source>11</maven.compiler.source>
     <maven.compiler.target>11</maven.compiler.target>
     <watch.mac.backend>fsevents</watch.mac.backend>
   </properties>
 
   <build>
+    <resources>
+      <resource>
+        <directory>src/main/resources</directory>
+        <excludes>
+          <exclude>src/main/rust/**/*.*</exclude>
+        </excludes>
+      </resource>
+    </resources>
     <plugins>
       <plugin> <!-- configure java compiler -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
-        <version>3.14.0</version>
+        <version>3.14.1</version>
         <configuration>
           <release>11</release>
           <compilerArgument>-parameters</compilerArgument>
@@ -94,25 +101,26 @@
       <plugin> <!-- automate release commits -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-release-plugin</artifactId>
-        <version>3.1.1</version>
+        <version>3.2.0</version>
         <configuration>
           <tagNameFormat>v@{project.version}</tagNameFormat>
+          <arguments>-DskipTests</arguments> <!-- when doing a local release, don't wait for tests, they're long and slow -->
           <!-- do not use the build in release profile, we invoke it later -->
           <releaseProfiles />
         </configuration>
       </plugin>
       <plugin> <!-- unit test integration -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>3.5.3</version>
+        <version>3.5.4</version>
         <configuration>
           <argLine>@{argLine} -Dengineering.swat.java-watch.mac=${watch.mac.backend}</argLine>
         </configuration>
       </plugin>
       <plugin> <!-- code coverage -->
         <groupId>org.jacoco</groupId>
         <artifactId>jacoco-maven-plugin</artifactId>
-        <version>0.8.13</version>
+        <version>0.8.14</version>
         <executions>
           <execution>
             <goals>
@@ -146,6 +154,9 @@
               </excludes>
             </licenseSet>
           </licenseSets>
+          <mapping>
+            <rs>DOUBLESLASH_STYLE</rs> <!-- Use same style for license headers in Rust files as in https://github.com/rust-lang/style-team/blob/main/example/lists.rs -->
+          </mapping>
         </configuration>
         <executions>
           <execution>
@@ -158,7 +169,7 @@
       <plugin> <!-- enforce editor config on the files -->
         <groupId>org.ec4j.maven</groupId>
         <artifactId>editorconfig-maven-plugin</artifactId>
-        <version>0.1.3</version>
+        <version>0.1.17</version>
         <!-- run mvn editorconfig:format to fix errors reported-->
         <executions>
           <execution>
@@ -169,11 +180,16 @@
             </goals>
           </execution>
         </executions>
+        <configuration>
+          <excludes>
+            <exclude>src/main/resources/**</exclude>
+          </excludes>
+        </configuration>
       </plugin>
       <plugin> <!-- use a new version of maven  -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.5.0</version>
+        <version>3.6.2</version>
         <executions>
           <execution>
             <id>enforce-maven</id>
@@ -228,16 +244,6 @@
       <version>${log4j.version}</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>net.java.dev.jna</groupId>
-      <artifactId>jna</artifactId>
-      <version>${jna.version}</version>
-    </dependency>
-    <dependency>
-      <groupId>net.java.dev.jna</groupId>
-      <artifactId>jna-platform</artifactId>
-      <version>${jna.version}</version>
-    </dependency>
   </dependencies>
 
   <profiles>
@@ -248,7 +254,7 @@
           <plugin><!-- uploading to maven central-->
             <groupId>org.sonatype.central</groupId>
             <artifactId>central-publishing-maven-plugin</artifactId>
-            <version>0.7.0</version>
+            <version>0.9.0</version>
             <extensions>true</extensions>
             <configuration>
               <publishingServerId>central</publishingServerId>
@@ -258,7 +264,7 @@
           <plugin> <!-- sign jar for maven central-->
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-gpg-plugin</artifactId>
-            <version>3.2.7</version>
+            <version>3.2.8</version>
             <executions>
               <execution>
                 <id>sign-artifacts</id>
@@ -272,7 +278,7 @@
           <plugin> <!-- generate java-doc -->
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-javadoc-plugin</artifactId>
-            <version>3.11.2</version>
+            <version>3.12.0</version>
             <executions>
               <execution>
                 <id>attach-javadocs</id>
@@ -288,7 +294,7 @@
           <plugin> <!-- generate sources jar -->
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-source-plugin</artifactId>
-            <version>3.3.1</version>
+            <version>3.4.0</version>
             <executions>
               <execution>
                 <id>attach-sources</id>
@@ -311,7 +317,7 @@
             <!-- This plugin will set properties values using dependency information -->
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-dependency-plugin</artifactId>
-            <version>3.8.1</version>
+            <version>3.9.0</version>
             <executions>
               <execution>
                 <goals>
@@ -323,7 +329,7 @@
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-compiler-plugin</artifactId>
-            <version>3.14.0</version>
+            <version>3.14.1</version>
             <configuration>
               <fork>true</fork>
               <release>11</release>

src/main/checkerframework/nio-file.astub

@@ -12,3 +12,8 @@ public interface WatchService {
 public interface WatchEvent<T> {
     @Nullable T context();
 }
+
+public class NoSuchFileException extends FileSystemException {
+    public NoSuchFileException(String file, @Nullable String other, String reason);
+}
+

src/main/java/engineering/swat/watch/DaemonThreadPool.java

@@ -0,0 +1,76 @@
+/*
+ * BSD 2-Clause License
+ *
+ * Copyright (c) 2023, Swat.engineering
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package engineering.swat.watch;
+
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.LinkedBlockingQueue;
+import java.util.concurrent.ThreadFactory;
+import java.util.concurrent.ThreadPoolExecutor;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicInteger;
+
+/**
+ * Build thread pools that even when not properly shutdown, will still not prevent the termination of the JVM.
+ */
+public class DaemonThreadPool {
+    private DaemonThreadPool() {}
+
+    /**
+     * Generate a thread pool that will reuse threads, clear them after a while, but constrain the total amount of threads.
+     * @param name name of the thread pool
+     * @param maxThreads the maximum amount of threads to start in this pool, after this things will get queued.
+     * @return an exectutor with deamon threads and constainted to a certain maximum
+     */
+    public static ExecutorService buildConstrainedCached(String name, int maxThreads) {
+        if (maxThreads <= 0) {
+            throw new IllegalArgumentException("maxThreads should be higher than 0");
+        }
+        var pool = new ThreadPoolExecutor(maxThreads, maxThreads,
+            60, TimeUnit.SECONDS,
+            new LinkedBlockingQueue<>(),
+            buildFactory(name)
+        );
+        pool.allowCoreThreadTimeOut(true);
+        return pool;
+    }
+
+    private static ThreadFactory buildFactory(String name) {
+        return new ThreadFactory() {
+            private final AtomicInteger id = new AtomicInteger(0);
+            private final ThreadGroup group = new ThreadGroup(name);
+            @Override
+            public Thread newThread(Runnable r) {
+                var t = new Thread(group, r, name + "-" + id.getAndIncrement());
+                t.setDaemon(true);
+                return t;
+            }
+        };
+    }
+
+
+
+}