HDDS-10518. Create base Builder in WithMetadata and WithObjectID by adoroszlai · Pull Request #6378 · apache/ozone

adoroszlai · 2024-03-14T09:18:44Z

What changes were proposed in this pull request?

Builders in subclasses of WithMetadata and WithObjectID all have their own code for setting the properties from the base classes. The goal of this task is to reduce code duplication by creating builders in the base classes and using them in the subclasses.

Existing subclass builder methods are kept for covariant return to be able to keep existing chained method calls (e.g. return OmBucketInfo instead of WithMetadata). We can remove them after replacing with non-chained calls in a follow-up patch.

https://issues.apache.org/jira/browse/HDDS-10518

How was this patch tested?

CI:
https://github.com/adoroszlai/ozone/actions/runs/8277449313

adoroszlai · 2024-03-14T19:08:20Z

@ivandika3 please take a look as well

ivandika3

Thank you for the patch. Mostly LGTM. Few minor comments.

ivandika3 · 2024-03-15T09:38:33Z

hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/OzoneBucket.java

-      this.metadata = metadata;
+      addAllMetadata(metadata);


Nit: Should not affect current usage, but the semantic seems to be changed changed from "replacing" to "adding". Might need to clear the metadata before adding it or can change the method name to addAllMetadata (but OzoneBucket is client-facing class so might not be a good idea).

I'm OK if you decide not to change it at all.

Good point. Updated to clear any existing metadata for these two classes.

ivandika3 · 2024-03-15T09:38:45Z

hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/OzoneVolume.java


    public Builder setMetadata(Map<String, String> metadata) {
-      this.metadata = metadata;
+      addAllMetadata(metadata);


Similar comment to OzoneBucket.Builder#setMetadata.

ivandika3

Thank you for the update. LGTM +1.

szetszwo

@adoroszlai , thanks for working on this! The change look good. I just have comments on adding @Override tag.

szetszwo · 2024-03-27T01:02:42Z

hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/OzoneBucket.java


    public Builder setMetadata(Map<String, String> metadata) {
-      this.metadata = metadata;
+      super.setMetadata(metadata);


Add @Override.

szetszwo · 2024-03-27T01:02:58Z

hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/OzoneVolume.java


    public Builder setMetadata(Map<String, String> metadata) {
-      this.metadata = metadata;
+      super.setMetadata(metadata);


Add @Override.

szetszwo · 2024-03-27T02:55:14Z

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java

    public Builder addAllMetadata(Map<String, String> map) {
-      metadata.putAll(map);
+      super.addAllMetadata(map);


Add @Override.

szetszwo · 2024-03-27T02:55:39Z

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java

    public Builder setObjectID(long obId) {
-      this.objectID = obId;
+      super.setObjectID(obId);


Add @Override.

szetszwo · 2024-03-27T02:55:47Z

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java

    public Builder setUpdateID(long id) {
-      this.updateID = id;
+      super.setUpdateID(id);


Add @Override.

szetszwo · 2024-03-27T02:58:02Z

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmVolumeArgs.java

-     * System.
-     * @param id - long
-     */
    public Builder setObjectID(long id) {


Add @Override.

szetszwo · 2024-03-27T02:58:09Z

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmVolumeArgs.java

-     * increasing values which are updated each time there is an update.
-     * @param id - long
-     */
    public Builder setUpdateID(long id) {


Add @Override.

szetszwo · 2024-03-27T02:58:22Z

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmVolumeArgs.java

@@ -384,14 +383,12 @@ public Builder setUsedNamespace(long namespaceUsage) {
    }

    public Builder addMetadata(String key, String value) {


Add @Override.

szetszwo · 2024-03-27T02:58:27Z

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmVolumeArgs.java

      return this;
    }

    public Builder addAllMetadata(Map<String, String> additionalMetaData) {


Add @Override.

szetszwo · 2024-03-27T02:59:10Z

...p-ozone/interface-storage/src/main/java/org/apache/hadoop/ozone/om/helpers/OmPrefixInfo.java

@@ -125,25 +123,23 @@ public Builder setName(String n) {
    }

    public OmPrefixInfo.Builder addMetadata(String key, String value) {


Add @Override.

adoroszlai · 2024-03-27T07:49:37Z

Thanks @szetszwo for the review, added all missing @Override annotations.

szetszwo

+1 the change looks good.

adoroszlai · 2024-03-27T16:22:46Z

Thanks @ivandika3, @szetszwo for the review.

…che#6378) (cherry picked from commit 7feafe9)

…bjectID (apache#6378) (cherry picked from commit 7feafe9) Conflicts: hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmDirectoryInfo.java hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java hadoop-ozone/interface-storage/src/main/java/org/apache/hadoop/ozone/om/helpers/OmPrefixInfo.java hadoop-ozone/interface-storage/src/test/java/org/apache/hadoop/ozone/om/helpers/TestOmPrefixInfo.java hadoop-ozone/recon/src/test/java/org/apache/hadoop/ozone/recon/common/CommonUtils.java Change-Id: Ie89b7ee52e0a8f33341700b03b28983895d72e55

HDDS-10518. Create base Builder in WithMetadata and WithObjectID

176f2fd

adoroszlai self-assigned this Mar 14, 2024

adoroszlai requested a review from aryangupta1998 March 14, 2024 11:35

ivandika3 reviewed Mar 15, 2024

View reviewed changes

adoroszlai added 2 commits March 15, 2024 12:07

restore setMetadata() semantics in OzoneVolume/Bucket

d13984a

fix infinite loop

21d7db7

ivandika3 approved these changes Mar 16, 2024

View reviewed changes

Merge remote-tracking branch 'origin/master' into HDDS-10518

50107d4

adoroszlai requested a review from szetszwo March 26, 2024 21:22

szetszwo reviewed Mar 27, 2024

View reviewed changes

adoroszlai added 2 commits March 27, 2024 07:21

Merge remote-tracking branch 'origin/master' into HDDS-10518

4c2f5cd

add missing @Override

65e61d6

szetszwo approved these changes Mar 27, 2024

View reviewed changes

szetszwo merged commit 7feafe9 into apache:master Mar 27, 2024

adoroszlai deleted the HDDS-10518 branch March 27, 2024 16:22

jojochuang pushed a commit to jojochuang/ozone that referenced this pull request May 29, 2024

HDDS-10518. Create base Builder in WithMetadata and WithObjectID (apa…

04c8cfe

…che#6378) (cherry picked from commit 7feafe9)

		@@ -384,14 +383,12 @@ public Builder setUsedNamespace(long namespaceUsage) {
		}

		public Builder addMetadata(String key, String value) {

		@@ -125,25 +123,23 @@ public Builder setName(String n) {
		}

		public OmPrefixInfo.Builder addMetadata(String key, String value) {

Conversation

adoroszlai commented Mar 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes were proposed in this pull request?

How was this patch tested?

Uh oh!

adoroszlai commented Mar 14, 2024

Uh oh!

ivandika3 left a comment

Choose a reason for hiding this comment

Uh oh!

ivandika3 Mar 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ivandika3 left a comment

Choose a reason for hiding this comment

Uh oh!

szetszwo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adoroszlai commented Mar 27, 2024

Uh oh!

szetszwo left a comment

Choose a reason for hiding this comment

Uh oh!

adoroszlai commented Mar 27, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

adoroszlai commented Mar 14, 2024 •

edited

Loading

ivandika3 Mar 15, 2024 •

edited

Loading