Merge pull request #241 from Microsoft/dm/perf

Performance enhancements to validation and reference resolution

Author: darrelmiller

Microsoft.OpenApi.sln

@@ -23,7 +23,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{E546B92F-20A
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{6357D7FD-2DE4-4900-ADB9-ABC37052040A}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.OpenApi.SmokeTests", "test\Microsoft.OpenApi.SmokeTests\Microsoft.OpenApi.SmokeTests.csproj", "{AD79B61D-88CF-497C-9ED5-41AE3867C5AC}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.SmokeTests", "test\Microsoft.OpenApi.SmokeTests\Microsoft.OpenApi.SmokeTests.csproj", "{AD79B61D-88CF-497C-9ED5-41AE3867C5AC}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

src/Microsoft.OpenApi.Readers/OpenApiReaderSettings.cs

@@ -47,7 +47,7 @@ public class OpenApiReaderSettings
         /// <summary>
         /// Rules to use for validating OpenAPI specification.  If none are provided a default set of rules are applied.
         /// </summary>
-        public ValidationRuleSet RuleSet { get; set; }
+        public ValidationRuleSet RuleSet { get; set; } = ValidationRuleSet.GetDefaultRuleSet();
 
     }
 }

src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs

@@ -90,11 +90,14 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
             }
 
             // Validate the document
-            var errors = document.Validate(_settings.RuleSet);
-            foreach (var item in errors)
+            if (_settings.RuleSet != null && _settings.RuleSet.Rules.Count > 0)
             {
-                diagnostic.Errors.Add(item);
-            } 
+                var errors = document.Validate(_settings.RuleSet);
+                foreach (var item in errors)
+                {
+                    diagnostic.Errors.Add(item);
+                }
+            }
 
             return document;
         }

src/Microsoft.OpenApi.Readers/Services/OpenApiReferenceResolver.cs

@@ -106,7 +106,8 @@ public override void Visit(OpenApiSecurityRequirement securityRequirement)
         {
             foreach (var scheme in securityRequirement.Keys.ToList())
             {
-                ResolveObject(scheme, (resolvedScheme) => {
+                ResolveObject(scheme, (resolvedScheme) =>
+                {
                     // If scheme was unresolved
                     // copy Scopes and remove old unresolved scheme
                     var scopes = securityRequirement[scheme];

src/Microsoft.OpenApi.Workbench/MainModel.cs

@@ -9,6 +9,8 @@
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers;
+using Microsoft.OpenApi.Services;
+using Microsoft.OpenApi.Validations;
 
 namespace Microsoft.OpenApi.Workbench
 {
@@ -19,6 +21,8 @@ public class MainModel : INotifyPropertyChanged
     {
         private string _input;
 
+        private string _inputFile;
+
         private string _output;
 
         private string _errors;
@@ -47,6 +51,16 @@ public string Input
             }
         }
 
+        public string InputFile
+        {
+            get => _inputFile;
+            set
+            {
+                _inputFile = value;
+                OnPropertyChanged(nameof(InputFile));
+            }
+        }
+
         public string Output
         {
             get => _output;
@@ -149,16 +163,30 @@ protected void OnPropertyChanged(string propertyName)
         /// The core method of the class.
         /// Runs the parsing and serializing.
         /// </summary>
-        internal void Validate()
+        internal void ParseDocument()
         {
             try
             {
-                var stream = CreateStream(_input);
+                Stream stream;
+                if (!String.IsNullOrWhiteSpace(_inputFile))
+                {
+                    stream = new FileStream(_inputFile, FileMode.Open);
+                }
+                else
+                {
+                    stream = CreateStream(_input);
+                }
+                
 
                 var stopwatch = new Stopwatch();
                 stopwatch.Start();
 
-                var document = new OpenApiStreamReader().Read(stream, out var context);
+                var document = new OpenApiStreamReader(new OpenApiReaderSettings
+                    {
+                        ReferenceResolution = ReferenceResolutionSetting.ResolveLocalReferences,
+                        RuleSet = ValidationRuleSet.GetDefaultRuleSet()
+                    }
+                ).Read(stream, out var context);
                 stopwatch.Stop();
                 ParseTime = $"{stopwatch.ElapsedMilliseconds} ms";
 
@@ -184,6 +212,12 @@ internal void Validate()
                 stopwatch.Stop();
 
                 RenderTime = $"{stopwatch.ElapsedMilliseconds} ms";
+
+                var statsVisitor = new StatsVisitor();
+                var walker = new OpenApiWalker(statsVisitor);
+                walker.Walk(document);
+
+                Errors += Environment.NewLine + "Statistics:" + Environment.NewLine + statsVisitor.GetStatisticsReport();    
             }
             catch (Exception ex)
             {

src/Microsoft.OpenApi.Workbench/MainWindow.xaml

@@ -11,8 +11,24 @@
             <ColumnDefinition/>
             <ColumnDefinition />
         </Grid.ColumnDefinitions>
-        <TextBox x:Name="txtInput" Text="{Binding Input}" VerticalScrollBarVisibility="Auto" Margin="10" TextWrapping="Wrap" AcceptsReturn="True" FontFamily="Consolas" />
-        <DockPanel Grid.Column="1" Margin="0,10" >
+    <DockPanel Grid.Column="0"  >
+      <StackPanel DockPanel.Dock="Top">
+        <Label>Input File:</Label>
+        <TextBox x:Name="txtInputFile"
+               Text="{Binding InputFile}" 
+               Margin="10" 
+               TextWrapping="Wrap" AcceptsReturn="false" FontFamily="Consolas" />
+        <Label>Input Content:</Label>
+      </StackPanel>
+      <TextBox x:Name="txtInput" Text="{Binding Input}" 
+               VerticalScrollBarVisibility="Auto" 
+               Margin="10" 
+               TextWrapping="Wrap" 
+               AcceptsReturn="True" 
+               FontFamily="Consolas"
+               VerticalContentAlignment="Stretch" />
+    </DockPanel>
+    <DockPanel Grid.Column="1" Margin="0,10" >
             <StackPanel Orientation="Horizontal"  DockPanel.Dock="Top">
                 <Button Content="Convert" VerticalAlignment="Center" HorizontalAlignment="Left" Height="20" Margin="10" Width="131" Click="Button_Click" Grid.Column="1"/>
                 <StackPanel Orientation="Vertical"  DockPanel.Dock="Top">

src/Microsoft.OpenApi.Workbench/MainWindow.xaml.cs

@@ -20,7 +20,7 @@ public MainWindow()
 
         private void Button_Click(object sender, RoutedEventArgs e)
         {
-            _mainModel.Validate();
+            _mainModel.ParseDocument();
         }
     }
 }