Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CELEBORN-1477][FOLLOWUP] Fix shaded celeborn-openapi-client dependency lack issue #2640

Closed
wants to merge 1 commit into from

Conversation

turboFei
Copy link
Member

@turboFei turboFei commented Jul 23, 2024

What changes were proposed in this pull request?

I am working on the integration with our devOps tool integration, and found issues due to dependency lack in the shaded jar:
Likes:

java.lang.NoClassDefFoundError: org/apache/celeborn/shaded/com/fasterxml/jackson/core/Versioned
	at java.lang.ClassLoader.defineClass1(Native Method)
	at java.lang.ClassLoader.defineClass(ClassLoader.java:757)
	at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:142)
	at java.net.URLClassLoader.defineClass(URLClassLoader.java:473)
	at java.net.URLClassLoader.access$100(URLClassLoader.java:74)
	at java.net.URLClassLoader$1.run(URLClassLoader.java:369)
	at java.net.URLClassLoader$1.run(URLClassLoader.java:363)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.net.URLClassLoader.findClass(URLClassLoader.java:362)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:419)
	at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:352)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:352)
	at org.apache.celeborn.rest.v1.master.invoker.ApiClient.<init>(ApiClient.java:122)
	at org.apache.celeborn.rest.v1.master.invoker.ApiClient.<init>(ApiClient.java:113)



java.lang.NoClassDefFoundError: org/apache/celeborn/shaded/org/glassfish/jersey/ExtendedConfig
	at org.apache.celeborn.rest.v1.master.invoker.ApiClient.getDefaultClientConfig(ApiClient.java:1132)
	at org.apache.celeborn.rest.v1.master.invoker.ApiClient.buildHttpClient(ApiClient.java:1118)
	at org.apache.celeborn.rest.v1.master.invoker.ApiClient.<init>(ApiClient.java:123)
	at org.apache.celeborn.rest.v1.master.invoker.ApiClient.<init>(ApiClient.java:113)

In this PR, I include all the necessary dependencies.

Why are the changes needed?

Fix above issues.

Does this PR introduce any user-facing change?

No.

How was this patch tested?

Testing with sample maven project.

pom.xml:

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>test_openapi</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.apache.celeborn</groupId>
            <artifactId>celeborn-openapi-client_2.12</artifactId>
            <version>0.6.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

Testing code:

package org.example;

import org.apache.celeborn.rest.v1.master.MasterApi;
import org.apache.celeborn.rest.v1.master.WorkerApi;
import org.apache.celeborn.rest.v1.master.invoker.ApiClient;

public class Main {
    public static void main(String[] args) throws Exception {

        String cmUrl = "http://***:9098";
        MasterApi masterApi  = new MasterApi(new ApiClient().setBasePath(cmUrl));
        System.out.println(masterApi.getMasterGroupInfo().getLeader().getAddress().split(":")[0]);
        WorkerApi workerApi = new WorkerApi(new ApiClient().setBasePath(cmUrl));
        System.out.println(workerApi.getWorkers());
        System.out.println(workerApi.getWorkerEvents());
    }
}
java -Dfile.encoding=UTF-8 -classpath /Users/fwang12/todo/test_openapi/target/classes:/Users/fwang12/todo/celeborn/openapi/openapi-client/target/celeborn-openapi-client_2.12-0.6.0-SNAPSHOT.jar org.example.Main
image

@turboFei turboFei marked this pull request as draft July 23, 2024 18:46
@turboFei turboFei force-pushed the fix_no_classfound branch 2 times, most recently from aa7e092 to 08452ae Compare July 24, 2024 06:01
jersey common

jvnet

work

jersey-common

shade

save

fix

save

deps

order

sbt

native-image

maven
@turboFei turboFei force-pushed the fix_no_classfound branch from 08452ae to 2124882 Compare July 24, 2024 06:05
@turboFei turboFei self-assigned this Jul 24, 2024
@turboFei turboFei marked this pull request as ready for review July 24, 2024 06:42
@turboFei turboFei changed the title jackson core [CELEBORN-1477][FOLLOWUP] Fix shaded celeborn-openapi-client dependency lack issue Jul 24, 2024
@turboFei
Copy link
Member Author

turboFei commented Jul 24, 2024

Maven:

