Prevent errors when config values are in the wrong format

Author: phil294

.vscode/settings.json

@@ -43,7 +43,8 @@
         "remotename",
         "scroller",
         "shortstat",
-        "vueuse"
+        "vueuse",
+        "yaireo"
     ],
     "files.trimTrailingWhitespace": true,
     "eslint.experimental.useFlatConfig": true,

src/global.d.ts

@@ -4,6 +4,8 @@ interface String {
 	hashCode(): number
 }
 
+type Json = null | string | number | boolean | Json[] | { [key: string]: Json };
+
 interface BridgeMessage {
 	type: 'response-to-web' | 'request-from-web' | 'push-to-web',
 	command?: string,

src/state.js

@@ -43,6 +43,8 @@ let storage_providers = {
 	},
 }
 
+/** @typedef {Record<string, Json>} ActualConfig Necessary as config schema isn't enforced by VSCode */
+
 /**
  * There can also be dynamic states, aka GitInput states.
  * This object only bootstraps the static ones. `state()` eventually accepts both.
@@ -52,7 +54,7 @@ let static_states = {
 	config: {
 		type: 'special',
 		storage: (ctx) => ({
-			get: () => ctx.get_config(),
+			get: () => /** @type {ActualConfig} */ (ctx.get_config()),
 			set() {},
 		}),
 	},

web/src/components/CommitRefTips.vue

@@ -5,7 +5,7 @@
 </template>
 <script setup>
 import { computed } from 'vue'
