Update spark client to use the shaded iceberg-core in iceberg-spark-runtime to avoid spark compatibilities issue #1908

gh-yzou · 2025-06-18T18:21:52Z

We run into an issue when testing the spark client using --packages (the jar path works correctly), where the iceberg requires avro 1.12.0, but the one provide by spark is 1.11.4. Even though the dependency is downloaded, the one used is still the one provided by spark. There for we see error like following when do select * from iceberg_tb:

java.lang.NoSuchMethodError: 'org.apache.avro.LogicalTypes$TimestampNanos org.apache.avro.LogicalTypes.timestampNanos()'
  at org.apache.iceberg.avro.TypeToSchema.<clinit>(TypeToSchema.java:50)
  at org.apache.iceberg.avro.AvroSchemaUtil.convert(AvroSchemaUtil.java:64)
  at org.apache.iceberg.avro.AvroSchemaUtil.convert(AvroSchemaUtil.java:59)
  at org.apache.iceberg.GenericManifestFile.<clinit>(GenericManifestFile.java:42)
  at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
  at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:75)
  at java.base/jdk.internal.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:53)
  at java.base/java.lang.reflect.Constructor.newInstanceWithCaller(Constructor.java:502)
  at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:486)
  at org.apache.iceberg.common.DynConstructors$Ctor.newInstanceChecked(DynConstructors.java:51)
  at org.apache.iceberg.common.DynConstructors$Ctor.newInstance(DynConstructors.java:64)
  at org.apache.iceberg.avro.InternalReaders$PlannedStructLikeReader.reuseOrCreate(InternalReaders.java:67)
  at org.apache.iceberg.avro.InternalReaders$PlannedStructLikeReader.reuseOrCreate(InternalReaders.java:42)
  at org.apache.iceberg.avro.ValueReaders$PlannedStructReader.read(ValueReaders.java:963)
  at org.apache.iceberg.avro.InternalReader.read(InternalReader.java:107)
  at org.apache.iceberg.avro.NameMappingDatumReader.read(NameMappingDatumReader.java:57)
  at org.apache.avro.file.DataFileStream.next(DataFileStream.java:263)
  at org.apache.avro.file.DataFileStream.next(DataFileStream.java:248)

A quick mitigation is to remove the default one used by spark. However, to avoid future conflict with other library, we switch to use the shaded library shipped in iceberg-spark-runtime.

The major change is that instead using com.fasterxml.jackson.annotation, we uses org.apache.iceberg.shaded.com.fasterxml.jackson.annotation for all request and response to ensure they can be serialized and deserialized correctly by Iceberg RESTClient.
Since the classes now looks different than the one used at server side now, we actually let client uses its own request and response classes. Those classes are added manually at this moment, will follow up to autogenerate them based on spec directly #1909

Since we are using all libraries shipped along with the iceberg-spark-runtime, it simplifies the build for client significantly

dimas-b · 2025-06-18T18:26:05Z

plugins/spark/v3.5/spark/src/main/java/org/apache/polaris/spark/PolarisSparkCatalog.java

This change is fine from my POV, but it does not seem to match the PR title and description. Please mention this refactoring there.

because the classes used by client and server now are different in terms of the import (server uses the regular import, but client uses the shaded one coming from iceberg). So the implementation of the class at client side are now different compare with server side, and the client side is now suppose to use the one provided at client side. This change is to use the class provided by the client side, which will be auto generated in the coming task.

Move on, the only contract client have with server will be the API spec, which i think is the correct thing to do.

I added a comment here, and also updated the description to contain more details

plugins/spark/v3.5/integration/build.gradle.kts

dimas-b · 2025-06-18T18:32:14Z

plugins/spark/v3.5/spark/src/main/java/org/apache/polaris/spark/rest/GenericTable.java

+1 to the TODO, but as of now this class is checked in to the source repo, not generated at build time 🤔

yes, this class requires a different code generation script because the code looks different compare with the one generated by server side in terms of the import. where the server side uses

import com.fasterxml.jackson.annotation.JsonCreator

but we will need to use

import org.apache.iceberg.shaded.com.fasterxml.jackson.annotation.JsonCreator;

at client side to enable reuse of iceberg rest client correctly, because the RESTClient shipped in the iceberg-spark-runtime has the jackson library shaded. i will have to add new generation script and build file to make sure things can be generated properly, and I have an issue to track the improvement #1909

I mean: do we need the @Generated annotation here? The file appears to be modified after generation and manually committed to git 🤔

i see. yes, we do not need the @generated annotation here, removed.

codestyle/checkstyle.xml

flyrain · 2025-06-20T16:00:25Z

