Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#6254]Improve: Rename tag to a name already exists in the current metalake, it should return 409 instead of 500 #6298

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −2
Open

[#6254]Improve: Rename tag to a name already exists in the current metalake, it should return 409 instead of 500 #6298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions core/src/main/java/org/apache/gravitino/tag/TagManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,8 @@ public Tag alterTag(String metalake, String name, TagChange... changes)
throw new NoSuchTagException(
"Tag with name %s under metalake %s does not exist", name, metalake);
} catch (EntityAlreadyExistsException e) {
throw new RuntimeException(
"Tag with name " + name + " under metalake " + metalake + " already exists");
throw new TagAlreadyExistsException(
"Tag with name %s under metalake %s already exists", getNewName(changes), metalake);
} catch (IOException ioe) {
LOG.error("Failed to alter tag {} under metalake {}", name, metalake, ioe);
throw new RuntimeException(ioe);
Expand Down Expand Up @@ -352,6 +352,15 @@ public String[] associateTagsForMetadataObject(
}));
}

private String getNewName(TagChange... changes) {
for (TagChange change : changes) {
if (change instanceof TagChange.RenameTag) {
return ((TagChange.RenameTag) change).getNewName();
}
}
return null;
Comment on lines +355 to +361
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can get the new name from the updated tag entity, no need to do it here. Also, it is not proper to return null, which will be weird for the printed log.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated Tag entity is being constructed within a deeply nested callback function, making it challenging to access (since the error occurs, the updated Tag entity cannot be retrieved as a return value). Alternatively, I could include the error name in the exception thrown by the TagMetaService.updateTag() method.

So I believe this alternative approach is simpler and more straightforward for retrieving the name.

In this case, if a TagAlreadyExistsException is triggered, the method will never return null. However, instead of returning null in cases where the method might be misused, it might be better to throw an error to explicitly handle such situations.
Which one do you prefer?
Get the name from the Exception or TagChange?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you make things complicated, if it is the name conflict, the old name and new name should be the same, you can use the name passed in. Both getting the name from TagChange and Exception are too complex and not necessary just for getting a name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But the conflict old name in updateTag step is actually come from TagChange?
And WDYM passed in name here, I don't get it.

Copy link
Contributor

@jerryshao jerryshao Jan 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it is the EntityAlreadyExistsException, which could only happen when the new name and the old name are the same, so you don't have to get the new name for TableChange, you can use the old name from the method, which is the same.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What you need to change it to change the exception only, no need to change the message.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danhuawang cc

}

private TagEntity updateTagEntity(TagEntity tagEntity, TagChange... changes) {
Map<String, String> props =
tagEntity.properties() == null
Expand Down
12 changes: 12 additions & 0 deletions core/src/test/java/org/apache/gravitino/tag/TestTagManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,18 @@ public void testAlterTag() {
Assertions.assertEquals("new comment", removedPropTag.comment());
Map<String, String> expectedProp2 = ImmutableMap.of("k2", "v2");
Assertions.assertEquals(expectedProp2, removedPropTag.properties());

// Test rename tag to an already-existing tag
tagManager.createTag(METALAKE, "tagA", "existing comment", null);
tagManager.createTag(METALAKE, "tagB", "some comment", null);

TagChange renameToExisting = TagChange.rename("tagB");
Exception e =
Assertions.assertThrows(
TagAlreadyExistsException.class,
() -> tagManager.alterTag(METALAKE, "tagA", renameToExisting));
Assertions.assertEquals(
"Tag with name tagB under metalake " + METALAKE + " already exists", e.getMessage());
}

@Test
Expand Down
Loading