saxenapranav commented on code in PR #6409:
URL: https://github.com/apache/hadoop/pull/6409#discussion_r1464894704
##########
hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AbfsConfiguration.java:
##########
@@ -1191,7 +1195,12 @@ public boolean getRenameResilience() {
return renameResilience;
}
- void setRenameResilience(boolean actualResilience) {
- renameResilience = actualResilience;
+ public boolean isPaginatedDeleteEnabled() {
+ return isPaginatedDeleteEnabled;
+ }
+
+ @VisibleForTesting
Review Comment:
Problem is that its a setter. And, it can be invoked from outside abfs
codebase : `fs.getAbfsStore().
getAbfsConfiguration().setIsPaginatedDeleteEnabled()`. Outside abfs should not
be able to change the config. Other setters (except one or two) are non-public.
Requesting you to kindly remove it. The same behavior that you want to set /
unset can be done by change in AbfsClient as suggested in:
https://github.com/apache/hadoop/pull/6409#discussion_r1442539222
##########
hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsClient.java:
##########
@@ -1053,12 +1053,24 @@ public AbfsRestOperation read(final String path,
return op;
}
- public AbfsRestOperation deletePath(final String path, final boolean
recursive, final String continuation,
+ public AbfsRestOperation deletePath(final String path, final boolean
recursive,
+ final String continuation,
TracingContext tracingContext)
throws AzureBlobFileSystemException {
final List<AbfsHttpHeader> requestHeaders = createDefaultHeaders();
-
final AbfsUriQueryBuilder abfsUriQueryBuilder =
createDefaultUriQueryBuilder();
+
+ if (abfsConfiguration.isPaginatedDeleteEnabled() && recursive) {
+ // Change the x-ms-version to "2023-08-03" if its less than that.
+ if (xMsVersion.compareTo(AUGUST_2023_API_VERSION) < 0) {
Review Comment:
It is still string comparison. My original proposal was to assign an index
to each enum, and then we compare on the basis of the index.
##########
hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsClient.java:
##########
@@ -1053,12 +1053,24 @@ public AbfsRestOperation read(final String path,
return op;
}
- public AbfsRestOperation deletePath(final String path, final boolean
recursive, final String continuation,
+ public AbfsRestOperation deletePath(final String path, final boolean
recursive,
+ final String continuation,
TracingContext tracingContext)
throws AzureBlobFileSystemException {
final List<AbfsHttpHeader> requestHeaders = createDefaultHeaders();
-
final AbfsUriQueryBuilder abfsUriQueryBuilder =
createDefaultUriQueryBuilder();
+
+ if (abfsConfiguration.isPaginatedDeleteEnabled() && recursive) {
Review Comment:
Great you have added private method `isPaginatedDeleteEnabled` which
computes the conditions. What I am proposing is that there be a
package-protected method `getIsPaginatedDeleteEnabled()` which you can refactor
with `abfsConfiguration.isPaginatedDeleteEnabled()`. Something like:
```
private Boolean isPaginatedDeleteEnabled(TracingContext tracingContext,
boolean isRecursiveDelete) throws AzureBlobFileSystemException {
return getIsPaginatedDeleteEnabled()
&& getIsNamespaceEnabled(tracingContext) && isRecursiveDelete;
}
...
Boolean getIsPaginatedDeleteEnabled() {
return abfsConfiguration.isPaginatedDeleteEnabled();
}
```
##########
hadoop-tools/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/services/ITestAbfsPaginatedDelete.java:
##########
@@ -0,0 +1,279 @@
+/**
+ * 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
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.fs.azurebfs.services;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.fs.FileSystem;
+import org.apache.hadoop.fs.Path;
+import org.apache.hadoop.fs.azurebfs.AbfsConfiguration;
+import org.apache.hadoop.fs.azurebfs.AbstractAbfsIntegrationTest;
+import org.apache.hadoop.fs.azurebfs.AzureBlobFileSystem;
+import
org.apache.hadoop.fs.azurebfs.contracts.exceptions.AbfsRestOperationException;
+import org.apache.hadoop.fs.azurebfs.oauth2.ClientCredsTokenProvider;
+import org.apache.hadoop.fs.azurebfs.utils.AclTestHelpers;
+import org.apache.hadoop.fs.azurebfs.utils.TracingContext;
+import org.apache.hadoop.fs.permission.AclEntry;
+import org.apache.hadoop.fs.permission.AclEntryScope;
+import org.apache.hadoop.fs.permission.AclEntryType;
+import org.apache.hadoop.fs.permission.FsAction;
+import org.apache.hadoop.util.Lists;
+
+import org.assertj.core.api.Assertions;
+import org.junit.Assume;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.UUID;
+
+import static java.net.HttpURLConnection.HTTP_BAD_REQUEST;
+import static java.net.HttpURLConnection.HTTP_NOT_FOUND;
+import static
org.apache.hadoop.fs.azurebfs.constants.AbfsHttpConstants.AUGUST_2023_API_VERSION;
+import static
org.apache.hadoop.fs.azurebfs.constants.AbfsHttpConstants.DECEMBER_2019_API_VERSION;
+import static
org.apache.hadoop.fs.azurebfs.constants.ConfigurationKeys.FS_AZURE_ACCOUNT_AUTH_TYPE_PROPERTY_NAME;
+import static
org.apache.hadoop.fs.azurebfs.constants.ConfigurationKeys.FS_AZURE_ACCOUNT_OAUTH_CLIENT_ENDPOINT;
+import static
org.apache.hadoop.fs.azurebfs.constants.ConfigurationKeys.AZURE_CREATE_REMOTE_FILESYSTEM_DURING_INITIALIZATION;
+import static
org.apache.hadoop.fs.azurebfs.constants.ConfigurationKeys.FS_AZURE_ACCOUNT_TOKEN_PROVIDER_TYPE_PROPERTY_NAME;
+import static
org.apache.hadoop.fs.azurebfs.constants.HttpHeaderConfigurations.X_MS_VERSION;
+import static
org.apache.hadoop.fs.azurebfs.constants.HttpQueryParams.QUERY_PARAM_PAGINATED;
+import static
org.apache.hadoop.fs.azurebfs.constants.TestConfigurationKeys.FS_AZURE_BLOB_FS_CHECKACCESS_TEST_CLIENT_ID;
+import static
org.apache.hadoop.fs.azurebfs.constants.TestConfigurationKeys.FS_AZURE_BLOB_FS_CHECKACCESS_TEST_CLIENT_SECRET;
+import static
org.apache.hadoop.fs.azurebfs.constants.TestConfigurationKeys.FS_AZURE_BLOB_FS_CHECKACCESS_TEST_USER_GUID;
+import static
org.apache.hadoop.fs.azurebfs.constants.TestConfigurationKeys.FS_AZURE_BLOB_FS_CLIENT_ID;
+import static
org.apache.hadoop.fs.azurebfs.constants.TestConfigurationKeys.FS_AZURE_BLOB_FS_CLIENT_SECRET;
+import static
org.apache.hadoop.fs.azurebfs.constants.TestConfigurationKeys.FS_AZURE_TEST_NAMESPACE_ENABLED_ACCOUNT;
+import static
org.apache.hadoop.fs.azurebfs.services.AbfsClientUtils.getHeaderValue;
+import static org.apache.hadoop.test.LambdaTestUtils.intercept;
+
+public class ITestAbfsPaginatedDelete extends AbstractAbfsIntegrationTest {
+
+ private AzureBlobFileSystem superUserFs;
+ private AzureBlobFileSystem firstTestUserFs;
+ private String firstTestUserGuid;
+
+ private boolean isHnsEnabled;
+ public ITestAbfsPaginatedDelete() throws Exception {
+ }
+
+ @Override
+ public void setup() throws Exception {
+ isHnsEnabled =
this.getConfiguration().getBoolean(FS_AZURE_TEST_NAMESPACE_ENABLED_ACCOUNT,
false);
+ loadConfiguredFileSystem();
+ super.setup();
+ this.superUserFs = getFileSystem();
+ this.firstTestUserGuid = getConfiguration()
+ .get(FS_AZURE_BLOB_FS_CHECKACCESS_TEST_USER_GUID);
+
+ if(isHnsEnabled) {
+ // setting up ACL permissions for test user
+ setFirstTestUserFsAuth();
+ setDefaultAclOnRoot(this.firstTestUserGuid);
+ }
+ }
+
+ /**
+ * Test to check that recursive deletePath works with paginated enabled and
+ * disabled for both empty and non-empty directory.
+ * When enabled appropriate xMsVersion should be used.
+ * @throws Exception
+ */
+ @Test
+ public void testRecursiveDeleteWithPagination() throws Exception {
+ testRecursiveDeleteWithPaginationInternal(false, true,
DECEMBER_2019_API_VERSION);
+ testRecursiveDeleteWithPaginationInternal(false, true,
AUGUST_2023_API_VERSION);
+ testRecursiveDeleteWithPaginationInternal(false, false,
DECEMBER_2019_API_VERSION);
+ testRecursiveDeleteWithPaginationInternal(false, false,
AUGUST_2023_API_VERSION);
+ testRecursiveDeleteWithPaginationInternal(true, true,
DECEMBER_2019_API_VERSION);
+ testRecursiveDeleteWithPaginationInternal(true, false,
AUGUST_2023_API_VERSION);
+ }
+
+ /**
+ * Test to check that non-recursive delete works with both paginated enabled
+ * and disabled only for empty directories.
+ * Pagination should not be set when recursive is false.
+ * @throws Exception
+ */
+ @Test
+ public void testNonRecursiveDeleteWithPagination() throws Exception {
+ testNonRecursiveDeleteWithPaginationInternal(true);
+ testNonRecursiveDeleteWithPaginationInternal(false);
+ }
+
+ /**
+ * Test to check that with pagination enabled, invalid CT will fail
+ * @throws Exception
+ */
+ @Test
+ public void testRecursiveDeleteWithInvalidCT() throws Exception {
+ testRecursiveDeleteWithInvalidCTInternal(true);
+ testRecursiveDeleteWithInvalidCTInternal(false);
+ }
+
+ public void testRecursiveDeleteWithPaginationInternal(boolean isEmptyDir,
boolean isPaginatedDeleteEnabled,
+ String xMsVersion) throws Exception {
+ final AzureBlobFileSystem fs = isHnsEnabled ? this.firstTestUserFs :
getFileSystem();
+ TracingContext testTracingContext =
getTestTracingContext(this.firstTestUserFs, true);
+ Path testPath;
+ if (isEmptyDir) {
+ testPath = new Path("/emptyPath" + StringUtils.right(
+ UUID.randomUUID().toString(), 10));
+ fs.mkdirs(testPath);
+ } else {
+ testPath = createSmallDir();
+ }
+
+ // Set the paginated enabled value and xMsVersion at client level.
+ AbfsClient client = ITestAbfsClient.setAbfsClientField(
+ fs.getAbfsStore().getClient(), "xMsVersion", xMsVersion);
+
client.getAbfsConfiguration().setIsPaginatedDeleteEnabled(isPaginatedDeleteEnabled);
+
+ AbfsRestOperation op = client.deletePath(testPath.toString(), true, null,
testTracingContext);
+
+ // Getting the xMsVersion that was used to make the request
+ String xMsVersionUsed = getHeaderValue(op.getRequestHeaders(),
X_MS_VERSION);
+ String urlUsed = op.getUrl().toString();
+
+ // Assert that appropriate xMsVersion and query param was used to make
request
+ if (isPaginatedDeleteEnabled &&
xMsVersion.compareTo(AUGUST_2023_API_VERSION) < 0) {
+ Assertions.assertThat(urlUsed)
+ .describedAs("Url must have paginated = true as query param")
+ .contains(QUERY_PARAM_PAGINATED);
+ Assertions.assertThat(xMsVersionUsed)
+ .describedAs("Request was made with wrong x-ms-version")
+ .isEqualTo(AUGUST_2023_API_VERSION);
+ } else if (isPaginatedDeleteEnabled &&
xMsVersion.compareTo(AUGUST_2023_API_VERSION) >= 0) {
+ Assertions.assertThat(urlUsed)
+ .describedAs("Url must have paginated = true as query param")
+ .contains(QUERY_PARAM_PAGINATED);
+ Assertions.assertThat(xMsVersionUsed)
+ .describedAs("Request was made with wrong x-ms-version")
+ .isEqualTo(xMsVersion);
+ } else {
+ Assertions.assertThat(urlUsed)
+ .describedAs("Url must not have paginated = true as query param")
+ .doesNotContain(QUERY_PARAM_PAGINATED);
+ Assertions.assertThat(xMsVersionUsed)
+ .describedAs("Request was made with wrong x-ms-version")
+ .isEqualTo(xMsVersion);
+ }
+
+ // Assert that deletion was successful in every scenario.
+ AbfsRestOperationException e = intercept(AbfsRestOperationException.class,
() ->
+ client.getPathStatus(testPath.toString(), false, testTracingContext,
null));
+ Assertions.assertThat(e.getStatusCode())
+ .describedAs("Path should have been
deleted").isEqualTo(HTTP_NOT_FOUND);
+ }
+
+ public void testNonRecursiveDeleteWithPaginationInternal(boolean
isPaginatedDeleteEnabled) throws Exception{
+ final AzureBlobFileSystem fs = isHnsEnabled ? this.firstTestUserFs :
getFileSystem();
+ TracingContext testTracingContext =
getTestTracingContext(this.firstTestUserFs, true);
+ Path testPath = new Path("/emptyPath");
+ fs.mkdirs(testPath);
+
+ // Set the paginated enabled value and xMsVersion at client level.
+ AbfsClient client = fs.getAbfsStore().getClient();
+
client.getAbfsConfiguration().setIsPaginatedDeleteEnabled(isPaginatedDeleteEnabled);
+ AbfsRestOperation op = client.deletePath(testPath.toString(), false, null,
testTracingContext);
+
+ // Getting the url that was used to make the request
+ String urlUsed = op.getUrl().toString();
+
+ // Assert that paginated query param was not set to make request
+ Assertions.assertThat(urlUsed)
+ .describedAs("Url must not have paginated as query param")
+ .doesNotContain(QUERY_PARAM_PAGINATED);
+
+ // Assert that deletion was successful in every scenario.
+ AbfsRestOperationException e = intercept(AbfsRestOperationException.class,
() ->
+ client.getPathStatus(testPath.toString(), false, testTracingContext,
null));
+ Assertions.assertThat(e.getStatusCode())
+ .describedAs("Path should have been
deleted").isEqualTo(HTTP_NOT_FOUND);
+ }
+
+ public void testRecursiveDeleteWithInvalidCTInternal(boolean
isPaginatedEnabled) throws Exception {
+ final AzureBlobFileSystem fs = isHnsEnabled ? this.firstTestUserFs :
getFileSystem();
+ Path smallDirPath = createSmallDir();
+ String randomCT = "randomContinuationToken1234";
+ TracingContext testTracingContext =
getTestTracingContext(this.firstTestUserFs, true);
+
+ AbfsClient client = fs.getAbfsStore().getClient();
+
client.getAbfsConfiguration().setIsPaginatedDeleteEnabled(isPaginatedEnabled);
+
+ AbfsRestOperationException e = intercept(AbfsRestOperationException.class,
() ->
+ client.deletePath(smallDirPath.toString(), true, randomCT,
testTracingContext));
+ Assertions.assertThat(e.getStatusCode())
+ .describedAs("Request Should fail with
400").isEqualTo(HTTP_BAD_REQUEST);
+ }
+
+ private void setFirstTestUserFsAuth() throws IOException {
+ if (this.firstTestUserFs != null) {
+ return;
+ }
+ checkIfConfigIsSet(FS_AZURE_ACCOUNT_OAUTH_CLIENT_ENDPOINT
+ + "." + getAccountName());
+ Configuration conf = getRawConfiguration();
+ setTestFsConf(FS_AZURE_BLOB_FS_CLIENT_ID,
FS_AZURE_BLOB_FS_CHECKACCESS_TEST_CLIENT_ID);
+ setTestFsConf(FS_AZURE_BLOB_FS_CLIENT_SECRET,
Review Comment:
Are UID, clientId, and secret not related. if yes, requesting you to supply
clientId and secret from the `setup()` method.
--
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.
To unsubscribe, e-mail: common-issues-unsubscr...@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: common-issues-h...@hadoop.apache.org
