Skip to content

Handle JsonView on getter-only properties #2599

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.

Sign up for GitHub

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

Open
xfocus3 wants to merge 1 commit into
base: main
Choose a base branch
from
+55 −1
Open

Handle JsonView on getter-only properties #2599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion core/src/main/java/io/smallrye/openapi/runtime/scanner/dataobject/TypeResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ public class TypeResolver {
private boolean exposed = false;
private boolean readOnly = false;
private boolean writeOnly = false;
private MethodInfo ignoredReadMethod;
private MethodInfo ignoredWriteMethod;
private final List<AnnotationTarget> constraintTargets = new ArrayList<>();
private String propertyNamePrefix;
private String propertyNameSuffix;
Expand Down Expand Up @@ -372,7 +374,17 @@ public Type resolveType() {

public boolean isIgnored() {
return ignored || (readOnly && readMethod == null && field == null)
|| (writeOnly && writeMethod == null && field == null);
|| (writeOnly && writeMethod == null && field == null)
|| (ignoredReadMethod != null && readMethod == ignoredReadMethod && writeMethod == null
&& !isFieldExplicitlyVisible())
|| (ignoredWriteMethod != null && writeMethod == ignoredWriteMethod && readMethod == null
&& !isFieldExplicitlyVisible());
}

private boolean isFieldExplicitlyVisible() {
return field != null && (context.annotations().getAnnotation(field, JacksonConstants.JSON_VIEW) != null
|| isUnhidden(field)
|| context.annotations().getAnnotation(field, JacksonConstants.JSON_PROPERTY) != null);
}

public boolean isReadOnly() {
Expand Down Expand Up @@ -692,8 +704,10 @@ private void processVisibility(AnnotationScannerContext context, AnnotationTarge
if (target.kind() == Kind.METHOD) {
if (isAccessor(context, target.asMethod())) {
this.writeOnly = true;
this.ignoredReadMethod = target.asMethod();
} else {
this.readOnly = true;
this.ignoredWriteMethod = target.asMethod();
}

if (this.readOnly && this.writeOnly) {
Expand Down
40 changes: 40 additions & 0 deletions core/src/test/java/io/smallrye/openapi/runtime/scanner/dataobject/TypeResolverTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -883,6 +883,46 @@ public void setField3(String field3) {
Stream.of("field0", "field1", "field2", "field3").forEach(f -> assertFalse(p3.get(f).isIgnored()));
}

@Test
/*
* Issue: https://github.com/smallrye/smallrye-open-api/issues/2412
*/
void testJsonViewExcludesGetterOnlyProperty() {
class Views {
class Public {
}

class Private {
}
}

@SuppressWarnings("unused")
class Bean {
private String field0;
private String field1;

public String getField0() {
return field0;
}

public void setField0(String field0) {
this.field0 = field0;
}

@JsonView(Views.Private.class)
public String getField1() {
return field1;
}
}

AnnotationScannerContext context = buildContext(emptyConfig(), Bean.class, Views.Private.class, Views.Public.class);
context.getJsonViews().put(Type.create(DotName.createSimple(Views.Public.class), Type.Kind.CLASS), true);

Map<String, TypeResolver> properties = getProperties(context, Bean.class);
assertFalse(properties.get("field0").isIgnored());
assertTrue(properties.get("field1").isIgnored());
}

/*
* Issue: https://github.com/smallrye/smallrye-open-api/issues/1817
*/
Expand Down