Merge branch 'master' into replace-with-async-lock

src/Foundatio.TestHarness/Storage/FileStorageTestsBase.cs

@@ -468,7 +468,7 @@ public virtual async Task WillWriteStreamContentAsync() {
 
             using (storage) {
 
-                using (var writer = new StreamWriter(await storage.GetFileStreamAsync(path, FileAccess.ReadWrite), Encoding.UTF8, 1024, false)) {
+                using (var writer = new StreamWriter(await storage.GetFileStreamAsync(path, StreamMode.Write), Encoding.UTF8, 1024, false)) {
                     await writer.WriteAsync(testContent);
                 }
 

src/Foundatio/Storage/FolderFileStorage.cs

@@ -45,9 +45,19 @@ public FolderFileStorage(Builder<FolderFileStorageOptionsBuilder, FolderFileStor
         ISerializer IHaveSerializer.Serializer => _serializer;
 
         public Task<Stream> GetFileStreamAsync(string path, CancellationToken cancellationToken = default)
-            => GetFileStreamAsync(path, FileAccess.Read, cancellationToken);
+            => GetFileStreamAsync(path, StreamMode.Read, cancellationToken);
 
-        public Task<Stream> GetFileStreamAsync(string path, FileAccess fileAccess, CancellationToken cancellationToken = default) {
+        public Task<Stream> GetFileStreamAsync(string path, StreamMode streamMode, CancellationToken cancellationToken = default) {
+            var stream = streamMode switch {
+                StreamMode.Read => GetFileStreamAsync(path, FileAccess.Read),
+                StreamMode.Write => GetFileStreamAsync(path, FileAccess.Write),
+                _ => throw new NotSupportedException($"Stream mode {streamMode} is not supported."),
+            };
+
+            return Task.FromResult(stream);
+        }
+
+        public Stream GetFileStreamAsync(string path, FileAccess fileAccess) {
             if (String.IsNullOrEmpty(path))
                 throw new ArgumentNullException(nameof(path));
 
@@ -60,12 +70,14 @@ public Task<Stream> GetFileStreamAsync(string path, FileAccess fileAccess, Cance
             var fileMode = GetFileModeForFileAccess(fileAccess);
 
             try {
-                return Task.FromResult<Stream>(File.Open(fullPath, fileMode, fileAccess));
+                return File.Open(fullPath, fileMode, fileAccess);
             } catch (IOException ex) when (ex is FileNotFoundException or DirectoryNotFoundException) {
                 _logger.LogError(ex, "Unable to get file stream for {Path}: {Message}", normalizedPath, ex.Message);
-                return Task.FromResult<Stream>(null);
+                return null;
             }
         }
+
+
         private FileMode GetFileModeForFileAccess(FileAccess fileAccess) {
             return fileAccess switch {
                 FileAccess.Read => FileMode.Open,

src/Foundatio/Storage/IFileStorage.cs

@@ -13,7 +13,14 @@ namespace Foundatio.Storage {
     public interface IFileStorage : IHaveSerializer, IDisposable {
         [Obsolete($"Use {nameof(GetFileStreamAsync)} with {nameof(FileAccess)} instead to define read or write behaviour of stream.")]
         Task<Stream> GetFileStreamAsync(string path, CancellationToken cancellationToken = default);
-        Task<Stream> GetFileStreamAsync(string path, FileAccess fileAccess, CancellationToken cancellationToken = default);
+        /// <summary>
+        /// Gets a file stream in the specified mode
+        /// </summary>
+        /// <param name="path">Path to the file in the file storage</param>
+        /// <param name="streamMode">What the stream is used for</param>
+        /// <param name="cancellationToken">Token to cancel</param>
+        /// <returns>Stream in the specified mode</returns>
+        Task<Stream> GetFileStreamAsync(string path, StreamMode streamMode, CancellationToken cancellationToken = default);
         Task<FileSpec> GetFileInfoAsync(string path);
         Task<bool> ExistsAsync(string path);
         Task<bool> SaveFileAsync(string path, Stream stream, CancellationToken cancellationToken = default);

src/Foundatio/Storage/InMemoryFileStorage.cs

@@ -39,7 +39,7 @@ public InMemoryFileStorage(Builder<InMemoryFileStorageOptionsBuilder, InMemoryFi
         ISerializer IHaveSerializer.Serializer => _serializer;
 
         public Task<Stream> GetFileStreamAsync(string path, CancellationToken cancellationToken = default) =>
-            GetFileStreamAsync(path, FileAccess.Read, cancellationToken);
+            GetFileStreamAsync(path, StreamMode.Read, cancellationToken);
 
         public async Task<Stream> GetFileStreamAsync(string path, FileAccess fileAccess, CancellationToken cancellationToken = default) {
             if (String.IsNullOrEmpty(path))

src/Foundatio/Storage/ScopedFileStorage.cs

@@ -21,9 +21,9 @@ public ScopedFileStorage(IFileStorage storage, string scope) {
         ISerializer IHaveSerializer.Serializer => UnscopedStorage.Serializer;
 
         public Task<Stream> GetFileStreamAsync(string path, CancellationToken cancellationToken = default)
-            => GetFileStreamAsync(path, FileAccess.Read, cancellationToken);
+            => GetFileStreamAsync(path, StreamMode.Read, cancellationToken);
 
-        public Task<Stream> GetFileStreamAsync(string path, FileAccess fileAccess, CancellationToken cancellationToken = default) {
+        public Task<Stream> GetFileStreamAsync(string path, StreamMode streamMode, CancellationToken cancellationToken = default) {
             if (String.IsNullOrEmpty(path))
                 throw new ArgumentNullException(nameof(path));
 

src/Foundatio/Storage/StreamMode.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Foundatio.Storage;
+
+/// <summary>
+/// Tells what the stream will be used for
+/// </summary>
+public enum StreamMode {
+    Read,
+    Write
+}