Use the server URL to uniquely ID schema models from different clouds during registration #1562

MaggieKimani1 · 2024-02-20T08:16:19Z

Fixes #1555

…ey when registering schemas in the registry to ID multi-cloud files

sonarqubecloud · 2024-02-20T08:45:11Z

Quality Gate failed

Failed conditions
18.8% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

baywet · 2024-02-21T14:31:05Z

src/Microsoft.OpenApi.Readers/V31/OpenApiComponentsDeserializer.cs

+                var refPath = !string.IsNullOrEmpty(serverUrl) ? string.Concat(serverUrl, OpenApiConstants.V3ReferencedSchemaPath)
+                    : OpenApiConstants.V3ReferenceUri;
+
+                var refUri = new Uri(refPath + schema.Key);


set the Uri kind to avoid exceptions

baywet · 2024-02-21T14:31:44Z

src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs

+                        var refPath = serverUrl != null ? string.Concat(serverUrl, OpenApiConstants.V3ReferencedSchemaPath)
+                                            : OpenApiConstants.V3ReferenceUri;
+
+                        var refUri = new Uri(refPath + jsonSchema.Key);


set the uri kind

baywet · 2024-02-21T14:33:23Z

src/Microsoft.OpenApi/Services/OpenApiReferenceResolver.cs

+        private string RemoveTrailingSlash(string url)
+        {
+            if (!string.IsNullOrEmpty(url) && url.EndsWith("/"))
+            {
+                return url.Substring(0, url.Length - 1);
+            }
+            return url;
+        }


Suggested change

private string RemoveTrailingSlash(string url)

{

if (!string.IsNullOrEmpty(url) && url.EndsWith("/"))

{

return url.Substring(0, url.Length - 1);

}

return url;

}

baywet · 2024-02-21T14:33:44Z

src/Microsoft.OpenApi/Services/OpenApiReferenceResolver.cs

+            var servers = _currentDocument.Servers;
+            var basePath = servers?.FirstOrDefault()?.Url;
+
+            basePath = RemoveTrailingSlash(basePath);


Suggested change

basePath = RemoveTrailingSlash(basePath);

basePath = basePath?.TrimEnd('/');

baywet · 2024-02-21T14:34:21Z

src/Microsoft.OpenApi.Readers/V3/OpenApiComponentsDeserializer.cs

+                var refPath = !string.IsNullOrEmpty(serverUrl) ? string.Concat(serverUrl, OpenApiConstants.V3ReferencedSchemaPath)
+                    : OpenApiConstants.V3ReferenceUri;
+
+                var refUri = new Uri(refPath + schema.Key);


set the uri kind

baywet · 2024-02-21T14:34:40Z

src/Microsoft.OpenApi.Readers/V2/OpenApiDocumentDeserializer.cs

+                // Remove any trailing slashes from the server URL
+                if (!string.IsNullOrEmpty(serverUrl) && serverUrl.EndsWith("/"))
+                {
+                    serverUrl = serverUrl.Substring(0, serverUrl.Length - 1);
+                }
+


Suggested change

// Remove any trailing slashes from the server URL

if (!string.IsNullOrEmpty(serverUrl) && serverUrl.EndsWith("/"))

{

serverUrl = serverUrl.Substring(0, serverUrl.Length - 1);

}

baywet · 2024-02-21T14:34:52Z

src/Microsoft.OpenApi.Readers/V2/OpenApiDocumentDeserializer.cs

@@ -321,7 +324,19 @@ private static void RegisterComponentsSchemasInGlobalRegistry(IDictionary<string

            foreach (var schema in schemas)
            {
-                var refUri = new Uri(OpenApiConstants.V2ReferenceUri + schema.Key);
+                var servers = context.GetFromTempStorage<IList<OpenApiServer>>(TempStorageKeys.Servers);
+                var serverUrl = servers?.FirstOrDefault()?.Url;


Suggested change

var serverUrl = servers?.FirstOrDefault()?.Url;

var serverUrl = servers?.FirstOrDefault()?.Url?.TrimEnd('/');

MaggieKimani1 added 3 commits February 20, 2024 11:07

Use compound assignment

efe2135

Use the server url to construct the reference path we'll use as the k…

fc03ad3

…ey when registering schemas in the registry to ID multi-cloud files

Update public API interface

a521169

MaggieKimani1 requested review from irvinesunday, darrelmiller, peombwa, zengin, baywet, millicentachieng and andrueastman as code owners February 20, 2024 08:16

MaggieKimani1 marked this pull request as draft February 20, 2024 08:16

MaggieKimani1 added 2 commits February 20, 2024 11:37

Remove any trailing slashes from the server url

3a70681

Remove comment

8f1de8d

baywet requested changes Feb 21, 2024

View reviewed changes

MaggieKimani1 closed this Mar 25, 2024

baywet deleted the mk/schema-registry branch November 12, 2024 11:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use the server URL to uniquely ID schema models from different clouds during registration #1562

Use the server URL to uniquely ID schema models from different clouds during registration #1562

MaggieKimani1 commented Feb 20, 2024

sonarqubecloud bot commented Feb 20, 2024

baywet Feb 21, 2024

baywet Feb 21, 2024

baywet Feb 21, 2024

baywet Feb 21, 2024

baywet Feb 21, 2024

baywet Feb 21, 2024

baywet Feb 21, 2024

	basePath = RemoveTrailingSlash(basePath);
	basePath = basePath?.TrimEnd('/');

	var serverUrl = servers?.FirstOrDefault()?.Url;
	var serverUrl = servers?.FirstOrDefault()?.Url?.TrimEnd('/');

Use the server URL to uniquely ID schema models from different clouds during registration #1562

Use the server URL to uniquely ID schema models from different clouds during registration #1562

Conversation

MaggieKimani1 commented Feb 20, 2024

sonarqubecloud bot commented Feb 20, 2024

Quality Gate failed

baywet Feb 21, 2024

Choose a reason for hiding this comment

baywet Feb 21, 2024

Choose a reason for hiding this comment

baywet Feb 21, 2024

Choose a reason for hiding this comment

baywet Feb 21, 2024

Choose a reason for hiding this comment

baywet Feb 21, 2024

Choose a reason for hiding this comment

baywet Feb 21, 2024

Choose a reason for hiding this comment

baywet Feb 21, 2024

Choose a reason for hiding this comment