GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS - #39361

Merged
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics
Jan 5, 2024
Merged

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS#39361
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics

Conversation

@felipecrv

@felipecrvfelipecrv commented Dec 24, 2023

Copy link
Copy Markdown
Contributor

Rationale for this change

The FileSystem implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.

What changes are included in this PR?

  • Skip fewer tests
  • Re-implement GetFileInfo using ListBlobsByHierarchy instead of ListBlobs
  • Re-implement CreateDir with an upfront HNS support check instead of falling back to Blobs API after an error
  • Add comprehensive tests to CreateDir
  • Add HasSubmitBatchBug to check if a test inside any scenario is affected by a certain Azurite issue
  • Implement DeleteDir to work properly on flat namespace storage accounts (non-HNS accounts)

Are these changes tested?

Yes. By existing and new tests added by this PR itself.

@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton

@Tom-NewtonTom-Newton left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not reviewed everything yet. I have a few comments, but generally I think it looks great so far.

Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
auto dir_marker_blob_path = internal::EnsureTrailingSlash(location.path);
return container_client.GetBlobClient(dir_marker_blob_path).AsBlockBlobClient();
},
[](auto& block_blob_client) { block_blob_client.UploadFrom(nullptr, 0); },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be a good idea to put some metadata on all directory marker blobs we create. That would allow us to add a simple checks in ObjectInputFile::Init and ObjectAppendStream::Init to ensure they are not being initialised as directories.

Additionally I think this will not be compatible with adlfs if it does not add metadata to directory markers. I think its very likely that people will end up using a combination of this arrow filesystem and adlfs.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I would like to be as compatible as possible with existing specs. But to clarify, what do you mean when you say adlfs? Don't you mean abfs instead [1]?

[1] https://github.com/apache/hadoop/blob/trunk/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AzureBlobFileSystem.java

I think there is a confusion between abfs (filesystem semantics over the Blobs API) and adlfs (the separate service that Azure created that can also be accessed via the Blobs API with some restrictions).

The fsspec repo seems to be linking both abfs and adlfs to the same thing, but they shouldn't be considered the same thing: https://github.com/fsspec/filesystem_spec/blob/0ffe06cb767456b7c13904b57ec1c3ca60d53eae/docs/source/api.rst?plain=1#L229

Tell me what I'm missing here because my experience with Azure is restricted just to reading the docs (a lot of them) recently.

@Tom-NewtonTom-NewtonDec 26, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, in this case I mean the adlfs pip repo. It's the Azure fsspec implementation.

@Tom-NewtonTom-NewtonJan 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More specifically I think we should add some metadata which will be compatible such that https://github.com/fsspec/adlfs/blob/32132c4094350fca2680155a5c236f2e9f991ba5/adlfs/spec.py#L855-L870 can correctly detect the directories.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot this, but I will add this change now.

Comment threadcpp/src/arrow/filesystem/azurefs_test.cc Outdated
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Dec 24, 2023
Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Jan 1, 2024
Comment threadcpp/src/arrow/filesystem/azurefs.cc
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton@kou I pushed changes based on your feedback. I would love to merge it before tomorrow's release cut.

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@kou

kou commented Jan 4, 2024

Copy link
Copy Markdown
Member

Could you check CI failures?

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3814

[ RUN ] TestAzuriteFileSystem.DeleteDirContentsSuccessDirectory
/arrow/cpp/src/arrow/filesystem/test_util.cc:143: Failure
Expected equality of these values:
info.type()
Which is: FileType::Directory
type
Which is: FileType::NotFound
For path 'hfqilxw9uhk7xqbathiwbudo4ci9dp9w/0iav1y3m4u53d5wvtp8g2j5af1o4s694'

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3680

[ RUN ] TestAzuriteFileSystem.DeleteDirSuccessNonexistent
/arrow/cpp/src/arrow/filesystem/azurefs_test.cc:1301: Failure
Failed
'fs()->DeleteDir(directory_path)' failed with IOError: Path does not exist 'go9qhglaypjhxnprrxc79a0e3xtceml1/bwumjdfql0n8hizvv1kd3jn75ucrlw4u'. Detail: [errno 2] No such file or directory

@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 4, 2024
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@kou done. These turned out to be Azurite-only tests that needed updating since the semantics are now different than what was assumed when the tests were written.

@felipecrv
felipecrv requested a review from kouJanuary 4, 2024 22:27
@felipecrvfelipecrv added this to the 15.0.0 milestone Jan 4, 2024
kou
kou approved these changes Jan 5, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Jan 5, 2024
@felipecrv
felipecrv merged commit aae6fa4 into apache:mainJan 5, 2024
@felipecrvfelipecrv removed the awaiting merge Awaiting merge label Jan 5, 2024
@felipecrv
felipecrv deleted the azure_dir_semantics branch January 5, 2024 15:44
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit aae6fa4.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…rage account doesn't support HNS (apache#39361)
### Rationale for this change
The `FileSystem` implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.
### What changes are included in this PR?
- Skip fewer tests
- Re-implement `GetFileInfo` using `ListBlobsByHierarchy` instead of `ListBlobs`
- Re-implement `CreateDir` with an upfront HNS support check instead of falling back to Blobs API after an error
- Add comprehensive tests to `CreateDir`
- Add `HasSubmitBatchBug` to check if a test inside any scenario is affected by a certain Azurite issue
- Implement `DeleteDir` to work properly on flat namespace storage accounts (non-HNS accounts)
- ### Are these changes tested?
Yes. By existing and new tests added by this PR itself.
* Closes: apache#38772
Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Signed-off-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[C++][FS][Azure] Should GetFileInfo() against a directory always return true without hierarchical namespace support?

3 participants

@felipecrv@kou@Tom-Newton
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS - #39361

Merged
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics
Jan 5, 2024
Merged

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS#39361
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics

