Restore `ExceptionFactory` by alexander-yevsyukov · Pull Request #281 · SpineEventEngine/validation

alexander-yevsyukov · 2026-03-24T19:37:06Z

This PR restores the ExceptionFactory class which was accidentally deleted in one of the previous PRs. This PR also adds tests to ensure that this abstract class is used via stub implementation.

Other notable changes

The ViolationText class was moved out of the diags subpackage to the upper level so that we don't have the one-class package.
Previously deprecated types from the io.spine.option package were removed.
Dependencies on Base, ToolBase, Validation, Compiler, and KSP were updated.
ExceptionFactory.getMessageTypeAttribute() now accepts parameter of the generic type M instead of just Message.

Copilot

Pull request overview

Restores the previously removed ExceptionFactory in the JVM runtime, updates diagnostics packaging by moving ViolationText to the top-level validation package, removes deprecated runtime option types, and bumps project/dependency versions accordingly.

Changes:

Reintroduce ExceptionFactory and add tests (with stub implementations) to validate its behavior.
Move ViolationText out of the diags subpackage and adjust call sites/imports.
Remove deprecated io.spine.validation.option runtime option types and update dependency versions/reports.

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
version.gradle.kts	Bumps published Validation SDK version to `2.0.0-SNAPSHOT.407`.
tests/runtime/src/test/kotlin/io/spine/validation/ValidateUtilitySpec.kt	Removes outdated `ViolationText` import after package move.
pom.xml	Updates project and dependency versions (incl. Spine/Compiler/KSP/Protobuf).
jvm-runtime/src/test/kotlin/io/spine/validation/given/ExceptionFactoryStubs.kt	Adds stub `ExceptionFactory`/exception used by tests.
jvm-runtime/src/test/kotlin/io/spine/validation/diags/ViolationTextSpec.kt	Updates import to new `ViolationText` package.
jvm-runtime/src/test/kotlin/io/spine/validation/ExceptionFactorySpec.kt	Adds coverage asserting exception/error contents produced by `ExceptionFactory`.
jvm-runtime/src/main/java/io/spine/validation/option/ValidatingOption.java	Removes deprecated runtime option API.
jvm-runtime/src/main/java/io/spine/validation/option/Required.java	Removes deprecated runtime option implementation.
jvm-runtime/src/main/java/io/spine/validation/option/FieldValidatingOption.java	Removes deprecated runtime option base type.
jvm-runtime/src/main/java/io/spine/validation/option/AlwaysRequired.java	Removes deprecated runtime option specialization.
jvm-runtime/src/main/java/io/spine/validation/diags/package-info.java	Removes `diags` package metadata as the package is eliminated.
jvm-runtime/src/main/java/io/spine/validation/ViolationText.java	Moves `ViolationText` into `io.spine.validation`.
jvm-runtime/src/main/java/io/spine/validation/ValidationException.java	Adjusts `ViolationText` usage and adds `serialVersionUID`.
jvm-runtime/src/main/java/io/spine/validation/ExceptionFactory.java	Restores the abstract factory for building validation exceptions/errors.
dependencies.md	Updates generated dependency/license report to the new versions.
buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt	Bumps referenced Validation dependency version to `...406`.
buildSrc/src/main/kotlin/io/spine/dependency/local/ToolBase.kt	Bumps ToolBase versions to `...375`.
buildSrc/src/main/kotlin/io/spine/dependency/local/Compiler.kt	Bumps Compiler fallback versions to `...041`.
buildSrc/src/main/kotlin/io/spine/dependency/local/Base.kt	Bumps Spine Base versions to `...386`.
buildSrc/src/main/kotlin/io/spine/dependency/build/Ksp.kt	Bumps KSP version to `2.3.6`.

Comments suppressed due to low confidence (1)

jvm-runtime/src/main/java/io/spine/validation/ViolationText.java:28

Moving ViolationText from io.spine.validation.diags to io.spine.validation is a binary/source breaking change for any consumers importing the old package. If backward compatibility is still desired for this SNAPSHOT line, consider keeping a deprecated shim in io.spine.validation.diags (e.g., a delegating wrapper with the same static API) so existing code continues to compile while users migrate.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

This reverts commit 4e01e27.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull request overview

Copilot reviewed 19 out of 20 changed files in this pull request and generated 5 comments.

Files not reviewed (1)

.idea/inspectionProfiles/Project_Default.xml: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-25T14:30:28Z

+
+package io.spine.validation.given
+
+import com.google.protobuf.Message


com.google.protobuf.Message is imported but never used in this test stub, which can fail the build if Kotlin warnings are treated as errors. Please remove the unused import.

Suggested change

import com.google.protobuf.Message

Copilot · 2026-03-25T14:30:29Z

+ *         the type of the {@code Message}, typically it would be a grouping interface such as
+ *         {@link io.spine.base.EventMessage} or {@link io.spine.base.CommandMessage}
+ * @param <C>
+ *         the type of the {@linkplain io.spine.type.MessageClass} of {@code |M|}


Javadoc for type parameter C contains {@code |M|}, which looks like a formatting artifact and will render incorrectly. Replace it with the intended reference (e.g. {@code M}) so the generated docs are correct.

Suggested change

* the type of the {@linkplain io.spine.type.MessageClass} of {@code |M|}

