feat: report unique resources by rsynek · Pull Request #2779 · TimefoldAI/timefold-solver

rsynek · 2026-10-26T13:49:32Z

Fixes https://github.com/TimefoldAI/timefold-solver-enterprise/issues/930.

An alternative to #2769.

mswiderski

nice work, especially around the Resolver

Copilot

🟡 Changes recommended

The immutable image list breaks descriptor generation, and valid input structures can produce missing or incorrect resource paths.

5 open issues

What changed in this PR

This PR adds unique-resource metadata to service model descriptors. It derives resource types and JSONPath expressions from model-input annotations for downstream resource reporting.

Changes:

Adds @UniqueResourceId and descriptor storage for resource types and paths.
Integrates build-time path discovery into Quarkus descriptor generation.
Adds resolver tests and an end-to-end descriptor test.

File	Description
`service/definition/src/main/java/ai/timefold/solver/service/definition/api/ModelDescriptor.java`	Stores and copies resource metadata; changes collection defaults.
`service/definition/src/main/java/ai/timefold/solver/service/definition/api/usage/UniqueResourceId.java`	Defines the resource-ID annotation.
`service/definition/src/main/java/ai/timefold/solver/service/definition/internal/descriptor/usage/UniqueResource.java`	Pairs a resource type with its JSONPath.
`service/quarkus/deployment/src/main/java/ai/timefold/solver/service/quarkus/deployment/TimefoldModelDescriptorProcessor.java`	Adds resource metadata during descriptor generation.
`service/quarkus/deployment/src/main/java/ai/timefold/solver/service/quarkus/deployment/descriptor/ResourceIdPathResolver.java`	Traverses indexed input fields to derive resource paths.
`service/quarkus/deployment/src/test/java/ai/timefold/solver/service/quarkus/deployment/ModelDescriptorUniqueResourcesTest.java`	Checks generated descriptor resource entries.
`service/quarkus/deployment/src/test/java/ai/timefold/solver/service/quarkus/deployment/descriptor/UniqueResourceIdPathResolverTest.java`	Tests traversal, field annotations, and blank resource types.
`service/quarkus/deployment/src/test/java/ai/timefold/solver/service/quarkus/deployment/testdata/uniqueresource/TestdataVisit.java`	Provides an annotated visit ID.
`service/quarkus/deployment/src/test/java/ai/timefold/solver/service/quarkus/deployment/testdata/uniqueresource/TestdataVehicle.java`	Provides an annotated vehicle ID and nested visits.
`service/quarkus/deployment/src/test/java/ai/timefold/solver/service/quarkus/deployment/testdata/uniqueresource/TestdataSolution.java`	Provides the test model input structure.
`service/quarkus/deployment/src/test/java/ai/timefold/solver/service/quarkus/deployment/testdata/uniqueresource/TestdataRest.java`	Supplies the test model REST interface.
`service/quarkus/deployment/src/test/java/ai/timefold/solver/service/quarkus/deployment/testdata/uniqueresource/TestdataConstraintProvider.java`	Supplies a constraint for the test deployment.

_{Review effort: Balanced}

timefold-automations · 2026-10-27T13:56:59Z

This pull request, as it stands, would leave the Solver documentation stale in the places below. An automated check found them and can be wrong.

Code change: TimefoldAI/timefold-solver, service/definition/src/main/java/ai/timefold/solver/service/definition/preview/api/usage/UniqueResourceId.java:1-19 — adds the preview @UniqueResourceId annotation and its required type() element (added public API).
Docs location: no mention found in timefold-solver/docs/src/modules/ROOT/.
Confidence: high.
Suggested edit: add a section to pages/deploying-to-platform/model-metadata.adoc that explains how to annotate resource ID fields:

