Using com.ibm.wala.cast.python.ml as a library is problematic due to Maven Shade plug-in

[khatchad]

com.ibm.wala.cast.python currently uses the Maven Shade plug-in:

ML/com.ibm.wala.cast.python.ml/pom.xml

Lines 65 to 100 in a8e1d8e

	<plugins>
	<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-shade-plugin</artifactId>
	<version>2.3</version>
	<configuration>
	<filters>
	<filter>
	<artifact>*:*</artifact>
	<excludes>
	<exclude>META-INF/*.SF</exclude>
	<exclude>META-INF/*.DSA</exclude>
	<exclude>META-INF/*.RSA</exclude>
	</excludes>
	</filter>
	</filters>
	<!-- Additional configuration. -->
	</configuration>
	<executions>
	<!-- Run shade goal on package phase -->
	<execution>
	<phase>package</phase>
	<goals>
	<goal>shade</goal>
	</goals>
	<configuration>
	<transformers>
	<!-- add Main-Class to manifest file -->
	<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
	<mainClass>com.ibm.wala.cast.python.ml.driver.Ariadne</mainClass>
	</transformer>
	</transformers>
	</configuration>
	</execution>
	</executions>
	</plugin>

I believe it does this for two reasons:

1. Produce an executable JAR by adding the appropriate MANIFEST.mf file.
2. Produce a standalone JAR that includes all of the dependencies ("uber" JAR).

However, this is problematic for using com.ibm.wala.cast.python.ml as a library:

If the uber JAR is reused as a dependency of some other project, directly including classes from the artifact's dependencies in the uber JAR can cause class loading conflicts due to duplicate classes on the class path.

[msridhar]

Sometimes this can be addressed by shifting classes from dependencies to a different (unlikely to conflict) package name. Is that possible with this plugin?

[khatchad]

Yes, it is. But, I am wondering whether just to use two JARs. The execution one would have some special name. The default JAR would be for library usage.

[khatchad]

See https://maven.apache.org/plugins/maven-shade-plugin/examples/attached-artifact.html

[msridhar]

PR welcome :-)

…

On Apr 14, 2023 at 12:15:21, Raffi Khatchadourian ***@***.***> wrote: See https://maven.apache.org/plugins/maven-shade-plugin/examples/attached-artifact.html — Reply to this email directly, view it on GitHub <#28 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABPEUMJBQA4LX46EK6OIWTXBGO4TANCNFSM6AAAAAAW6XWT5Q> . You are receiving this because you commented.Message ID: ***@***.***>

[khatchad]

Should be solved by #29.