`MappingInstantiationException` for Abstract Classes using tasks ran on ForkJoinPool

[cabbonizio]

Hi, our team has had a really tough problem we been dealing with for some time and been trying to get to root cause. We have an issue with a particular service where it begins failing with the following exception:

Exception:
org.springframework.data.mapping.model.MappingInstantiationException

Message:

Failed to instantiate com.qvc.common.couchbase.model.cart.payment.AbstractPaymentMethod using constructor public com.qvc.common.couchbase.model.cart.payment.AbstractPaymentMethod() with arguments

Stacktrace:

org.springframework.data.mapping.model.ClassGeneratingEntityInstantiator$MappingInstantiationExceptionEntityInstantiator.createInstance(ClassGeneratingEntityInstantiator.java:358)
org.springframework.data.mapping.model.ClassGeneratingEntityInstantiator.createInstance(ClassGeneratingEntityInstantiator.java:102)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter.read(MappingCouchbaseConverter.java:266)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter.read(MappingCouchbaseConverter.java:244)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter.readCollection(MappingCouchbaseConverter.java:773)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter.readValue(MappingCouchbaseConverter.java:856)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter.access$300(MappingCouchbaseConverter.java:86)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter$CouchbasePropertyValueProvider.getPropertyValue(MappingCouchbaseConverter.java:972)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter.getValueInternal(MappingCouchbaseConverter.java:309)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter$1.doWithPersistentProperty(MappingCouchbaseConverter.java:277)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter$1.doWithPersistentProperty(MappingCouchbaseConverter.java:269)
org.springframework.data.mapping.model.BasicPersistentEntity.doWithProperties(BasicPersistentEntity.java:368)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter.read(MappingCouchbaseConverter.java:269)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter.read(MappingCouchbaseConverter.java:244)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter.read(MappingCouchbaseConverter.java:201)
org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter.read(MappingCouchbaseConverter.java:86)
org.springframework.data.couchbase.core.CouchbaseTemplateSupport.decodeEntity(CouchbaseTemplateSupport.java:141)
org.springframework.data.couchbase.core.NonReactiveSupportWrapper.lambda$decodeEntity$1(NonReactiveSupportWrapper.java:45)
reactor.core.publisher.MonoSupplier.call(MonoSupplier.java:86)
reactor.core.publisher.MonoFlatMap$FlatMapMain.onNext(MonoFlatMap.java:139)
reactor.core.publisher.FluxHide$SuppressFuseableSubscriber.onNext(FluxHide.java:137)
org.springframework.cloud.sleuth.instrument.reactor.ScopePassingSpanSubscriber.onNext(ScopePassingSpanSubscriber.java:89)
reactor.core.publisher.FluxOnErrorResume$ResumeSubscriber.onNext(FluxOnErrorResume.java:79)
reactor.core.publisher.FluxDoFinally$DoFinallySubscriber.onNext(FluxDoFinally.java:113)
org.springframework.cloud.sleuth.instrument.reactor.ScopePassingSpanSubscriber.onNext(ScopePassingSpanSubscriber.java:89)
reactor.core.publisher.Operators$MonoSubscriber.complete(Operators.java:1839)
com.couchbase.client.core.Reactor$SilentMonoCompletionStage.lambda$subscribe$0(Reactor.java:183)
java.util.concurrent.CompletableFuture.uniWhenComplete(CompletableFuture.java:859)
java.util.concurrent.CompletableFuture$UniWhenComplete.tryFire(CompletableFuture.java:837)
java.util.concurrent.CompletableFuture.postComplete(CompletableFuture.java:506)
java.util.concurrent.CompletableFuture.complete(CompletableFuture.java:2073)
com.couchbase.client.core.msg.BaseRequest.succeed(BaseRequest.java:161)
com.couchbase.client.core.io.netty.kv.KeyValueMessageHandler.decodeAndComplete(KeyValueMessageHandler.java:412)
com.couchbase.client.core.io.netty.kv.KeyValueMessageHandler.retryOrComplete(KeyValueMessageHandler.java:368)
com.couchbase.client.core.io.netty.kv.KeyValueMessageHandler.decode(KeyValueMessageHandler.java:351)
com.couchbase.client.core.io.netty.kv.KeyValueMessageHandler.channelRead(KeyValueMessageHandler.java:282)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:365)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:357)
com.couchbase.client.core.io.netty.kv.MemcacheProtocolVerificationHandler.channelRead(MemcacheProtocolVerificationHandler.java:85)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:365)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:357)
com.couchbase.client.core.deps.io.netty.handler.codec.ByteToMessageDecoder.fireChannelRead(ByteToMessageDecoder.java:336)
com.couchbase.client.core.deps.io.netty.handler.codec.ByteToMessageDecoder.channelRead(ByteToMessageDecoder.java:308)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:365)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:357)
com.couchbase.client.core.deps.io.netty.handler.flush.FlushConsolidationHandler.channelRead(FlushConsolidationHandler.java:152)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:365)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:357)
com.couchbase.client.core.deps.io.netty.handler.ssl.SslHandler.unwrap(SslHandler.java:1373)
com.couchbase.client.core.deps.io.netty.handler.ssl.SslHandler.decodeJdkCompatible(SslHandler.java:1236)
com.couchbase.client.core.deps.io.netty.handler.ssl.SslHandler.decode(SslHandler.java:1285)
com.couchbase.client.core.deps.io.netty.handler.codec.ByteToMessageDecoder.decodeRemovalReentryProtection(ByteToMessageDecoder.java:519)
com.couchbase.client.core.deps.io.netty.handler.codec.ByteToMessageDecoder.callDecode(ByteToMessageDecoder.java:458)
com.couchbase.client.core.deps.io.netty.handler.codec.ByteToMessageDecoder.channelRead(ByteToMessageDecoder.java:280)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:365)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:357)
com.couchbase.client.core.deps.io.netty.channel.DefaultChannelPipeline$HeadContext.channelRead(DefaultChannelPipeline.java:1410)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379)
com.couchbase.client.core.deps.io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:365)
com.couchbase.client.core.deps.io.netty.channel.DefaultChannelPipeline.fireChannelRead(DefaultChannelPipeline.java:919)
com.couchbase.client.core.deps.io.netty.channel.epoll.AbstractEpollStreamChannel$EpollStreamUnsafe.epollInReady(AbstractEpollStreamChannel.java:800)
com.couchbase.client.core.deps.io.netty.channel.epoll.EpollEventLoop.processReady(EpollEventLoop.java:499)
com.couchbase.client.core.deps.io.netty.channel.epoll.EpollEventLoop.run(EpollEventLoop.java:397)
com.couchbase.client.core.deps.io.netty.util.concurrent.SingleThreadEventExecutor$4.run(SingleThreadEventExecutor.java:997)
com.couchbase.client.core.deps.io.netty.util.internal.ThreadExecutorMap$2.run(ThreadExecutorMap.java:74)
com.couchbase.client.core.deps.io.netty.util.concurrent.FastThreadLocalRunnable.run(FastThreadLocalRunnable.java:30)
java.lang.Thread.run(Thread.java:829)

