feat(QTDI-2979): Add labelDisplayMode attribute to @Suggestable by thboileau · Pull Request #1238 · Talend/component-runtime

thboileau · 2026-06-05T15:44:52Z

Requirements

Any code change adding any logic MUST be tested through a unit test executed with the default build
Any API addition MUST be done with a documentation update if relevant

Why this PR is needed?

Jira: QTDI-2979 — Allow to configure how the labels are displayed for a suggestable field

When two or more @Suggestable options share the same label, the Studio user cannot distinguish between them. Selecting the wrong option leads to misconfigured jobs that may only fail at runtime, which is costly to debug.

This PR provides a TCK-level mechanism that allows component developers to declare that their suggestable field may have non-unique labels, so that the front-end can surface enough information for an unambiguous choice.

What does this PR adds (design/code thoughts)?

component-api — Suggestable.java

Adds an inner enum LabelDisplayMode with two constants:
- LABEL (default) — show option label only; no change for existing usages.
- LABEL_ID — show both label and identifier (e.g. Paris (fr-paris-01)); use when labels may not be unique.
Adds annotation attribute labelDisplayMode() defaulting to LabelDisplayMode.LABEL.

Serialisation (no change to ActionParameterEnricher)

The existing ActionParameterEnricher already serialises all annotation methods generically. The new attribute appears automatically in the component metadata map as:

tcomp::action::suggestions::labelDisplayMode = "LABEL"   // or "LABEL_ID"

No changes to component-server-model are required — SimplePropertyDefinition.metadata is already a Map<String, String>.

Tests — ActionParameterEnricherTest.java

Updated suggestion() test: asserts that the default value produces labelDisplayMode = "LABEL" in the serialised metadata.
New suggestionWithLabelId() test: asserts that setting labelDisplayMode = LABEL_ID produces labelDisplayMode = "LABEL_ID".

Backward compatibility

The attribute defaults to LABEL. All existing @Suggestable usages gain labelDisplayMode = LABEL in their metadata map — additive, transparent to consumers that do not know the key.

Out of scope

Studio rendering (separate future ticket)
BuiltInSuggestable — not affected
Documentation ticket (PO to open)

AI generated code

https://internal.qlik.dev/general/ways-of-working/code-reviews/#guidelines-for-ai-generated-code

this PR has been written with the help of GitHub Copilot or another generative AI tool

@suggestable

Add a LabelDisplayMode enum (LABEL, LABEL_ID) and a labelDisplayMode() annotation attribute to @suggestable. The attribute defaults to LABEL, preserving full backward compatibility. When two or more suggestions share the same label, setting labelDisplayMode = LABEL_ID allows the front-end to show both the label and the opaque identifier so the user can make an unambiguous choice (e.g. 'Paris (fr-paris-01)'). The value is serialised as tcomp::action::suggestions::labelDisplayMode in the component metadata map by the existing ActionParameterEnricher, with no changes to component-server-model required. Also includes Spotless reformatting of several pre-existing violations caught during mvn spotless:apply, and a .gitignore update for ai-commons tooling files. Co-Authored-By: GitHub Copilot <ai@noreply>

thboileau · 2026-06-05T15:47:06Z

🔍 Scope & Design Review — QTDI-2979

Round 1 — Final verdict: APPROVED

AC Coverage

AC	Requirement	Status
AC-1	`@Suggestable` gains optional `labelDisplayMode` attribute	✅ PASS
AC-2	Enum `LABEL` (default) + `LABEL_ID`	✅ PASS
AC-3	Declared in `component-api`, serialised via `ActionParameterEnricher`	✅ PASS
AC-4	Default `LABEL`, backward compatible — additive only	✅ PASS
AC-5	Front-ends can read from `metadata` map	✅ PASS

Edge cases — all clear

