Fixes #3741 - Move Eclipse Yasson dependency and its usage into a Pir…

…anha Extension module (#3742)
piranhacloud · May 29, 2024 · 1c695ee · 1c695ee
1 parent fcbfe46
commit 1c695ee
Show file tree

Hide file tree

Showing 15 changed files with 183 additions and 51 deletions.
diff --git a/COMPONENTS.md b/COMPONENTS.md
@@ -4,6 +4,7 @@
 |-----------------------|---------------|
 | Eclipse Grizzly       | 4.0.2         |
 | Eclipse Grizzly NPN   | 2.0.0         |
+| Eclipse Yasson        | 3.0.3         |
 | Netty                 | 4.1.108.Final |
 | Project CRaC          | 0.1.3         |
 | RedHat Undertow       | 2.3.12.Final  |

diff --git a/extension/coreprofile/pom.xml b/extension/coreprofile/pom.xml
@@ -51,25 +51,26 @@
         </dependency>
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
-            <artifactId>piranha-extension-naming</artifactId>
+            <artifactId>piranha-extension-eclipse-yasson</artifactId>
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
-            <artifactId>piranha-extension-redhat-weld</artifactId>
+            <artifactId>piranha-extension-naming</artifactId>
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
-            <artifactId>piranha-extension-scinitializer</artifactId>
+            <artifactId>piranha-extension-redhat-weld</artifactId>
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
-            <groupId>org.eclipse</groupId>
-            <artifactId>yasson</artifactId>
+            <groupId>cloud.piranha.extension</groupId>
+            <artifactId>piranha-extension-scinitializer</artifactId>
+            <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
     </dependencies>

diff --git a/extension/coreprofile/src/main/java/module-info.java b/extension/coreprofile/src/main/java/module-info.java
@@ -54,6 +54,5 @@
     requires cloud.piranha.extension.jersey;
     requires cloud.piranha.extension.naming;
     requires cloud.piranha.extension.scinitializer;
-    requires org.eclipse.parsson;
-    requires org.eclipse.yasson;
+    requires cloud.piranha.extension.yasson;
 }