Conversation

@felipecrv

@felipecrvfelipecrv commented Dec 24, 2023

Copy link
Copy Markdown
Contributor

Rationale for this change

The FileSystem implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.

What changes are included in this PR?

  • Skip fewer tests
  • Re-implement GetFileInfo using ListBlobsByHierarchy instead of ListBlobs
  • Re-implement CreateDir with an upfront HNS support check instead of falling back to Blobs API after an error
  • Add comprehensive tests to CreateDir
  • Add HasSubmitBatchBug to check if a test inside any scenario is affected by a certain Azurite issue
  • Implement DeleteDir to work properly on flat namespace storage accounts (non-HNS accounts)

Are these changes tested?

Yes. By existing and new tests added by this PR itself.

@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton

@Tom-NewtonTom-Newton left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not reviewed everything yet. I have a few comments, but generally I think it looks great so far.

Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
auto dir_marker_blob_path = internal::EnsureTrailingSlash(location.path);
return container_client.GetBlobClient(dir_marker_blob_path).AsBlockBlobClient();
},
[](auto& block_blob_client) { block_blob_client.UploadFrom(nullptr, 0); },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be a good idea to put some metadata on all directory marker blobs we create. That would allow us to add a simple checks in ObjectInputFile::Init and ObjectAppendStream::Init to ensure they are not being initialised as directories.

Additionally I think this will not be compatible with adlfs if it does not add metadata to directory markers. I think its very likely that people will end up using a combination of this arrow filesystem and adlfs.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I would like to be as compatible as possible with existing specs. But to clarify, what do you mean when you say adlfs? Don't you mean abfs instead [1]?

[1] https://github.com/apache/hadoop/blob/trunk/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AzureBlobFileSystem.java

I think there is a confusion between abfs (filesystem semantics over the Blobs API) and adlfs (the separate service that Azure created that can also be accessed via the Blobs API with some restrictions).

The fsspec repo seems to be linking both abfs and adlfs to the same thing, but they shouldn't be considered the same thing: https://github.com/fsspec/filesystem_spec/blob/0ffe06cb767456b7c13904b57ec1c3ca60d53eae/docs/source/api.rst?plain=1#L229

Tell me what I'm missing here because my experience with Azure is restricted just to reading the docs (a lot of them) recently.

@Tom-NewtonTom-NewtonDec 26, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, in this case I mean the adlfs pip repo. It's the Azure fsspec implementation.

@Tom-NewtonTom-NewtonJan 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More specifically I think we should add some metadata which will be compatible such that https://github.com/fsspec/adlfs/blob/32132c4094350fca2680155a5c236f2e9f991ba5/adlfs/spec.py#L855-L870 can correctly detect the directories.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot this, but I will add this change now.

Comment threadcpp/src/arrow/filesystem/azurefs_test.cc Outdated
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Dec 24, 2023
Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Jan 1, 2024
Comment threadcpp/src/arrow/filesystem/azurefs.cc
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton@kou I pushed changes based on your feedback. I would love to merge it before tomorrow's release cut.

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@kou

kou commented Jan 4, 2024

Copy link
Copy Markdown
Member

Could you check CI failures?

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3814

[ RUN ] TestAzuriteFileSystem.DeleteDirContentsSuccessDirectory
/arrow/cpp/src/arrow/filesystem/test_util.cc:143: Failure
Expected equality of these values:
info.type()
Which is: FileType::Directory
type
Which is: FileType::NotFound
For path 'hfqilxw9uhk7xqbathiwbudo4ci9dp9w/0iav1y3m4u53d5wvtp8g2j5af1o4s694'

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3680

[ RUN ] TestAzuriteFileSystem.DeleteDirSuccessNonexistent
/arrow/cpp/src/arrow/filesystem/azurefs_test.cc:1301: Failure
Failed
'fs()->DeleteDir(directory_path)' failed with IOError: Path does not exist 'go9qhglaypjhxnprrxc79a0e3xtceml1/bwumjdfql0n8hizvv1kd3jn75ucrlw4u'. Detail: [errno 2] No such file or directory

@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 4, 2024
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@kou done. These turned out to be Azurite-only tests that needed updating since the semantics are now different than what was assumed when the tests were written.

@felipecrv
felipecrv requested a review from kouJanuary 4, 2024 22:27
@felipecrvfelipecrv added this to the 15.0.0 milestone Jan 4, 2024
kou
kou approved these changes Jan 5, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Jan 5, 2024
@felipecrv
felipecrv merged commit aae6fa4 into apache:mainJan 5, 2024
@felipecrvfelipecrv removed the awaiting merge Awaiting merge label Jan 5, 2024
@felipecrv
felipecrv deleted the azure_dir_semantics branch January 5, 2024 15:44
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit aae6fa4.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…rage account doesn't support HNS (apache#39361)
### Rationale for this change
The `FileSystem` implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.
### What changes are included in this PR?
- Skip fewer tests
- Re-implement `GetFileInfo` using `ListBlobsByHierarchy` instead of `ListBlobs`
- Re-implement `CreateDir` with an upfront HNS support check instead of falling back to Blobs API after an error
- Add comprehensive tests to `CreateDir`
- Add `HasSubmitBatchBug` to check if a test inside any scenario is affected by a certain Azurite issue
- Implement `DeleteDir` to work properly on flat namespace storage accounts (non-HNS accounts)
- ### Are these changes tested?
Yes. By existing and new tests added by this PR itself.
* Closes: apache#38772
Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Signed-off-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[C++][FS][Azure] Should GetFileInfo() against a directory always return true without hierarchical namespace support?

3 participants

@felipecrv@kou@Tom-Newton
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS - #39361

Merged
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics
Jan 5, 2024
Merged

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS#39361
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics

Conversation

@felipecrv

@felipecrvfelipecrv commented Dec 24, 2023

