Fixes #25434: Preserve empty string for Kafka schemaRegistryTopicSuffixName by RajdeepKushwaha5 · Pull Request #27015 · open-metadata/OpenMetadata

RajdeepKushwaha5 · 2026-04-03T08:42:18Z

Describe your changes:

What changes did you make?

When editing a Kafka or Redpanda connection, clearing the schemaRegistryTopicSuffixName field to an empty string reverts it to the schema default "-value" after saving. This prevents users whose Kafka schema registry does not use topic suffixes from configuring the connection correctly.

Root cause: RJSF (React JSON Schema Form) converts empty text inputs to undefined, which removes the field from formData. During the connection update merge, the old value ("-value") is preserved via object spread from the existing config. The backend never receives the empty string.

Fix: Added 'ui:emptyValue': '' to the RJSF uiSchema for the schemaRegistryTopicSuffixName field in both Kafka and Redpanda connection configs. This instructs RJSF to use an empty string ("") instead of undefined when the user clears the field, so the empty value is properly included in the form data and sent to the backend.

How did you test your changes?

Added unit tests in MessagingServiceUtils.test.ts verifying:
- Kafka uiSchema includes ui:emptyValue: "" for schemaRegistryTopicSuffixName
- Redpanda uiSchema includes ui:emptyValue: "" for schemaRegistryTopicSuffixName
- Non-broker services (e.g. Kinesis) do NOT include this override
- Invalid service types return only the common UI schema
All 4 tests pass
ESLint and Prettier checks pass

Files changed:

openmetadata-ui/src/main/resources/ui/src/utils/MessagingServiceUtils.ts — Added SCHEMA_REGISTRY_SUFFIX_UI_SCHEMA constant with ui:emptyValue and applied it to Kafka/Redpanda cases
openmetadata-ui/src/main/resources/ui/src/utils/MessagingServiceUtils.test.ts — New test file covering the fix

Type of change:

Bug fix

Checklist:

I have read the CONTRIBUTING document.
My PR title is Fixes <issue-number>: <short explanation>
I have commented on my code, particularly in hard-to-understand areas.
For JSON Schema changes: I updated the migration scripts or explained why it is not needed.

I have added a test that covers the exact scenario we are fixing. For complex issues, comment the issue number in the test for future reference.

Summary by Gitar

Refactor:
- Updated import path for COMMON_UI_SCHEMA to point to ServiceUISchema.constant.
Code Quality:
- Improved retVal return logic in MessagingServiceUtils.ts to handle undefined checks more explicitly.

_{This will update automatically on new commits.}

…stryTopicSuffixName

github-actions · 2026-04-03T08:42:44Z

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

Copilot

Pull request overview

This PR fixes an OpenMetadata UI bug where clearing schemaRegistryTopicSuffixName in Kafka/Redpanda connections could not be persisted because RJSF converted an empty string input to undefined, causing the backend update merge to retain the prior/default value.

Changes:

Add an RJSF ui:emptyValue: '' override for schemaRegistryTopicSuffixName in Kafka and Redpanda messaging connection UI schemas.
Add unit tests to verify the override is present for Kafka/Redpanda, absent for non-broker services, and that invalid service types return only the common UI schema.

Reviewed changes

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

File	Description
openmetadata-ui/src/main/resources/ui/src/utils/MessagingServiceUtils.ts	Extends Kafka/Redpanda `uiSchema` to preserve empty string values for `schemaRegistryTopicSuffixName` via `ui:emptyValue`.
openmetadata-ui/src/main/resources/ui/src/utils/MessagingServiceUtils.test.ts	Adds focused unit tests validating the new uiSchema behavior across service types and default handling.

github-actions · 2026-04-11T16:36:33Z

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

RajdeepKushwaha5 · 2026-04-17T00:53:44Z

Bug #25434 — Kafka schemaRegistryTopicSuffixName cannot be cleared

Running vanilla OpenMetadata 1.11.7 in Docker (docker.getcollate.io/openmetadata/server:1.11.7). I create a Kafka messaging service with schemaRegistryTopicSuffixName = -value, then edit the connection, clear the field, and save. On re-opening the Edit Connection dialog, the field still shows -value — the clear silently failed.

Root cause: the RJSF uiSchema for Kafka/Redpanda has no ui:emptyValue hint, so RJSF treats the empty string as undefined and omits the field from the PATCH payload. The backend never receives the update and keeps the stale value.

kafkabug.mp4

RajdeepKushwaha5 · 2026-04-17T00:57:58Z

Fix #25434 — PR #27015

