Various code improvements to Global & Workspace View State methods and unit tests.

Author: mhutchie

tests/extensionState.test.ts

@@ -427,6 +427,7 @@ describe('ExtensionState', () => {
 			const result = extensionState.getGlobalViewState();
 
 			// Assert
+			expect(extensionContext.globalState.get).toHaveBeenCalledWith('globalViewState', expect.anything());
 			expect(result).toStrictEqual(globalViewState);
 		});
 
@@ -440,6 +441,7 @@ describe('ExtensionState', () => {
 			const result = extensionState.getGlobalViewState();
 
 			// Assert
+			expect(extensionContext.globalState.get).toHaveBeenCalledWith('globalViewState', expect.anything());
 			expect(result).toStrictEqual({
 				alwaysAcceptCheckoutCommit: false,
 				issueLinkingConfig: null
@@ -454,6 +456,7 @@ describe('ExtensionState', () => {
 			const result = extensionState.getGlobalViewState();
 
 			// Assert
+			expect(extensionContext.globalState.get).toHaveBeenCalledWith('globalViewState', expect.anything());
 			expect(result).toStrictEqual({
 				alwaysAcceptCheckoutCommit: false,
 				issueLinkingConfig: null
@@ -509,6 +512,7 @@ describe('ExtensionState', () => {
 			const result = extensionState.getWorkspaceViewState();
 
 			// Assert
+			expect(extensionContext.workspaceState.get).toHaveBeenCalledWith('workspaceViewState', expect.anything());
 			expect(result).toStrictEqual(workspaceViewState);
 		});
 
@@ -523,6 +527,7 @@ describe('ExtensionState', () => {
 			const result = extensionState.getWorkspaceViewState();
 
 			// Assert
+			expect(extensionContext.workspaceState.get).toHaveBeenCalledWith('workspaceViewState', expect.anything());
 			expect(result).toStrictEqual({
 				findIsCaseSensitive: true,
 				findIsRegex: false,
@@ -538,6 +543,7 @@ describe('ExtensionState', () => {
 			const result = extensionState.getWorkspaceViewState();
 
 			// Assert
+			expect(extensionContext.workspaceState.get).toHaveBeenCalledWith('workspaceViewState', expect.anything());
 			expect(result).toStrictEqual({
 				findIsCaseSensitive: false,
 				findIsRegex: false,

web/findWidget.ts

@@ -64,7 +64,7 @@ class FindWidget {
 		this.caseSensitiveElem = document.getElementById('findCaseSensitive')!;
 		alterClass(this.caseSensitiveElem, CLASS_ACTIVE, workspaceState.findIsCaseSensitive);
 		this.caseSensitiveElem.addEventListener('click', () => {
-			this.view.updateWorkspaceViewState('findIsCaseSensitive', !workspaceState.findIsCaseSensitive);
+			updateWorkspaceViewState('findIsCaseSensitive', !workspaceState.findIsCaseSensitive);
 			alterClass(this.caseSensitiveElem, CLASS_ACTIVE, workspaceState.findIsCaseSensitive);
 			this.clearMatches();
 			this.findMatches(this.getCurrentHash(), true);
@@ -74,7 +74,7 @@ class FindWidget {
 		this.regexElem = document.getElementById('findRegex')!;
 		alterClass(this.regexElem, CLASS_ACTIVE, workspaceState.findIsRegex);
 		this.regexElem.addEventListener('click', () => {
-			this.view.updateWorkspaceViewState('findIsRegex', !workspaceState.findIsRegex);
+			updateWorkspaceViewState('findIsRegex', !workspaceState.findIsRegex);
 			alterClass(this.regexElem, CLASS_ACTIVE, workspaceState.findIsRegex);
 			this.clearMatches();
 			this.findMatches(this.getCurrentHash(), true);
@@ -97,7 +97,7 @@ class FindWidget {
 		openCdvElem.innerHTML = SVG_ICONS.cdv;
 		alterClass(openCdvElem, CLASS_ACTIVE, workspaceState.findOpenCommitDetailsView);
 		openCdvElem.addEventListener('click', () => {
-			this.view.updateWorkspaceViewState('findOpenCommitDetailsView', !workspaceState.findOpenCommitDetailsView);
+			updateWorkspaceViewState('findOpenCommitDetailsView', !workspaceState.findOpenCommitDetailsView);
 			alterClass(openCdvElem, CLASS_ACTIVE, workspaceState.findOpenCommitDetailsView);
 			this.openCommitDetailsViewForCurrentMatchIfEnabled();
 		});

web/global.d.ts

@@ -15,9 +15,9 @@ declare global {
 
 	type Config = GG.GitGraphViewConfig;
 
-	var initialState: GG.GitGraphViewInitialState;
-	var globalState: GG.GitGraphViewGlobalState;
-	var workspaceState: GG.GitGraphViewWorkspaceState;
+	const initialState: GG.GitGraphViewInitialState;
+	const globalState: GG.DeepReadonly<GG.GitGraphViewGlobalState>;
+	const workspaceState: GG.DeepReadonly<GG.GitGraphViewWorkspaceState>;
 
 	type AvatarImageCollection = { [email: string]: string };
 

web/main.ts

@@ -772,16 +772,6 @@ class GitGraphView {
 		}
 	}
 
-	public updateGlobalViewState<K extends keyof GG.GitGraphViewGlobalState>(key: K, value: GG.GitGraphViewGlobalState[K]) {
-		globalState[key] = value;
-		sendMessage({ command: 'setGlobalViewState', state: globalState });
-	}
-
-	public updateWorkspaceViewState<K extends keyof GG.GitGraphViewWorkspaceState>(key: K, value: GG.GitGraphViewWorkspaceState[K]) {
-		workspaceState[key] = value;
-		sendMessage({ command: 'setWorkspaceViewState', state: workspaceState });
-	}
-
 
 	/* Renderers */
 
@@ -1124,7 +1114,7 @@ class GitGraphView {
 					} else {
 						dialog.showCheckbox('Are you sure you want to checkout commit <b><i>' + abbrevCommit(hash) + '</i></b>? This will result in a \'detached HEAD\' state.', 'Always Accept', false, 'Yes, checkout', (alwaysAccept) => {
 							if (alwaysAccept) {
-								this.updateGlobalViewState('alwaysAcceptCheckoutCommit', true);
+								updateGlobalViewState('alwaysAcceptCheckoutCommit', true);
 							}
 							checkoutCommit();
 						}, target);

web/settingsWidget.ts

@@ -551,7 +551,7 @@ class SettingsWidget {
 			if (this.repo.issueLinkingConfig !== null) {
 				this.view.saveRepoStateValue(this.currentRepo, 'issueLinkingConfig', null);
 			}
-			this.view.updateGlobalViewState('issueLinkingConfig', config);
+			updateGlobalViewState('issueLinkingConfig', config);
 		} else {
 			this.view.saveRepoStateValue(this.currentRepo, 'issueLinkingConfig', config);
 		}

web/utils.ts

@@ -477,6 +477,29 @@ function handledEvent(event: Event) {
 }
 
 
+/* State Helpers */
+
+/**
+ * Update a key-value pair in the Global View State.
+ * @param key The key identifying the value to update.
+ * @param value The new value.
+ */
+function updateGlobalViewState<K extends keyof GG.GitGraphViewGlobalState>(key: K, value: GG.GitGraphViewGlobalState[K]) {
+	(<GG.DeepWriteable<GG.GitGraphViewGlobalState>>globalState)[key] = value;
+	sendMessage({ command: 'setGlobalViewState', state: globalState });
+}
+
+/**
+ * Update a key-value pair in the Workspace View State.
+ * @param key The key identifying the value to update.
+ * @param value The new value.
+ */
+function updateWorkspaceViewState<K extends keyof GG.GitGraphViewWorkspaceState>(key: K, value: GG.GitGraphViewWorkspaceState[K]) {
+	(<GG.DeepWriteable<GG.GitGraphViewWorkspaceState>>workspaceState)[key] = value;
+	sendMessage({ command: 'setWorkspaceViewState', state: workspaceState });
+}
+
+
 /* VSCode Helpers */
 
 /**