Add `validate()` probe to `ValidatingBuilder` by alexander-yevsyukov · Pull Request #316 · SpineEventEngine/validation

alexander-yevsyukov · 2026-07-05T21:18:03Z

What

Adds a default probe method to io.spine.validation.ValidatingBuilder:

default List<ConstraintViolation> validate()

It builds the current content via buildPartial() and, when the result is a
ValidatableMessage, unwraps its Optional<ValidationError> into the returned
list; a message that does not support validation is treated as valid. An empty
list means the content is valid.

The method is a non-throwing, non-mutating probe of the builder's current
content — including content that is already invalid. It sits between the two
existing options:

Method	Validates?	On invalid content
`build()`	yes	throws `ValidationException`
`buildPartial()`	no	returns a possibly-invalid message
`validate()` (new)	yes	returns the violations, throws nothing

Why

Complements the tryAlter {} entity extension designed in core-jvm
PR #1642
(de-event-sourcing Phase A), which needs to check a builder's content for
validity in place without either throwing or handing back a message. Implements
the D9 amendment of ADR 0001. Requested by @armiol in
SpineEventEngine/core-jvm#1642 (comment)

How it works

The generated ValidatableMessage.validate(parentPath, parentName) already
folds in ValidatorRegistry.validate(this), so buildPartial() +
ValidatableMessage.validate() checks exactly what generated build() checks —
no more, no less. It deliberately does not route through
Validate.violationsOf(), which adds Any-unpacking logic irrelevant to a
builder.

Tests

ValidatingBuilderSpec (jvm-runtime) — unit specs with minimal stubs
covering every branch of validate(): a valid ValidatableMessage → empty
list; an invalid one → violations returned without throwing; a product that
does not implement ValidatableMessage → treated as valid.
ValidatingBuilderSpec (tests/validating) — the same valid/invalid paths
against the real generated InterestRate builder (a (min) constraint),
plus a check that probing leaves the builder content intact.
JavaMessageSmokeTest (tests/validating) — smoke coverage for validate()
on the generated CardNumber builder.

Notes for reviewers

