Merge branch 'main' into develop

Author: anidotnet

.github/copilot-instructions.md

@@ -0,0 +1,147 @@
+# Copilot Instructions for Nitrite Database
+
+## Project Overview
+
+Nitrite Database is an open source embedded NoSQL database for Java. It's a multi-module Maven project that supports both in-memory and file-based persistent storage.
+
+**Key Features:**
+- Embedded, serverless document store
+- Document-oriented with schema-less collections
+- Extensible storage engines (MVStore, RocksDB)
+- Full-text search and indexing
+- Transaction support
+- Android compatibility (API Level 26+)
+
+## Repository Structure
+
+This is a multi-module Maven project with the following modules:
+
+- `nitrite` - Core database module
+- `nitrite-bom` - Bill of materials for dependency management
+- `nitrite-jackson-mapper` - Jackson-based JSON mapper
+- `nitrite-mvstore-adapter` - MVStore storage adapter
+- `nitrite-rocksdb-adapter` - RocksDB storage adapter
+- `nitrite-spatial` - Spatial indexing support
+- `nitrite-support` - Support utilities
+- `nitrite-native-tests` - GraalVM native image tests
+- `potassium-nitrite` - Kotlin extension
+
+## Development Environment
+
+### Java Versions
+- **Minimum supported:** Java 11 (as configured in pom.xml)
+- **Primary testing:** Java 11 and 17
+- **Native image testing:** Java 17 and 21 with GraalVM
+
+### Build Tool
+Maven is the build tool. Key commands:
+
+```bash
+# Build the project
+mvn clean install
+
+# Build without tests
+mvn clean install -DskipTests
+
+# Run tests only
+mvn test
+
+# Build specific module
+mvn -pl nitrite clean install
+```
+
+## Code Guidelines
+
+### Java Standards
+1. **Minimum compatibility:** Code must compile and run on Java 11 (as per maven.compiler.source=11 in pom.xml)
+2. **Code style:** Follow existing code formatting in the repository (see `.editorconfig`)
+3. **Dependencies:** Check `pom.xml` files before adding new dependencies
+4. **API changes:** Be cautious with public API changes - this is a library used by others
+
+### Testing Requirements
+1. **Always run tests:** Execute `mvn test` before submitting changes
+2. **Write tests:** New features should include unit tests
+3. **Test coverage:** Maintain or improve code coverage (tracked via CodeCov)
+4. **Cross-platform:** Consider Linux, macOS, and Windows compatibility
+
+### Module-Specific Guidelines
+- When modifying storage adapters (`nitrite-mvstore-adapter`, `nitrite-rocksdb-adapter`), ensure compatibility with the core module
+- Changes to `nitrite` core module may require updates to adapter modules
+- Kotlin extension (`potassium-nitrite`) should mirror Java API capabilities
+
+## Pull Request Best Practices
+
+### Before Creating a PR
+1. Run full build: `mvn clean install`
+2. Ensure all tests pass across Java 11 and 17
+3. Check for compilation warnings
+4. Update documentation if changing public APIs
+5. Add or update tests for your changes
+
+### PR Scope
+- Keep PRs focused on a single issue or feature
+- Include issue references in PR description
+- Document breaking changes clearly
+- Update CHANGELOG.md for significant changes
+
+### Review Process
+- All PRs require review before merging
+- CI must pass (build on Linux, macOS, Windows)
+- CodeQL security analysis must pass
+- Code coverage should not decrease significantly
+
+## Security Considerations
+
+1. **No secrets in code:** Never commit API keys, passwords, or credentials
+2. **Input validation:** Validate all user inputs, especially in query operations
+3. **File operations:** Be careful with file I/O operations in storage adapters
+4. **Dependencies:** Check for known vulnerabilities in dependencies
+5. **CodeQL:** Address any CodeQL security findings
+
+## Common Tasks
+
+### Good Tasks for Copilot
+- Bug fixes in specific modules
+- Adding unit tests to improve coverage
+- Documentation updates (JavaDoc, README)
+- Code style and formatting improvements
+- Refactoring isolated methods/classes
+- Adding new query operators or filters
+- Implementing feature requests with clear specifications
+
+### Tasks Requiring Human Review
+- Breaking API changes
+- Changes to core database engine logic
+- Modifications to transaction handling
+- Storage format changes
+- Security-sensitive operations
+- Multi-module architectural changes
+
+## Documentation
+
+- **JavaDoc:** All public APIs must have JavaDoc comments
+- **README updates:** Update README.md if changing features or usage
+- **User guide:** Major features may need documentation at https://nitrite.dizitart.com
+- **Code comments:** Add comments for complex logic, not obvious code
+
+## Gradle vs Maven
+This project uses **Maven**, not Gradle. All build commands should use `mvn`.
+
+## Related Projects
+
+- **Potassium Nitrite:** Kotlin extension within this repository
+- **Nitrite Flutter:** Separate repository for Flutter/Dart version
+- **Deprecated:** Nitrite DataGate and Nitrite Explorer (no longer maintained)
+
+## Communication
+
+- **Issues:** Use GitHub issues for bugs and feature requests
+- **Discussions:** Use GitHub Discussions for questions and community interaction
+- **Contributing:** See CONTRIBUTING.md for detailed contribution guidelines
+
+## Additional Resources
+
+- **Website:** https://nitrite.dizitart.com
+- **Documentation:** https://nitrite.dizitart.com/java-sdk/getting-started/index.html
+- **API Docs:** https://javadoc.io/doc/org.dizitart/nitrite
+- **GitHub:** https://github.com/nitrite/nitrite-java

