feat: report unique resource IDs by rsynek · Pull Request #2769 · TimefoldAI/timefold-solver

rsynek · 2026-10-21T11:24:24Z

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

The PR covers resource reporting for standard operations.

POST compute or solve
POST score analysis

Also model-specific operations are covered by exposing the UniqueResourceReporter bean to send the data.

Related:
https://github.com/TimefoldAI/timefold-solver-enterprise/pull/948

Copilot

🟡 Changes recommended

Reporter exceptions can mark valid datasets as failed and prevent normal completion.

1 open issue

Reporter failures incorrectly fail completed dataset operations · New

What changed in this PR

Adds unique resource ID reporting to the service layer for usage metering.

Changes:

Adds resource collection and reporting APIs.
Reports resources after worker output computation.
Adds event definitions and tests for resource collection behavior.

File	Description
service/worker/src/main/java/ai/timefold/solver/service/worker/impl/SolverWorker.java	Reports resources after computation.
service/definition/src/test/java/ai/timefold/solver/service/definition/api/usage/UniqueResourcesTest.java	Tests deduplication, immutability, builders and JSON.
service/definition/src/main/java/ai/timefold/solver/service/definition/internal/events/UniqueResourceReportEvent.java	Adds the resource reporting event.
service/definition/src/main/java/ai/timefold/solver/service/definition/internal/events/SolverChannels.java	Defines the reporting channel.
service/definition/src/main/java/ai/timefold/solver/service/definition/internal/events/AbstractEvent.java	Permits the new event type.
service/definition/src/main/java/ai/timefold/solver/service/definition/api/usage/UniqueResources.java	Stores immutable, deduplicated resource IDs.
service/definition/src/main/java/ai/timefold/solver/service/definition/api/usage/UniqueResourceReporter.java	Defines reporting methods.
service/definition/src/main/java/ai/timefold/solver/service/definition/api/usage/UniqueResourceAware.java	Lets models expose their resources.

_{Review effort: Balanced}

+            }
+
+            if (uniqueResources != null) {
+                uniqueResourceReporter.reportUniqueResources(OperationId.SCHEDULE, datasetId, uniqueResources);


Copilot

🟡 Changes recommended

Worker reporting and its fallback paths need regression tests before approval.

2 open issues

_{Review effort: Balanced}

                    extractOutputMetrics(solverModel));

+            // We report the unique resources once we compute the outputs of the valid dataset.
+            reportUniqueResources(id, solverModel);


timefold-automations · 2026-10-21T11:34:38Z

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

Code change: timefold-solver, service/definition/src/main/java/ai/timefold/solver/service/definition/api/usage/UniqueResources.java:13 (and the added UniqueResourceAware.java:6 and UniqueResourceReporter.java:6) — added public usage-metering API types, including UniqueResources.from, UniqueResources.builder, UniqueResourceAware#getUniqueResources, and UniqueResourceReporter#reportUniqueResources.
Docs location: no mention found under docs/src/modules/ROOT/pages/.
Confidence: high.
Suggested edit: Add a short service-specific section, for example to pages/running-timefold-solver/service/overview.adoc:

[#uniqueResourceReporting]
== Reporting unique resources

A service model can implement `UniqueResourceAware` to identify the unique resources used by an operation:

[source,java]
----
public class EmployeeSchedule implements UniqueResourceAware {
    @Override
    public UniqueResources getUniqueResources() {
        return UniqueResources.from("employee", employeeIds);
    }
}
----

Use the injected `UniqueResourceReporter` to report resources for model-specific operations. Use `UniqueResources.builder()` when a model has multiple resource types.

The documentation fix belongs in this 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.3 AIC · ⌖ 2.99 AIC · ⊞ 25.2K · ◷

mswiderski · 2026-10-22T06:06:20Z

+/**
+ * Contains IDs of unique resources identified by the optimization model.
+ */
+public record UniqueResources(Map<String, Collection<String>> uniqueResourceIdsPerType) {


just a thought, would it be easier to have UniqueResources(String type, Collection<String> uniqueResourceIds) and then we could have collection of it? Bit better from type perspective - having map by unknown keys might bite us soon.

In addition, since the issue says there should be one billable at the moment - how do we know that? will this come from here or?

mswiderski · 2026-10-22T06:07:12Z

            storageService.storeSolution(id, modelOutput, metadata, extractInputMetrics(solverModel),
                    extractOutputMetrics(solverModel));

+            // We report the unique resources once we compute the outputs of the valid dataset.


the document says we should only do this on successful runs - what would it do when compute is fine and then the solving fails?

rsynek · 2026-10-27T13:45:52Z

Closing in favor of #2779

rsynek requested review from a team, cristianonicolai and mswiderski and a balanced review from Copilot October 21, 2026 11:24

rsynek requested a review from triceo as a code owner October 21, 2026 11:24

rsynek temporarily deployed to internal October 21, 2026 11:24 — with GitHub Actions Inactive

Copilot started reviewing on behalf of rsynek October 21, 2026 11:24

View session

feat: report unique resource IDs

3c82c2e

rsynek force-pushed the feat/unique-entity-metering branch from 93c9a7d to 3c82c2e Compare October 21, 2026 11:26

rsynek temporarily deployed to internal October 21, 2026 11:26 — with GitHub Actions Inactive

Copilot AI reviewed Oct 21, 2026

View reviewed changes

Comment thread service/worker/src/main/java/ai/timefold/solver/service/worker/impl/SolverWorker.java

}

if (uniqueResources != null) {

uniqueResourceReporter.reportUniqueResources(OperationId.SCHEDULE, datasetId, uniqueResources);

Copilot AI balanced review requested due to automatic review settings October 21, 2026 11:28

Copilot started reviewing on behalf of rsynek October 21, 2026 11:29

View session

Copilot AI reviewed Oct 21, 2026

View reviewed changes

Comment thread service/worker/src/main/java/ai/timefold/solver/service/worker/impl/SolverWorker.java

extractOutputMetrics(solverModel));

// We report the unique resources once we compute the outputs of the valid dataset.

reportUniqueResources(id, solverModel);

mswiderski reviewed Oct 22, 2026

View reviewed changes

rsynek mentioned this pull request Oct 26, 2026

feat: report unique resources #2779

Merged

rsynek closed this Oct 27, 2026

Navigation Menu

Repository navigation

feat: report unique resource IDs - #2769

feat: report unique resource IDs#2769
rsynek wants to merge 1 commit into
TimefoldAI:mainfrom
rsynek:feat/unique-entity-metering

rsynek commented Oct 21, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

timefold-automations Bot commented Oct 21, 2026

Uh oh!

mswiderski Oct 22, 2026

Uh oh!

mswiderski Oct 22, 2026

Uh oh!

rsynek commented Oct 27, 2026

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

rsynek commented Oct 21, 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!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

timefold-automations Bot commented Oct 21, 2026

Uh oh!

mswiderski Oct 22, 2026

Choose a reason for hiding this comment

Uh oh!

mswiderski Oct 22, 2026

Choose a reason for hiding this comment

Uh oh!

rsynek commented Oct 27, 2026

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rsynek commented Oct 21, 2026 •

edited

Loading