(gravitino) branch main updated: [#8387]Prevent duplicate whitespace in StringIdentifier (#8400)

[jmclean]

This is an automated email from the ASF dual-hosted git repository.

jmclean pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git


The following commit(s) were added to refs/heads/main by this push:
     new 6444a32a0e [#8387]Prevent duplicate whitespace in StringIdentifier 
(#8400)
6444a32a0e is described below

commit 6444a32a0ed4b7151245dc7907caf9d65a76d747
Author: Jackeyzhe <jackeyzh...@163.com>
AuthorDate: Wed Sep 3 14:18:22 2025 +0800

    [#8387]Prevent duplicate whitespace in StringIdentifier (#8400)
    
    ### What changes were proposed in this pull request?
    Prevent duplicate whitespace in
    org.apache.gravitino.StringIdentifier#addToComment
    
    
    ### Why are the changes needed?
    Fix: #8387
    
    ### Does this PR introduce _any_ user-facing change?
    no
    
    ### How was this patch tested?
    add some unit tests
    
    Co-authored-by: jackeyzhe <jackeyzh...@gmail.com>
---
 .../java/org/apache/gravitino/StringIdentifier.java     |  3 ++-
 .../java/org/apache/gravitino/TestStringIdentifier.java | 17 +++++++++++++++++
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/core/src/main/java/org/apache/gravitino/StringIdentifier.java 
b/core/src/main/java/org/apache/gravitino/StringIdentifier.java
index 4938c07b10..38c644944f 100644
--- a/core/src/main/java/org/apache/gravitino/StringIdentifier.java
+++ b/core/src/main/java/org/apache/gravitino/StringIdentifier.java
@@ -168,7 +168,8 @@ public class StringIdentifier {
       return String.format(STRING_COMMENT_FORMAT, "", STRING_COMMENT, 
stringId.toString());
     }
 
-    return String.format(STRING_COMMENT_FORMAT, comment + " ", STRING_COMMENT, 
stringId.toString());
+    return String.format(
+        STRING_COMMENT_FORMAT, comment.trim() + " ", STRING_COMMENT, 
stringId.toString());
   }
 
   public static StringIdentifier fromComment(String comment) {
diff --git a/core/src/test/java/org/apache/gravitino/TestStringIdentifier.java 
b/core/src/test/java/org/apache/gravitino/TestStringIdentifier.java
index a9740d6297..765eef77ce 100644
--- a/core/src/test/java/org/apache/gravitino/TestStringIdentifier.java
+++ b/core/src/test/java/org/apache/gravitino/TestStringIdentifier.java
@@ -206,4 +206,21 @@ public class TestStringIdentifier {
     Assertions.assertEquals(
         commentWithSpace.trim(), 
StringIdentifier.removeIdFromComment(commentWithId));
   }
+
+  @Test
+  public void testAddToCommentAvoidsDuplicateSpace() {
+    String commentWithSpace1 = "This is a comment ";
+    StringIdentifier identifier1 = StringIdentifier.fromId(1L);
+    String commentWithId1 = StringIdentifier.addToComment(identifier1, 
commentWithSpace1);
+    Assertions.assertEquals(
+        commentWithSpace1.trim() + " (From Gravitino, DO NOT EDIT: " + 
identifier1 + ")",
+        commentWithId1);
+
+    String commentWithSpace2 = "  This is a comment ";
+    StringIdentifier identifier2 = StringIdentifier.fromId(2L);
+    String commentWithId2 = StringIdentifier.addToComment(identifier2, 
commentWithSpace2);
+    Assertions.assertEquals(
+        commentWithSpace2.trim() + " (From Gravitino, DO NOT EDIT: " + 
identifier2 + ")",
+        commentWithId2);
+  }
 }