From 53b94a8f5716e2b0dd207360d8ee2ca74c954b11 Mon Sep 17 00:00:00 2001
From: Ronald Barendse <ronald@barend.se>
Date: Wed, 23 Apr 2025 13:38:03 +0200
Subject: [PATCH] Add async methods to `IFileType` (#19116)

* Add GetChecksumStreamAsync and GetLengthAsync

* Obsolete CanSetPhysical, Set and GetVirtualPath

* Updated obsolete messages to reference Umbraco 18

---------

Co-authored-by: Andy Butland <abutland73@gmail.com>
---
 src/Umbraco.Core/Deploy/IFileType.cs | 48 +++++++++++++++++++++-------
 1 file changed, 37 insertions(+), 11 deletions(-)

diff --git a/src/Umbraco.Core/Deploy/IFileType.cs b/src/Umbraco.Core/Deploy/IFileType.cs
index f8fa5ba92d..0d65ad3b06 100644
--- a/src/Umbraco.Core/Deploy/IFileType.cs
+++ b/src/Umbraco.Core/Deploy/IFileType.cs
@@ -11,17 +11,18 @@ public interface IFileType
     /// <value>
     ///   <c>true</c> if the file can be set using a physical path; otherwise, <c>false</c>.
     /// </value>
+    [Obsolete("An interface should not expose implementation details. Scheduled for removal in Umbraco 18.")]
     bool CanSetPhysical { get; }
 
     /// <summary>
-    /// Gets the stream as an asynchronous operation.
+    /// Gets the stream in an asynchronous operation.
     /// </summary>
     /// <param name="udi">The UDI.</param>
     /// <param name="token">The cancellation token.</param>
     /// <returns>
-    /// The task object representing the asynchronous operation.
+    /// The task object representing the asynchronous operation. The task result contains the stream.
     /// </returns>
-    Task<Stream> GetStreamAsync(StringUdi udi, CancellationToken token);
+    Task<Stream> GetStreamAsync(StringUdi udi, CancellationToken token); // TODO: Rename token to cancellationToken and add default value
 
     /// <summary>
     /// Gets the checksum stream.
@@ -30,8 +31,22 @@ public interface IFileType
     /// <returns>
     /// The checksum stream.
     /// </returns>
+    [Obsolete("Use GetChecksumStreamAsync() instead. Scheduled for removal in Umbraco 18.")]
     Stream GetChecksumStream(StringUdi udi);
 
+    /// <summary>
+    /// Gets the checksum stream in an asynchronous operation.
+    /// </summary>
+    /// <param name="udi">The UDI.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>
+    /// The task object representing the asynchronous operation. The task result contains the checksum stream.
+    /// </returns>
+    Task<Stream> GetChecksumStreamAsync(StringUdi udi, CancellationToken cancellationToken = default)
+#pragma warning disable CS0618 // Type or member is obsolete
+        => Task.FromResult(GetChecksumStream(udi));
+#pragma warning restore CS0618 // Type or member is obsolete
+
     /// <summary>
     /// Gets the file length in bytes or <c>-1</c> if not found.
     /// </summary>
@@ -39,8 +54,22 @@ public interface IFileType
     /// <returns>
     /// The file length in bytes or <c>-1</c> if not found.
     /// </returns>
+    [Obsolete("Use GetLengthAsync() instead. Scheduled for removal in Umbraco 18.")]
     long GetLength(StringUdi udi);
 
+    /// <summary>
+    /// Gets the file length in bytes or <c>-1</c> if not found in an asynchronous operation.
+    /// </summary>
+    /// <param name="udi">The UDI.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>
+    /// The task object representing the asynchronous operation. The task result contains the file length in bytes or <c>-1</c> if not found.
+    /// </returns>
+    Task<long> GetLengthAsync(StringUdi udi, CancellationToken cancellationToken = default)
+#pragma warning disable CS0618 // Type or member is obsolete
+        => Task.FromResult(GetLength(udi));
+#pragma warning restore CS0618 // Type or member is obsolete
+
     /// <summary>
     /// Sets the stream as an asynchronous operation.
     /// </summary>
@@ -50,7 +79,7 @@ public interface IFileType
     /// <returns>
     /// The task object representing the asynchronous operation.
     /// </returns>
-    Task SetStreamAsync(StringUdi udi, Stream stream, CancellationToken token);
+    Task SetStreamAsync(StringUdi udi, Stream stream, CancellationToken token); // TODO: Rename token to cancellationToken and add default value
 
     /// <summary>
     /// Sets the physical path of the file.
@@ -58,20 +87,16 @@ public interface IFileType
     /// <param name="udi">The UDI.</param>
     /// <param name="physicalPath">The physical path.</param>
     /// <param name="copy">If set to <c>true</c> copies the file instead of moving.</param>
+    [Obsolete("Use SetStreamAsync() instead to not rely on physical file paths. Scheduled for removal in Umbraco 18.")]
     void Set(StringUdi udi, string physicalPath, bool copy = false);
 
     /// <summary>
-    /// Gets the physical path or <see cref="string.Empty"/> if not found.
+    /// Gets the path to the file, including the file name. Returns <see cref="string.Empty" /> if the file is not directly accessible.
     /// </summary>
     /// <param name="udi">The UDI.</param>
     /// <returns>
-    /// The physical path or <see cref="string.Empty"/> if not found.
+    /// The path to the file, including the file name or <see cref="string.Empty" /> if the file is not directly accessible.
     /// </returns>
-    /// <remarks>
-    /// This is not pretty as *everywhere* in Deploy we take care of ignoring
-    /// the physical path and always rely on the virtual IFileSystem,
-    /// but Cloud wants to add some of these files to Git and needs the path...
-    /// </remarks>
     string GetPhysicalPath(StringUdi udi);
 
     /// <summary>
@@ -81,5 +106,6 @@ public interface IFileType
     /// <returns>
     /// The virtual path or <see cref="string.Empty"/> if not found.
     /// </returns>
+    [Obsolete("This is not used anymore. Scheduled for removal in Umbraco 18.")]
     string GetVirtualPath(StringUdi udi);
 }