[#4968] improvement(api): Unify the modification behavior of the comm…

…ent field (#4968)

api/src/main/java/org/apache/gravitino/file/FilesetChange.java

@@ -73,7 +73,9 @@ static FilesetChange removeProperty(String property) {
    * Creates a new fileset change to remove comment from the fileset.
    *
    * @return The fileset change.
+   * @deprecated Use {@link #updateComment(String)} with null value as the argument instead.
    */
+  @Deprecated
   static FilesetChange removeComment() {
     return RemoveComment.getInstance();
   }
@@ -310,7 +312,13 @@ public String toString() {
     }
   }
 
-  /** A fileset change to remove comment from the fileset. */
+  /**
+   * A fileset change to remove comment from the fileset. The remove operation has been replaced by
+   * the update operation. Please use the update operation.
+   *
+   * @deprecated Use {@link UpdateFilesetComment} with null value as the argument instead.
+   */
+  @Deprecated
   final class RemoveComment implements FilesetChange {
     private static final RemoveComment INSTANCE = new RemoveComment();
 

catalogs/catalog-hadoop/src/main/java/org/apache/gravitino/catalog/hadoop/HadoopCatalogOperations.java

@@ -688,8 +688,6 @@ private FilesetEntity updateFilesetEntity(
         newName = ((FilesetChange.RenameFileset) change).getNewName();
       } else if (change instanceof FilesetChange.UpdateFilesetComment) {
         newComment = ((FilesetChange.UpdateFilesetComment) change).getNewComment();
-      } else if (change instanceof FilesetChange.RemoveComment) {
-        newComment = null;
       } else {
         throw new IllegalArgumentException(
             "Unsupported fileset change: " + change.getClass().getSimpleName());

catalogs/catalog-hadoop/src/test/java/org/apache/gravitino/catalog/hadoop/TestHadoopCatalogOperations.java

@@ -770,7 +770,7 @@ public void testRemoveFilesetComment() throws IOException {
     String name = "fileset27";
     Fileset fileset = createFileset(name, schemaName, comment, Fileset.Type.MANAGED, null, null);
 
-    FilesetChange change1 = FilesetChange.removeComment();
+    FilesetChange change1 = FilesetChange.updateComment(null);
     try (SecureHadoopCatalogOperations ops = new SecureHadoopCatalogOperations(store)) {
       ops.initialize(Maps.newHashMap(), randomCatalogInfo(), HADOOP_PROPERTIES_METADATA);
       NameIdentifier filesetIdent = NameIdentifier.of("m1", "c1", schemaName, name);

catalogs/catalog-hadoop/src/test/java/org/apache/gravitino/catalog/hadoop/integration/test/HadoopCatalogIT.java

@@ -575,7 +575,7 @@ public void testFilesetRemoveComment() throws IOException {
         catalog
             .asFilesetCatalog()
             .alterFileset(
-                NameIdentifier.of(schemaName, filesetName), FilesetChange.removeComment());
+                NameIdentifier.of(schemaName, filesetName), FilesetChange.updateComment(null));
     assertFilesetExists(filesetName);
 
     // verify fileset is updated

clients/client-java/src/main/java/org/apache/gravitino/client/DTOConverters.java

@@ -212,8 +212,6 @@ static FilesetUpdateRequest toFilesetUpdateRequest(FilesetChange change) {
     } else if (change instanceof FilesetChange.UpdateFilesetComment) {
       return new FilesetUpdateRequest.UpdateFilesetCommentRequest(
           ((FilesetChange.UpdateFilesetComment) change).getNewComment());
-    } else if (change instanceof FilesetChange.RemoveComment) {
-      return new FilesetUpdateRequest.RemoveFilesetCommentRequest();
     } else if (change instanceof FilesetChange.SetProperty) {
       return new FilesetUpdateRequest.SetFilesetPropertiesRequest(
           ((FilesetChange.SetProperty) change).getProperty(),

clients/client-java/src/test/java/org/apache/gravitino/client/TestFilesetCatalog.java

@@ -378,7 +378,7 @@ public void testAlterFileset() throws JsonProcessingException {
     assertFileset(mockFileset3, res3);
 
     // Test remove fileset comment
-    FilesetUpdateRequest req4 = new FilesetUpdateRequest.RemoveFilesetCommentRequest();
+    FilesetUpdateRequest req4 = new FilesetUpdateRequest.UpdateFilesetCommentRequest(null);
     FilesetDTO mockFileset4 =
         mockFilesetDTO("new name", Fileset.Type.MANAGED, null, "mock location", ImmutableMap.of());
     FilesetResponse resp4 = new FilesetResponse(mockFileset4);

clients/client-java/src/test/java/org/apache/gravitino/client/integration/test/CatalogIT.java

@@ -221,7 +221,7 @@ public void testCatalogAvailable() {
         CatalogNotInUseException.class,
         () ->
             filesetOps.alterFileset(
-                NameIdentifier.of("dummy", "dummy"), FilesetChange.removeComment()));
+                NameIdentifier.of("dummy", "dummy"), FilesetChange.updateComment(null)));
 
     Assertions.assertTrue(metalake.dropCatalog(catalogName), "catalog should be dropped");
     Assertions.assertFalse(metalake.dropCatalog(catalogName), "catalog should be non-existent");

clients/client-java/src/test/java/org/apache/gravitino/client/integration/test/MetalakeIT.java

@@ -317,7 +317,7 @@ public void testMetalakeAvailable() {
         MetalakeNotInUseException.class,
         () ->
             filesetOps.alterFileset(
-                NameIdentifier.of("dummy", "dummy"), FilesetChange.removeComment()));
+                NameIdentifier.of("dummy", "dummy"), FilesetChange.updateComment(null)));
 
     Assertions.assertThrows(
         NonEmptyMetalakeException.class, () -> client.dropMetalake(metalakeName));

clients/client-python/gravitino/api/fileset_change.py

@@ -81,8 +81,11 @@ def remove_comment():
 
         Returns:
             The fileset change.
+
+        Deprecated:
+            Please use `update_comment(str)` with null value as the argument instead.
         """
-        return FilesetChange.RemoveComment()
+        return FilesetChange.UpdateFilesetComment("")
 
     @dataclass
     class RenameFileset:
@@ -279,7 +282,11 @@ def __str__(self):
 
     @dataclass
     class RemoveComment:
-        """A fileset change to remove comment from the fileset."""
+        """A fileset change to remove comment from the fileset.
+
+        Deprecated:
+            Please use `UpdateFilesetComment(str)` with null value as the argument instead.
+        """
 
         def __eq__(self, other) -> bool:
             """Compares this RemoveComment instance with another object for equality.

clients/client-python/gravitino/catalog/fileset_catalog.py

@@ -319,5 +319,5 @@ def to_fileset_update_request(change: FilesetChange):
         if isinstance(change, FilesetChange.RemoveProperty):
             return FilesetUpdateRequest.RemoveFilesetPropertyRequest(change.property())
         if isinstance(change, FilesetChange.RemoveComment):
-            return FilesetUpdateRequest.RemoveFilesetCommentRequest()
+            return FilesetUpdateRequest.UpdateFilesetCommentRequest("")
         raise ValueError(f"Unknown change type: {type(change).__name__}")

clients/client-python/gravitino/dto/requests/catalog_update_request.py

@@ -78,8 +78,8 @@ def catalog_change(self):
             return CatalogChange.update_comment(self._new_comment)
 
         def validate(self):
-            if not self._new_comment:
-                raise ValueError('"newComment" field is required and cannot be empty')
+            """Validates the fields of the request. Always pass."""
+            pass
 
     @dataclass
     class SetCatalogPropertyRequest(CatalogUpdateRequestBase):

clients/client-python/gravitino/dto/requests/fileset_update_request.py

@@ -79,13 +79,8 @@ def __init__(self, new_comment: str):
             self._new_comment = new_comment
 
         def validate(self):
-            """Validates the fields of the request.
-
-            Raises:
-                IllegalArgumentException if the new comment is not set.
-            """
-            if not self._new_comment:
-                raise ValueError('"new_comment" field is required and cannot be empty')
+            """Validates the fields of the request. Always pass."""
+            pass
 
         def fileset_change(self):
             """Returns the fileset change"""
@@ -149,7 +144,11 @@ def fileset_change(self):
 
     @dataclass
     class RemoveFilesetCommentRequest(FilesetUpdateRequestBase):
-        """Represents a request to remove comment from a Fileset."""
+        """Represents a request to remove comment from a Fileset.
+
+        Deprecated:
+            Please use `UpdateFilesetCommentRequest` with null value as the argument instead.
+        """
 
         def __init__(self):
             super().__init__("removeComment")

clients/client-python/gravitino/dto/requests/metalake_update_request.py

@@ -74,13 +74,8 @@ def __init__(self, new_comment: str):
             self._new_comment = new_comment
 
         def validate(self):
-            """Validates the fields of the request.
-
-            Raises:
-                IllegalArgumentException if the new comment is not set.
-            """
-            if not self._new_comment:
-                raise ValueError('"newComment" field is required and cannot be empty')
+            """Validates the fields of the request. Always pass."""
+            pass
 
         def metalake_change(self):
             return MetalakeChange.update_comment(self._new_comment)

clients/client-python/tests/integration/test_fileset_catalog.py

@@ -239,7 +239,7 @@ def test_alter_fileset(self):
         self.assertEqual(fileset_new.comment(), fileset_new_comment)
 
         fileset_comment_removed = catalog.as_fileset_catalog().alter_fileset(
-            self.fileset_ident, FilesetChange.remove_comment()
+            self.fileset_ident, FilesetChange.update_comment("")
         )
         self.assertEqual(fileset_comment_removed.name(), self.fileset_name)
         self.assertIsNone(fileset_comment_removed.comment())

common/src/main/java/org/apache/gravitino/dto/requests/CatalogUpdateRequest.java

@@ -117,17 +117,9 @@ public UpdateCatalogCommentRequest() {
       this(null);
     }
 
-    /**
-     * Validates the fields of the request.
-     *
-     * @throws IllegalArgumentException if the new comment is not set.
-     */
+    /** Validates the fields of the request. Always pass. */
     @Override
-    public void validate() throws IllegalArgumentException {
-      Preconditions.checkArgument(
-          StringUtils.isNotBlank(newComment),
-          "\"newComment\" field is required and cannot be empty");
-    }
+    public void validate() throws IllegalArgumentException {}
 
     @Override
     public CatalogChange catalogChange() {

common/src/main/java/org/apache/gravitino/dto/requests/FilesetUpdateRequest.java

@@ -109,17 +109,9 @@ public FilesetChange filesetChange() {
       return FilesetChange.updateComment(newComment);
     }
 
-    /**
-     * Validates the request.
-     *
-     * @throws IllegalArgumentException if the request is invalid.
-     */
+    /** Validates the fields of the request. Always pass. */
     @Override
-    public void validate() throws IllegalArgumentException {
-      Preconditions.checkArgument(
-          StringUtils.isNotBlank(newComment),
-          "\"newComment\" field is required and cannot be empty");
-    }
+    public void validate() throws IllegalArgumentException {}
   }
 
   /** The fileset update request for setting the properties of a fileset. */
@@ -189,6 +181,7 @@ public void validate() throws IllegalArgumentException {
   @EqualsAndHashCode
   @NoArgsConstructor(force = true)
   @ToString
+  @Deprecated
   class RemoveFilesetCommentRequest implements FilesetUpdateRequest {
 
     /** @return The fileset change. */

common/src/main/java/org/apache/gravitino/dto/requests/MetalakeUpdateRequest.java

@@ -117,17 +117,9 @@ public UpdateMetalakeCommentRequest() {
       this(null);
     }
 
-    /**
-     * Validates the fields of the request.
-     *
-     * @throws IllegalArgumentException if the new comment is not set.
-     */
+    /** Validates the fields of the request. Always pass. */
     @Override
-    public void validate() throws IllegalArgumentException {
-      Preconditions.checkArgument(
-          StringUtils.isNotBlank(newComment),
-          "\"newComment\" field is required and cannot be empty");
-    }
+    public void validate() throws IllegalArgumentException {}
 
     @Override
     public MetalakeChange metalakeChange() {

common/src/main/java/org/apache/gravitino/dto/requests/TableUpdateRequest.java

@@ -164,17 +164,9 @@ public UpdateTableCommentRequest() {
       this(null);
     }
 
-    /**
-     * Validates the request.
-     *
-     * @throws IllegalArgumentException If the request is invalid, this exception is thrown.
-     */
+    /** Validates the fields of the request. Always pass. */
     @Override
-    public void validate() throws IllegalArgumentException {
-      Preconditions.checkArgument(
-          StringUtils.isNotBlank(newComment),
-          "\"newComment\" field is required and cannot be empty");
-    }
+    public void validate() throws IllegalArgumentException {}
 
     /**
      * Returns the table change.

common/src/main/java/org/apache/gravitino/dto/requests/TagUpdateRequest.java

@@ -114,11 +114,9 @@ public TagChange tagChange() {
       return TagChange.updateComment(newComment);
     }
 
+    /** Validates the fields of the request. Always pass. */
     @Override
-    public void validate() throws IllegalArgumentException {
-      Preconditions.checkArgument(
-          StringUtils.isNotBlank(newComment), "\"newComment\" must not be blank");
-    }
+    public void validate() throws IllegalArgumentException {}
   }
 
   /** The tag update request for setting a tag property. */

common/src/main/java/org/apache/gravitino/dto/requests/TopicUpdateRequest.java

@@ -72,17 +72,9 @@ public UpdateTopicCommentRequest() {
       this(null);
     }
 
-    /**
-     * Validates the request.
-     *
-     * @throws IllegalArgumentException If the request is invalid, this exception is thrown.
-     */
+    /** Validates the fields of the request. Always pass. */
     @Override
-    public void validate() throws IllegalArgumentException {
-      Preconditions.checkArgument(
-          StringUtils.isNotBlank(newComment),
-          "\"newComment\" field is required and cannot be empty");
-    }
+    public void validate() throws IllegalArgumentException {}
 
     /**
      * Returns the topic change.

core/src/test/java/org/apache/gravitino/catalog/TestFilesetOperationDispatcher.java

@@ -143,7 +143,7 @@ public void testCreateAndAlterFileset() {
     Assertions.assertEquals(fileset1.name(), alteredFileset2.name());
     Assertions.assertEquals("new comment", alteredFileset2.comment());
 
-    FilesetChange[] changes3 = new FilesetChange[] {FilesetChange.removeComment()};
+    FilesetChange[] changes3 = new FilesetChange[] {FilesetChange.updateComment(null)};
 
     Fileset alteredFileset3 = filesetOperationDispatcher.alterFileset(filesetIdent1, changes3);
     Assertions.assertEquals(fileset1.name(), alteredFileset3.name());

core/src/test/java/org/apache/gravitino/connector/TestCatalogOperations.java

@@ -441,8 +441,6 @@ public Fileset alterFileset(NameIdentifier ident, FilesetChange... changes)
         filesets.remove(ident);
       } else if (change instanceof FilesetChange.UpdateFilesetComment) {
         newComment = ((FilesetChange.UpdateFilesetComment) change).getNewComment();
-      } else if (change instanceof FilesetChange.RemoveComment) {
-        newComment = null;
       } else {
         throw new IllegalArgumentException("Unsupported fileset change: " + change);
       }

docs/manage-fileset-metadata-using-gravitino.md

@@ -389,13 +389,13 @@ fileset_new = catalog.as_fileset_catalog().alter_fileset(NameIdentifier.of("sche
 
 Currently, Gravitino supports the following changes to a fileset:
 
-| Supported modification     | JSON                                                         | Java                                          |
-|----------------------------|--------------------------------------------------------------|-----------------------------------------------|
-| Rename a fileset           | `{"@type":"rename","newName":"fileset_renamed"}`             | `FilesetChange.rename("fileset_renamed")`     |
-| Update a comment           | `{"@type":"updateComment","newComment":"new_comment"}`       | `FilesetChange.updateComment("new_comment")`  |
-| Set a fileset property     | `{"@type":"setProperty","property":"key1","value":"value1"}` | `FilesetChange.setProperty("key1", "value1")` |
-| Remove a fileset property  | `{"@type":"removeProperty","property":"key1"}`               | `FilesetChange.removeProperty("key1")`        |
-| Remove comment             | `{"@type":"removeComment"}`                                  | `FilesetChange.removeComment()`               |
+| Supported modification      | JSON                                                         | Java                                          |
+|-----------------------------|--------------------------------------------------------------|-----------------------------------------------|
+| Rename a fileset            | `{"@type":"rename","newName":"fileset_renamed"}`             | `FilesetChange.rename("fileset_renamed")`     |
+| Update a comment            | `{"@type":"updateComment","newComment":"new_comment"}`       | `FilesetChange.updateComment("new_comment")`  |
+| Set a fileset property      | `{"@type":"setProperty","property":"key1","value":"value1"}` | `FilesetChange.setProperty("key1", "value1")` |
+| Remove a fileset property   | `{"@type":"removeProperty","property":"key1"}`               | `FilesetChange.removeProperty("key1")`        |
+| Remove comment (deprecated) | `{"@type":"removeComment"}`                                  | `FilesetChange.removeComment()`               |
 
 ### Drop a fileset
 

server/src/test/java/org/apache/gravitino/server/web/rest/TestFilesetOperations.java

@@ -370,7 +370,7 @@ public void testUpdateFilesetComment() {
 
   @Test
   public void testRemoveFilesetComment() {
-    FilesetUpdateRequest req = new FilesetUpdateRequest.RemoveFilesetCommentRequest();
+    FilesetUpdateRequest req = new FilesetUpdateRequest.UpdateFilesetCommentRequest(null);
     Fileset fileset =
         mockFileset("fileset1", Fileset.Type.MANAGED, null, "mock location", ImmutableMap.of());
     assertUpdateFileset(new FilesetUpdatesRequest(ImmutableList.of(req)), fileset);
@@ -387,7 +387,7 @@ public void testMultiUpdateRequest() {
     // remove k2
     FilesetUpdateRequest req5 = new FilesetUpdateRequest.RemoveFilesetPropertiesRequest("k2");
     // remove comment
-    FilesetUpdateRequest req6 = new FilesetUpdateRequest.RemoveFilesetCommentRequest();
+    FilesetUpdateRequest req6 = new FilesetUpdateRequest.UpdateFilesetCommentRequest(null);
 
     Fileset fileset =
         mockFileset(