[HDDS-6796] Extract method for building OMRequest in TrashOzoneFileSystem

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Implemented
• Fix Version/s: 1.5.0
• Component/s: OM
• Labels: GoodForNewContributors good-first-issue pull-request-available
• Assignee: Will Xiao
• Reporter: Sadanand Shenoy
• Created: 24/May/22 14:46
• Updated: 22/Jan/24 12:55
• Resolved: 22/Jan/24 12:55

Description

TrashOzoneFileSystem has 3 pieces of similar code where it builds OMRequest:

https://github.com/apache/ozone/blob/82d27595958f70a7468a38899bf48b2208bebe64/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/TrashOzoneFileSystem.java#L486-L492

      omRequest = OzoneManagerProtocolProtos.OMRequest.newBuilder()
              .setClientId(CLIENT_ID.toString())
              .setVersion(ClientVersion.CURRENT_VERSION)
              .setUserInfo(getUserInfo())
              .setRenameKeyRequest(renameKeyRequest)
              .setCmdType(OzoneManagerProtocolProtos.Type.RenameKey)
              .build();

https://github.com/apache/ozone/blob/82d27595958f70a7468a38899bf48b2208bebe64/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/TrashOzoneFileSystem.java#L552-L559

      omRequest =
          OzoneManagerProtocolProtos.OMRequest.newBuilder()
              .setClientId(CLIENT_ID.toString())
              .setVersion(ClientVersion.CURRENT_VERSION)
              .setUserInfo(getUserInfo())
              .setDeleteKeyRequest(deleteKeyRequest)
              .setCmdType(OzoneManagerProtocolProtos.Type.DeleteKey)
              .build();

https://github.com/apache/ozone/blob/82d27595958f70a7468a38899bf48b2208bebe64/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/TrashOzoneFileSystem.java#L622-L628

        omRequest = OzoneManagerProtocolProtos.OMRequest.newBuilder()
            .setClientId(CLIENT_ID.toString())
            .setVersion(ClientVersion.CURRENT_VERSION)
            .setUserInfo(getUserInfo())
            .setDeleteKeysRequest(deleteKeysRequest)
            .setCmdType(OzoneManagerProtocolProtos.Type.DeleteKeys)
            .build();

The goal of this task is to

• create a new method that returns a new OMRequest.Builder after setting the properties that are the same in all 3 snippets
• use this new method to replace the duplicated part of the code

Example for the same pattern elsewhere:

https://github.com/apache/ozone/blob/82d27595958f70a7468a38899bf48b2208bebe64/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/protocolPB/OzoneManagerProtocolClientSideTranslatorPB.java#L288-L293

  private OMRequest.Builder createOMRequest(Type cmdType) {
    return OMRequest.newBuilder()
        .setCmdType(cmdType)
        .setVersion(ClientVersion.CURRENT_VERSION)
        .setClientId(clientID);
  }

Issue Links

• links to: GitHub Pull Request #6048