Version bumped 2.0.0-SNAPSHOT.446 → .447; docs/dependencies/* are the
regenerated reports (version/timestamp churn only).
The developer-docs page runtime-library.md, which mirrors the interface
body, is updated to include the new method.
docs/content/** was touched but no links were added or changed, so
check-links has no bearing on this diff.

Bundled maintenance

Beyond the validate() change, this branch also carries routine SDK
maintenance the author chose to keep together rather than split out:

Toolchain migration — latest Base (2.0.0-SNAPSHOT.391) and CoreJvm
compiler (2.0.0-SNAPSHOT.080), Protobuf 4.35.0, Gradle wrapper 9.6.1.
Config sync — .agents/ restructure, refreshed dependency reports, and
two new CI workflows (revalidate-versions, secret-scan).
Example alignment — the hello-validation docs submodule
(docs/_examples) is advanced to force Protobuf 4.35.0, matching the
migrated compiler's gencode; this fixes the Build embedded code check.

Verification: full ./gradlew build passes; :docs:buildExamples
(embedded-code) passes after the submodule alignment; the version-increment
guard and remaining CI checks are green.

🤖 Generated with Claude Code

@armiol

Add a default `validate()` method to `io.spine.validation.ValidatingBuilder` that probes the builder's current content and returns any constraint violations without throwing or mutating the builder. It builds the content via `buildPartial()` and, when the result is a `ValidatableMessage`, unwraps its `ValidationError` into the returned list; a message that does not support validation is treated as valid. An empty list means the content is valid. This gives callers a non-throwing counterpart to `build()` (which throws `ValidationException`) that, unlike `buildPartial()`, does not skip validation or hand back a possibly invalid message. It complements the `tryAlter {}` entity extension from core-jvm PR #1642 (de-event-sourcing Phase A) and implements the D9 amendment of ADR 0001. Requested by @armiol: SpineEventEngine/core-jvm#1642 (comment) Covered by stub-based unit tests (`ValidatingBuilderSpec`) and integration tests against generated code (`JavaMessageSmokeTest`). The developer-docs snippet mirroring the interface is updated to match. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot

Pull request overview

Adds a non-throwing validation probe to ValidatingBuilder so callers can check builder content validity (including already-invalid content) without throwing and without returning a potentially invalid message instance.

Changes:

Added ValidatingBuilder#validate() default method returning constraint violations (empty list = valid).
Added unit + integration tests covering valid/invalid cases and non-mutating behavior.
Updated runtime-library docs and bumped snapshot version / regenerated dependency reports.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`jvm-runtime/src/main/java/io/spine/validation/ValidatingBuilder.java`	Adds `validate()` API and Javadoc explaining non-throwing probe semantics.
`jvm-runtime/src/test/kotlin/io/spine/validation/ValidatingBuilderSpec.kt`	New stub-based unit specs for `validate()` behavior and non-mutation.
`tests/validating/src/test/kotlin/io/spine/test/JavaMessageSmokeTest.kt`	Adds integration coverage for `validate()` on generated Java builder.
`docs/content/docs/validation/developer/runtime-library.md`	Updates developer docs page that mirrors the runtime contracts to include `validate()`.
`version.gradle.kts`	Bumps published snapshot version.
`docs/dependencies/pom.xml`	Regenerated dependency report metadata version.
`docs/dependencies/dependencies.md`	Regenerated dependency report content/version/timestamp churn.
`.agents/tasks/validating-builder-validate.md`	Task plan / implementation notes (not part of published API).

codecov · 2026-07-05T21:24:13Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 12.35%. Comparing base (dd8c421) to head (17e536f).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #316      +/-   ##
============================================
+ Coverage     12.09%   12.35%   +0.25%     
- Complexity       82       84       +2     
============================================
  Files            82       82              
  Lines          2034     2040       +6     
  Branches        160      161       +1     
============================================
+ Hits            246      252       +6     
  Misses         1786     1786              
  Partials          2        2

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Address review feedback on PR #316: the interface-level Javadoc said `validate()` checks validity "without building the message", but the method calls `buildPartial()`, which does construct a message instance (the caller just never receives it). Reword to "without obtaining the built message". Also align abbreviation punctuation (`i.e.,`) with the `e.g.,` used earlier in the same Javadoc block. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot

Pull request overview

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

Rewrite `ValidatingBuilderSpec` to probe the new `ValidatingBuilder.validate()` method through a real generated validating type instead of hand-written `AbstractMessage`/`Builder` stubs. The spec now uses the generated `InterestRate` message (a single `float percent` field constrained with `(min) > 0.0`) to cover the meaningful paths: valid content yields no violations, invalid content returns the violations without throwing, and probing leaves the builder content intact. Because a generated `ValidatingBuilder` always builds a `ValidatableMessage`, real generated types cannot reach the "message does not support validation" fallback branch; that branch is defensive and no longer has a dedicated stub test. The spec moves to the `tests:validating` module: `jvm-runtime` depends on `spine-base` and does not apply the `io.spine.validation` code generator, so it cannot produce a generated `ValidatableMessage`/`ValidatingBuilder` to test against — only a plugin-applied module such as `tests:validating` can. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Advance the `docs/_examples` submodule to the Protobuf runtime alignment for the migrated CoreJvm compiler. Fixes the `Build embedded code` check, where the generated `BankCard` failed to initialize because of a gencode `4.35.0` / runtime `4.34.1` mismatch. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot

Pull request overview

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

`ValidatingBuilder.validate()` returns an empty list when `buildPartial()` yields a message that does not implement `ValidatableMessage`. Real generated builders always produce a `ValidatableMessage`, so this branch cannot be reached from the `tests/validating` spec; exercise it here with a minimal builder that delegates to a plain `Empty` product. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 262 out of 269 changed files in this pull request and generated 3 comments.

Extend the `jvm-runtime` unit spec so the `validate()` default method is exercised for all three products it can encounter: a `ValidatableMessage` that is valid, one that reports violations, and a message that does not support validation. The builder stub now takes an arbitrary product, and a minimal `ValidatableMessage` stub reports the configured violations. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

… into claude/wonderful-hellman-f8ec72

- `runtime-library.md`: state that `validate()` treats a product that does not implement `ValidatableMessage` as valid, matching the interface Javadoc and the unit tests. - `ValidateUtilitySpec.kt`: bump the copyright header to 2026 for a file edited on this branch. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot

Pull request overview

Copilot reviewed 262 out of 269 changed files in this pull request and generated 1 comment.

Replace restrictive `which` clauses (no preceding comma) with `that` in the interface Javadoc, per the repo grammar convention. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

alexander-yevsyukov and others added 3 commits July 5, 2026 22:08

Bump version -> 2.0.0-SNAPSHOT.447

b1f0104

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Update dependency reports

0e7335c

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot AI review requested due to automatic review settings July 5, 2026 21:18

Copilot started reviewing on behalf of alexander-yevsyukov July 5, 2026 21:18 View session

Copilot AI reviewed Jul 5, 2026

View reviewed changes

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

alexander-yevsyukov and others added 5 commits July 5, 2026 23:24

Update config

70a218e

Update config

7decc5c

Update dependency reports

38190e7

Migrate to latest Base and CoreJvm Compiler

f8c5751

Copilot AI review requested due to automatic review settings July 5, 2026 22:52

Copilot started reviewing on behalf of alexander-yevsyukov July 5, 2026 22:52 View session

Copilot AI reviewed Jul 5, 2026

View reviewed changes

Comment thread docs/project.md Outdated

Comment thread version.gradle.kts

alexander-yevsyukov self-assigned this Jul 5, 2026

alexander-yevsyukov added this to v2.0 Jul 5, 2026

alexander-yevsyukov moved this to 🏗 In progress in v2.0 Jul 5, 2026

Copilot AI review requested due to automatic review settings July 5, 2026 23:50

Copilot started reviewing on behalf of alexander-yevsyukov July 5, 2026 23:51 View session

Copilot AI reviewed Jul 5, 2026

View reviewed changes

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

Comment thread tests/validating/src/test/kotlin/io/spine/test/ValidatingBuilderSpec.kt

alexander-yevsyukov moved this from 🏗 In progress to In Review in v2.0 Jul 6, 2026

Fix the Markdown link

df87029

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings July 6, 2026 00:48

Copilot started reviewing on behalf of alexander-yevsyukov July 6, 2026 00:49 View session

alexander-yevsyukov moved this from In Review to 🏗 In progress in v2.0 Jul 6, 2026

Copilot AI reviewed Jul 6, 2026

View reviewed changes

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

Comment thread tests/runtime/src/test/kotlin/io/spine/validation/ValidateUtilitySpec.kt

Comment thread docs/content/docs/validation/developer/runtime-library.md Outdated

alexander-yevsyukov and others added 3 commits July 6, 2026 01:57

Merge remote-tracking branch 'origin/claude/wonderful-hellman-f8ec72'…

0bc626d

… into claude/wonderful-hellman-f8ec72

Copilot AI review requested due to automatic review settings July 6, 2026 01:03

Copilot started reviewing on behalf of alexander-yevsyukov July 6, 2026 01:03 View session

Copilot AI reviewed Jul 6, 2026

View reviewed changes

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

Use restrictive that in ValidatingBuilder Javadoc

17e536f

Replace restrictive `which` clauses (no preceding comma) with `that` in the interface Javadoc, per the repo grammar convention. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

alexander-yevsyukov requested a review from armiol July 6, 2026 02:59

alexander-yevsyukov moved this from 🏗 In progress to In Review in v2.0 Jul 6, 2026

armiol approved these changes Jul 6, 2026

View reviewed changes

alexander-yevsyukov merged commit 9c12903 into master Jul 6, 2026
12 checks passed

alexander-yevsyukov deleted the claude/wonderful-hellman-f8ec72 branch July 6, 2026 09:50

github-project-automation Bot moved this from In Review to ✅ Done in v2.0 Jul 6, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add `validate()` probe to `ValidatingBuilder`#316

Add `validate()` probe to `ValidatingBuilder`#316
alexander-yevsyukov merged 16 commits into
masterfrom
claude/wonderful-hellman-f8ec72

alexander-yevsyukov commented Jul 5, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

codecov Bot commented Jul 5, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

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

Uh oh!

What

Why

How it works

Tests

Notes for reviewers

Bundled maintenance

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

codecov Bot commented Jul 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alexander-yevsyukov commented Jul 5, 2026 •

edited

Loading

codecov Bot commented Jul 5, 2026 •

edited

Loading