Move db item expanded state to workspace storage (#1904)

Author: charisk

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

@@ -1,11 +1,6 @@
 import { pathExists, outputJSON, readJSON, readJSONSync } from "fs-extra";
 import { join } from "path";
-import {
-  cloneDbConfig,
-  DbConfig,
-  ExpandedDbItem,
-  SelectedDbItem,
-} from "./db-config";
+import { cloneDbConfig, DbConfig, SelectedDbItem } from "./db-config";
 import * as chokidar from "chokidar";
 import { DisposableObject, DisposeHandler } from "../../pure/disposable-object";
 import { DbConfigValidator } from "./db-config-validator";
@@ -81,19 +76,6 @@ export class DbConfigStore extends DisposableObject {
     await this.writeConfig(config);
   }
 
-  public async updateExpandedState(expandedItems: ExpandedDbItem[]) {
-    if (!this.config) {
-      throw Error("Cannot update expansion state if config is not loaded");
-    }
-
-    const config: DbConfig = {
-      ...this.config,
-      expanded: expandedItems,
-    };
-
-    await this.writeConfig(config);
-  }
-
   public async addRemoteRepo(
     repoNwo: string,
     parentList?: string,
@@ -330,7 +312,6 @@ export class DbConfigStore extends DisposableObject {
           databases: [],
         },
       },
-      expanded: [],
     };
   }
 }

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

@@ -2,7 +2,6 @@
 
 export interface DbConfig {
   databases: DbConfigDatabases;
-  expanded: ExpandedDbItem[];
   selected?: SelectedDbItem;
 }
 
@@ -140,7 +139,6 @@ export function cloneDbConfig(config: DbConfig): DbConfig {
         databases: config.databases.local.databases.map((db) => ({ ...db })),
       },
     },
-    expanded: config.expanded.map(cloneDbConfigExpandedItem),
     selected: config.selected
       ? cloneDbConfigSelectedItem(config.selected)
       : undefined,
@@ -183,17 +181,3 @@ function cloneDbConfigSelectedItem(selected: SelectedDbItem): SelectedDbItem {
       };
   }
 }
-
-function cloneDbConfigExpandedItem(item: ExpandedDbItem): ExpandedDbItem {
-  switch (item.kind) {
-    case ExpandedDbItemKind.RootLocal:
-    case ExpandedDbItemKind.RootRemote:
-      return { kind: item.kind };
-    case ExpandedDbItemKind.LocalUserDefinedList:
-    case ExpandedDbItemKind.RemoteUserDefinedList:
-      return {
-        kind: item.kind,
-        listName: item.listName,
-      };
-  }
-}

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

@@ -1,6 +1,7 @@
 import { App } from "../common/app";
 import { AppEvent, AppEventEmitter } from "../common/events";
 import { ValueResult } from "../common/value-result";
+import { ExpandedDbItem } from "./config/db-config";
 import { DbConfigStore } from "./config/db-config-store";
 import { DbItem, DbListKind } from "./db-item";
 import { calculateNewExpandedState } from "./db-item-expansion";