...ntegration/src/intTest/java/org/apache/polaris/spark/quarkus/it/PolarisManagementClient.java

Nit:

Suggested change

/**

* That class provides rest client that is can be used to talk to Polaris Management service and

* auth token endpoint. This class is currently used by Spark Client tests for commands that can not

* be issued through spark command, such as createCatalog etc.

*/

/**

* This class provides a REST client for the Polaris Management service endpoints and its auth-token endpoint, which used in

* Spark client tests to run commands that Spark SQL can’t issue directly (e.g., createCatalog).

*/

flyrain · 2025-06-20T16:03:25Z

plugins/spark/v3.5/integration/build.gradle.kts

+1 this provides more flexibility on the client side by minimizing dependencies, as it only depends on the Polaris REST spec now.

flyrain

Thanks a lot @gh-yzou for the fix! LGTM!

flyrain · 2025-06-20T16:08:23Z

A minor suggestion, would you mind sharing the error msg/stack trace of the issue the PR trying to fix? This will provide more context people who track this issue.

dimas-b · 2025-06-20T16:19:33Z

I raised some concerns about this PR on the dev ML: https://lists.apache.org/thread/0z30f3cfvm41hxlbxgp4fqdpv7mfgnv8

Let's resolve that discussion before merging.

dimas-b · 2025-06-20T16:21:04Z

codestyle/checkstyle_no_illegalimport.xml

I'm not sure this approach is ideal for making exceptions to Checkstyle rules.

@adutra : WDYT?

switched to use suppress rule now

flyrain · 2025-06-20T17:22:04Z

plugins/spark/v3.5/spark/build.gradle.kts

cc @dimas-b, it doesn't depend on iceberg-core anymore, not leaking of transitive dependencies.

gh-yzou · 2025-06-20T21:38:46Z

@flyrain i added the stacktrace in the PR description.

dimas-b · 2025-06-20T22:24:46Z

codestyle/checkstyle.xml

Is this not the same as lines 41-42?

it is not the same, actually line 41-42 is not doing anything, the config says look for config org.checkstyle.google.suppressionfilter.config, which i don't think we configure it anywhere in our project, if not configured, use file checkstyle-suppressions.xml, which we do not have it anywhere in the project also, the check style job doesn't fail, because it sets optional to true.
Now since we do have the suppressions file, i made it non-optional, and removed the other configuration. One thing i did notice here is that if i just use the relative path regarding to root project path, gradlew build seems not able to found the path, the recommended way seems using the config, and then get the absolute path, which is the way i am going with now

i moved the suppress file to the polaris-spark project, and reuses the original configuration

dimas-b · 2025-06-20T22:25:57Z

codestyle/checkstyle_suppressions.xml

Is it possible to keep this file under the Spark module as opposed to the global codestyle dir?

Actually, i think it make sense to have it at the top level, in the future, if there are other suppress rule we want to add, they can all be added to this file, and we will have centralized file to mange all checkstyle and suppress rule, which i think can make things much easier to mange.

Agree with @dimas-b , let's not add module specifics here globally - that does affect all modules

Moved the suppress config to spark client side.

snazy · 2025-06-23T13:12:57Z

build-logic/src/main/kotlin/polaris-java.gradle.kts

Please do not add a project specific change to all projects?

moved to project specific

snazy · 2025-06-23T13:14:33Z

codestyle/checkstyle_suppressions.xml

Agree with @dimas-b , let's not add module specifics here globally - that does affect all modules

snazy · 2025-06-23T13:24:35Z

plugins/spark/v3.5/integration/build.gradle.kts

Why have two Jackson in tests - the relocated one and this?

That one is used by a polaris client test utility that is used to talk to the polaris management API for test setup, such as createCatalog. This test utility has nothing to do with Iceberg, and is not suppose to rely on the iceberg spark client library.

…ache#1857)" This reverts commit 1f7f127.

* fix spark client * fix test failure and address feedback * fix error * update regression test * update classifier name * address comment * add change * update doc * update build and readme * add back jr * udpate dependency * add change * update * update tests * remove merge service file * update readme * update readme

…ache#1857)" This reverts commit 40f4d36.

flyrain

Thanks for keeping working on it, @gh-yzou !

dimas-b

I still think that compiling against shaded jackson classes is sub-optimal and can be avoided, but I will not hold this PR because of that. Other changes LGTM.

