Use loading pattern #1553

MaggieKimani1 · 2024-02-07T07:32:20Z

This PR is an implementation of the loading design proposed as part of this conversation: #1446 (comment) which seeks to resolve the issue highlighted in #1434

It involves:

Creating a static factory for loading/parsing any OpenAPI model object that implements the Load/LoadAsync/Parse pattern as per this implementation https://learn.microsoft.com/en-us/dotnet/api/system.xml.linq.xdocument.load?view=net-7.0
Introducing static Load/LoadAsync/Parse methods in the OpenAPI document class to eliminate the discovery issue
Adding a registry class that allows users to register different OpenAPI format providers and their implementations
Moves the loading code into the core library so that people who only want to load JSON don't need a dependency on the third party YAML library
Short-circuits parsing of JSON documents by avoiding the YAML parser.

Fixes #1434
Fixes #1447

…PI format providers

src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs

src/Microsoft.OpenApi/Reader/Services/OpenApiWorkspaceLoader.cs

+            foreach (var item in referenceCollector.References)
+            {
+                // If not already in workspace, load it and process references
+                if (!_workspace.Contains(item.ExternalResource))
+                {
+                    var input = await _loader.LoadAsync(new(item.ExternalResource, UriKind.RelativeOrAbsolute));
+                    var result = await reader.ReadAsync(input, _readerSettings, cancellationToken);
+                    // Merge diagnostics
+                    if (result.OpenApiDiagnostic != null)
+                    {
+                        diagnostic.AppendDiagnostic(result.OpenApiDiagnostic, item.ExternalResource);
+                    }
+                    if (result.OpenApiDocument != null)
+                    {
+                        var loadDiagnostic = await LoadAsync(item, result.OpenApiDocument, format,  diagnostic, cancellationToken);
+                        diagnostic = loadDiagnostic;
+                    }
+                }
+            }


src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs

src/Microsoft.OpenApi/Reader/Services/OpenApiRemoteReferenceCollector.cs

src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs

src/Microsoft.OpenApi/Reader/OpenApiReaderRegistry.cs

src/Microsoft.OpenApi/Interfaces/IOpenApiReader.cs

src/Microsoft.OpenApi.Readers/OpenApiYamlReader.cs

src/Microsoft.OpenApi/Models/OpenApiModelFactory.cs

src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs

sonarqubecloud · 2024-02-13T12:54:45Z

Quality Gate failed

Failed conditions
70.3% Coverage on New Code (required ≥ 80%)
13.8% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

src/Microsoft.OpenApi/Interfaces/IOpenApiReader.cs

…he API surface; cleanup tests

…tionality that isn't reader-specific to the factory

… to reuse the ReadAsync() methods

src/Microsoft.OpenApi/Reader/OpenApiReaderRegistry.cs

…rd for JsonSchema.NET to qualify it as a valid keyword

…n, else default to the input file extension

darrelmiller

I think this PR looks good. I want have a conversation about having a Load method that doesn't require you to say what the format is, but we can defer that to conversation to after this PR has been merged..

sonarqubecloud · 2024-03-26T07:53:25Z

Quality Gate failed

Failed conditions
26.0% Coverage on New Code (required ≥ 80%)
15.5% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

MaggieKimani1 added 11 commits February 5, 2024 18:31

Move loading code to core lib and adjust namespaces

90dc7fc

Create a static factory for loading/parsing an OpenAPI model object

ed1e02f

Use static methods to call the factory and load up a document

dee116c

Create a reader interface and the implementation for different Open A…

27755ec

…PI format providers

Adjust namespaces and usings

9103bb8

Create a static registry class to register different format providers

ce1c28d

Update constants

2e12d5d

Clean up usings and namespaces

5d89270

Remove unnecessary usings

96e914a

copy output to directory

a507c95

Register reader

7ecb9f2

MaggieKimani1 requested review from andrueastman, baywet, darrelmiller, irvinesunday, millicentachieng, peombwa and zengin as code owners February 7, 2024 07:32

MaggieKimani1 marked this pull request as draft February 7, 2024 07:32

github-advanced-security bot found potential problems Feb 7, 2024

View reviewed changes

Address CodeQL concerns

4382dbb

github-advanced-security bot found potential problems Feb 7, 2024

View reviewed changes

MaggieKimani1 added 4 commits February 7, 2024 16:24

Create a static Http client instance for reuse

67c3501

More CodeQL fixes

3f8238c

Refactor access modifier

b3b458b

Add documentation

d3a1f2b

github-advanced-security bot found potential problems Feb 7, 2024

View reviewed changes

src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs Fixed Show fixed Hide fixed

src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs Fixed Show fixed Hide fixed

MaggieKimani1 added 3 commits February 8, 2024 12:54

Use default settings if none are passed

2eb9852

Update API interface

36de7b8

Update error message

bcafdec

Update tests to validate the load pattern

70768e1

andrueastman reviewed Feb 13, 2024

View reviewed changes

MaggieKimani1 added 2 commits February 13, 2024 15:44

Implement PR feedback

3724eeb

Return the media type without extracting the file format

242428a

darrelmiller reviewed Feb 13, 2024

View reviewed changes

src/Microsoft.OpenApi/Interfaces/IOpenApiReader.cs Outdated Show resolved Hide resolved

MaggieKimani1 added 9 commits February 15, 2024 16:53

Remove the static load methods from the models to prevent expanding t…

957ca8d

…he API surface; cleanup tests

Update hidi to use the Load/Parse methods

575a48a

Simplifies code base by removing unnecessary code and delegating func…

18a152e

…tionality that isn't reader-specific to the factory

Set the JsonReader as the default reader and use it in the YamlReader…

480310e

… to reuse the ReadAsync() methods

Remove depracated files

782b2ec

Code refactoring

298b3e9

Remove depracated interface

487b1f9

Fix failing tests

374fe98

Update API interface

895b48b

MaggieKimani1 mentioned this pull request Feb 19, 2024

Use Load/LoadAsync pattern to load OpenApi documents #1446

Closed

MaggieKimani1 added 3 commits February 19, 2024 14:27

Remove unnecessary usings

77f45b0

Auto-register the YamlReader in Hidi

085c1f1

Remove unnecessary usings

889fcde

VisualBean reviewed Feb 20, 2024

View reviewed changes

src/Microsoft.OpenApi/Reader/OpenApiReaderRegistry.cs Show resolved Hide resolved

MaggieKimani1 added 3 commits February 28, 2024 12:59

Add the SpecVersionAttribute decorator to the custom Extensions keywo…

fcbabd4

…rd for JsonSchema.NET to qualify it as a valid keyword

Clean up

538013d

If supplied, use the input OpenApi format as the output file extensio…

2e5c5f8

…n, else default to the input file extension

darrelmiller approved these changes Mar 20, 2024

View reviewed changes

MaggieKimani1 added 2 commits March 26, 2024 10:43

Update API interface

951aadb

Resolve merge conflicts

c8acd59

Clean up tests

2583b89

MaggieKimani1 merged commit 624814d into release/2.0.0 Mar 26, 2024

MaggieKimani1 deleted the mk/use-loading-pattern branch March 26, 2024 12:58

Use loading pattern #1553

Use loading pattern #1553

Uh oh!

Conversation

MaggieKimani1 commented Feb 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check notice

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Feb 13, 2024

Quality Gate failed

Uh oh!

Uh oh!

Uh oh!

darrelmiller left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Mar 26, 2024

Quality Gate failed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

MaggieKimani1 commented Feb 7, 2024 •

edited

Loading