Add a note about Jackson annotation library clash in Wildfly

Aperta
#4,734 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Inizia esaminando la documentazione del Vaadin CDI add-on e le indicazioni esistenti di Vaadin 25 release-note a cui si fa riferimento nell’issue. Aggiungi la nota sul conflitto delle annotazioni Jackson in WildFly, incluse le alternative di jboss-deployment-structure.xml per WildFly 37+ e per le versioni precedenti. Il lavoro è completato quando gli utenti CDI possono trovare il workaround e distinguere i due casi di versione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

flow

When using Vaadin 25 in Wildfly, it could happen that the application fails at deployment or runtime because of an incompatibility with the Jackson annotation artifact version.

Wildfly adds jackson 2.x to each deployment as part of the default jaxrs subsystem. This causes issues with Vaadin 25 if the Jackson annotation dependency is older than the one expected by Jackson 3 (used by Vaadin).

07:41:44,960 ERROR [io.undertow.request] (default task-1) UT005023: Exception handling request to /push/: java.lang.NoSuchFieldError: Class com.fasterxml.jackson.annotation.JsonFormat$Shape does not have member field 'com.fasterxml.jackson.annotation.JsonFormat$Shape POJO'
        at deployment.push.war//tools.jackson.databind.ser.BasicSerializerFactory.buildEnumSerializer(BasicSerializerFactory.java:1071)
        at deployment.push.war//tools.jackson.databind.ser.BeanSerializerFactory._createSerializer2(BeanSerializerFactory.java:241)
        at deployment.push.war//tools.jackson.databind.ser.BeanSerializerFactory.createSerializer(BeanSerializerFactory.java:182)
        at deployment.push.war//tools.jackson.databind.SerializationContext._createAndCachePropertySerializer(SerializationContext.java:1027)
        at deployment.push.war//tools.jackson.databind.SerializationContext.findPrimaryPropertySerializer(SerializationContext.java:697)
        at deployment.push.war//tools.jackson.databind.ser.bean.BeanSerializerBase.resolve(BeanSerializerBase.java:311)
        at deployment.push.war//tools.jackson.databind.ser.UnrolledBeanSerializer.resolve(UnrolledBeanSerializer.java:155)
        at deployment.push.war//tools.jackson.databind.ser.SerializerCache.addAndResolveNonTypedSerializer(SerializerCache.java:216)
        at deployment.push.war//tools.jackson.databind.SerializationContext._createAndCacheUntypedSerializer(SerializationContext.java:975)
        at deployment.push.war//tools.jackson.databind.SerializationContext.findValueSerializer(SerializationContext.java:774)
        at deployment.push.war//tools.jackson.databind.SerializationContext.findTypedValueSerializer(SerializationContext.java:586)
        at deployment.push.war//tools.jackson.databind.ser.SerializationContextExt.valueToTree(SerializationContextExt.java:185)
        at deployment.push.war//tools.jackson.databind.ObjectMapper.valueToTree(ObjectMapper.java:1365)
        at deployment.push.war//com.vaadin.flow.server.communication.UidlWriter.dependencyToJson(UidlWriter.java:252)

The current solution to the problem is to add a jboss-deployment-structure.xml descriptor to the application, which contains an explicit exclusion for the Jackson annotation modules or the whole jaxrs subsytem.
To be noted that the module exclusion works only starting with Widlfly 37; for previous releases the jaxrs subsytem must be excluded.

This is mentioned in the release notes for Vaadin 25, but it would be good to add a note also on the Vaadin CDI add-on documentation, since Wildfly is most likely to be used with that add-on.

<jboss-deployment-structure>
    <deployment>
        <!-- Wildfly 37+ -->
        <exclusions>
            <module name="com.fasterxml.jackson.core.jackson-annotations"/>
        </exclusions>
        <!-- Wildfly less than 37 -->
        <exclude-subsystems>
            <subsystem name="jaxrs" />
        </exclude-subsystems>
    </deployment>
</jboss-deployment-structure>

Lingua principale
AsciiDoc
Stelle
38
Fork
225
Merge medio
17h 38m
PR unite (30g)
214

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di vaadin/docs

Tutte le issue di vaadin/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.