Performance fixes for validation and reference resolution

Author: darrelmiller

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.Workbench/MainModel.cs

@@ -9,6 +9,7 @@
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers;
+using Microsoft.OpenApi.Validations;
 
 namespace Microsoft.OpenApi.Workbench
 {
@@ -19,6 +20,8 @@ public class MainModel : INotifyPropertyChanged
     {
         private string _input;
 
+        private string _inputFile;
+
         private string _output;
 
         private string _errors;
@@ -47,6 +50,16 @@ public string Input
             }
         }
 
+        public string InputFile
+        {
+            get => _inputFile;
+            set
+            {
+                _inputFile = value;
+                OnPropertyChanged(nameof(InputFile));
+            }
+        }
+
         public string Output
         {
             get => _output;
@@ -153,12 +166,26 @@ internal void Validate()
         {
             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";
 

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/Extensions/OpenApiElementExtensions.cs

@@ -20,7 +20,7 @@ public static class OpenApiElementExtensions
         /// <param name="element">Element to validate</param>
         /// <param name="ruleSet">Optional set of rules to use for validation</param>
         /// <returns>An IEnumerable of errors.  This function will never return null.</returns>
-        public static IEnumerable<OpenApiError> Validate(this IOpenApiElement element, ValidationRuleSet ruleSet = null)
+        public static IEnumerable<OpenApiError> Validate(this IOpenApiElement element, ValidationRuleSet ruleSet)
         {
             var validator = new OpenApiValidator(ruleSet);
             var walker = new OpenApiWalker(validator);

src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs

@@ -15,6 +15,7 @@ namespace Microsoft.OpenApi.Services
     public abstract class OpenApiVisitorBase
     {
         private readonly Stack<string> _path = new Stack<string>();
+        private bool _inComponents = false;
 
         /// <summary>
         /// Allow Rule to indicate validation error occured at a deeper context level.  
@@ -33,6 +34,16 @@ public void Exit()
             this._path.Pop();
         }
 
+        public void EnterComponents()
+        {
+            _inComponents = true;
+        }
+
+        public void ExitComponents()
+        {
+            _inComponents = false;
+        }
+
         /// <summary>
         /// Pointer to source of validation error in document
         /// </summary>
@@ -44,7 +55,14 @@ public string PathString
             }
         }
 
-        
+        public bool InComponents
+        {
+            get
+            {
+                return _inComponents;
+            }
+        }
+
         /// <summary>
         /// Visits <see cref="OpenApiDocument"/>
         /// </summary>

src/Microsoft.OpenApi/Services/OpenApiWalker.cs

@@ -96,6 +96,8 @@ internal void Walk(OpenApiComponents components)
                 return;
             }
 
+            _visitor.EnterComponents();
+
             _visitor.Visit(components);
 
             if (components == null)
@@ -192,6 +194,7 @@ internal void Walk(OpenApiComponents components)
             });
 
             Walk(components as IOpenApiExtensible);
+            _visitor.ExitComponents();
         }
 
         /// <summary>

src/Microsoft.OpenApi/Validations/OpenApiValidator.cs

@@ -22,9 +22,9 @@ public class OpenApiValidator : OpenApiVisitorBase, IValidationContext
         /// Create a vistor that will validate an OpenAPIDocument
         /// </summary>
         /// <param name="ruleSet"></param>
-        public OpenApiValidator(ValidationRuleSet ruleSet = null) 
+        public OpenApiValidator(ValidationRuleSet ruleSet) 
         {
-            _ruleSet = ruleSet ?? ValidationRuleSet.GetDefaultRuleSet();
+            _ruleSet = ruleSet;
         }
 
         /// <summary>
@@ -170,7 +170,24 @@ private void Validate<T>(T item)
         private void Validate(object item, Type type)
         {
             if (item == null) return;  // Required fields should be checked by higher level objects
-            var rules = _ruleSet.Where(r => r.ElementType == type);
+            var potentialReference = item as IOpenApiReferenceable;
+
+            if (potentialReference != null && potentialReference.Reference != null)
+            {
+                if (potentialReference.UnresolvedReference)
+                {
+                    return; // Don't attempt to validate unresolved references
+                }
+                else
+                {
+                    if (potentialReference.Reference != null && !InComponents)
+                    {
+                        // Don't validate references if they are in not in Components to avoid validating on every reference
+                        return;
+                    }
+                }
+            }
+            var rules = _ruleSet.FindRules(type);
             foreach (var rule in rules)
             {
                 rule.Evaluate(this as IValidationContext, item);

src/Microsoft.OpenApi/Validations/ValidationRuleSet.cs

@@ -21,6 +21,20 @@ public sealed class ValidationRuleSet : IEnumerable<ValidationRule>
 
         private static ValidationRuleSet _defaultRuleSet;
 
+        private IList<ValidationRule> _emptyRules = new List<ValidationRule>();
+
+        /// <summary>
+        /// Retrieve the rules that are related to a specific type
+        /// </summary>
+        /// <param name="type">The type that is to be validated</param>
+        /// <returns>Either the rules related to the type, or an empty list.</returns>
+        public IList<ValidationRule> FindRules(Type type)
+        {
+            IList<ValidationRule> results = null;
+            _rules.TryGetValue(type, out results);
+            return results ?? _emptyRules;
+        }
+
         /// <summary>
         /// Gets the default validation rule sets.
         /// </summary>
@@ -42,6 +56,12 @@ public static ValidationRuleSet GetDefaultRuleSet()
             return new ValidationRuleSet(_defaultRuleSet);
         }
 
+        public static ValidationRuleSet GetEmptyRuleSet()
+        {
+            // We create a new instance of ValidationRuleSet per call as a safeguard
+            // against unintentional modification of the private _defaultRuleSet.
+            return new ValidationRuleSet();
+        }
         /// <summary>
         /// Initializes a new instance of the <see cref="ValidationRuleSet"/> class.
         /// </summary>

test/Microsoft.OpenApi.Tests/Services/OpenApiValidatorTests.cs

@@ -51,7 +51,7 @@ public void ResponseMustHaveADescription()
                     }
                 });
 
-            var validator = new OpenApiValidator();
+            var validator = new OpenApiValidator(ValidationRuleSet.GetDefaultRuleSet());
             var walker = new OpenApiWalker(validator);
             walker.Walk(openApiDocument);
 
@@ -83,7 +83,7 @@ public void ServersShouldBeReferencedByIndex()
                 }
             };
 
-            var validator = new OpenApiValidator();
+            var validator = new OpenApiValidator(ValidationRuleSet.GetDefaultRuleSet());
             var walker = new OpenApiWalker(validator);
             walker.Walk(openApiDocument);