refactor: load noise list from embedded json resource

Author: paul-fresquet

docs/specs/SPEC-noise-file-detection.md

@@ -4,6 +4,9 @@
 
 This document lists the known noise file names filtered by the client inventory pipeline and their platform origin.
 
+The runtime source of truth is the embedded JSON resource:
+`src/ByteSync.Client/Services/Inventories/noise-files.json`.
+
 ## Known noise file names
 
 | File name | Origin platform | Typical purpose |

src/ByteSync.Client/ByteSync.Client.csproj

@@ -111,6 +111,7 @@
         </EmbeddedResource>
         <None Remove="local.settings.json"/>
         <EmbeddedResource Include="local.settings.json"/>
+        <EmbeddedResource Include="Services\Inventories\noise-files.json"/>
     </ItemGroup>
     <ItemGroup>
         <UpToDateCheckInput Remove="Assets\Resources\Resources.en.resx"/>
@@ -258,4 +259,4 @@
             <SubType>Code</SubType>
         </Compile>
     </ItemGroup>
-</Project>
+</Project>

src/ByteSync.Client/Services/Inventories/NoiseFileDetector.cs

@@ -1,27 +1,13 @@
+using System.Reflection;
+using System.Text.Json;
 using ByteSync.Common.Business.Misc;
 
 namespace ByteSync.Services.Inventories;
 
 public static class NoiseFileDetector
 {
-    private static readonly string[] KnownNoiseFileNames =
-    [
-        "desktop.ini",
-        "thumbs.db",
-        "ehthumbs.db",
-        "ehthumbs_vista.db",
-        ".desktop.ini",
-        ".thumbs.db",
-        ".DS_Store",
-        ".AppleDouble",
-        ".LSOverride",
-        ".Spotlight-V100",
-        ".Trashes",
-        ".fseventsd",
-        ".TemporaryItems",
-        ".VolumeIcon.icns",
-        ".directory"
-    ];
+    private const string NoiseFileResourceSuffix = ".Services.Inventories.noise-files.json";
+    private static readonly string[] KnownNoiseFileNames = LoadNoiseFileNames();
 
     private static readonly HashSet<string> CaseSensitiveNoiseFileNames = new(KnownNoiseFileNames, StringComparer.Ordinal);
     private static readonly HashSet<string> CaseInsensitiveNoiseFileNames = new(KnownNoiseFileNames, StringComparer.OrdinalIgnoreCase);
@@ -37,4 +23,33 @@ public static bool IsNoiseFileName(string? fileName, OSPlatforms os)
             ? CaseSensitiveNoiseFileNames.Contains(fileName)
             : CaseInsensitiveNoiseFileNames.Contains(fileName);
     }
+
+    private static string[] LoadNoiseFileNames()
+    {
+        var assembly = typeof(NoiseFileDetector).Assembly;
+        var resourceName = assembly.GetManifestResourceNames()
+            .SingleOrDefault(rn => rn.EndsWith(NoiseFileResourceSuffix, StringComparison.Ordinal));
+
+        if (resourceName == null)
+        {
+            throw new InvalidOperationException($"Embedded resource not found: '*{NoiseFileResourceSuffix}'");
+        }
+
+        using var stream = assembly.GetManifestResourceStream(resourceName);
+        if (stream == null)
+        {
+            throw new InvalidOperationException($"Unable to open embedded resource stream: '{resourceName}'");
+        }
+
+        var parsed = JsonSerializer.Deserialize<string[]>(stream);
+        if (parsed == null)
+        {
+            throw new InvalidOperationException($"Unable to deserialize embedded resource: '{resourceName}'");
+        }
+
+        return parsed
+            .Where(s => !string.IsNullOrWhiteSpace(s))
+            .Distinct(StringComparer.Ordinal)
+            .ToArray();
+    }
 }

src/ByteSync.Client/Services/Inventories/noise-files.json

@@ -0,0 +1,17 @@
+[
+  "desktop.ini",
+  "thumbs.db",
+  "ehthumbs.db",
+  "ehthumbs_vista.db",
+  ".desktop.ini",
+  ".thumbs.db",
+  ".DS_Store",
+  ".AppleDouble",
+  ".LSOverride",
+  ".Spotlight-V100",
+  ".Trashes",
+  ".fseventsd",
+  ".TemporaryItems",
+  ".VolumeIcon.icns",
+  ".directory"
+]

tests/ByteSync.Client.UnitTests/Services/Inventories/NoiseFileDetectorTests.cs

@@ -1,3 +1,5 @@
+using System.Reflection;
+using System.Text.Json;
 using ByteSync.Common.Business.Misc;
 using ByteSync.Services.Inventories;
 using FluentAssertions;
@@ -7,24 +9,7 @@ namespace ByteSync.Client.UnitTests.Services.Inventories;
 
 public class NoiseFileDetectorTests
 {
-    private static readonly string[] KnownNoiseFileNames =
-    [
-        "desktop.ini",
-        "thumbs.db",
-        "ehthumbs.db",
-        "ehthumbs_vista.db",
-        ".desktop.ini",
-        ".thumbs.db",
-        ".DS_Store",
-        ".AppleDouble",
-        ".LSOverride",
-        ".Spotlight-V100",
-        ".Trashes",
-        ".fseventsd",
-        ".TemporaryItems",
-        ".VolumeIcon.icns",
-        ".directory"
-    ];
+    private static readonly string[] KnownNoiseFileNames = LoadNoiseFileNamesFromEmbeddedResource();
 
     [TestCaseSource(nameof(KnownNoiseFileNames))]
     public void IsNoiseFileName_ShouldReturnTrue_ForKnownNoiseFiles_OnWindows(string fileName)
@@ -107,4 +92,21 @@ public void IsNoiseFileName_ShouldReturnFalse_ForEmptyValues(string? fileName)
         windowsResult.Should().BeFalse();
         linuxResult.Should().BeFalse();
     }
+
+    private static string[] LoadNoiseFileNamesFromEmbeddedResource()
+    {
+        var assembly = typeof(NoiseFileDetector).Assembly;
+        var resourceName = assembly.GetManifestResourceNames()
+            .SingleOrDefault(rn => rn.EndsWith(".Services.Inventories.noise-files.json", StringComparison.Ordinal));
+
+        resourceName.Should().NotBeNull();
+
+        using var stream = assembly.GetManifestResourceStream(resourceName!);
+        stream.Should().NotBeNull();
+
+        var data = JsonSerializer.Deserialize<string[]>(stream!);
+        data.Should().NotBeNull();
+
+        return data!;
+    }
 }