add style modal in Domains by siddhant1 · Pull Request #25011 · open-metadata/OpenMetadata

siddhant1 · 2025-12-31T07:02:24Z

Describe your changes:

Fixes

I worked on ... because ...

Type of change:

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.

Summary by Gitar

Component migration:
- Replaced StyleModal (Ant Design) with IconColorModal (MUI) in DomainDetails.component.tsx
Cover image support:
- Added optional includeCoverImage prop to IconColorModal for conditional cover image upload field
Architecture improvement:
- Uses prop-based feature flagging instead of runtime app detection for cleaner component design
Data transformation:
- Handles cover image position format conversion from nested {y: "50%"} to flat string "50%" for API compatibility

_{This will update automatically on new commits.}

github-actions · 2025-12-31T07:02:49Z

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!

github-actions · 2025-12-31T07:47:43Z

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!

github-actions · 2025-12-31T08:17:30Z

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!

github-actions · 2026-01-03T12:47:29Z

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!

github-actions · 2026-01-05T05:16: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!

github-actions · 2026-01-05T07:54:40Z

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!

github-actions · 2026-01-05T08:10:45Z

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!

github-actions · 2026-01-05T08:17:52Z

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!

github-actions · 2026-01-05T08:46:36Z

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!

github-actions · 2026-01-05T10:43:20Z

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-01-05T10:47:58Z

Wrapping up

Code Review ⚠️ Changes requested 4 resolved / 6 findings

Well-structured refactor to add cover image support for domain updates. One important issue with potential missing error rethrow in the new utility function's catch block.

⚠️

Edge Case: Missing error rethrow in updateEntityWithCoverImage catch block

📄 openmetadata-ui/src/main/resources/ui/src/utils/CoverImageUploadUtils.tsx:382-391

The updateEntityWithCoverImage function's catch block shows an error notification but the diff is truncated. Comparing with createEntityWithCoverImage (line 278-286), it includes throw error; after showing the notification. Ensure the new function also rethrows the error after the showNotistackError call to maintain consistent error propagation behavior.

If the error is not rethrown, callers won't know the operation failed and may proceed as if it succeeded. The inner upload error correctly throws (line 373), but the outer catch block at the end needs to also throw.

Suggested fix: Verify the catch block ends with throw error; similar to the existing createEntityWithCoverImage function.

💡 Quality: Redundant null check in coverImage position condition

📄 openmetadata-ui/src/main/resources/ui/src/utils/CoverImageUploadUtils.tsx:400-406

In the style object construction (lines 400-410), the condition coverImagePosition !== undefined && coverImagePosition !== null includes a redundant null check. Since coverImagePosition is typed as string | undefined (line 351), it cannot be null.

Current code:

...(coverImagePosition !== undefined &&
  coverImagePosition !== null && {
    position: coverImagePosition,
  }),

Suggested fix:

...(coverImagePosition !== undefined && {
  position: coverImagePosition,
}),

This is minor but improves code clarity by aligning the condition with the type.

✅ 4 resolved

✅ Edge Case: coverImage may be created with position but no URL

📄 openmetadata-ui/src/main/resources/ui/src/utils/CoverImageUploadUtils.tsx:384-392
The condition if (coverImageUrl || coverImagePosition) allows creating a coverImage object with only a position property when coverImageUrl is undefined but coverImagePosition has a value:\n\ntypescript\nif (coverImageUrl || coverImagePosition) {\n updatedStyle.coverImage = {\n ...(coverImageUrl && { url: coverImageUrl }),\n ...(coverImagePosition && { position: coverImagePosition }),\n };\n}\n\n\nA cover image with only a position and no URL is likely invalid and could cause rendering issues.\n\nSuggested fix: Require coverImageUrl to be present when setting a cover image:\ntypescript\nif (coverImageUrl) {\n updatedStyle.coverImage = {\n url: coverImageUrl,\n ...(coverImagePosition && { position: coverImagePosition }),\n };\n}\n

