Refactor to C# 8.0 features

Author: Chris Martinez

SECURITY.md

@@ -12,7 +12,7 @@ If you believe you have found a security vulnerability in any Microsoft-owned re
 
 Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
 
-If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
 
 You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
 

build/code-analysis.props

@@ -16,8 +16,8 @@
   </ItemGroup>
 
   <ItemGroup Label="NuGet">
-    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.6.2" PrivateAssets="All" />
-    <PackageReference Include="StyleCop.Analyzers" Version="1.1.1-beta.61" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.6" PrivateAssets="All" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.66" PrivateAssets="All" />
   </ItemGroup>
 
 </Project>

build/nuget.props

@@ -2,6 +2,7 @@
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 
  <PropertyGroup Label="NuGet">
+  <IsPackable>true</IsPackable>
   <RepositoryType>git</RepositoryType>
   <RepositoryUrl>https://github.com/Microsoft/aspnet-api-versioning</RepositoryUrl>
   <PackageIconUrl>http://go.microsoft.com/fwlink/?LinkID=288890</PackageIconUrl>

samples/aspnetcore/ODataBasicSample/ODataBasicSample.csproj

@@ -2,7 +2,6 @@
 
  <PropertyGroup>
   <TargetFramework>netcoreapp2.2</TargetFramework>
-  <AspNetCoreHostingModel>InProcess</AspNetCoreHostingModel>
   <RootNamespace>Microsoft.Examples</RootNamespace>
  </PropertyGroup>
 

samples/aspnetcore/SwaggerODataSample/SwaggerODataSample.csproj

@@ -2,7 +2,6 @@
 
  <PropertyGroup>
   <TargetFramework>netcoreapp2.2</TargetFramework>
-  <AspNetCoreHostingModel>InProcess</AspNetCoreHostingModel>
   <RootNamespace>Microsoft.Examples</RootNamespace>
   <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(MSBuildThisFileName).xml</DocumentationFile>
  </PropertyGroup>

samples/directory.build.props

@@ -4,6 +4,7 @@
  <PropertyGroup>
   <LangVersion>latest</LangVersion>
   <IsTestProject>false</IsTestProject>
+  <IsPackable>false</IsPackable>
  </PropertyGroup>
 
 </Project>

src/Common.ApiExplorer/ApiExplorerOptions.cs

@@ -25,7 +25,7 @@ public partial class ApiExplorerOptions
         /// <remarks>For information about API version formatting, review <see cref="ApiVersionFormatProvider"/>
         /// as well as the <see cref="ApiVersion.ToString(string)"/> and <see cref="ApiVersion.ToString(string, IFormatProvider)"/>
         /// methods.</remarks>
-        public string GroupNameFormat { get; set; }
+        public string GroupNameFormat { get; set; } = string.Empty;
 
         /// <summary>
         /// Gets or sets the format used to format the API version value substituted in route templates.

src/Common.OData.ApiExplorer/AspNet.OData/Builder/DefaultODataQueryOptionDescriptionProvider.cs

@@ -3,7 +3,6 @@
     using Microsoft.AspNet.OData.Query;
     using System;
     using System.Collections.Generic;
-    using System.Diagnostics.Contracts;
     using System.Text;
     using static Microsoft.AspNet.OData.Query.AllowedArithmeticOperators;
     using static Microsoft.AspNet.OData.Query.AllowedLogicalOperators;
@@ -23,8 +22,6 @@ public class DefaultODataQueryOptionDescriptionProvider : IODataQueryOptionDescr
         /// <inheritdoc />
         public virtual string Describe( AllowedQueryOptions queryOption, ODataQueryOptionDescriptionContext context )
         {
-            Arg.NotNull( context, nameof( context ) );
-
             if ( ( queryOption < Filter || queryOption > Supported ) || ( queryOption != Filter && ( (int) queryOption % 2 != 0 ) ) )
             {
                 throw new ArgumentException( SR.MultipleQueryOptionsNotAllowed, nameof( queryOption ) );
@@ -41,8 +38,8 @@ public virtual string Describe( AllowedQueryOptions queryOption, ODataQueryOptio
                 Count => DescribeCount( context ),
 #pragma warning disable CA1308 // Normalize strings to uppercase
                 _ => throw new ArgumentException( SR.UnsupportedQueryOption.FormatDefault( queryOption.ToString().ToLowerInvariant() ), nameof( queryOption ) ),
-            };
 #pragma warning restore CA1308
+            };
         }
 
         /// <summary>
