Fixes #25434: allow empty Kafka schema registry suffix by himanshu748 · Pull Request #27496 · open-metadata/OpenMetadata

himanshu748 · 2026-04-17T18:27:16Z

Describe your changes:

Kafka schema registries sometimes do not use a topic suffix (e.g. -value). The UI connection form currently restores the schema default (-value) when the field is cleared, making it impossible to persist an explicitly empty suffix.

This change sets ui:emptyValue for schemaRegistryTopicSuffixName on the Kafka connection form so a cleared input is submitted as an explicit empty string.

Testing

Unit: MessagingServiceUtils config includes ui:emptyValue override for Kafka.

Type of change:

Bug fix

Checklist:

I have read the CONTRIBUTING document.

Hackathon / AI disclosure

Built with Cursor (AI-assisted) and manually reviewed.

Made with Cursor

Allow saving an explicit empty schemaRegistryTopicSuffixName in the Kafka connection form by using rjsf ui:emptyValue, preventing the schema default (-value) from being restored. Made-with: Cursor

github-actions · 2026-04-17T18:27:47Z

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

Enables Kafka connection forms to persist an explicitly empty schemaRegistryTopicSuffixName by configuring the RJSF UI schema to submit an empty string (instead of omitting the field and re-applying the schema default).

Changes:

Add a Kafka-specific uiSchema override setting ui:emptyValue for schemaRegistryTopicSuffixName.
Add unit tests for getMessagingConfig covering Kafka and other messaging connector types.

Reviewed changes

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

File	Description
`openmetadata-ui/src/main/resources/ui/src/utils/MessagingServiceUtils.ts`	Adds `ui:emptyValue` override for Kafka so clearing the suffix field persists as `''`.
`openmetadata-ui/src/main/resources/ui/src/utils/MessagingServiceUtils.test.ts`	Adds unit coverage asserting the Kafka config includes the `ui:emptyValue` override.

Comments suppressed due to low confidence (1)

openmetadata-ui/src/main/resources/ui/src/utils/MessagingServiceUtils.ts:60

