Show information about parent namespaces on the ID prefix reservation admin panel (#9208)

Progress on NuGet/Engineering#4523

Author: joelverhagen

src/NuGetGallery/Areas/Admin/Controllers/ReservedNamespaceController.cs

@@ -39,12 +39,28 @@ public JsonResult SearchPrefix(string query)
             var prefixQueries = GetPrefixesFromQuery(query);
 
             var foundPrefixes = _reservedNamespaceService.FindReservedNamespacesForPrefixList(prefixQueries);
+            var valueToNamespace = foundPrefixes.ToDictionary(x => x.Value, StringComparer.OrdinalIgnoreCase);
 
-            var notFoundPrefixQueries = prefixQueries.Except(foundPrefixes.Select(p => p.Value), StringComparer.OrdinalIgnoreCase);
-            var notFoundPrefixes = notFoundPrefixQueries.Select(q => new ReservedNamespace(value: q, isSharedNamespace: false, isPrefix: true));
-
-            var resultModel = foundPrefixes.Select(fp => new ReservedNamespaceResultModel(fp, isExisting: true));
-            resultModel = resultModel.Concat(notFoundPrefixes.Select(nfp => new ReservedNamespaceResultModel(nfp, isExisting: false)).ToList());
+            var resultModel = new List<ReservedNamespaceResultModel>();
+            foreach (var value in prefixQueries)
+            {
+                bool isExisting = valueToNamespace.TryGetValue(value, out var ns);
+                if (!isExisting)
+                {
+                    ns = new ReservedNamespace(value: value, isSharedNamespace: false, isPrefix: true);
+                }
+
+                var existingPrefixes = _reservedNamespaceService.GetReservedNamespacesForId(value);
+
+                var parents = existingPrefixes
+                    .Where(x => value.StartsWith(x.Value, StringComparison.OrdinalIgnoreCase)
+                             && value.Length > x.Value.Length)
+                    .Select(x => x.Value + (x.IsPrefix ? "*" : string.Empty))
+                    .OrderBy(x => x.Length)
+                    .ToArray();
+
+                resultModel.Add(new ReservedNamespaceResultModel(ns, isExisting, parents));
+            }
 
             var results = new ReservedNamespaceSearchResult
             {

src/NuGetGallery/Areas/Admin/ViewModels/ReservedNamespaceResultModel.cs

@@ -18,9 +18,11 @@ public sealed class ReservedNamespaceResultModel
 
         public string[] owners { get; }
 
+        public string[] parents { get; }
+
         public ReservedNamespaceResultModel() { }
 
-        public ReservedNamespaceResultModel(ReservedNamespace reservedNamespace, bool isExisting)
+        public ReservedNamespaceResultModel(ReservedNamespace reservedNamespace, bool isExisting, string[] parents)
         {
             if (reservedNamespace == null)
             {
@@ -31,6 +33,7 @@ public ReservedNamespaceResultModel(ReservedNamespace reservedNamespace, bool is
             registrations = reservedNamespace.PackageRegistrations?.Select(pr => pr.Id).ToArray();
             owners = reservedNamespace.Owners?.Select(u => u.Username).ToArray();
             this.isExisting = isExisting;
+            this.parents = parents;
         }
     }
 }

src/NuGetGallery/Areas/Admin/Views/ReservedNamespace/Index.cshtml

@@ -48,13 +48,23 @@
                                             <span style="font-weight: bold">Matching Pattern: </span>
                                             <span data-bind="text: $data.pattern" />
                                         </div>
+                                        <!-- ko if: $data.parents.length > 0 -->
+                                        <div>
+                                            <span style="font-weight: bold">⚠ Parent namespaces:</span>
+                                            <ul>
+                                                <!-- ko foreach: $data.parents -->
+                                                <li data-bind="text: $data"></li>
+                                                <!-- /ko -->
+                                            </ul>
+                                        </div>
+                                        <!-- /ko -->
                                         <!-- ko if: $data.isExisting -->
                                         <input style="margin-top: 5px" type="submit" value="Deallocate Namespace" title="Delete this namespace"
-                                               data-bind="click: $parent.managePrefix.bind(this, $data.prefix, false)" />
+                                               data-bind="click: $parent.managePrefix.bind(this, $data.prefix, false, $data.parents)" />
                                         <!-- /ko -->
                                         <!-- ko ifnot: $data.isExisting -->
                                         <input style="margin-top: 5px" type="submit" value="Reserve Namespace" title="Add this namespace"
-                                               data-bind="click: $parent.managePrefix.bind(this, $data.prefix, true)" />
+                                               data-bind="click: $parent.managePrefix.bind(this, $data.prefix, true, $data.parents)" />
                                         <!-- /ko -->
                                     </div>
                                 </td>
@@ -243,12 +253,19 @@
                     });
                 };
 
-                this.managePrefix = function (data, addPrefix) {
+                this.managePrefix = function (prefixToModify, addPrefix, parents, model, e) {
                     if (!addPrefix && !confirm('Are you sure you want to delete this namespace?')) {
                         e.preventDefault();
+                        return;
+                    }
+
+                    if (addPrefix
+                        && parents.length > 0
+                        && !confirm("At least one parent namespace exists. Ensure the owners of the parent namespaces have approved of the new child namespace. Press 'OK' to continue. Existing parent(s):\n" + parents.join("\n"))) {
+                        e.preventDefault();
+                        return;
                     }
 
-                    var prefixToModify = data;
                     var url = addPrefix
                         ? '@Url.Action("AddNamespace", "ReservedNamespace", new { area = "Admin" })'
                         : '@Url.Action("RemoveNamespace", "ReservedNamespace", new { area = "Admin" })';

tests/NuGetGallery.Facts/Areas/Admin/Controllers/ReservedNamespaceControllerFacts.cs

@@ -51,6 +51,34 @@ public void SearchFindsMatchingPrefixes(string query, int foundCount, int notFou
             Assert.Equal(notFoundCount, notFound.Count());
         }
 
+
+        [Theory]
+        [InlineData("Zzz.", "")]
+        [InlineData("Microsoft.", "")]
+        [InlineData("Microsoft.Zzz.", "Microsoft.*")]
+        [InlineData("microsoft.zzz.", "Microsoft.*")]
+        [InlineData("Microsoft.AspNet.", "Microsoft.*")]
+        [InlineData("Microsoft.AspNet.Zzz", "Microsoft.*, Microsoft.Aspnet.*")]
+        [InlineData("jquery.", "")]
+        [InlineData("jquery.Extentions.Zzz", "jquery.Extentions.*")]
+        public void IncludesParentNamespaces(string query, string parents)
+        {
+            // Arrange.
+            var namespaces = ReservedNamespaceServiceTestData.GetTestNamespaces();
+            var reservedNamespaceService = new TestableReservedNamespaceService(reservedNamespaces: namespaces);
+            var packageRegistrations = new Mock<IEntityRepository<PackageRegistration>>();
+            var controller = new ReservedNamespaceController(reservedNamespaceService, packageRegistrations.Object);
+
+            // Act.
+            JsonResult jsonResult = controller.SearchPrefix(query);
+
+            // Assert
+            dynamic data = jsonResult.Data;
+            var resultModelList = data.Prefixes as IEnumerable<ReservedNamespaceResultModel>;
+            var match = Assert.Single(resultModelList);
+            Assert.Equal(parents, string.Join(", ", match.parents));
+        }
+
         [Fact]
         public async Task AddNamespaceDoesNotReturnSuccessForInvalidNamespaces()
         {