Move inspect to config.ts to reduce duplication of knowledge

Author: robertbrignull

extensions/ql-vscode/src/config.ts

@@ -35,6 +35,19 @@ export class Setting {
     }
     return workspace.getConfiguration(this.parent.qualifiedName).update(this.name, value, target);
   }
+
+  inspect<T>(): InspectionResult<T> | undefined {
+    if (this.parent === undefined) {
+      throw new Error('Cannot update the value of a root setting.');
+    }
+    return workspace.getConfiguration(this.parent.qualifiedName).inspect(this.name);
+  }
+}
+
+export interface InspectionResult<T> {
+  globalValue?: T;
+  workspaceValue?: T,
+  workspaceFolderValue?: T,
 }
 
 const ROOT_SETTING = new Setting('codeQL');

extensions/ql-vscode/src/vscode-tests/test-config.ts

@@ -1,32 +1,28 @@
-import { ConfigurationTarget, workspace } from 'vscode';
-import { CUSTOM_CODEQL_PATH_SETTING, REMOTE_CONTROLLER_REPO, REMOTE_REPO_LISTS, Setting } from '../config';
+import { ConfigurationTarget } from 'vscode';
+import { CUSTOM_CODEQL_PATH_SETTING, InspectionResult, REMOTE_CONTROLLER_REPO, REMOTE_REPO_LISTS, Setting } from '../config';
 
 class TestSetting<T> {
-  private settingState: {
-    globalValue?: T;
-    workspaceValue?: T,
-    workspaceFolderValue?: T,
-  } | undefined;
+  private settingState: InspectionResult<T> | undefined;
 
   constructor(
     public readonly setting: Setting,
     private initialTestValue: T | undefined = undefined
   ) { }
 
   public async get(): Promise<T | undefined> {
-    return this.section.get(this.setting.name);
+    return this.setting.getValue();
   }
 
   public async set(value: T | undefined, target: ConfigurationTarget = ConfigurationTarget.Global): Promise<void> {
-    await this.section.update(this.setting.name, value, target);
+    await this.setting.updateValue(value, target);
   }
 
   public async setInitialTestValue(value: T | undefined) {
     this.initialTestValue = value;
   }
 
   public async initialSetup() {
-    this.settingState = this.section.inspect(this.setting.name);
+    this.settingState = this.setting.inspect();
 
     // Unfortunately it's not well-documented how to check whether we can write to a workspace
     // configuration. This is the best I could come up with. It only fails for initial test values
@@ -46,7 +42,7 @@ class TestSetting<T> {
   }
 
   public async restoreToInitialValues() {
-    const state = this.section.inspect(this.setting.name);
+    const state = this.setting.inspect();
 
     // We need to check the state of the setting before we restore it. This is less important for the global
     // configuration target, but the workspace/workspace folder configuration might not even exist. If they
@@ -61,13 +57,6 @@ class TestSetting<T> {
       await this.set(this.settingState?.workspaceFolderValue, ConfigurationTarget.WorkspaceFolder);
     }
   }
-
-  private get section() {
-    if (this.setting.parent === undefined) {
-      throw new Error('Cannot get the value of a root setting.');
-    }
-    return workspace.getConfiguration(this.setting.parent.qualifiedName);
-  }
 }
 
 export const testConfig = {