GH-10083: Add Nullability to core support package #10395

cppwfs · 2025-09-08T14:50:17Z

Related to: #10083

Add Nullability support to support.management package
Add Nullability support to support.management.micrometer package
Add Nullability support to support.management.observation
Add Nullability support to support.json

artembilan · 2025-09-08T17:39:37Z

...ion-core/src/main/java/org/springframework/integration/splitter/AbstractMessageSplitter.java

 		Object correlationId = message.getHeaders().getId();
 		AtomicInteger sequenceNumber = new AtomicInteger(1);
-
+		Assert.state(correlationId != null, "Correlation ID must not be null.");


This is redundant here.
The createBuilder() can accept it as null.
And then e have a check at the applySequence condition.

artembilan · 2025-09-08T17:59:27Z

...tegration-core/src/main/java/org/springframework/integration/support/BaseMessageBuilder.java

 	 * @see IntegrationMessageHeaderAccessor#isReadOnly(String)
 	 */
+	@SuppressWarnings("NullAway") // Dataflow analysis limitation
 	public B readOnlyHeaders(@Nullable String... readOnlyHeaders) {


This @Nullable is at wrong place.
Has to be next to ellipsis.
Therefore private String @Nullable [] readOnlyHeaders;
Then everything else in this class should be fixed well.

artembilan · 2025-09-08T17:59:47Z

...core/src/main/java/org/springframework/integration/support/DefaultMessageBuilderFactory.java

 	 * @since 4.3.2
 	 */
+	@SuppressWarnings("NullAway") // Dataflow analysis limitation
 	public void setReadOnlyHeaders(@Nullable String... readOnlyHeaders) {


Missed to fix properly: setReadOnlyHeaders(String @Nullable ... readOnlyHeaders)

artembilan · 2025-09-08T18:01:40Z

...core/src/main/java/org/springframework/integration/support/SmartLifecycleRoleController.java

 	 * @param role the role.
 	 */
-	public void startLifecyclesInRole(String role) {
+	public void startLifecyclesInRole(@Nullable String role) {


I think this is wrong.
This is not possible by the logic of this API.

On line 321 startLifecyclesInRole is used and a nullable value can be passed in. Do we add a Assert.state prior to line 321?

Let's revise that AbstractLeaderEvent instead!
Remove AbstractLeaderEvent(Object source) ctor as it is out of use.
Looks like the other ctor is never used with null.

artembilan · 2025-09-08T18:05:37Z

...re/src/main/java/org/springframework/integration/support/json/Jackson2JsonMessageParser.java

 			}
 			Assert.notNull(headers, error);
-
+			Assert.state(payload != null, () -> "Payload must not be null");


This class is marked for removal.
So, it is OK to not spend any time on it and just mark the whole class with NullAway.

artembilan · 2025-09-08T18:06:54Z

...ration-core/src/main/java/org/springframework/integration/support/json/JacksonJsonUtils.java

 		private final String[] trustedPackages;

+		@SuppressWarnings("NullAway") // Dataflow analysis limitation
 		AllowListTypeResolverBuilder(String... trustedPackages) {


String @Nullable ... instead.

artembilan · 2025-09-08T18:11:19Z

...ration-core/src/main/java/org/springframework/integration/support/json/JsonObjectMapper.java


-	default <T> T fromJson(Object json, Class<T> valueType) throws IOException {
+	@Nullable
+	default <T> T fromJson(@Nullable Object json, Class<T> valueType) throws IOException {


How that happened that we allow null over here?
Doesn't looks like Jackson accepts such a behavior:

public <T> T readValue(String content, JavaType valueType) throws JacksonException { _assertNotNull("content", content);

Please, revise all the places which put a null for this API.

artembilan · 2025-09-08T18:20:39Z

...rg/springframework/integration/http/outbound/AbstractHttpRequestExecutingMessageHandler.java

-			replyBuilder = (responseBody instanceof Message<?>)
-					? messageBuilderFactory.fromMessage((Message<?>) responseBody)
-					: messageBuilderFactory.withPayload(responseBody); // NOSONAR - hasBody()
+			Assert.state(responseBody != null, "The response body must not be null");


Not correct. The httpResponse.hasBody() does cover this.
Please, revise. Perhaps in favor of NullAway

...core/src/main/java/org/springframework/integration/support/json/JacksonJsonObjectMapper.java

artembilan · 2025-09-08T18:28:40Z

.../main/java/org/springframework/integration/support/json/AbstractJacksonJsonObjectMapper.java

 	}

-	protected abstract <T> T fromJson(Object json, J type) throws IOException;
+	protected abstract <T> T fromJson(@Nullable Object json, J type) throws IOException;


Please, revise these from methods.
No null is allowed.

artembilan · 2025-09-08T20:12:40Z

...core/src/main/java/org/springframework/integration/support/DefaultMessageBuilderFactory.java

 	 * @since 4.3.2
 	 */
+	@SuppressWarnings("NullAway") // Dataflow analysis limitation
 	public void setReadOnlyHeaders(@Nullable String... readOnlyHeaders) {


Missed to fix properly: setReadOnlyHeaders(String @Nullable ... readOnlyHeaders)

artembilan · 2025-09-08T20:13:53Z

...core/src/main/java/org/springframework/integration/support/SmartLifecycleRoleController.java

 	@Override
 	public void onApplicationEvent(AbstractLeaderEvent event) {
 		if (event instanceof OnGrantedEvent) {
+			Assert.state(event.getRole() != null, "A role is required");


That's not what I meant.
That AbstractLeaderEvent has to be fixed to not accept (and produce) nulls at all.
Thanks

artembilan · 2025-09-08T20:14:07Z

...core/src/main/java/org/springframework/integration/support/SmartLifecycleRoleController.java

 	 * @param role the role.
 	 */
-	public void stopLifecyclesInRole(String role) {
+	public void stopLifecyclesInRole(@Nullable String role) {


Therefore, same here: no null allowed.

artembilan · 2025-09-08T20:41:34Z

...core/src/main/java/org/springframework/integration/support/DefaultMessageBuilderFactory.java

 public class DefaultMessageBuilderFactory implements MessageBuilderFactory {

-	private String[] readOnlyHeaders;
+	@SuppressWarnings("NullAway.Init")


If the property is nullable, then this suppression is redundant.

artembilan · 2025-09-08T20:42:55Z

...tegration-core/src/main/java/org/springframework/integration/support/BaseMessageBuilder.java

 	private volatile boolean modified;

-	private String[] readOnlyHeaders;
+	@SuppressWarnings("NullAway.Init")


Remove this, please.

artembilan · 2025-09-08T20:43:16Z

...tegration-core/src/main/java/org/springframework/integration/support/BaseMessageBuilder.java

 	 * @see IntegrationMessageHeaderAccessor#isReadOnly(String)
 	 */
-	public B readOnlyHeaders(@Nullable String... readOnlyHeaders) {
+	public B readOnlyHeaders(String... readOnlyHeaders) {


Put @Nullable next to ellipsis.

artembilan · 2025-09-08T20:43:57Z

...core/src/main/java/org/springframework/integration/support/DefaultMessageBuilderFactory.java

 	public <T> MessageBuilder<T> fromMessage(Message<T> message) {
-		return MessageBuilder.fromMessage(message)
-				.readOnlyHeaders(this.readOnlyHeaders);
+		if (this.readOnlyHeaders != null) {


When you fix BaseMessageBuilder, then this change has to be reverted.

artembilan · 2025-09-08T20:44:16Z

...core/src/main/java/org/springframework/integration/support/DefaultMessageBuilderFactory.java

 	public <T> MessageBuilder<T> withPayload(T payload) {
-		return MessageBuilder.withPayload(payload)
-				.readOnlyHeaders(this.readOnlyHeaders);
+		if (this.readOnlyHeaders != null) {


artembilan · 2025-09-08T20:46:29Z

...tegration-core/src/main/java/org/springframework/integration/support/BaseMessageBuilder.java

 		if (!ObjectUtils.isEmpty(this.readOnlyHeaders)) {
 			for (String readOnly : this.readOnlyHeaders) {
-				if (headers.containsKey(readOnly)) {
+				if (readOnly != null && headers.containsKey(readOnly)) {


This does not reflect reality.
The String @Nullable [] is about the whole array being null.
To reflect that individual items could be null, too, we have to make it like:

@Nullable String @Nullable []

But that is not our case.
Therefore this != null is not true.

artembilan · 2025-09-08T20:47:02Z

...tegration-core/src/main/java/org/springframework/integration/support/BaseMessageBuilder.java

 	}

 	private boolean containsReadOnly(MessageHeaders headers) {
 		if (!ObjectUtils.isEmpty(this.readOnlyHeaders)) {


Let's change this to != null to remove that @SuppressWarnings("NullAway.Init") on the property.

Related to: spring-projects#10083 * Add Nullability support to support.management package * Add Nullability support to support.management.micrometer package * Add Nullability support to support.management.observation * Add Nullability support to support.json

* Disabled null checks in Deprecated Jackson2 classes Remove Nullable from Jackson2 classes

Remove unnecessary if statements following review

cppwfs requested a review from artembilan September 8, 2025 14:50

artembilan added this to the 7.0.0-M3 milestone Sep 8, 2025

artembilan added type: enhancement in: core labels Sep 8, 2025

artembilan requested changes Sep 8, 2025

View reviewed changes

cppwfs force-pushed the GH-10083-core-support branch 2 times, most recently from 5ff7320 to fc29e23 Compare September 8, 2025 20:01

artembilan requested changes Sep 8, 2025

View reviewed changes

cppwfs and others added 4 commits September 8, 2025 17:13

Removed nullable parameters from fromJson

f667e03

* Disabled null checks in Deprecated Jackson2 classes Remove Nullable from Jackson2 classes

Remove Nullable from AbstractLeaderEvent

21dce27

Remove unnecessary SuppressWarnings

d0f07eb

Remove unnecessary if statements following review

cppwfs force-pushed the GH-10083-core-support branch from febeea9 to d0f07eb Compare September 8, 2025 21:15

artembilan merged commit 448cee7 into spring-projects:main Sep 8, 2025
3 checks passed

GH-10083: Add Nullability to core support package #10395

GH-10083: Add Nullability to core support package #10395

Uh oh!

Conversation

cppwfs commented Sep 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!