.NET Core 3 Upgrade

Docs/Orleans.md

@@ -20,6 +20,10 @@ The [Microsoft Orleans](https://dotnet.github.io/orleans/) project template uses
 - **ReadMe** - Add a README.md markdown file describing the project.
 - **TreatWarningsAsErrors** - Treat warnings as errors.
 
+#### Security
+
+- **TLS** (Default=Off) - Adds TLS transport encryption to secure communication between the client and server.
+
 #### Analytics
 
 - **Analytics** - Monitor internal information about how your application is running, as well as external user information.

Source/ApiTemplate/.template.config/template.json

@@ -49,8 +49,7 @@
         {
           "condition": "(!Swagger)",
           "exclude": [
-            "Source/ApiTemplate/OperationFilters/**/*",
-            "Source/ApiTemplate/ViewModelSchemaFilters/**/*"
+            "Source/ApiTemplate/OperationFilters/**/*"
           ]
         },
         // Versioning
@@ -491,4 +490,4 @@
       ]
     }
   ]
-}
+}

Source/ApiTemplate/Source/ApiTemplate/ApiTemplate.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
   <!--#if (AuthoringMode)-->
   <PropertyGroup>
     <!-- Modify these constants to enable/disable a feature to debug the template. Note that this only affects the C#. -->
@@ -13,8 +13,7 @@
   <!--#endif-->
 
   <PropertyGroup Label="Build">
-    <TargetFramework>netcoreapp2.2</TargetFramework>
-    <AspNetCoreHostingModel>InProcess</AspNetCoreHostingModel>
+    <TargetFramework>netcoreapp3.0</TargetFramework>
     <!-- Use the latest version of the C# language. -->
     <LangVersion>latest</LangVersion>
     <!--#if (Swagger)-->
@@ -26,9 +25,6 @@
          control provider. Only use this in Development, it is not intended for Production use.
          See http://docs.asp.net/en/latest/security/app-secrets.html -->
     <UserSecretsId>ApiTemplate-113f2d04-69f0-40c3-8797-ba3f356dd812</UserSecretsId>
-    <!-- Enable tiered JIT compilation for better performance.
-         See http://mattwarren.org/2017/12/15/How-does-.NET-JIT-a-method-and-Tiered-Compilation/ -->
-    <TieredCompilation>true</TieredCompilation>
     <TreatWarningsAsErrors Condition="'$(TreatWarningsAsErrors)' == 'true'">true</TreatWarningsAsErrors>
     <!--#if (!IIS)-->
     <!-- Disable publishing of a web.config file for IIS when calling dotnet publish. -->
@@ -52,27 +48,29 @@
   </ItemGroup>
 
   <ItemGroup Label="Package References">
-    <PackageReference Include="Boxed.AspNetCore" Version="4.0.0" />
+    <ProjectReference Include="..\..\..\..\..\Framework\Source\Boxed.AspNetCore\Boxed.AspNetCore.csproj" />
+    <ProjectReference Include="..\..\..\..\..\Framework\Source\Boxed.AspNetCore.Swagger\Boxed.AspNetCore.Swagger.csproj" Condition="'$(Swagger)' == 'true'" />
+    <ProjectReference Include="..\..\..\..\..\Framework\Source\Boxed.Mapping\Boxed.Mapping.csproj" />
+    <!--<PackageReference Include="Boxed.AspNetCore" Version="4.0.0" />
     <PackageReference Include="Boxed.AspNetCore.Swagger" Version="5.1.0" Condition="'$(Swagger)' == 'true'" />
-    <PackageReference Include="Boxed.Mapping" Version="2.0.0" />
+    <PackageReference Include="Boxed.Mapping" Version="2.0.0" />-->
     <PackageReference Include="CorrelationId" Version="2.1.0" Condition="'$(CorrelationId)' == 'true'" />
