-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Add a StrictTypeIdResolver which would throw an exception if type is not in the predefined json subtype list. Use it in DimensionSchema.
#18565
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
e0294e2
strict-type-id
cecemei 5ab276a
test
cecemei 341b26e
Merge branch 'master' into serde
cecemei baf7813
trigger ci / empty commit
cecemei a73daeb
use-delegate
cecemei d31dc50
Merge branch 'master' into serde
cecemei f167cd4
unnecessary-null-check
cecemei 71a2897
Update processing/src/test/java/org/apache/druid/data/input/impl/Dime…
cecemei File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
124 changes: 124 additions & 0 deletions
124
processing/src/main/java/org/apache/druid/jackson/StrictTypeIdResolver.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.apache.druid.jackson; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; | ||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||
| import com.fasterxml.jackson.databind.DatabindContext; | ||
| import com.fasterxml.jackson.databind.DeserializationContext; | ||
| import com.fasterxml.jackson.databind.JavaType; | ||
| import com.fasterxml.jackson.databind.cfg.MapperConfig; | ||
| import com.fasterxml.jackson.databind.jsontype.NamedType; | ||
| import com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator; | ||
| import com.fasterxml.jackson.databind.jsontype.TypeIdResolver; | ||
| import com.fasterxml.jackson.databind.jsontype.impl.StdTypeResolverBuilder; | ||
| import com.fasterxml.jackson.databind.jsontype.impl.TypeIdResolverBase; | ||
| import com.fasterxml.jackson.databind.jsontype.impl.TypeNameIdResolver; | ||
|
|
||
| import java.util.Collection; | ||
|
|
||
| /** | ||
| * A strict {@link TypeIdResolver} implementation that validates all incoming type ids. | ||
| * <p> | ||
| * During deserialization, the type discriminator in the JSON must correspond to a registered subtype; | ||
| * otherwise this resolver will throw an exception instead of silently accepting or defaulting. | ||
| * <p> | ||
| * An optional default implementation may still be configured and used only when the type id is absent. | ||
| */ | ||
| public class StrictTypeIdResolver extends TypeIdResolverBase | ||
| { | ||
| public static class Builder extends StdTypeResolverBuilder | ||
| { | ||
| @Override | ||
| protected TypeIdResolver idResolver( | ||
| MapperConfig<?> config, | ||
| JavaType baseType, | ||
| PolymorphicTypeValidator subtypeValidator, | ||
| Collection<NamedType> subtypes, | ||
| boolean forSer, | ||
| boolean forDeser | ||
| ) | ||
| { | ||
| this._customIdResolver = new StrictTypeIdResolver(config, baseType, subtypes, forSer, forDeser); | ||
| return this._customIdResolver; | ||
| } | ||
| } | ||
|
|
||
| protected final JavaType baseType; | ||
| protected final TypeNameIdResolver delegate; | ||
|
|
||
| StrictTypeIdResolver() | ||
| { | ||
| // Required default constructor for Jackson, the instance is never used | ||
| baseType = null; | ||
| delegate = null; | ||
| } | ||
|
|
||
| StrictTypeIdResolver( | ||
| MapperConfig<?> config, | ||
| JavaType baseType, | ||
| Collection<NamedType> subtypes, | ||
| boolean forSer, | ||
| boolean forDeser | ||
| ) | ||
| { | ||
| this.baseType = baseType; | ||
| this.delegate = TypeNameIdResolver.construct(config, baseType, subtypes, forSer, forDeser); | ||
| } | ||
|
|
||
| @Override | ||
| public JavaType typeFromId(DatabindContext context, String id) throws JsonProcessingException | ||
| { | ||
| JavaType type = delegate.typeFromId(context, id); | ||
| if (type == null) { | ||
| // in TypeNameIdResolver, it'd fall back to defaultImpl if configured, but we want to error out instead | ||
| throw ((DeserializationContext) context).invalidTypeIdException( | ||
| baseType, | ||
| id, | ||
| "known type ids = " + delegate.getDescForKnownTypeIds() | ||
| ); | ||
| } | ||
| return type; | ||
| } | ||
|
|
||
| @Override | ||
| public String idFromValue(Object value) | ||
| { | ||
| return delegate.idFromValue(value); | ||
| } | ||
|
|
||
| @Override | ||
| public String idFromValueAndType(Object value, Class<?> suggestedType) | ||
| { | ||
| return delegate.idFromValueAndType(value, suggestedType); | ||
| } | ||
|
|
||
| @Override | ||
| public String getDescForKnownTypeIds() | ||
| { | ||
| return delegate.getDescForKnownTypeIds(); | ||
| } | ||
|
|
||
| @Override | ||
| public Id getMechanism() | ||
| { | ||
| return Id.CUSTOM; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment states 'the instance is never used' but this may be misleading. Jackson may instantiate this constructor for reflection purposes. Consider clarifying that this constructor creates an unusable instance that should not be used for actual resolution.