Using split packages still requires adding basically all models

[ZanochkynYehor]

SDK version - 19.0.0

I'm trying to use the new split-packages approach to reduce the size of my final artifact. My application only needs to fetch the categories, so I have added the following dependencies and code to my project:

build.gradle.kts

val commercetoolsVersion = "19.0.0"

dependencies {
    implementation("com.commercetools.sdk:commercetools-http-client:$commercetoolsVersion")
    implementation("com.commercetools.sdk:commercetools-sdk-java-api-models_category:$commercetoolsVersion")
    implementation("com.commercetools.sdk:commercetools-sdk-java-api-predicates:$commercetoolsVersion")
}

code:

val apiRoot = ApiRootBuilder.of()
      .defaultClient(
          ClientCredentials.of()
              .withClientId(System.getenv("CTP_CLIENT_ID"))
              .withClientSecret(System.getenv("CTP_CLIENT_SECRET"))
              .build(),
          ServiceRegion.valueOf("GCP_EUROPE_WEST1")
      )
      .build(System.getenv("CTP_PROJECT_KEY"))

val response = apiRoot.categories()
    .get()
    .addLimit(500)
    .execute()
    .get()
    .body

After executing the following code, I can see the next error:

java.lang.NoClassDefFoundError: com/commercetools/api/models/customer/CustomerReference

I thought: "Okay, let's add customer models - com.commercetools.sdk:commercetools-sdk-java-api-models_customer". After this, I see the following error:

java.lang.NoClassDefFoundError: com/commercetools/api/models/order/OrderReferenceBuilder

My thoughts: "Hmm, let's try adding order models - com.commercetools.sdk:commercetools-sdk-java-api-models_order". The next error:

java.lang.NoClassDefFoundError: com/commercetools/api/models/business_unit/BusinessUnitReferenceBuilder

It seems to go on forever. What's interesting is that it fails with a different NoClassDefFoundError error every time you run this code.

Could you please help me understand where the issue could be? Am I doing something wrong, or is this something with the SDK? It looks like com.commercetools.api.models.common.Reference could be the culprit as it has a lot of builders for various types.

I have also created a minimal reproducible example - https://github.com/ZanochkynYehor/CT-split-packages-test. Hope this helps

[jenschude]

Can you try it without the predicates package. This may be the culprit. And yes the reference is in a way problematic as is creates references to all domains. But we tried to prevent this by reversing the dependencies in the json subtype annotations.

[jenschude]

Took an initial look at it, could not directly find the culprit directly. Besides the biggest package will be the message one, which is not referenced directly. Next week will be available to take a deeper look at it.

[ZanochkynYehor]

Without the predicates package, my IDE highlights the next warnings

and I see the next error after running the code

java.lang.NoClassDefFoundError: com/commercetools/api/predicates/expansion/ExpansionDsl

It looks like this is because ByProjectKeyCategoriesGet implements ByProjectKeyCategoriesGetMixin and CategoryExpansionMixin, and they're using classes from com.commercetools.api.predicates package

[jenschude]

I found the culprit in the helper methods to create type specific reference builders like associateRoleBuilder

We will take a look how to remove this coupling or create a workaround.

[jenschude]

Hi,

relesed today a new version which should fix the issue. Could you give it a try?

[ZanochkynYehor]

Hi @jenschude. I still had to add com.commercetools.sdk:commercetools-sdk-java-api-models_customer for it to work. In addition, I had to add com.commercetools.sdk:commercetools-sdk-java-api-models_project so I can mock ProjectApiRoot in unit tests.

Not sure if something could be done to address the above, but it's at least working now :)

[jenschude]

The customers package is needed due to the lastModifiedBy and createdBy reference which can point to a customer

[ZanochkynYehor]

If I'm not mistaken, lastModifiedBy and createdBy are present basically on every resource in CT. So if we have to explicitly add customer models every time anyway, can't they just be added to a base (or common, whatever it's called) package?

[jenschude]

We did something similar already for common package. May consider it also for customer one