#3314 fix has no effect if swagger-core resolved a schema before `ObjectMapperProvider` was created
I maintainer di solito rispondono entro 9 giorni
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- java, spring-boot
- Ambito
- backend
Direzione di ricerca
Start in ObjectMapperProvider, where the constructor registers SchemaTypeMixin on the shared Json31.mapper(), then follow SpringDocUtils.cloneViaJson and the fallback in AbstractRequestService.applyBeanValidatorAnnotations. Reproduce by creating a bean that calls AnnotationsUtils.resolveSchemaFromType before springdoc auto-configuration, then requesting /v3/api-docs for a constrained parameter. Done when cloning a JsonSchema with types no longer depends on mapper initialization order; run the relevant springdoc tests for OpenAPI 3.1 schema cloning.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Describe the bug
With OpenAPI 3.1, Json Processing Exception occurred: Cannot construct instance of java.util.HashSet … from String value ('string') (through reference chain: io.swagger.v3.oas.models.media.JsonSchema["type"]) is still logged for every parameter with a validation constraint (@Min, @Pattern, @Size, …), although #3314 should have fixed this in 3.1.1. As a consequence, AbstractRequestService.applyBeanValidatorAnnotations falls back to modifying the original, possibly shared schema, which is the case #3270 meant to avoid.
Cause
ObjectMapperProvider registers SchemaTypeMixin on the JVM-wide Json31.mapper() in its constructor. Jackson only applies mixins to deserializers built afterwards, and caches those deserializers.
swagger-core uses the same mapper: ModelResolver copies property schemas via AnnotationsUtils.clone, which reads them back through ModelDeserializer, which in turn calls Json31.mapper().convertValue(node, JsonSchema.class) after removing type from the node. If that happens before ObjectMapperProvider is created, the cached JsonSchema deserializer lacks the TypeSetDeserializer. Every later SpringDocUtils.cloneViaJson fails, because it does not remove type first.
This happens in any application whose own configuration resolves a schema while it is being created. User configuration beans are instantiated before springdoc's auto-configuration. In our case it was an OperationCustomizer bean:
@Bean
public OperationCustomizer errorResponseSchemas(SpringDocConfigProperties properties) {
Schema schema = AnnotationsUtils.resolveSchemaFromType(ApiResponseBody.class, null, null, properties.isOpenapi31());
// …
}
To Reproduce
- Spring Boot: 4.1.1
- springdoc-openapi: 3.1.1 and 3.2.0
- swagger-core: 2.2.55
springdoc.api-docs.version=OPENAPI_3_1(the default)
- A bean in the application's own configuration that calls
AnnotationsUtils.resolveSchemaFromType(SomeDto.class, null, null, true)for a class with properties. - A controller method with a constrained parameter, e.g.
@RequestParam @Min(1) Integer pageSize. - Request
/v3/api-docs: the warning is logged for that parameter.
At that point, objectMapperProvider.jsonMapper() is Json31.mapper() and findMixInClassFor(Schema.class) returns SchemaTypeMixin, yet SpringDocUtils.cloneViaJson of a JsonSchema with types = [integer] falls back to returning the original object. The same clone succeeds in a fresh JVM without the early bean.
Expected behavior
The schema is copied regardless of what used Json31.mapper() before springdoc was initialized.
Workaround
Inject ObjectMapperProvider into the bean that resolves schemas early, so that springdoc configures the mapper first. This makes the warnings disappear in our application.
Possible fix
Don't change the shared Json31.mapper(). Let ObjectMapperProvider configure its own instance instead, e.g. ObjectMapperFactory.createJson31() with SchemaTypeMixin, as createJson already does for the standalone mappers. Alternatively, swagger-core could make the 3.1 type property readable back in the form it writes it (swagger-api/swagger-core#5264), which would make the mixin unnecessary.
- Lingua principale
- Java
- Stelle
- 3.7k
- Fork
- 605
- Merge medio
- 9g 11h
- PR unite (30g)
- 14
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di springdoc/springdoc-openapi
-
enhancement upstream
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
springdoc/springdoc-openapi#3324 · 2 commenti ·
I maintainer di solito rispondono entro 9 giorni
-
enhancement upstream
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
springdoc/springdoc-openapi#3309 · 4 commenti · 1 reazione ·
I maintainer di solito rispondono entro 9 giorni
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
springdoc/springdoc-openapi#3404 · 1 commento ·
I maintainer di solito rispondono entro 9 giorni
Tutte le issue di springdoc/springdoc-openapi
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
scylladb/scylla-cdc-source-connector#402 ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
I maintainer di solito rispondono entro 1 giorno
-
enhancement good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
ahmedmmordi/store-app#8 ·
-
jhipster heroku fails on heroku git:remote when reusing an existing app outside a git repositoryApertaarea: triage theme: undefined
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
jhipster/generator-jhipster#36018 ·
I maintainer di solito rispondono entro 1 giorno