File I/O abstraction part 19: Migrate ISourceFileFactory and remove IFileResolver (#17761)

- Updated `ISourceFileFactory` methods to use `IOUri`
- Removed `IFileResolver` and `FileResolver`
###### Microsoft Reviewers: [Open in
CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/Azure/bicep/pull/17761)

Author: shenglol

src/Bicep.Cli/Commands/BuildParamsCommand.cs

@@ -116,7 +116,7 @@ public async Task<DiagnosticSummary> CompileMultiple(BuildParamsArguments args,
             return null;
         }
 
-        var sourceFile = sourceFileFactory.CreateBicepParamFile(paramsFileUri.ToUri(), paramsFileText);
+        var sourceFile = sourceFileFactory.CreateBicepParamFile(paramsFileUri, paramsFileText);
         var parameterOverrides = JsonConvert.DeserializeObject<Dictionary<string, JToken>>(parameterOverridesJson, new JsonSerializerSettings()
         {
             DateParseHandling = DateParseHandling.None,

src/Bicep.Cli/Commands/DecompileCommand.cs

@@ -68,7 +68,7 @@ public async Task<int> RunAsync(DecompileArguments args)
                 var workspace = new Workspace();
                 foreach (var (fileUri, bicepOutput) in decompilation.FilesToSave)
                 {
-                    workspace.UpsertSourceFile(this.sourceFileFactory.CreateBicepFile(fileUri, bicepOutput));
+                    workspace.UpsertSourceFile(this.sourceFileFactory.CreateBicepFile(fileUri.ToIOUri(), bicepOutput));
                 }
 
                 // to verify success we recompile and check for syntax errors.

src/Bicep.Cli/Commands/FormatCommand.cs

@@ -45,7 +45,7 @@ public void Format(FormatArguments args, IOUri inputUri, IOUri outputUri, bool o
             throw new DiagnosticException(diagnostic);
         }
 
-        if (sourceFileFactory.CreateSourceFile(inputUri.ToUri(), fileContents) is not BicepSourceFile sourceFile)
+        if (sourceFileFactory.CreateSourceFile(inputUri, fileContents) is not BicepSourceFile sourceFile)
         {
             throw new InvalidOperationException("Unable to create Bicep source file.");
         }

src/Bicep.Cli/Commands/PublishCommand.cs

@@ -120,7 +120,7 @@ private async Task PublishModuleAsync(ArtifactReference target, BinaryData compi
 
         private ArtifactReference ValidateReference(string targetModuleReference, IOUri targetModuleUri)
         {
-            var dummyReferencingFile = this.sourceFileFactory.CreateBicepFile(targetModuleUri.ToUri(), string.Empty);
+            var dummyReferencingFile = this.sourceFileFactory.CreateBicepFile(targetModuleUri, string.Empty);
 
             if (!this.moduleDispatcher.TryGetArtifactReference(dummyReferencingFile, ArtifactType.Module, targetModuleReference).IsSuccess(out var moduleReference, out var failureBuilder))
             {

src/Bicep.Cli/Commands/PublishExtensionCommand.cs

@@ -129,7 +129,7 @@ private ArtifactReference ValidateReference(string targetReference)
                 dummyReferencingFileUri = new IOUri("file", "", "/dummy");
             }
 
-            var dummyReferencingFile = sourceFileFactory.CreateBicepFile(dummyReferencingFileUri.ToUri(), "");
+            var dummyReferencingFile = sourceFileFactory.CreateBicepFile(dummyReferencingFileUri, "");
 
             if (!moduleDispatcher.TryGetArtifactReference(dummyReferencingFile, ArtifactType.Extension, targetReference).IsSuccess(out var extensionReference, out var failureBuilder))
             {

src/Bicep.Cli/Helpers/ParamsFileHelper.cs

@@ -85,6 +85,6 @@ public static BicepParamFile ApplyParameterOverrides(ISourceFileFactory sourceFi
             return sourceFile;
         }
 
-        return sourceFileFactory.CreateBicepParamFile(sourceFile.Uri, newProgramSyntax.ToString());
+        return sourceFileFactory.CreateBicepParamFile(sourceFile.FileHandle.Uri, newProgramSyntax.ToString());
     }
 }

src/Bicep.Cli/Helpers/ServiceCollectionExtensions.cs

@@ -71,7 +71,6 @@ public static IServiceCollection AddBicepCore(this IServiceCollection services)
         .AddSingleton<IModuleDispatcher, ModuleDispatcher>()
         .AddSingleton<IArtifactRegistryProvider, DefaultArtifactRegistryProvider>()
         .AddSingleton<ITokenCredentialFactory, TokenCredentialFactory>()
-        .AddSingleton<IFileResolver, FileResolver>()
         .AddSingleton<IEnvironment, Environment>()
         .AddSingleton<IFileSystem, LocalFileSystem>()
         .AddSingleton<IFileExplorer, FileSystemFileExplorer>()

src/Bicep.Core.IntegrationTests/RegistryTests.cs

@@ -12,6 +12,7 @@
 using Bicep.Core.UnitTests.Assertions;
 using Bicep.Core.UnitTests.Features;
 using Bicep.Core.UnitTests.Utils;
+using Bicep.IO.InMemory;
 using Bicep.TextFixtures.Utils;
 using FluentAssertions;
 using FluentAssertions.Execution;
@@ -211,12 +212,9 @@ public async Task ModuleRestoreWithStuckFileLockShouldFailAfterTimeout(IEnumerab
             var artifactManager = new TestExternalArtifactManager(TestCompiler.ForMockFileSystemCompilation().WithFeatureOverrides<FeatureProviderOverrides, OverriddenFeatureProviderFactory>(features));
             await dataSet.PublishAllDataSetArtifacts(artifactManager, publishSource: true);
 
-            var fileResolver = BicepTestConstants.FileResolver;
-
             var services = Services
                 .WithFeatureOverrides(features)
                 .WithTestArtifactManager(artifactManager)
-                .WithFileResolver(fileResolver)
                 .Build();
 
             var dispatcher = services.Construct<IModuleDispatcher>();
@@ -277,12 +275,9 @@ public async Task ForceModuleRestoreWithStuckFileLockShouldFailAfterTimeout(IEnu
             var artifactManager = new TestExternalArtifactManager(TestCompiler.ForMockFileSystemCompilation().WithFeatureOverrides<FeatureProviderOverrides, OverriddenFeatureProviderFactory>(features));
             await dataSet.PublishAllDataSetArtifacts(artifactManager, publishSource: true);
 
-            var fileResolver = BicepTestConstants.FileResolver;
-
             var services = Services
                 .WithFeatureOverrides(features)
                 .WithTestArtifactManager(artifactManager)
-                .WithFileResolver(fileResolver)
                 .Build();
 
             var dispatcher = services.Construct<IModuleDispatcher>();
@@ -351,12 +346,9 @@ public async Task ForceModuleRestoreShouldRestoreAllModules(IEnumerable<External
             var artifactManager = new TestExternalArtifactManager(TestCompiler.ForMockFileSystemCompilation().WithFeatureOverrides<FeatureProviderOverrides, OverriddenFeatureProviderFactory>(features));
             await dataSet.PublishAllDataSetArtifacts(artifactManager, publishSource: true);
 
-            var fileResolver = BicepTestConstants.FileResolver;
-
             var services = Services
                 .WithFeatureOverrides(new(CacheRootDirectory: cacheDirectory))
                 .WithTestArtifactManager(artifactManager)
-                .WithFileResolver(fileResolver)
                 .Build();
 
             var dispatcher = services.Construct<IModuleDispatcher>();
@@ -400,7 +392,7 @@ private static BicepFile CreateDummyReferencingFile(IDependencyHelper dependency
         {
             var sourceFileFactory = dependencyHelper.Construct<ISourceFileFactory>();
 
-            return sourceFileFactory.CreateBicepFile(new Uri("inmemory:///main.bicep"), "");
+            return sourceFileFactory.CreateBicepFile(DummyFileHandle.Default, "");
         }
 
         private static ResultWithDiagnosticBuilder<ArtifactReference> TryGetModuleReference(IModuleDispatcher moduleDispatcher, BicepSourceFile referencingFile, string reference) =>

src/Bicep.Core.IntegrationTests/Scenarios/LoadFunctionsTests.cs

@@ -7,6 +7,7 @@
 using Bicep.Core.UnitTests.Assertions;
 using Bicep.Core.UnitTests.FileSystem;
 using Bicep.Core.UnitTests.Utils;
+using Bicep.TextFixtures.IO;
 using Bicep.TextFixtures.Utils;
 using FluentAssertions;
 using FluentAssertions.Execution;
@@ -111,17 +112,15 @@ private static CompilationHelper.CompilationResult CreateLoadTextContentTestComp
         {
             var encoding = LanguageConstants.SupportedEncodings.TryGetValue(encodingName, out var val) ? val : Encoding.UTF8;
 
-            var files = new Dictionary<Uri, MockFileData>
-            {
-                [new Uri("file:///main.bicep")] = new(@"
-var message = loadTextContent('message.txt', '" + encodingName + @"')
+            var fileSet = MockFileSystemTestFileSet.Create(
+                ("main.bicep", $"""
+                    var message = loadTextContent('message.txt', '{encodingName}')
 
-output out string = message
-"),
-                [new Uri("file:///message.txt")] = new(TEXT_CONTENT, encoding),
-            };
+                    output out string = message
+                    """),
+                ("message.txt", new(TEXT_CONTENT, encoding)));
 
-            return CompilationHelper.Compile(new(), new InMemoryFileResolver(files), files.Keys, new Uri("file:///main.bicep"));
+            return CompilationHelper.Compile(new(), fileSet, fileSet.GetUri("main.bicep"));
         }
 
         [DataTestMethod]
@@ -649,15 +648,13 @@ private static CompilationHelper.CompilationResult CreateLoadJsonContentTestComp
         {
             var encoding = LanguageConstants.SupportedEncodings.TryGetValue(encodingName, out var val) ? val : Encoding.UTF8;
 
-            var files = new Dictionary<Uri, MockFileData>
-            {
-                [new Uri("file:///main.bicep")] = new(@"
-var fileObj = loadJsonContent('file.json', '$', '" + encodingName + @"')
-"),
-                [new Uri("file:///file.json")] = new(TEST_JSON, encoding),
-            };
+            var fileSet = MockFileSystemTestFileSet.Create(
+                ("main.bicep", $"""
+                    var fileObj = loadJsonContent('file.json', '$', '{encodingName}')
+                    """),
+                ("file.json", new(TEST_JSON, encoding)));
 
-            return CompilationHelper.Compile(new(), new InMemoryFileResolver(files), files.Keys, new Uri("file:///main.bicep"));
+            return CompilationHelper.Compile(new(), fileSet, fileSet.GetUri("main.bicep"));
         }
 
         [DataTestMethod]
@@ -995,15 +992,13 @@ private static CompilationHelper.CompilationResult CreateLoadYamlContentTestComp
         {
             var encoding = LanguageConstants.SupportedEncodings.TryGetValue(encodingName, out var val) ? val : Encoding.UTF8;
 
-            var files = new Dictionary<Uri, MockFileData>
-            {
-                [new Uri("file:///main.bicep")] = new(@"
-var fileObj = loadYamlContent('file.yaml', '$', '" + encodingName + @"')
-"),
-                [new Uri("file:///file.yaml")] = new(TEST_YAML, encoding),
-            };
+            var fileSet = MockFileSystemTestFileSet.Create(
+                ("main.bicep", $"""
+                    var fileObj = loadYamlContent('file.yaml', '$', '{encodingName}')
+                    """),
+                ("file.yaml", new(TEST_YAML, encoding)));
 
-            return CompilationHelper.Compile(new(), new InMemoryFileResolver(files), files.Keys, new Uri("file:///main.bicep"));
+            return CompilationHelper.Compile(new(), fileSet, fileSet.GetUri("main.bicep"));
         }
 
         [DataTestMethod]

src/Bicep.Core.UnitTests/BicepTestConstants.cs

@@ -42,8 +42,6 @@ public static class BicepTestConstants
 
         public static readonly IFileSystem FileSystem = new OnDiskFileSystem();
 
-        public static readonly FileResolver FileResolver = new(FileSystem);
-
         public static readonly IFileExplorer FileExplorer = new FileSystemFileExplorer(FileSystem);
 
         public static readonly FeatureProviderOverrides FeatureOverrides = new();
@@ -186,8 +184,7 @@ public static BicepFile CreateDummyBicepFile(RootConfiguration? configuration =
         public static BicepFile CreateDummyBicepFile(IConfigurationManager configurationManager, IFeatureProviderFactory? featureProviderFactory = null)
         {
             return new(
-                new Uri($"inmemory:///main.bicep"),
-                DummyFileHandle.Instance,
+                DummyFileHandle.Default,
                 [],
                 SyntaxFactory.EmptyProgram,
                 configurationManager,