@@ -14,8 +15,12 @@ import { DbConfigValidationError } from "./db-validation-errors";
 export class DbManager {
   public readonly onDbItemsChanged: AppEvent<void>;
   private readonly onDbItemsChangesEventEmitter: AppEventEmitter<void>;
+  private static readonly DB_EXPANDED_STATE_KEY = "db_expanded";
 
-  constructor(app: App, private readonly dbConfigStore: DbConfigStore) {
+  constructor(
+    private readonly app: App,
+    private readonly dbConfigStore: DbConfigStore,
+  ) {
     this.onDbItemsChangesEventEmitter = app.createEventEmitter<void>();
     this.onDbItemsChanged = this.onDbItemsChangesEventEmitter.event;
 
@@ -40,9 +45,11 @@ export class DbManager {
       return ValueResult.fail(configResult.errors);
     }
 
+    const expandedItems = this.getCurrentExpandedItems();
+
     return ValueResult.ok([
-      createRemoteTree(configResult.value),
-      createLocalTree(configResult.value),
+      createRemoteTree(configResult.value, expandedItems),
+      createLocalTree(configResult.value, expandedItems),
     ]);
   }
 
@@ -66,13 +73,18 @@ export class DbManager {
       throw Error("Cannot update expanded state if config is not loaded");
     }
 
+    const currentExpandedItems = this.getCurrentExpandedItems();
+
     const newExpandedItems = calculateNewExpandedState(
-      configResult.value.expanded,
+      currentExpandedItems,
       dbItem,
       itemExpanded,
     );
 
-    await this.dbConfigStore.updateExpandedState(newExpandedItems);
+    await this.app.workspaceState.update(
+      DbManager.DB_EXPANDED_STATE_KEY,
+      newExpandedItems,
+    );
   }
 
   public async addNewRemoteRepo(
@@ -120,4 +132,12 @@ export class DbManager {
   public doesRemoteRepoExist(nwo: string, listName?: string): boolean {
     return this.dbConfigStore.doesRemoteDbExist(nwo, listName);
   }
+
+  private getCurrentExpandedItems(): ExpandedDbItem[] {
+    const items = this.app.workspaceState.get<ExpandedDbItem[]>(
+      DbManager.DB_EXPANDED_STATE_KEY,
+    );
+
+    return items || [];
+  }
 }

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

@@ -1,5 +1,6 @@
 import {
   DbConfig,
+  ExpandedDbItem,
   ExpandedDbItemKind,
   LocalDatabase,
   LocalList,
@@ -18,15 +19,18 @@ import {
   RootRemoteDbItem,
 } from "./db-item";
 
-export function createRemoteTree(dbConfig: DbConfig): RootRemoteDbItem {
+export function createRemoteTree(
+  dbConfig: DbConfig,
+  expandedItems: ExpandedDbItem[],
+): RootRemoteDbItem {
   const systemDefinedLists = [
     createSystemDefinedList(10, dbConfig),
     createSystemDefinedList(100, dbConfig),
     createSystemDefinedList(1000, dbConfig),
   ];
 
   const userDefinedRepoLists = dbConfig.databases.remote.repositoryLists.map(
-    (r) => createRemoteUserDefinedList(r, dbConfig),
+    (r) => createRemoteUserDefinedList(r, dbConfig, expandedItems),
   );
   const owners = dbConfig.databases.remote.owners.map((o) =>
     createOwnerItem(o, dbConfig),
@@ -35,9 +39,9 @@ export function createRemoteTree(dbConfig: DbConfig): RootRemoteDbItem {
     createRepoItem(r, dbConfig),
   );
 
-  const expanded =
-    dbConfig.expanded &&
-    dbConfig.expanded.some((e) => e.kind === ExpandedDbItemKind.RootRemote);
+  const expanded = expandedItems.some(
+    (e) => e.kind === ExpandedDbItemKind.RootRemote,
+  );
 
   return {
     kind: DbItemKind.RootRemote,
@@ -51,17 +55,20 @@ export function createRemoteTree(dbConfig: DbConfig): RootRemoteDbItem {
   };
 }
 
-export function createLocalTree(dbConfig: DbConfig): RootLocalDbItem {
+export function createLocalTree(
+  dbConfig: DbConfig,
+  expandedItems: ExpandedDbItem[],
+): RootLocalDbItem {
   const localLists = dbConfig.databases.local.lists.map((l) =>
-    createLocalList(l, dbConfig),
+    createLocalList(l, dbConfig, expandedItems),
   );
   const localDbs = dbConfig.databases.local.databases.map((l) =>
     createLocalDb(l, dbConfig),
   );
 
-  const expanded =
-    dbConfig.expanded &&
-    dbConfig.expanded.some((e) => e.kind === ExpandedDbItemKind.RootLocal);
+  const expanded = expandedItems.some(
+    (e) => e.kind === ExpandedDbItemKind.RootLocal,
+  );
 
   return {
     kind: DbItemKind.RootLocal,
@@ -93,19 +100,18 @@ function createSystemDefinedList(
 function createRemoteUserDefinedList(
   list: RemoteRepositoryList,
   dbConfig: DbConfig,
+  expandedItems: ExpandedDbItem[],
 ): RemoteUserDefinedListDbItem {
   const selected =
     dbConfig.selected &&
     dbConfig.selected.kind === SelectedDbItemKind.RemoteUserDefinedList &&
     dbConfig.selected.listName === list.name;
 
-  const expanded =
-    dbConfig.expanded &&
-    dbConfig.expanded.some(
-      (e) =>
-        e.kind === ExpandedDbItemKind.RemoteUserDefinedList &&
-        e.listName === list.name,
-    );
+  const expanded = expandedItems.some(
+    (e) =>
+      e.kind === ExpandedDbItemKind.RemoteUserDefinedList &&
+      e.listName === list.name,
+  );
 
   return {
     kind: DbItemKind.RemoteUserDefinedList,
@@ -148,19 +154,21 @@ function createRepoItem(
   };
 }
 
-function createLocalList(list: LocalList, dbConfig: DbConfig): LocalListDbItem {
+function createLocalList(
+  list: LocalList,
+  dbConfig: DbConfig,
+  expandedItems: ExpandedDbItem[],
+): LocalListDbItem {
   const selected =
     dbConfig.selected &&
     dbConfig.selected.kind === SelectedDbItemKind.LocalUserDefinedList &&
     dbConfig.selected.listName === list.name;
 
-  const expanded =
-    dbConfig.expanded &&
-    dbConfig.expanded.some(
-      (e) =>
-        e.kind === ExpandedDbItemKind.LocalUserDefinedList &&
-        e.listName === list.name,
-    );
+  const expanded = expandedItems.some(
+    (e) =>
+      e.kind === ExpandedDbItemKind.LocalUserDefinedList &&
+      e.listName === list.name,
+  );
 
   return {
     kind: DbItemKind.LocalList,

extensions/ql-vscode/src/vscode-tests/factories/db-config-factories.ts

@@ -1,7 +1,6 @@
 import { faker } from "@faker-js/faker";
 import {
   DbConfig,
-  ExpandedDbItem,
   LocalDatabase,
   LocalList,
   RemoteRepositoryList,
@@ -15,15 +14,13 @@ export function createDbConfig({
   localLists = [],
   localDbs = [],
   selected = undefined,
-  expanded = [],
 }: {
   remoteLists?: RemoteRepositoryList[];
   remoteOwners?: string[];
   remoteRepos?: string[];
   localLists?: LocalList[];
   localDbs?: LocalDatabase[];
   selected?: SelectedDbItem;
-  expanded?: ExpandedDbItem[];
 } = {}): DbConfig {
   return {
     databases: {
@@ -37,7 +34,6 @@ export function createDbConfig({
         databases: localDbs,
       },
     },
-    expanded,
     selected,
   };
 }

extensions/ql-vscode/src/vscode-tests/factories/extension-context.ts

@@ -1,4 +1,5 @@
 import * as vscode from "vscode";
+import { createMockMemento } from "../mock-memento";
 
 /**
  * Creates a partially implemented mock of vscode.ExtensionContext.
@@ -11,10 +12,12 @@ export function createMockExtensionContext({
   extensionPath?: string;
   workspaceStoragePath?: string;
   globalStoragePath?: string;
+  workspaceState?: vscode.Memento;
 }): vscode.ExtensionContext {
   return {
     extensionPath,
     globalStorageUri: vscode.Uri.file(globalStoragePath),
     storageUri: vscode.Uri.file(workspaceStoragePath),
+    workspaceState: createMockMemento(),
   } as any as vscode.ExtensionContext;
 }

…/ql-vscode/test/__mocks__/mementoMock.ts …-vscode/src/vscode-tests/mock-memento.tsextensions/ql-vscode/test/__mocks__/mementoMock.ts renamed to extensions/ql-vscode/src/vscode-tests/mock-memento.ts extensions/ql-vscode/test/__mocks__/mementoMock.ts renamed to extensions/ql-vscode/src/vscode-tests/mock-memento.ts

@@ -1,4 +1,4 @@
-import { Memento } from "../../src/common/memento";
+import { Memento } from "../common/memento";
 
 export function createMockMemento(): Memento {
   return new MockMemento();

extensions/ql-vscode/test/__mocks__/appMock.ts

@@ -3,7 +3,7 @@ import { AppEvent, AppEventEmitter } from "../../src/common/events";
 import { Memento } from "../../src/common/memento";
 import { Disposable } from "../../src/pure/disposable-object";
 import { createMockLogger } from "./loggerMock";
-import { createMockMemento } from "./mementoMock";
+import { createMockMemento } from "../../src/vscode-tests/mock-memento";
 
 export function createMockApp({
   extensionPath = "/mock/extension/path",

extensions/ql-vscode/test/pure-tests/databases/config/data/without-selected/workspace-databases.json

@@ -9,6 +9,5 @@
       "lists": [],
       "databases": []
     }
-  },
-  "expanded": []
+  }
 }

extensions/ql-vscode/test/pure-tests/databases/config/data/workspace-databases.json

@@ -45,7 +45,6 @@
       ]
     }
   },
-  "expanded": [],
   "selected": {
     "kind": "remoteUserDefinedList",
     "listName": "repoList1"