chore: additional NRT fixes

Signed-off-by: Vincent Biret <[email protected]>

Author: baywet

src/Microsoft.OpenApi.OData.Reader/Edm/ODataOperationSegment.cs

@@ -72,7 +72,7 @@ public ODataOperationSegment(IEdmOperation operation, bool isEscapedFunction, IE
             _model = model ?? throw Error.ArgumentNull(nameof(model));
         }
 
-        private readonly IEdmModel _model;
+        private readonly IEdmModel? _model;
 
         /// <summary>
         /// Gets the parameter mappings.
@@ -99,7 +99,7 @@ public ODataOperationSegment(IEdmOperation operation, bool isEscapedFunction, IE
         public override IEdmEntityType? EntityType => null;
 
         /// <inheritdoc />
-        public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters)
+        public override string? GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters)
         {
             Utils.CheckArgumentNull(settings, nameof(settings));
 
@@ -108,7 +108,7 @@ public override string GetPathItemName(OpenApiConvertSettings settings, HashSet<
                 return FunctionName(function, settings, parameters);
             }
 
-            return OperationName(Operation, settings);
+            return Operation is null ? null : OperationName(Operation, settings);
         }
 
         internal IDictionary<string, string> GetNameMapping(OpenApiConvertSettings settings, HashSet<string> parameters)
