Fix smidge bundles not always invalidated between backoffice versions. (#11700)

* Introduced new smidge CacheBuster with sensible defaults.

* Bring back reset functionality in SmidgeRuntimeMinifier

* Clearer obsolete messaging.

Author: Paul Johnson

.gitignore

@@ -84,6 +84,7 @@ src/Umbraco.Web.UI/wwwroot/[Uu]mbraco/js/*
 src/Umbraco.Web.UI/wwwroot/[Uu]mbraco/lib/*
 src/Umbraco.Web.UI/wwwroot/[Uu]mbraco/views/*
 src/Umbraco.Web.UI/wwwroot/Media/*
+src/Umbraco.Web.UI/Smidge/
 
 # Tests
 cypress.env.json

src/Umbraco.Core/Configuration/EntryAssemblyMetadata.cs

@@ -0,0 +1,24 @@
+using System.Reflection;
+
+namespace Umbraco.Cms.Core.Configuration
+{
+    internal class EntryAssemblyMetadata : IEntryAssemblyMetadata
+    {
+        public EntryAssemblyMetadata()
+        {
+            var entryAssembly = Assembly.GetEntryAssembly();
+
+            Name = entryAssembly
+                ?.GetName()
+                ?.Name ?? string.Empty;
+
+            InformationalVersion = entryAssembly
+                ?.GetCustomAttribute<AssemblyInformationalVersionAttribute>()
+                ?.InformationalVersion ?? string.Empty;
+        }
+
+        public string Name { get; }
+
+        public string InformationalVersion { get; }
+    }
+}

src/Umbraco.Core/Configuration/IEntryAssemblyMetadata.cs

@@ -0,0 +1,18 @@
+namespace Umbraco.Cms.Core.Configuration
+{
+    /// <summary>
+    /// Provides metadata about the entry assembly.
+    /// </summary>
+    public interface IEntryAssemblyMetadata
+    {
+        /// <summary>
+        /// Gets the Name of entry assembly.
+        /// </summary>
+        public string Name { get; }
+
+        /// <summary>
+        /// Gets the InformationalVersion string for entry assembly.
+        /// </summary>
+        public string InformationalVersion { get; }
+    }
+}

src/Umbraco.Core/DependencyInjection/UmbracoBuilder.cs

@@ -163,6 +163,7 @@ private void AddCoreServices()
             Services.AddUnique(factory => factory.GetRequiredService<AppCaches>().RequestCache);
             Services.AddUnique<IProfilingLogger, ProfilingLogger>();
             Services.AddUnique<IUmbracoVersion, UmbracoVersion>();
+            Services.AddUnique<IEntryAssemblyMetadata, EntryAssemblyMetadata>();
 
             this.AddAllCoreCollectionBuilders();
             this.AddNotificationHandler<UmbracoApplicationStartingNotification, EssentialDirectoryCreator>();

src/Umbraco.Core/WebAssets/IRuntimeMinifier.cs

@@ -88,7 +88,18 @@ public interface IRuntimeMinifier
         /// <summary>
         /// Ensures that all runtime minifications are refreshed on next request. E.g. Clearing cache.
         /// </summary>
+        /// <remarks>
+        /// <para>
+        /// No longer necessary, invalidation occurs automatically if any of the following occur.
+        /// </para>
+        /// <list type="bullet">
+        /// <item>Your sites assembly information version changes.</item>
+        /// <item>Umbraco.Cms.Core assembly information version changes.</item>
+        /// <item>RuntimeMinificationSettings Version string changes.</item>
+        /// </list>
+        /// <see href="https://our.umbraco.com/documentation/Reference/V9-Config/RuntimeMinificationSettings/" /> for further details.
+        /// </remarks>
+        [Obsolete("Invalidation is handled automatically. Scheduled for removal V11.")]
         void Reset();
-
     }
 }

src/Umbraco.Web.BackOffice/Install/InstallController.cs

@@ -72,9 +72,6 @@ public async Task<ActionResult> Index()
             // TODO: Update for package migrations
             if (_runtime.Level == RuntimeLevel.Upgrade)
             {
-                // Update ClientDependency version and delete its temp directories to make sure we get fresh caches
-                _runtimeMinifier.Reset();
-
                 var authResult = await this.AuthenticateBackOfficeAsync();
 
                 if (!authResult.Succeeded)

src/Umbraco.Web.Common/DependencyInjection/UmbracoBuilderExtensions.cs

@@ -18,6 +18,7 @@
 using Microsoft.Extensions.Logging;
 using Serilog;
 using Smidge;
+using Smidge.Cache;
 using Smidge.FileProcessors;
 using Smidge.InMemory;
 using Smidge.Nuglify;
@@ -274,6 +275,7 @@ public static IUmbracoBuilder AddRuntimeMinifier(this IUmbracoBuilder builder)
                         new[] { "/App_Plugins/**/*.js", "/App_Plugins/**/*.css" }));
             });
 
+            builder.Services.AddUnique<ICacheBuster, UmbracoSmidgeConfigCacheBuster>();
             builder.Services.AddSmidge(builder.Config.GetSection(Constants.Configuration.ConfigRuntimeMinification));
             // Replace the Smidge request helper, in order to discourage the use of brotli since it's super slow
             builder.Services.AddUnique<IRequestHelper, SmidgeRequestHelper>();

src/Umbraco.Web.Common/RuntimeMinification/SmidgeRuntimeMinifier.cs

@@ -24,7 +24,6 @@ public class SmidgeRuntimeMinifier : IRuntimeMinifier
         private readonly IHostingEnvironment _hostingEnvironment;
         private readonly IConfigManipulator _configManipulator;
         private readonly CacheBusterResolver _cacheBusterResolver;
-        private readonly RuntimeMinificationSettings _runtimeMinificationSettings;
         private readonly IBundleManager _bundles;
         private readonly SmidgeHelperAccessor _smidge;
 
@@ -53,7 +52,6 @@ public SmidgeRuntimeMinifier(
             _hostingEnvironment = hostingEnvironment;
             _configManipulator = configManipulator;
             _cacheBusterResolver = cacheBusterResolver;
-            _runtimeMinificationSettings = runtimeMinificationSettings.Value;
             _jsMinPipeline = new Lazy<PreProcessPipeline>(() => _bundles.PipelineFactory.Create(typeof(JsMinifier)));
             _cssMinPipeline = new Lazy<PreProcessPipeline>(() => _bundles.PipelineFactory.Create(typeof(NuglifyCss)));
 
@@ -76,10 +74,10 @@ public SmidgeRuntimeMinifier(
                 return defaultCss;
             });
 
-            Type cacheBusterType = _runtimeMinificationSettings.CacheBuster switch
+            Type cacheBusterType = runtimeMinificationSettings.Value.CacheBuster switch
             {
                 RuntimeMinificationCacheBuster.AppDomain => typeof(AppDomainLifetimeCacheBuster),
-                RuntimeMinificationCacheBuster.Version => typeof(ConfigCacheBuster),
+                RuntimeMinificationCacheBuster.Version => typeof(UmbracoSmidgeConfigCacheBuster),
                 RuntimeMinificationCacheBuster.Timestamp => typeof(TimestampCacheBuster),
                 _ => throw new NotImplementedException()
             };
@@ -169,18 +167,12 @@ public async Task<string> MinifyAsync(string fileContent, AssetType assetType)
             }
         }
 
-
         /// <inheritdoc />
-        /// <remarks>
-        /// Smidge uses the version number as cache buster (configurable).
-        /// We therefore can reset, by updating the version number in config
-        /// </remarks>
+        [Obsolete("Invalidation is handled automatically. Scheduled for removal V11.")]
         public void Reset()
         {
             var version = DateTime.UtcNow.Ticks.ToString();
             _configManipulator.SaveConfigValue(Cms.Core.Constants.Configuration.ConfigRuntimeMinificationVersion, version.ToString());
         }
-
-
     }
 }

src/Umbraco.Web.Common/RuntimeMinification/UmbracoSmidgeConfigCacheBuster.cs

@@ -0,0 +1,77 @@
+using System;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using Smidge;
+using Smidge.Cache;
+using Umbraco.Cms.Core.Configuration;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Extensions;
+
+namespace Umbraco.Cms.Web.Common.RuntimeMinification
+{
+    /// <summary>
+    /// Constructs a cache buster string with sensible defaults.
+    /// </summary>
+    /// <remarks>
+    /// <para>
+    /// Had planned on handling all of this in SmidgeRuntimeMinifier, but that only handles some urls.
+    /// </para>
+    /// <para>
+    /// A lot of the work is delegated e.g. to <see cref="SmidgeHelper.GenerateJsUrlsAsync(string, bool)"/>
+    /// which doesn't care about the cache buster string in our classes only the value returned by the resolved ICacheBuster.
+    /// </para>
+    /// <para>
+    /// Then I thought fine I'll just use a IConfigureOptions to tweak upstream <see cref="ConfigCacheBuster"/>, but that only cares about the <see cref="SmidgeConfig"/>
+    /// class we instantiate and pass through in <see cref="Umbraco.Extensions.UmbracoBuilderExtensions.AddRuntimeMinifier"/>
+    /// </para>
+    /// <para>
+    /// So here we are, create our own to ensure we cache bust in a reasonable fashion.
+    /// </para>
+    /// <br/><br/>
+    /// <para>
+    /// Note that this class makes some other bits of code pretty redundant e.g. <see cref="UrlHelperExtensions.GetUrlWithCacheBust"/> will
+    /// concatenate version with CacheBuster value and hash again, but there's no real harm so can think about that later.
+    /// </para>
+    /// </remarks>
+    internal class UmbracoSmidgeConfigCacheBuster : ICacheBuster
+    {
+        private readonly IOptions<RuntimeMinificationSettings> _runtimeMinificationSettings;
+        private readonly IUmbracoVersion _umbracoVersion;
+        private readonly IEntryAssemblyMetadata _entryAssemblyMetadata;
+
+        private string _cacheBusterValue;
+
+        public UmbracoSmidgeConfigCacheBuster(
+            IOptions<RuntimeMinificationSettings> runtimeMinificationSettings,
+            IUmbracoVersion umbracoVersion,
+            IEntryAssemblyMetadata entryAssemblyMetadata)
+        {
+            _runtimeMinificationSettings = runtimeMinificationSettings ?? throw new ArgumentNullException(nameof(runtimeMinificationSettings));
+            _umbracoVersion = umbracoVersion ?? throw new ArgumentNullException(nameof(umbracoVersion));
+            _entryAssemblyMetadata = entryAssemblyMetadata ?? throw new ArgumentNullException(nameof(entryAssemblyMetadata));
+        }
+
+        private string CacheBusterValue
+        {
+            get
+            {
+                if (_cacheBusterValue != null)
+                {
+                    return _cacheBusterValue;
+                }
+
+                // Assembly Name adds a bit of uniqueness across sites when version missing from config.
+                // Adds a bit of security through obscurity that was asked for in standup.
+                var prefix = _runtimeMinificationSettings.Value.Version ?? _entryAssemblyMetadata.Name ?? string.Empty;
+                var umbracoVersion = _umbracoVersion.SemanticVersion.ToString();
+                var downstreamVersion = _entryAssemblyMetadata.InformationalVersion;
+
+                _cacheBusterValue = $"{prefix}_{umbracoVersion}_{downstreamVersion}".GenerateHash();
+
+                return _cacheBusterValue;
+            }
+        }
+
+        public string GetValue() => CacheBusterValue;
+    }
+}

tests/.editorconfig

@@ -0,0 +1,5 @@
+root = false
+
+[*.cs]
+csharp_style_var_when_type_is_apparent = true:none
+csharp_style_var_elsewhere = true:none