Tracking if NDatabase is shaded

NivixX · Oct 29, 2024 · e42efe8 · e42efe8
1 parent b3758a8
commit e42efe8
Show file tree

Hide file tree

Showing 19 changed files with 84 additions and 66 deletions.
diff --git a/ndatabase-api/pom.xml b/ndatabase-api/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <artifactId>ndatabase</artifactId>
         <groupId>com.nivixx</groupId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/ndatabase-api/src/main/java/com/nivixx/ndatabase/api/NDatabase.java b/ndatabase-api/src/main/java/com/nivixx/ndatabase/api/NDatabase.java
@@ -10,23 +10,40 @@ public class NDatabase {
 
     private static NDatabaseAPI instance;
 
+    private final static String API_BASE_PACKAGE = "com.nivixx.ndatabase.api";
+
     /**
-     *
      * @return the api interface to operate NDatabase.
      * The actual implementation will differ depending on what platform
      * you are currently using.
      */
     public static NDatabaseAPI api() {
         NDatabaseAPI instance = NDatabase.instance;
-        if (instance == null) {
-            throw new IllegalStateException("NDatabase has not loaded yet. Verify that your plugin configuration include NDatabase in dependencies.");
-        } else {
+
+        if (instance != null) {
             return instance;
         }
+
+        // Check if NDatabase is not shaded into the plugin
+        // That may prevent from retrieving the correct singleton API instance
+        String callerPackage = NDatabase.class.getPackage().getName();
+        if (!Objects.equals(API_BASE_PACKAGE, callerPackage)) {
+            throw new IllegalStateException(String.format(
+                    "NDatabase has not loaded yet. " +
+                            "it looks like you are calling NDatabase.api() from a different package location:" +
+                            "%s instead of the original instance located in %s." +
+                            "Perhaps you are shading NDatabase into your .jar ? Make sure to declare " +
+                            "NDatabase dependency with scope \"provided\" or exclude it from your packaging.",
+                    callerPackage, API_BASE_PACKAGE));
+
+        }
+
+        // Trying to get api while not loaded yet, probably because NDatabase is not added into dependencies
+        throw new IllegalStateException("NDatabase has not loaded yet. Verify that your plugin configuration include NDatabase in dependencies.");
     }
 
     // Note: the NDatabaseAPI instance is set by the core module after loaded
-    static void set(NDatabaseAPI nDatabaseAPI) {
+    static void set(NDatabaseAPI nDatabaseAPI){
         Objects.requireNonNull(nDatabaseAPI,
                 "The NDatabase instance is null, probably due to a Google Guice incompatibility issue with java/spigot or other plugin.");
         instance = nDatabaseAPI;
@@ -35,4 +52,5 @@ static void set(NDatabaseAPI nDatabaseAPI) {
     private NDatabase() {
         throw new AssertionError("illegal constructor called");
     }
-}
+
+}
diff --git a/ndatabase-core/pom.xml b/ndatabase-core/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <artifactId>ndatabase</artifactId>
         <groupId>com.nivixx</groupId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -20,52 +20,52 @@
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-expressiontree</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-core</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-jdbc</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-mysql</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-sqlite</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-mongodb</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-mariadb</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>core-platform</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
     </dependencies>
 

diff --git a/ndatabase-dbms-api/pom.xml b/ndatabase-dbms-api/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.nivixx</groupId>
         <artifactId>ndatabase</artifactId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
 
     <artifactId>ndatabase-dbms-api</artifactId>
@@ -21,19 +21,19 @@
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-expressiontree</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>core-platform</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
     </dependencies>
 

diff --git a/ndatabase-dbms-core/pom.xml b/ndatabase-dbms-core/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.nivixx</groupId>
         <artifactId>ndatabase</artifactId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
 
     <artifactId>ndatabase-dbms-core</artifactId>
@@ -21,24 +21,24 @@
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-expressiontree</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>core-platform</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
     </dependencies>
 

diff --git a/ndatabase-dbms-jdbc/pom.xml b/ndatabase-dbms-jdbc/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.nivixx</groupId>
         <artifactId>ndatabase</artifactId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
 
     <artifactId>ndatabase-dbms-jdbc</artifactId>
@@ -21,13 +21,13 @@
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-core</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
     </dependencies>

diff --git a/ndatabase-dbms-mariadb/pom.xml b/ndatabase-dbms-mariadb/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.nivixx</groupId>
         <artifactId>ndatabase</artifactId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
 
     <artifactId>ndatabase-dbms-mariadb</artifactId>
@@ -21,13 +21,13 @@
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-jdbc</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
     </dependencies>

diff --git a/ndatabase-dbms-mongodb/pom.xml b/ndatabase-dbms-mongodb/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.nivixx</groupId>
         <artifactId>ndatabase</artifactId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
 
     <artifactId>ndatabase-dbms-mongodb</artifactId>
@@ -20,13 +20,13 @@
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-core</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
         <dependency>

diff --git a/ndatabase-dbms-mysql/pom.xml b/ndatabase-dbms-mysql/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.nivixx</groupId>
         <artifactId>ndatabase</artifactId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
 
     <artifactId>ndatabase-dbms-mysql</artifactId>
@@ -21,13 +21,13 @@
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-jdbc</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
     </dependencies>

diff --git a/ndatabase-dbms-sqlite/pom.xml b/ndatabase-dbms-sqlite/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.nivixx</groupId>
         <artifactId>ndatabase</artifactId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
 
     <artifactId>ndatabase-dbms-sqlite</artifactId>
@@ -22,13 +22,13 @@
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-dbms-jdbc</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
     </dependencies>

diff --git a/ndatabase-expressiontree/pom.xml b/ndatabase-expressiontree/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.nivixx</groupId>
         <artifactId>ndatabase</artifactId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
 
     <artifactId>ndatabase-expressiontree</artifactId>
@@ -21,7 +21,7 @@
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-api</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
 
     </dependencies>

diff --git a/ndatabase-packaging-jar/pom.xml b/ndatabase-packaging-jar/pom.xml
@@ -7,11 +7,11 @@
     <parent>
         <groupId>com.nivixx</groupId>
         <artifactId>ndatabase</artifactId>
-        <version>1.4.1-SNAPSHOT</version>
+        <version>1.4.2-SNAPSHOT</version>
     </parent>
     <packaging>jar</packaging>
     <artifactId>ndatabase-packaging-jar</artifactId>
-    <version>1.4.1-SNAPSHOT</version>
+    <version>1.4.2-SNAPSHOT</version>
 
 
     <build>
@@ -51,17 +51,17 @@
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>ndatabase-core</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>app-platform</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.nivixx</groupId>
             <artifactId>bukkit-platform</artifactId>
-            <version>1.4.1-SNAPSHOT</version>
+            <version>1.4.2-SNAPSHOT</version>
         </dependency>
     </dependencies>
 

diff --git a/ndatabase-packaging-jar/src/main/resources/plugin.yml b/ndatabase-packaging-jar/src/main/resources/plugin.yml
@@ -1,6 +1,6 @@
 name: NDatabase
 main: com.nivixx.ndatabase.platforms.bukkitplatform.NDatabasePlugin
-version: 1.4.1
+version: 1.4.2
 description: A lightweight centralised Key-value style database
 api-version: 1.13
 authors: [NivixX]