-import { config } from '../data/store'
+import config from '../data/store/config'
 
 let props = defineProps({
 	commit: {
@@ -27,7 +27,7 @@ function group_same_name_branches_into_one(/** @type {Branch[]} */ branches) {
 }
 
 let grouped_git_refs = computed(() => {
-	if (config.value['group-branch-remotes'] === false)
+	if (config.get_boolean_or_undefined('group-branch-remotes') === false)
 		return props.commit.refs
 	return Object.values(props.commit.refs.reduce((/** @type {Record<string, GitRef[]>} */ all, ref) => {
 		all[ref.name] = [...all[ref.name] || [], ref]

web/src/data/state.js

@@ -29,8 +29,9 @@ add_push_listener('state-update', (/** @template {StateKey} K @type {{data?: {ke
  * @param {K} key
  * @param {NonNullable<StateType<K>>} default_value
  * @param {() => any} on_load=
+ * @param {{ write_only?: boolean }} opt
  */
-let state = (key, default_value, on_load = () => {}) => {
+let state = (key, default_value, on_load = () => {}, { write_only } = {}) => {
 	/** @type {State<K>|undefined} */
 	let ret = _states[key]
 	if (ret) {
@@ -61,8 +62,10 @@ let state = (key, default_value, on_load = () => {}) => {
 	// @ts-ignore // TODO:
 	_states[key] = ret;
 	(async () => {
-		await ret.reload()
-		await nextTick()
+		if (! write_only) {
+			await ret.reload()
+			await nextTick()
+		}
 		on_load?.()
 	})()
 	return ret

web/src/data/store/actions.js

@@ -1,8 +1,9 @@
 import { computed } from 'vue'
 import default_git_actions from '../default-git-actions.json'
-import { combine_branches_from_branch_name, combine_branches_to_branch_name, config } from '../store'
+import { combine_branches_from_branch_name, combine_branches_to_branch_name } from '../store'
 import { git } from '../../bridge'
 import { default_origin } from '../store/repo'
+import config from '../store/config'
 
 /**
  * @param actions {ConfigGitAction[]}
@@ -12,7 +13,7 @@ import { default_origin } from '../store/repo'
 function apply_action_replacements(actions, replacements = []) {
 	let namespace = replacements.map(([k]) => k).join('-') || 'global'
 	let replacements_by_type = replacements.reduce((all, replacement) =>
-		/** tsc doesn't understand of this */ ((/** @type {any} */ (all)[typeof replacement[1]] ??= []).push(replacement), all), /** @type {{string:[string,string][], function:[string,()=>Promise<string>][]}} */ ({ string: [], function: [] })) // eslint-disable-line jsdoc/valid-types
+		/** tsc doesn't understand of this */ ((/** @type {any} */ (all)[typeof replacement[1]] ??= []).push(replacement), all), /** @type {{string:[string,string][], function:[string,()=>Promise<string>][]}} */ ({ string: [], function: [] }))
 	let apply_string_replacements = (/** @type {string} */ txt) =>
 		replacements_by_type.string.reduce((str, replacement) =>
 			str.replaceAll(replacement[0], replacement[1]), txt)
@@ -39,23 +40,27 @@ function apply_action_replacements(actions, replacements = []) {
 
 /** @type {Vue.Ref<GitAction[]>} */
 export let global_actions = computed(() =>
-	apply_action_replacements(default_git_actions['actions.global'].concat(config.value.actions?.global || [])))
+	apply_action_replacements(/** @type {ConfigGitAction[]} */ (default_git_actions['actions.global'])
+		.concat(config.get_git_actions('actions.global'))))
 export let commit_actions = (/** @type {string} */ hash) => computed(() => {
-	let config_commit_actions = default_git_actions['actions.commit'].concat(config.value.actions?.commit || [])
+	let config_commit_actions = /** @type {ConfigGitAction[]} */ (default_git_actions['actions.commit'])
+		.concat(config.get_git_actions('actions.commit'))
 	return apply_action_replacements(config_commit_actions, [
 		['{COMMIT_HASH}', hash],
 		['{COMMIT_BODY}', () =>
 			git(`show -s --format="%B" ${hash}`)],
 		['{DEFAULT_REMOTE_NAME}', default_origin.value || 'MISSING_REMOTE_NAME']])
 })
 export let commits_actions = (/** @type {string[]} */ hashes) => computed(() => {
-	let config_commits_actions = default_git_actions['actions.commits'].concat(config.value.actions?.commits || [])
+	let config_commits_actions = /** @type {ConfigGitAction[]} */ (default_git_actions['actions.commits'])
+		.concat(config.get_git_actions('actions.commits'))
 	return apply_action_replacements(config_commits_actions, [
 		['{COMMIT_HASHES}', hashes.join(' ')],
 		['{DEFAULT_REMOTE_NAME}', default_origin.value || 'MISSING_REMOTE_NAME']])
 })
 export let branch_actions = (/** @type {Branch} */ branch) => computed(() => {
-	let config_branch_actions = default_git_actions['actions.branch'].concat(config.value.actions?.branch || [])
+	let config_branch_actions = /** @type {ConfigGitAction[]} */ (default_git_actions['actions.branch'])
+		.concat(config.get_git_actions('actions.branch'))
 	return apply_action_replacements(config_branch_actions, [
 		['{BRANCH_ID}', branch.id],
 		['{BRANCH_DISPLAY_NAME}', branch.display_name],
@@ -65,19 +70,22 @@ export let branch_actions = (/** @type {Branch} */ branch) => computed(() => {
 		['{DEFAULT_REMOTE_NAME}', default_origin.value || 'MISSING_REMOTE_NAME']])
 })
 export let tag_actions = (/** @type {string} */ tag_name) => computed(() => {
-	let config_tag_actions = default_git_actions['actions.tag'].concat(config.value.actions?.tag || [])
+	let config_tag_actions = /** @type {ConfigGitAction[]} */ (default_git_actions['actions.tag'])
+		.concat(config.get_git_actions('actions.tag'))
 	return apply_action_replacements(config_tag_actions, [
 		['{TAG_NAME}', tag_name],
 		['{DEFAULT_REMOTE_NAME}', default_origin.value || 'MISSING_REMOTE_NAME']])
 })
 export let stash_actions = (/** @type {string} */ stash_name) => computed(() => {
-	let config_stash_actions = default_git_actions['actions.stash'].concat(config.value.actions?.stash || [])
+	let config_stash_actions = /** @type {ConfigGitAction[]} */ (default_git_actions['actions.stash'])
+		.concat(config.get_git_actions('actions.stash'))
 	return apply_action_replacements(config_stash_actions, [
 		['{STASH_NAME}', stash_name],
 		['{DEFAULT_REMOTE_NAME}', default_origin.value || 'MISSING_REMOTE_NAME']])
 })
 export let combine_branches_actions = computed(() => {
-	let config_combine_branches_actions = default_git_actions['actions.branch-drop'].concat(config.value.actions?.['branch-drop'] || [])
+	let config_combine_branches_actions = /** @type {ConfigGitAction[]} */ (default_git_actions['actions.branch-drop'])
+		.concat(config.get_git_actions('actions.branch-drop'))
 	return apply_action_replacements(config_combine_branches_actions, [
 		['{SOURCE_BRANCH_NAME}', combine_branches_from_branch_name.value],
 		['{TARGET_BRANCH_NAME}', combine_branches_to_branch_name.value],

web/src/data/store/config.js

@@ -0,0 +1,77 @@
+import state from '../state'
+
+// TODO: test with all set to null
+let config = state('config', {}).ref
+
+/** @returns {val is Record<string, unknown>} */
+let is_object = (/** @type {Json | undefined} */ val) =>
+	val !== null && typeof val === 'object' && ! Array.isArray(val)
+
+let get_json = (/** @type {string} */ key) =>
+	key.split('.')
+		.reduce((/** @type {Json | undefined} */ acc, sub_key) =>
+			is_object(acc) ? acc[sub_key] : null
+		, config.value) ?? null
+
+/** All getters support nested keys using `.` dot separation notation */
+export default {
+	get_string_array: (/** @type {string} */ key) => {
+		let val = get_json(key)
+		return Array.isArray(val) ? val.map(String) : []
+	},
+	get_string_map: (/** @type {string} */ key) => {
+		let val = get_json(key)
+		return is_object(val)
+			? Object.fromEntries(Object.entries(val).map(([k, v]) =>
+				[k, String(v)]))
+			: {}
+	},
+	get_number: (/** @type {string} */ key) =>
+		Number(get_json(key)) || 0,
+	get_string: (/** @type {string} */ key) =>
+		String(get_json(key)),
+	/** Undefined necessary in case `true` is supposed to be the default */
+	get_boolean_or_undefined: (/** @type {string} */ key) => {
+		let val = get_json(key)
+		return val === undefined ? undefined : Boolean(val)
+	},
+	/** @returns {ConfigGitAction[]} */
+	get_git_actions: (/** @type {string} */ key) => {
+		let val = get_json(key)
+		if (! Array.isArray(val))
+			return []
+		return val.map(v => {
+			if (! is_object(v))
+				return null
+			return {
+				title: String(v.title),
+				description: String(v.description),
+				info: String(v.info),
+				immediate: Boolean(v.immediate),
+				ignore_errors: Boolean(v.ignore_errors),
+				args: String(v.args),
+				icon: String(v.icon),
+				params: ! Array.isArray(v.params) ? [] : v.params.map(p =>
+					typeof p === 'string' ? p
+						: ! is_object(p) ? null
+							: {
+								value: String(p.value),
+								multiline: Boolean(p.multiline),
+								placeholder: String(p.placeholder),
+								readonly: Boolean(p.readonly),
+							})
+					.filter(is_truthy),
+				options: ! Array.isArray(v.options) ? [] : v.options.map(o =>
+					! is_object(o) ? null : {
+						value: String(o.value),
+						default_active: Boolean(o.default_active),
+						active: Boolean(o.active),
+						info: String(o.info),
+					}).filter(is_truthy),
+			}
+		}).filter(is_truthy)
+	},
+	_protected: {
+		ref: config,
+	},
+}

web/src/data/store/index.js

@@ -2,8 +2,9 @@ import { computed, nextTick, ref, watch } from 'vue'
 import { add_push_listener, show_information_message } from '../../bridge.js'
 import state, { refresh_repo_states } from '../state.js'
 import * as repo_store from './repo.js'
+import config from './config.js'
 
-export let web_phase = state('web-phase', 'initializing').ref
+export let web_phase = state('web-phase', 'initializing', undefined, { write_only: true }).ref
 
 /** @type {Vue.Ref<Readonly<Vue.ShallowRef<typeof import('../../components/GitInput.vue')|null>>|null>} */
 export let main_view_git_input_ref = ref(null)
@@ -29,14 +30,16 @@ export let _run_main_refresh = async (log_args, { fetch_stash_refs, fetch_branch
 	let preliminary_loading = false
 	if (web_phase.value === 'initializing')
 		web_phase.value = 'initializing_repo'
+	else if (web_phase.value === 'dead')
+		throw new Error('tried refreshing when webview is dead')
 	else if (web_phase.value !== 'initializing_repo')
 		web_phase.value = 'refreshing'
 	if (web_phase.value === 'initializing_repo') {
 		repo_store._protected.unset()
 		if (! selected_repo_path_is_valid.value)
 			return web_phase.value = 'ready'
 		refresh_repo_states()
-		preliminary_loading = ! config.value['disable-preliminary-loading']
+		preliminary_loading = ! config.get_boolean_or_undefined('disable-preliminary-loading')
 	}
 	await repo_store._protected.refresh(log_args, { preliminary_loading, fetch_stash_refs, fetch_branches })
 	web_phase.value = 'ready'
@@ -59,12 +62,8 @@ export let selected_repo_path = state('selected-repo-path', '', () => {
 /** @type {Vue.Ref<GitAction|null>} */
 export let selected_git_action = ref(null)
 
-// TODO: actual settings but with everything set to optional
-// TODO :test extension with all set to null
-export let config = state('config', {}).ref
-
 export let vis_v_width = computed(() =>
-	Number(config.value['branch-width']) || 10)
+	config.get_number('branch-width') || 10)
 export let vis_width = state('vis-width', 130).ref
 
 export let combine_branches_to_branch_name = ref('')
@@ -103,7 +102,7 @@ add_push_listener('repo-external-state-change', () => trigger_main_refresh())
 
 add_push_listener('refresh-main-view', () => trigger_main_refresh())
 
-watch(config, async () => {
+watch(config._protected.ref, async () => {
 	web_phase.value = 'initializing_repo'
 	trigger_main_refresh()
 })

web/src/data/store/repo.js

@@ -1,10 +1,10 @@
 import { computed, ref, watch } from 'vue'
 import { git, show_information_message } from '../../bridge.js'
 import { parse } from '../../utils/log-parser.js'
-import { config } from './index.js'
 import { _protected as search_protected } from './search'
 import state from '../state.js'
 import { update_commit_stats } from './commit-stats.js'
+import config from './config.js'
 
 /** @type {Vue.Ref<Commit[]|null>} */
 export let loaded_commits = ref(null)
@@ -67,15 +67,19 @@ async function git_log(/** @type {string} */ log_args, { fetch_stash_refs = true
 	/** @type {Awaited<ReturnType<parse>>} */
 	let parsed = { commits: [], branches: [] }
 	if (log_data)
-		parsed = await parse(log_data, branch_data, stash_data, sep, config.value['curve-radius'], config.value['branch-colors'], config.value['branch-color-strategy'] === 'name-based', config.value['branch-color-custom-mapping'])
+		parsed = await parse(log_data, branch_data, stash_data, sep,
+			config.get_number('curve-radius'),
+			config.get_string_array('branch-colors'),
+			config.get_string('branch-color-strategy') === 'name-based',
+			config.get_string_map('branch-color-custom-mapping'))
 	return parsed
 }
 /** @param log_args {string} @param options {{ preliminary_loading?: boolean, fetch_stash_refs?: boolean, fetch_branches?: boolean }} */
 let refresh = async (log_args, { preliminary_loading, fetch_stash_refs, fetch_branches }) => {
 	let preliminary_loading_promise = null
 	if (preliminary_loading)
-	// The "main" main log happens below, but because of the large default_log_action_n, this can take several seconds for large repos.
-	// This below is a bit of a pre-flight request optimized for speed to show the first few commits while the rest keeps loading in the background.
+		// The "main" main log happens below, but because of the large default_log_action_n, this can take several seconds for large repos.
+		// This below is a bit of a pre-flight request optimized for speed to show the first few commits while the rest keeps loading in the background.
 		preliminary_loading_promise = git_log(`${base_log_args} --author-date-order -n 100 --all`,
 			{ fetch_stash_refs: false, fetch_branches: false }).then((parsed) =>
 			loaded_commits.value = parsed.commits
@@ -112,7 +116,7 @@ watch(visible_commits, async () => {
 		commit.hash && ! commit.stats)
 	if (! visible_cp.length)
 		return
-	if (! config.value['disable-commit-stats'])
+	if (! config.get_boolean_or_undefined('disable-commit-stats'))
 		await update_commit_stats(visible_cp)
 })
 

web/src/views/main-view/CommitDetails.vue

@@ -103,9 +103,10 @@
 <script setup>
 import { ref, computed, watchEffect } from 'vue'
 import { git } from '../../bridge.js'
-import { config, show_branch } from '../../data/store/index.js'
+import { show_branch } from '../../data/store/index.js'
 import { commit_actions as commit_actions_, stash_actions as stash_actions_, branch_actions as branch_actions_, tag_actions as tag_actions_ } from '../../data/store/actions.js'
 import { filtered_commits, loaded_commits } from '../../data/store/repo.js'
+import config from '../../data/store/config.js'
 
 let props = defineProps({
 	commit: {
@@ -117,7 +118,7 @@ let props = defineProps({
 defineEmits(['hash_clicked'])
 
 let details_panel_position = computed(() =>
-	config.value['details-panel-position'])
+	config.get_string('details-panel-position'))
 
 let branch_tips = computed(() =>
 	props.commit.refs.filter(is_branch))
@@ -152,7 +153,7 @@ let tag_actions = computed(() => (/** @type {string} */ tag_name) =>
 	tag_actions_(tag_name).value)
 
 let config_show_buttons = computed(() =>
-	! config.value['hide-sidebar-buttons'])
+	! config.get_boolean_or_undefined('hide-sidebar-buttons'))
 
 let index_in_filtered_commits = computed(() =>
 	props.commit ? filtered_commits.value.indexOf(props.commit) : -1)