jar -tf openapi/openapi-client/target/celeborn-openapi-client_2.12-0.6.0-SNAPSHOT.jar|grep -v celeborn
org/
org/apache/
META-INF/
META-INF/maven/
META-INF/maven/io.swagger/
META-INF/maven/io.swagger/swagger-annotations/
META-INF/maven/io.swagger/swagger-annotations/pom.xml
META-INF/maven/io.swagger/swagger-annotations/pom.properties
META-INF/maven/io.swagger/swagger-models/
META-INF/maven/io.swagger/swagger-models/pom.xml
META-INF/maven/io.swagger/swagger-models/pom.properties
META-INF/services/
META-INF/maven/org.openapitools/
META-INF/maven/org.openapitools/jackson-databind-nullable/
META-INF/maven/org.openapitools/jackson-databind-nullable/pom.xml
META-INF/maven/org.openapitools/jackson-databind-nullable/pom.properties
META-INF/maven/jakarta.annotation/
META-INF/maven/jakarta.annotation/jakarta.annotation-api/
META-INF/maven/jakarta.annotation/jakarta.annotation-api/pom.properties
META-INF/maven/jakarta.annotation/jakarta.annotation-api/pom.xml
META-INF/maven/jakarta.ws.rs/
META-INF/maven/jakarta.ws.rs/jakarta.ws.rs-api/
META-INF/maven/jakarta.ws.rs/jakarta.ws.rs-api/pom.properties
META-INF/maven/jakarta.ws.rs/jakarta.ws.rs-api/pom.xml
META-INF/maven/org.glassfish.hk2.external/
META-INF/maven/org.glassfish.hk2.external/jakarta.inject/
META-INF/maven/org.glassfish.hk2.external/jakarta.inject/pom.xml
META-INF/maven/org.glassfish.hk2.external/jakarta.inject/pom.properties
META-INF/maven/org.glassfish.jersey.core/
META-INF/maven/org.glassfish.jersey.core/jersey-client/
META-INF/maven/org.glassfish.jersey.core/jersey-client/pom.properties
META-INF/maven/org.glassfish.jersey.core/jersey-client/pom.xml
META-INF/maven/org.glassfish.jersey.core/jersey-common/
META-INF/maven/org.glassfish.jersey.core/jersey-common/pom.properties
META-INF/maven/org.glassfish.jersey.core/jersey-common/pom.xml
META-INF/versions/
META-INF/versions/11/
META-INF/versions/11/org/
META-INF/versions/11/org/apache/
META-INF/maven/org.glassfish.jersey.ext/
META-INF/maven/org.glassfish.jersey.ext/jersey-entity-filtering/
META-INF/maven/org.glassfish.jersey.ext/jersey-entity-filtering/pom.properties
META-INF/maven/org.glassfish.jersey.ext/jersey-entity-filtering/pom.xml
META-INF/maven/org.glassfish.jersey.media/
META-INF/maven/org.glassfish.jersey.media/jersey-media-json-jackson/
META-INF/maven/org.glassfish.jersey.media/jersey-media-json-jackson/pom.properties
META-INF/maven/org.glassfish.jersey.media/jersey-media-json-jackson/pom.xml
META-INF/maven/com.fasterxml.jackson.core/
META-INF/maven/com.fasterxml.jackson.core/jackson-annotations/
META-INF/maven/com.fasterxml.jackson.core/jackson-annotations/pom.xml
META-INF/maven/com.fasterxml.jackson.core/jackson-annotations/pom.properties
META-INF/maven/com.fasterxml.jackson.core/jackson-core/
META-INF/maven/com.fasterxml.jackson.core/jackson-core/pom.xml
META-INF/maven/com.fasterxml.jackson.core/jackson-core/pom.properties
META-INF/versions/17/
META-INF/versions/17/org/
META-INF/versions/17/org/apache/
META-INF/versions/19/
META-INF/versions/19/org/
META-INF/versions/19/org/apache/
META-INF/maven/com.fasterxml.jackson.core/jackson-databind/
META-INF/maven/com.fasterxml.jackson.core/jackson-databind/pom.xml
META-INF/maven/com.fasterxml.jackson.core/jackson-databind/pom.properties
META-INF/maven/com.fasterxml.jackson.datatype/
META-INF/maven/com.fasterxml.jackson.datatype/jackson-datatype-jsr310/
META-INF/maven/com.fasterxml.jackson.datatype/jackson-datatype-jsr310/pom.properties
META-INF/maven/com.fasterxml.jackson.datatype/jackson-datatype-jsr310/pom.xml
META-INF/maven/org.glassfish.jersey.media/jersey-media-multipart/
META-INF/maven/org.glassfish.jersey.media/jersey-media-multipart/pom.properties
META-INF/maven/org.glassfish.jersey.media/jersey-media-multipart/pom.xml
META-INF/maven/org.jvnet.mimepull/
META-INF/maven/org.jvnet.mimepull/mimepull/
META-INF/maven/org.jvnet.mimepull/mimepull/pom.xml
META-INF/maven/org.jvnet.mimepull/mimepull/pom.properties