-    <PackageReference Include="Microsoft.AspNetCore.App" />
+    <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.8.2" Condition="'$(ApplicationInsights)' == 'true'" />
     <PackageReference Include="Microsoft.AspNetCore.ApplicationInsights.HostingStartup" Version="2.2.0" Condition="'$(ApplicationInsights)' == 'true'" />
-    <PackageReference Include="Microsoft.AspNetCore.AzureAppServicesIntegration" Version="2.2.5" Condition="'$(Azure)' == 'true'" />
-    <PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning" Version="3.1.5" Condition="'$(Swagger)' == 'false' AND '$(Versioning)' == 'true'" />
-    <PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer" Version="3.2.1" Condition="'$(Swagger)' == 'true' AND '$(Versioning)' == 'true'" />
-    <PackageReference Include="Newtonsoft.Json" Version="12.0.2" />
-    <PackageReference Include="Serilog.AspNetCore" Version="2.1.1" />
+    <PackageReference Include="Microsoft.AspNetCore.AzureAppServicesIntegration" Version="3.0.0" Condition="'$(Azure)' == 'true'" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer" Version="4.0.0" Condition="'$(Swagger)' == 'true' AND '$(Versioning)' == 'true'" />
+    <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
+    <PackageReference Include="Serilog.AspNetCore" Version="3.2.0-dev-00135" />
     <PackageReference Include="Serilog.Enrichers.Environment" Version="2.1.3" />
     <PackageReference Include="Serilog.Enrichers.Process" Version="2.0.1" />
     <PackageReference Include="Serilog.Enrichers.Thread" Version="3.1.0" />
     <PackageReference Include="Serilog.Exceptions" Version="5.3.1" />
     <PackageReference Include="Serilog.Settings.Configuration" Version="3.1.0" />
-    <PackageReference Include="Serilog.Sinks.ApplicationInsights" Version="2.5.2" Condition="'$(ApplicationInsights)' == 'true'" />
+    <PackageReference Include="Serilog.Sinks.ApplicationInsights" Version="3.0.4" Condition="'$(ApplicationInsights)' == 'true'" />
     <PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
     <PackageReference Include="Serilog.Sinks.Debug" Version="1.0.1" />
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="4.0.1" Condition="'$(Swagger)' == 'true'" />
-    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="4.0.1" Condition="'$(Swagger)' == 'true'" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="5.0.0-rc4" Condition="'$(Swagger)' == 'true'" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="5.0.0-rc4" Condition="'$(Swagger)' == 'true'" />
   </ItemGroup>
 
 </Project>

Source/ApiTemplate/Source/ApiTemplate/ApplicationBuilderExtensions.cs

@@ -11,24 +11,13 @@ namespace ApiTemplate
     using Microsoft.AspNetCore.Builder;
 #if Versioning
     using Microsoft.AspNetCore.Mvc.ApiExplorer;
+    using Microsoft.AspNetCore.Mvc.Infrastructure;
 #endif
     using Microsoft.Extensions.DependencyInjection;
+    using Serilog;
 
     public static partial class ApplicationBuilderExtensions
     {
-        /// <summary>
-        /// Adds developer friendly error pages for the application which contain extra debug and exception information.
-        /// Note: It is unsafe to use this in production.
-        /// </summary>
-        public static IApplicationBuilder UseDeveloperErrorPages(this IApplicationBuilder application) =>
-            application
-                // When a database error occurs, displays a detailed error page with full diagnostic information. It is
-                // unsafe to use this in production. Uncomment this if using a database.
-                // .UseDatabaseErrorPage(DatabaseErrorPageOptions.ShowAll);
-                // When an error occurs, displays a detailed error page with full diagnostic information.
-                // See http://docs.asp.net/en/latest/fundamentals/diagnostics.html
-                .UseDeveloperExceptionPage();
-
         /// <summary>
         /// Uses the static files middleware to serve static files. Also adds the Cache-Control and Pragma HTTP
         /// headers. The cache duration is controlled from configuration.
@@ -50,6 +39,23 @@ public static IApplicationBuilder UseStaticFilesWithCacheControl(this IApplicati
                     });
         }
 