Copy link
Copy Markdown
Contributor

Rationale for this change

The FileSystem implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.

What changes are included in this PR?

  • Skip fewer tests
  • Re-implement GetFileInfo using ListBlobsByHierarchy instead of ListBlobs
  • Re-implement CreateDir with an upfront HNS support check instead of falling back to Blobs API after an error
  • Add comprehensive tests to CreateDir
  • Add HasSubmitBatchBug to check if a test inside any scenario is affected by a certain Azurite issue
  • Implement DeleteDir to work properly on flat namespace storage accounts (non-HNS accounts)

Are these changes tested?

Yes. By existing and new tests added by this PR itself.

@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton

@Tom-NewtonTom-Newton left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not reviewed everything yet. I have a few comments, but generally I think it looks great so far.

Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
auto dir_marker_blob_path = internal::EnsureTrailingSlash(location.path);
return container_client.GetBlobClient(dir_marker_blob_path).AsBlockBlobClient();
},
[](auto& block_blob_client) { block_blob_client.UploadFrom(nullptr, 0); },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be a good idea to put some metadata on all directory marker blobs we create. That would allow us to add a simple checks in ObjectInputFile::Init and ObjectAppendStream::Init to ensure they are not being initialised as directories.

Additionally I think this will not be compatible with adlfs if it does not add metadata to directory markers. I think its very likely that people will end up using a combination of this arrow filesystem and adlfs.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I would like to be as compatible as possible with existing specs. But to clarify, what do you mean when you say adlfs? Don't you mean abfs instead [1]?

[1] https://github.com/apache/hadoop/blob/trunk/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AzureBlobFileSystem.java

I think there is a confusion between abfs (filesystem semantics over the Blobs API) and adlfs (the separate service that Azure created that can also be accessed via the Blobs API with some restrictions).

The fsspec repo seems to be linking both abfs and adlfs to the same thing, but they shouldn't be considered the same thing: https://github.com/fsspec/filesystem_spec/blob/0ffe06cb767456b7c13904b57ec1c3ca60d53eae/docs/source/api.rst?plain=1#L229

Tell me what I'm missing here because my experience with Azure is restricted just to reading the docs (a lot of them) recently.

@Tom-NewtonTom-NewtonDec 26, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, in this case I mean the adlfs pip repo. It's the Azure fsspec implementation.

@Tom-NewtonTom-NewtonJan 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More specifically I think we should add some metadata which will be compatible such that https://github.com/fsspec/adlfs/blob/32132c4094350fca2680155a5c236f2e9f991ba5/adlfs/spec.py#L855-L870 can correctly detect the directories.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot this, but I will add this change now.

Comment threadcpp/src/arrow/filesystem/azurefs_test.cc Outdated
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Dec 24, 2023
Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Jan 1, 2024
Comment threadcpp/src/arrow/filesystem/azurefs.cc
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton@kou I pushed changes based on your feedback. I would love to merge it before tomorrow's release cut.

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@kou

kou commented Jan 4, 2024

Copy link
Copy Markdown
Member

Could you check CI failures?

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3814

[ RUN ] TestAzuriteFileSystem.DeleteDirContentsSuccessDirectory
/arrow/cpp/src/arrow/filesystem/test_util.cc:143: Failure
Expected equality of these values:
info.type()
Which is: FileType::Directory
type
Which is: FileType::NotFound
For path 'hfqilxw9uhk7xqbathiwbudo4ci9dp9w/0iav1y3m4u53d5wvtp8g2j5af1o4s694'

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3680

[ RUN ] TestAzuriteFileSystem.DeleteDirSuccessNonexistent
/arrow/cpp/src/arrow/filesystem/azurefs_test.cc:1301: Failure
Failed
'fs()->DeleteDir(directory_path)' failed with IOError: Path does not exist 'go9qhglaypjhxnprrxc79a0e3xtceml1/bwumjdfql0n8hizvv1kd3jn75ucrlw4u'. Detail: [errno 2] No such file or directory

@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 4, 2024
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@kou done. These turned out to be Azurite-only tests that needed updating since the semantics are now different than what was assumed when the tests were written.

@felipecrv
felipecrv requested a review from kouJanuary 4, 2024 22:27
@felipecrvfelipecrv added this to the 15.0.0 milestone Jan 4, 2024
kou
kou approved these changes Jan 5, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Jan 5, 2024
@felipecrv
felipecrv merged commit aae6fa4 into apache:mainJan 5, 2024
@felipecrvfelipecrv removed the awaiting merge Awaiting merge label Jan 5, 2024
@felipecrv
felipecrv deleted the azure_dir_semantics branch January 5, 2024 15:44
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit aae6fa4.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…rage account doesn't support HNS (apache#39361)
### Rationale for this change
The `FileSystem` implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.
### What changes are included in this PR?
- Skip fewer tests
- Re-implement `GetFileInfo` using `ListBlobsByHierarchy` instead of `ListBlobs`
- Re-implement `CreateDir` with an upfront HNS support check instead of falling back to Blobs API after an error
- Add comprehensive tests to `CreateDir`
- Add `HasSubmitBatchBug` to check if a test inside any scenario is affected by a certain Azurite issue
- Implement `DeleteDir` to work properly on flat namespace storage accounts (non-HNS accounts)
- ### Are these changes tested?
Yes. By existing and new tests added by this PR itself.
* Closes: apache#38772
Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Signed-off-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[C++][FS][Azure] Should GetFileInfo() against a directory always return true without hierarchical namespace support?

3 participants

@felipecrv@kou@Tom-Newton
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS - #39361

Merged
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics
Jan 5, 2024
Merged

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS#39361
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics

Conversation

@felipecrv

@felipecrvfelipecrv commented Dec 24, 2023

Copy link
Copy Markdown
Contributor

Rationale for this change

The FileSystem implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.

What changes are included in this PR?

  • Skip fewer tests
  • Re-implement GetFileInfo using ListBlobsByHierarchy instead of ListBlobs
  • Re-implement CreateDir with an upfront HNS support check instead of falling back to Blobs API after an error
  • Add comprehensive tests to CreateDir
  • Add HasSubmitBatchBug to check if a test inside any scenario is affected by a certain Azurite issue
  • Implement DeleteDir to work properly on flat namespace storage accounts (non-HNS accounts)

Are these changes tested?

Yes. By existing and new tests added by this PR itself.

@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton

@Tom-NewtonTom-Newton left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not reviewed everything yet. I have a few comments, but generally I think it looks great so far.

Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
auto dir_marker_blob_path = internal::EnsureTrailingSlash(location.path);
return container_client.GetBlobClient(dir_marker_blob_path).AsBlockBlobClient();
},
[](auto& block_blob_client) { block_blob_client.UploadFrom(nullptr, 0); },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be a good idea to put some metadata on all directory marker blobs we create. That would allow us to add a simple checks in ObjectInputFile::Init and ObjectAppendStream::Init to ensure they are not being initialised as directories.

Additionally I think this will not be compatible with adlfs if it does not add metadata to directory markers. I think its very likely that people will end up using a combination of this arrow filesystem and adlfs.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I would like to be as compatible as possible with existing specs. But to clarify, what do you mean when you say adlfs? Don't you mean abfs instead [1]?

[1] https://github.com/apache/hadoop/blob/trunk/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AzureBlobFileSystem.java

I think there is a confusion between abfs (filesystem semantics over the Blobs API) and adlfs (the separate service that Azure created that can also be accessed via the Blobs API with some restrictions).

The fsspec repo seems to be linking both abfs and adlfs to the same thing, but they shouldn't be considered the same thing: https://github.com/fsspec/filesystem_spec/blob/0ffe06cb767456b7c13904b57ec1c3ca60d53eae/docs/source/api.rst?plain=1#L229

Tell me what I'm missing here because my experience with Azure is restricted just to reading the docs (a lot of them) recently.

@Tom-NewtonTom-NewtonDec 26, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, in this case I mean the adlfs pip repo. It's the Azure fsspec implementation.

@Tom-NewtonTom-NewtonJan 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More specifically I think we should add some metadata which will be compatible such that https://github.com/fsspec/adlfs/blob/32132c4094350fca2680155a5c236f2e9f991ba5/adlfs/spec.py#L855-L870 can correctly detect the directories.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot this, but I will add this change now.

Comment threadcpp/src/arrow/filesystem/azurefs_test.cc Outdated
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Dec 24, 2023
Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Jan 1, 2024
Comment threadcpp/src/arrow/filesystem/azurefs.cc
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton@kou I pushed changes based on your feedback. I would love to merge it before tomorrow's release cut.

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@kou

kou commented Jan 4, 2024

Copy link
Copy Markdown
Member

Could you check CI failures?

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3814

[ RUN ] TestAzuriteFileSystem.DeleteDirContentsSuccessDirectory
/arrow/cpp/src/arrow/filesystem/test_util.cc:143: Failure
Expected equality of these values:
info.type()
Which is: FileType::Directory
type
Which is: FileType::NotFound
For path 'hfqilxw9uhk7xqbathiwbudo4ci9dp9w/0iav1y3m4u53d5wvtp8g2j5af1o4s694'

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3680

[ RUN ] TestAzuriteFileSystem.DeleteDirSuccessNonexistent
/arrow/cpp/src/arrow/filesystem/azurefs_test.cc:1301: Failure
Failed
'fs()->DeleteDir(directory_path)' failed with IOError: Path does not exist 'go9qhglaypjhxnprrxc79a0e3xtceml1/bwumjdfql0n8hizvv1kd3jn75ucrlw4u'. Detail: [errno 2] No such file or directory

@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 4, 2024
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@kou done. These turned out to be Azurite-only tests that needed updating since the semantics are now different than what was assumed when the tests were written.

@felipecrv
felipecrv requested a review from kouJanuary 4, 2024 22:27
@felipecrvfelipecrv added this to the 15.0.0 milestone Jan 4, 2024
kou
kou approved these changes Jan 5, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Jan 5, 2024
@felipecrv
felipecrv merged commit aae6fa4 into apache:mainJan 5, 2024
@felipecrvfelipecrv removed the awaiting merge Awaiting merge label Jan 5, 2024
@felipecrv
felipecrv deleted the azure_dir_semantics branch January 5, 2024 15:44
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit aae6fa4.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…rage account doesn't support HNS (apache#39361)
### Rationale for this change
The `FileSystem` implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.
### What changes are included in this PR?
- Skip fewer tests
- Re-implement `GetFileInfo` using `ListBlobsByHierarchy` instead of `ListBlobs`
- Re-implement `CreateDir` with an upfront HNS support check instead of falling back to Blobs API after an error
- Add comprehensive tests to `CreateDir`
- Add `HasSubmitBatchBug` to check if a test inside any scenario is affected by a certain Azurite issue
- Implement `DeleteDir` to work properly on flat namespace storage accounts (non-HNS accounts)
- ### Are these changes tested?
Yes. By existing and new tests added by this PR itself.
* Closes: apache#38772
Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Signed-off-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[C++][FS][Azure] Should GetFileInfo() against a directory always return true without hierarchical namespace support?

3 participants

@felipecrv@kou@Tom-Newton
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS - #39361

Merged
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics
Jan 5, 2024
Merged

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS#39361
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics

Conversation

@felipecrv

@felipecrvfelipecrv commented Dec 24, 2023

Copy link
Copy Markdown
Contributor

Rationale for this change

The FileSystem implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.

What changes are included in this PR?

  • Skip fewer tests
  • Re-implement GetFileInfo using ListBlobsByHierarchy instead of ListBlobs
  • Re-implement CreateDir with an upfront HNS support check instead of falling back to Blobs API after an error
  • Add comprehensive tests to CreateDir
  • Add HasSubmitBatchBug to check if a test inside any scenario is affected by a certain Azurite issue
  • Implement DeleteDir to work properly on flat namespace storage accounts (non-HNS accounts)

Are these changes tested?

Yes. By existing and new tests added by this PR itself.

@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton

@Tom-NewtonTom-Newton left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not reviewed everything yet. I have a few comments, but generally I think it looks great so far.

Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
auto dir_marker_blob_path = internal::EnsureTrailingSlash(location.path);
return container_client.GetBlobClient(dir_marker_blob_path).AsBlockBlobClient();
},
[](auto& block_blob_client) { block_blob_client.UploadFrom(nullptr, 0); },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be a good idea to put some metadata on all directory marker blobs we create. That would allow us to add a simple checks in ObjectInputFile::Init and ObjectAppendStream::Init to ensure they are not being initialised as directories.

Additionally I think this will not be compatible with adlfs if it does not add metadata to directory markers. I think its very likely that people will end up using a combination of this arrow filesystem and adlfs.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I would like to be as compatible as possible with existing specs. But to clarify, what do you mean when you say adlfs? Don't you mean abfs instead [1]?

[1] https://github.com/apache/hadoop/blob/trunk/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AzureBlobFileSystem.java

I think there is a confusion between abfs (filesystem semantics over the Blobs API) and adlfs (the separate service that Azure created that can also be accessed via the Blobs API with some restrictions).

The fsspec repo seems to be linking both abfs and adlfs to the same thing, but they shouldn't be considered the same thing: https://github.com/fsspec/filesystem_spec/blob/0ffe06cb767456b7c13904b57ec1c3ca60d53eae/docs/source/api.rst?plain=1#L229

Tell me what I'm missing here because my experience with Azure is restricted just to reading the docs (a lot of them) recently.

@Tom-NewtonTom-NewtonDec 26, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, in this case I mean the adlfs pip repo. It's the Azure fsspec implementation.

@Tom-NewtonTom-NewtonJan 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More specifically I think we should add some metadata which will be compatible such that https://github.com/fsspec/adlfs/blob/32132c4094350fca2680155a5c236f2e9f991ba5/adlfs/spec.py#L855-L870 can correctly detect the directories.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot this, but I will add this change now.

Comment threadcpp/src/arrow/filesystem/azurefs_test.cc Outdated
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Dec 24, 2023
Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Jan 1, 2024
Comment threadcpp/src/arrow/filesystem/azurefs.cc
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton@kou I pushed changes based on your feedback. I would love to merge it before tomorrow's release cut.

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@kou

kou commented Jan 4, 2024

Copy link
Copy Markdown
Member

Could you check CI failures?

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3814

[ RUN ] TestAzuriteFileSystem.DeleteDirContentsSuccessDirectory
/arrow/cpp/src/arrow/filesystem/test_util.cc:143: Failure
Expected equality of these values:
info.type()
Which is: FileType::Directory
type
Which is: FileType::NotFound
For path 'hfqilxw9uhk7xqbathiwbudo4ci9dp9w/0iav1y3m4u53d5wvtp8g2j5af1o4s694'

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3680

[ RUN ] TestAzuriteFileSystem.DeleteDirSuccessNonexistent
/arrow/cpp/src/arrow/filesystem/azurefs_test.cc:1301: Failure
Failed
'fs()->DeleteDir(directory_path)' failed with IOError: Path does not exist 'go9qhglaypjhxnprrxc79a0e3xtceml1/bwumjdfql0n8hizvv1kd3jn75ucrlw4u'. Detail: [errno 2] No such file or directory

@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 4, 2024
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@kou done. These turned out to be Azurite-only tests that needed updating since the semantics are now different than what was assumed when the tests were written.

@felipecrv
felipecrv requested a review from kouJanuary 4, 2024 22:27
@felipecrvfelipecrv added this to the 15.0.0 milestone Jan 4, 2024
kou
kou approved these changes Jan 5, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Jan 5, 2024
@felipecrv
felipecrv merged commit aae6fa4 into apache:mainJan 5, 2024
@felipecrvfelipecrv removed the awaiting merge Awaiting merge label Jan 5, 2024
@felipecrv
felipecrv deleted the azure_dir_semantics branch January 5, 2024 15:44
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit aae6fa4.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…rage account doesn't support HNS (apache#39361)
### Rationale for this change
The `FileSystem` implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.
### What changes are included in this PR?
- Skip fewer tests
- Re-implement `GetFileInfo` using `ListBlobsByHierarchy` instead of `ListBlobs`
- Re-implement `CreateDir` with an upfront HNS support check instead of falling back to Blobs API after an error
- Add comprehensive tests to `CreateDir`
- Add `HasSubmitBatchBug` to check if a test inside any scenario is affected by a certain Azurite issue
- Implement `DeleteDir` to work properly on flat namespace storage accounts (non-HNS accounts)
- ### Are these changes tested?
Yes. By existing and new tests added by this PR itself.
* Closes: apache#38772
Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Signed-off-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[C++][FS][Azure] Should GetFileInfo() against a directory always return true without hierarchical namespace support?

3 participants

@felipecrv@kou@Tom-Newton
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS - #39361

Merged
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics
Jan 5, 2024
Merged

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS#39361
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics

Conversation

@felipecrv

@felipecrvfelipecrv commented Dec 24, 2023

Copy link
Copy Markdown
Contributor

Rationale for this change

The FileSystem implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.

What changes are included in this PR?

  • Skip fewer tests
  • Re-implement GetFileInfo using ListBlobsByHierarchy instead of ListBlobs
  • Re-implement CreateDir with an upfront HNS support check instead of falling back to Blobs API after an error
  • Add comprehensive tests to CreateDir
  • Add HasSubmitBatchBug to check if a test inside any scenario is affected by a certain Azurite issue
  • Implement DeleteDir to work properly on flat namespace storage accounts (non-HNS accounts)

Are these changes tested?

Yes. By existing and new tests added by this PR itself.

@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton

@Tom-NewtonTom-Newton left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not reviewed everything yet. I have a few comments, but generally I think it looks great so far.

Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
auto dir_marker_blob_path = internal::EnsureTrailingSlash(location.path);
return container_client.GetBlobClient(dir_marker_blob_path).AsBlockBlobClient();
},
[](auto& block_blob_client) { block_blob_client.UploadFrom(nullptr, 0); },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be a good idea to put some metadata on all directory marker blobs we create. That would allow us to add a simple checks in ObjectInputFile::Init and ObjectAppendStream::Init to ensure they are not being initialised as directories.

Additionally I think this will not be compatible with adlfs if it does not add metadata to directory markers. I think its very likely that people will end up using a combination of this arrow filesystem and adlfs.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I would like to be as compatible as possible with existing specs. But to clarify, what do you mean when you say adlfs? Don't you mean abfs instead [1]?

[1] https://github.com/apache/hadoop/blob/trunk/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AzureBlobFileSystem.java

I think there is a confusion between abfs (filesystem semantics over the Blobs API) and adlfs (the separate service that Azure created that can also be accessed via the Blobs API with some restrictions).

The fsspec repo seems to be linking both abfs and adlfs to the same thing, but they shouldn't be considered the same thing: https://github.com/fsspec/filesystem_spec/blob/0ffe06cb767456b7c13904b57ec1c3ca60d53eae/docs/source/api.rst?plain=1#L229

Tell me what I'm missing here because my experience with Azure is restricted just to reading the docs (a lot of them) recently.

@Tom-NewtonTom-NewtonDec 26, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, in this case I mean the adlfs pip repo. It's the Azure fsspec implementation.

@Tom-NewtonTom-NewtonJan 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More specifically I think we should add some metadata which will be compatible such that https://github.com/fsspec/adlfs/blob/32132c4094350fca2680155a5c236f2e9f991ba5/adlfs/spec.py#L855-L870 can correctly detect the directories.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot this, but I will add this change now.

Comment threadcpp/src/arrow/filesystem/azurefs_test.cc Outdated
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Dec 24, 2023
Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Jan 1, 2024
Comment threadcpp/src/arrow/filesystem/azurefs.cc
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton@kou I pushed changes based on your feedback. I would love to merge it before tomorrow's release cut.

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@kou

kou commented Jan 4, 2024

Copy link
Copy Markdown
Member

Could you check CI failures?

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3814

[ RUN ] TestAzuriteFileSystem.DeleteDirContentsSuccessDirectory
/arrow/cpp/src/arrow/filesystem/test_util.cc:143: Failure
Expected equality of these values:
info.type()
Which is: FileType::Directory
type
Which is: FileType::NotFound
For path 'hfqilxw9uhk7xqbathiwbudo4ci9dp9w/0iav1y3m4u53d5wvtp8g2j5af1o4s694'

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3680

[ RUN ] TestAzuriteFileSystem.DeleteDirSuccessNonexistent
/arrow/cpp/src/arrow/filesystem/azurefs_test.cc:1301: Failure
Failed
'fs()->DeleteDir(directory_path)' failed with IOError: Path does not exist 'go9qhglaypjhxnprrxc79a0e3xtceml1/bwumjdfql0n8hizvv1kd3jn75ucrlw4u'. Detail: [errno 2] No such file or directory

@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 4, 2024
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@kou done. These turned out to be Azurite-only tests that needed updating since the semantics are now different than what was assumed when the tests were written.

@felipecrv
felipecrv requested a review from kouJanuary 4, 2024 22:27
@felipecrvfelipecrv added this to the 15.0.0 milestone Jan 4, 2024
kou
kou approved these changes Jan 5, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Jan 5, 2024
@felipecrv
felipecrv merged commit aae6fa4 into apache:mainJan 5, 2024
@felipecrvfelipecrv removed the awaiting merge Awaiting merge label Jan 5, 2024
@felipecrv
felipecrv deleted the azure_dir_semantics branch January 5, 2024 15:44
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit aae6fa4.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…rage account doesn't support HNS (apache#39361)
### Rationale for this change
The `FileSystem` implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.
### What changes are included in this PR?
- Skip fewer tests
- Re-implement `GetFileInfo` using `ListBlobsByHierarchy` instead of `ListBlobs`
- Re-implement `CreateDir` with an upfront HNS support check instead of falling back to Blobs API after an error
- Add comprehensive tests to `CreateDir`
- Add `HasSubmitBatchBug` to check if a test inside any scenario is affected by a certain Azurite issue
- Implement `DeleteDir` to work properly on flat namespace storage accounts (non-HNS accounts)
- ### Are these changes tested?
Yes. By existing and new tests added by this PR itself.
* Closes: apache#38772
Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Signed-off-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[C++][FS][Azure] Should GetFileInfo() against a directory always return true without hierarchical namespace support?

3 participants

@felipecrv@kou@Tom-Newton
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS - #39361

Merged
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics
Jan 5, 2024
Merged

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS#39361
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics

Conversation

@felipecrv

@felipecrvfelipecrv commented Dec 24, 2023

Copy link
Copy Markdown
Contributor

Rationale for this change

The FileSystem implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.

What changes are included in this PR?

  • Skip fewer tests
  • Re-implement GetFileInfo using ListBlobsByHierarchy instead of ListBlobs
  • Re-implement CreateDir with an upfront HNS support check instead of falling back to Blobs API after an error
  • Add comprehensive tests to CreateDir
  • Add HasSubmitBatchBug to check if a test inside any scenario is affected by a certain Azurite issue
  • Implement DeleteDir to work properly on flat namespace storage accounts (non-HNS accounts)

Are these changes tested?

Yes. By existing and new tests added by this PR itself.

@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton

@Tom-NewtonTom-Newton left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not reviewed everything yet. I have a few comments, but generally I think it looks great so far.

Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
auto dir_marker_blob_path = internal::EnsureTrailingSlash(location.path);
return container_client.GetBlobClient(dir_marker_blob_path).AsBlockBlobClient();
},
[](auto& block_blob_client) { block_blob_client.UploadFrom(nullptr, 0); },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be a good idea to put some metadata on all directory marker blobs we create. That would allow us to add a simple checks in ObjectInputFile::Init and ObjectAppendStream::Init to ensure they are not being initialised as directories.

Additionally I think this will not be compatible with adlfs if it does not add metadata to directory markers. I think its very likely that people will end up using a combination of this arrow filesystem and adlfs.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I would like to be as compatible as possible with existing specs. But to clarify, what do you mean when you say adlfs? Don't you mean abfs instead [1]?

[1] https://github.com/apache/hadoop/blob/trunk/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AzureBlobFileSystem.java

I think there is a confusion between abfs (filesystem semantics over the Blobs API) and adlfs (the separate service that Azure created that can also be accessed via the Blobs API with some restrictions).

The fsspec repo seems to be linking both abfs and adlfs to the same thing, but they shouldn't be considered the same thing: https://github.com/fsspec/filesystem_spec/blob/0ffe06cb767456b7c13904b57ec1c3ca60d53eae/docs/source/api.rst?plain=1#L229

Tell me what I'm missing here because my experience with Azure is restricted just to reading the docs (a lot of them) recently.

@Tom-NewtonTom-NewtonDec 26, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, in this case I mean the adlfs pip repo. It's the Azure fsspec implementation.

@Tom-NewtonTom-NewtonJan 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More specifically I think we should add some metadata which will be compatible such that https://github.com/fsspec/adlfs/blob/32132c4094350fca2680155a5c236f2e9f991ba5/adlfs/spec.py#L855-L870 can correctly detect the directories.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot this, but I will add this change now.

Comment threadcpp/src/arrow/filesystem/azurefs_test.cc Outdated
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Dec 24, 2023
Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Jan 1, 2024
Comment threadcpp/src/arrow/filesystem/azurefs.cc
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton@kou I pushed changes based on your feedback. I would love to merge it before tomorrow's release cut.

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@kou

kou commented Jan 4, 2024

Copy link
Copy Markdown
Member

Could you check CI failures?

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3814

[ RUN ] TestAzuriteFileSystem.DeleteDirContentsSuccessDirectory
/arrow/cpp/src/arrow/filesystem/test_util.cc:143: Failure
Expected equality of these values:
info.type()
Which is: FileType::Directory
type
Which is: FileType::NotFound
For path 'hfqilxw9uhk7xqbathiwbudo4ci9dp9w/0iav1y3m4u53d5wvtp8g2j5af1o4s694'

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3680

[ RUN ] TestAzuriteFileSystem.DeleteDirSuccessNonexistent
/arrow/cpp/src/arrow/filesystem/azurefs_test.cc:1301: Failure
Failed
'fs()->DeleteDir(directory_path)' failed with IOError: Path does not exist 'go9qhglaypjhxnprrxc79a0e3xtceml1/bwumjdfql0n8hizvv1kd3jn75ucrlw4u'. Detail: [errno 2] No such file or directory

@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 4, 2024
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@kou done. These turned out to be Azurite-only tests that needed updating since the semantics are now different than what was assumed when the tests were written.

@felipecrv
felipecrv requested a review from kouJanuary 4, 2024 22:27
@felipecrvfelipecrv added this to the 15.0.0 milestone Jan 4, 2024
kou
kou approved these changes Jan 5, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Jan 5, 2024
@felipecrv
felipecrv merged commit aae6fa4 into apache:mainJan 5, 2024
@felipecrvfelipecrv removed the awaiting merge Awaiting merge label Jan 5, 2024
@felipecrv
felipecrv deleted the azure_dir_semantics branch January 5, 2024 15:44
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit aae6fa4.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…rage account doesn't support HNS (apache#39361)
### Rationale for this change
The `FileSystem` implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.
### What changes are included in this PR?
- Skip fewer tests
- Re-implement `GetFileInfo` using `ListBlobsByHierarchy` instead of `ListBlobs`
- Re-implement `CreateDir` with an upfront HNS support check instead of falling back to Blobs API after an error
- Add comprehensive tests to `CreateDir`
- Add `HasSubmitBatchBug` to check if a test inside any scenario is affected by a certain Azurite issue
- Implement `DeleteDir` to work properly on flat namespace storage accounts (non-HNS accounts)
- ### Are these changes tested?
Yes. By existing and new tests added by this PR itself.
* Closes: apache#38772
Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Signed-off-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[C++][FS][Azure] Should GetFileInfo() against a directory always return true without hierarchical namespace support?

3 participants

@felipecrv@kou@Tom-Newton
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS - #39361

Merged
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics
Jan 5, 2024
Merged

GH-38772: [C++] Implement directory semantics even when the storage account doesn't support HNS#39361
felipecrv merged 24 commits into
apache:mainfrom
felipecrv:azure_dir_semantics

Conversation

@felipecrv

@felipecrvfelipecrv commented Dec 24, 2023

Copy link
Copy Markdown
Contributor

Rationale for this change

The FileSystem implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.

What changes are included in this PR?

  • Skip fewer tests
  • Re-implement GetFileInfo using ListBlobsByHierarchy instead of ListBlobs
  • Re-implement CreateDir with an upfront HNS support check instead of falling back to Blobs API after an error
  • Add comprehensive tests to CreateDir
  • Add HasSubmitBatchBug to check if a test inside any scenario is affected by a certain Azurite issue
  • Implement DeleteDir to work properly on flat namespace storage accounts (non-HNS accounts)

Are these changes tested?

Yes. By existing and new tests added by this PR itself.

@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton

@Tom-NewtonTom-Newton left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not reviewed everything yet. I have a few comments, but generally I think it looks great so far.

Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
auto dir_marker_blob_path = internal::EnsureTrailingSlash(location.path);
return container_client.GetBlobClient(dir_marker_blob_path).AsBlockBlobClient();
},
[](auto& block_blob_client) { block_blob_client.UploadFrom(nullptr, 0); },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be a good idea to put some metadata on all directory marker blobs we create. That would allow us to add a simple checks in ObjectInputFile::Init and ObjectAppendStream::Init to ensure they are not being initialised as directories.

Additionally I think this will not be compatible with adlfs if it does not add metadata to directory markers. I think its very likely that people will end up using a combination of this arrow filesystem and adlfs.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I would like to be as compatible as possible with existing specs. But to clarify, what do you mean when you say adlfs? Don't you mean abfs instead [1]?

[1] https://github.com/apache/hadoop/blob/trunk/hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AzureBlobFileSystem.java

I think there is a confusion between abfs (filesystem semantics over the Blobs API) and adlfs (the separate service that Azure created that can also be accessed via the Blobs API with some restrictions).

The fsspec repo seems to be linking both abfs and adlfs to the same thing, but they shouldn't be considered the same thing: https://github.com/fsspec/filesystem_spec/blob/0ffe06cb767456b7c13904b57ec1c3ca60d53eae/docs/source/api.rst?plain=1#L229

Tell me what I'm missing here because my experience with Azure is restricted just to reading the docs (a lot of them) recently.

@Tom-NewtonTom-NewtonDec 26, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, in this case I mean the adlfs pip repo. It's the Azure fsspec implementation.

@Tom-NewtonTom-NewtonJan 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More specifically I think we should add some metadata which will be compatible such that https://github.com/fsspec/adlfs/blob/32132c4094350fca2680155a5c236f2e9f991ba5/adlfs/spec.py#L855-L870 can correctly detect the directories.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot this, but I will add this change now.

Comment threadcpp/src/arrow/filesystem/azurefs_test.cc Outdated
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Dec 24, 2023
Comment threadcpp/src/arrow/filesystem/azurefs.cc
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
Comment threadcpp/src/arrow/filesystem/azurefs.cc Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Jan 1, 2024
Comment threadcpp/src/arrow/filesystem/azurefs.cc
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@Tom-Newton@kou I pushed changes based on your feedback. I would love to merge it before tomorrow's release cut.

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@kou

kou commented Jan 4, 2024

Copy link
Copy Markdown
Member

Could you check CI failures?

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3814

[ RUN ] TestAzuriteFileSystem.DeleteDirContentsSuccessDirectory
/arrow/cpp/src/arrow/filesystem/test_util.cc:143: Failure
Expected equality of these values:
info.type()
Which is: FileType::Directory
type
Which is: FileType::NotFound
For path 'hfqilxw9uhk7xqbathiwbudo4ci9dp9w/0iav1y3m4u53d5wvtp8g2j5af1o4s694'

https://github.com/apache/arrow/actions/runs/7414494286/job/20175680211?pr=39361#step:6:3680

[ RUN ] TestAzuriteFileSystem.DeleteDirSuccessNonexistent
/arrow/cpp/src/arrow/filesystem/azurefs_test.cc:1301: Failure
Failed
'fs()->DeleteDir(directory_path)' failed with IOError: Path does not exist 'go9qhglaypjhxnprrxc79a0e3xtceml1/bwumjdfql0n8hizvv1kd3jn75ucrlw4u'. Detail: [errno 2] No such file or directory

@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 4, 2024
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 4, 2024
@felipecrv

Copy link
Copy Markdown
ContributorAuthor

@kou done. These turned out to be Azurite-only tests that needed updating since the semantics are now different than what was assumed when the tests were written.

@felipecrv
felipecrv requested a review from kouJanuary 4, 2024 22:27
@felipecrvfelipecrv added this to the 15.0.0 milestone Jan 4, 2024
kou
kou approved these changes Jan 5, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Jan 5, 2024
@felipecrv
felipecrv merged commit aae6fa4 into apache:mainJan 5, 2024
@felipecrvfelipecrv removed the awaiting merge Awaiting merge label Jan 5, 2024
@felipecrv
felipecrv deleted the azure_dir_semantics branch January 5, 2024 15:44
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit aae6fa4.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…rage account doesn't support HNS (apache#39361)
### Rationale for this change
The `FileSystem` implementation based on Azure Blob Storage should implement directory operations according to filesystem semantics. When Hierarchical Namespace (HNS) is enabled, we can rely on Azure Data Lake Storage Gen 2 APIs implementing the filesystem semantics for us, but when all we have is the Blobs API, we should emulate it.
### What changes are included in this PR?
- Skip fewer tests
- Re-implement `GetFileInfo` using `ListBlobsByHierarchy` instead of `ListBlobs`
- Re-implement `CreateDir` with an upfront HNS support check instead of falling back to Blobs API after an error
- Add comprehensive tests to `CreateDir`
- Add `HasSubmitBatchBug` to check if a test inside any scenario is affected by a certain Azurite issue
- Implement `DeleteDir` to work properly on flat namespace storage accounts (non-HNS accounts)
- ### Are these changes tested?
Yes. By existing and new tests added by this PR itself.
* Closes: apache#38772
Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Signed-off-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[C++][FS][Azure] Should GetFileInfo() against a directory always return true without hierarchical namespace support?

3 participants

@felipecrv@kou@Tom-Newton