diff --git a/extension/eclipse-yasson/pom.xml b/extension/eclipse-yasson/pom.xml
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>cloud.piranha.extension</groupId>
+        <artifactId>project</artifactId>
+        <version>24.6.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>piranha-extension-eclipse-yasson</artifactId>
+    <packaging>jar</packaging>
+
+    <name>Piranha - Extension - Eclipse Yasson</name>
+    <properties>
+        <yasson.version>3.0.3</yasson.version>
+    </properties>
+    <dependencies>
+        <!-- compile -->
+        <dependency>
+            <groupId>cloud.piranha.core</groupId>
+            <artifactId>piranha-core-api</artifactId>
+            <version>${project.version}</version>
+            <scope>compile</scope>
+        </dependency>
+        <!-- provided -->
+        <dependency>
+            <groupId>cloud.piranha.extension</groupId>
+            <artifactId>piranha-extension-scinitializer</artifactId>
+            <version>${project.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <!-- runtime -->
+        <dependency>
+            <groupId>org.eclipse</groupId>
+            <artifactId>yasson</artifactId>
+            <version>${yasson.version}</version>
+            <scope>runtime</scope>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/extension/eclipse-yasson/src/main/java/cloud/piranha/extension/yasson/YassonExtension.java b/extension/eclipse-yasson/src/main/java/cloud/piranha/extension/yasson/YassonExtension.java
@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2002-2024 Manorrock.com. All Rights Reserved.
+ *
+ * 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.
+ *   3. Neither the name of the copyright holder nor the names of its
+ *      contributors may be used to endorse or promote products derived from
+ *      this software without specific prior written permission.
+ *
+ * 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 cloud.piranha.extension.yasson;
+
+import cloud.piranha.core.api.WebApplication;
+import cloud.piranha.core.api.WebApplicationExtension;
+import java.lang.System.Logger;
+import static java.lang.System.Logger.Level.TRACE;
+
+/**
+ * The extension that delivers Eclipse Yasson to Piranha.
+ *
+ * @author Manfred Riem ([email protected])
+ */
+public class YassonExtension implements WebApplicationExtension {
+
+    /**
+     * Stores the logger.
+     */
+    private static final Logger LOGGER = System.getLogger(YassonExtension.class.getName());
+
+    /**
+     * Configure the extension.
+     * 
+     * @param webApplication the web application.
+     */
+    @Override
+    public void configure(WebApplication webApplication) {
+        LOGGER.log(TRACE, "Configuring Yasson extension");
+    }
+}
diff --git a/extension/eclipse-yasson/src/main/java/module-info.java b/extension/eclipse-yasson/src/main/java/module-info.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2002-2024 Manorrock.com. All Rights Reserved.
+ *
+ * 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.
+ *   3. Neither the name of the copyright holder nor the names of its
+ *      contributors may be used to endorse or promote products derived from
+ *      this software without specific prior written permission.
+ *
+ * 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.
+ */
+
+/**
+ * This module delivers the Eclipse Yasson integration extension.
+ *
+ * <p>
+ *  This extension integrates Eclipse Yasson into Piranha. See 
+ *  https://github.com/eclipse-ee4j/yasson for more information about its
+ *  project.
+ * </p>
+ * 
+ * @author Manfred Riem ([email protected])
+ */
+module cloud.piranha.extension.yasson {
+
+    requires cloud.piranha.core.api;
+    requires static cloud.piranha.extension.scinitializer;
+}
diff --git a/extension/micro/pom.xml b/extension/micro/pom.xml
@@ -28,7 +28,6 @@
             <artifactId>piranha-core-impl</artifactId>
             <version>${project.version}</version>
         </dependency>
-
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
             <artifactId>piranha-extension-apache-fileupload</artifactId>
@@ -71,6 +70,12 @@
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>cloud.piranha.extension</groupId>
+            <artifactId>piranha-extension-eclipse-yasson</artifactId>
+            <version>${project.version}</version>
+            <scope>compile</scope>
+        </dependency> 
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
             <artifactId>piranha-extension-policy</artifactId>
@@ -82,7 +87,6 @@
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
-        <!-- RedHat Weld -->
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
             <artifactId>piranha-extension-redhat-weld</artifactId>
@@ -111,7 +115,7 @@
             <artifactId>piranha-extension-tempdir</artifactId>
             <version>${project.version}</version>
             <scope>compile</scope>
-        </dependency> 
+        </dependency>
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
             <artifactId>piranha-extension-webxml</artifactId>
@@ -154,13 +158,6 @@
             <scope>runtime</scope>
         </dependency>
 
-        <!-- Jakarta JSON Binding implementation  -->
-        <dependency>
-            <groupId>org.eclipse</groupId>
-            <artifactId>yasson</artifactId>
-            <scope>runtime</scope>
-        </dependency>
-
         <!-- Jakarta Validation API -->
         <dependency>
             <groupId>jakarta.validation</groupId>

diff --git a/extension/microprofile/pom.xml b/extension/microprofile/pom.xml
@@ -45,26 +45,26 @@
         </dependency>
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
-            <artifactId>piranha-extension-naming</artifactId>
+            <artifactId>piranha-extension-eclipse-yasson</artifactId>
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
-        <!-- RedHat Weld -->
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
-            <artifactId>piranha-extension-redhat-weld</artifactId>
+            <artifactId>piranha-extension-naming</artifactId>
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
-            <artifactId>piranha-extension-scinitializer</artifactId>
+            <artifactId>piranha-extension-redhat-weld</artifactId>
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
-            <groupId>org.eclipse</groupId>
-            <artifactId>yasson</artifactId>
+            <groupId>cloud.piranha.extension</groupId>
+            <artifactId>piranha-extension-scinitializer</artifactId>
+            <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
     </dependencies>

diff --git a/extension/microprofile/src/main/java/module-info.java b/extension/microprofile/src/main/java/module-info.java
@@ -52,6 +52,5 @@
     requires cloud.piranha.extension.jersey;
     requires cloud.piranha.extension.naming;
     requires cloud.piranha.extension.scinitializer;
-    requires org.eclipse.parsson;
-    requires org.eclipse.yasson;
+    requires cloud.piranha.extension.yasson;
 }
