Add Disk Space Checker

osu.Game.Tests/Database/DiskUsageTests.cs

@@ -0,0 +1,58 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System.IO;
+using System.Threading.Tasks;
+using NUnit.Framework;
+using osu.Game.IO;
+
+namespace osu.Game.Tests.Database
+{
+    [TestFixture]
+    public class DiskUsageTests
+    {
+        private string tempDir = null!;
+
+        [SetUp]
+        public void SetUp()
+        {
+            // Create a temporary directory to ensure we are testing against a valid location
+            tempDir = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+            Directory.CreateDirectory(tempDir);
+        }
+
+        [TearDown]
+        public void TearDown()
+        {
+            if (Directory.Exists(tempDir))
+                Directory.Delete(tempDir, true);
+        }
+
+        [Test]
+        public void TestSufficientSpace()
+        {
+            // Asking for 0 bytes should always succeed (unless the drive is 100% full)
+            Assert.DoesNotThrow(() => DiskUsage.EnsureSufficientSpace(tempDir, 0));
+        }
+
+        [Test]
+        public void TestInsufficientSpace()
+        {
+            // Asking for the maximum possible long value should always exceed available space
+            Assert.Throws<IOException>(() => DiskUsage.EnsureSufficientSpace(tempDir, long.MaxValue));
+        }
+
+        [Test]
+        public void TestNonExistentDirectory()
+        {
+            string nonExistentPath = Path.Combine(tempDir, "does_not_exist");
+            Assert.Throws<DirectoryNotFoundException>(() => DiskUsage.EnsureSufficientSpace(nonExistentPath));
+        }
+
+        [Test]
+        public async Task TestAsyncWrapper()
+        {
+            await DiskUsage.EnsureSufficientSpaceAsync(tempDir, 0);
+        }
+    }
+}

osu.Game/Database/RealmAccess.cs

@@ -25,6 +25,7 @@
 using osu.Game.Extensions;
 using osu.Game.Input;
 using osu.Game.Input.Bindings;
+using osu.Game.IO;
 using osu.Game.Models;
 using osu.Game.Online.API;
 using osu.Game.Online.API.Requests.Responses;
@@ -37,6 +38,7 @@
 using osuTK.Input;
 using Realms;
 using Realms.Exceptions;
+using FileInfo = System.IO.FileInfo;
 
 namespace osu.Game.Database
 {
@@ -332,6 +334,16 @@ private Realm prepareFirstRealmAccess()
             }
             catch { }
 
+            // Check for requisite disk space
+            try
+            {
+                DiskUsage.EnsureSufficientSpace(storage.GetFullPath(string.Empty));
+            }
+            catch (IOException)
+            {
+                Logger.Log("Your device is running low on disk space! Please free up some space to avoid potential issues.", LoggingTarget.Runtime, LogLevel.Important);
+            }
+
             try
             {
                 return getRealmInstance();

osu.Game/IO/DiskUsage.cs

@@ -0,0 +1,50 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System.IO;
+using System.Threading.Tasks;
+using osu.Framework.Logging;
+
+namespace osu.Game.IO
+{
+    public static class DiskUsage
+    {
+        /// <summary>
+        /// 500 MiB
+        /// </summary>
+        private const long required_space_default = 512L * 1024L * 1024L;
+
+        /// <summary>
+        /// Checks if the available free space on the drive containing the path is sufficient for normal operation.
+        /// This method is blocking, and <see cref="EnsureSufficientSpaceAsync"/> should be preferred in IO-bound scenarios.
+        /// </summary>
+        /// <param name="checkPath">A path to a file or directory in which the drive's disk space should be checked.</param>
+        /// <param name="requiredSpace">The amount of space to ensure is available in bytes. Defaults to <see cref="required_space_default"/>.</param>
+        public static void EnsureSufficientSpace(string checkPath, long requiredSpace = required_space_default)
+        {
+            if (!Directory.Exists(checkPath))
+                throw new DirectoryNotFoundException($"The directory '{checkPath}' does not exist or could not be found.");
+
+            string? validPathRoot = Path.GetPathRoot(checkPath);
+
+            if (string.IsNullOrEmpty(validPathRoot))
+                throw new IOException($"The directory '{checkPath}' is not a valid path.");
+
+            var activeDriveInfo = new DriveInfo(validPathRoot);
+
+            long availableFreeSpace = activeDriveInfo.AvailableFreeSpace;
+
+#if DEBUG
+            Logger.Log($"Available disk space: {availableFreeSpace / 1048576L} MiB");
+#endif
+
+            if (availableFreeSpace < requiredSpace)
+                throw new IOException($"Insufficient disk space available! Required: {requiredSpace} | Available: {availableFreeSpace}");
+        }
+
+        public static async Task EnsureSufficientSpaceAsync(string checkDirectory, long requiredSpace = required_space_default)
+        {
+            await Task.Run(() => EnsureSufficientSpace(checkDirectory, requiredSpace)).ConfigureAwait(false);
+        }
+    }
+}