schemaRegistryTopicSuffixName also exists in the Redpanda connection schema with the same default of "-value" (see openmetadata-spec/.../redpandaConnection.json). With the current change, Redpanda users will likely still be unable to persist an explicitly empty suffix for the same reason Kafka was affected. Consider applying the same ui:emptyValue: '' override for MessagingServiceType.Redpanda (and updating the corresponding test expectation) so behavior is consistent across messaging connectors that expose this field.

  switch (type) {
    case MessagingServiceType.Kafka:
      schema = kafkaConnection;
      /**
       * By default, rjsf may treat an empty text input as `undefined` and omit the field
       * from the submitted payload. Since the Kafka connection schema has a default
       * `schemaRegistryTopicSuffixName` of "-value", omitting the field causes the
       * value to be restored to the default after saving.
       *
       * Setting `ui:emptyValue` ensures a cleared input is persisted as an explicit
       * empty string.
       */
      Object.assign(uiSchema, {
        schemaRegistryTopicSuffixName: { 'ui:emptyValue': '' },
      });

      break;

    case MessagingServiceType.Redpanda:
      schema = redpandaConnection;

Copilot · 2026-04-17T18:31:42Z

+  it('getMessagingConfig should return correct config for Redpanda connector', () => {
+    const config = getMessagingConfig(MessagingServiceType.Redpanda);
+
+    expect(config).toEqual({
+      schema: { ...redpandaConnection },
+      uiSchema: { ...COMMON_UI_SCHEMA },


This test currently asserts Redpanda returns the unmodified COMMON_UI_SCHEMA. If you extend the ui:emptyValue fix to MessagingServiceType.Redpanda (recommended since Redpanda also defaults schemaRegistryTopicSuffixName to "-value"), update this expectation to include the override as well; otherwise the test will lock in the inconsistent behavior.

Suggested change

it('getMessagingConfig should return correct config for Redpanda connector', () => {

const config = getMessagingConfig(MessagingServiceType.Redpanda);

expect(config).toEqual({

schema: { ...redpandaConnection },

uiSchema: { ...COMMON_UI_SCHEMA },

it('getMessagingConfig should return correct config for Redpanda connector and preserve empty schema suffix', () => {

const config = getMessagingConfig(MessagingServiceType.Redpanda);

expect(config).toEqual({

schema: { ...redpandaConnection },

uiSchema: {

...COMMON_UI_SCHEMA,

schemaRegistryTopicSuffixName: { 'ui:emptyValue': '' },

},

himanshu748 · 2026-04-17T18:41:57Z

Hi! This PR is ready for CI. Could a maintainer please add the label so the workflows can run? (Currently failing at the label gate.) Thanks!

himanshu748 · 2026-04-17T18:42:04Z

Hi! This PR is ready for CI. Could a maintainer please add the safe to test label so the workflows can run? (They currently fail at the PR-label gate.) Thanks!

Apply the same rjsf ui:emptyValue override used for Kafka to Redpanda, since the connection schema defines the same default (-value). Made-with: Cursor

himanshu748 · 2026-04-17T18:42:48Z

Addressed Copilot review suggestion: applied the same override to Redpanda as well (schema has the same default ).

himanshu748 · 2026-04-17T18:42:52Z

Addressed Copilot review suggestion: applied the same ui:emptyValue: '' override to Redpanda as well (schema has the same default -value).

github-actions · 2026-04-17T18:43:10Z

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!

Made-with: Cursor

himanshu748 · 2026-04-17T18:47:37Z

Gitar suggestion addressed: added a brief comment explaining why the Redpanda override exists (same rationale as Kafka).

himanshu748 · 2026-04-17T18:47:41Z

Gitar suggestion addressed: added a brief comment explaining why the Redpanda ui:emptyValue override exists (same rationale as Kafka).

github-actions · 2026-04-17T18:47:56Z

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!

gitar-bot · 2026-04-17T18:48:53Z

Code Review ✅ Approved 1 resolved / 1 findings

Allows an empty Kafka schema registry suffix to resolve configuration constraints. Added an explanatory comment to the Redpanda case to match existing documentation.

✅ 1 resolved

✅ Quality: Redpanda case missing explanatory comment unlike Kafka case

📄 openmetadata-ui/src/main/resources/ui/src/utils/MessagingServiceUtils.ts:61-63
The Kafka case (lines 44-55) has a detailed comment explaining why ui:emptyValue is needed, but the identical Redpanda case (lines 61-63) added in this commit has no comment. Since the rationale is the same, a brief comment (or extracting the shared logic) would help future maintainers understand why this override exists for Redpanda too.

Options

Display: compact → Showing less information.

Comment with these commands to change:

`Compact`
`gitar display:verbose`

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

Copilot

Pull request overview

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

Fixes open-metadata#25434: preserve empty Kafka schema registry suffix

ee3dd5b

Allow saving an explicit empty schemaRegistryTopicSuffixName in the Kafka connection form by using rjsf ui:emptyValue, preventing the schema default (-value) from being restored. Made-with: Cursor

himanshu748 requested a review from a team as a code owner April 17, 2026 18:27

Copilot AI review requested due to automatic review settings April 17, 2026 18:27

Copilot started reviewing on behalf of himanshu748 April 17, 2026 18:27 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

Improve: preserve empty schema registry suffix for Redpanda

6bec9fe

Apply the same rjsf ui:emptyValue override used for Kafka to Redpanda, since the connection schema defines the same default (-value). Made-with: Cursor

gitar-bot bot reviewed Apr 17, 2026

View reviewed changes

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

Docs: explain Redpanda empty suffix override

ab6f35f

Made-with: Cursor

Copilot AI review requested due to automatic review settings April 17, 2026 18:47

Copilot started reviewing on behalf of himanshu748 April 17, 2026 18:48 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

Conversation

himanshu748 commented Apr 17, 2026

Describe your changes:

Type of change:

Checklist:

Hackathon / AI disclosure

Uh oh!

github-actions bot commented Apr 17, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

himanshu748 commented Apr 17, 2026

Uh oh!

himanshu748 commented Apr 17, 2026

Uh oh!

himanshu748 commented Apr 17, 2026

Uh oh!

himanshu748 commented Apr 17, 2026

Uh oh!

github-actions bot commented Apr 17, 2026

Uh oh!

Uh oh!

himanshu748 commented Apr 17, 2026

Uh oh!

himanshu748 commented Apr 17, 2026

Uh oh!

github-actions bot commented Apr 17, 2026

Uh oh!

gitar-bot bot 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gitar-bot bot commented Apr 17, 2026 •

edited

Loading