We have a standard @document with a list of an Abstract object like so:

private List<AbstractPaymentMethod<?>> paymentMethods;

The definition of the abstract class is:

import lombok.Getter;
import lombok.Setter;

@Setter
@Getter
public abstract class AbstractPaymentMethod<T>   {

	private String id;
	private T data;

}

An example of a class implementing the abstract class is:

public class CreditPaymentMethod extends AbstractPaymentMethod<Credit> {
}

@Getter
@Setter
public class Credit  {
	private String id;
	private String type;
	private String description;
	private BigDecimal amount;
}

We can't quite determine when exactly it happen but some of the versions that we're on are:

• Spring Boot 2.7.6
• spring data commons 2.7.6
• spring data couchbase 4.4.6

When app is initially deployed it runs fine for a while and then suddenly it begins throwing this error complaining specifically about our abstract class. Previous to these versions, we have been running fine up to 5 years so we're trying to determine if there was any change of behavior in the spring data commons area where we have to configure abstract classes differently. Any help would be greatly appreciated.

We are not using converters (@ReadingConverter / @WritingConverter) for this but simply just have an overall @document spring data couchbase entity class and use the standard PagingAndSortingRepository.

I imagine more data will be needed to help here but wanted to get convo started.

[mp911de]

I moved the ticket into Spring Data Couchbase. The converter should honor the concrete type for properties holding values that do not exactly match the property type.