@@ -155,8 +155,6 @@ private string FunctionName(IEdmFunction function, OpenApiConvertSettings settin
         {
             if (settings.EnableUriEscapeFunctionCall && IsEscapedFunction)
             {
-                // Debug.Assert(function.Parameters.Count == 2); It should be verify at Edm model.
-                // Debug.Assert(function.IsBound == true);
                 string parameterName = function.Parameters.Last().Name;
                 string uniqueName = Utils.GetUniqueName(parameterName, parameters);
                 if (function.IsComposable)
@@ -171,7 +169,7 @@ private string FunctionName(IEdmFunction function, OpenApiConvertSettings settin
 
             StringBuilder functionName = new();
             functionName.Append(OperationName(function, settings));
-            functionName.Append("(");
+            functionName.Append('(');
 
             int skip = function.IsBound ? 1 : 0;
             functionName.Append(string.Join(",", function.Parameters.Skip(skip).Select(p =>
@@ -183,7 +181,7 @@ private string FunctionName(IEdmFunction function, OpenApiConvertSettings settin
                     : p.Name + $"={quote}{{{uniqueName}}}{quote}";
             })));
 
-            functionName.Append(")");
+            functionName.Append(')');
 
             return functionName.ToString();
         }

src/Microsoft.OpenApi.OData.Reader/Edm/ODataSegment.cs

@@ -86,7 +86,7 @@ public abstract class ODataSegment
         /// <summary>
         /// Gets the entity type of current segment.
         /// </summary>
-        public virtual IEdmEntityType EntityType => throw new NotImplementedException();
+        public virtual IEdmEntityType? EntityType => throw new NotImplementedException();
 
         /// <summary>
         /// Gets the kind of this segment.
@@ -96,14 +96,14 @@ public abstract class ODataSegment
         /// <summary>
         /// Gets the identifier of this segment.
         /// </summary>
-        public abstract string Identifier { get; }
+        public abstract string? Identifier { get; }
 
         /// <summary>
         /// Gets the path item name for this segment.
         /// </summary>
         /// <param name="settings">The settings.</param>
         /// <returns>The path item name.</returns>
-        public string GetPathItemName(OpenApiConvertSettings settings)
+        public string? GetPathItemName(OpenApiConvertSettings settings)
         {
             return GetPathItemName(settings, []);
         }
@@ -125,7 +125,7 @@ public string GetPathHash(OpenApiConvertSettings settings, ODataPath? path = def
         /// <param name="settings">The settings.</param>
         /// <param name="parameters">The existing parameters.</param>
         /// <returns>The path item name.</returns>
-        public abstract string GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters);
+        public abstract string? GetPathItemName(OpenApiConvertSettings settings, HashSet<string> parameters);
 
         /// <summary>
         /// Returns the list of <see cref="IEdmVocabularyAnnotatable"/> this segment refers to.

src/Microsoft.OpenApi.OData.Reader/Operation/EdmOperationOperationHandler.cs

@@ -3,6 +3,7 @@
 //  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
 // ------------------------------------------------------------
 
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text.Json.Nodes;
@@ -32,22 +33,22 @@ protected EdmOperationOperationHandler(OpenApiDocument document) : base(document
         {
 
         }
-        private OperationRestrictionsType _operationRestriction;
+        private OperationRestrictionsType? _operationRestriction;
 
         /// <summary>
         /// Gets the navigation source.
         /// </summary>
-        protected IEdmNavigationSource NavigationSource { get; private set; }
+        protected IEdmNavigationSource? NavigationSource { get; private set; }
 
         /// <summary>
         /// Gets the Edm operation.
         /// </summary>
-        protected IEdmOperation EdmOperation { get; private set; }
+        protected IEdmOperation? EdmOperation { get; private set; }
 
         /// <summary>
         /// Gets the OData operation segment.
         /// </summary>
-        protected ODataOperationSegment OperationSegment { get; private set; }
+        protected ODataOperationSegment? OperationSegment { get; private set; }
 
         /// <summary>
         /// Gets a value indicating whether the path has type cast segment or not.
@@ -60,31 +61,38 @@ protected override void Initialize(ODataContext context, ODataPath path)
             base.Initialize(context, path);
 
             // It's bound operation, the first segment must be the navigaiton source.
-            ODataNavigationSourceSegment navigationSourceSegment = path.FirstSegment as ODataNavigationSourceSegment;
-            NavigationSource = navigationSourceSegment.NavigationSource;
+            if (path.FirstSegment is ODataNavigationSourceSegment navigationSourceSegment)
+                NavigationSource = navigationSourceSegment.NavigationSource;
 
-            OperationSegment = path.LastSegment as ODataOperationSegment;
-            EdmOperation = OperationSegment.Operation;
+            if (path.LastSegment is ODataOperationSegment opSegment)
+            {
+                OperationSegment = opSegment;
+                EdmOperation = opSegment.Operation;
+            }
 
             HasTypeCast = path.Segments.Any(s => s is ODataTypeCastSegment);
 
-            _operationRestriction = Context.Model.GetRecord<OperationRestrictionsType>(TargetPath, CapabilitiesConstants.OperationRestrictions);
-            var operationRestrictions = Context.Model.GetRecord<OperationRestrictionsType>(EdmOperation, CapabilitiesConstants.OperationRestrictions);
-            _operationRestriction?.MergePropertiesIfNull(operationRestrictions);
-            _operationRestriction ??= operationRestrictions;
+            if (!string.IsNullOrEmpty(TargetPath))
+                _operationRestriction = Context?.Model.GetRecord<OperationRestrictionsType>(TargetPath, CapabilitiesConstants.OperationRestrictions);
+            if (Context is not null && EdmOperation is not null &&
+                Context.Model.GetRecord<OperationRestrictionsType>(EdmOperation, CapabilitiesConstants.OperationRestrictions) is { } operationRestrictions)
+            {
+                _operationRestriction?.MergePropertiesIfNull(operationRestrictions);
+                _operationRestriction ??= operationRestrictions;
+            }
         }
 
         /// <inheritdoc/>
         protected override void SetBasicInfo(OpenApiOperation operation)
         {
             // Summary
-            operation.Summary = "Invoke " + (EdmOperation.IsAction() ? "action " : "function ") + EdmOperation.Name;
+            operation.Summary = "Invoke " + (EdmOperation?.IsAction() ?? false ? "action " : "function ") + EdmOperation?.Name;
 
             // Description
-            operation.Description = Context.Model.GetDescriptionAnnotation(TargetPath) ?? Context.Model.GetDescriptionAnnotation(EdmOperation);
+            operation.Description = (string.IsNullOrEmpty(TargetPath) ? null :Context?.Model.GetDescriptionAnnotation(TargetPath)) ?? Context?.Model.GetDescriptionAnnotation(EdmOperation);
 
             // OperationId
-            if (Context.Settings.EnableOperationId)
+            if (Context is {Settings.EnableOperationId: true} && Path is not null)
             {
                 // When the key segment is available,
                 // its EntityType name will be used
@@ -97,7 +105,7 @@ protected override void SetBasicInfo(OpenApiOperation operation)
                 {
                     if (segment is ODataKeySegment keySegment)
                     {
-                        if (!keySegment.IsAlternateKey) 
+                        if (!keySegment.IsAlternateKey && segment is {EntityType: not null}) 
                         {
                             identifiers.Add(segment.EntityType.Name);
                             continue;
@@ -113,7 +121,7 @@ protected override void SetBasicInfo(OpenApiOperation operation)
                             identifiers.Add(keySegment.Identifier);
                         }
                     }
-                    else if (segment is ODataOperationSegment opSegment)
+                    else if (segment is ODataOperationSegment {Identifier: not null} opSegment)
                     {
                         if (opSegment.Operation is IEdmFunction function && Context.Model.IsOperationOverload(function))
                         {
@@ -123,9 +131,9 @@ protected override void SetBasicInfo(OpenApiOperation operation)
                                 : (pathHash + opSegment.GetPathHash(Context.Settings)).GetHashSHA256()[..4];
                         }
 
-                        identifiers.Add(segment.Identifier);
+                        identifiers.Add(opSegment.Identifier);
                     }
-                    else
+                    else if (!string.IsNullOrEmpty(segment.Identifier))
                     {
                         identifiers.Add(segment.Identifier);
                     }
@@ -154,11 +162,12 @@ protected override void SetTags(OpenApiOperation operation)
             {
                 Name = tagName,
             };
+            tag.Extensions ??= new Dictionary<string, IOpenApiExtension>();
             tag.Extensions.Add(Constants.xMsTocType, new OpenApiAny("container"));
             operation.Tags ??= new HashSet<OpenApiTagReference>();
             operation.Tags.Add(new OpenApiTagReference(tag.Name, _document));
 
-            Context.AppendTag(tag);
+            Context?.AppendTag(tag);
 
             base.SetTags(operation);
         }
@@ -169,12 +178,13 @@ protected override void SetTags(OpenApiOperation operation)
         /// <param name="tagName">The generated tag name.</param>
         /// <param name="skip">The number of segments to skip.</param>
         private void GenerateTagName(out string tagName, int skip = 1)
-        {            
+        {
+            if (Path is null) throw new InvalidOperationException("Path is null.");
             var targetSegment = Path.Segments.Reverse().Skip(skip).FirstOrDefault();
 
             switch (targetSegment)
             {
-                case ODataNavigationPropertySegment:
+                case ODataNavigationPropertySegment when Context is not null:
                     tagName = EdmModelHelper.GenerateNavigationPropertyPathTagName(Path, Context);
                     break;
                 case ODataOperationImportSegment:
@@ -184,7 +194,7 @@ private void GenerateTagName(out string tagName, int skip = 1)
                     GenerateTagName(out tagName, skip);
                     break;
                 default:
-                    tagName = NavigationSource.Name + "." + NavigationSource.EntityType.Name;
+                    tagName = NavigationSource?.Name + "." + NavigationSource?.EntityType.Name;
                     if (EdmOperation.IsAction())
                     {
                         tagName += ".Actions";
@@ -202,17 +212,17 @@ protected override void SetParameters(OpenApiOperation operation)
         {
             base.SetParameters(operation);
 
-            if (EdmOperation.IsFunction())
+            if (EdmOperation.IsFunction() && EdmOperation is IEdmFunction function)
             {
-                IEdmFunction function = (IEdmFunction)EdmOperation;
                 AppendSystemQueryOptions(function, operation);
             }
         }
 
         /// <inheritdoc/>
         protected override void SetResponses(OpenApiOperation operation) 
         {
-            operation.Responses = Context.CreateResponses(EdmOperation, _document);
+            if (EdmOperation is not null && Context is not null)
+                operation.Responses = Context.CreateResponses(EdmOperation, _document);
             base.SetResponses(operation);
         }
 
@@ -224,7 +234,7 @@ protected override void SetSecurity(OpenApiOperation operation)
                 return;
             }
 
-            operation.Security = Context.CreateSecurityRequirements(_operationRestriction.Permissions, _document).ToList();
+            operation.Security = Context?.CreateSecurityRequirements(_operationRestriction.Permissions, _document).ToList();
         }
 
         /// <inheritdoc/>
@@ -248,8 +258,9 @@ protected override void AppendCustomParameters(OpenApiOperation operation)
 
         private void AppendSystemQueryOptions(IEdmFunction function, OpenApiOperation operation)
         {
-            if (function.ReturnType.IsCollection())
+            if (function.ReturnType.IsCollection() && Context is not null)
             {
+                operation.Parameters ??= [];
                 // $top
                 if (Context.CreateTop(function, _document) is {} topParameter)
                 {
@@ -306,10 +317,10 @@ private void AppendSystemQueryOptions(IEdmFunction function, OpenApiOperation op
         /// <inheritdoc/>
         protected override void SetCustomLinkRelType()
         {
-            if (Context.Settings.CustomHttpMethodLinkRelMapping != null && EdmOperation != null)
+            if (Context is {Settings.CustomHttpMethodLinkRelMapping: not null} && EdmOperation != null)
             {
                 LinkRelKey key = EdmOperation.IsAction() ? LinkRelKey.Action : LinkRelKey.Function;
-                Context.Settings.CustomHttpMethodLinkRelMapping.TryGetValue(key, out string linkRelValue);
+                Context.Settings.CustomHttpMethodLinkRelMapping.TryGetValue(key, out var linkRelValue);
                 CustomLinkRel =  linkRelValue;
             }
         }
@@ -321,9 +332,9 @@ protected override void SetExternalDocs(OpenApiOperation operation)
             {
                 var externalDocs = (string.IsNullOrEmpty(TargetPath), string.IsNullOrEmpty(CustomLinkRel))  switch
                 {
-                    (_, true) => null,
                     (false, false) => Context.Model.GetLinkRecord(TargetPath!, CustomLinkRel!),
-                    (true, false) => Context.Model.GetLinkRecord(EdmOperation, CustomLinkRel!),
+                    (true, false) when EdmOperation is not null => Context.Model.GetLinkRecord(EdmOperation, CustomLinkRel!),
+                    (_, _) => null,
                 };
 
                 if (externalDocs != null)
@@ -340,9 +351,9 @@ protected override void SetExternalDocs(OpenApiOperation operation)
         // <inheritdoc/>
         protected override void SetExtensions(OpenApiOperation operation)
         {
-            if (Context is { Settings.EnablePagination: true } && EdmOperation.ReturnType?.TypeKind() == EdmTypeKind.Collection)
+            if (Context is { Settings.EnablePagination: true } && EdmOperation?.ReturnType?.TypeKind() == EdmTypeKind.Collection)
             {
-                JsonObject extension = new JsonObject
+                var extension = new JsonObject
                 {
                     { "nextLinkName", "@odata.nextLink"},
                     { "operationName", Context.Settings.PageableOperationName}

src/Microsoft.OpenApi.OData.Reader/Operation/EntitySetOperationHandler.cs

@@ -5,6 +5,7 @@
 
 using Microsoft.OData.Edm;
 using Microsoft.OpenApi.Any;
+using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Models.References;
 using Microsoft.OpenApi.OData.Common;
@@ -30,27 +31,26 @@ protected EntitySetOperationHandler(OpenApiDocument document) : base(document)
         /// <summary>
         /// Gets/sets the <see cref="IEdmEntitySet"/>.
         /// </summary>
-        protected IEdmEntitySet EntitySet { get; private set; }
+        protected IEdmEntitySet? EntitySet { get; private set; }
 
         /// <inheritdoc/>
         protected override void Initialize(ODataContext context, ODataPath path)
         {
             base.Initialize(context, path);
 
             // get the entity set.
-            ODataNavigationSourceSegment navigationSourceSegment = path.FirstSegment as ODataNavigationSourceSegment;
-
-            EntitySet = navigationSourceSegment.NavigationSource as IEdmEntitySet;
+            if (path.FirstSegment is ODataNavigationSourceSegment {NavigationSource: IEdmEntitySet navigationSource})
+                EntitySet = navigationSource;
         }
 
         /// <inheritdoc/>
         protected override void SetTags(OpenApiOperation operation)
         {
-            var tagName = EntitySet.Name + "." + EntitySet.EntityType.Name;
+            var tagName = EntitySet?.Name + "." + EntitySet?.EntityType.Name;
             operation.Tags ??= new HashSet<OpenApiTagReference>();
             operation.Tags.Add(new OpenApiTagReference(tagName, _document));
 
-            Context.AddExtensionToTag(tagName, Constants.xMsTocType, new OpenApiAny("page"), () => new OpenApiTag()
+            Context?.AddExtensionToTag(tagName, Constants.xMsTocType, new OpenApiAny("page"), () => new OpenApiTag()
 			{
 				Name = tagName
 			});
@@ -61,6 +61,7 @@ protected override void SetTags(OpenApiOperation operation)
         /// <inheritdoc/>
         protected override void SetExtensions(OpenApiOperation operation)
         {
+            operation.Extensions ??= new Dictionary<string, IOpenApiExtension>();
             operation.Extensions.Add(Constants.xMsDosOperationType, new OpenApiAny("operation"));
 
             base.SetExtensions(operation);
@@ -69,10 +70,10 @@ protected override void SetExtensions(OpenApiOperation operation)
         /// <inheritdoc/>
         protected override void SetExternalDocs(OpenApiOperation operation)
         {
-            if (Context.Settings.ShowExternalDocs)
+            if (Context is {Settings.ShowExternalDocs: true} && CustomLinkRel is not null)
             {
-                var externalDocs = Context.Model.GetLinkRecord(TargetPath, CustomLinkRel) ??
-                    Context.Model.GetLinkRecord(EntitySet, CustomLinkRel);
+                var externalDocs = (string.IsNullOrEmpty(TargetPath) ? null : Context.Model.GetLinkRecord(TargetPath, CustomLinkRel)) ??
+                    (EntitySet is null ? null : Context.Model.GetLinkRecord(EntitySet, CustomLinkRel));
 
                 if (externalDocs != null)
                 {