@@ -52,8 +49,10 @@ public virtual string Describe( AllowedQueryOptions queryOption, ODataQueryOptio
         /// <returns>The query option description.</returns>
         protected virtual string DescribeFilter( ODataQueryOptionDescriptionContext context )
         {
-            Arg.NotNull( context, nameof( context ) );
-            Contract.Ensures( !string.IsNullOrEmpty( Contract.Result<string>() ) );
+            if ( context == null )
+            {
+                throw new ArgumentNullException( nameof( context ) );
+            }
 
             var description = new StringBuilder();
 
@@ -84,8 +83,10 @@ protected virtual string DescribeFilter( ODataQueryOptionDescriptionContext cont
         /// <returns>The query option description.</returns>
         protected virtual string DescribeExpand( ODataQueryOptionDescriptionContext context )
         {
-            Arg.NotNull( context, nameof( context ) );
-            Contract.Ensures( !string.IsNullOrEmpty( Contract.Result<string>() ) );
+            if ( context == null )
+            {
+                throw new ArgumentNullException( nameof( context ) );
+            }
 
             var description = new StringBuilder();
 
@@ -114,8 +115,10 @@ protected virtual string DescribeExpand( ODataQueryOptionDescriptionContext cont
         /// <returns>The query option description.</returns>
         protected virtual string DescribeSelect( ODataQueryOptionDescriptionContext context )
         {
-            Arg.NotNull( context, nameof( context ) );
-            Contract.Ensures( !string.IsNullOrEmpty( Contract.Result<string>() ) );
+            if ( context == null )
+            {
+                throw new ArgumentNullException( nameof( context ) );
+            }
 
             var description = new StringBuilder();
 
@@ -138,8 +141,10 @@ protected virtual string DescribeSelect( ODataQueryOptionDescriptionContext cont
         /// <returns>The query option description.</returns>
         protected virtual string DescribeOrderBy( ODataQueryOptionDescriptionContext context )
         {
-            Arg.NotNull( context, nameof( context ) );
-            Contract.Ensures( !string.IsNullOrEmpty( Contract.Result<string>() ) );
+            if ( context == null )
+            {
+                throw new ArgumentNullException( nameof( context ) );
+            }
 
             var description = new StringBuilder();
 
@@ -168,8 +173,10 @@ protected virtual string DescribeOrderBy( ODataQueryOptionDescriptionContext con
         /// <returns>The query option description.</returns>
         protected virtual string DescribeTop( ODataQueryOptionDescriptionContext context )
         {
-            Arg.NotNull( context, nameof( context ) );
-            Contract.Ensures( !string.IsNullOrEmpty( Contract.Result<string>() ) );
+            if ( context == null )
+            {
+                throw new ArgumentNullException( nameof( context ) );
+            }
 
             var description = new StringBuilder();
 
@@ -191,8 +198,10 @@ protected virtual string DescribeTop( ODataQueryOptionDescriptionContext context
         /// <returns>The query option description.</returns>
         protected virtual string DescribeSkip( ODataQueryOptionDescriptionContext context )
         {
-            Arg.NotNull( context, nameof( context ) );
-            Contract.Ensures( !string.IsNullOrEmpty( Contract.Result<string>() ) );
+            if ( context == null )
+            {
+                throw new ArgumentNullException( nameof( context ) );
+            }
 
             var description = new StringBuilder();
 
@@ -212,19 +221,10 @@ protected virtual string DescribeSkip( ODataQueryOptionDescriptionContext contex
         /// </summary>
         /// <param name="context">The current <see cref="ODataQueryOptionDescriptionContext">description context</see>.</param>
         /// <returns>The query option description.</returns>
-        protected virtual string DescribeCount( ODataQueryOptionDescriptionContext context )
-        {
-            Arg.NotNull( context, nameof( context ) );
-            Contract.Ensures( !string.IsNullOrEmpty( Contract.Result<string>() ) );
-
-            return SR.CountQueryOptionDesc;
-        }
+        protected virtual string DescribeCount( ODataQueryOptionDescriptionContext context ) => SR.CountQueryOptionDesc;
 
         static void AppendAllowedOptions( StringBuilder description, ODataQueryOptionDescriptionContext context )
         {
-            Contract.Requires( description != null );
-            Contract.Requires( context != null );
-
             if ( context.AllowedLogicalOperators != AllowedLogicalOperators.None &&
                  context.AllowedLogicalOperators != AllowedLogicalOperators.All )
             {
@@ -336,28 +336,24 @@ static IEnumerable<string> EnumerateArithmeticOperators( AllowedArithmeticOperat
 
         static string ToCommaSeparatedValues( IEnumerable<string> values )
         {
-            Contract.Requires( values != null );
-            Contract.Ensures( Contract.Result<string>() != null );
+            using var iterator = values.GetEnumerator();
 
-            using ( var iterator = values.GetEnumerator() )
+            if ( !iterator.MoveNext() )
             {
-                if ( !iterator.MoveNext() )
-                {
-                    return string.Empty;
-                }
-
-                var csv = new StringBuilder();
+                return string.Empty;
+            }
 
-                csv.Append( iterator.Current );
+            var csv = new StringBuilder();
 
-                while ( iterator.MoveNext() )
-                {
-                    csv.Append( ", " );
-                    csv.Append( iterator.Current );
-                }
+            csv.Append( iterator.Current );
 
-                return csv.ToString();
+            while ( iterator.MoveNext() )
+            {
+                csv.Append( ", " );
+                csv.Append( iterator.Current );
             }
+
+            return csv.ToString();
         }
     }
 }

src/Common.OData.ApiExplorer/AspNet.OData/Builder/IODataActionQueryOptionsConventionBuilder{T}.cs

@@ -14,8 +14,11 @@
     [CLSCompliant( false )]
 #endif
     public interface IODataActionQueryOptionsConventionBuilder<T>
+        where T : notnull
 #if WEBAPI
-        where T : IHttpController
+#pragma warning disable SA1001 // Commas should be spaced correctly
+       , IHttpController
+#pragma warning restore SA1001 // Commas should be spaced correctly
 #endif
     {
         /// <summary>

src/Common.OData.ApiExplorer/AspNet.OData/Builder/ODataActionQueryOptionConventionLookup.cs

@@ -3,5 +3,5 @@
     using System;
     using System.Reflection;
 
-    delegate bool ODataActionQueryOptionConventionLookup( MethodInfo action, ODataQueryOptionSettings settings, out IODataQueryOptionsConvention convention );
+    delegate bool ODataActionQueryOptionConventionLookup( MethodInfo action, ODataQueryOptionSettings settings, out IODataQueryOptionsConvention? convention );
 }