Null not possible for annotation attributes (Java guarantee).
Suggestable.LabelDisplayMode is a public inner enum — accessible to all callers.
Serialised value "LABEL" / "LABEL_ID" (uppercase) is consistent with codebase convention (BuiltInSuggestable.Name also uppercases).
Backward compat confirmed: existing @Suggestable usages gain labelDisplayMode=LABEL in their metadata map (additive, ignored by consumers that don't know the key).
Anonymous-class test pattern is consistent with all other tests in the file.

Findings

Severity	Finding	Action
(none)	—	—

Review performed by AI (GitHub Copilot). Scope and design decisions validated by Dev before implementation.

thboileau · 2026-06-05T15:47:20Z

✅ Compliance Check — QTDI-2979

Summary

Severity	Count
Critical (fixed)	0
Warning	0
Info	0

File-by-file findings

component-api/.../Suggestable.java

Rule	Status	Notes
No wildcard imports	✅ PASS	No new imports added
Javadoc on new `labelDisplayMode()`	✅ PASS	Has `@return` and description
Javadoc on `LabelDisplayMode` enum constants	✅ PASS	Both `LABEL` and `LABEL_ID` have Javadoc
No deprecation of existing API	✅ PASS	Purely additive
Spotless	✅ PASS	`mvn spotless:check` — no violations

component-runtime-manager/.../ActionParameterEnricherTest.java

Rule	Status	Notes
Test class naming (`Test` suffix)	✅ PASS	`ActionParameterEnricherTest`
Same package as production class	✅ PASS	Both `parameterenricher` package
No wildcard imports	✅ PASS	No new imports
UT coverage — new behaviour	✅ PASS	`suggestionWithLabelId()` covers `LABEL_ID`; `suggestion()` covers `LABEL` default
No TUJ required	✅ PASS	Purely additive schema change; no Studio-level integration risk identified
Spotless	✅ PASS	`mvn spotless:check` — no violations

Quality rules

Rule	Status
UT for every behaviour change	✅ PASS
TUJ scope check	N/A — no TUJ needed (UT-only scope confirmed)
DOC ticket	PO responsibility

Verdict: COMPLIANT — no Critical findings.

Compliance check performed by AI (GitHub Copilot).

Copilot

Pull request overview

This PR extends the public @Suggestable API with a labelDisplayMode attribute so UIs can disambiguate suggestions whose labels are not unique, and updates runtime metadata serialization expectations accordingly.

Changes:

Add Suggestable.LabelDisplayMode enum and labelDisplayMode() attribute (default LABEL) to component-api.
Update ActionParameterEnricherTest to assert labelDisplayMode is present in serialized suggestion metadata (including a new LABEL_ID case).
Apply minor formatting-only refactors across several modules and extend .gitignore for AI-related local artifacts.

Reviewed changes

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

Show a summary per file

File	Description
singer-parent/component-kitap/src/main/java/org/talend/sdk/component/singer/kitap/RecordJsonMapper.java	Formatting-only line wrapping in service initialization.
documentation/src/main/java/org/talend/runtime/documentation/Generator.java	Formatting-only line wrapping in exclusion list generation.
component-tools/src/test/java/org/talend/sdk/component/tools/ComponentValidatorTest.java	Formatting-only line wrapping in test utility.
component-runtime-testing/component-runtime-junit/src/main/java/org/talend/sdk/component/junit5/ComponentExtension.java	Formatting-only line wrapping in extension shutdown.
component-runtime-manager/src/test/java/org/talend/sdk/component/runtime/manager/service/RecordServiceImplTest.java	Formatting-only plus indentation adjustments in proxy/test setup.
component-runtime-manager/src/test/java/org/talend/sdk/component/runtime/manager/ReflectionServiceTest.java	Formatting-only line wrapping for readability.
component-runtime-manager/src/test/java/org/talend/sdk/component/runtime/manager/reflect/parameterenricher/ActionParameterEnricherTest.java	Updates expectations to include `labelDisplayMode` metadata and adds a `LABEL_ID` test.
component-runtime-manager/src/test/java/org/talend/sdk/component/runtime/manager/ConfigurationMigrationTest.java	Formatting-only line wrapping in test setup.
component-runtime-manager/src/test/java/org/talend/sdk/component/runtime/manager/ComponentManagerTest.java	Formatting-only line wrapping in environment configuration test.
component-runtime-manager/src/main/java/org/talend/sdk/component/runtime/manager/service/InjectorImpl.java	Formatting-only line wrapping for generic type extraction.
component-runtime-manager/src/main/java/org/talend/sdk/component/runtime/manager/reflect/ReflectionService.java	Formatting-only line wrapping in list/array construction path.
component-runtime-manager/src/main/java/org/talend/sdk/component/runtime/manager/reflect/ParameterModelService.java	Formatting-only indentation adjustments in annotation/parameter meta building.
component-runtime-manager/src/main/java/org/talend/sdk/component/runtime/manager/ComponentManager.java	Formatting-only line wrapping for parameter enricher context creation.
component-runtime-impl/src/test/java/org/talend/sdk/component/runtime/record/PluralRecordExtension.java	Formatting-only array initializer spacing.
component-runtime-impl/src/main/java/org/talend/sdk/component/runtime/reflect/Defaults.java	Formatting-only line wrapping in method-handle invocation handler setup.
component-api/src/main/java/org/talend/sdk/component/api/configuration/action/Suggestable.java	Adds `labelDisplayMode()` attribute + `LabelDisplayMode` enum to the public API.
.gitignore	Ignore local AI-tooling directories/files.

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

    @Test
    void suggestion() {
        assertEquals(new HashMap<String, String>() {

            {


sonar-rnd · 2026-06-08T15:23:55Z

Quality Gate passed

Issues

Measures

Project ID: org.talend.sdk.component:component-runtime

View in SonarQube

fix(QTDI-2979): apply spotless

96f42b7

thboileau requested a review from Copilot June 8, 2026 15:03

Copilot started reviewing on behalf of thboileau June 8, 2026 15:04 View session

thboileau requested a review from undx June 8, 2026 15:04

Copilot AI reviewed Jun 8, 2026

View reviewed changes

Comment thread ...end/sdk/component/runtime/manager/reflect/parameterenricher/ActionParameterEnricherTest.java

Comment on lines 155 to 159

@Test

void suggestion() {

assertEquals(new HashMap<String, String>() {

{

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(QTDI-2979): Add labelDisplayMode attribute to @Suggestable#1238

feat(QTDI-2979): Add labelDisplayMode attribute to @Suggestable#1238
thboileau wants to merge 2 commits into
masterfrom
copilot/QTDI-2979_suggestable_label_display_mode

thboileau commented Jun 5, 2026 •

edited by atlassian Bot

Loading

Uh oh!

thboileau commented Jun 5, 2026

Uh oh!

thboileau commented Jun 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

sonar-rnd Bot commented Jun 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

thboileau commented Jun 5, 2026 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Requirements

Why this PR is needed?

What does this PR adds (design/code thoughts)?

AI generated code

Uh oh!

thboileau commented Jun 5, 2026

🔍 Scope & Design Review — QTDI-2979

AC Coverage

Edge cases — all clear

Findings

Uh oh!

thboileau commented Jun 5, 2026

✅ Compliance Check — QTDI-2979

Summary

File-by-file findings

Quality rules

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

sonar-rnd Bot commented Jun 8, 2026

Quality Gate passed

Issues

Measures

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

thboileau commented Jun 5, 2026 •

edited by atlassian Bot

Loading