Work on baseURL for workspace

Author: darrelmiller

src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
@@ -16,7 +17,9 @@ namespace Microsoft.OpenApi.Services
     /// </summary>
     public class OpenApiWorkspace
     {
-        private Dictionary<string, OpenApiDocument> _documents = new Dictionary<string, OpenApiDocument>();
+        private Dictionary<Uri, OpenApiDocument> _documents = new Dictionary<Uri, OpenApiDocument>();
+        private Dictionary<Uri, IOpenApiElement> _fragments = new Dictionary<Uri, IOpenApiElement>();
+        private Dictionary<Uri, Stream> _artifacts = new Dictionary<Uri, Stream>();
 
         /// <summary>
         /// A list of OpenApiDocuments contained in the workspace
@@ -30,44 +33,52 @@ public IEnumerable<OpenApiDocument> Documents {
         /// <summary>
         /// A list of document fragments that are contained in the workspace
         /// </summary>
-        public IEnumerable<IOpenApiFragment> Fragments { get; }
+        public IEnumerable<IOpenApiElement> Fragments { get; }
 
+        /// <summary>
+        /// The base location from where all relative references are resolved
+        /// </summary>
+        public Uri BaseUrl { get; }
+
+        /// <summary>
+        /// A list of document fragments that are contained in the workspace
+        /// </summary>
+        public IEnumerable<Stream> Artifacts { get; }
 
         public bool Contains(string location)
         {
-            return _documents.ContainsKey(location);
+            return _documents.ContainsKey(ToLocationUrl(location));
         }
 
-        public void AddDocument(string location, OpenApiDocument  document) 
+        public void AddDocument(string location, OpenApiDocument  document)
         {
             document.Workspace = this;
-            _documents.Add(location, document);
+            _documents.Add(ToLocationUrl(location), document);
         }
 
-        public void AddFragment(string location, IOpenApiFragment fragment)
+        public void AddFragment(string location, IOpenApiElement fragment)
         {
-
+            _fragments.Add(ToLocationUrl(location), fragment);
         }
 
-        public void AddArtifact<T>(string location, T artifact)
+        public void AddArtifact(string location, Stream artifact)
         {
-
+            _artifacts.Add(ToLocationUrl(location), artifact);
         }
 
         public IOpenApiReferenceable ResolveReference(OpenApiReference reference)
         {
-            if (!_documents.TryGetValue(reference.ExternalResource,out var doc))
+            if (!_documents.TryGetValue(new Uri(reference.ExternalResource,UriKind.RelativeOrAbsolute),out var doc))
             {
                 return null;
             }
 
             return doc.ResolveReference(reference,true);
         }
 
-    }
-
-    public interface IOpenApiFragment
-    {
-        IOpenApiReferenceable ResolveReference(OpenApiReference reference);
+        private Uri ToLocationUrl(string location)
+        {
+            return new Uri(BaseUrl, location);
+        }
     }
 }

test/Microsoft.OpenApi.Tests/Workspaces/OpenApiWorkspaceTests.cs

@@ -138,12 +138,30 @@ public void OpenApiWorkspacesAllowDocumentsToReferenceEachOther_short()
         [Fact]
         public void OpenApiWorkspacesShouldNormalizeDocumentLocations()
         {
+            // what does normalize mean?
+            // If we use Urls as locators then normalization happens automatically.
+
+            // How do we set a base location for a workspace?
+                // A base could be a folder.  Should we use file://
+                // A base could be a root url
+                // Are absolute locations allowed?
+                // Can a base URI change once a workspace has been created?
+                // What should be the default base URL?
+            // Can we infer it from a root document?
+                // Is the root document the first document loaded?
+                // Can we load multiple APIs into a Workspace?  Does root document make sense?
+            // What data type should "location" really be?  Is it a Uri?
+                //             
             Assert.True(false);
         }
 
         // Enable Workspace to load from any reader, not just streams.
 
         // Test fragments
+        public void OpenApiWorkspacesShouldLoadDocumentFragments()
+        {
+            Assert.True(false);
+        }
 
         // Test artifacts