✅ Bug: Potential type mismatch in coverImage position transformation

📄 openmetadata-ui/src/main/resources/ui/src/components/Modals/IconColorModal/IconColorModal.tsx:122-125
The cover image position transformation logic may have a type inconsistency:
position: style.coverImage.position
  ? { y: style.coverImage.position }
  : undefined,
This wraps style.coverImage.position in { y: ... }. If the source position is already an object like { y: number }, this creates nested objects { y: { y: number } }. If position is a raw number representing the Y offset, the transformation is correct.

Impact: This could cause the cover image position to be improperly initialized when editing an existing style, leading to incorrect cover image positioning or runtime errors.

Suggested fix: Verify the type definition of Style.coverImage.position and ensure consistent transformation:
position: style.coverImage.position
  ? (typeof style.coverImage.position === 'number' 
      ? { y: style.coverImage.position } 
      : style.coverImage.position)
  : undefined,
Or if position is always a number in the API response, add a clarifying comment.

✅ Quality: Debug console.log left in production code

📄 openmetadata-ui/src/main/resources/ui/src/components/Modals/IconColorModal/IconColorModal.tsx:114
A console.log(values) statement is left in the handleSubmit function. This should be removed before merging to avoid polluting the console in production.
const handleSubmit = async (values: Style & { coverImage?: unknown }) => {
  try {
    setSaving(true);
    console.log(values);  // <-- Remove this

✅ Quality: Debug console.log statement left in production code

📄 openmetadata-ui/src/main/resources/ui/src/components/Modals/IconColorModal/IconColorModal.tsx:52
A debug console.log('style', style) statement is present at line 52. This appears to be leftover debugging code that should be removed before merging.

Impact: Debug logs in production can expose internal data to browser console, clutter logs, and indicate incomplete code review.

Suggested fix: Remove the console.log statement:
-  console.log('style', style);

🤖 Prompt for agents

Code Review: Well-structured refactor to add cover image support for domain updates. One important issue with potential missing error rethrow in the new utility function's catch block.

1. ⚠️ Edge Case: Missing error rethrow in updateEntityWithCoverImage catch block
   Files: openmetadata-ui/src/main/resources/ui/src/utils/CoverImageUploadUtils.tsx:382-391

   The `updateEntityWithCoverImage` function's catch block shows an error notification but the diff is truncated. Comparing with `createEntityWithCoverImage` (line 278-286), it includes `throw error;` after showing the notification. Ensure the new function also rethrows the error after the `showNotistackError` call to maintain consistent error propagation behavior.
   
   If the error is not rethrown, callers won't know the operation failed and may proceed as if it succeeded. The inner upload error correctly throws (line 373), but the outer catch block at the end needs to also throw.
   
   **Suggested fix**: Verify the catch block ends with `throw error;` similar to the existing `createEntityWithCoverImage` function.

2. 💡 Quality: Redundant null check in coverImage position condition
   Files: openmetadata-ui/src/main/resources/ui/src/utils/CoverImageUploadUtils.tsx:400-406

   In the style object construction (lines 400-410), the condition `coverImagePosition !== undefined && coverImagePosition !== null` includes a redundant null check. Since `coverImagePosition` is typed as `string | undefined` (line 351), it cannot be `null`.
   
   **Current code:**
   ```typescript
   ...(coverImagePosition !== undefined &&
     coverImagePosition !== null && {
       position: coverImagePosition,
     }),
   ```
   
   **Suggested fix:**
   ```typescript
   ...(coverImagePosition !== undefined && {
     position: coverImagePosition,
   }),
   ```
   
   This is minor but improves code clarity by aligning the condition with the type.

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change:

`Auto-apply`	`Compact`
`gitar auto-apply:on`	`gitar display:verbose`

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

gitar-bot · 2026-03-13T06:39:46Z

+            { vertical: 'top', horizontal: 'center' },
+            closeSnackbar
+          );
+
+          throw uploadError;
+        }
+      }
+    } else if (coverImageData) {
+      // No new file - use existing URL and position from form data or preserve from entity
+      coverImageUrl = coverImageData.url;


⚠️ Edge Case: Missing error rethrow in updateEntityWithCoverImage catch block

The updateEntityWithCoverImage function's catch block shows an error notification but the diff is truncated. Comparing with createEntityWithCoverImage (line 278-286), it includes throw error; after showing the notification. Ensure the new function also rethrows the error after the showNotistackError call to maintain consistent error propagation behavior.

If the error is not rethrown, callers won't know the operation failed and may proceed as if it succeeded. The inner upload error correctly throws (line 373), but the outer catch block at the end needs to also throw.

Suggested fix: Verify the catch block ends with throw error; similar to the existing createEntityWithCoverImage function.

_{Was this helpful? React with 👍 / 👎 | Reply gitar fix to apply this suggestion}

gitar-bot · 2026-03-13T06:39:46Z

+
+    // Build style object
+    const style: Style = {
+      color: styleData.color ?? undefined,
+      iconURL: styleData.iconURL ?? undefined,
+      coverImage:
+        coverImageUrl


💡 Quality: Redundant null check in coverImage position condition

In the style object construction (lines 400-410), the condition coverImagePosition !== undefined && coverImagePosition !== null includes a redundant null check. Since coverImagePosition is typed as string | undefined (line 351), it cannot be null.

Current code:

...(coverImagePosition !== undefined && coverImagePosition !== null && { position: coverImagePosition, }),

Suggested fix:

...(coverImagePosition !== undefined && { position: coverImagePosition, }),

This is minor but improves code clarity by aligning the condition with the type.

_{Was this helpful? React with 👍 / 👎 | Reply gitar fix to apply this suggestion}

add style modal

6a019fc

siddhant1 requested a review from a team as a code owner December 31, 2025 07:02

siddhant1 had a problem deploying to test December 31, 2025 07:02 — with GitHub Actions Failure

fix coverImageField

4bf5cf9

siddhant1 had a problem deploying to test December 31, 2025 07:47 — with GitHub Actions Failure

add coverageImage

05a928c

siddhant1 had a problem deploying to test December 31, 2025 08:17 — with GitHub Actions Error

siddhant1 had a problem deploying to test December 31, 2025 08:17 — with GitHub Actions Failure

add bool

b05636c

siddhant1 had a problem deploying to test December 31, 2025 08:18 — with GitHub Actions Failure

siddhant1 had a problem deploying to test January 3, 2026 12:47 — with GitHub Actions Failure

siddhant1 had a problem deploying to test January 5, 2026 05:16 — with GitHub Actions Failure

siddhant1 force-pushed the sid/style-modal branch from c7ec8ec to 0d0f4fc Compare January 5, 2026 07:54

siddhant1 had a problem deploying to test January 5, 2026 07:54 — with GitHub Actions Failure

fix reposition

6199a2b

siddhant1 force-pushed the sid/style-modal branch from 0d0f4fc to 6199a2b Compare January 5, 2026 08:10

siddhant1 had a problem deploying to test January 5, 2026 08:10 — with GitHub Actions Failure

fix reposition

19c8af2

add log

52a8346

fix i8n

094ae73

gitar-bot Bot reviewed Mar 13, 2026

View reviewed changes

Conversation

siddhant1 commented Dec 31, 2025 • 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 Dec 31, 2025

Uh oh!

github-actions Bot commented Dec 31, 2025

Uh oh!

github-actions Bot commented Dec 31, 2025

Uh oh!

github-actions Bot commented Jan 3, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

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

Uh oh!

Uh oh!

gitar-bot Bot Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

gitar-bot Bot Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

siddhant1 commented Dec 31, 2025 •

edited by gitar-bot Bot

Loading

gitar-bot Bot commented Jan 5, 2026 •

edited

Loading