I.e. for a List of AbstractPaymentMethod, the list in the Couchbase document should contain a type hint (discriminator) that describes which subclass of AbstractPaymentMethod was saved. Also, since data is an Object, a type hint there seems appropriate.

When you mention that the application only fails after a certain time, this might indicate that the functionality isn't used right from the start or that a cache is being evicted.

I'd ask you to verify whether the affected documents contain proper type hints. Since you're not using @TypeAlias, you don't need any specific configuration of the mapping context.

[cabbonizio]

Hey there @mp911de .......thx for your comment! Here's what a sample of the document looks like when I pull a sample doc from Couchbase analytics. I am guessing the spring-data / Couchbase framework has been adding the "_class" attribute when saving to Couchbase all along. This must be how the reads work to understand what type of object to de-serialize. There were no special annotations done to make this work. We have done this in other API models outside of Couchbase using Jackson annotations such as @JsonTypeInfo and @JsonSubTypes. We never had to do this for the Couchbase entity model it just worked. Thoughts?

"paymentMethods": [ { "_class": "com.****.common.couchbase.model.cart.payment.CreditCardPaymentMethod", "data": { "cvvPromptFlag": false, "expirationDate": "1999-12", "id": "1141055087", "lastFourDigits": "****", "type": "XX", "typeDescription": "XXXXXX" } } ],

[mikereiche]

@cabbonizio - I'll investigate your issue.
There was an issue around the _class not being leveraged that was causing an issue for abstract entities - #1315 (and its duplicate #1364). But these were fixed before 4.4.6. (Meanwhile, can you please use the latest 4.x which is 4.4.9 so we are both looking using the same codebase? Thanks. Edit: 4.4.8 from spring-boot 2.7.9 is fine).

[BillTurnbull]

@mikereiche just to be clear you want an update to use spring-data-couchbase 4.4.9 ?

[cabbonizio]

@cabbonizio - I'll investigate your issue. There was an issue around the _class not being leveraged that was causing an issue for abstract entities - #1315 (and its duplicate #1364). But these were fixed before 4.4.6. (Meanwhile, can you please use the lates 4.x which is 4.4.9 so we are both looking using the same codebase? Thanks).

Thank you so much for jumping in. A few other co-workers may also help contribute and answer questions. It sounds like we can force bump Spring Data Couchbase to 4.4.9 and we'll be like for like.

I made a mistake we are actually on the following currently:

• Spring Boot 2.7.9
• spring data commons 2.7.8
• spring data couchbase 4.4.8

We can force bump spring data couchbase to 4.4.9 and then we're on same versions.

[ammw]

And please let us know if there's anything else to check or try out

[mikereiche]

