v10: Update to ImageSharp v2

[ronaldbarendse]

Prerequisites

• I have added steps to test this contribution in the description below

If there's an existing issue for this PR then this fixes #11329. Also see the related discussion #11938 and the draft PR #11991 trying to update v9 in a backwards compatible way (spoiler: we can't).

Description

This PR updates the dependency versions of ImageSharp to 2.1.0 and ImageSharp.Web to 2.0.0 (alpha, currently waiting on the final release). Because these new major versions contain breaking changes, we can only update these for the upcoming Umbraco v10 release. Some of the breaking changes are:

• CachedNameLength has been renamed to CacheHashLength;
• IDictionary<string, string> commands has been changed to CommandCollection commands;
• A new RequiresTrueColorPixelFormat() method is added to IImageWebProcessor.

ImageSharp/ImageSharp.Web also has some functional changes as well:

• The PhysicalFileSystemProvider doesn't use the WebRootFileProvider anymore (it now only supports actual physical files OOTB) (an additional WebRootImageProvider is now available OOTB, but not used by default);
• The ResizeWebProcessor is now EXIF-orientation aware (as browsers now default to displaying images based on the EXIF orientation);
• The PhysicalFileSystemCache has a separate option for the cache folder depth (it previously used the file length to create nested cache folders);
• It adds support for WebP images and includes better memory management.

---

To-do:

• Update to final ImageSharp.Web v2 release (and remove MyGet feed)
• Implement EXIF-orientation aware cropping in CropWebProcessor (waiting on PR Expose ExifOrientationUtilities and ICommandConverter implementations SixLabors/ImageSharp.Web#241 that adds an utility class to make this easier)
• Add WebP to default image file types/extensions?
  

  Umbraco-CMS/src/Umbraco.Core/Configuration/Models/ContentImagingSettings.cs

  Line 26 in 5bfab13

  internal const string StaticImageFileTypes = "jpeg,jpg,gif,bmp,png,tiff,tif";

[ronaldbarendse]

This setting doesn't seem to be used: the supported image file types are now retrieved from the IImageUrlGenerator.SupportedImageFileTypes property and the ImageSharpImageUrlGenerator implementation dynamically retrieves the supported ones from the ImageSharp configuration instead.

These image file types are then used to for more then just generating image URLs though (e.g. whether to extract image dimensions to auto-fill properties, disallow file uploads that are not images and automatically changing the media type from File to Image).

I suggest keeping this setting and create a separate PR to fix the mixed usage, so:

• ContentImagingSettings.ImageFileTypes is used to determine whether the uploaded file is a valid image and if it can automatically change the media type to Image;
• IImageUrlGenerator.SupportedImageFileTypes is used whether it can generate an image URL for a specified file;
• A new IImageDimensionExtractor.SupportedImageFileTypes property is added that exposes whether it can get dimensions for a specified file (and have the ImageSharpDimensionExtractor populate this the same way as the ImageSharpImageUrlGenerator currently does).

[ronaldbarendse]

I think v would be a much better (and shorter) query string key, as this isn't a random value we're adding, but a versioning value. Changing this doesn't impact the generation of images: it would only invalidate any images in your browser cache.

And that might actually be for the better, as you should also clear your existing ImageSharp cache as part of the migration, because newly generated images can be different because of the automatic EXIF rotation.

Suggested change

	queryString.Add("rnd", cacheBusterValue);
	queryString.Add("v", cacheBusterValue);

This should then also be updated in the corresponding tests.

[ronaldbarendse]

Breaking changes

• Update dependency versions:
  • SixLabors.ImageSharp from 1.0.4 to 2.1.1 (see breaking changes in v2.0.0 release notes);
  • SixLabors.ImageSharp.Web from 1.0.5 to 2.0.0 (see breaking changed in release notes);
• Renamed CachedNameLength property to CacheHashLength on ImagingCacheSettings;
• Moved ImageSharpImageUrlGenerator from project Umbraco.Infrastructure to Umbraco.Web.Common and updated the corresponding namespace and DI registration (from AddCoreInitialServices() to AddUmbracoImageSharp());
• Moved ImageSharp configuration from the AddUmbracoImageSharp() extension method into separate IConfigureOptions<> implementations:
  • The middleware is configured in ConfigureImageSharpMiddlewareOptions (which also replaces ImageSharpConfigurationOptions that previously only set the default ImageSharp configuration);
  • The default physical cache is configured in ConfigurePhysicalFileSystemCacheOptions.

There are also some functional changes to be aware of:

• The default physical file cache has a different/optimized folder structure (less nesting and shorter file names): make sure to delete your existing cache folder if you're upgrading (located in umbraco\Data\TEMP\MediaCache);
• The cache key is now only generated based on the relative URL (it doesn't include the hostname anymore), so the same cached image is returned if you have multiple hostnames configured in Umbraco;
• Images are automatically rotated based on their EXIF orientation (another reason to remove your existing cached images);
• WebP support is added 🎉

[bergmania]

Normally we add a NoopImpementation so you can boot Infrastructure without the web assemblies