…untime to avoid spark compatibilities issue (#1908) * add change * add comment * update change * add comment * add change * add tests * add comment * clean up style check * update build * Revert "Reuse shadowJar for spark client bundle jar maven publish (#1857)" This reverts commit 1f7f127. * Reuse shadowJar for spark client bundle jar maven publish (#1857) * fix spark client * fix test failure and address feedback * fix error * update regression test * update classifier name * address comment * add change * update doc * update build and readme * add back jr * udpate dependency * add change * update * update tests * remove merge service file * update readme * update readme * update checkstyl * rebase with main * Revert "Reuse shadowJar for spark client bundle jar maven publish (#1857)" This reverts commit 40f4d36. * update checkstyle * revert change * address comments * trigger tests

github-project-automation bot added this to Basic Kanban Board Jun 18, 2025

github-project-automation bot moved this to PRs In Progress in Basic Kanban Board Jun 18, 2025

gh-yzou requested review from RussellSpitzer, adutra, eric-maynard and flyrain June 18, 2025 18:21

dimas-b reviewed Jun 18, 2025

View reviewed changes

plugins/spark/v3.5/integration/build.gradle.kts Outdated Show resolved Hide resolved

dimas-b reviewed Jun 18, 2025

View reviewed changes

codestyle/checkstyle.xml Outdated Show resolved Hide resolved

gh-yzou force-pushed the yzou-test-shade branch from 627bd0d to df7bcd2 Compare June 18, 2025 21:55

flyrain reviewed Jun 20, 2025

View reviewed changes

flyrain previously approved these changes Jun 20, 2025

View reviewed changes

github-project-automation bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Jun 20, 2025

dimas-b reviewed Jun 20, 2025

View reviewed changes

flyrain reviewed Jun 20, 2025

View reviewed changes

gh-yzou dismissed flyrain’s stale review via f122578 June 20, 2025 20:53

gh-yzou force-pushed the yzou-test-shade branch from 22a1738 to f122578 Compare June 20, 2025 20:53

dimas-b reviewed Jun 20, 2025

View reviewed changes

snazy reviewed Jun 23, 2025

View reviewed changes

gh-yzou added 5 commits June 23, 2025 11:08

add change

947135e

add comment

1c0255f

update change

32804fc

add comment

691f149

add change

5494d1e

gh-yzou added 10 commits June 23, 2025 11:08

add tests

469dcce

add comment

89cb53d

clean up style check

85a8789

update build

783ad75

Revert "Reuse shadowJar for spark client bundle jar maven publish (ap…

e512399

…ache#1857)" This reverts commit 1f7f127.

update checkstyl

d44f87f

rebase with main

328889a

Revert "Reuse shadowJar for spark client bundle jar maven publish (ap…

82f31e7

…ache#1857)" This reverts commit 40f4d36.

update checkstyle

69a7c69

gh-yzou force-pushed the yzou-test-shade branch from 7571e96 to 69a7c69 Compare June 23, 2025 19:12

gh-yzou added 3 commits June 23, 2025 12:14

revert change

c1651dd

address comments

d8e2b4c

trigger tests

cafb710

flyrain approved these changes Jun 23, 2025

View reviewed changes

dimas-b reviewed Jun 23, 2025

View reviewed changes

gh-yzou merged commit 93938fd into apache:main Jun 23, 2025
11 checks passed

github-project-automation bot moved this from Ready to merge to Done in Basic Kanban Board Jun 23, 2025

-/**
- * That class provides rest client that is can be used to talk to Polaris Management service and
- * auth token endpoint. This class is currently used by Spark Client tests for commands that can not
- * be issued through spark command, such as createCatalog etc.
- */
+/**
+ * This class provides a REST client for the Polaris Management service endpoints and its auth-token endpoint, which used in
+ * Spark client tests to run commands that Spark SQL can’t issue directly (e.g., createCatalog).
+ */

Update spark client to use the shaded iceberg-core in iceberg-spark-runtime to avoid spark compatibilities issue #1908

Update spark client to use the shaded iceberg-core in iceberg-spark-runtime to avoid spark compatibilities issue #1908

Uh oh!

Conversation

gh-yzou commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

flyrain left a comment

Choose a reason for hiding this comment

Uh oh!

flyrain commented Jun 20, 2025

Uh oh!

dimas-b commented Jun 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gh-yzou commented Jun 20, 2025

Uh oh!

dimas-b Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gh-yzou Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gh-yzou Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gh-yzou Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

flyrain left a comment

Choose a reason for hiding this comment

gh-yzou commented Jun 18, 2025 •

edited

Loading

dimas-b Jun 20, 2025 •

edited

Loading

gh-yzou Jun 20, 2025 •

edited

Loading

gh-yzou Jun 20, 2025 •

edited

Loading

gh-yzou Jun 23, 2025 •

edited

Loading

dimas-b left a comment •

edited

Loading