From b6fc327e46b4d1bd92271d726139bf61296f4fcd Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Mon, 23 Feb 2026 17:47:03 -0500 Subject: [PATCH 01/12] impl --- .../slack/api/util/annotation/Required.java | 11 +++ .../api/util/json/RequiredAdapterFactory.java | 79 +++++++++++++++++++ .../test_locally/util/JSONUtilityTest.java | 25 ++++++ 3 files changed, 115 insertions(+) create mode 100644 slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java create mode 100644 slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java diff --git a/slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java b/slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java new file mode 100644 index 000000000..4e4c9b724 --- /dev/null +++ b/slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java @@ -0,0 +1,11 @@ +package com.slack.api.util.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface Required { +} diff --git a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java new file mode 100644 index 000000000..a1a723d55 --- /dev/null +++ b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java @@ -0,0 +1,79 @@ +package com.slack.api.util.json; + +import com.google.gson.JsonParseException; +import com.google.gson.Gson; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.TypeAdapter; +import com.google.gson.reflect.TypeToken; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.slack.api.util.annotation.Required; + +import java.util.Arrays; +import java.io.IOException; + +/** + * Adapter factory for processing objects annotated with our custom annotation {@link Required}. + *

+ * For deserialization (e.g. converting JSON --> POJO), it ensures that any fields marked as {@link Required} are + * present in the constructed object and nonnull. + *

+ * For serialization (e.g. converting POJO --> JSON), it ensures that any fields marked as {@link Required} are + * non-null and written to the JSON string. + */ +public class RequiredAdapterFactory implements TypeAdapterFactory { + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + TypeAdapter delegate = gson.getDelegateAdapter(this, type); + + // Check if there are any fields that have the @Required annotation. If there aren't, + // we can directly delegate to the underlying type factory + boolean hasRequiredAnnotation = Arrays.stream(type.getRawType().getDeclaredFields()) + .anyMatch(field -> field.isAnnotationPresent(Required.class)); + + if (!hasRequiredAnnotation) { + return delegate; + } + + return new TypeAdapter() { + @Override + public void write(JsonWriter out, T value) throws IOException { + if (value != null) { + ensureFieldValidity(value); + } + delegate.write(out, value); + } + + @Override + public T read(JsonReader in) throws IOException { + T result = delegate.read(in); + if (result == null) { + return null; + } + + ensureFieldValidity(result); + return result; + } + }; + } + + private void ensureFieldValidity(T obj) { + Arrays.asList(obj.getClass().getDeclaredFields()).forEach(field -> { + if (field.isAnnotationPresent(Required.class)) { + // Primitives get initialized by the JVM, so if the annotation was used + // on any primitives, it doesn't really make sense to check this + if (!field.getType().isPrimitive()) { + field.setAccessible(true); + try { + if (field.get(obj) == null) { + throw new JsonParseException("Required field '" + field.getName() + "' is missing in " + + obj.getClass().getSimpleName()); + } + } catch (IllegalAccessException e) { + throw new JsonParseException("Cannot access field: " + field.getName(), e); + } + } + } + }); + } +} diff --git a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java index c2139faee..5da5d3845 100644 --- a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java +++ b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java @@ -11,7 +11,10 @@ import com.slack.api.model.block.element.ImageElement; import com.slack.api.model.block.element.OverflowMenuElement; import com.slack.api.model.event.FunctionExecutedEvent; +import com.slack.api.util.annotation.Required; import com.slack.api.util.json.*; +import lombok.Builder; +import lombok.Data; import org.junit.Test; import test_locally.unit.GsonFactory; @@ -25,6 +28,8 @@ import static org.hamcrest.CoreMatchers.is; import static org.hamcrest.MatcherAssert.assertThat; import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.fail; public class JSONUtilityTest { @@ -153,4 +158,24 @@ public void testGsonFunctionExecutedEventInputValueFactory() { parsed = f.deserialize(json, FunctionExecutedEvent.InputValue.class, context); assertThat(parsed.asStringArray(), is(Arrays.asList("C111", "C222"))); } + + @Test + public void testRequiredAdapterFactory() { + Gson gson = new GsonBuilder().registerTypeAdapterFactory(new RequiredAdapterFactory()).create(); + + // Serialization + TestClassWithRequired instance = TestClassWithRequired.builder().build(); + assertThrows(JsonParseException.class, () -> gson.toJson(instance)); + + // Deserialization + String json = "{\"name\": \"Hello\"}"; + assertThrows(JsonParseException.class, () -> gson.fromJson(json, TestClassWithRequired.class)); + } + + @Data + @Builder + private static class TestClassWithRequired { + @Required private Integer id; + private String name; + } } From 61394abe67ccbae3cbc02b11b3ee08313e4c0f4e Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Mon, 23 Feb 2026 18:00:54 -0500 Subject: [PATCH 02/12] update javadocs --- .../com/slack/api/util/json/RequiredAdapterFactory.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java index a1a723d55..d5507a7f3 100644 --- a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java +++ b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java @@ -13,13 +13,15 @@ import java.io.IOException; /** - * Adapter factory for processing objects annotated with our custom annotation {@link Required}. + * Adapter factory for processing objects annotated with {@link Required}. This annotation signals what properties + * of a model object are required, and thus should be expected to be initialized and non-null on every instance of + * said object. *

* For deserialization (e.g. converting JSON --> POJO), it ensures that any fields marked as {@link Required} are * present in the constructed object and nonnull. *

- * For serialization (e.g. converting POJO --> JSON), it ensures that any fields marked as {@link Required} are - * non-null and written to the JSON string. + * For serialization (e.g. converting POJO --> JSON), it ensures that any fields marked as {@link Required} are non-null + * in the construct object prior to serialization. */ public class RequiredAdapterFactory implements TypeAdapterFactory { @Override From 00d45fab4cd1e38f135a50766a60429b7f4d0d08 Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Tue, 24 Feb 2026 12:52:14 -0500 Subject: [PATCH 03/12] updates --- .../main/java/com/slack/api/SlackConfig.java | 10 ++++ .../com/slack/api/util/json/GsonFactory.java | 14 +++-- .../api/model/annotation/FieldPredicate.java | 5 ++ .../annotation/IsNotNullFieldPredicate.java | 10 ++++ .../slack/api/model/annotation/Required.java | 25 +++++++++ .../slack/api/util/annotation/Required.java | 11 ---- .../api/util/json/RequiredAdapterFactory.java | 33 +++++------- .../java/test_locally/unit/GsonFactory.java | 12 +++-- .../test_locally/util/JSONUtilityTest.java | 54 ++++++++++++++++--- 9 files changed, 127 insertions(+), 47 deletions(-) create mode 100644 slack-api-model/src/main/java/com/slack/api/model/annotation/FieldPredicate.java create mode 100644 slack-api-model/src/main/java/com/slack/api/model/annotation/IsNotNullFieldPredicate.java create mode 100644 slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java delete mode 100644 slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java diff --git a/slack-api-client/src/main/java/com/slack/api/SlackConfig.java b/slack-api-client/src/main/java/com/slack/api/SlackConfig.java index a3b0707b2..1c72260c7 100644 --- a/slack-api-client/src/main/java/com/slack/api/SlackConfig.java +++ b/slack-api-client/src/main/java/com/slack/api/SlackConfig.java @@ -62,6 +62,9 @@ public void setFailOnUnknownProperties(boolean failOnUnknownProperties) { throwException(); } + @Override + public void setFailOnRequiredProperties(boolean failOnRequiredProperties) { throwException(); } + @Override public void setPrettyResponseLoggingEnabled(boolean prettyResponseLoggingEnabled) { throwException(); @@ -248,6 +251,13 @@ public void setLibraryMaintainerMode(boolean libraryMaintainerMode) { */ private boolean failOnUnknownProperties = false; + /** + * Makes it so that any fields annotated with {@link com.slack.api.model.annotation.Required} that are missing + * or invalid when deserializing responses from the Slack Web API client will throw an exception. + * By default, this is "off", but can be opted into by setting to true. + */ + private boolean failOnRequiredProperties = false; + /** * Slack Web API client verifies the existence of tokens before sending HTTP requests to Slack servers. */ diff --git a/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java b/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java index 4468f2df4..595b8d83b 100644 --- a/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java +++ b/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java @@ -32,7 +32,7 @@ private GsonFactory() { public static Gson createSnakeCase() { GsonBuilder gsonBuilder = new GsonBuilder() .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES); - registerTypeAdapters(gsonBuilder, false); + registerTypeAdapters(gsonBuilder, false, false); return gsonBuilder.create(); } @@ -41,9 +41,10 @@ public static Gson createSnakeCase() { */ public static Gson createSnakeCase(SlackConfig config) { boolean failOnUnknownProps = config.isFailOnUnknownProperties(); + boolean failOnRequiredProperties = config.isFailOnRequiredProperties(); GsonBuilder gsonBuilder = new GsonBuilder() .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES); - registerTypeAdapters(gsonBuilder, failOnUnknownProps); + registerTypeAdapters(gsonBuilder, failOnUnknownProps, failOnRequiredProperties); if (failOnUnknownProps || config.isLibraryMaintainerMode()) { gsonBuilder = gsonBuilder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()); } @@ -58,8 +59,9 @@ public static Gson createSnakeCase(SlackConfig config) { */ public static Gson createCamelCase(SlackConfig config) { boolean failOnUnknownProps = config.isFailOnUnknownProperties(); + boolean failOnRequiredProperties = config.isFailOnRequiredProperties(); GsonBuilder gsonBuilder = new GsonBuilder(); - registerTypeAdapters(gsonBuilder, failOnUnknownProps); + registerTypeAdapters(gsonBuilder, failOnUnknownProps, failOnRequiredProperties); if (failOnUnknownProps || config.isLibraryMaintainerMode()) { gsonBuilder = gsonBuilder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()); } @@ -69,7 +71,7 @@ public static Gson createCamelCase(SlackConfig config) { return gsonBuilder.create(); } - public static void registerTypeAdapters(GsonBuilder builder, boolean failOnUnknownProps) { + public static void registerTypeAdapters(GsonBuilder builder, boolean failOnUnknownProps, boolean failOnRequiredProperties) { builder .registerTypeAdapter(Instant.class, new JavaTimeInstantFactory(failOnUnknownProps)) .registerTypeAdapter(File.class, new GsonFileFactory(failOnUnknownProps)) @@ -86,5 +88,9 @@ public static void registerTypeAdapters(GsonBuilder builder, boolean failOnUnkno .registerTypeAdapter(AppWorkflow.StepInputValueElementDefault.class, new GsonAppWorkflowStepInputValueDefaultFactory(failOnUnknownProps)) .registerTypeAdapter(LogsResponse.DetailsChangedValue.class, new GsonAuditLogsDetailsChangedValueFactory(failOnUnknownProps)) .registerTypeAdapter(LogsResponse.UserIDs.class, new GsonAuditLogsDetailsUserIDsFactory(failOnUnknownProps)); + + if (failOnRequiredProperties) { + builder.registerTypeAdapterFactory(new RequiredAdapterFactory()); + } } } diff --git a/slack-api-model/src/main/java/com/slack/api/model/annotation/FieldPredicate.java b/slack-api-model/src/main/java/com/slack/api/model/annotation/FieldPredicate.java new file mode 100644 index 000000000..d6d7b29cc --- /dev/null +++ b/slack-api-model/src/main/java/com/slack/api/model/annotation/FieldPredicate.java @@ -0,0 +1,5 @@ +package com.slack.api.model.annotation; + +public interface FieldPredicate { + boolean test(Object obj); +} diff --git a/slack-api-model/src/main/java/com/slack/api/model/annotation/IsNotNullFieldPredicate.java b/slack-api-model/src/main/java/com/slack/api/model/annotation/IsNotNullFieldPredicate.java new file mode 100644 index 000000000..90e638701 --- /dev/null +++ b/slack-api-model/src/main/java/com/slack/api/model/annotation/IsNotNullFieldPredicate.java @@ -0,0 +1,10 @@ +package com.slack.api.model.annotation; + +import java.util.Objects; + +public class IsNotNullFieldPredicate implements FieldPredicate { + @Override + public boolean test(Object obj) { + return !Objects.isNull(obj); + } +} diff --git a/slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java b/slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java new file mode 100644 index 000000000..d741490c9 --- /dev/null +++ b/slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java @@ -0,0 +1,25 @@ +package com.slack.api.model.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Field-level annotation indicating whether the field is a "required" field or not on the model object. + *

+ * The enforcement of the field's presence in instantiated instances of the model object is accomplished using the + * {@link com.slack.api.util.json.RequiredAdapterFactory} which ensures all fields marked with {@link Required} are + * present during the object deserialization (or serialization) process. Note that the enforcement of this annotation + * is opt-in and defaults to "off". + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface Required { + /** + * Optional predicate to evaluate against the field annotated with {@link Required}. By default, all fields + * marked with {@link Required} are checked for null. Primitive field types are initialized by the JVM, and thus + * are never null by default. + */ + Class validator() default IsNotNullFieldPredicate.class; +} diff --git a/slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java b/slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java deleted file mode 100644 index 4e4c9b724..000000000 --- a/slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java +++ /dev/null @@ -1,11 +0,0 @@ -package com.slack.api.util.annotation; - -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; - -@Retention(RetentionPolicy.RUNTIME) -@Target(ElementType.FIELD) -public @interface Required { -} diff --git a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java index d5507a7f3..56c98693b 100644 --- a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java +++ b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java @@ -7,8 +7,10 @@ import com.google.gson.reflect.TypeToken; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; -import com.slack.api.util.annotation.Required; +import com.slack.api.model.annotation.FieldPredicate; +import com.slack.api.model.annotation.Required; +import java.lang.reflect.InvocationTargetException; import java.util.Arrays; import java.io.IOException; @@ -28,15 +30,6 @@ public class RequiredAdapterFactory implements TypeAdapterFactory { public TypeAdapter create(Gson gson, TypeToken type) { TypeAdapter delegate = gson.getDelegateAdapter(this, type); - // Check if there are any fields that have the @Required annotation. If there aren't, - // we can directly delegate to the underlying type factory - boolean hasRequiredAnnotation = Arrays.stream(type.getRawType().getDeclaredFields()) - .anyMatch(field -> field.isAnnotationPresent(Required.class)); - - if (!hasRequiredAnnotation) { - return delegate; - } - return new TypeAdapter() { @Override public void write(JsonWriter out, T value) throws IOException { @@ -62,18 +55,16 @@ public T read(JsonReader in) throws IOException { private void ensureFieldValidity(T obj) { Arrays.asList(obj.getClass().getDeclaredFields()).forEach(field -> { if (field.isAnnotationPresent(Required.class)) { - // Primitives get initialized by the JVM, so if the annotation was used - // on any primitives, it doesn't really make sense to check this - if (!field.getType().isPrimitive()) { - field.setAccessible(true); - try { - if (field.get(obj) == null) { - throw new JsonParseException("Required field '" + field.getName() + "' is missing in " - + obj.getClass().getSimpleName()); - } - } catch (IllegalAccessException e) { - throw new JsonParseException("Cannot access field: " + field.getName(), e); + field.setAccessible(true); + try { + FieldPredicate predicate = field.getAnnotation(Required.class).validator().getDeclaredConstructor().newInstance(); + if (!predicate.test(field.get(obj))) { + throw new JsonParseException("Required field '" + field.getName() + "' failed validation in " + + obj.getClass().getSimpleName() + " using predicate " + predicate.getClass().getSimpleName()); } + } catch (NoSuchMethodException | InstantiationException | IllegalAccessException | + InvocationTargetException e) { + throw new JsonParseException("Cannot parse field: " + field.getName(), e); } } }); diff --git a/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java b/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java index 409056175..a75c6d371 100644 --- a/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java +++ b/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java @@ -28,9 +28,13 @@ public static Gson createSnakeCaseWithoutUnknownPropertyDetection(boolean failOn } public static Gson createSnakeCase(boolean failOnUnknownProperties, boolean unknownPropertyDetection) { + return getBuilder(failOnUnknownProperties, unknownPropertyDetection).create(); + } + + public static GsonBuilder getBuilder(boolean failOnUnknownProperties, boolean unknownPropertyDetection) { GsonBuilder builder = new GsonBuilder() .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES) - .registerTypeAdapter(File.class, new GsonFileFactory(failOnUnknownProperties)) + .registerTypeAdapter(File.class, new GsonFileFactory()) .registerTypeAdapter(LayoutBlock.class, new GsonLayoutBlockFactory(failOnUnknownProperties)) .registerTypeAdapter(BlockElement.class, new GsonBlockElementFactory(failOnUnknownProperties)) .registerTypeAdapter(ContextBlockElement.class, new GsonContextBlockElementFactory(failOnUnknownProperties)) @@ -45,9 +49,9 @@ public static Gson createSnakeCase(boolean failOnUnknownProperties, boolean unkn new GsonMessageChangedEventPreviousMessageFactory(failOnUnknownProperties)); if (unknownPropertyDetection) { - return builder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()).create(); - } else { - return builder.create(); + builder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()); } + + return builder; } } diff --git a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java index 5da5d3845..b252677f6 100644 --- a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java +++ b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java @@ -1,6 +1,7 @@ package test_locally.util; import com.google.gson.*; +import com.slack.api.model.annotation.FieldPredicate; import com.slack.api.model.block.ContextBlockElement; import com.slack.api.model.block.DividerBlock; import com.slack.api.model.block.LayoutBlock; @@ -11,11 +12,12 @@ import com.slack.api.model.block.element.ImageElement; import com.slack.api.model.block.element.OverflowMenuElement; import com.slack.api.model.event.FunctionExecutedEvent; -import com.slack.api.util.annotation.Required; +import com.slack.api.model.annotation.Required; import com.slack.api.util.json.*; import lombok.Builder; import lombok.Data; import org.junit.Test; +import org.junit.runners.model.TestClass; import test_locally.unit.GsonFactory; import java.lang.reflect.Type; @@ -26,10 +28,10 @@ import static com.slack.api.model.block.element.BlockElements.image; import static com.slack.api.model.block.element.BlockElements.overflowMenu; import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.Matchers.equalToIgnoringCase; import static org.hamcrest.MatcherAssert.assertThat; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertThrows; -import static org.junit.Assert.fail; public class JSONUtilityTest { @@ -160,22 +162,60 @@ public void testGsonFunctionExecutedEventInputValueFactory() { } @Test - public void testRequiredAdapterFactory() { - Gson gson = new GsonBuilder().registerTypeAdapterFactory(new RequiredAdapterFactory()).create(); + public void testRequiredAdapterFactory_basicCase() { + Gson gson = GsonFactory.getBuilder(true, true) + .registerTypeAdapterFactory(new RequiredAdapterFactory()).create(); // Serialization - TestClassWithRequired instance = TestClassWithRequired.builder().build(); + TestClassWithRequiredBasic instance = TestClassWithRequiredBasic.builder().build(); assertThrows(JsonParseException.class, () -> gson.toJson(instance)); // Deserialization String json = "{\"name\": \"Hello\"}"; - assertThrows(JsonParseException.class, () -> gson.fromJson(json, TestClassWithRequired.class)); + assertThrows(JsonParseException.class, () -> gson.fromJson(json, TestClassWithRequiredBasic.class)); + } + + @Test + public void testRequiredAdapterFactory_advancedCase() { + Gson gson = GsonFactory.getBuilder(true, true).registerTypeAdapterFactory(new RequiredAdapterFactory()).create(); + + // Serialization + JsonParseException e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().build())); + assertThat(e.getMessage(), equalToIgnoringCase("Required field 'id' failed validation in TestClassWithRequiredAdvanced using predicate IntegerGreaterThanZero")); + + e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().id(1).build())); + assertThat(e.getMessage(), equalToIgnoringCase("Required field 'name' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyString")); + e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().id(1).name("").build())); + assertThat(e.getMessage(), equalToIgnoringCase("Required field 'name' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyString")); } @Data @Builder - private static class TestClassWithRequired { + private static class TestClassWithRequiredBasic { @Required private Integer id; private String name; } + + @Data + @Builder + private static class TestClassWithRequiredAdvanced { + @Required(validator = IntegerGreaterThanZero.class) + private int id; + @Required(validator = NonEmptyString.class) + private String name; + + public static class IntegerGreaterThanZero implements FieldPredicate { + @Override + public boolean test(Object obj) { + return obj instanceof Integer && (int)obj > 0; + } + } + + public static class NonEmptyString implements FieldPredicate { + @Override + public boolean test(Object obj) { + return obj instanceof String && !((String) obj).isEmpty(); + } + } + } } From ead8247bb2f7ab5979de0abbbe2cfc2311876ad4 Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Tue, 24 Feb 2026 12:58:36 -0500 Subject: [PATCH 04/12] update javadocs --- .../slack/api/util/json/RequiredAdapterFactory.java | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java index 56c98693b..c77a258e4 100644 --- a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java +++ b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java @@ -16,14 +16,11 @@ /** * Adapter factory for processing objects annotated with {@link Required}. This annotation signals what properties - * of a model object are required, and thus should be expected to be initialized and non-null on every instance of - * said object. + * of a model object are required, and thus should be expected to be initialized on instantiated instances. For all + * fields on the model objected annotated with {@link Required} applies the {@link FieldPredicate#test(Object)} via the + * specified {@link Required#validator()}. *

- * For deserialization (e.g. converting JSON --> POJO), it ensures that any fields marked as {@link Required} are - * present in the constructed object and nonnull. - *

- * For serialization (e.g. converting POJO --> JSON), it ensures that any fields marked as {@link Required} are non-null - * in the construct object prior to serialization. + * Note that this adapter handles both deserialization (JSON --> POJO) and serialization (POJO --> JSON). */ public class RequiredAdapterFactory implements TypeAdapterFactory { @Override From f04be39774e3801114d137511cfca235876aaac8 Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Tue, 24 Feb 2026 15:39:51 -0500 Subject: [PATCH 05/12] small update --- .../src/test/java/test_locally/unit/GsonFactory.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java b/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java index a75c6d371..4138c5b0e 100644 --- a/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java +++ b/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java @@ -34,7 +34,7 @@ public static Gson createSnakeCase(boolean failOnUnknownProperties, boolean unkn public static GsonBuilder getBuilder(boolean failOnUnknownProperties, boolean unknownPropertyDetection) { GsonBuilder builder = new GsonBuilder() .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES) - .registerTypeAdapter(File.class, new GsonFileFactory()) + .registerTypeAdapter(File.class, new GsonFileFactory(failOnUnknownProperties)) .registerTypeAdapter(LayoutBlock.class, new GsonLayoutBlockFactory(failOnUnknownProperties)) .registerTypeAdapter(BlockElement.class, new GsonBlockElementFactory(failOnUnknownProperties)) .registerTypeAdapter(ContextBlockElement.class, new GsonContextBlockElementFactory(failOnUnknownProperties)) From 8e21407037925186b94a7c31f4514a316770666d Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Tue, 24 Feb 2026 15:45:36 -0500 Subject: [PATCH 06/12] add a couple more test cases --- .../test/java/test_locally/util/JSONUtilityTest.java | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java index b252677f6..088a319f3 100644 --- a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java +++ b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java @@ -187,6 +187,16 @@ public void testRequiredAdapterFactory_advancedCase() { assertThat(e.getMessage(), equalToIgnoringCase("Required field 'name' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyString")); e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().id(1).name("").build())); assertThat(e.getMessage(), equalToIgnoringCase("Required field 'name' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyString")); + + // Deserialization + e = assertThrows(JsonParseException.class, () -> gson.fromJson("{\"id\": 0}", TestClassWithRequiredAdvanced.class)); + assertThat(e.getMessage(), equalToIgnoringCase("Required field 'id' failed validation in TestClassWithRequiredAdvanced using predicate IntegerGreaterThanZero")); + + e = assertThrows(JsonParseException.class, () -> gson.fromJson("{\"id\": 1}", TestClassWithRequiredAdvanced.class)); + assertThat(e.getMessage(), equalToIgnoringCase("Required field 'name' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyString")); + + e = assertThrows(JsonParseException.class, () -> gson.fromJson("{\"id\": 1, \"name\": ''}", TestClassWithRequiredAdvanced.class)); + assertThat(e.getMessage(), equalToIgnoringCase("Required field 'name' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyString")); } @Data From df4cda2a28cafff204e72ac2aaac0dc1da5649be Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Tue, 24 Feb 2026 17:24:29 -0500 Subject: [PATCH 07/12] cache FieldPredicate instances upfront --- .../api/util/json/RequiredAdapterFactory.java | 72 +++++++++++++++---- 1 file changed, 57 insertions(+), 15 deletions(-) diff --git a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java index c77a258e4..cb63ea38b 100644 --- a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java +++ b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java @@ -9,9 +9,14 @@ import com.google.gson.stream.JsonWriter; import com.slack.api.model.annotation.FieldPredicate; import com.slack.api.model.annotation.Required; +import lombok.EqualsAndHashCode; +import lombok.RequiredArgsConstructor; +import java.lang.reflect.Field; import java.lang.reflect.InvocationTargetException; -import java.util.Arrays; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; import java.io.IOException; /** @@ -26,12 +31,17 @@ public class RequiredAdapterFactory implements TypeAdapterFactory { @Override public TypeAdapter create(Gson gson, TypeToken type) { TypeAdapter delegate = gson.getDelegateAdapter(this, type); + List entries = buildRequiredFieldEntries(type.getRawType()); + + if (entries.isEmpty()) { + return delegate; + } return new TypeAdapter() { @Override public void write(JsonWriter out, T value) throws IOException { if (value != null) { - ensureFieldValidity(value); + ensureFieldValidity(value, entries); } delegate.write(out, value); } @@ -43,27 +53,59 @@ public T read(JsonReader in) throws IOException { return null; } - ensureFieldValidity(result); + ensureFieldValidity(result, entries); return result; } }; } - private void ensureFieldValidity(T obj) { - Arrays.asList(obj.getClass().getDeclaredFields()).forEach(field -> { - if (field.isAnnotationPresent(Required.class)) { + /** + * Scans the given class for fields annotated with {@link Required}, pre-resolves each field's + * accessibility and {@link FieldPredicate} instance, and returns an immutable list of entries. + * This is called once per type during Gson adapter creation. + */ + private List buildRequiredFieldEntries(Class clazz) { + List entries = new ArrayList<>(); + for (Field field : clazz.getDeclaredFields()) { + Required annotation = field.getAnnotation(Required.class); + if (annotation != null) { field.setAccessible(true); try { - FieldPredicate predicate = field.getAnnotation(Required.class).validator().getDeclaredConstructor().newInstance(); - if (!predicate.test(field.get(obj))) { - throw new JsonParseException("Required field '" + field.getName() + "' failed validation in " - + obj.getClass().getSimpleName() + " using predicate " + predicate.getClass().getSimpleName()); - } - } catch (NoSuchMethodException | InstantiationException | IllegalAccessException | - InvocationTargetException e) { - throw new JsonParseException("Cannot parse field: " + field.getName(), e); + FieldPredicate predicate = annotation.validator().getDeclaredConstructor().newInstance(); + entries.add(new RequiredFieldEntry(field, predicate)); + } catch (NoSuchMethodException | InstantiationException | + IllegalAccessException | InvocationTargetException e) { + throw new JsonParseException( + "Cannot instantiate validator for field: " + field.getName(), e); } } - }); + } + return Collections.unmodifiableList(entries); + } + + private void ensureFieldValidity(T obj, List entries) { + for (RequiredFieldEntry entry : entries) { + try { + Object value = entry.field.get(obj); + if (!entry.predicate.test(value)) { + throw new JsonParseException("Required field '" + entry.field.getName() + + "' failed validation in " + obj.getClass().getSimpleName() + + " using predicate " + entry.predicate.getClass().getSimpleName()); + } + } catch (IllegalAccessException e) { + throw new JsonParseException( + "Cannot access field: " + entry.field.getName(), e); + } + } + } + + /** + * Class holding the accessible {@link Field} handle and the cached instance of {@link FieldPredicate}. + */ + @RequiredArgsConstructor + @EqualsAndHashCode + private static class RequiredFieldEntry { + final Field field; + final FieldPredicate predicate; } } From f40b893545c24113b14b14d9bf49092e0933d01f Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Wed, 25 Feb 2026 16:54:04 -0500 Subject: [PATCH 08/12] address comments --- .../main/java/com/slack/api/SlackConfig.java | 4 +- .../com/slack/api/util/json/GsonFactory.java | 100 ++++++++++-------- slack-api-model/pom.xml | 12 +++ .../api/model/annotation/FieldPredicate.java | 5 - .../annotation/IsNotNullFieldPredicate.java | 10 -- .../slack/api/model/annotation/Required.java | 6 +- .../api/model/predicate/FieldPredicate.java | 11 ++ .../predicate/IsNotNullFieldPredicate.java | 10 ++ ...uiredPropertyDetectionAdapterFactory.java} | 6 +- .../test_locally/util/JSONUtilityTest.java | 90 ++++++++++++++-- 10 files changed, 182 insertions(+), 72 deletions(-) delete mode 100644 slack-api-model/src/main/java/com/slack/api/model/annotation/FieldPredicate.java delete mode 100644 slack-api-model/src/main/java/com/slack/api/model/annotation/IsNotNullFieldPredicate.java create mode 100644 slack-api-model/src/main/java/com/slack/api/model/predicate/FieldPredicate.java create mode 100644 slack-api-model/src/main/java/com/slack/api/model/predicate/IsNotNullFieldPredicate.java rename slack-api-model/src/main/java/com/slack/api/util/json/{RequiredAdapterFactory.java => RequiredPropertyDetectionAdapterFactory.java} (95%) diff --git a/slack-api-client/src/main/java/com/slack/api/SlackConfig.java b/slack-api-client/src/main/java/com/slack/api/SlackConfig.java index 1c72260c7..ac2a6329e 100644 --- a/slack-api-client/src/main/java/com/slack/api/SlackConfig.java +++ b/slack-api-client/src/main/java/com/slack/api/SlackConfig.java @@ -252,9 +252,7 @@ public void setLibraryMaintainerMode(boolean libraryMaintainerMode) { private boolean failOnUnknownProperties = false; /** - * Makes it so that any fields annotated with {@link com.slack.api.model.annotation.Required} that are missing - * or invalid when deserializing responses from the Slack Web API client will throw an exception. - * By default, this is "off", but can be opted into by setting to true. + * If you would like to detect required properties by throwing exceptions, set this flag as true. */ private boolean failOnRequiredProperties = false; diff --git a/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java b/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java index 595b8d83b..44ee97009 100644 --- a/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java +++ b/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java @@ -30,9 +30,8 @@ private GsonFactory() { * Most of the Slack APIs' key naming is snake-cased. */ public static Gson createSnakeCase() { - GsonBuilder gsonBuilder = new GsonBuilder() - .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES); - registerTypeAdapters(gsonBuilder, false, false); + GsonBuilder gsonBuilder = getSnakeCaseBuilder(); + configureBuilder(gsonBuilder); return gsonBuilder.create(); } @@ -40,17 +39,8 @@ public static Gson createSnakeCase() { * Most of the Slack APIs' key naming is snake-cased. */ public static Gson createSnakeCase(SlackConfig config) { - boolean failOnUnknownProps = config.isFailOnUnknownProperties(); - boolean failOnRequiredProperties = config.isFailOnRequiredProperties(); - GsonBuilder gsonBuilder = new GsonBuilder() - .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES); - registerTypeAdapters(gsonBuilder, failOnUnknownProps, failOnRequiredProperties); - if (failOnUnknownProps || config.isLibraryMaintainerMode()) { - gsonBuilder = gsonBuilder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()); - } - if (config.isPrettyResponseLoggingEnabled()) { - gsonBuilder = gsonBuilder.setPrettyPrinting(); - } + GsonBuilder gsonBuilder = getSnakeCaseBuilder(); + configureBuilder(gsonBuilder, config); return gsonBuilder.create(); } @@ -58,39 +48,65 @@ public static Gson createSnakeCase(SlackConfig config) { * Mainly used for SCIM APIs. */ public static Gson createCamelCase(SlackConfig config) { - boolean failOnUnknownProps = config.isFailOnUnknownProperties(); - boolean failOnRequiredProperties = config.isFailOnRequiredProperties(); GsonBuilder gsonBuilder = new GsonBuilder(); - registerTypeAdapters(gsonBuilder, failOnUnknownProps, failOnRequiredProperties); - if (failOnUnknownProps || config.isLibraryMaintainerMode()) { - gsonBuilder = gsonBuilder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()); - } - if (config.isPrettyResponseLoggingEnabled()) { - gsonBuilder = gsonBuilder.setPrettyPrinting(); - } + configureBuilder(gsonBuilder, config); return gsonBuilder.create(); } - public static void registerTypeAdapters(GsonBuilder builder, boolean failOnUnknownProps, boolean failOnRequiredProperties) { - builder - .registerTypeAdapter(Instant.class, new JavaTimeInstantFactory(failOnUnknownProps)) - .registerTypeAdapter(File.class, new GsonFileFactory(failOnUnknownProps)) - .registerTypeAdapter(LayoutBlock.class, new GsonLayoutBlockFactory(failOnUnknownProps)) - .registerTypeAdapter(TextObject.class, new GsonTextObjectFactory(failOnUnknownProps)) - .registerTypeAdapter(ContextBlockElement.class, new GsonContextBlockElementFactory(failOnUnknownProps)) - .registerTypeAdapter(ContextActionsBlockElement.class, new GsonContextActionsBlockElementFactory(failOnUnknownProps)) - .registerTypeAdapter(BlockElement.class, new GsonBlockElementFactory(failOnUnknownProps)) - .registerTypeAdapter(RichTextElement.class, new GsonRichTextElementFactory(failOnUnknownProps)) - .registerTypeAdapter(FunctionExecutedEvent.InputValue.class, new GsonFunctionExecutedEventInputValueFactory()) - .registerTypeAdapter(Attachment.VideoHtml.class, new GsonMessageAttachmentVideoHtmlFactory(failOnUnknownProps)) - .registerTypeAdapter(MessageChangedEvent.PreviousMessage.class, new GsonMessageChangedEventPreviousMessageFactory(failOnUnknownProps)) - .registerTypeAdapter(AppWorkflow.StepInputValue.class, new GsonAppWorkflowStepInputValueFactory(failOnUnknownProps)) - .registerTypeAdapter(AppWorkflow.StepInputValueElementDefault.class, new GsonAppWorkflowStepInputValueDefaultFactory(failOnUnknownProps)) - .registerTypeAdapter(LogsResponse.DetailsChangedValue.class, new GsonAuditLogsDetailsChangedValueFactory(failOnUnknownProps)) - .registerTypeAdapter(LogsResponse.UserIDs.class, new GsonAuditLogsDetailsUserIDsFactory(failOnUnknownProps)); + private static GsonBuilder getSnakeCaseBuilder() { + return new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES); + } + + private static void configureBuilder(GsonBuilder builder) { + configureBuilder(builder, false, false, false, false); + } - if (failOnRequiredProperties) { - builder.registerTypeAdapterFactory(new RequiredAdapterFactory()); + private static void configureBuilder(GsonBuilder builder, SlackConfig config) { + configureBuilder( + builder, + config.isFailOnUnknownProperties(), + config.isFailOnRequiredProperties(), + config.isPrettyResponseLoggingEnabled(), + config.isLibraryMaintainerMode() + ); + } + + private static void configureBuilder( + GsonBuilder builder, + boolean failOnUnknownProps, + boolean failOnRequiredProps, + boolean isPrettyResponseLoggingEnabled, + boolean isLibraryMaintainerMode + ) { + if (failOnUnknownProps || isLibraryMaintainerMode) { + builder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()); + } + if (failOnRequiredProps) { + builder.registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()); + } + if (isPrettyResponseLoggingEnabled) { + builder.setPrettyPrinting(); } + + registerTypeAdapters(builder, failOnUnknownProps); + } + + public static void registerTypeAdapters(GsonBuilder builder, boolean failOnUnknownProps) { + builder + .registerTypeAdapter(Instant.class, new JavaTimeInstantFactory(failOnUnknownProps)) + .registerTypeAdapter(File.class, new GsonFileFactory(failOnUnknownProps)) + .registerTypeAdapter(LayoutBlock.class, new GsonLayoutBlockFactory(failOnUnknownProps)) + .registerTypeAdapter(TextObject.class, new GsonTextObjectFactory(failOnUnknownProps)) + .registerTypeAdapter(ContextBlockElement.class, new GsonContextBlockElementFactory(failOnUnknownProps)) + .registerTypeAdapter(ContextActionsBlockElement.class, new GsonContextActionsBlockElementFactory(failOnUnknownProps)) + .registerTypeAdapter(BlockElement.class, new GsonBlockElementFactory(failOnUnknownProps)) + .registerTypeAdapter(RichTextElement.class, new GsonRichTextElementFactory(failOnUnknownProps)) + .registerTypeAdapter(FunctionExecutedEvent.InputValue.class, new GsonFunctionExecutedEventInputValueFactory()) + .registerTypeAdapter(Attachment.VideoHtml.class, new GsonMessageAttachmentVideoHtmlFactory(failOnUnknownProps)) + .registerTypeAdapter(MessageChangedEvent.PreviousMessage.class, new GsonMessageChangedEventPreviousMessageFactory(failOnUnknownProps)) + .registerTypeAdapter(AppWorkflow.StepInputValue.class, new GsonAppWorkflowStepInputValueFactory(failOnUnknownProps)) + .registerTypeAdapter(AppWorkflow.StepInputValueElementDefault.class, new GsonAppWorkflowStepInputValueDefaultFactory(failOnUnknownProps)) + .registerTypeAdapter(LogsResponse.DetailsChangedValue.class, new GsonAuditLogsDetailsChangedValueFactory(failOnUnknownProps)) + .registerTypeAdapter(LogsResponse.UserIDs.class, new GsonAuditLogsDetailsUserIDsFactory(failOnUnknownProps)); } } diff --git a/slack-api-model/pom.xml b/slack-api-model/pom.xml index 5c5a51342..5a4eab54f 100644 --- a/slack-api-model/pom.xml +++ b/slack-api-model/pom.xml @@ -24,5 +24,17 @@ ${gson.version} + + + + org.apache.maven.plugins + maven-compiler-plugin + + 9 + 9 + + + + diff --git a/slack-api-model/src/main/java/com/slack/api/model/annotation/FieldPredicate.java b/slack-api-model/src/main/java/com/slack/api/model/annotation/FieldPredicate.java deleted file mode 100644 index d6d7b29cc..000000000 --- a/slack-api-model/src/main/java/com/slack/api/model/annotation/FieldPredicate.java +++ /dev/null @@ -1,5 +0,0 @@ -package com.slack.api.model.annotation; - -public interface FieldPredicate { - boolean test(Object obj); -} diff --git a/slack-api-model/src/main/java/com/slack/api/model/annotation/IsNotNullFieldPredicate.java b/slack-api-model/src/main/java/com/slack/api/model/annotation/IsNotNullFieldPredicate.java deleted file mode 100644 index 90e638701..000000000 --- a/slack-api-model/src/main/java/com/slack/api/model/annotation/IsNotNullFieldPredicate.java +++ /dev/null @@ -1,10 +0,0 @@ -package com.slack.api.model.annotation; - -import java.util.Objects; - -public class IsNotNullFieldPredicate implements FieldPredicate { - @Override - public boolean test(Object obj) { - return !Objects.isNull(obj); - } -} diff --git a/slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java b/slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java index d741490c9..795c30d79 100644 --- a/slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java +++ b/slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java @@ -1,5 +1,9 @@ package com.slack.api.model.annotation; +import com.slack.api.model.predicate.FieldPredicate; +import com.slack.api.model.predicate.IsNotNullFieldPredicate; +import com.slack.api.util.json.RequiredPropertyDetectionAdapterFactory; + import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @@ -9,7 +13,7 @@ * Field-level annotation indicating whether the field is a "required" field or not on the model object. *

* The enforcement of the field's presence in instantiated instances of the model object is accomplished using the - * {@link com.slack.api.util.json.RequiredAdapterFactory} which ensures all fields marked with {@link Required} are + * {@link RequiredPropertyDetectionAdapterFactory} which ensures all fields marked with {@link Required} are * present during the object deserialization (or serialization) process. Note that the enforcement of this annotation * is opt-in and defaults to "off". */ diff --git a/slack-api-model/src/main/java/com/slack/api/model/predicate/FieldPredicate.java b/slack-api-model/src/main/java/com/slack/api/model/predicate/FieldPredicate.java new file mode 100644 index 000000000..58cc287e0 --- /dev/null +++ b/slack-api-model/src/main/java/com/slack/api/model/predicate/FieldPredicate.java @@ -0,0 +1,11 @@ +package com.slack.api.model.predicate; + +/** + * A functional interface for defining validation predicates against {@link java.lang.reflect.Field}. Used by + * {@link com.slack.api.model.annotation.Required} during object serialization and deserialization to ensure the + * field member is "valid" per the defined predicate. + */ +@FunctionalInterface +public interface FieldPredicate { + boolean validate(Object obj); +} diff --git a/slack-api-model/src/main/java/com/slack/api/model/predicate/IsNotNullFieldPredicate.java b/slack-api-model/src/main/java/com/slack/api/model/predicate/IsNotNullFieldPredicate.java new file mode 100644 index 000000000..53d948c4a --- /dev/null +++ b/slack-api-model/src/main/java/com/slack/api/model/predicate/IsNotNullFieldPredicate.java @@ -0,0 +1,10 @@ +package com.slack.api.model.predicate; + +import java.util.Objects; + +public class IsNotNullFieldPredicate implements FieldPredicate { + @Override + public boolean validate(Object obj) { + return Objects.nonNull(obj); + } +} diff --git a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredPropertyDetectionAdapterFactory.java similarity index 95% rename from slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java rename to slack-api-model/src/main/java/com/slack/api/util/json/RequiredPropertyDetectionAdapterFactory.java index cb63ea38b..4e94f71bb 100644 --- a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java +++ b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredPropertyDetectionAdapterFactory.java @@ -7,7 +7,7 @@ import com.google.gson.reflect.TypeToken; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; -import com.slack.api.model.annotation.FieldPredicate; +import com.slack.api.model.predicate.FieldPredicate; import com.slack.api.model.annotation.Required; import lombok.EqualsAndHashCode; import lombok.RequiredArgsConstructor; @@ -27,7 +27,7 @@ *

* Note that this adapter handles both deserialization (JSON --> POJO) and serialization (POJO --> JSON). */ -public class RequiredAdapterFactory implements TypeAdapterFactory { +public class RequiredPropertyDetectionAdapterFactory implements TypeAdapterFactory { @Override public TypeAdapter create(Gson gson, TypeToken type) { TypeAdapter delegate = gson.getDelegateAdapter(this, type); @@ -87,7 +87,7 @@ private void ensureFieldValidity(T obj, List entries) { for (RequiredFieldEntry entry : entries) { try { Object value = entry.field.get(obj); - if (!entry.predicate.test(value)) { + if (!entry.predicate.validate(value)) { throw new JsonParseException("Required field '" + entry.field.getName() + "' failed validation in " + obj.getClass().getSimpleName() + " using predicate " + entry.predicate.getClass().getSimpleName()); diff --git a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java index 088a319f3..255598239 100644 --- a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java +++ b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java @@ -1,7 +1,7 @@ package test_locally.util; import com.google.gson.*; -import com.slack.api.model.annotation.FieldPredicate; +import com.slack.api.model.predicate.FieldPredicate; import com.slack.api.model.block.ContextBlockElement; import com.slack.api.model.block.DividerBlock; import com.slack.api.model.block.LayoutBlock; @@ -17,11 +17,13 @@ import lombok.Builder; import lombok.Data; import org.junit.Test; -import org.junit.runners.model.TestClass; import test_locally.unit.GsonFactory; import java.lang.reflect.Type; import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.function.Predicate; import static com.slack.api.model.block.composition.BlockCompositions.markdownText; import static com.slack.api.model.block.composition.BlockCompositions.plainText; @@ -30,6 +32,7 @@ import static org.hamcrest.CoreMatchers.is; import static org.hamcrest.Matchers.equalToIgnoringCase; import static org.hamcrest.MatcherAssert.assertThat; +import static org.junit.Assert.assertNull; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertThrows; @@ -162,9 +165,9 @@ public void testGsonFunctionExecutedEventInputValueFactory() { } @Test - public void testRequiredAdapterFactory_basicCase() { + public void testRequiredPropertyDetectionAdapterFactory_basicCase_failureCases() { Gson gson = GsonFactory.getBuilder(true, true) - .registerTypeAdapterFactory(new RequiredAdapterFactory()).create(); + .registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()).create(); // Serialization TestClassWithRequiredBasic instance = TestClassWithRequiredBasic.builder().build(); @@ -176,8 +179,30 @@ public void testRequiredAdapterFactory_basicCase() { } @Test - public void testRequiredAdapterFactory_advancedCase() { - Gson gson = GsonFactory.getBuilder(true, true).registerTypeAdapterFactory(new RequiredAdapterFactory()).create(); + public void testRequiredPropertyDetectionAdapterFactory_basicCase_happyPath() { + Gson gson = GsonFactory.getBuilder(true, true).registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()).create(); + TestClassWithRequiredBasic instanceNoName = TestClassWithRequiredBasic.builder().id(1).build(); + TestClassWithRequiredBasic instanceWithName = TestClassWithRequiredBasic.builder().id(1).name("Hello").build(); + + // Serialization + assertThat(gson.toJson(instanceNoName), is("{\"id\":1}")); + assertThat(gson.toJson(instanceWithName), is("{\"id\":1,\"name\":\"Hello\"}")); + + // Deserialization + String json = "{\"id\": 1}"; + TestClassWithRequiredBasic instance = gson.fromJson(json, TestClassWithRequiredBasic.class); + assertThat(instance.getId(), is(1)); + assertNull(instance.getName()); + + json = "{\"id\": 1, \"name\": \"Hello\"}"; + instance = gson.fromJson(json, TestClassWithRequiredBasic.class); + assertThat(instance.getId(), is(1)); + assertThat(instance.getName(), is("Hello")); + } + + @Test + public void testRequiredPropertyDetectionAdapterFactory_advancedCase_failureCases() { + Gson gson = GsonFactory.getBuilder(true, true).registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()).create(); // Serialization JsonParseException e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().build())); @@ -185,9 +210,16 @@ public void testRequiredAdapterFactory_advancedCase() { e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().id(1).build())); assertThat(e.getMessage(), equalToIgnoringCase("Required field 'name' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyString")); + e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().id(1).name("").build())); assertThat(e.getMessage(), equalToIgnoringCase("Required field 'name' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyString")); + e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().id(1).name("Hello").build())); + assertThat(e.getMessage(), equalToIgnoringCase("Required field 'users' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyCollection")); + + e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().id(1).name("Hello").users(List.of("user1")).build())); + assertThat(e.getMessage(), equalToIgnoringCase("Required field 'myBool' failed validation in TestClassWithRequiredAdvanced using predicate isNotNullFieldPredicate")); + // Deserialization e = assertThrows(JsonParseException.class, () -> gson.fromJson("{\"id\": 0}", TestClassWithRequiredAdvanced.class)); assertThat(e.getMessage(), equalToIgnoringCase("Required field 'id' failed validation in TestClassWithRequiredAdvanced using predicate IntegerGreaterThanZero")); @@ -197,6 +229,35 @@ public void testRequiredAdapterFactory_advancedCase() { e = assertThrows(JsonParseException.class, () -> gson.fromJson("{\"id\": 1, \"name\": ''}", TestClassWithRequiredAdvanced.class)); assertThat(e.getMessage(), equalToIgnoringCase("Required field 'name' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyString")); + + e = assertThrows(JsonParseException.class, () -> gson.fromJson("{\"id\":1,\"name\":\"test\",\"users\":[]}", TestClassWithRequiredAdvanced.class)); + assertThat(e.getMessage(), equalToIgnoringCase("Required field 'users' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyCollection")); + + e = assertThrows(JsonParseException.class, () -> gson.fromJson("{\"id\":1,\"name\":\"test\",\"users\":[\"hello\"]}", TestClassWithRequiredAdvanced.class)); + assertThat(e.getMessage(), equalToIgnoringCase("Required field 'myBool' failed validation in TestClassWithRequiredAdvanced using predicate isNotNullFieldPredicate")); + } + + @Test + public void testRequiredPropertyDetectionAdapterFactory_advancedCase_happyPath() { + Gson gson = GsonFactory.getBuilder(true, true).registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()).create(); + TestClassWithRequiredAdvanced instance = TestClassWithRequiredAdvanced.builder() + .id(1) + .name("test") + .users(List.of("testUser")) + .myBool(true) + .build(); + + // Serialization + assertThat(gson.toJson(instance), is("{\"id\":1,\"name\":\"test\",\"users\":[\"testUser\"],\"my_bool\":true}")); + + // Deserialization + String json = "{\"id\":1,\"name\":\"test\",\"users\":[\"testUser\"],\"my_bool\":true}"; + instance = gson.fromJson(json, TestClassWithRequiredAdvanced.class); + assertThat(instance.getId(), is(1)); + assertThat(instance.getName(), is("test")); + assertThat(instance.getUsers().get(0), is("testUser")); + assertThat(instance.getMyBool(), is(true)); + assertNull(instance.getCanBeNull()); } @Data @@ -213,19 +274,32 @@ private static class TestClassWithRequiredAdvanced { private int id; @Required(validator = NonEmptyString.class) private String name; + @Required(validator = NonEmptyCollection.class) + private List users; + @Required + Boolean myBool; + private String canBeNull; public static class IntegerGreaterThanZero implements FieldPredicate { @Override - public boolean test(Object obj) { + public boolean validate(Object obj) { return obj instanceof Integer && (int)obj > 0; } } public static class NonEmptyString implements FieldPredicate { @Override - public boolean test(Object obj) { + public boolean validate(Object obj) { return obj instanceof String && !((String) obj).isEmpty(); } } + + public static class NonEmptyCollection implements FieldPredicate { + @Override + public boolean validate(Object obj) { + Predicate> isNotEmpty = collection -> !collection.isEmpty(); + return obj instanceof Collection && isNotEmpty.test((Collection) obj); + } + } } } From d4ca333f095d17de8aa2d8d0cd8917aa12c78897 Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Wed, 25 Feb 2026 16:59:53 -0500 Subject: [PATCH 09/12] oops --- slack-api-model/pom.xml | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/slack-api-model/pom.xml b/slack-api-model/pom.xml index 5a4eab54f..5c5a51342 100644 --- a/slack-api-model/pom.xml +++ b/slack-api-model/pom.xml @@ -24,17 +24,5 @@ ${gson.version} - - - - org.apache.maven.plugins - maven-compiler-plugin - - 9 - 9 - - - - From 4339fc257e4bf44660ae95642c2345f3c18f0f30 Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Thu, 26 Feb 2026 11:01:40 -0500 Subject: [PATCH 10/12] addressing more comments --- .../com/slack/api/util/json/GsonFactory.java | 96 ++++++++----------- .../java/test_locally/unit/GsonFactory.java | 21 +++- .../test_locally/util/JSONUtilityTest.java | 9 +- 3 files changed, 62 insertions(+), 64 deletions(-) diff --git a/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java b/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java index 44ee97009..3bd6c9c7a 100644 --- a/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java +++ b/slack-api-client/src/main/java/com/slack/api/util/json/GsonFactory.java @@ -30,8 +30,9 @@ private GsonFactory() { * Most of the Slack APIs' key naming is snake-cased. */ public static Gson createSnakeCase() { - GsonBuilder gsonBuilder = getSnakeCaseBuilder(); - configureBuilder(gsonBuilder); + GsonBuilder gsonBuilder = new GsonBuilder() + .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES); + registerTypeAdapters(gsonBuilder, false); return gsonBuilder.create(); } @@ -39,8 +40,21 @@ public static Gson createSnakeCase() { * Most of the Slack APIs' key naming is snake-cased. */ public static Gson createSnakeCase(SlackConfig config) { - GsonBuilder gsonBuilder = getSnakeCaseBuilder(); - configureBuilder(gsonBuilder, config); + boolean failOnUnknownProps = config.isFailOnUnknownProperties(); + GsonBuilder gsonBuilder = new GsonBuilder() + .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES); + registerTypeAdapters(gsonBuilder, failOnUnknownProps); + + if (failOnUnknownProps || config.isLibraryMaintainerMode()) { + gsonBuilder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()); + } + if (config.isFailOnRequiredProperties()) { + gsonBuilder.registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()); + } + if (config.isPrettyResponseLoggingEnabled()) { + gsonBuilder.setPrettyPrinting(); + } + return gsonBuilder.create(); } @@ -48,65 +62,39 @@ public static Gson createSnakeCase(SlackConfig config) { * Mainly used for SCIM APIs. */ public static Gson createCamelCase(SlackConfig config) { + boolean failOnUnknownProps = config.isFailOnUnknownProperties(); GsonBuilder gsonBuilder = new GsonBuilder(); - configureBuilder(gsonBuilder, config); - return gsonBuilder.create(); - } + registerTypeAdapters(gsonBuilder, failOnUnknownProps); - private static GsonBuilder getSnakeCaseBuilder() { - return new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES); - } - - private static void configureBuilder(GsonBuilder builder) { - configureBuilder(builder, false, false, false, false); - } - - private static void configureBuilder(GsonBuilder builder, SlackConfig config) { - configureBuilder( - builder, - config.isFailOnUnknownProperties(), - config.isFailOnRequiredProperties(), - config.isPrettyResponseLoggingEnabled(), - config.isLibraryMaintainerMode() - ); - } - - private static void configureBuilder( - GsonBuilder builder, - boolean failOnUnknownProps, - boolean failOnRequiredProps, - boolean isPrettyResponseLoggingEnabled, - boolean isLibraryMaintainerMode - ) { - if (failOnUnknownProps || isLibraryMaintainerMode) { - builder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()); + if (failOnUnknownProps || config.isLibraryMaintainerMode()) { + gsonBuilder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()); } - if (failOnRequiredProps) { - builder.registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()); + if (config.isFailOnRequiredProperties()) { + gsonBuilder.registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()); } - if (isPrettyResponseLoggingEnabled) { - builder.setPrettyPrinting(); + if (config.isPrettyResponseLoggingEnabled()) { + gsonBuilder.setPrettyPrinting(); } - registerTypeAdapters(builder, failOnUnknownProps); + return gsonBuilder.create(); } public static void registerTypeAdapters(GsonBuilder builder, boolean failOnUnknownProps) { builder - .registerTypeAdapter(Instant.class, new JavaTimeInstantFactory(failOnUnknownProps)) - .registerTypeAdapter(File.class, new GsonFileFactory(failOnUnknownProps)) - .registerTypeAdapter(LayoutBlock.class, new GsonLayoutBlockFactory(failOnUnknownProps)) - .registerTypeAdapter(TextObject.class, new GsonTextObjectFactory(failOnUnknownProps)) - .registerTypeAdapter(ContextBlockElement.class, new GsonContextBlockElementFactory(failOnUnknownProps)) - .registerTypeAdapter(ContextActionsBlockElement.class, new GsonContextActionsBlockElementFactory(failOnUnknownProps)) - .registerTypeAdapter(BlockElement.class, new GsonBlockElementFactory(failOnUnknownProps)) - .registerTypeAdapter(RichTextElement.class, new GsonRichTextElementFactory(failOnUnknownProps)) - .registerTypeAdapter(FunctionExecutedEvent.InputValue.class, new GsonFunctionExecutedEventInputValueFactory()) - .registerTypeAdapter(Attachment.VideoHtml.class, new GsonMessageAttachmentVideoHtmlFactory(failOnUnknownProps)) - .registerTypeAdapter(MessageChangedEvent.PreviousMessage.class, new GsonMessageChangedEventPreviousMessageFactory(failOnUnknownProps)) - .registerTypeAdapter(AppWorkflow.StepInputValue.class, new GsonAppWorkflowStepInputValueFactory(failOnUnknownProps)) - .registerTypeAdapter(AppWorkflow.StepInputValueElementDefault.class, new GsonAppWorkflowStepInputValueDefaultFactory(failOnUnknownProps)) - .registerTypeAdapter(LogsResponse.DetailsChangedValue.class, new GsonAuditLogsDetailsChangedValueFactory(failOnUnknownProps)) - .registerTypeAdapter(LogsResponse.UserIDs.class, new GsonAuditLogsDetailsUserIDsFactory(failOnUnknownProps)); + .registerTypeAdapter(Instant.class, new JavaTimeInstantFactory(failOnUnknownProps)) + .registerTypeAdapter(File.class, new GsonFileFactory(failOnUnknownProps)) + .registerTypeAdapter(LayoutBlock.class, new GsonLayoutBlockFactory(failOnUnknownProps)) + .registerTypeAdapter(TextObject.class, new GsonTextObjectFactory(failOnUnknownProps)) + .registerTypeAdapter(ContextBlockElement.class, new GsonContextBlockElementFactory(failOnUnknownProps)) + .registerTypeAdapter(ContextActionsBlockElement.class, new GsonContextActionsBlockElementFactory(failOnUnknownProps)) + .registerTypeAdapter(BlockElement.class, new GsonBlockElementFactory(failOnUnknownProps)) + .registerTypeAdapter(RichTextElement.class, new GsonRichTextElementFactory(failOnUnknownProps)) + .registerTypeAdapter(FunctionExecutedEvent.InputValue.class, new GsonFunctionExecutedEventInputValueFactory()) + .registerTypeAdapter(Attachment.VideoHtml.class, new GsonMessageAttachmentVideoHtmlFactory(failOnUnknownProps)) + .registerTypeAdapter(MessageChangedEvent.PreviousMessage.class, new GsonMessageChangedEventPreviousMessageFactory(failOnUnknownProps)) + .registerTypeAdapter(AppWorkflow.StepInputValue.class, new GsonAppWorkflowStepInputValueFactory(failOnUnknownProps)) + .registerTypeAdapter(AppWorkflow.StepInputValueElementDefault.class, new GsonAppWorkflowStepInputValueDefaultFactory(failOnUnknownProps)) + .registerTypeAdapter(LogsResponse.DetailsChangedValue.class, new GsonAuditLogsDetailsChangedValueFactory(failOnUnknownProps)) + .registerTypeAdapter(LogsResponse.UserIDs.class, new GsonAuditLogsDetailsUserIDsFactory(failOnUnknownProps)); } } diff --git a/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java b/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java index 4138c5b0e..8e797da0f 100644 --- a/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java +++ b/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java @@ -20,18 +20,26 @@ private GsonFactory() { } public static Gson createSnakeCase() { - return createSnakeCase(false, true); + return createSnakeCase(false, true, false); } public static Gson createSnakeCaseWithoutUnknownPropertyDetection(boolean failOnUnknownProperties) { - return createSnakeCase(failOnUnknownProperties, false); + return createSnakeCase(failOnUnknownProperties, false, false); + } + + public static Gson createSnakeCaseWithRequiredPropertyDetection() { + return createSnakeCase(false, true, true); } public static Gson createSnakeCase(boolean failOnUnknownProperties, boolean unknownPropertyDetection) { - return getBuilder(failOnUnknownProperties, unknownPropertyDetection).create(); + return createSnakeCase(failOnUnknownProperties, unknownPropertyDetection, false); } - public static GsonBuilder getBuilder(boolean failOnUnknownProperties, boolean unknownPropertyDetection) { + public static Gson createSnakeCase( + boolean failOnUnknownProperties, + boolean unknownPropertyDetection, + boolean failOnRequiredProperties + ) { GsonBuilder builder = new GsonBuilder() .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES) .registerTypeAdapter(File.class, new GsonFileFactory(failOnUnknownProperties)) @@ -51,7 +59,10 @@ public static GsonBuilder getBuilder(boolean failOnUnknownProperties, boolean un if (unknownPropertyDetection) { builder.registerTypeAdapterFactory(new UnknownPropertyDetectionAdapterFactory()); } + if (failOnRequiredProperties) { + builder.registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()); + } - return builder; + return builder.create(); } } diff --git a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java index 255598239..ed5eb2946 100644 --- a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java +++ b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java @@ -166,8 +166,7 @@ public void testGsonFunctionExecutedEventInputValueFactory() { @Test public void testRequiredPropertyDetectionAdapterFactory_basicCase_failureCases() { - Gson gson = GsonFactory.getBuilder(true, true) - .registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()).create(); + Gson gson = GsonFactory.createSnakeCaseWithRequiredPropertyDetection(); // Serialization TestClassWithRequiredBasic instance = TestClassWithRequiredBasic.builder().build(); @@ -180,7 +179,7 @@ public void testRequiredPropertyDetectionAdapterFactory_basicCase_failureCases() @Test public void testRequiredPropertyDetectionAdapterFactory_basicCase_happyPath() { - Gson gson = GsonFactory.getBuilder(true, true).registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()).create(); + Gson gson = GsonFactory.createSnakeCaseWithRequiredPropertyDetection(); TestClassWithRequiredBasic instanceNoName = TestClassWithRequiredBasic.builder().id(1).build(); TestClassWithRequiredBasic instanceWithName = TestClassWithRequiredBasic.builder().id(1).name("Hello").build(); @@ -202,7 +201,7 @@ public void testRequiredPropertyDetectionAdapterFactory_basicCase_happyPath() { @Test public void testRequiredPropertyDetectionAdapterFactory_advancedCase_failureCases() { - Gson gson = GsonFactory.getBuilder(true, true).registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()).create(); + Gson gson = GsonFactory.createSnakeCaseWithRequiredPropertyDetection(); // Serialization JsonParseException e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().build())); @@ -239,7 +238,7 @@ public void testRequiredPropertyDetectionAdapterFactory_advancedCase_failureCase @Test public void testRequiredPropertyDetectionAdapterFactory_advancedCase_happyPath() { - Gson gson = GsonFactory.getBuilder(true, true).registerTypeAdapterFactory(new RequiredPropertyDetectionAdapterFactory()).create(); + Gson gson = GsonFactory.createSnakeCaseWithRequiredPropertyDetection(); TestClassWithRequiredAdvanced instance = TestClassWithRequiredAdvanced.builder() .id(1) .name("test") From 60de10b45c8ca365f46f04ed77caf02a08221d31 Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Thu, 26 Feb 2026 11:04:32 -0500 Subject: [PATCH 11/12] update --- .../src/test/java/test_locally/unit/GsonFactory.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java b/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java index 8e797da0f..9f6591b02 100644 --- a/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java +++ b/slack-api-model/src/test/java/test_locally/unit/GsonFactory.java @@ -20,11 +20,11 @@ private GsonFactory() { } public static Gson createSnakeCase() { - return createSnakeCase(false, true, false); + return createSnakeCase(false, true); } public static Gson createSnakeCaseWithoutUnknownPropertyDetection(boolean failOnUnknownProperties) { - return createSnakeCase(failOnUnknownProperties, false, false); + return createSnakeCase(failOnUnknownProperties, false); } public static Gson createSnakeCaseWithRequiredPropertyDetection() { From e8ca2142bcb0823892430cb73d0fb63e5cf10075 Mon Sep 17 00:00:00 2001 From: "Ford St. John" Date: Thu, 26 Feb 2026 15:09:34 -0500 Subject: [PATCH 12/12] move packages and use java8 compliant syntax --- .../api/{model => util}/annotation/Required.java | 6 +++--- .../RequiredPropertyDetectionAdapterFactory.java | 6 +++--- .../{model => util}/predicate/FieldPredicate.java | 4 ++-- .../predicate/IsNotNullFieldPredicate.java | 2 +- .../java/test_locally/util/JSONUtilityTest.java | 14 +++++++++----- 5 files changed, 18 insertions(+), 14 deletions(-) rename slack-api-model/src/main/java/com/slack/api/{model => util}/annotation/Required.java (88%) rename slack-api-model/src/main/java/com/slack/api/{model => util}/predicate/FieldPredicate.java (63%) rename slack-api-model/src/main/java/com/slack/api/{model => util}/predicate/IsNotNullFieldPredicate.java (83%) diff --git a/slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java b/slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java similarity index 88% rename from slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java rename to slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java index 795c30d79..76c85c075 100644 --- a/slack-api-model/src/main/java/com/slack/api/model/annotation/Required.java +++ b/slack-api-model/src/main/java/com/slack/api/util/annotation/Required.java @@ -1,7 +1,7 @@ -package com.slack.api.model.annotation; +package com.slack.api.util.annotation; -import com.slack.api.model.predicate.FieldPredicate; -import com.slack.api.model.predicate.IsNotNullFieldPredicate; +import com.slack.api.util.predicate.FieldPredicate; +import com.slack.api.util.predicate.IsNotNullFieldPredicate; import com.slack.api.util.json.RequiredPropertyDetectionAdapterFactory; import java.lang.annotation.ElementType; diff --git a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredPropertyDetectionAdapterFactory.java b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredPropertyDetectionAdapterFactory.java index 4e94f71bb..41a17ed88 100644 --- a/slack-api-model/src/main/java/com/slack/api/util/json/RequiredPropertyDetectionAdapterFactory.java +++ b/slack-api-model/src/main/java/com/slack/api/util/json/RequiredPropertyDetectionAdapterFactory.java @@ -7,8 +7,8 @@ import com.google.gson.reflect.TypeToken; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; -import com.slack.api.model.predicate.FieldPredicate; -import com.slack.api.model.annotation.Required; +import com.slack.api.util.predicate.FieldPredicate; +import com.slack.api.util.annotation.Required; import lombok.EqualsAndHashCode; import lombok.RequiredArgsConstructor; @@ -22,7 +22,7 @@ /** * Adapter factory for processing objects annotated with {@link Required}. This annotation signals what properties * of a model object are required, and thus should be expected to be initialized on instantiated instances. For all - * fields on the model objected annotated with {@link Required} applies the {@link FieldPredicate#test(Object)} via the + * fields on the model objected annotated with {@link Required} applies the {@link FieldPredicate#validate(Object)} via the * specified {@link Required#validator()}. *

* Note that this adapter handles both deserialization (JSON --> POJO) and serialization (POJO --> JSON). diff --git a/slack-api-model/src/main/java/com/slack/api/model/predicate/FieldPredicate.java b/slack-api-model/src/main/java/com/slack/api/util/predicate/FieldPredicate.java similarity index 63% rename from slack-api-model/src/main/java/com/slack/api/model/predicate/FieldPredicate.java rename to slack-api-model/src/main/java/com/slack/api/util/predicate/FieldPredicate.java index 58cc287e0..968ebe6ff 100644 --- a/slack-api-model/src/main/java/com/slack/api/model/predicate/FieldPredicate.java +++ b/slack-api-model/src/main/java/com/slack/api/util/predicate/FieldPredicate.java @@ -1,8 +1,8 @@ -package com.slack.api.model.predicate; +package com.slack.api.util.predicate; /** * A functional interface for defining validation predicates against {@link java.lang.reflect.Field}. Used by - * {@link com.slack.api.model.annotation.Required} during object serialization and deserialization to ensure the + * {@link com.slack.api.util.annotation.Required} during object serialization and deserialization to ensure the * field member is "valid" per the defined predicate. */ @FunctionalInterface diff --git a/slack-api-model/src/main/java/com/slack/api/model/predicate/IsNotNullFieldPredicate.java b/slack-api-model/src/main/java/com/slack/api/util/predicate/IsNotNullFieldPredicate.java similarity index 83% rename from slack-api-model/src/main/java/com/slack/api/model/predicate/IsNotNullFieldPredicate.java rename to slack-api-model/src/main/java/com/slack/api/util/predicate/IsNotNullFieldPredicate.java index 53d948c4a..a80ce45f9 100644 --- a/slack-api-model/src/main/java/com/slack/api/model/predicate/IsNotNullFieldPredicate.java +++ b/slack-api-model/src/main/java/com/slack/api/util/predicate/IsNotNullFieldPredicate.java @@ -1,4 +1,4 @@ -package com.slack.api.model.predicate; +package com.slack.api.util.predicate; import java.util.Objects; diff --git a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java index ed5eb2946..718721586 100644 --- a/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java +++ b/slack-api-model/src/test/java/test_locally/util/JSONUtilityTest.java @@ -1,7 +1,6 @@ package test_locally.util; import com.google.gson.*; -import com.slack.api.model.predicate.FieldPredicate; import com.slack.api.model.block.ContextBlockElement; import com.slack.api.model.block.DividerBlock; import com.slack.api.model.block.LayoutBlock; @@ -12,14 +11,16 @@ import com.slack.api.model.block.element.ImageElement; import com.slack.api.model.block.element.OverflowMenuElement; import com.slack.api.model.event.FunctionExecutedEvent; -import com.slack.api.model.annotation.Required; +import com.slack.api.util.annotation.Required; import com.slack.api.util.json.*; +import com.slack.api.util.predicate.FieldPredicate; import lombok.Builder; import lombok.Data; import org.junit.Test; import test_locally.unit.GsonFactory; import java.lang.reflect.Type; +import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.List; @@ -202,7 +203,7 @@ public void testRequiredPropertyDetectionAdapterFactory_basicCase_happyPath() { @Test public void testRequiredPropertyDetectionAdapterFactory_advancedCase_failureCases() { Gson gson = GsonFactory.createSnakeCaseWithRequiredPropertyDetection(); - + List users = new ArrayList<>(); // Serialization JsonParseException e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().build())); assertThat(e.getMessage(), equalToIgnoringCase("Required field 'id' failed validation in TestClassWithRequiredAdvanced using predicate IntegerGreaterThanZero")); @@ -216,7 +217,8 @@ public void testRequiredPropertyDetectionAdapterFactory_advancedCase_failureCase e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().id(1).name("Hello").build())); assertThat(e.getMessage(), equalToIgnoringCase("Required field 'users' failed validation in TestClassWithRequiredAdvanced using predicate NonEmptyCollection")); - e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().id(1).name("Hello").users(List.of("user1")).build())); + users.add("user1"); + e = assertThrows(JsonParseException.class, () -> gson.toJson(TestClassWithRequiredAdvanced.builder().id(1).name("Hello").users(users).build())); assertThat(e.getMessage(), equalToIgnoringCase("Required field 'myBool' failed validation in TestClassWithRequiredAdvanced using predicate isNotNullFieldPredicate")); // Deserialization @@ -239,10 +241,12 @@ public void testRequiredPropertyDetectionAdapterFactory_advancedCase_failureCase @Test public void testRequiredPropertyDetectionAdapterFactory_advancedCase_happyPath() { Gson gson = GsonFactory.createSnakeCaseWithRequiredPropertyDetection(); + List users = new ArrayList<>(); + users.add("testUser"); TestClassWithRequiredAdvanced instance = TestClassWithRequiredAdvanced.builder() .id(1) .name("test") - .users(List.of("testUser")) + .users(users) .myBool(true) .build();