* the type of the {@linkplain io.spine.type.MessageClass} of {@code M}

Copilot · 2026-03-25T14:30:29Z

+     *         an invalid event message
+     * @param violations
+     *         constraint violations for the event message


Constructor parameter docs refer to an “event message”, but ExceptionFactory is generic over any invalid Message type (including commands). Please update the wording to avoid misleading API docs.

Suggested change

* an invalid event message

* @param violations

* constraint violations for the event message

* an invalid message

* @param violations

* constraint violations for the message

Copilot · 2026-03-25T14:30:29Z

+    protected abstract Map<String, Value> getMessageTypeAttribute(M message);
+
+    /**
+     * Defines the way to create an instance of exception basing on the source {@code Message},


The phrase “create an instance of exception basing on…” is grammatically incorrect and makes the Javadoc harder to read. Please reword it (e.g. “based on”).

Suggested change

* Defines the way to create an instance of exception basing on the source {@code Message},

* Defines how to create an exception instance based on the source {@code Message},

Copilot · 2026-03-25T14:30:30Z

+    <inspection_tool class="FieldNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">
+      <extension name="ConstantNamingConvention" enabled="false">
+        <option name="m_regex" value="[A-Z_\d]*" />
+        <option name="m_minLength" value="5" />
+        <option name="m_maxLength" value="32" />
+      </extension>
+      <extension name="InstanceVariableNamingConvention" enabled="true">
+        <option name="m_regex" value="[a-z][A-Za-z\d]*" />
+        <option name="m_minLength" value="2" />
+        <option name="m_maxLength" value="32" />
+      </extension>
+    </inspection_tool>


This PR is primarily about restoring ExceptionFactory and related validation types, but it also changes the IntelliJ inspection profile (e.g., adds FieldNamingConvention). If these IDE settings changes are not strictly required for the restoration, consider moving them to a separate PR to keep review history focused.

alexander-yevsyukov added 8 commits March 24, 2026 18:42

Bump version -> 2.0.0-SNAPSHOT.407

d1b154a

Restore ExceptionFactory class

bc0b218

Update dependencies

d4533ea

Update dependency reports

9836383

Add tests for ExceptionFactory

1156165

Pull ViolationText to the upper package

6d9a5ff

Remove deprecated types

4e01e27

Update build time

98c8003

Copilot AI review requested due to automatic review settings March 24, 2026 19:37

Copilot started reviewing on behalf of alexander-yevsyukov March 24, 2026 19:37 View session

Copilot AI reviewed Mar 24, 2026

View reviewed changes

Comment thread jvm-runtime/src/main/java/io/spine/validation/ExceptionFactory.java

Comment thread jvm-runtime/src/main/java/io/spine/validation/ExceptionFactory.java Outdated

alexander-yevsyukov added 5 commits March 24, 2026 19:45

Remove redundant suppression

e896676

Improve generic parameter descriptions

2c9d70f

Narrow down the parameter type

23c6ca0

Auto-update by IDEA

348e14a

Update build time

36d35ed

alexander-yevsyukov self-assigned this Mar 24, 2026

alexander-yevsyukov marked this pull request as ready for review March 24, 2026 20:01

alexander-yevsyukov requested review from armiol and Copilot March 24, 2026 20:01

alexander-yevsyukov enabled auto-merge March 24, 2026 20:02

Copilot started reviewing on behalf of alexander-yevsyukov March 24, 2026 20:02 View session

Revert "Remove deprecated types"

a7b0090

This reverts commit 4e01e27.

Copilot AI reviewed Mar 25, 2026

View reviewed changes

armiol approved these changes Mar 25, 2026

View reviewed changes

alexander-yevsyukov added 3 commits March 25, 2026 14:24

Update Validation version in examples

6a72da7

Update config ref.

64ef837

Update build time

6a7d65d

Copilot AI review requested due to automatic review settings March 25, 2026 14:25

Copilot started reviewing on behalf of alexander-yevsyukov March 25, 2026 14:25 View session

Update build time

0330f4e

Copilot AI reviewed Mar 25, 2026

View reviewed changes

alexander-yevsyukov merged commit b08a553 into master Mar 25, 2026
7 of 14 checks passed

alexander-yevsyukov deleted the restore-exception-factory branch March 25, 2026 15:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restore `ExceptionFactory`#281

Restore `ExceptionFactory`#281
alexander-yevsyukov merged 18 commits intomasterfrom
restore-exception-factory

alexander-yevsyukov commented Mar 24, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 25, 2026

Uh oh!

Copilot AI Mar 25, 2026

Uh oh!

Copilot AI Mar 25, 2026

Uh oh!

Copilot AI Mar 25, 2026

Uh oh!

Copilot AI Mar 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		package io.spine.validation.given

		import com.google.protobuf.Message

	* the type of the {@linkplain io.spine.type.MessageClass} of {@code \|M\|}
	* the type of the {@linkplain io.spine.type.MessageClass} of {@code M}

	* Defines the way to create an instance of exception basing on the source {@code Message},
	* Defines how to create an exception instance based on the source {@code Message},

Conversation

alexander-yevsyukov commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Other notable changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alexander-yevsyukov commented Mar 24, 2026 •

edited

Loading