+        /// <summary>
+        /// Uses custom serilog request logging. Adds additional properties to each log.
+        /// See https://github.com/serilog/serilog-aspnetcore.
+        /// </summary>
+        public static IApplicationBuilder UseCustomSerilogRequestLogging(
+            this IApplicationBuilder application,
+            IActionContextAccessor actionContextAccessor) =>
+            application.UseSerilogRequestLogging(
+                options => options.EnrichDiagnosticContext = (diagnosticContext, httpContext) =>
+                {
+                    var actionDescriptor = actionContextAccessor.ActionContext.ActionDescriptor;
+                    diagnosticContext.Set("ActionName", actionDescriptor.DisplayName);
+                    diagnosticContext.Set("ActionId", actionDescriptor.Id);
+                    diagnosticContext.Set("RequestHost", httpContext.Request.Host.Value);
+                    diagnosticContext.Set("RequestScheme", httpContext.Request.Scheme);
+                });
+
 #if Swagger
 
         public static IApplicationBuilder UseCustomSwaggerUI(this IApplicationBuilder application) =>
@@ -63,7 +69,8 @@ public static IApplicationBuilder UseCustomSwaggerUI(this IApplicationBuilder ap
                         .Product;
                     // Set the Swagger UI to render at '/'.
                     options.RoutePrefix = string.Empty;
-                    // Show the request duration in Swagger UI.
+
+                    options.DisplayOperationId();
                     options.DisplayRequestDuration();
 
 #if Versioning

Source/ApiTemplate/Source/ApiTemplate/Commands/DeleteCarCommand.cs

@@ -14,13 +14,13 @@ public DeleteCarCommand(ICarRepository carRepository) =>
 
         public async Task<IActionResult> ExecuteAsync(int carId, CancellationToken cancellationToken)
         {
-            var car = await this.carRepository.Get(carId, cancellationToken);
-            if (car == null)
+            var car = await this.carRepository.GetAsync(carId, cancellationToken);
+            if (car is null)
             {
                 return new NotFoundResult();
             }
 
-            await this.carRepository.Delete(car, cancellationToken);
+            await this.carRepository.DeleteAsync(car, cancellationToken);
 
             return new NoContentResult();
         }

Source/ApiTemplate/Source/ApiTemplate/Commands/GetCarCommand.cs

@@ -9,7 +9,6 @@ namespace ApiTemplate.Commands
     using Microsoft.AspNetCore.Http;
     using Microsoft.AspNetCore.Mvc;
     using Microsoft.AspNetCore.Mvc.Infrastructure;
-    using Microsoft.Extensions.Primitives;
     using Microsoft.Net.Http.Headers;
 
     public class GetCarCommand : IGetCarCommand
@@ -30,8 +29,8 @@ public GetCarCommand(
 
         public async Task<IActionResult> ExecuteAsync(int carId, CancellationToken cancellationToken)
         {
-            var car = await this.carRepository.Get(carId, cancellationToken);
-            if (car == null)
+            var car = await this.carRepository.GetAsync(carId, cancellationToken);
+            if (car is null)
             {
                 return new NotFoundResult();
             }

Source/ApiTemplate/Source/ApiTemplate/Commands/GetCarPageCommand.cs

@@ -40,18 +40,18 @@ public async Task<IActionResult> ExecuteAsync(PageOptions pageOptions, Cancellat
             var createdAfter = Cursor.FromCursor<DateTimeOffset?>(pageOptions.After);
             var createdBefore = Cursor.FromCursor<DateTimeOffset?>(pageOptions.Before);
 
-            var getCarsTask = this.GetCars(pageOptions.First, pageOptions.Last, createdAfter, createdBefore, cancellationToken);
-            var getHasNextPageTask = this.GetHasNextPage(pageOptions.First, createdAfter, createdBefore, cancellationToken);
-            var getHasPreviousPageTask = this.GetHasPreviousPage(pageOptions.Last, createdAfter, createdBefore, cancellationToken);
-            var totalCountTask = this.carRepository.GetTotalCount(cancellationToken);
+            var getCarsTask = this.GetCarsAsync(pageOptions.First, pageOptions.Last, createdAfter, createdBefore, cancellationToken);
+            var getHasNextPageTask = this.GetHasNextPageAsync(pageOptions.First, createdAfter, createdBefore, cancellationToken);
+            var getHasPreviousPageTask = this.GetHasPreviousPageAsync(pageOptions.Last, createdAfter, createdBefore, cancellationToken);
+            var totalCountTask = this.carRepository.GetTotalCountAsync(cancellationToken);
 
             await Task.WhenAll(getCarsTask, getHasNextPageTask, getHasPreviousPageTask, totalCountTask);
-            var cars = getCarsTask.Result;
-            var hasNextPage = getHasNextPageTask.Result;
-            var hasPreviousPage = getHasPreviousPageTask.Result;
-            var totalCount = totalCountTask.Result;
+            var cars = await getCarsTask;
+            var hasNextPage = await getHasNextPageTask;
+            var hasPreviousPage = await getHasPreviousPageTask;
+            var totalCount = await totalCountTask;
 
-            if (cars == null)
+            if (cars is null)
             {
                 return new NotFoundResult();
             }
@@ -110,7 +110,7 @@ public async Task<IActionResult> ExecuteAsync(PageOptions pageOptions, Cancellat
             return new OkObjectResult(connection);
         }
 
-        private Task<List<Models.Car>> GetCars(
+        private Task<List<Models.Car>> GetCarsAsync(
             int? first,
             int? last,
             DateTimeOffset? createdAfter,
@@ -120,25 +120,25 @@ public async Task<IActionResult> ExecuteAsync(PageOptions pageOptions, Cancellat
             Task<List<Models.Car>> getCarsTask;
             if (first.HasValue)
             {
-                getCarsTask = this.carRepository.GetCars(first, createdAfter, createdBefore, cancellationToken);
+                getCarsTask = this.carRepository.GetCarsAsync(first, createdAfter, createdBefore, cancellationToken);
             }
             else
             {
-                getCarsTask = this.carRepository.GetCarsReverse(last, createdAfter, createdBefore, cancellationToken);
+                getCarsTask = this.carRepository.GetCarsReverseAsync(last, createdAfter, createdBefore, cancellationToken);
             }
 
             return getCarsTask;
         }
 
-        private async Task<bool> GetHasNextPage(
+        private async Task<bool> GetHasNextPageAsync(
             int? first,
             DateTimeOffset? createdAfter,
             DateTimeOffset? createdBefore,
             CancellationToken cancellationToken)
         {
             if (first.HasValue)
             {
-                return await this.carRepository.GetHasNextPage(first, createdAfter, cancellationToken);
+                return await this.carRepository.GetHasNextPageAsync(first, createdAfter, cancellationToken);
             }
             else if (createdBefore.HasValue)
             {
@@ -148,15 +148,15 @@ private async Task<bool> GetHasNextPage(
             return false;
         }
 
-        private async Task<bool> GetHasPreviousPage(
+        private async Task<bool> GetHasPreviousPageAsync(
             int? last,
             DateTimeOffset? createdAfter,
             DateTimeOffset? createdBefore,
             CancellationToken cancellationToken)
         {
             if (last.HasValue)
             {
-                return await this.carRepository.GetHasPreviousPage(last, createdBefore, cancellationToken);
+                return await this.carRepository.GetHasPreviousPageAsync(last, createdBefore, cancellationToken);
             }
             else if (createdAfter.HasValue)
             {

Source/ApiTemplate/Source/ApiTemplate/Commands/PatchCarCommand.cs

@@ -40,8 +40,8 @@ public async Task<IActionResult> ExecuteAsync(
             JsonPatchDocument<SaveCar> patch,
             CancellationToken cancellationToken)
         {
-            var car = await this.carRepository.Get(carId, cancellationToken);
-            if (car == null)
+            var car = await this.carRepository.GetAsync(carId, cancellationToken);
+            if (car is null)
             {
                 return new NotFoundResult();
             }
@@ -60,10 +60,10 @@ public async Task<IActionResult> ExecuteAsync(
             }
 
             this.saveCarToCarMapper.Map(saveCar, car);
-            await this.carRepository.Update(car, cancellationToken);
+            await this.carRepository.UpdateAsync(car, cancellationToken);
             var carViewModel = this.carToCarMapper.Map(car);
 
             return new OkObjectResult(carViewModel);
         }
     }
-}
+}

Source/ApiTemplate/Source/ApiTemplate/Commands/PostCarCommand.cs

@@ -27,7 +27,7 @@ public PostCarCommand(
         public async Task<IActionResult> ExecuteAsync(SaveCar saveCar, CancellationToken cancellationToken)
         {
             var car = this.saveCarToCarMapper.Map(saveCar);
-            car = await this.carRepository.Add(car, cancellationToken);
+            car = await this.carRepository.AddAsync(car, cancellationToken);
             var carViewModel = this.carToCarMapper.Map(car);
 
             return new CreatedAtRouteResult(

Source/ApiTemplate/Source/ApiTemplate/Commands/PutCarCommand.cs

@@ -25,14 +25,14 @@ public PutCarCommand(
 
         public async Task<IActionResult> ExecuteAsync(int carId, SaveCar saveCar, CancellationToken cancellationToken)
         {
-            var car = await this.carRepository.Get(carId, cancellationToken);
-            if (car == null)
+            var car = await this.carRepository.GetAsync(carId, cancellationToken);
+            if (car is null)
             {
                 return new NotFoundResult();
             }
 
             this.saveCarToCarMapper.Map(saveCar, car);
-            car = await this.carRepository.Update(car, cancellationToken);
+            car = await this.carRepository.UpdateAsync(car, cancellationToken);
             var carViewModel = this.carToCarMapper.Map(car);
 
             return new OkObjectResult(carViewModel);

Source/ApiTemplate/Source/ApiTemplate/Constants/CarsControllerRoute.cs

@@ -2,13 +2,15 @@ namespace ApiTemplate.Constants
 {
     public static class CarsControllerRoute
     {
-        public const string DeleteCar = ControllerName.Car + nameof(DeleteCar);
-        public const string GetCar = ControllerName.Car + nameof(GetCar);
-        public const string GetCarPage = ControllerName.Car + nameof(GetCarPage);
-        public const string HeadCar = ControllerName.Car + nameof(HeadCar);
-        public const string HeadCarPage = ControllerName.Car + nameof(HeadCarPage);
-        public const string PatchCar = ControllerName.Car + nameof(PatchCar);
-        public const string PostCar = ControllerName.Car + nameof(PostCar);
-        public const string PutCar = ControllerName.Car + nameof(PutCar);
+        public const string DeleteCar = ControllerName.Cars + nameof(DeleteCar);
+        public const string GetCar = ControllerName.Cars + nameof(GetCar);
+        public const string GetCarPage = ControllerName.Cars + nameof(GetCarPage);
+        public const string HeadCar = ControllerName.Cars + nameof(HeadCar);
+        public const string HeadCarPage = ControllerName.Cars + nameof(HeadCarPage);
+        public const string OptionsCar = ControllerName.Cars + nameof(OptionsCar);
+        public const string OptionsCars = ControllerName.Cars + nameof(OptionsCars);
+        public const string PatchCar = ControllerName.Cars + nameof(PatchCar);
+        public const string PostCar = ControllerName.Cars + nameof(PostCar);
+        public const string PutCar = ControllerName.Cars + nameof(PutCar);
     }
 }

Source/ApiTemplate/Source/ApiTemplate/Constants/ControllerName.cs

@@ -2,6 +2,6 @@ namespace ApiTemplate.Constants
 {
     public static class ControllerName
     {
-        public const string Car = nameof(Car);
+        public const string Cars = nameof(Cars);
     }
-}
+}