Update the format of selected state and propagate it to the treeview (#1817)

Author: charisk

extensions/ql-vscode/src/databases/config/db-config.ts

@@ -10,14 +10,53 @@ export interface DbConfigDatabases {
   local: LocalDbConfig;
 }
 
-export interface SelectedDbItem {
-  kind: SelectedDbItemKind;
-  value: string;
-}
+export type SelectedDbItem =
+  | SelectedLocalUserDefinedList
+  | SelectedLocalDatabase
+  | SelectedRemoteSystemDefinedList
+  | SelectedRemoteUserDefinedList
+  | SelectedRemoteOwner
+  | SelectedRemoteRepository;
 
 export enum SelectedDbItemKind {
-  ConfigDefined = "configDefined",
+  LocalUserDefinedList = "localUserDefinedList",
+  LocalDatabase = "localDatabase",
   RemoteSystemDefinedList = "remoteSystemDefinedList",
+  RemoteUserDefinedList = "remoteUserDefinedList",
+  RemoteOwner = "remoteOwner",
+  RemoteRepository = "remoteRepository",
+}
+
+export interface SelectedLocalUserDefinedList {
+  kind: SelectedDbItemKind.LocalUserDefinedList;
+  listName: string;
+}
+
+export interface SelectedLocalDatabase {
+  kind: SelectedDbItemKind.LocalDatabase;
+  databaseName: string;
+  listName?: string;
+}
+
+export interface SelectedRemoteSystemDefinedList {
+  kind: SelectedDbItemKind.RemoteSystemDefinedList;
+  listName: string;
+}
+
+export interface SelectedRemoteUserDefinedList {
+  kind: SelectedDbItemKind.RemoteUserDefinedList;
+  listName: string;
+}
+
+export interface SelectedRemoteOwner {
+  kind: SelectedDbItemKind.RemoteOwner;
+  ownerName: string;
+}
+
+export interface SelectedRemoteRepository {
+  kind: SelectedDbItemKind.RemoteRepository;
+  repositoryName: string;
+  listName?: string;
 }
 
 export interface RemoteDbConfig {
@@ -70,10 +109,44 @@ export function cloneDbConfig(config: DbConfig): DbConfig {
       },
     },
     selected: config.selected
-      ? {
-          kind: config.selected.kind,
-          value: config.selected.value,
-        }
+      ? cloneDbConfigSelectedItem(config.selected)
       : undefined,
   };
 }
+
+function cloneDbConfigSelectedItem(selected: SelectedDbItem): SelectedDbItem {
+  switch (selected.kind) {
+    case SelectedDbItemKind.LocalUserDefinedList:
+      return {
+        kind: SelectedDbItemKind.LocalUserDefinedList,
+        listName: selected.listName,
+      };
+    case SelectedDbItemKind.LocalDatabase:
+      return {
+        kind: SelectedDbItemKind.LocalDatabase,
+        databaseName: selected.databaseName,
+        listName: selected.listName,
+      };
+    case SelectedDbItemKind.RemoteSystemDefinedList:
+      return {
+        kind: SelectedDbItemKind.RemoteSystemDefinedList,
+        listName: selected.listName,
+      };
+    case SelectedDbItemKind.RemoteUserDefinedList:
+      return {
+        kind: SelectedDbItemKind.RemoteUserDefinedList,
+        listName: selected.listName,
+      };
+    case SelectedDbItemKind.RemoteOwner:
+      return {
+        kind: SelectedDbItemKind.RemoteOwner,
+        ownerName: selected.ownerName,
+      };
+    case SelectedDbItemKind.RemoteRepository:
+      return {
+        kind: SelectedDbItemKind.RemoteRepository,
+        repositoryName: selected.repositoryName,
+        listName: selected.listName,
+      };
+  }
+}

extensions/ql-vscode/src/databases/db-item.ts

@@ -20,12 +20,14 @@ export type LocalDbItem = LocalListDbItem | LocalDatabaseDbItem;
 
 export interface LocalListDbItem {
   kind: DbItemKind.LocalList;
+  selected: boolean;
   listName: string;
   databases: LocalDatabaseDbItem[];
 }
 
 export interface LocalDatabaseDbItem {
   kind: DbItemKind.LocalDatabase;
+  selected: boolean;
   databaseName: string;
   dateAdded: number;
   language: string;
@@ -51,23 +53,74 @@ export type RemoteDbItem =
 
 export interface RemoteSystemDefinedListDbItem {
   kind: DbItemKind.RemoteSystemDefinedList;
+  selected: boolean;
   listName: string;
   listDisplayName: string;
   listDescription: string;
 }
 
 export interface RemoteUserDefinedListDbItem {
   kind: DbItemKind.RemoteUserDefinedList;
+  selected: boolean;
   listName: string;
   repos: RemoteRepoDbItem[];
 }
 
 export interface RemoteOwnerDbItem {
   kind: DbItemKind.RemoteOwner;
+  selected: boolean;
   ownerName: string;
 }
 
 export interface RemoteRepoDbItem {
   kind: DbItemKind.RemoteRepo;
+  selected: boolean;
   repoFullName: string;
 }
+
+export function isRemoteSystemDefinedListDbItem(
+  dbItem: DbItem,
+): dbItem is RemoteSystemDefinedListDbItem {
+  return dbItem.kind === DbItemKind.RemoteSystemDefinedList;
+}
+
+export function isRemoteUserDefinedListDbItem(
+  dbItem: DbItem,
+): dbItem is RemoteUserDefinedListDbItem {
+  return dbItem.kind === DbItemKind.RemoteUserDefinedList;
+}
+
+export function isRemoteOwnerDbItem(
+  dbItem: DbItem,
+): dbItem is RemoteOwnerDbItem {
+  return dbItem.kind === DbItemKind.RemoteOwner;
+}
+
+export function isRemoteRepoDbItem(dbItem: DbItem): dbItem is RemoteRepoDbItem {
+  return dbItem.kind === DbItemKind.RemoteRepo;
+}
+
+export function isLocalListDbItem(dbItem: DbItem): dbItem is LocalListDbItem {
+  return dbItem.kind === DbItemKind.LocalList;
+}
+
+export function isLocalDatabaseDbItem(
+  dbItem: DbItem,
+): dbItem is LocalDatabaseDbItem {
+  return dbItem.kind === DbItemKind.LocalDatabase;
+}
+
+export type SelectableDbItem = RemoteDbItem | LocalDbItem;
+
+export function isSelectableDbItem(dbItem: DbItem): dbItem is SelectableDbItem {
+  return SelectableDbItemKinds.includes(dbItem.kind);
+}
+
+const SelectableDbItemKinds = [
+  DbItemKind.LocalList,
+  DbItemKind.LocalDatabase,
+  DbItemKind.RemoteSystemDefinedList,
+  DbItemKind.RemoteUserDefinedList,
+  DbItemKind.RemoteOwner,
+  DbItemKind.RemoteRepo,
+];

extensions/ql-vscode/src/databases/db-tree-creator.ts

@@ -3,6 +3,7 @@ import {
   LocalDatabase,
   LocalList,
   RemoteRepositoryList,
+  SelectedDbItemKind,
 } from "./config/db-config";
 import {
   DbItemKind,
@@ -18,16 +19,20 @@ import {
 
 export function createRemoteTree(dbConfig: DbConfig): RootRemoteDbItem {
   const systemDefinedLists = [
-    createSystemDefinedList(10),
-    createSystemDefinedList(100),
-    createSystemDefinedList(1000),
+    createSystemDefinedList(10, dbConfig),
+    createSystemDefinedList(100, dbConfig),
+    createSystemDefinedList(1000, dbConfig),
   ];
 
   const userDefinedRepoLists = dbConfig.databases.remote.repositoryLists.map(
-    createUserDefinedList,
+    (r) => createRemoteUserDefinedList(r, dbConfig),
+  );
+  const owners = dbConfig.databases.remote.owners.map((o) =>
+    createOwnerItem(o, dbConfig),
+  );
+  const repos = dbConfig.databases.remote.repositories.map((r) =>
+    createRepoItem(r, dbConfig),
   );
-  const owners = dbConfig.databases.remote.owners.map(createOwnerItem);
-  const repos = dbConfig.databases.remote.repositories.map(createRepoItem);
 
   return {
     kind: DbItemKind.RootRemote,
@@ -41,62 +46,118 @@ export function createRemoteTree(dbConfig: DbConfig): RootRemoteDbItem {
 }
 
 export function createLocalTree(dbConfig: DbConfig): RootLocalDbItem {
-  const localLists = dbConfig.databases.local.lists.map(createLocalList);
-  const localDbs = dbConfig.databases.local.databases.map(createLocalDb);
+  const localLists = dbConfig.databases.local.lists.map((l) =>
+    createLocalList(l, dbConfig),
+  );
+  const localDbs = dbConfig.databases.local.databases.map((l) =>
+    createLocalDb(l, dbConfig),
+  );
 
   return {
     kind: DbItemKind.RootLocal,
     children: [...localLists, ...localDbs],
   };
 }
 
-function createSystemDefinedList(n: number): RemoteSystemDefinedListDbItem {
+function createSystemDefinedList(
+  n: number,
+  dbConfig: DbConfig,
+): RemoteSystemDefinedListDbItem {
+  const listName = `top_${n}`;
+
+  const selected =
+    dbConfig.selected &&
+    dbConfig.selected.kind === SelectedDbItemKind.RemoteSystemDefinedList &&
+    dbConfig.selected.listName === listName;
+
   return {
     kind: DbItemKind.RemoteSystemDefinedList,
-    listName: `top_${n}`,
+    listName,
     listDisplayName: `Top ${n} repositories`,
     listDescription: `Top ${n} repositories of a language`,
+    selected: !!selected,
   };
 }
 
-function createUserDefinedList(
+function createRemoteUserDefinedList(
   list: RemoteRepositoryList,
+  dbConfig: DbConfig,
 ): RemoteUserDefinedListDbItem {
+  const selected =
+    dbConfig.selected &&
+    dbConfig.selected.kind === SelectedDbItemKind.RemoteUserDefinedList &&
+    dbConfig.selected.listName === list.name;
+
   return {
     kind: DbItemKind.RemoteUserDefinedList,
     listName: list.name,
-    repos: list.repositories.map((r) => createRepoItem(r)),
+    repos: list.repositories.map((r) => createRepoItem(r, dbConfig, list.name)),
+    selected: !!selected,
   };
 }
 
-function createOwnerItem(owner: string): RemoteOwnerDbItem {
+function createOwnerItem(owner: string, dbConfig: DbConfig): RemoteOwnerDbItem {
+  const selected =
+    dbConfig.selected &&
+    dbConfig.selected.kind === SelectedDbItemKind.RemoteOwner &&
+    dbConfig.selected.ownerName === owner;
+
   return {
     kind: DbItemKind.RemoteOwner,
     ownerName: owner,
+    selected: !!selected,
   };
 }
 
-function createRepoItem(repo: string): RemoteRepoDbItem {
+function createRepoItem(
+  repo: string,
+  dbConfig: DbConfig,
+  listName?: string,
+): RemoteRepoDbItem {
+  const selected =
+    dbConfig.selected &&
+    dbConfig.selected.kind === SelectedDbItemKind.RemoteRepository &&
+    dbConfig.selected.repositoryName === repo &&
+    dbConfig.selected.listName === listName;
+
   return {
     kind: DbItemKind.RemoteRepo,
     repoFullName: repo,
+    selected: !!selected,
   };
 }
 
-function createLocalList(list: LocalList): LocalListDbItem {
+function createLocalList(list: LocalList, dbConfig: DbConfig): LocalListDbItem {
+  const selected =
+    dbConfig.selected &&
+    dbConfig.selected.kind === SelectedDbItemKind.LocalUserDefinedList &&
+    dbConfig.selected.listName === list.name;
+
   return {
     kind: DbItemKind.LocalList,
     listName: list.name,
-    databases: list.databases.map(createLocalDb),
+    databases: list.databases.map((d) => createLocalDb(d, dbConfig, list.name)),
+    selected: !!selected,
   };
 }
 
-function createLocalDb(db: LocalDatabase): LocalDatabaseDbItem {
+function createLocalDb(
+  db: LocalDatabase,
+  dbConfig: DbConfig,
+  listName?: string,
+): LocalDatabaseDbItem {
+  const selected =
+    dbConfig.selected &&
+    dbConfig.selected.kind === SelectedDbItemKind.LocalDatabase &&
+    dbConfig.selected.databaseName === db.name &&
+    dbConfig.selected.listName === listName;
+
   return {
     kind: DbItemKind.LocalDatabase,
     databaseName: db.name,
     dateAdded: db.dateAdded,
     language: db.language,
     storagePath: db.storagePath,
+    selected: !!selected,
   };
 }

extensions/ql-vscode/src/databases/ui/db-tree-view-item.ts

@@ -1,6 +1,7 @@
 import * as vscode from "vscode";
 import {
   DbItem,
+  isSelectableDbItem,
   LocalDatabaseDbItem,
   LocalListDbItem,
   RemoteOwnerDbItem,
@@ -28,6 +29,16 @@ export class DbTreeViewItem extends vscode.TreeItem {
     public readonly children: DbTreeViewItem[],
   ) {
     super(label, collapsibleState);
+
+    if (dbItem && isSelectableDbItem(dbItem)) {
+      if (dbItem.selected) {
+        // Define the resource id to drive the UI to render this item as selected.
+        this.resourceUri = vscode.Uri.parse("codeql://databases?selected=true");
+      } else {
+        // Define a context value to drive the UI to show an action to select the item.
+        this.contextValue = "selectableDbItem";
+      }
+    }
   }
 }