SBT:

jar -tf openapi/openapi-client/target/scala-2.12/celeborn-openapi-client_2.12-0.6.0-SNAPSHOT.jar|grep -v celeborn
META-INF/
META-INF/MANIFEST.MF
META-INF/maven/
META-INF/maven/com.fasterxml.jackson.core/
META-INF/maven/com.fasterxml.jackson.core/jackson-annotations/
META-INF/maven/com.fasterxml.jackson.core/jackson-annotations/pom.properties
META-INF/maven/com.fasterxml.jackson.core/jackson-annotations/pom.xml
META-INF/maven/com.fasterxml.jackson.core/jackson-core/
META-INF/maven/com.fasterxml.jackson.core/jackson-core/pom.properties
META-INF/maven/com.fasterxml.jackson.core/jackson-core/pom.xml
META-INF/maven/com.fasterxml.jackson.core/jackson-databind/
META-INF/maven/com.fasterxml.jackson.core/jackson-databind/pom.properties
META-INF/maven/com.fasterxml.jackson.core/jackson-databind/pom.xml
META-INF/maven/com.fasterxml.jackson.datatype/
META-INF/maven/com.fasterxml.jackson.datatype/jackson-datatype-jsr310/
META-INF/maven/com.fasterxml.jackson.datatype/jackson-datatype-jsr310/pom.properties
META-INF/maven/com.fasterxml.jackson.datatype/jackson-datatype-jsr310/pom.xml
META-INF/maven/io.swagger/
META-INF/maven/io.swagger/swagger-annotations/
META-INF/maven/io.swagger/swagger-annotations/pom.properties
META-INF/maven/io.swagger/swagger-annotations/pom.xml
META-INF/maven/io.swagger/swagger-models/
META-INF/maven/io.swagger/swagger-models/pom.properties
META-INF/maven/io.swagger/swagger-models/pom.xml
META-INF/maven/jakarta.annotation/
META-INF/maven/jakarta.annotation/jakarta.annotation-api/
META-INF/maven/jakarta.annotation/jakarta.annotation-api/pom.properties
META-INF/maven/jakarta.annotation/jakarta.annotation-api/pom.xml
META-INF/maven/jakarta.ws.rs/
META-INF/maven/jakarta.ws.rs/jakarta.ws.rs-api/
META-INF/maven/jakarta.ws.rs/jakarta.ws.rs-api/pom.properties
META-INF/maven/jakarta.ws.rs/jakarta.ws.rs-api/pom.xml
META-INF/maven/org.glassfish.hk2.external/
META-INF/maven/org.glassfish.hk2.external/jakarta.inject/
META-INF/maven/org.glassfish.hk2.external/jakarta.inject/pom.properties
META-INF/maven/org.glassfish.hk2.external/jakarta.inject/pom.xml
META-INF/maven/org.glassfish.jersey.core/
META-INF/maven/org.glassfish.jersey.core/jersey-client/
META-INF/maven/org.glassfish.jersey.core/jersey-client/pom.properties
META-INF/maven/org.glassfish.jersey.core/jersey-client/pom.xml
META-INF/maven/org.glassfish.jersey.core/jersey-common/
META-INF/maven/org.glassfish.jersey.core/jersey-common/pom.properties
META-INF/maven/org.glassfish.jersey.core/jersey-common/pom.xml
META-INF/maven/org.glassfish.jersey.ext/
META-INF/maven/org.glassfish.jersey.ext/jersey-entity-filtering/
META-INF/maven/org.glassfish.jersey.ext/jersey-entity-filtering/pom.properties
META-INF/maven/org.glassfish.jersey.ext/jersey-entity-filtering/pom.xml
META-INF/maven/org.glassfish.jersey.media/
META-INF/maven/org.glassfish.jersey.media/jersey-media-json-jackson/
META-INF/maven/org.glassfish.jersey.media/jersey-media-json-jackson/pom.properties
META-INF/maven/org.glassfish.jersey.media/jersey-media-json-jackson/pom.xml
META-INF/maven/org.glassfish.jersey.media/jersey-media-multipart/
META-INF/maven/org.glassfish.jersey.media/jersey-media-multipart/pom.properties
META-INF/maven/org.glassfish.jersey.media/jersey-media-multipart/pom.xml
META-INF/maven/org.openapitools/
META-INF/maven/org.openapitools/jackson-databind-nullable/
META-INF/maven/org.openapitools/jackson-databind-nullable/pom.properties
META-INF/maven/org.openapitools/jackson-databind-nullable/pom.xml
META-INF/services/
META-INF/versions/
META-INF/versions/11/
META-INF/versions/11/org/
META-INF/versions/11/org/apache/
META-INF/versions/17/
META-INF/versions/17/org/
META-INF/versions/17/org/apache/
META-INF/versions/19/
META-INF/versions/19/com/
META-INF/versions/19/com/fasterxml/
META-INF/versions/19/com/fasterxml/jackson/
META-INF/versions/19/com/fasterxml/jackson/core/
META-INF/versions/19/com/fasterxml/jackson/core/io/
META-INF/versions/19/com/fasterxml/jackson/core/io/doubleparser/
META-INF/versions/19/com/fasterxml/jackson/core/io/doubleparser/FastDoubleSwar.class
META-INF/versions/19/com/fasterxml/jackson/core/io/doubleparser/FastIntegerMath$UInt128.class
META-INF/versions/19/com/fasterxml/jackson/core/io/doubleparser/FastIntegerMath.class
org/
org/apache/