diff --git a/extension/platform/pom.xml b/extension/platform/pom.xml
@@ -49,6 +49,12 @@
             <artifactId>piranha-extension-eclipse-jersey</artifactId>
             <version>${project.version}</version>
             <scope>compile</scope>
+        </dependency> 
+        <dependency>
+            <groupId>cloud.piranha.extension</groupId>
+            <artifactId>piranha-extension-eclipse-yasson</artifactId>
+            <version>${project.version}</version>
+            <scope>compile</scope>
         </dependency>       
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
@@ -68,10 +74,5 @@
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>       
-        <dependency>
-            <groupId>org.eclipse</groupId>
-            <artifactId>yasson</artifactId>
-            <scope>compile</scope>
-        </dependency>
     </dependencies>
 </project>
diff --git a/extension/platform/src/main/java/module-info.java b/extension/platform/src/main/java/module-info.java
@@ -54,6 +54,5 @@
     requires cloud.piranha.extension.jersey;
     requires cloud.piranha.extension.naming;
     requires cloud.piranha.extension.scinitializer;
-    requires org.eclipse.parsson;
-    requires org.eclipse.yasson;
+    requires cloud.piranha.extension.yasson;
 }
diff --git a/extension/pom.xml b/extension/pom.xml
@@ -30,6 +30,7 @@
         <module>eclipse-jersey</module>
         <module>eclipse-mojarra</module>
         <module>eclipse-soteria</module>
+        <module>eclipse-yasson</module>
         <module>eclipse-wasp</module>
         <module>eclipselink</module>
         <module>hazelcast</module>

diff --git a/pom.xml b/pom.xml
@@ -107,7 +107,6 @@
         <spring-boot.version>3.2.3</spring-boot.version>
         <transact-cdi-beans.version>1.0.1</transact-cdi-beans.version>
         <tyrus.version>2.1.5</tyrus.version>
-        <yasson.version>3.0.3</yasson.version>
         <!-- plugins -->
         <build-helper-maven-plugin.version>3.5.0</build-helper-maven-plugin.version>
         <clirr-maven-plugin.version>2.8</clirr-maven-plugin.version>
@@ -234,13 +233,6 @@
                 <artifactId>tyrus-container-servlet</artifactId>
                 <version>${tyrus.version}</version>
             </dependency>
-
-            <!-- Eclipse Yasson  -->
-            <dependency>
-                <groupId>org.eclipse</groupId>
-                <artifactId>yasson</artifactId>
-                <version>${yasson.version}</version>
-            </dependency>
 
             <!-- Freeport Finder -->
             <dependency>

diff --git a/test/debug/pom.xml b/test/debug/pom.xml
@@ -94,6 +94,11 @@
             <artifactId>piranha-extension-eclipse-soteria</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>cloud.piranha.extension</groupId>
+            <artifactId>piranha-extension-eclipse-yasson</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
             <artifactId>piranha-extension-eclipse-wasp</artifactId>
@@ -428,12 +433,6 @@
             <artifactId>tyrus-container-servlet</artifactId>
         </dependency>
 
-        <!-- Eclipse Yasson -->
-        <dependency>
-            <groupId>org.eclipse</groupId>
-            <artifactId>yasson</artifactId>
-        </dependency>
-
         <!-- Freeport Finder -->
         <dependency>
             <groupId>me.alexpanov</groupId>

diff --git a/test/embedded/eclipselink/pom.xml b/test/embedded/eclipselink/pom.xml
@@ -67,6 +67,12 @@
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>cloud.piranha.extension</groupId>
+            <artifactId>piranha-extension-eclipse-yasson</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
             <artifactId>piranha-extension-naming</artifactId>
@@ -106,11 +112,6 @@
             <artifactId>jakarta.websocket-client-api</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>org.eclipse</groupId>
-            <artifactId>yasson</artifactId>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>