ASP.NET Core One Hour Makeover

_aspnet-core-one-hour-makeover-devsum-2019.md

https://aka.ms/aspnetcore-makeover

Slides

Outline

• Intro (goals/non-goals/what you'll learn)
• Pick The Right Starting Template
  • Web Application (no auth)
  • Web API
  • SPA
  • Other templates (teaser)
• Source Control and Solution Structure
  • editorconfig
  • gitignore
• Maintainability
  • Tests
  • Health Checks
  • Debug Footer
• Front End
  • Bootstrap
  • Front end build?
  • Libman
  • SEO
• Performance (no way we'll get to this in 50 minutes...)
  • ANCM
  • Tiered Compilation
  • Language feature opt-in
  • Caching
  • Miniprofiler
• Creating your own templates

Code Snippets

FunctionalTests.cs

using Microsoft.AspNetCore.Mvc.Testing;
using OneHour.Web;
using System;
using System.Threading.Tasks;
using Xunit;

namespace WebApp.Tests
{
	public class BasicTests
		: IClassFixture<WebApplicationFactory<Startup>>
	{
		private readonly WebApplicationFactory<Startup> _factory;

		public BasicTests(WebApplicationFactory<Startup> factory)
		{
			_factory = factory;
		}

		[Theory]
		[InlineData("/")]
		[InlineData("/Index")]
		[InlineData("/Privacy")]
		public async Task Get_EndpointsReturnSuccessAndCorrectContentType(string url)
		{
			// Arrange
			var client = _factory.CreateClient();

			// Act
			var response = await client.GetAsync(url);

			// Assert
			response.EnsureSuccessStatusCode(); // Status Code 200-299
			Assert.Equal("text/html; charset=utf-8",
				response.Content.Headers.ContentType.ToString());
		}

		[Fact]
		public async Task Get_HealthCheckReturnsHealthy()
		{
			// Arrange
			var client = _factory.CreateClient();

			// Act
			var response = await client.GetAsync("/health");

			// Assert
			response.EnsureSuccessStatusCode(); // Status Code 200-299
			Assert.Equal("Healthy",
				response.Content.ReadAsStringAsync().Result);

		}
	}
}

libman.json

{
  "version": "1.0",
  "defaultProvider": "cdnjs",
  "libraries": [
  {
   "library": "[email protected]",
   "files": [
    "jquery.min.js",
    "jquery.js",
    "jquery.min.map"
   ],
   "destination": "wwwroot/lib/jquery/dist"
  },
  {
   "provider": "unpkg",
   "library": "[email protected]",
   "destination": "wwwroot/lib/bootstrap/",
   "files": [
    "dist/css/bootstrap.css",
    "dist/css/bootstrap-grid.css",
    "dist/css/bootstrap-reboot.css",
    "dist/js/bootstrap.js"
   ]
  },
  {
   "provider": "unpkg",
   "library": "[email protected]",
   "destination": "wwwroot/lib/ionicons",
   "files": [ "dist/css/ionicons.min.css" ]
  }
  ]
}  

Sitemap Extension

using Ducksoft.NetCore.Razor.Sitemap.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;

namespace OneHour.Web.Utility
{
	public static class SitemapExtensions
	{
		public static IServiceCollection ConfigureMvcRazorPages(this IServiceCollection services,
			  CompatibilityVersion version, string startPageUrl = "", string startPageArea = "")
		{
			services.AddMvc()
				.SetCompatibilityVersion(version)
				.AddRazorPagesOptions(options =>
				{
					var isSupportAreas = !string.IsNullOrWhiteSpace(startPageArea);
					options.AllowAreas = isSupportAreas;
					options.AllowMappingHeadRequestsToGetHandler = true;
					if (isSupportAreas)
					{
						options.Conventions.AddAreaPageRoute(startPageArea, startPageUrl, string.Empty);
					}
					else if (!string.IsNullOrWhiteSpace(startPageUrl))
					{
						options.Conventions.AddPageRoute(startPageUrl, string.Empty);
					}
				})
				.AddRazorPagesOptions(options =>
				{
					options.Conventions.Add(new SitemapRouteConvention());
				})
				.AddRazorPagesOptions(options =>
				{
					options.Conventions.AddPageRoute("/Sitemap", "sitemap.xml");
				});

			return services;
		}
	}
}

.template.config/template.json

{
"$schema": "http://json.schemastore.org/template",
"author": "YOUR NAME",
"classifications": [ "ASP.NET Core", "Solution" ],
"identity": "[YOUR NAME].AspNetCoreSolutionTemplateTemplate.CSharp",
"name": "ASP.NET Core One Hour",
"shortName": "aspnetonehour",
"sourceName": "OneHour"
}

References and Other Good Stuff

An Opinionated Approach to ASP.NET Core (Scott Allen)

• An Opinionated Approach to ASP.NET Core - NDC - YouTube
• .NET Core Opinion #1 - Structuring a Repository
• .NET Core Opinion #2 - Managing a Repository Structure
• .NET Core Opinion #3 - Other Folders To Include in the Source Repository
• .NET Core Opinion #4 - Increase Productivity with Dev Scripts
• .NET Core Opinion #5 - Deployment Scripts and Templates
• .NET Core Opinion #6 - Be Wary of GUI Build Tools
• Community blogger's transcription

Grab Bag

• ASP.NET Core 2.2 Goes Bootstrap 4
• ASP.NET Core Architect David Fowler's Hidden Gems in 2.1

Existing Template Solutions

• ASP.NET Boilerplate
• .NET Boxed

Stuff I Wish I'd Had Time For

• Dev Adventures .NET Core project setup. - Visual Studio Marketplace

• dotnet templates

• madskristensen/PhotoGallery: ASP.NET Core Photo Gallery

• madskristensen/AspNetCoreTemplatePack

• Custom templates for dotnet new - .NET Core CLI

• Xabaril/AspNetCore.Diagnostics.HealthChecks: Enterprise HealthChecks for ASP.NET Core Diagnostics Package

• Web Applications with ASP.NET Core Architecture and Patterns guidance (Updated for .NET Core 2.0)

• ASP.NET Core - Best practices (tips and tricks) - an opinionated approach - Part 1

• ASP.NET Core Best Practices Archives - CodingBlast

• Top 13 ASP.NET Core Features You Need to Know

• gothinkster/aspnetcore-realworld-example-app: ASP.NET Core backend implementation for RealWorld

• Cache in-memory in ASP.NET Core

• VahidN/EFSecondLevelCache.Core: Entity Framework Core Second Level Caching Library

• SteffenMangold/EntityFrameworkCore.Cacheable: EntityFrameworkCore second level cache

• dotnet-architecture/eShopOnWeb: Sample ASP.NET Core 2.1 reference application, powered by Microsoft, demonstrating a layered application architecture with monolithic deployment model. Download 130+ page eBook PDF from docs folder.

• MiniProfiler for .NET : ASP.NET Core

• ASP.NET Core Best Practices - Opinionated Approach - CodingBlast

• url redirection - Redirect asp.net core 2.0 urls to lowercase - Stack Overflow

• AddOptions (strongly typed)

• https://github.com/AArnott/Nerdbank.GitVersioning/blob/master/doc/dotnet.md

• https://dotnetthoughts.net/how-to-display-app-version-in-aspnet-core/

• https://github.com/JosephWoodward/GlobalExceptionHandlerDotNet

• https://nugetmusthaves.com/Category/ASP.NET?page=4

• https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-2.2

• https://docs.microsoft.com/en-us/aspnet/core/performance/performance-best-practices?view=aspnetcore-2.2

_aspnet-core-one-hour-makeover-techorama-2019.md

Slides

Outline

• Intro (goals/non-goals/what you'll learn)
• Pick The Right Starting Template
  • Web Application (no auth)
  • Web API
  • SPA
  • Other templates (teaser)
• Front End
  • Bootstrap
  • Front end build?
  • Libman
  • SEO
• Maintainability
  • Tests
  • Health Checks
  • Debug Footer
• Source Control and Solution Structure
  • editorconfig
  • gitignore
• Database (? - probably no)
  • Data seeding?
  • Migrations?
• Security?
  • Set up Roles (IsAdmin)
• Performance
  • ANCM
  • Tiered Compilation
  • Language feature opt-in
  • Caching
  • Miniprofiler

Code Snippets

libman.json

{
  "version": "1.0",
  "defaultProvider": "cdnjs",
  "libraries": [
  {
   "library": "[email protected]",
   "files": [
    "jquery.min.js",
    "jquery.js",
    "jquery.min.map"
   ],
   "destination": "wwwroot/lib/jquery/dist"
  },
  {
   "provider": "unpkg",
   "library": "[email protected]",
   "destination": "wwwroot/lib/bootstrap/",
   "files": [
    "dist/css/bootstrap.css",
    "dist/css/bootstrap-grid.css",
    "dist/css/bootstrap-reboot.css",
    "dist/js/bootstrap.js"
   ]
  },
  {
   "provider": "unpkg",
   "library": "[email protected]",
   "destination": "wwwroot/lib/ionicons",
   "files": [ "dist/css/ionicons.min.css" ]
  }
  ]
}  

template.json

{
"$schema": "http://json.schemastore.org/template",
"author": "YOUR NAME",
"classifications": [ "ASP.NET Core", "Solution" ],
"identity": "[YOUR NAME].AspNetCoreSolutionTemplateTemplate.CSharp",
"name": "ASP.NET Core One Hour",
"shortName": "aspnetonehour",
"sourceName": "OneHour"
}

Sitemap Extension

using Ducksoft.NetCore.Razor.Sitemap.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;

namespace OneHour.Web.Utility
{
	public static class SitemapExtensions
	{
		public static IServiceCollection ConfigureMvcRazorPages(this IServiceCollection services,
			  CompatibilityVersion version, string startPageUrl = "", string startPageArea = "")
		{
			services.AddMvc()
				.SetCompatibilityVersion(version)
				.AddRazorPagesOptions(options =>
				{
					var isSupportAreas = !string.IsNullOrWhiteSpace(startPageArea);
					options.AllowAreas = isSupportAreas;
					options.AllowMappingHeadRequestsToGetHandler = true;
					if (isSupportAreas)
					{
						options.Conventions.AddAreaPageRoute(startPageArea, startPageUrl, string.Empty);
					}
					else if (!string.IsNullOrWhiteSpace(startPageUrl))
					{
						options.Conventions.AddPageRoute(startPageUrl, string.Empty);
					}
				})
				.AddRazorPagesOptions(options =>
				{
					options.Conventions.Add(new SitemapRouteConvention());
				})
				.AddRazorPagesOptions(options =>
				{
					options.Conventions.AddPageRoute("/Sitemap", "sitemap.xml");
				});

			return services;
		}
	}
}

FunctionalTests.cs

using Microsoft.AspNetCore.Mvc.Testing;
using OneHour.Web;
using System;
using System.Threading.Tasks;
using Xunit;

namespace WebApp.Tests
{
	public class BasicTests
		: IClassFixture<WebApplicationFactory<Startup>>
	{
		private readonly WebApplicationFactory<Startup> _factory;

		public BasicTests(WebApplicationFactory<Startup> factory)
		{
			_factory = factory;
		}

		[Theory]
		[InlineData("/")]
		[InlineData("/Index")]
		[InlineData("/Privacy")]
		public async Task Get_EndpointsReturnSuccessAndCorrectContentType(string url)
		{
			// Arrange
			var client = _factory.CreateClient();

			// Act
			var response = await client.GetAsync(url);

			// Assert
			response.EnsureSuccessStatusCode(); // Status Code 200-299
			Assert.Equal("text/html; charset=utf-8",
				response.Content.Headers.ContentType.ToString());
		}

		[Fact]
		public async Task Get_HealthCheckReturnsHealthy()
		{
			// Arrange
			var client = _factory.CreateClient();

			// Act
			var response = await client.GetAsync("/health");

			// Assert
			response.EnsureSuccessStatusCode(); // Status Code 200-299
			Assert.Equal("Healthy",
				response.Content.ReadAsStringAsync().Result);

		}
	}
}

References and Other Good Stuff

An Opinionated Approach to ASP.NET Core (Scott Allen)

• An Opinionated Approach to ASP.NET Core - NDC - YouTube
• .NET Core Opinion #1 - Structuring a Repository
• .NET Core Opinion #2 - Managing a Repository Structure
• .NET Core Opinion #3 - Other Folders To Include in the Source Repository
• .NET Core Opinion #4 - Increase Productivity with Dev Scripts
• .NET Core Opinion #5 - Deployment Scripts and Templates
• .NET Core Opinion #6 - Be Wary of GUI Build Tools
• Community blogger's transcription

Grab Bag

• ASP.NET Core 2.2 Goes Bootstrap 4
• ASP.NET Core Architect David Fowler's Hidden Gems in 2.1

Existing Template Solutions

• ASP.NET Boilerplate
• .NET Boxed

Stuff I Wish I'd Had Time For

• Dev Adventures .NET Core project setup. - Visual Studio Marketplace

• dotnet templates

• madskristensen/PhotoGallery: ASP.NET Core Photo Gallery

• madskristensen/AspNetCoreTemplatePack

• Custom templates for dotnet new - .NET Core CLI

• Xabaril/AspNetCore.Diagnostics.HealthChecks: Enterprise HealthChecks for ASP.NET Core Diagnostics Package

• Web Applications with ASP.NET Core Architecture and Patterns guidance (Updated for .NET Core 2.0)

• ASP.NET Core - Best practices (tips and tricks) - an opinionated approach - Part 1

• ASP.NET Core Best Practices Archives - CodingBlast

• Top 13 ASP.NET Core Features You Need to Know

• gothinkster/aspnetcore-realworld-example-app: ASP.NET Core backend implementation for RealWorld

• Cache in-memory in ASP.NET Core

• VahidN/EFSecondLevelCache.Core: Entity Framework Core Second Level Caching Library

• SteffenMangold/EntityFrameworkCore.Cacheable: EntityFrameworkCore second level cache

• dotnet-architecture/eShopOnWeb: Sample ASP.NET Core 2.1 reference application, powered by Microsoft, demonstrating a layered application architecture with monolithic deployment model. Download 130+ page eBook PDF from docs folder.

• MiniProfiler for .NET : ASP.NET Core

• ASP.NET Core Best Practices - Opinionated Approach - CodingBlast

• url redirection - Redirect asp.net core 2.0 urls to lowercase - Stack Overflow

• AddOptions (strongly typed)

• https://github.com/AArnott/Nerdbank.GitVersioning/blob/master/doc/dotnet.md

• https://dotnetthoughts.net/how-to-display-app-version-in-aspnet-core/

• https://github.com/JosephWoodward/GlobalExceptionHandlerDotNet

• https://nugetmusthaves.com/Category/ASP.NET?page=4

• https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-2.2

• https://docs.microsoft.com/en-us/aspnet/core/performance/performance-best-practices?view=aspnetcore-2.2

aspnet-core-one-hour-makeover-ndc-london-2019.md

Slides

Outline

• Intro (goals/non-goals/what you'll learn)
• Pick The Right Starting Template
  • Web Application (no auth)
  • Web API
  • SPA
  • Other templates (teaser)
• Front End
  • Bootstrap
  • Front end build?
  • Libman
  • SEO
• Maintainability
  • Tests
  • Health Checks
  • Debug Footer
• Source Control and Solution Structure
  • editorconfig
  • gitignore
• Database (? - probably no)
  • Data seeding?
  • Migrations?
• Security?
  • Set up Roles (IsAdmin)
• Performance
  • ANCM
  • Tiered Compilation
  • Language feature opt-in
  • Caching
  • Miniprofiler

Code Snippets

libman.json

{
  "version": "1.0",
  "defaultProvider": "cdnjs",
  "libraries": [
  {
   "library": "[email protected]",
   "files": [
    "jquery.min.js",
    "jquery.js",
    "jquery.min.map"
   ],
   "destination": "wwwroot/lib/jquery/dist"
  },
  {
   "provider": "unpkg",
   "library": "[email protected]",
   "destination": "wwwroot/lib/bootstrap/",
   "files": [
    "dist/css/bootstrap.css",
    "dist/css/bootstrap-grid.css",
    "dist/css/bootstrap-reboot.css",
    "dist/js/bootstrap.js"
   ]
  },
  {
   "provider": "unpkg",
   "library": "[email protected]",
   "destination": "wwwroot/lib/ionicons",
   "files": [ "dist/css/ionicons.min.css" ]
  }
  ]
}  

References and Other Good Stuff

An Opinionated Approach to ASP.NET Core (Scott Allen)

• An Opinionated Approach to ASP.NET Core - NDC - YouTube
• .NET Core Opinion #1 - Structuring a Repository
• .NET Core Opinion #2 - Managing a Repository Structure
• .NET Core Opinion #3 - Other Folders To Include in the Source Repository
• .NET Core Opinion #4 - Increase Productivity with Dev Scripts
• .NET Core Opinion #5 - Deployment Scripts and Templates
• .NET Core Opinion #6 - Be Wary of GUI Build Tools
• Community blogger's transcription

Grab Bag

• ASP.NET Core 2.2 Goes Bootstrap 4
• ASP.NET Core Architect David Fowler's Hidden Gems in 2.1

Existing Template Solutions

• ASP.NET Boilerplate
• .NET Boxed

Stuff I Wish I'd Had Time For

• Dev Adventures .NET Core project setup. - Visual Studio Marketplace

• dotnet templates

• madskristensen/PhotoGallery: ASP.NET Core Photo Gallery

• madskristensen/AspNetCoreTemplatePack

• Custom templates for dotnet new - .NET Core CLI

• Xabaril/AspNetCore.Diagnostics.HealthChecks: Enterprise HealthChecks for ASP.NET Core Diagnostics Package

• Web Applications with ASP.NET Core Architecture and Patterns guidance (Updated for .NET Core 2.0)

• ASP.NET Core - Best practices (tips and tricks) - an opinionated approach - Part 1

• ASP.NET Core Best Practices Archives - CodingBlast

• Top 13 ASP.NET Core Features You Need to Know

• gothinkster/aspnetcore-realworld-example-app: ASP.NET Core backend implementation for RealWorld

• Cache in-memory in ASP.NET Core

• VahidN/EFSecondLevelCache.Core: Entity Framework Core Second Level Caching Library

• SteffenMangold/EntityFrameworkCore.Cacheable: EntityFrameworkCore second level cache

• dotnet-architecture/eShopOnWeb: Sample ASP.NET Core 2.1 reference application, powered by Microsoft, demonstrating a layered application architecture with monolithic deployment model. Download 130+ page eBook PDF from docs folder.

• MiniProfiler for .NET : ASP.NET Core

• ASP.NET Core Best Practices - Opinionated Approach - CodingBlast

• url redirection - Redirect asp.net core 2.0 urls to lowercase - Stack Overflow

• AddOptions (strongly typed)

• https://github.com/AArnott/Nerdbank.GitVersioning/blob/master/doc/dotnet.md

• https://dotnetthoughts.net/how-to-display-app-version-in-aspnet-core/

• https://github.com/JosephWoodward/GlobalExceptionHandlerDotNet

• https://nugetmusthaves.com/Category/ASP.NET?page=4

• https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-2.2

• https://docs.microsoft.com/en-us/aspnet/core/performance/performance-best-practices?view=aspnetcore-2.2

aspnet-core-one-hour-makeover-ndc-sydney-2018.md

Session Video

ASP.NET Core: The One Hour Makeover - Jon Galloway (YouTube)

Checklist

• Set Up Solution
• Add global.json using dotnet sdks
• Add Directory.Build.props
• Push to GitHub
• Add a license
• Add Analyzers
• dotnet watch run
• dotnet outdated
• Configure Functional Tests
• Configure Health Checks
  • Add Microsoft.AspNetCore.Diagnostics.HealthChecks
  • services.AddHealthChecks();
  • app.UseHealthChecks("/health");
• Add MiniProfiler.AspNetCore.Mvc
• Front End Setup
  • Decide: Front end build or just want to own the libs
  • LibMan
  • Update to Bootstrap 4
  • BundlerMinifier
  • Web Optimizer

Integration Testing

• Integration Tests - Docs
• Functional Testing - Scott Hanselman
• ASP.NET Core 2.1.0-preview1: Functional testing of MVC applications
• Code Samples that work in ASP.NET Core 2.1
• Implicit version reference discussion

Health Checks

• ASP.NET Core 2.2.0-preview1 Health Checks

API

• Set up Swashbuckle and NSwag
• Configure Polly for HttpClientFactory

Hosting Optimizations

• Azure Blob Storage IFileProvider
• Linux Transport

So you want a front end build...

• JavaScriptServices
• Setting up HMR
• Updating ASP.NET Core Identity to use Bootstrap 4

Next Steps

• Configure HttpClientFactory
• Configure PWA
• Centralized exception handling and request validation in ASP.NET Core Architecture Guide eBook on Web Applications with ASP.NET Core has been updated to ASP.NET Core 2.1
• Tweak your logging

General Web Stuff

Web Developer Checklist

Other Opinionated Lists / Templates

• A to-do list for new ASP.NET Core projects