Note that: for sbt build, the META-INF/versions/11/ and META-INF/versions/17 are shaded, but META-INF/versions/19 is not, not sure why, but I think we can ignore it.

jar -tf openapi/openapi-client/target/scala-2.12/celeborn-openapi-client_2.12-0.6.0-SNAPSHOT.jar|grep FastDoubleSwar
META-INF/versions/11/org/apache/celeborn/shaded/com/fasterxml/jackson/core/io/doubleparser/FastDoubleSwar.class
META-INF/versions/17/org/apache/celeborn/shaded/com/fasterxml/jackson/core/io/doubleparser/FastDoubleSwar.class
META-INF/versions/19/com/fasterxml/jackson/core/io/doubleparser/FastDoubleSwar.class
org/apache/celeborn/shaded/com/fasterxml/jackson/core/io/doubleparser/FastDoubleSwar.class

@turboFei
Copy link
Member Author

cc @pan3793 how do you think about?

@turboFei
Copy link
Member Author

favor to #2641

@turboFei turboFei closed this Jul 24, 2024
RexXiong pushed a commit that referenced this pull request Jul 31, 2024
…nstead of `jersey2`

### What changes were proposed in this pull request?
We used `jersey2` library for celeborn-openapi-client before, and I found that there is dependencies lack issue for shaded celeborn-openapi-client.
I tried to raise a [PR #2640] to fix it, but seems It is difficult to maintain the dependencies transition from jersey dependencies.

And I received the suggestion from pan to migrate the library from jersey2 to `apache-httpclient`.

FYI: for https://openapi-generator.tech/docs/generators/java/

<img width="500" alt="image" src="https://github.com/user-attachments/assets/d102a7c9-46cd-4fd7-a2a0-7396a815776d">

To leverage the latest openapi-generator plugin, I upgrade the openapi-generator version to latest 7.7.0 and it requires JDK11+.
Due celeborn does not drop the Java8 support so far, so I include the generated code into repo and add user guide for re-generation.

### Why are the changes needed?

To fix dependencies leak issue and maintain the dependencies easily.

### Does this PR introduce _any_ user-facing change?

No, this SDK has not been released, so no user-facing change.

### How was this patch tested?

Testing with sample maven project.

pom.xml:
```
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>test_openapi</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.apache.celeborn</groupId>
            <artifactId>celeborn-openapi-client_2.12</artifactId>
            <version>0.6.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>
```

Testing code:
```
package org.example;

import org.apache.celeborn.rest.v1.master.MasterApi;
import org.apache.celeborn.rest.v1.master.WorkerApi;
import org.apache.celeborn.rest.v1.master.invoker.ApiClient;

public class Main {
    public static void main(String[] args) throws Exception {

        String cmUrl = "http://***:9098";
        MasterApi masterApi  = new MasterApi(new ApiClient().setBasePath(cmUrl));
        System.out.println(masterApi.getMasterGroupInfo().getLeader().getAddress().split(":")[0]);
        WorkerApi workerApi = new WorkerApi(new ApiClient().setBasePath(cmUrl));
        System.out.println(workerApi.getWorkers());
        System.out.println(workerApi.getWorkerEvents());
    }
}
```

```
java -Dfile.encoding=UTF-8 -classpath /Users/fwang12/todo/test_openapi/target/classes:/Users/fwang12/todo/celeborn/openapi/openapi-client/target/celeborn-openapi-client_2.12-0.6.0-SNAPSHOT.jar org.example.Main
```

<img width="1727" alt="image" src="https://github.com/user-attachments/assets/2da8b126-be96-4c37-9a33-ba196024f2ba">

Closes #2641 from turboFei/appache_httpclient.

Lead-authored-by: Wang, Fei <[email protected]>
Co-authored-by: Fei Wang <[email protected]>
Co-authored-by: Cheng Pan <[email protected]>
Signed-off-by: Shuang <[email protected]>
wankunde pushed a commit to wankunde/celeborn that referenced this pull request Oct 11, 2024
…nstead of `jersey2`

### What changes were proposed in this pull request?
We used `jersey2` library for celeborn-openapi-client before, and I found that there is dependencies lack issue for shaded celeborn-openapi-client.
I tried to raise a [PR apache#2640] to fix it, but seems It is difficult to maintain the dependencies transition from jersey dependencies.

And I received the suggestion from pan to migrate the library from jersey2 to `apache-httpclient`.

FYI: for https://openapi-generator.tech/docs/generators/java/

<img width="500" alt="image" src="https://github.com/user-attachments/assets/d102a7c9-46cd-4fd7-a2a0-7396a815776d">

To leverage the latest openapi-generator plugin, I upgrade the openapi-generator version to latest 7.7.0 and it requires JDK11+.
Due celeborn does not drop the Java8 support so far, so I include the generated code into repo and add user guide for re-generation.

### Why are the changes needed?

To fix dependencies leak issue and maintain the dependencies easily.

### Does this PR introduce _any_ user-facing change?

No, this SDK has not been released, so no user-facing change.

### How was this patch tested?

Testing with sample maven project.

pom.xml:
```
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>test_openapi</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.apache.celeborn</groupId>
            <artifactId>celeborn-openapi-client_2.12</artifactId>
            <version>0.6.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>
```

Testing code:
```
package org.example;

import org.apache.celeborn.rest.v1.master.MasterApi;
import org.apache.celeborn.rest.v1.master.WorkerApi;
import org.apache.celeborn.rest.v1.master.invoker.ApiClient;

public class Main {
    public static void main(String[] args) throws Exception {

        String cmUrl = "http://***:9098";
        MasterApi masterApi  = new MasterApi(new ApiClient().setBasePath(cmUrl));
        System.out.println(masterApi.getMasterGroupInfo().getLeader().getAddress().split(":")[0]);
        WorkerApi workerApi = new WorkerApi(new ApiClient().setBasePath(cmUrl));
        System.out.println(workerApi.getWorkers());
        System.out.println(workerApi.getWorkerEvents());
    }
}
```

```
java -Dfile.encoding=UTF-8 -classpath /Users/fwang12/todo/test_openapi/target/classes:/Users/fwang12/todo/celeborn/openapi/openapi-client/target/celeborn-openapi-client_2.12-0.6.0-SNAPSHOT.jar org.example.Main
```

<img width="1727" alt="image" src="https://github.com/user-attachments/assets/2da8b126-be96-4c37-9a33-ba196024f2ba">

Closes apache#2641 from turboFei/appache_httpclient.

Lead-authored-by: Wang, Fei <[email protected]>
Co-authored-by: Fei Wang <[email protected]>
Co-authored-by: Cheng Pan <[email protected]>
Signed-off-by: Shuang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant