Add command to sort databases by name

This assumes that we will be adding other sorting mechanisms in the
future, like sort by data added.

Not happy with the icon I chose, but I didn't want to spend too much
time creating a new one.

Author: aeisenberg

extensions/ql-vscode/media/dark/sort-precedence.svg

@@ -206,6 +206,14 @@
         "command": "codeQLDatabases.upgradeDatabase",
         "title": "Upgrade Database"
       },
+      {
+        "command": "codeQLDatabases.sortByName",
+        "title": "Sort by Name",
+        "icon": {
+          "light": "media/light/sort-precedence.svg",
+          "dark": "media/dark/sort-precedence.svg"
+        }
+      },
       {
         "command": "codeQL.checkForUpdatesToCLI",
         "title": "CodeQL: Check for CLI Updates"
@@ -257,6 +265,11 @@
     ],
     "menus": {
       "view/title": [
+        {
+          "command": "codeQLDatabases.sortByName",
+          "when": "view == codeQLDatabases",
+          "group": "navigation"
+        },
         {
           "command": "codeQL.chooseDatabase",
           "when": "view == codeQLDatabases",
@@ -344,6 +357,10 @@
           "command": "codeQLDatabases.setCurrentDatabase",
           "when": "false"
         },
+        {
+          "command": "codeQLDatabases.sortByName",
+          "when": "false"
+        },
         {
           "command": "codeQLDatabases.removeDatabase",
           "when": "false"

extensions/ql-vscode/media/light/sort-precedence.svg

@@ -34,12 +34,19 @@ function joinThemableIconPath(base: string, iconPath: ThemableIconPath): Themabl
     return path.join(base, iconPath);
 }
 
+enum SortOrder {
+  NameAsc = 'NameAsc',
+  NameDesc = 'NameDesc'
+}
+
 /**
  * Tree data provider for the databases view.
  */
 class DatabaseTreeDataProvider extends DisposableObject
   implements TreeDataProvider<DatabaseItem> {
 
+  private _sortOrder = SortOrder.NameAsc;
+
   private readonly _onDidChangeTreeData = new EventEmitter<DatabaseItem | undefined>();
   private currentDatabaseItem: DatabaseItem | undefined;
 
@@ -84,7 +91,14 @@ class DatabaseTreeDataProvider extends DisposableObject
 
   public getChildren(element?: DatabaseItem): ProviderResult<DatabaseItem[]> {
     if (element === undefined) {
-      return this.databaseManager.databaseItems.slice(0);
+      return this.databaseManager.databaseItems.slice(0).sort((db1, db2) => {
+        switch(this.sortOrder) {
+          case SortOrder.NameAsc:
+            return db1.name.localeCompare(db2.name);
+          case SortOrder.NameDesc:
+            return db2.name.localeCompare(db1.name);
+        }
+      });
     }
     else {
       return [];
@@ -98,6 +112,15 @@ class DatabaseTreeDataProvider extends DisposableObject
   public getCurrent(): DatabaseItem | undefined {
     return this.currentDatabaseItem;
   }
+
+  public get sortOrder() {
+    return this._sortOrder;
+  }
+
+  public set sortOrder(newSortOrder: SortOrder) {
+    this._sortOrder = newSortOrder;
+    this._onDidChangeTreeData.fire();
+  }
 }
 
 /** Gets the first element in the given list, if any, or undefined if the list is empty or undefined. */
@@ -129,19 +152,25 @@ async function chooseDatabaseDir(): Promise<Uri | undefined> {
 }
 
 export class DatabaseUI extends DisposableObject {
-  public constructor(ctx: ExtensionContext, private cliserver: cli.CodeQLCliServer, private databaseManager: DatabaseManager,
-    private readonly queryServer: qsClient.QueryServerClient | undefined) {
-
+  private treeDataProvider: DatabaseTreeDataProvider;
+
+  public constructor(
+    ctx: ExtensionContext,
+    private cliserver: cli.CodeQLCliServer,
+    private databaseManager: DatabaseManager,
+    private readonly queryServer: qsClient.QueryServerClient | undefined
+  ) {
     super();
 
-    const treeDataProvider = this.push(new DatabaseTreeDataProvider(ctx, databaseManager));
-    this.push(window.createTreeView('codeQLDatabases', { treeDataProvider }));
+    this.treeDataProvider = this.push(new DatabaseTreeDataProvider(ctx, databaseManager));
+    this.push(window.createTreeView('codeQLDatabases', { treeDataProvider: this.treeDataProvider }));
 
     ctx.subscriptions.push(commands.registerCommand('codeQL.chooseDatabase', this.handleChooseDatabase));
     ctx.subscriptions.push(commands.registerCommand('codeQL.setCurrentDatabase', this.handleSetCurrentDatabase));
     ctx.subscriptions.push(commands.registerCommand('codeQL.upgradeCurrentDatabase', this.handleUpgradeCurrentDatabase));
     ctx.subscriptions.push(commands.registerCommand('codeQL.clearCache', this.handleClearCache));
     ctx.subscriptions.push(commands.registerCommand('codeQLDatabases.setCurrentDatabase', this.handleMakeCurrentDatabase));
+    ctx.subscriptions.push(commands.registerCommand('codeQLDatabases.sortByName', this.handleSortByName));
     ctx.subscriptions.push(commands.registerCommand('codeQLDatabases.removeDatabase', this.handleRemoveDatabase));
     ctx.subscriptions.push(commands.registerCommand('codeQLDatabases.upgradeDatabase', this.handleUpgradeDatabase));
   }
@@ -154,6 +183,14 @@ export class DatabaseUI extends DisposableObject {
     return await this.chooseAndSetDatabase();
   }
 
+  private handleSortByName = async () => {
+    if (this.treeDataProvider.sortOrder === SortOrder.NameAsc) {
+      this.treeDataProvider.sortOrder = SortOrder.NameDesc;
+    } else {
+      this.treeDataProvider.sortOrder = SortOrder.NameAsc;
+    }
+  }
+
   private handleUpgradeCurrentDatabase = async (): Promise<void> => {
     await this.handleUpgradeDatabase(this.databaseManager.currentDatabaseItem);
   }