v9: Throw error on duplicate routes (#11774)

* Add conflicting route service and check

* Added testclass

* Cleanup

* Update src/Umbraco.Web.BackOffice/Services/ConflictingRouteService.cs

Co-authored-by: Elitsa Marinovska <[email protected]>

* Implemented out variable

Co-authored-by: Elitsa Marinovska <[email protected]>
Co-authored-by: Elitsa Marinovska <[email protected]>

Author: Zeegaan

src/Umbraco.Core/Services/IConflictingRouteService.cs

@@ -0,0 +1,7 @@
+namespace Umbraco.Cms.Core.Services
+{
+    public interface IConflictingRouteService
+    {
+        public bool HasConflictingRoutes(out string controllerName);
+    }
+}

src/Umbraco.Infrastructure/Runtime/RuntimeState.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Threading;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core;
@@ -12,6 +13,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Infrastructure.Migrations.Upgrade;
 using Umbraco.Cms.Infrastructure.Persistence;
+using Umbraco.Cms.Web.Common.DependencyInjection;
 using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Infrastructure.Runtime
@@ -30,6 +32,7 @@ public class RuntimeState : IRuntimeState
         private readonly ILogger<RuntimeState> _logger;
         private readonly PendingPackageMigrations _packageMigrationState;
         private readonly Dictionary<string, object> _startupState = new Dictionary<string, object>();
+        private readonly IConflictingRouteService _conflictingRouteService;
 
         /// <summary>
         /// The initial <see cref="RuntimeState"/>
@@ -51,16 +54,35 @@ public RuntimeState(
             IUmbracoDatabaseFactory databaseFactory,
             ILogger<RuntimeState> logger,
             PendingPackageMigrations packageMigrationState)
+            : this(
+                globalSettings,
+                unattendedSettings,
+                umbracoVersion,
+                databaseFactory,
+                logger,
+                packageMigrationState,
+                StaticServiceProvider.Instance.GetRequiredService<IConflictingRouteService>())
+        {
+        }
+
+        public RuntimeState(
+            IOptions<GlobalSettings> globalSettings,
+            IOptions<UnattendedSettings> unattendedSettings,
+            IUmbracoVersion umbracoVersion,
+            IUmbracoDatabaseFactory databaseFactory,
+            ILogger<RuntimeState> logger,
+            PendingPackageMigrations packageMigrationState,
+            IConflictingRouteService conflictingRouteService)
         {
             _globalSettings = globalSettings;
             _unattendedSettings = unattendedSettings;
             _umbracoVersion = umbracoVersion;
             _databaseFactory = databaseFactory;
             _logger = logger;
             _packageMigrationState = packageMigrationState;
+            _conflictingRouteService = conflictingRouteService;
         }
 
-
         /// <inheritdoc />
         public Version Version => _umbracoVersion.Version;
 
@@ -101,6 +123,16 @@ public void DetermineRuntimeLevel()
                 return;
             }
 
+            // Check if we have multiple controllers with the same name.
+            if (_conflictingRouteService.HasConflictingRoutes(out string controllerName))
+            {
+                Level = RuntimeLevel.BootFailed;
+                Reason = RuntimeLevelReason.BootFailedOnException;
+                BootFailedException = new BootFailedException($"Conflicting routes, you cannot have multiple controllers with the same name: {controllerName}");
+
+                return;
+            }
+
             // Check the database state, whether we can connect or if it's in an upgrade or empty state, etc...
 
             switch (GetUmbracoDatabaseState(_databaseFactory))

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

@@ -114,6 +114,7 @@ public static IUmbracoBuilder AddBackOfficeCore(this IUmbracoBuilder builder)
             });
 
             builder.Services.AddUnique<IIconService, IconService>();
+            builder.Services.AddUnique<IConflictingRouteService, ConflictingRouteService>();
             builder.Services.AddUnique<UnhandledExceptionLoggerMiddleware>();
 
             return builder;

src/Umbraco.Web.BackOffice/Services/ConflictingRouteService.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Linq;
+using Umbraco.Cms.Core.Composing;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Web.Common.Controllers;
+
+namespace Umbraco.Cms.Web.BackOffice.Services
+{
+    public class ConflictingRouteService : IConflictingRouteService
+    {
+        private readonly TypeLoader _typeLoader;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ConflictingRouteService"/> class.
+        /// </summary>
+        public ConflictingRouteService(TypeLoader typeLoader) => _typeLoader = typeLoader;
+
+        /// <inheritdoc/>
+        public bool HasConflictingRoutes(out string controllerName)
+        {
+            var controllers = _typeLoader.GetTypes<UmbracoApiControllerBase>().ToList();
+            foreach (Type controller in controllers)
+            {
+                if (controllers.Count(x => x.Name == controller.Name) > 1)
+                {
+                    controllerName = controller.Name;
+                    return true;
+                }
+            }
+
+            controllerName = string.Empty;
+            return false;
+        }
+    }
+}

tests/Umbraco.Tests.Integration/Testing/TestConflictingRouteService.cs

@@ -0,0 +1,14 @@
+using System;
+using Umbraco.Cms.Core.Services;
+
+namespace Umbraco.Cms.Tests.Integration.Testing
+{
+    public class TestConflictingRouteService : IConflictingRouteService
+    {
+        public bool HasConflictingRoutes(out string controllername)
+        {
+            controllername = string.Empty;
+            return false;
+        }
+    }
+}

tests/Umbraco.Tests.Integration/Testing/UmbracoIntegrationTest.cs

@@ -201,6 +201,9 @@ public virtual void ConfigureServices(IServiceCollection services)
             IWebHostEnvironment webHostEnvironment = TestHelper.GetWebHostEnvironment();
             services.AddRequiredNetCoreServices(TestHelper, webHostEnvironment);
 
+            // We register this service because we need it for IRuntimeState, if we don't this breaks 900 tests
+            services.AddSingleton<IConflictingRouteService, TestConflictingRouteService>();
+
             // Add it!
             Core.Hosting.IHostingEnvironment hostingEnvironment = TestHelper.GetHostingEnvironment();
             TypeLoader typeLoader = services.AddTypeLoader(