Add grouping to Command Palette (jenkinsci#10252)

Author: krisstern

core/src/main/java/hudson/model/Computer.java

@@ -112,6 +112,7 @@
 import jenkins.model.IComputer;
 import jenkins.model.IDisplayExecutor;
 import jenkins.model.Jenkins;
+import jenkins.search.SearchGroup;
 import jenkins.security.ExtendedReadRedaction;
 import jenkins.security.ImpersonatingExecutorService;
 import jenkins.security.MasterToSlaveCallable;
@@ -1112,6 +1113,11 @@ public String getSearchUrl() {
         return getUrl();
     }
 
+    @Override
+    public SearchGroup getSearchGroup() {
+        return SearchGroup.get(SearchGroup.ComputerSearchGroup.class);
+    }
+
     /**
      * {@link RetentionStrategy} associated with this computer.
      *

core/src/main/java/hudson/model/Item.java

@@ -39,6 +39,7 @@
 import java.io.IOException;
 import java.util.Collection;
 import jenkins.model.Jenkins;
+import jenkins.search.SearchGroup;
 import jenkins.util.SystemProperties;
 import jenkins.util.io.OnMaster;
 import org.kohsuke.stapler.StaplerRequest2;
@@ -249,6 +250,11 @@ default void onCreatedFromScratch() {
      */
     void delete() throws IOException, InterruptedException;
 
+    @Override
+    default SearchGroup getSearchGroup() {
+        return SearchGroup.get(SearchGroup.ItemSearchGroup.class);
+    }
+
     PermissionGroup PERMISSIONS = new PermissionGroup(Item.class, Messages._Item_Permissions_Title());
     Permission CREATE =
             new Permission(

core/src/main/java/hudson/model/User.java

@@ -72,6 +72,7 @@
 import jenkins.model.Loadable;
 import jenkins.model.ModelObjectWithContextMenu;
 import jenkins.scm.RunWithSCM;
+import jenkins.search.SearchGroup;
 import jenkins.security.ImpersonatingUserDetailsService2;
 import jenkins.security.LastGrantedAuthoritiesProperty;
 import jenkins.security.UserDetailsCache;
@@ -284,6 +285,11 @@ public String getSearchIcon() {
         return UserAvatarResolver.resolve(this, "48x48");
     }
 
+    @Override
+    public SearchGroup getSearchGroup() {
+        return SearchGroup.get(SearchGroup.UserSearchGroup.class);
+    }
+
     /**
      * The URL of the user page.
      */

core/src/main/java/hudson/model/View.java

@@ -95,6 +95,7 @@
 import jenkins.model.item_category.Categories;
 import jenkins.model.item_category.Category;
 import jenkins.model.item_category.ItemCategory;
+import jenkins.search.SearchGroup;
 import jenkins.security.ExtendedReadRedaction;
 import jenkins.security.stapler.StaplerNotDispatchable;
 import jenkins.util.xml.XMLUtils;
@@ -567,6 +568,11 @@ public String getSearchIcon() {
         return "symbol-jobs";
     }
 
+    @Override
+    public SearchGroup getSearchGroup() {
+        return SearchGroup.get(SearchGroup.ViewSearchGroup.class);
+    }
+
     /**
      * Returns the transient {@link Action}s associated with the top page.
      *

core/src/main/java/hudson/search/Search.java

@@ -29,6 +29,8 @@
 
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import hudson.ExtensionComponent;
+import hudson.ExtensionList;
 import hudson.Util;
 import hudson.util.EditDistance;
 import io.jenkins.servlet.ServletExceptionWrapper;
@@ -37,12 +39,16 @@
 import java.util.AbstractList;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.Comparator;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import java.util.stream.Collectors;
 import jenkins.model.Jenkins;
+import jenkins.search.SearchGroup;
 import jenkins.security.stapler.StaplerNotDispatchable;
 import jenkins.util.MemoryReductionUtil;
 import jenkins.util.SystemProperties;
@@ -171,11 +177,26 @@ public void doSuggest(StaplerRequest2 req, StaplerResponse2 rsp, @QueryParameter
 
             if (iconName.startsWith("symbol")) {
                 r.suggestions.add(new Item(curItem.getPath(), curItem.getUrl(),
-                        Symbol.get(new SymbolRequest.Builder().withRaw(iconName).build())));
+                        Symbol.get(new SymbolRequest.Builder().withRaw(iconName).build()), "symbol", curItem.item.getSearchGroup().getDisplayName()));
             } else {
-                r.suggestions.add(new Item(curItem.getPath(), curItem.getUrl(), iconName, "image"));
+                r.suggestions.add(new Item(curItem.getPath(), curItem.getUrl(), iconName, "image", curItem.item.getSearchGroup().getDisplayName()));
             }
         }
+
+        // Sort results by group
+        ExtensionList<SearchGroup> groupsExtensionList = ExtensionList.lookup(SearchGroup.class);
+        List<ExtensionComponent<SearchGroup>> components = groupsExtensionList.getComponents();
+        Map<String, Double> searchGroupOrdinal = components.stream()
+                .collect(Collectors.toMap(
+                        (k) -> k.getInstance().getDisplayName(),
+                        ExtensionComponent::ordinal
+                ));
+        r.suggestions.sort(
+                Comparator.comparingDouble((Item item) -> searchGroupOrdinal.getOrDefault(item.getGroup(), Double.MAX_VALUE))
+                        .reversed()
+                        .thenComparing(item -> item.name)
+        );
+
         rsp.serveExposedBean(req, r, new ExportConfig());
     }
 
@@ -270,7 +291,6 @@ public static class Result {
     public static class Item {
 
         @Exported
-        @SuppressFBWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD", justification = "read by Stapler")
         public String name;
 
         private final String url;
@@ -279,22 +299,19 @@ public static class Item {
 
         private final String icon;
 
+        private final String group;
+
         public Item(String name) {
-            this(name, null, null);
+            this(name, null, null, "symbol", null);
         }
 
-        public Item(String name, String url, String icon) {
+        public Item(String name, String url, String icon, String type, String group) {
             this.name = name;
             this.url = url;
             this.icon = icon;
-            this.type = "symbol";
-        }
-
-        public Item(String name, String url, String icon, String type) {
             this.name = name;
-            this.url = url;
-            this.icon = icon;
             this.type = type;
+            this.group = group;
         }
 
         @Exported
@@ -311,6 +328,11 @@ public String getIcon() {
         public String getType() {
             return type;
         }
+
+        @Exported
+        public String getGroup() {
+            return group;
+        }
     }
 
     private enum Mode {

core/src/main/java/hudson/search/SearchItem.java

@@ -25,6 +25,7 @@
 package hudson.search;
 
 import hudson.model.Build;
+import jenkins.search.SearchGroup;
 import org.jenkins.ui.icon.IconSpec;
 
 /**
@@ -63,6 +64,10 @@ default String getSearchIcon() {
         return "symbol-search";
     }
 
+    default SearchGroup getSearchGroup() {
+        return SearchGroup.get(SearchGroup.UnclassifiedSearchGroup.class);
+    }
+
     /**
      * Returns the {@link SearchIndex} to further search sub items inside this item.
      *

core/src/main/java/jenkins/search/SearchGroup.java

@@ -0,0 +1,73 @@
+package jenkins.search;
+
+import static jenkins.search.Messages.SearchGroup_ComputerSearchGroup_DisplayName;
+import static jenkins.search.Messages.SearchGroup_ItemSearchGroup_DisplayName;
+import static jenkins.search.Messages.SearchGroup_UnclassifiedSearchGroup_DisplayName;
+import static jenkins.search.Messages.SearchGroup_UserSearchGroup_DisplayName;
+import static jenkins.search.Messages.SearchGroup_ViewSearchGroup_DisplayName;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import hudson.Extension;
+import hudson.ExtensionList;
+import hudson.ExtensionPoint;
+import hudson.model.ModelObject;
+
+public interface SearchGroup extends ExtensionPoint, ModelObject {
+
+    static ExtensionList<SearchGroup> all() {
+        return ExtensionList.lookup(SearchGroup.class);
+    }
+
+    static @NonNull <T extends SearchGroup> T get(Class<T> type) {
+        T category = all().get(type);
+        if (category == null) {
+            throw new AssertionError("Group not found. It seems the " + type + " is not annotated with @Extension and so not registered");
+        }
+        return category;
+    }
+
+    @Extension(ordinal = -1)
+    class UnclassifiedSearchGroup implements SearchGroup {
+
+        @Override
+        public String getDisplayName() {
+            return SearchGroup_UnclassifiedSearchGroup_DisplayName();
+        }
+    }
+
+    @Extension(ordinal = 999)
+    class ItemSearchGroup implements SearchGroup {
+
+        @Override
+        public String getDisplayName() {
+            return SearchGroup_ItemSearchGroup_DisplayName();
+        }
+    }
+
+    @Extension
+    class ComputerSearchGroup implements SearchGroup {
+
+        @Override
+        public String getDisplayName() {
+            return SearchGroup_ComputerSearchGroup_DisplayName();
+        }
+    }
+
+    @Extension
+    class ViewSearchGroup implements SearchGroup {
+
+        @Override
+        public String getDisplayName() {
+            return SearchGroup_ViewSearchGroup_DisplayName();
+        }
+    }
+
+    @Extension
+    class UserSearchGroup implements SearchGroup {
+
+        @Override
+        public String getDisplayName() {
+            return SearchGroup_UserSearchGroup_DisplayName();
+        }
+    }
+}

core/src/main/resources/jenkins/search/Messages.properties

@@ -0,0 +1,27 @@
+# The MIT License
+#
+# Copyright (c) 2025 Jan Faracik
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+SearchGroup.UnclassifiedSearchGroup.DisplayName=Other
+SearchGroup.ItemSearchGroup.DisplayName=Items
+SearchGroup.ComputerSearchGroup.DisplayName=Nodes
+SearchGroup.ViewSearchGroup.DisplayName=Views
+SearchGroup.UserSearchGroup.DisplayName=Users

src/main/js/components/command-palette/datasources.js

@@ -21,6 +21,7 @@ export const JenkinsSearchSource = {
             type: e.type,
             label: e.name,
             url: correctAddress(e.url),
+            group: e.group,
           }),
         );
       }),

src/main/js/components/command-palette/index.js

@@ -5,6 +5,7 @@ import * as Symbols from "./symbols";
 import makeKeyboardNavigable from "@/util/keyboard";
 import { xmlEscape } from "@/util/security";
 import { createElementFromHtml } from "@/util/dom";
+import { groupResultsByCategory } from "@/components/command-palette/utils";
 
 const datasources = [JenkinsSearchSource];
 
@@ -68,6 +69,7 @@ function init() {
           label: i18n.dataset.getHelp,
           url: headerCommandPaletteButton.dataset.searchHelpUrl,
           isExternal: true,
+          group: null,
         }),
       ]);
     } else {
@@ -77,15 +79,26 @@ function init() {
     }
 
     results.then((results) => {
+      results = groupResultsByCategory(results);
+
       // Clear current search results
       searchResults.innerHTML = "";
 
       if (query.length === 0 || Object.keys(results).length > 0) {
-        results.forEach(function (obj) {
-          const link = createElementFromHtml(obj.render());
-          link.addEventListener("mouseenter", (e) => itemMouseEnter(e));
-          searchResults.append(link);
-        });
+        for (const [group, items] of Object.entries(results)) {
+          if (group !== "null") {
+            const heading = document.createElement("p");
+            heading.className = "jenkins-command-palette__results__heading";
+            heading.innerText = group;
+            searchResults.append(heading);
+          }
+
+          items.forEach(function (obj) {
+            const link = createElementFromHtml(obj.render());
+            link.addEventListener("mouseenter", (e) => itemMouseEnter(e));
+            searchResults.append(link);
+          });
+        }
 
         updateSelectedItem(0);
       } else {

src/main/js/components/command-palette/models.js

@@ -7,12 +7,14 @@ import { xmlEscape } from "@/util/security";
  * @param {string} params.label
  * @param {'symbol' | 'image'} params.type
  * @param {string} params.url
+ * @param {string | null} params.group
  * @param {boolean | undefined} params.isExternal
  */
 export function LinkResult(params) {
   return {
     label: params.label,
     url: params.url,
+    group: params.group,
     render: () => {
       return `<a class="jenkins-command-palette__results__item" href="${xmlEscape(
         params.url,

src/main/js/components/command-palette/utils.js

@@ -0,0 +1,13 @@
+/**
+ * Group results by 'group' field into a map
+ */
+export function groupResultsByCategory(array) {
+  return array.reduce((hash, obj) => {
+    if (obj.group === undefined) {
+      return hash;
+    }
+    return Object.assign(hash, {
+      [obj.group]: (hash[obj.group] || []).concat(obj),
+    });
+  }, {});
+}