[#_unique_resource_ids]
== Unique resource IDs

Annotate each resource identifier that must be unique within its resource type with `@UniqueResourceId` from `ai.timefold.solver.service.definition.preview.api.usage`.

[source,java,options="nowrap"]
----
@UniqueResourceId(type = "vehicle")
private String id;
----

Code change: TimefoldAI/timefold-solver, service/definition/src/main/java/ai/timefold/solver/service/definition/api/ModelDescriptor.java:70, 280-288 — adds the public uniqueResources property and its getUniqueResources()/setUniqueResources(...) accessors, exposing resource types and JSONPath expressions in generated service metadata (added public API).
Docs location: no mention found in timefold-solver/docs/src/modules/ROOT/.
Confidence: high.
Suggested edit: in the same section, document the generated metadata:

The generated model descriptor exposes these resources through `uniqueResources`.
Each entry contains `resourceType` and `resourceIdJsonPath`, such as `vehicle` and `$.vehicles[*].id`.

The fix goes into this timefold-solver pull request. A new commit on the branch updates this comment, and drift that is still there when the group merges gets a docs pull request against main.

Generated by Solver Docs Drift Review · copilot · gpt56 · 11 AIC · ⌖ 3.86 AIC · ⊞ 25.2K · ◷

Copilot

🟡 Changes recommended

Multidimensional arrays produce incorrect resource paths, causing resource IDs to be missed.

2 open issues

4 resolved since last review

_{Review effort: Balanced}

Copilot

🟡 Changes recommended

Resource ID discovery can silently miss IDs in application-defined containers due to the class loader choice and in renamed fields because special property names are not correctly quoted and escaped.

2 open issues

1 resolved since last review

Preserve all wildcard dimensions for multidimensional arrays

_{Review effort: Balanced}

Copilot

🟡 Changes recommended

Resource ID resolution can miss IDs or select unrelated values because special JSON property names use unsafe dot notation and application-defined collections are misclassified during Quarkus augmentation.

2 open issues

1 resolved since last review

Use the application class loader to detect container types

_{Review effort: Balanced}

Copilot

🔵 Needs a closer look

Human assessment is needed to evaluate an edge case where concrete collection subtypes are inspected as containers, causing annotated element IDs to be omitted from descriptors.

1 open issue

Resolve Jackson annotations from complete property accessors

1 resolved since last review

Dot notation misreads field names containing dots or wildcards

_{Review effort: Balanced}

rsynek · 2026-11-02T14:34:36Z

The downstream failure is addressed by #2798.

Copilot

🟢 Approval recommended

No active review issues are reported for the unique-resource metadata changes.

1 open issue

Resolve Jackson annotations from complete property accessors

_{Review effort: Balanced}

rsynek requested a review from mswiderski October 26, 2026 13:49

rsynek temporarily deployed to internal October 26, 2026 13:49 — with GitHub Actions Inactive

rsynek commented Oct 26, 2026

View reviewed changes

Comment thread ...t/java/ai/timefold/solver/service/quarkus/deployment/ModelDescriptorUniqueResourcesTest.java Resolved

mswiderski reviewed Oct 27, 2026

View reviewed changes

rsynek force-pushed the feat/json-path-resource-reporting branch from 7668b6b to 41b2343 Compare October 27, 2026 13:44

rsynek temporarily deployed to internal October 27, 2026 13:44 — with GitHub Actions Inactive

rsynek marked this pull request as ready for review October 27, 2026 13:45

rsynek requested a review from a team October 27, 2026 13:45

rsynek requested a review from triceo as a code owner October 27, 2026 13:45

Copilot AI balanced review requested due to automatic review settings October 27, 2026 13:45

rsynek mentioned this pull request Oct 27, 2026

feat: report unique resource IDs #2769

Closed

Copilot started reviewing on behalf of rsynek October 27, 2026 13:45

View session

Copilot AI reviewed Oct 27, 2026

View reviewed changes

rsynek force-pushed the feat/json-path-resource-reporting branch from 41b2343 to 060e71e Compare October 27, 2026 16:07

Copilot AI balanced review requested due to automatic review settings October 27, 2026 16:07

rsynek temporarily deployed to internal October 27, 2026 16:07 — with GitHub Actions Inactive

Copilot started reviewing on behalf of rsynek October 27, 2026 16:08

View session

Copilot AI reviewed Oct 27, 2026

View reviewed changes

Comment thread ...in/java/ai/timefold/solver/service/quarkus/deployment/descriptor/ResourceIdPathResolver.java Resolved

mswiderski approved these changes Oct 27, 2026

View reviewed changes

triceo reviewed Nov 2, 2026

View reviewed changes

Comment thread .../src/main/java/ai/timefold/solver/service/definition/preview/api/usage/UniqueResourceId.java Resolved

rsynek force-pushed the feat/json-path-resource-reporting branch from 060e71e to c64bb63 Compare November 2, 2026 13:47

Copilot AI balanced review requested due to automatic review settings November 2, 2026 13:47

rsynek temporarily deployed to internal November 2, 2026 13:47 — with GitHub Actions Inactive

Copilot started reviewing on behalf of rsynek November 2, 2026 13:47

View session

Copilot AI reviewed Nov 2, 2026

View reviewed changes

Comment thread ...in/java/ai/timefold/solver/service/quarkus/deployment/descriptor/ResourceIdPathResolver.java Resolved

rsynek force-pushed the feat/json-path-resource-reporting branch from c64bb63 to 9807fbd Compare November 2, 2026 13:59

Copilot AI balanced review requested due to automatic review settings November 2, 2026 13:59

rsynek temporarily deployed to internal November 2, 2026 13:59 — with GitHub Actions Inactive

Copilot started reviewing on behalf of rsynek November 2, 2026 13:59

View session

rsynek temporarily deployed to internal November 2, 2026 14:03 — with GitHub Actions Inactive

Copilot AI reviewed Nov 2, 2026

View reviewed changes

Comment thread ...in/java/ai/timefold/solver/service/quarkus/deployment/descriptor/ResourceIdPathResolver.java Resolved

Copilot AI balanced review requested due to automatic review settings November 2, 2026 14:05

Copilot started reviewing on behalf of rsynek November 2, 2026 14:05

View session

Copilot AI reviewed Nov 2, 2026

View reviewed changes

rsynek added 7 commits November 2, 2026 17:05

feat: report unique resources

c3a4f50

address review comments

05d058f

address review comments

d6bf7ef

move UniqueResourceId to preview.api package

217efdc

normalize line endings in mvnw.cmd

99ad48c

support multi-dimensional arrays

f15e706

use context classloader

a331792

rsynek force-pushed the feat/json-path-resource-reporting branch from 814dc13 to a331792 Compare November 2, 2026 16:05

Copilot AI balanced review requested due to automatic review settings November 2, 2026 16:05

rsynek temporarily deployed to internal November 2, 2026 16:05 — with GitHub Actions Inactive

Copilot started reviewing on behalf of rsynek November 2, 2026 16:06

View session

Copilot AI reviewed Nov 2, 2026

View reviewed changes

triceo added this to the v2.9.0-rc-1 milestone Nov 3, 2026

triceo merged commit c712cc0 into TimefoldAI:main Nov 3, 2026
39 checks passed

timefold-automations Bot mentioned this pull request Nov 3, 2026

docs: [docs-drift] feat/json-path-resource-reporting #2802

Closed

Conversation

rsynek commented Oct 26, 2026

Uh oh!

Uh oh!

mswiderski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timefold-automations Bot commented Oct 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🔵 Needs a closer look

Uh oh!

rsynek commented Nov 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

timefold-automations Bot commented Oct 27, 2026 •

edited

Loading