Skip to content

[Enhancement] Strict Staged Builders Support Primitive Optimized Collections #2464

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

Merged
merged 1 commit into from
May 20, 2025
Merged

[Enhancement] Strict Staged Builders Support Primitive Optimized Collections #2464

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
5 changes: 5 additions & 0 deletions changelog/@unreleased/pr-2464.v2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
type: improvement
improvement:
description: '[Enhancement] Strict Staged Builders Support Primitive Optimized Collections'
links:
- https://github.com/palantir/conjure-java/pull/2464
30 changes: 28 additions & 2 deletions ...ionInput/java/strictprimitivecollections/com/palantir/product/PrimitiveStrictExample.java
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 8 additions & 2 deletions ...-core/src/main/java/com/palantir/conjure/java/types/BeanBuilderAuxiliarySettersUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,18 @@ final class BeanBuilderAuxiliarySettersUtils {
private BeanBuilderAuxiliarySettersUtils() {}

static MethodSpec.Builder createPrimitiveCollectionSetterBuilder(
EnrichedField enriched, TypeMapper typeMapper, ClassName returnClass, SafetyEvaluator safetyEvaluator) {
EnrichedField enriched,
TypeMapper typeMapper,
ClassName returnClass,
SafetyEvaluator safetyEvaluator,
boolean strict) {
FieldSpec field = enriched.poetSpec();
FieldDefinition definition = enriched.conjureDef();
TypeName innerTypeName = extractInnerTypeFromList(definition, typeMapper, safetyEvaluator);
// Strict builders are not "adders" so they should be named to overload the field setter
String methodName = strict ? field.name() : "addAll" + StringUtils.capitalize(field.name());

return MethodSpec.methodBuilder("addAll" + StringUtils.capitalize(field.name()))
return MethodSpec.methodBuilder(methodName)
.addJavadoc(Javadoc.render(definition.getDocs(), definition.getDeprecated())
.map(rendered -> CodeBlock.of("$L", rendered))
.orElseGet(() -> CodeBlock.builder().build()))
Expand Down
121 changes: 69 additions & 52 deletions conjure-java-core/src/main/java/com/palantir/conjure/java/types/BeanBuilderGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,8 @@ private void addStrictStagedBuilderImpl(
addJsonDeserializeUsingBuilderAnnotation(specBuilder, STAGED_BUILDER_IMPLEMENTATION_NAME);

List<EnrichedField> allFields = enrichFields(typeDef.getFields());
List<TypeSpec> interfaces =
generateIntermediateStageInterfaces(objectClass, builderClass, typeMapper, allFields, safetyEvaluator);
interfaces.add(generateBuilderFinalStageInterface(List.of()));
List<TypeSpec> interfaces = generateIntermediateStageInterfaces(allFields, true);
interfaces.add(generateBuilderFinalStageInterface(List.of(), true));
specBuilder.addTypes(interfaces);

addBuilderInterfaceAndMethod(specBuilder, interfaces);
Expand Down Expand Up @@ -203,11 +202,12 @@ private void addStagedBuilderImpl(

addJsonDeserializeUsingBuilderAnnotation(specBuilder, STAGED_BUILDER_IMPLEMENTATION_NAME);

List<TypeSpec> interfaces = generateIntermediateStageInterfaces(
objectClass, builderClass, typeMapper, fieldsNeedingBuilderStage, safetyEvaluator);
interfaces.add(generateBuilderFinalStageInterface(allFields.stream()
.filter(field -> !fieldsNeedingBuilderStage.contains(field))
.collect(Collectors.toList())));
List<TypeSpec> interfaces = generateIntermediateStageInterfaces(fieldsNeedingBuilderStage, false);
interfaces.add(generateBuilderFinalStageInterface(
allFields.stream()
.filter(field -> !fieldsNeedingBuilderStage.contains(field))
.collect(Collectors.toList()),
false));
specBuilder.addTypes(interfaces);
addBuilderInterfaceAndMethod(specBuilder, interfaces);

Expand Down Expand Up @@ -264,19 +264,16 @@ private void addBuilderInterfaceAndMethod(TypeSpec.Builder specBuilder, List<Typ
.build());
}

private static List<TypeSpec> generateIntermediateStageInterfaces(
ClassName objectClass,
ClassName builderClass,
TypeMapper typeMapper,
List<EnrichedField> fieldsNeedingBuilderStage,
SafetyEvaluator safetyEvaluator) {
private List<TypeSpec> generateIntermediateStageInterfaces(
List<EnrichedField> fieldsNeedingBuilderStage, boolean strict) {
List<TypeSpec.Builder> interfaces = new ArrayList<>();

PeekingIterator<EnrichedField> fieldPeekingIterator =
Iterators.peekingIterator(fieldsNeedingBuilderStage.iterator());

while (fieldPeekingIterator.hasNext()) {
EnrichedField field = fieldPeekingIterator.next();
Type type = field.conjureDef().getType();
String nextBuilderStageName = fieldPeekingIterator.hasNext()
? JavaNameSanitizer.sanitize(fieldPeekingIterator.peek().fieldName())
: "completed_";
Expand All @@ -290,7 +287,7 @@ private static List<TypeSpec> generateIntermediateStageInterfaces(
.addParameter(ParameterSpec.builder(
BeanBuilderAuxiliarySettersUtils.widenParameterIfPossible(
field.poetSpec().type(),
field.conjureDef().getType(),
type,
typeMapper,
safetyEvaluator.getUsageTimeSafety(field.conjureDef())),
JavaNameSanitizer.sanitize(field.fieldName()))
Expand All @@ -300,12 +297,20 @@ private static List<TypeSpec> generateIntermediateStageInterfaces(
.returns(Primitives.box(nextStageClassName))
.build());

if (field.conjureDef().getType().accept(TypeVisitor.IS_OPTIONAL)) {
if (type.accept(TypeVisitor.IS_OPTIONAL)) {
stageInterface.addMethod(BeanBuilderAuxiliarySettersUtils.createOptionalSetterBuilder(
field, typeMapper, nextStageClassName, safetyEvaluator)
.addModifiers(Modifier.ABSTRACT)
.build());
}

if (isPrimitiveOptimized(type)) {
stageInterface.addMethod(BeanBuilderAuxiliarySettersUtils.createPrimitiveCollectionSetterBuilder(
field, typeMapper, nextStageClassName, safetyEvaluator, strict)
.addModifiers(Modifier.ABSTRACT)
.build());
}

interfaces.add(stageInterface);
}

Expand All @@ -320,7 +325,7 @@ private static List<TypeSpec> generateIntermediateStageInterfaces(
return interfaces.stream().map(TypeSpec.Builder::build).collect(Collectors.toList());
}

private TypeSpec generateBuilderFinalStageInterface(List<EnrichedField> fields) {
private TypeSpec generateBuilderFinalStageInterface(List<EnrichedField> fields, boolean strict) {
ClassName completedStageClass = stageBuilderInterfaceName(objectClass, "completed_");
return TypeSpec.interfaceBuilder(completedStageClass)
.addModifiers(Modifier.PUBLIC)
Expand All @@ -330,7 +335,7 @@ private TypeSpec generateBuilderFinalStageInterface(List<EnrichedField> fields)
.returns(Primitives.box(objectClass))
.build())
.addMethods(fields.stream()
.map(field -> generateMethodsForFinalStageInterfaceField(field, completedStageClass))
.map(field -> generateMethodsForFinalStageInterfaceField(field, completedStageClass, strict))
.flatMap(List::stream)
.collect(Collectors.toList()))
.build();
Expand All @@ -340,7 +345,8 @@ private static ClassName stageBuilderInterfaceName(ClassName enclosingClass, Str
return enclosingClass.nestedClass(StringUtils.capitalize(stageName) + "StageBuilder");
}

private List<MethodSpec> generateMethodsForFinalStageInterfaceField(EnrichedField enriched, ClassName returnClass) {
private List<MethodSpec> generateMethodsForFinalStageInterfaceField(
EnrichedField enriched, ClassName returnClass, boolean strict) {
List<MethodSpec> methodSpecs = new ArrayList<>();
Type type = enriched.conjureDef().getType();
FieldDefinition definition = enriched.conjureDef();
Expand Down Expand Up @@ -368,7 +374,7 @@ private List<MethodSpec> generateMethodsForFinalStageInterfaceField(EnrichedFiel
.build());
if (isPrimitiveOptimized(type)) {
methodSpecs.add(BeanBuilderAuxiliarySettersUtils.createPrimitiveCollectionSetterBuilder(
enriched, typeMapper, returnClass, safetyEvaluator)
enriched, typeMapper, returnClass, safetyEvaluator, strict)
.addModifiers(Modifier.ABSTRACT)
.build());
}
Expand Down Expand Up @@ -596,9 +602,17 @@ private Iterable<MethodSpec> createSetters(
// Each field tends to fan out into many setters
Collection<MethodSpec> setters = Lists.newArrayListWithExpectedSize(fields.size() * 5);
for (EnrichedField field : fields) {
setters.add(createSetter(field, typesMap, override, strict));
if (!strict || field.conjureDef().getType().accept(TypeVisitor.IS_OPTIONAL)) {
setters.addAll(createAuxiliarySetters(field, typesMap, override));
Type type = field.conjureDef().getType();

// Add all the base required setters
setters.add(createSetter(field, typesMap, override));
// Add any primitive setters, which are required when optimized as they handle deserialization
if (isPrimitiveOptimized(type)) {
setters.add(createPrimitiveCollectionSetter(field, typesMap, override, strict));
}
// Non-strict builders have various additional QOL overloads
if (!strict || type.accept(TypeVisitor.IS_OPTIONAL)) {
setters.addAll(createAuxiliarySetters(field, override));
}
}
return setters;
Expand All @@ -607,8 +621,7 @@ private Iterable<MethodSpec> createSetters(
private MethodSpec createSetter(
EnrichedField enriched,
Map<com.palantir.conjure.spec.TypeName, TypeDefinition> typesMap,
boolean override,
boolean strict) {
boolean override) {
FieldSpec field = enriched.poetSpec();
Type type = enriched.conjureDef().getType();

Expand All @@ -633,12 +646,7 @@ private MethodSpec createSetter(
// Certain type combinations and feature flags may produce highly optimized code paths.
// These optimized paths include deserialization, so if it isn't enabled we should add the
// simple deserializer.
//
// At the moment we are excluding strict staged builders from the optimization
// however there was an issue that when generating strict builders we assumed
// that another setter would be added later. This is not the case for strict staged
// builders.
if (!isPrimitiveOptimized(type) || strict) {
if (!isPrimitiveOptimized(type)) {
setterBuilder.addAnnotation(createJacksonSetterAnnotation(enriched, typesMap));
}

Expand Down Expand Up @@ -684,26 +692,42 @@ private MethodSpec createCollectionSetter(String prefix, EnrichedField enriched,
private MethodSpec createPrimitiveCollectionSetter(
EnrichedField enriched,
Map<com.palantir.conjure.spec.TypeName, TypeDefinition> typesMap,
boolean override) {
boolean override,
boolean strict) {
FieldSpec field = enriched.poetSpec();
Type type = enriched.conjureDef().getType();

CollectionType collectionType = getCollectionType(type);
return BeanBuilderAuxiliarySettersUtils.createPrimitiveCollectionSetterBuilder(
enriched, typeMapper, builderClass, safetyEvaluator)
MethodSpec.Builder methodBuilder = BeanBuilderAuxiliarySettersUtils.createPrimitiveCollectionSetterBuilder(
enriched, typeMapper, builderClass, safetyEvaluator, strict)
.addAnnotations(ConjureAnnotations.override(override))
// Unlike the other setter, when this setter is present it is always responsible for deserialization
.addAnnotation(createJacksonSetterAnnotation(enriched, typesMap))
.addCode(verifyNotBuilt())
.addCode(CodeBlocks.statement(
"$1T.addAllTo$2L(this.$3N, $4L)",
ConjureCollections.class,
collectionType.getConjureCollectionType().getCollectionName(),
field.name(),
Expressions.requireNonNull(
field.name(), enriched.fieldName().get() + " cannot be null")))
.addStatement("return this")
.build();
.addCode(verifyNotBuilt());

if (strict) {
// the primitive collection overload inside of a strict builder cannot allow
// for modification as such we should create a new container on every call.
// This is admittedly very defensive as it would involve someone explicitly casting
// away the strict builder safety, but its not impossible...
methodBuilder.addCode(CodeBlocks.statement(
"this.$1N = $2T.newNonNull$3L($4L)",
field.name(),
ConjureCollections.class,
collectionType.getConjureCollectionType().getCollectionName(),
Expressions.requireNonNull(
field.name(), enriched.fieldName().get() + " cannot be null")));
} else {
methodBuilder.addCode(CodeBlocks.statement(
"$1T.addAllTo$2L(this.$3N, $4L)",
ConjureCollections.class,
collectionType.getConjureCollectionType().getCollectionName(),
field.name(),
Expressions.requireNonNull(
field.name(), enriched.fieldName().get() + " cannot be null")));
}

return methodBuilder.addStatement("return this").build();
}

@SuppressWarnings("checkstyle:CyclomaticComplexity")
Expand Down Expand Up @@ -798,20 +822,13 @@ private boolean isByteBuffer(Type type) {
return type.accept(TypeVisitor.IS_BINARY) && !options.useImmutableBytes();
}

private List<MethodSpec> createAuxiliarySetters(
EnrichedField enriched,
Map<com.palantir.conjure.spec.TypeName, TypeDefinition> typesMap,
boolean override) {
private List<MethodSpec> createAuxiliarySetters(EnrichedField enriched, boolean override) {
Type type = enriched.conjureDef().getType();
Optional<LogSafety> safety = safetyEvaluator.getUsageTimeSafety(enriched.conjureDef());

ImmutableList.Builder<MethodSpec> builder = ImmutableList.builder();

if (type.accept(TypeVisitor.IS_LIST)) {
if (isPrimitiveOptimized(type)) {
Copy link
Member Author

@bmarcaur bmarcaur Feb 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hoisted this up as having it nested in the auxiliary setters was a hold over from a time before isPrimitiveOptimized properly guarded for collection types only. Hence it needing to be nested inside a type.accept(TypeVisitor.IS_LIST). However, this is not strictly a refactor for refactor's sake. I did need to add the primitive setter in more cases than what this method is used for.

builder.add(createPrimitiveCollectionSetter(enriched, typesMap, override));
}

builder.add(
createCollectionSetter("addAll", enriched, override),
createItemSetter(enriched, type.accept(TypeVisitor.LIST).getItemType(), override, safety));
Expand Down