I created an application from Spring Initialzr 2.7.9 (It doesn't let you pick the spring data version, it uses 4.4.8).
No issue with either the template or the repository:

package com.example.demo;

import java.math.BigDecimal;
import java.util.Optional;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.data.couchbase.core.CouchbaseTemplate;
import org.springframework.stereotype.Component;

/**
 * Components of the type CommandLineRunner are called right after the application start up. So the method *run* is
 * called as soon as the application starts.
 * 
 * @author Michael Reiche
 */
@Component
public class CmdRunner implements CommandLineRunner {

  @Autowired CouchbaseTemplate template;
  @Autowired PaymentRepository paymentRepository;

  @Override
  public void run(String... strings) {

    AbstractPaymentMethod paymentMethod = new CreditPaymentMethod();
    paymentMethod.setId("123");
    Credit credit = new Credit();
    credit.setType("visa_type");
    credit.setId("visa_id");
    credit.setDescription("Walmart_Purchase");
    credit.setAmount(BigDecimal.TEN);
    paymentMethod.setData(credit);

    template.upsertById(AbstractPaymentMethod.class).one(paymentMethod);

    AbstractPaymentMethod pFound = template.findById(AbstractPaymentMethod.class).one(paymentMethod.getId());
    System.err.println("payment method: " + pFound);

    paymentMethod.setId("abc");
    paymentRepository.save(paymentMethod);
    Optional<AbstractPaymentMethod> foundRepoPaymentMethod = paymentRepository.findById(paymentMethod.getId());
    System.err.println("repository payment method: " + foundRepoPaymentMethod);

  }

}

payment method: { id=123, data={ id=visa_id, type=visa_type, description='Walmart_Purchase', amount=10}}
repository payment method: Optional[{ id=abc, data={ id=visa_id, type=visa_type, description='Walmart_Purchase', amount=10}}]

id="123"
{
  "_class": "com.example.demo.CreditPaymentMethod",
  "data": {
    "amount": "10",
    "description": "Walmart_Purchase",
    "id": "visa_id",
    "type": "visa_type"
  }
}

id="abc"
{
  "_class": "com.example.demo.CreditPaymentMethod",
  "data": {
    "amount": "10",
    "description": "Walmart_Purchase",
    "id": "visa_id",
    "type": "visa_type"
  }
}

[mikereiche]

package com.example.demo;

import lombok.Getter;
import lombok.Setter;

@Setter
@Getter
public abstract class AbstractPaymentMethod<T> {

  private String id;
  private T data;

  public String toString(){
    StringBuffer sb=new StringBuffer();
    sb.append("{ id="+id+", data="+data+"}");
    return sb.toString();
  }

}

package com.example.demo;

import com.couchbase.client.core.msg.kv.DurabilityLevel;
import com.couchbase.client.java.env.ClusterEnvironment;
import com.couchbase.client.java.transactions.config.TransactionsConfig;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.couchbase.config.AbstractCouchbaseConfiguration;
import org.springframework.data.couchbase.repository.config.EnableCouchbaseRepositories;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@Configuration
@EnableCouchbaseRepositories({"com.example.demo"})
@EnableTransactionManagement
public class Config extends AbstractCouchbaseConfiguration {
  @Override
  public String getConnectionString() {
    return "127.0.0.1";
  }

  @Override
  public String getUserName() {
    return "Administrator";
  }

  @Override
  public String getPassword() {
    return "password";
  }

  @Override
  public String getBucketName() {
    return "my_bucket";
  }

}

package com.example.demo;

import lombok.Getter;
import lombok.Setter;
import java.math.BigDecimal;

@Getter
@Setter
public class Credit  {
  private String id;
  private String type;
  private String description;
  private BigDecimal amount;

  public String toString(){
    StringBuffer sb=new StringBuffer();
    sb.append("{ id="+id+", type="+type+", description='"+description+"', amount="+amount+"}");
    return sb.toString();
  }
}

package com.example.demo;

public class CreditPaymentMethod extends AbstractPaymentMethod<Credit> {
}

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;

@SpringBootApplication
public class DemoApplication {

	public static void main(String[] args) {
 		SpringApplication.run( DemoApplication.class, args );
	}

}

package com.example.demo;

import org.springframework.data.couchbase.repository.CouchbaseRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface PaymentRepository
  extends CouchbaseRepository<AbstractPaymentMethod, String>{
}

[mikereiche]

4.4.8 is fine.

Can you show me the call that is attempting to retrieve the payment method? The definition (in the repository interface if that's how it's being called) and the actual call?

[cabbonizio]

4.4.8 is fine.

Can you show me the call that is attempting to retrieve the payment method? The definition (in the repository interface if that's how it's being called) and the actual call?

There's an overall @document entity it's part of so it's retrieving the parent doc.....the payment methods are simply a list of embedded object....here's what the doc looks like:

@Getter
@Setter
@Document
@NoArgsConstructor
public class Cart {
    
    @IdPrefix
    private String keyPrefix = "carts::";
    @IdAttribute
    private String id;
    @Id @GeneratedValue(delimiter = "")
    private String key;
    @CreatedDate
    private LocalDateTime createdTimestamp;
    @LastModifiedDate
    private LocalDateTime lastUpdatedTimestamp;
    @Version
    private long versionID;
    private List<AbstractPaymentMethod<?>> paymentMethods;

I took out a lot of the attributes to keep it simple since there are a lot more.

Repo looks like this:

public interface CartRepository extends PagingAndSortingRepository<Cart, String> {
}

In code we're using the CartRepository.findById() method......

[mikereiche]

I can't reproduce the problem.

I add this Cart class :

package com.example.demo;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.Id;
import org.springframework.data.annotation.LastModifiedDate;
import org.springframework.data.annotation.Version;
import org.springframework.data.couchbase.core.mapping.Document;
import org.springframework.data.couchbase.core.mapping.id.GeneratedValue;
import org.springframework.data.couchbase.core.mapping.id.IdAttribute;
import org.springframework.data.couchbase.core.mapping.id.IdPrefix;

import java.time.LocalDateTime;
import java.util.List;

@Getter
@Setter
@Document
@NoArgsConstructor
public class Cart {

  @IdPrefix
  private String keyPrefix = "carts::";
  @IdAttribute
  private String id;
  @Id
  @GeneratedValue(delimiter = "")
  private String key;
  @CreatedDate
  private LocalDateTime createdTimestamp;
  @LastModifiedDate
  private LocalDateTime lastUpdatedTimestamp;
  @Version
  private long versionID;
  private List<AbstractPaymentMethod<?>> paymentMethods;

  public String toString(){
    StringBuffer sb=new StringBuffer();
    sb.append("Cart{id="+id+", paymentMethods="+paymentMethods+"}");
    return sb.toString();
  }
}

And this CartRepository :

package com.example.demo;

import org.springframework.data.repository.PagingAndSortingRepository;

public interface CartRepository extends PagingAndSortingRepository<Cart, String> {
}

And use this driver class:

package com.example.demo;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.data.couchbase.core.CouchbaseTemplate;
import org.springframework.stereotype.Component;

/**
 * Components of the type CommandLineRunner are called right after the application start up. So the method *run* is
 * called as soon as the application starts.
 * 
 * @author Michael Reiche
 */
@Component
public class CmdRunner implements CommandLineRunner {

  @Autowired CouchbaseTemplate template;
  @Autowired PaymentRepository paymentRepository;
  @Autowired CartRepository cartRepository;

  @Override
  public void run(String... strings) {

    AbstractPaymentMethod paymentMethod = new CreditPaymentMethod();
    paymentMethod.setId("123");
    Credit credit = new Credit();
    credit.setType("visa_type");
    credit.setId("visa_id");
    credit.setDescription("Walmart_Purchase");
    credit.setAmount(BigDecimal.TEN);
    paymentMethod.setData(credit);

    Cart cart = new Cart();
    cart.setId("111");
    List pmtMethods = new ArrayList();
    pmtMethods.add(paymentMethod);
    cart.setPaymentMethods( pmtMethods);
    //template.upsertById(Cart.class).one(cart);  // same saved by template or repository
    cartRepository.save(cart);

    Cart pFound = template.findById(Cart.class).one("carts::"+cart.getId());
    System.err.println("template cart: " + pFound);

    Optional<Cart> repoFound = cartRepository.findById("carts::"+cart.getId());
    System.err.println("repo cart: " + repoFound);

  }

}

I get:

template cart: Cart{id=111, paymentMethods=[{ id=123, data={ id=visa_id, type=visa_type, description='Walmart_Purchase', amount=10}}]}
repo cart: Optional[Cart{id=111, paymentMethods=[{ id=123, data={ id=visa_id, type=visa_type, description='Walmart_Purchase', amount=10}}]}]

And the document looks like:

{
  "_class": "com.example.demo.Cart",
  "id": "111",
  "paymentMethods": [
    {
      "_class": "com.example.demo.CreditPaymentMethod",
      "data": {
        "amount": "10",
        "description": "Walmart_Purchase",
        "id": "visa_id",
        "type": "visa_type"
      },
      "id": "123"
    }
  ]
}