Same Docker backend (OpenMetadata 1.11.7) — only the UI layer is swapped for the Vite dev server running this branch. The fix adds { 'ui:emptyValue': '' } to the uiSchema for schemaRegistryTopicSuffixName on both Kafka and Redpanda messaging services (MessagingServiceUtils.ts .

I repeat the same flow from Video 1: open the existing Kafka service, clear the field, save, and re-open. The field is now correctly empty — RJSF submits "" instead of dropping the property, so the backend persists the clear.

Coverage: 4 new Jest tests in MessagingServiceUtils.test.ts — 2 positive (Kafka + Redpanda get the emptyValue hint) and 2 negative regression guards (Kinesis and invalid types don't). All 4 pass.

kafkafix.mp4

Missing playwright coverage

aniketkatkar97 · 2026-04-17T05:29:35Z

Hey @RajdeepKushwaha5, Awesome work. Can we also add playwright coverage for the same? I think you can just add the test case in existing ServiceForm.spec.ts.

github-actions · 2026-04-17T05:49:32Z

Jest test Coverage

UI tests summary

Lines	Statements	Branches	Functions
	63.32% (59296/93638)	43.61% (31452/72106)	46.49% (9436/20293)

…xName (open-metadata#25434) Adds a regression test in ServiceForm.spec.ts that creates a Kafka messaging service with schemaRegistryTopicSuffixName='-value', clears the field in the edit-connection form, and asserts the PATCH payload carries an explicit empty string and that the cleared value persists on reload. Addresses review feedback on PR open-metadata#27015 requesting Playwright coverage.

RajdeepKushwaha5 · 2026-04-17T07:10:20Z

Hey @RajdeepKushwaha5, Awesome work. Can we also add playwright coverage for the same? I think you can just add the test case in existing ServiceForm.spec.ts.

Thanks for the review, @aniketkatkar97! I've pushed 7a63739 adding a Playwright regression test to ServiceForm.spec.ts under a new Kafka describe block, right next to the existing Superset / Looker suites.

The test covers the exact user flow from the bug report:

Creates a Kafka messaging service via API with schemaRegistryTopicSuffixName: '-value'
Opens the service → Connection tab → Edit Connection.
Clears the schemaRegistryTopicSuffixName field.
Intercepts the PATCH /api/v1/services/messagingServices request and asserts the JSON Patch body contains an op at /connection/config/schemaRegistryTopicSuffixName with value: "" — this is what actually proves the fix (without 'ui:emptyValue': '', RJSF would drop the field entirely and this assertion would fail).
Reopens the edit form and asserts the field stays empty, confirming the backend persisted the clear.
Cleans up the service via API in afterAll.
Together with the existing Jest tests (which assert the uiSchema shape), this now locks in the behaviour end-to-end. Let me know if you'd like any tweaks to the selectors or if you'd prefer the service setup done through the UI instead of the API helper — happy to adjust!

Copilot

Pull request overview

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

Copilot · 2026-04-17T07:12:40Z

+    // Regression coverage for issue #25434 (PR #27015):
+    // Clearing `schemaRegistryTopicSuffixName` on a Kafka connection must
+    // send an empty string to the backend instead of dropping the field,
+    // so the cleared value is persisted on reload.
+    test.describe('Kafka', () => {


The PR description’s “Files changed” list omits this Playwright spec update. Please update the PR description to include openmetadata-ui/src/main/resources/ui/playwright/e2e/Flow/ServiceForm.spec.ts so reviewers/maintainers can see the added E2E regression coverage at a glance.

Copilot

Pull request overview

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

…a.constant per Copilot review

…ty-suffix-name

gitar-bot · 2026-04-20T10:15:47Z

Code Review ✅ Approved

Explicitly preserves empty strings for the Kafka schemaRegistryTopicSuffixName configuration. No issues found.

Options

Display: compact → Showing less information.

Comment with these commands to change:

`Compact`
`gitar display:verbose`

_{Was this helpful? React with 👍 / 👎 | Gitar}

sonarqubecloud · 2026-04-20T10:43:30Z

Quality Gate passed for 'open-metadata-ui'

Issues
954 New issues
0 Accepted issues

Measures
14 Security Hotspots
0.0% Coverage on New Code
3.9% Duplication on New Code

See analysis details on SonarQube Cloud

…ixName (#27015) * Fixes #25434: Preserve empty string for Kafka schemaRegistryTopicSuffixName * test(e2e): add Playwright coverage for empty schemaRegistryTopicSuffixName (#25434) Adds a regression test in ServiceForm.spec.ts that creates a Kafka messaging service with schemaRegistryTopicSuffixName='-value', clears the field in the edit-connection form, and asserts the PATCH payload carries an explicit empty string and that the cleared value persists on reload. Addresses review feedback on PR #27015 requesting Playwright coverage. * style: apply prettier formatting to ServiceForm.spec.ts * style: drop PR number from regression comment per Copilot review * fix(test): import COMMON_UI_SCHEMA from non-deprecated ServiceUISchema.constant per Copilot review

aniketkatkar97 · 2026-04-21T05:38:01Z

Cherry-picked to 1.13

Fixes open-metadata#25434: Preserve empty string for Kafka schemaRegi…

7fb95cb

…stryTopicSuffixName

RajdeepKushwaha5 requested a review from a team as a code owner April 3, 2026 08:42

Copilot AI review requested due to automatic review settings April 3, 2026 08:42

Copilot started reviewing on behalf of RajdeepKushwaha5 April 3, 2026 08:42 View session

Copilot AI reviewed Apr 3, 2026

View reviewed changes

Merge branch 'main' into fix/25434-kafka-empty-suffix-name

9f7879b

RajdeepKushwaha5 mentioned this pull request Apr 17, 2026

Cannot set Kafka connection schemaRegistryTopicSuffixName parameter to an empty string #25434

Closed

aniketkatkar97 added the safe to test Add this label to run secure Github workflows on PRs label Apr 17, 2026

aniketkatkar97 previously approved these changes Apr 17, 2026

View reviewed changes

aniketkatkar97 had a problem deploying to test April 17, 2026 05:33 — with GitHub Actions Error

aniketkatkar97 temporarily deployed to test April 17, 2026 05:33 — with GitHub Actions Inactive

aniketkatkar97 had a problem deploying to test April 17, 2026 05:33 — with GitHub Actions Error

aniketkatkar97 temporarily deployed to test April 17, 2026 05:33 — with GitHub Actions Inactive

aniketkatkar97 had a problem deploying to test April 17, 2026 05:33 — with GitHub Actions Error

aniketkatkar97 temporarily deployed to test April 17, 2026 05:33 — with GitHub Actions Inactive

Copilot AI review requested due to automatic review settings April 17, 2026 07:09

Copilot started reviewing on behalf of RajdeepKushwaha5 April 17, 2026 07:09 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

aniketkatkar97 previously approved these changes Apr 17, 2026

View reviewed changes

RajdeepKushwaha5 had a problem deploying to test April 17, 2026 07:20 — with GitHub Actions Error

RajdeepKushwaha5 temporarily deployed to test April 19, 2026 20:40 — with GitHub Actions Inactive

RajdeepKushwaha5 had a problem deploying to test April 19, 2026 20:40 — with GitHub Actions Failure

RajdeepKushwaha5 temporarily deployed to test April 19, 2026 20:40 — with GitHub Actions Inactive

Merge branch 'main' into fix/25434-kafka-empty-suffix-name

e21116b

Copilot AI review requested due to automatic review settings April 20, 2026 08:42

Copilot started reviewing on behalf of RajdeepKushwaha5 April 20, 2026 08:42 View session

Copilot AI reviewed Apr 20, 2026

View reviewed changes

Comment thread openmetadata-ui/src/main/resources/ui/src/utils/MessagingServiceUtils.test.ts Outdated

RajdeepKushwaha5 temporarily deployed to test April 20, 2026 08:53 — with GitHub Actions Inactive

RajdeepKushwaha5 had a problem deploying to test April 20, 2026 08:53 — with GitHub Actions Error

RajdeepKushwaha5 temporarily deployed to test April 20, 2026 08:53 — with GitHub Actions Inactive

RajdeepKushwaha5 had a problem deploying to test April 20, 2026 08:53 — with GitHub Actions Error

RajdeepKushwaha5 added 2 commits April 20, 2026 15:36

fix(test): import COMMON_UI_SCHEMA from non-deprecated ServiceUISchem…

c45cee4

…a.constant per Copilot review

Merge remote-tracking branch 'upstream/main' into fix/25434-kafka-emp…

a39ca5b

…ty-suffix-name

RajdeepKushwaha5 temporarily deployed to test April 20, 2026 10:24 — with GitHub Actions Inactive

RajdeepKushwaha5 had a problem deploying to test April 20, 2026 10:24 — with GitHub Actions Failure

RajdeepKushwaha5 temporarily deployed to test April 21, 2026 02:04 — with GitHub Actions Inactive

aniketkatkar97 approved these changes Apr 21, 2026

View reviewed changes

aniketkatkar97 merged commit 2633b8d into open-metadata:main Apr 21, 2026
49 of 50 checks passed

Conversation

RajdeepKushwaha5 commented Apr 3, 2026 • edited by gitar-bot Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe your changes:

Type of change:

Checklist:

Summary by Gitar

Uh oh!

github-actions Bot commented Apr 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

github-actions Bot commented Apr 11, 2026

Uh oh!

RajdeepKushwaha5 commented Apr 17, 2026

Uh oh!

RajdeepKushwaha5 commented Apr 17, 2026

Uh oh!

aniketkatkar97 commented Apr 17, 2026

Uh oh!

github-actions Bot commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Jest test Coverage

UI tests summary

Uh oh!

RajdeepKushwaha5 commented Apr 17, 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

Pull request overview

Uh oh!

Copilot AI Apr 17, 2026

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!

Uh oh!

gitar-bot Bot commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud Bot commented Apr 20, 2026

Quality Gate passed for 'open-metadata-ui'

Uh oh!

Uh oh!

aniketkatkar97 commented Apr 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

RajdeepKushwaha5 commented Apr 3, 2026 •

edited by gitar-bot Bot

Loading

github-actions Bot commented Apr 17, 2026 •

edited

Loading

RajdeepKushwaha5 commented Apr 17, 2026 •

edited

Loading

gitar-bot Bot commented Apr 20, 2026 •

edited

Loading