HADOOP-19232: [ABFS][FNSOverBlob] Implementing Ingress Support with various Fallback Handling #7272
+6,367
−371
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anmolanmol1234
changed the title
This comment was marked as outdated.
This comment was marked as outdated.
anujmodi2021
reviewed
Jan 6, 2025
hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AbfsConfiguration.java
Outdated
Show resolved
Hide resolved
...tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AzureBlobFileSystemStore.java
Outdated
Show resolved
Hide resolved
...op-azure/src/main/java/org/apache/hadoop/fs/azurebfs/constants/FileSystemConfigurations.java
Show resolved
Hide resolved
...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/constants/AbfsHttpConstants.java
Show resolved
Hide resolved
.../java/org/apache/hadoop/fs/azurebfs/contracts/exceptions/InvalidIngressServiceException.java
Outdated
Show resolved
Hide resolved
hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBlock.java
Show resolved
Hide resolved
...tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBlockStatus.java
Show resolved
Hide resolved
hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsErrors.java
Outdated
Show resolved
Hide resolved
|
|
||
| /** | ||
| * Creates or retrieves an existing Azure ingress handler based on the service type and provided parameters. | ||
| * <p> |
There was a problem hiding this comment.
seems like xml tag is not closed
There was a problem hiding this comment.
which tag is not closed ?
...ools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsOutputStream.java
Show resolved
Hide resolved
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
anujmodi2021
reviewed
Jan 8, 2025
hadoop-tools/hadoop-azure/src/config/checkstyle-suppressions.xml
Outdated
Show resolved
Hide resolved
| * @param errorMessage the error message | ||
| * @param innerException the inner exception | ||
| */ | ||
| public InvalidIngressServiceException(final int statusCode, |
There was a problem hiding this comment.
Can we also try to include erver request Id for the failed request here??
There was a problem hiding this comment.
That is already included in the exception message
There was a problem hiding this comment.
May be I am missing something here, but I can see there are 2 constructors for base exception and the one that excepts AbfsHttpOperation as a separate parameter calls the formatMessage() which adds the req Id to exception message.
Refering to:
There was a problem hiding this comment.
The inner exception that gets caught has the request Id in the message already
...ools/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/ITestAbfsCustomEncryption.java
Outdated
Show resolved
Hide resolved
...ls/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/AbstractAbfsIntegrationTest.java
Outdated
Show resolved
Hide resolved
...ools/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/ITestAbfsCustomEncryption.java
Show resolved
Hide resolved
...hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/ITestAzureBlobFileSystemAppend.java
Outdated
Show resolved
Hide resolved
| fs.create(filePath); | ||
| FSDataOutputStream outputStream = fs.append(filePath); | ||
| outputStream.write(10); | ||
| final AzureBlobFileSystem fs1 |
There was a problem hiding this comment.
use try() to autoclose here and every where else applicable
| * Verify that parallel write with same offset from different output streams will not throw exception. | ||
| **/ | ||
| @Test | ||
| public void testParallelWriteSameOffsetDifferentOutputStreams() |
There was a problem hiding this comment.
For this and next 2 tests, there is a lot of code redundancy, not sure if possible but would be good to refactor common code into a parameterised method.
There was a problem hiding this comment.
Moved the common code into a common method
| out::hsync | ||
| ); | ||
| } | ||
| } |
|
|
||
| // Create a spy of AzureBlobFileSystemStore | ||
| AzureBlobFileSystemStore store = Mockito.spy(fs.getAbfsStore()); | ||
| Assume.assumeTrue(store.getClient() instanceof AbfsBlobClient); |
There was a problem hiding this comment.
We can use base class method assumeBlobServiceType() here and other places.
anujmodi2021
requested changes
Jan 9, 2025
...hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/utils/AzcopyExecutionException.java
Outdated
Show resolved
Hide resolved
...hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/utils/AzcopyExecutionException.java
Show resolved
Hide resolved
...oop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/services/ITestAbfsPaginatedDelete.java
Show resolved
Hide resolved
| }); | ||
| if (spiedClient instanceof AbfsDfsClient) { | ||
| intercept(FileNotFoundException.class, os::close); | ||
| } else { |
There was a problem hiding this comment.
What is the exact difference in behavior between DFS and Blob here?
Can we assert on status code as well??
There was a problem hiding this comment.
DFS throws FileNotFoundException while Blob throws IOException
...hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/services/ITestAbfsOutputStream.java
Outdated
Show resolved
Hide resolved
...hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/services/ITestAbfsOutputStream.java
Outdated
Show resolved
Hide resolved
| @@ -61,6 +65,12 @@ public ITestAbfsHttpClientRequestExecutor() throws Exception { | |||
| public void testExpect100ContinueHandling() throws Exception { | |||
| AzureBlobFileSystem fs = getFileSystem(); | |||
| Path path = new Path("/testExpect100ContinueHandling"); | |||
| if (isAppendBlobEnabled()) { | |||
| Assume.assumeFalse("Not valid for AppendBlob with blob endpoint", | |||
There was a problem hiding this comment.
We can check using getAbfsServiceType()
There was a problem hiding this comment.
Since service type and ingress type can be different this might not work, we can add a getIngressServiceType() method in base class ?
There was a problem hiding this comment.
Yes that would be better and cleaner code
...ls/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/ITestAzureBlobFilesystemAcl.java
Outdated
Show resolved
Hide resolved
...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/constants/AbfsHttpConstants.java
Show resolved
Hide resolved
...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/constants/AbfsHttpConstants.java
Show resolved
Hide resolved
| @@ -1140,7 +1387,7 @@ public boolean checkIsDir(AbfsHttpOperation result) { | |||
| public boolean checkUserError(int responseStatusCode) { | |||
| return (responseStatusCode >= HttpURLConnection.HTTP_BAD_REQUEST | |||
| && responseStatusCode < HttpURLConnection.HTTP_INTERNAL_ERROR | |||
| && responseStatusCode != HttpURLConnection.HTTP_CONFLICT); | |||
| && responseStatusCode != HTTP_CONFLICT); | |||
There was a problem hiding this comment.
We can do same changes for above two codes (HTTP_INTERNAL_ERROR, HTTP_BAD_REQUEST) as well.
There was a problem hiding this comment.
reverted this change
| this.outputStream = outputStream; | ||
| this.offset = offset; | ||
| DataBlocks.BlockFactory blockFactory = outputStream.getBlockManager().getBlockFactory(); | ||
| long blockCount = outputStream.getBlockManager().getBlockCount(); |
There was a problem hiding this comment.
Since we are using these variables (blockCount, blockSize) only at one place, it would be better to call it inplace.
There was a problem hiding this comment.
better to store them as variables for better readability
| + "exists and its resource type is invalid for this operation."; | ||
| public static final String BLOB_OPERATION_NOT_SUPPORTED = "Blob operation is not supported."; | ||
| public static final String INVALID_APPEND_OPERATION = "The resource was created or modified by the Azure Blob Service API " | ||
| + "and cannot be appended to by the Azure Data Lake Storage Service API"; |
There was a problem hiding this comment.
Typo error: and cannot be appended by the Azure Data Lake Storage Service API.
There was a problem hiding this comment.
This is how the error message comes from the backend
| boolean hasActiveBlockDataToUpload() { | ||
| AzureBlockManager blockManager = getBlockManager(); | ||
| AbfsBlock activeBlock = blockManager.getActiveBlock(); | ||
| return blockManager.hasActiveBlock() && activeBlock.hasData(); |
There was a problem hiding this comment.
Can blockManager and activeBlock be null in any of the case?
There was a problem hiding this comment.
hasActiveBlock checks for null for activeBlock and blockManager can not be null
| if (hasActiveBlock()) { | ||
| clearActiveBlock(); | ||
| } | ||
| getBlockManager().clearActiveBlock(); |
There was a problem hiding this comment.
Should we not have check on hasActiveBlock before clearActiveBlock?
| @VisibleForTesting | ||
| AbfsClient getClient() { | ||
| synchronized AbfsClient getClient() { |
There was a problem hiding this comment.
What is the need of this change?
There was a problem hiding this comment.
was reported as a spot bug hence I added it but dont see the need for it hence reverting
| AbfsBlobClient blobClient = abfsOutputStream.getClientHandler().getBlobClient(); | ||
| final AbfsRestOperation op = blobClient | ||
| .getBlockList(abfsOutputStream.getPath(), tracingContext); | ||
| committedBlockIdList = op.getResult().getBlockIdList(); |
There was a problem hiding this comment.
A check on op and op.getResult before calling getBlockIdList is needed.
| BlobAppendRequestParameters blobParams = new BlobAppendRequestParameters(blockToUpload.getBlockId(), getETag()); | ||
| reqParams.setBlobParams(blobParams); | ||
| AbfsRestOperation op; | ||
| long threadId = Thread.currentThread().getId(); |
There was a problem hiding this comment.
Can we get Thread.currentThread().getId() inplace as we are only using it once?
| TracingContext tracingContext) throws IOException { | ||
| TracingContext tracingContextAppend = new TracingContext(tracingContext); | ||
| long threadId = Thread.currentThread().getId(); | ||
| String threadIdStr = String.valueOf(threadId); |
There was a problem hiding this comment.
Same as above, if threadIf is getting used at only one place, can we keep it inplace?
| IOUtils.closeStreams(uploadData, activeBlock); | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
Please remove 1 extra empty line.
| AbfsRestOperation op; | ||
| TracingContext tracingContextAppend = new TracingContext(tracingContext); | ||
| long threadId = Thread.currentThread().getId(); | ||
| String threadIdStr = String.valueOf(threadId); |
| throws IOException { | ||
| TracingContext tracingContextFlush = new TracingContext(tracingContext); | ||
| if (tracingContextFlush.getIngressHandler().equals(EMPTY_STRING)) { | ||
| tracingContextFlush.setIngressHandler("DFlush"); |
There was a problem hiding this comment.
Can we create constant for DFlush and use it whereever required?
| // Perform the upload within a performance tracking context. | ||
| try (AbfsPerfInfo perfInfo = new AbfsPerfInfo( | ||
| dfsClient.getAbfsPerfTracker(), | ||
| "writeCurrentBufferToService", "append")) { |
There was a problem hiding this comment.
can we create constant for append?
There was a problem hiding this comment.
already present, added it here
| } | ||
| try { | ||
| TracingContext tracingContextFlush = new TracingContext(tracingContext); | ||
| tracingContextFlush.setIngressHandler("FBFlush"); |
There was a problem hiding this comment.
Same as above, constant for FBFlush
| // Perform the upload within a performance tracking context. | ||
| try (AbfsPerfInfo perfInfo = new AbfsPerfInfo( | ||
| getClient().getAbfsPerfTracker(), | ||
| "writeCurrentBufferToService", "append")) { |
There was a problem hiding this comment.
Same as above, constant for append.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
🎊 +1 overall
This message was automatically generated. |
|
🎊 +1 overall
This message was automatically generated. |
anujmodi2021
requested changes
Jan 16, 2025
| @@ -234,6 +236,27 @@ public void initialize(URI uri, Configuration configuration) | |||
| throw new InvalidConfigurationValueException(FS_AZURE_ACCOUNT_IS_HNS_ENABLED, ex); | |||
| } | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
This should be a blocked comment instead of javadoc to avoid dangling javadoc issues.
| @@ -234,6 +236,27 @@ public void initialize(URI uri, Configuration configuration) | |||
| throw new InvalidConfigurationValueException(FS_AZURE_ACCOUNT_IS_HNS_ENABLED, ex); | |||
| } | |||
|
|
|||
| /** | |||
| * Validates if the FixedSASTokenProvider is configured for non-HNS accounts. | |||
There was a problem hiding this comment.
I feel like the comment here should be re-phrased. Its sounds like only FixedSasTokenProvider can be used with FNS. It should clarify that if Auth Type is SAS then user can only configure a fixed SAS Token and SASTokenProvider should not be configured at all otherwise Fixed SAS Token won't be used.
Refer to
| * @throws InvalidConfigurationValueException if the namespace is not enabled and the FixedSASTokenProvider is not configured. | ||
| */ | ||
| try { | ||
| if (!getIsNamespaceEnabled(new TracingContext(initFSTracingContext)) |
There was a problem hiding this comment.
Better use tryGetIsNamespaceEnabled() here with proper exception handling.
Refer to:
| try { | ||
| if (!getIsNamespaceEnabled(new TracingContext(initFSTracingContext)) | ||
| && !abfsConfiguration.isFixedSASTokenProviderConfigured()) { | ||
| close(); |
There was a problem hiding this comment.
No need of close() here. FileSystem creation happening after all the checks now.
| throw new InvalidConfigurationValueException( | ||
| FS_AZURE_SAS_TOKEN_PROVIDER_TYPE, UNAUTHORIZED_SAS); | ||
| } | ||
| } catch (AzureBlobFileSystemException ex) { |
There was a problem hiding this comment.
We need better exception handling here.
We should first catch SASTokenProviderException and throw InvalidConfigurationValueException() with original exception included as it will tell why getSASTokenProvder() failed.
Then we should catch the AzureBlobFileSystemException that can be thrown while determining account type.
| /** | ||
| * Exception message on filesystem init if token-provider-auth-type configs are provided | ||
| */ | ||
| public static final String UNAUTHORIZED_SAS = |
There was a problem hiding this comment.
Can be moved to AbfsErrors.java class
| * @param errorMessage the error message | ||
| * @param innerException the inner exception | ||
| */ | ||
| public InvalidIngressServiceException(final int statusCode, |
There was a problem hiding this comment.
May be I am missing something here, but I can see there are 2 constructors for base exception and the one that excepts AbfsHttpOperation as a separate parameter calls the formatMessage() which adds the req Id to exception message.
Refering to:
| op = client.getPathStatus(fileName, true, testTracingContext, null); | ||
| return AzureBlobFileSystemStore.extractEtagHeader(op.getResult()); | ||
| } | ||
| } |
| @@ -370,4 +397,4 @@ public void testAcquireRetry() throws Exception { | |||
| tracingContext); | |||
| }); | |||
| } | |||
| } | |||
| } | |||
|
💔 -1 overall
This message was automatically generated. |
|
🎊 +1 overall
This message was automatically generated. |
|
🎊 +1 overall
This message was automatically generated. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of PR :
This Pr is in correlation to the series of work done under Parent Jira: [HADOOP-19179]
(https://issues.apache.org/jira/browse/HADOOP-19179)
Jira for this Patch: https://issues.apache.org/jira/browse/HADOOP-19232
Scope of this task is to refactor the AbfsOutputStream class to handle the ingress for DFS and Blob endpoint effectively.
Production code changes :
The
AbfsOutputStreamclass is crucial for handling the data being written to Azure Storage. Its primary responsibilities include:New Additions
The new additions introduce a more modular and flexible approach to managing data ingress (data being written to storage), catering to both Azure Data Lake Storage (ADLS) and Azure Blob Storage.
AzureIngressHandler
The
AzureIngressHandleris a new parent class designed to encapsulate common logic for data ingress operations. It simplifies the process of writing data to Azure Storage by providing a unified interface. This class has two specialized child classes:AzureDfsIngressHandler:
AzureBlobIngressHandler:
blockId.AbfsBlock and AbfsBlobBlock
Data is managed in discrete blocks to improve efficiency and manageability.
AbfsBlock:
AbfsBlobBlock:
AbfsBlocktailored for Blob Storage.blockIdfor each block, which is necessary for the Blob Storage API.Block Managers
To manage these data blocks, new manager classes have been introduced. These classes handle the lifecycle of blocks, including creation, appending, and flushing.
AzureBlockManager:
AzureDFSBlockManager:
AbfsBlockinstances for DFS.AzureBlobBlockManager:
AbfsBlobBlockinstances for Blob Storage.blockId.Integration with AbfsOutputStream
The
AbfsOutputStreamclass has been updated to incorporate the new ingress flow logic, enhancing its ability to handle data writes to both DFS and Blob Storage. Here’s how it integrates:Configuration Selection:
AbfsOutputStreamreads the configuration parameterfs.azure.ingress.service.typeto determine whether the user has configured the system to useBLOBorDFSfor data ingress.Handler Initialization:
AbfsOutputStreaminitializes the appropriate handler (AzureBlobIngressHandlerorAzureDfsIngressHandler).Buffering Data:
AbfsOutputStream, it is buffered into blocks (AbfsBlockfor DFS orAbfsBlobBlockfor Blob Storage).Managing Blocks:
AzureDFSBlockManagerorAzureBlobBlockManager) manages the lifecycle of these blocks, ensuring that data is correctly created, appended, and flushed.Block Id Management (Blob Specific):
AzureBlobBlockManagerensures that each block has a uniqueblockId, adhering to the requirements of the Blob Storage API.Detailed Flow
Creating Data Blocks:
AbfsOutputStream, it is divided into blocks (AbfsBlockfor DFS orAbfsBlobBlockfor Blob Storage).Appending Data:
AzureBlobIngressHandlerorAzureDfsIngressHandler).Flushing Data:
Lifecycle Management:
AzureDFSBlockManagerandAzureBlobBlockManager) oversee the lifecycle of blocks, handling retries, errors, and ensuring data integrity.Test Code Changes: