Merge pull request #64 from umbraco/bugfix/use-directory-delimiter

ronaldbarendse · web-flow · commit a285ce7a61a8 · 2024-03-07T09:02:33.000+01:00
Use directory delimiter when listing blobs
diff --git a/src/Umbraco.StorageProviders.AzureBlob/IO/AzureBlobFileSystem.cs b/src/Umbraco.StorageProviders.AzureBlob/IO/AzureBlobFileSystem.cs
@@ -1,9 +1,3 @@
-using System;
-using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
-using System.IO;
-using System.Linq;
-using System.Threading.Tasks;
 using Azure;
 using Azure.Storage.Blobs;
 using Azure.Storage.Blobs.Models;
@@ -59,6 +53,7 @@ public AzureBlobFileSystem(AzureBlobFileSystemOptions options, IHostingEnvironme
         /// <exception cref="System.ArgumentNullException"><paramref name="blobContainerClient" /> is <c>null</c>.</exception>
         /// <exception cref="System.ArgumentNullException"><paramref name="ioHelper" /> is <c>null</c>.</exception>
         /// <exception cref="System.ArgumentNullException"><paramref name="contentTypeProvider" /> is <c>null</c>.</exception>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "This parameter is only a part of the URL.")]
         public AzureBlobFileSystem(string rootUrl, BlobContainerClient blobContainerClient, IIOHelper ioHelper, IContentTypeProvider contentTypeProvider, string? containerRootPath = null)
         {
             ArgumentNullException.ThrowIfNull(rootUrl);
@@ -98,7 +93,7 @@ public IEnumerable<string> GetDirectories(string path)
         {
             ArgumentNullException.ThrowIfNull(path);
 
-            return ListBlobs(GetDirectoryPath(path))
+            return ListBlobs(path)
                 .Where(x => x.IsPrefix)
                 .Select(x => GetRelativePath($"/{x.Prefix}").Trim('/'));
         }
@@ -118,13 +113,9 @@ public void DeleteDirectory(string path, bool recursive)
         {
             ArgumentNullException.ThrowIfNull(path);
 
-            foreach (var blob in ListBlobs(GetDirectoryPath(path)))
+            foreach (BlobHierarchyItem blob in ListBlobs(path, true))
             {
-                if (blob.IsPrefix)
-                {
-                    DeleteDirectory(blob.Prefix, true);
-                }
-                else if (blob.IsBlob)
+                if (blob.IsBlob)
                 {
                     _container.GetBlobClient(blob.Blob.Name).DeleteIfExists();
                 }
@@ -137,7 +128,10 @@ public bool DirectoryExists(string path)
         {
             ArgumentNullException.ThrowIfNull(path);
 
-            return GetBlobClient(GetDirectoryPath(path)).Exists();
+            // Try getting a single item/page
+            Page<BlobHierarchyItem>? firstPage = ListBlobs(path).AsPages(pageSizeHint: 1).FirstOrDefault();
+
+            return firstPage?.Values.Count > 0;
         }
 
         /// <inheritdoc />
@@ -159,10 +153,10 @@ public void AddFile(string path, Stream stream, bool overrideIfExists)
             ArgumentNullException.ThrowIfNull(path);
             ArgumentNullException.ThrowIfNull(stream);
 
-            var blob = GetBlobClient(path);
+            BlobClient blob = GetBlobClient(path);
             if (!overrideIfExists && blob.Exists())
             {
-                throw new InvalidOperationException($"A file at path '{path}' already exists");
+                throw new InvalidOperationException($"A file at path '{path}' already exists.");
             }
 
             var headers = new BlobHttpHeaders();
@@ -187,10 +181,10 @@ public void AddFile(string path, string physicalPath, bool overrideIfExists = tr
             ArgumentNullException.ThrowIfNull(path);
             ArgumentNullException.ThrowIfNull(physicalPath);
 
-            var destinationBlob = GetBlobClient(path);
+            BlobClient destinationBlob = GetBlobClient(path);
             if (!overrideIfExists && destinationBlob.Exists())
             {
-                throw new InvalidOperationException($"A file at path '{path}' already exists");
+                throw new InvalidOperationException($"A file at path '{path}' already exists.");
             }
 
             var sourceBlob = GetBlobClient(physicalPath);
@@ -227,7 +221,7 @@ public IEnumerable<string> GetFiles(string path, string? filter)
         {
             ArgumentNullException.ThrowIfNull(path);
 
-            var files = ListBlobs(GetDirectoryPath(path)).Where(x => x.IsBlob).Select(x => x.Blob.Name);
+            IEnumerable<string> files = ListBlobs(path).Where(x => x.IsBlob).Select(x => x.Blob.Name);
             if (!string.IsNullOrEmpty(filter) && filter != "*.*")
             {
                 // TODO: Might be better to use a globbing library
@@ -267,6 +261,7 @@ public bool FileExists(string path)
 
         /// <inheritdoc />
         /// <exception cref="System.ArgumentNullException"><paramref name="fullPathOrUrl" /> is <c>null</c>.</exception>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "This method is inherited from an interface.")]
         public string GetRelativePath(string fullPathOrUrl)
         {
             ArgumentNullException.ThrowIfNull(fullPathOrUrl);
@@ -297,6 +292,7 @@ public string GetFullPath(string path)
 
         /// <inheritdoc />
         /// <exception cref="System.ArgumentNullException"><paramref name="path" /> is <c>null</c>.</exception>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1055:URI-like return values should not be strings", Justification = "This method is inherited from an interface.")]
         public string GetUrl(string? path)
         {
             ArgumentNullException.ThrowIfNull(path);
@@ -337,7 +333,7 @@ public BlobClient GetBlobClient(string path)
         {
             ArgumentNullException.ThrowIfNull(path);
 
-            return _container.GetBlobClient(GetBlobPath(path));
+            return _container.GetBlobClient(GetBlobName(path));
         }
 
         /// <inheritdoc />
@@ -346,19 +342,15 @@ public BlobClient GetBlobClient(string path)
         private static string EnsureUrlSeparatorChar(string path)
             => path.Replace("\\", "/", StringComparison.InvariantCultureIgnoreCase);
 
-        private string GetDirectoryPath(string fullPathOrUrl)
+        private Pageable<BlobHierarchyItem> ListBlobs(string path, bool recursive = false)
         {
-            var path = GetFullPath(fullPathOrUrl);
+            string? delimiter = recursive ? null : "/";
+            string prefix = GetFullPath(path).EnsureEndsWith('/');
 
-            return path.Length == 0 ? path : path.EnsureEndsWith('/');
-        }
-
-        private IEnumerable<BlobHierarchyItem> ListBlobs(string path)
-        {
-            return _container.GetBlobsByHierarchy(prefix: path);
+            return _container.GetBlobsByHierarchy(delimiter: delimiter, prefix: prefix);
         }
 
-        private string GetBlobPath(string path)
+        private string GetBlobName(string path)
         {
             path = EnsureUrlSeparatorChar(path);
 
diff --git a/version.json b/version.json
@@ -1,6 +1,6 @@
 {
-  "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "10.1.0-alpha",
+  "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json",
+  "version": "10.0.1",
   "assemblyVersion": {
     "precision": "build"
   },
@@ -20,4 +20,4 @@
   "release": {
     "branchName": "release/{version}"
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,3 @@`
`1`		`-using System;`
`2`		`-using System.Collections.Generic;`
`3`		`-using System.Diagnostics.CodeAnalysis;`
`4`		`-using System.IO;`
`5`		`-using System.Linq;`
`6`		`-using System.Threading.Tasks;`
`7`	`1`	`using Azure;`
`8`	`2`	`using Azure.Storage.Blobs;`
`9`	`3`	`using Azure.Storage.Blobs.Models;`
`@@ -59,6 +53,7 @@ public AzureBlobFileSystem(AzureBlobFileSystemOptions options, IHostingEnvironme`
`59`	`53`	`/// <exception cref="System.ArgumentNullException"><paramref name="blobContainerClient" /> is <c>null</c>.</exception>`
`60`	`54`	`/// <exception cref="System.ArgumentNullException"><paramref name="ioHelper" /> is <c>null</c>.</exception>`
`61`	`55`	`/// <exception cref="System.ArgumentNullException"><paramref name="contentTypeProvider" /> is <c>null</c>.</exception>`
	`56`	`+ [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "This parameter is only a part of the URL.")]`
`62`	`57`	`public AzureBlobFileSystem(string rootUrl, BlobContainerClient blobContainerClient, IIOHelper ioHelper, IContentTypeProvider contentTypeProvider, string? containerRootPath = null)`
`63`	`58`	`{`
`64`	`59`	`ArgumentNullException.ThrowIfNull(rootUrl);`
`@@ -98,7 +93,7 @@ public IEnumerable<string> GetDirectories(string path)`
`98`	`93`	`{`
`99`	`94`	`ArgumentNullException.ThrowIfNull(path);`
`100`	`95`
`101`		`- return ListBlobs(GetDirectoryPath(path))`
	`96`	`+ return ListBlobs(path)`
`102`	`97`	`.Where(x => x.IsPrefix)`
`103`	`98`	`.Select(x => GetRelativePath($"/{x.Prefix}").Trim('/'));`
`104`	`99`	`}`
`@@ -118,13 +113,9 @@ public void DeleteDirectory(string path, bool recursive)`
`118`	`113`	`{`
`119`	`114`	`ArgumentNullException.ThrowIfNull(path);`
`120`	`115`
`121`		`- foreach (var blob in ListBlobs(GetDirectoryPath(path)))`
	`116`	`+ foreach (BlobHierarchyItem blob in ListBlobs(path, true))`
`122`	`117`	`{`
`123`		`- if (blob.IsPrefix)`
`124`		`- {`
`125`		`- DeleteDirectory(blob.Prefix, true);`
`126`		`- }`
`127`		`- else if (blob.IsBlob)`
	`118`	`+ if (blob.IsBlob)`
`128`	`119`	`{`
`129`	`120`	`_container.GetBlobClient(blob.Blob.Name).DeleteIfExists();`
`130`	`121`	`}`
`@@ -137,7 +128,10 @@ public bool DirectoryExists(string path)`
`137`	`128`	`{`
`138`	`129`	`ArgumentNullException.ThrowIfNull(path);`
`139`	`130`
`140`		`- return GetBlobClient(GetDirectoryPath(path)).Exists();`
	`131`	`+ // Try getting a single item/page`
	`132`	`+ Page<BlobHierarchyItem>? firstPage = ListBlobs(path).AsPages(pageSizeHint: 1).FirstOrDefault();`
	`133`	`+`
	`134`	`+ return firstPage?.Values.Count > 0;`
`141`	`135`	`}`
`142`	`136`
`143`	`137`	`/// <inheritdoc />`
`@@ -159,10 +153,10 @@ public void AddFile(string path, Stream stream, bool overrideIfExists)`
`159`	`153`	`ArgumentNullException.ThrowIfNull(path);`
`160`	`154`	`ArgumentNullException.ThrowIfNull(stream);`
`161`	`155`
`162`		`- var blob = GetBlobClient(path);`
	`156`	`+ BlobClient blob = GetBlobClient(path);`
`163`	`157`	`if (!overrideIfExists && blob.Exists())`
`164`	`158`	`{`
`165`		`- throw new InvalidOperationException($"A file at path '{path}' already exists");`
	`159`	`+ throw new InvalidOperationException($"A file at path '{path}' already exists.");`
`166`	`160`	`}`
`167`	`161`
`168`	`162`	`var headers = new BlobHttpHeaders();`
`@@ -187,10 +181,10 @@ public void AddFile(string path, string physicalPath, bool overrideIfExists = tr`
`187`	`181`	`ArgumentNullException.ThrowIfNull(path);`
`188`	`182`	`ArgumentNullException.ThrowIfNull(physicalPath);`
`189`	`183`
`190`		`- var destinationBlob = GetBlobClient(path);`
	`184`	`+ BlobClient destinationBlob = GetBlobClient(path);`
`191`	`185`	`if (!overrideIfExists && destinationBlob.Exists())`
`192`	`186`	`{`
`193`		`- throw new InvalidOperationException($"A file at path '{path}' already exists");`
	`187`	`+ throw new InvalidOperationException($"A file at path '{path}' already exists.");`
`194`	`188`	`}`
`195`	`189`
`196`	`190`	`var sourceBlob = GetBlobClient(physicalPath);`
`@@ -227,7 +221,7 @@ public IEnumerable<string> GetFiles(string path, string? filter)`
`227`	`221`	`{`
`228`	`222`	`ArgumentNullException.ThrowIfNull(path);`
`229`	`223`
`230`		`- var files = ListBlobs(GetDirectoryPath(path)).Where(x => x.IsBlob).Select(x => x.Blob.Name);`
	`224`	`+ IEnumerable<string> files = ListBlobs(path).Where(x => x.IsBlob).Select(x => x.Blob.Name);`
`231`	`225`	`if (!string.IsNullOrEmpty(filter) && filter != ".")`
`232`	`226`	`{`
`233`	`227`	`// TODO: Might be better to use a globbing library`
`@@ -267,6 +261,7 @@ public bool FileExists(string path)`
`267`	`261`
`268`	`262`	`/// <inheritdoc />`
`269`	`263`	`/// <exception cref="System.ArgumentNullException"><paramref name="fullPathOrUrl" /> is <c>null</c>.</exception>`
	`264`	`+ [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "This method is inherited from an interface.")]`
`270`	`265`	`public string GetRelativePath(string fullPathOrUrl)`
`271`	`266`	`{`
`272`	`267`	`ArgumentNullException.ThrowIfNull(fullPathOrUrl);`
`@@ -297,6 +292,7 @@ public string GetFullPath(string path)`
`297`	`292`
`298`	`293`	`/// <inheritdoc />`
`299`	`294`	`/// <exception cref="System.ArgumentNullException"><paramref name="path" /> is <c>null</c>.</exception>`
	`295`	`+ [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1055:URI-like return values should not be strings", Justification = "This method is inherited from an interface.")]`
`300`	`296`	`public string GetUrl(string? path)`
`301`	`297`	`{`
`302`	`298`	`ArgumentNullException.ThrowIfNull(path);`
`@@ -337,7 +333,7 @@ public BlobClient GetBlobClient(string path)`
`337`	`333`	`{`
`338`	`334`	`ArgumentNullException.ThrowIfNull(path);`
`339`	`335`
`340`		`- return _container.GetBlobClient(GetBlobPath(path));`
	`336`	`+ return _container.GetBlobClient(GetBlobName(path));`
`341`	`337`	`}`
`342`	`338`
`343`	`339`	`/// <inheritdoc />`
`@@ -346,19 +342,15 @@ public BlobClient GetBlobClient(string path)`
`346`	`342`	`private static string EnsureUrlSeparatorChar(string path)`
`347`	`343`	`=> path.Replace("\\", "/", StringComparison.InvariantCultureIgnoreCase);`
`348`	`344`
`349`		`- private string GetDirectoryPath(string fullPathOrUrl)`
	`345`	`+ private Pageable<BlobHierarchyItem> ListBlobs(string path, bool recursive = false)`
`350`	`346`	`{`
`351`		`- var path = GetFullPath(fullPathOrUrl);`
	`347`	`+ string? delimiter = recursive ? null : "/";`
	`348`	`+ string prefix = GetFullPath(path).EnsureEndsWith('/');`
`352`	`349`
`353`		`- return path.Length == 0 ? path : path.EnsureEndsWith('/');`
`354`		`- }`
`355`		`-`
`356`		`- private IEnumerable<BlobHierarchyItem> ListBlobs(string path)`
`357`		`- {`
`358`		`- return _container.GetBlobsByHierarchy(prefix: path);`
	`350`	`+ return _container.GetBlobsByHierarchy(delimiter: delimiter, prefix: prefix);`
`359`	`351`	`}`
`360`	`352`
`361`		`- private string GetBlobPath(string path)`
	`353`	`+ private string GetBlobName(string path)`
`362`	`354`	`{`
`363`	`355`	`path = EnsureUrlSeparatorChar(path);`
`364`	`356`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`		`- "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",`
`3`		`- "version": "10.1.0-alpha",`
	`2`	`+ "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json",`
	`3`	`+ "version": "10.0.1",`
`4`	`4`	`"assemblyVersion": {`
`5`	`5`	`"precision": "build"`
`6`	`6`	`},`
`@@ -20,4 +20,4 @@`
`20`	`20`	`"release": {`
`21`	`21`	`"branchName": "release/{version}"`
`22`	`22`	`}`
`23`		`-}`
	`23`	`+}`