.github/dependabot.yml

@@ -9,6 +9,12 @@ updates:
       # Ignore minor version updates for dependencies with group ID "com.google.errorprone"
       - dependency-name: "com.google.errorprone:*"
         update-types: [ "version-update:semver-minor" ]
+      # Pin RocksDB to version 10.2.1
+      - dependency-name: "org.rocksdb:rocksdbjni"
+        update-types: [ "version-update:semver-major", "version-update:semver-minor", "version-update:semver-patch" ]
+      # Pin JUnit BOM to version 6.0.0
+      - dependency-name: "org.junit:junit-bom"
+        update-types: [ "version-update:semver-major", "version-update:semver-minor", "version-update:semver-patch" ]
     groups:
       security:
         # Group security updates into a single pull request

.github/workflows/build.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        java: [ '11', '17' ]
+        java: [ '17' ]
     env:
       JAVA_OPTS: "-XX:+TieredCompilation -XX:TieredStopAtLevel=1"
 
@@ -42,7 +42,7 @@ jobs:
         run: mvn -B -ff -ntp clean install
 
       - name: Publish Code Coverage
-        if: github.ref == 'refs/heads/main' && matrix.java == '11'
+        if: github.ref == 'refs/heads/main' && matrix.java == '17'
         uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
@@ -53,7 +53,7 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        java: [ '11', '17' ]
+        java: [ '17' ]
     env:
       JAVA_OPTS: "-XX:+TieredCompilation -XX:TieredStopAtLevel=1"
 
@@ -76,7 +76,7 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        java: [ '11', '17' ]
+        java: [ '17' ]
     env:
       JAVA_OPTS: "-XX:+TieredCompilation -XX:TieredStopAtLevel=1"
 
@@ -105,7 +105,7 @@ jobs:
     steps:
       - uses: actions/checkout@v5
 
-      - uses: graalvm/setup-graalvm@v1.3.7
+      - uses: graalvm/setup-graalvm@v1.4.2
         with:
           java-version: ${{ matrix.java }}
           distribution: 'graalvm-community'

.github/workflows/codeql-analysis.yml

@@ -33,14 +33,14 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
+        uses: github/codeql-action/init@v4
         with:
           languages: ${{ matrix.language }}
 
       # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
       # If this step fails, then you should remove it and run the build manually (see below)
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v3
+        uses: github/codeql-action/autobuild@v4
 
       # ℹ️ Command-line programs to run using the OS shell.
       # 📚 https://git.io/JvXDl
@@ -54,4 +54,4 @@ jobs:
       #   make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
+        uses: github/codeql-action/analyze@v4

README.md

@@ -28,7 +28,7 @@ Nitrite is an embedded database ideal for desktop, mobile or small web applicati
 - Transaction support
 - Schema migration support
 - Encryption support
-- Android compatibility (API Level 24)
+- Android compatibility (API Level 26)
 
 ## Kotlin Extension
 

nitrite-bom/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.dizitart</groupId>
         <artifactId>nitrite-java</artifactId>
-        <version>4.3.2-SNAPSHOT</version>
+        <version>4.3.3-SNAPSHOT</version>
     </parent>
 
     <artifactId>nitrite-bom</artifactId>
@@ -15,6 +15,8 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <!-- Skip flattening for BOM module to preserve dependencyManagement section -->
+        <flatten.skip>true</flatten.skip>
     </properties>
 
     <dependencyManagement>

nitrite-jackson-mapper/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.dizitart</groupId>
         <artifactId>nitrite-java</artifactId>
-        <version>4.3.2-SNAPSHOT</version>
+        <version>4.3.3-SNAPSHOT</version>
     </parent>
 
     <artifactId>nitrite-jackson-mapper</artifactId>

nitrite-mvstore-adapter/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.dizitart</groupId>
         <artifactId>nitrite-java</artifactId>
-        <version>4.3.2-SNAPSHOT</version>
+        <version>4.3.3-SNAPSHOT</version>
     </parent>
 
     <artifactId>nitrite-mvstore-adapter</artifactId>

nitrite-mvstore-adapter/src/test/java/org/dizitart/no2/integration/collection/CollectionCompoundIndexTest.java

@@ -242,10 +242,10 @@ public void testIssue178() {
         assertEquals(cursor.size(), 1);
 
         cursor = collection.find(where("field1").eq(5));
-        assertEquals(cursor.size(), 1);
+        assertEquals(cursor.size(), 2);
 
         cursor = collection.find(where("field1").eq(5.0));
-        assertEquals(cursor.size(), 1);
+        assertEquals(cursor.size(), 2);
 
         collection.createIndex("field1", "field2");
         cursor = collection.find(and(where("field1").eq(0.03),
@@ -257,10 +257,10 @@ public void testIssue178() {
         assertEquals(cursor.size(), 1);
 
         cursor = collection.find(where("field1").eq(5));
-        assertEquals(cursor.size(), 1);
+        assertEquals(cursor.size(), 2);
 
         cursor = collection.find(where("field1").eq(5.0));
-        assertEquals(cursor.size(), 1);
+        assertEquals(cursor.size(), 2);
     }
 
     @Test

nitrite-mvstore-adapter/src/test/java/org/dizitart/no2/integration/collection/CollectionFindByCompoundIndexTest.java

@@ -200,7 +200,7 @@ public void testFindByOrFilter() throws ParseException {
 
         FindPlan findPlan = cursor.getFindPlan();
         assertEquals(3, findPlan.getSubPlans().size());
-        assertEquals(5, cursor.size());
+        assertEquals(3, cursor.size());
 
         // distinct
         cursor = collection.find(