[GitHub] [hadoop-ozone] linyiqun commented on a change in pull request #1358: HDDS-4143. Implement a version factory for OM Apply Transaction that …

[GitBox <gi...@apache.org>]

linyiqun commented on a change in pull request #1358:
URL: https://github.com/apache/hadoop-ozone/pull/1358#discussion_r479648837



##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/upgrade/OmVersionFactory.java
##########
@@ -0,0 +1,133 @@
+package org.apache.hadoop.ozone.om.upgrade;
+
+import java.util.function.Function;
+
+import org.apache.hadoop.ozone.om.ratis.utils.OzoneManagerRatisUtils;
+import org.apache.hadoop.ozone.om.request.OMClientRequest;
+import org.apache.hadoop.ozone.om.request.bucket.OMBucketCreateRequest;
+import org.apache.hadoop.ozone.om.request.bucket.OMBucketDeleteRequest;
+import org.apache.hadoop.ozone.om.request.bucket.OMBucketSetPropertyRequest;
+import org.apache.hadoop.ozone.om.request.file.OMDirectoryCreateRequest;
+import org.apache.hadoop.ozone.om.request.file.OMFileCreateRequest;
+import org.apache.hadoop.ozone.om.request.key.OMAllocateBlockRequest;
+import org.apache.hadoop.ozone.om.request.key.OMKeyCommitRequest;
+import org.apache.hadoop.ozone.om.request.key.OMKeyCreateRequest;
+import org.apache.hadoop.ozone.om.request.key.OMKeyCreateRequestV2;
+import org.apache.hadoop.ozone.om.request.key.OMKeyDeleteRequest;
+import org.apache.hadoop.ozone.om.request.key.OMKeyPurgeRequest;
+import org.apache.hadoop.ozone.om.request.key.OMKeyRenameRequest;
+import org.apache.hadoop.ozone.om.request.key.OMKeysDeleteRequest;
+import org.apache.hadoop.ozone.om.request.key.OMTrashRecoverRequest;
+import org.apache.hadoop.ozone.om.request.s3.multipart.S3InitiateMultipartUploadRequest;
+import org.apache.hadoop.ozone.om.request.s3.multipart.S3MultipartUploadAbortRequest;
+import org.apache.hadoop.ozone.om.request.s3.multipart.S3MultipartUploadCommitPartRequest;
+import org.apache.hadoop.ozone.om.request.s3.multipart.S3MultipartUploadCompleteRequest;
+import org.apache.hadoop.ozone.om.request.s3.security.S3GetSecretRequest;
+import org.apache.hadoop.ozone.om.request.security.OMCancelDelegationTokenRequest;
+import org.apache.hadoop.ozone.om.request.security.OMGetDelegationTokenRequest;
+import org.apache.hadoop.ozone.om.request.security.OMRenewDelegationTokenRequest;
+import org.apache.hadoop.ozone.om.request.volume.OMVolumeCreateRequest;
+import org.apache.hadoop.ozone.om.request.volume.OMVolumeDeleteRequest;
+import org.apache.hadoop.ozone.om.upgrade.OMLayoutFeatureCatalog.OMLayoutFeature;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type;
+import org.apache.hadoop.ozone.upgrade.VersionFactoryKey;
+import org.apache.hadoop.ozone.upgrade.VersionedInstanceSupplierFactory;
+
+/**
+ * Wrapper class for OM around a generic Versioned Instance factory.
+ */
+public class OmVersionFactory {
+
+  public OmVersionFactory() {
+    registerClientRequests();
+  }
+
+  private VersionedInstanceSupplierFactory<OMRequest, OMClientRequest>
+      writeRequestFactory = new VersionedInstanceSupplierFactory<>();
+
+  public void registerClientRequest(String type,
+                                      Function<OMRequest, OMClientRequest>
+                                          function) {
+    writeRequestFactory.register(
+        new VersionFactoryKey.Builder().key(type).build(), function);
+  }
+
+  /**
+   * New client requests go here.
+   */
+  private void registerClientRequests() {
+    registerClientRequest(Type.CreateVolume.name(),
+        OMVolumeCreateRequest::new);
+    registerClientRequest(Type.SetVolumeProperty.name(),
+        OzoneManagerRatisUtils::getVolumeSetOwnerRequest);
+    registerClientRequest(Type.DeleteVolume.name(), OMVolumeDeleteRequest::new);
+    registerClientRequest(Type.CreateBucket.name(), OMBucketCreateRequest::new);
+    registerClientRequest(Type.DeleteBucket.name(), OMBucketDeleteRequest::new);
+    registerClientRequest(Type.SetBucketProperty.name(),
+        OMBucketSetPropertyRequest::new);
+    registerClientRequest(Type.AllocateBlock.name(),
+        OMAllocateBlockRequest::new);
+    registerClientRequest(Type.CreateKey.name(), OMKeyCreateRequest::new);
+    registerClientRequest(Type.CommitKey.name(), OMKeyCommitRequest::new);
+    registerClientRequest(Type.DeleteKey.name(), OMKeyDeleteRequest::new);
+    registerClientRequest(Type.DeleteKeys.name(), OMKeysDeleteRequest::new);
+    registerClientRequest(Type.RenameKey.name(), OMKeyRenameRequest::new);
+    registerClientRequest(Type.CreateDirectory.name(),
+        OMDirectoryCreateRequest::new);
+    registerClientRequest(Type.CreateFile.name(), OMFileCreateRequest::new);
+    registerClientRequest(Type.PurgeKeys.name(), OMKeyPurgeRequest::new);
+    registerClientRequest(Type.InitiateMultiPartUpload.name(),
+        S3InitiateMultipartUploadRequest::new);
+    registerClientRequest(Type.CommitMultiPartUpload.name(),
+        S3MultipartUploadCommitPartRequest::new);
+    registerClientRequest(Type.AbortMultiPartUpload.name(),
+        S3MultipartUploadAbortRequest::new);
+    registerClientRequest(Type.CompleteMultiPartUpload.name(),
+        S3MultipartUploadCompleteRequest::new);
+    registerClientRequest(Type.AddAcl.name(),
+        OzoneManagerRatisUtils::getOMAclRequest);
+    registerClientRequest(Type.RemoveAcl.name(),
+        OzoneManagerRatisUtils::getOMAclRequest);
+    registerClientRequest(Type.SetAcl.name(),
+        OzoneManagerRatisUtils::getOMAclRequest);
+    registerClientRequest(Type.GetDelegationToken.name(),
+        OMGetDelegationTokenRequest::new);
+    registerClientRequest(Type.CancelDelegationToken.name(),
+        OMCancelDelegationTokenRequest::new);
+    registerClientRequest(Type.RenewDelegationToken.name(),
+        OMRenewDelegationTokenRequest::new);
+    registerClientRequest(Type.GetS3Secret.name(), S3GetSecretRequest::new);
+    registerClientRequest(Type.RecoverTrash.name(), OMTrashRecoverRequest::new);
+
+    // Adding "Mock" Create Key Request V2.
+    registerClientRequest(Type.CreateKey.name(), OMLayoutFeature.NEW_FEATURE,
+        OMKeyCreateRequestV2::new);
+  }
+
+  public void registerClientRequest(
+      String type, OMLayoutFeature layoutFeature,
+      Function<OMRequest, OMClientRequest> function) {
+    VersionFactoryKey key = new VersionFactoryKey.Builder()
+        .key(type).version(layoutFeature.layoutVersion()).build();
+    writeRequestFactory.register(key, function);
+  }
+
+  public OMClientRequest getClientRequest(OMRequest omRequest) {
+    Function<OMRequest, ? extends OMClientRequest> instance =
+        writeRequestFactory.getInstance(getVersionFactoryKey(omRequest));

Review comment:
       When input omRequest type is not existed, we should return IllegalStateException error as original logic OzoneManagerRatisUtils#createClientRequest did. 

##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ratis/utils/OzoneManagerRatisUtils.java
##########
@@ -84,86 +61,26 @@
 
   private OzoneManagerRatisUtils() {
   }
-  /**
-   * Create OMClientRequest which encapsulates the OMRequest.
-   * @param omRequest
-   * @return OMClientRequest
-   * @throws IOException
-   */
-  public static OMClientRequest createClientRequest(OMRequest omRequest) {
-    Type cmdType = omRequest.getCmdType();

Review comment:
       Can we keep OzoneManagerRatisUtils#createClientRequest unchanged and invoke omVersionFactory#getClientRequest Here?
   Now OzoneManagerRatisUtils defines the request/response functions, I prefer to keep this function there. This is just my personal taste for this change.

##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/protocolPB/OzoneManagerRequestHandler.java
##########
@@ -290,6 +290,11 @@ public void validateRequest(OMRequest omRequest) throws OMException {
       throw new OMException("ClientId is null",
           OMException.ResultCodes.INVALID_REQUEST);
     }
+
+    if (omRequest.getLayoutVersion() == null) {

Review comment:
       We might add a comment to say why we should pass layout version in write type request. That will be good understanding.

##########
File path: hadoop-ozone/ozone-manager/src/test/java/org/apache/hadoop/ozone/om/upgrade/TestOmVersionFactory.java
##########
@@ -0,0 +1,73 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.hadoop.ozone.om.upgrade;
+
+import static org.apache.hadoop.ozone.om.upgrade.OMLayoutFeatureCatalog.OMLayoutFeature.NEW_FEATURE;
+import static org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type.CreateKey;
+
+import java.util.function.Function;
+
+import org.apache.hadoop.ozone.om.request.OMClientRequest;
+import org.apache.hadoop.ozone.om.request.key.OMKeyCreateRequest;
+import org.apache.hadoop.ozone.om.request.key.OMKeyCreateRequestV2;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.LayoutVersion;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest;
+import org.apache.hadoop.ozone.upgrade.VersionFactoryKey;
+import org.apache.hadoop.ozone.upgrade.VersionedInstanceSupplierFactory;
+import org.junit.Assert;
+import org.junit.Test;
+
+/**
+ * Test OmVersionFactory.
+ */
+public class TestOmVersionFactory {

Review comment:
       Can we add a test case that using existed OM request and verify its layout version is set as expected?




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: ozone-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: ozone-issues-help@hadoop.apache.org