keyboard: improve Toshy Kanata device recovery

Author: 4evy

.gitignore

@@ -27,6 +27,8 @@ result
 !/packages/
 !/packages/**
 /packages/**/.DS_Store
+**/__pycache__/
+**/*.py[cod]
 node_modules/
 **/node_modules/
 

ansible/files/scripts/host/keyboard/kanata.service

@@ -24,7 +24,6 @@ LockPersonality=true
 MemoryDenyWriteExecute=true
 NoNewPrivileges=true
 PrivateNetwork=true
-PrivateUsers=true
 ProcSubset=pid
 ProtectClock=true
 ProtectControlGroups=true

ansible/files/scripts/host/keyboard/toshy-kanata-chain.sh

@@ -24,6 +24,7 @@ config_path=$(run_host_user_bash "printf \"%s\n\" \"\${XDG_CONFIG_HOME:-\$HOME/.
 require_file "$toshy_automation"
 require_file "$toshy_slice_merger"
 require_file "$toshy_slice_dir/keymapper_api.py"
+require_file "$toshy_slice_dir/kbtype_override.py"
 require_file "$toshy_slice_dir/barebones_user_cfg.py"
 
 ensure_dir "$toshy_root"

ansible/files/scripts/host/keyboard/toshy-kanata-check.sh

@@ -60,6 +60,13 @@ fi
 check_system_service_active kanata-main.service
 check_user_service_active toshy-config.service
 
+if systemctl cat kanata-main.service 2>/dev/null |
+	grep -Fq 'PrivateUsers=true'; then
+	fail "kanata-main.service uses PrivateUsers=true, which can hide input/uinput supplemental groups"
+else
+	ok "kanata-main.service does not isolate host input/uinput groups with PrivateUsers"
+fi
+
 if [[ -f $repo_kanata_config && -f $host_kanata_config ]]; then
 	if cmp -s "$repo_kanata_config" "$host_kanata_config"; then
 		ok "$host_kanata_config matches the dotfiles Kanata config"
@@ -87,8 +94,10 @@ fi
 toshy_config="${XDG_CONFIG_HOME:-$HOME/.config}/toshy/toshy_config.py"
 if [[ -f $toshy_config ]]; then
 	if grep -Fq 'SLICE_MARK_START: keymapper_api' "$toshy_config" &&
+		grep -Fq 'SLICE_MARK_START: kbtype_override' "$toshy_config" &&
 		grep -Fq 'DOTFILES_TOSHY_ONLY_DEVICES' "$toshy_config" &&
-		grep -Fq '/run/kanata-main/main' "$toshy_config"; then
+		grep -Fq '/run/kanata-main/main' "$toshy_config" &&
+		grep -Fq 'dotfiles-kanata-main' "$toshy_config"; then
 		ok "Toshy config includes dotfiles Kanata device slice"
 	else
 		fail "Toshy config does not include the dotfiles Kanata device slice"
@@ -118,12 +127,23 @@ else
 fi
 
 if systemctl --user cat toshy-kanata-device.path 2>/dev/null |
-	grep -Fxq 'PathChanged=/run/kanata-main'; then
+	grep -Fxq 'PathChanged=/run/kanata-main/main'; then
 	ok "toshy-kanata-device.path watches the Kanata virtual device"
 else
 	fail "toshy-kanata-device.path is missing the Kanata virtual device watch"
 fi
 
+if systemctl --user cat toshy-kanata-device.service 2>/dev/null |
+	grep -Fq 'reset-failed toshy-config.service' &&
+	systemctl --user cat toshy-kanata-device.service 2>/dev/null |
+	grep -Fq '[ -e /run/kanata-main/main ]' &&
+	systemctl --user cat toshy-kanata-device.service 2>/dev/null |
+	grep -Fq 'restart toshy-config.service'; then
+	ok "toshy-kanata-device.service can recover a failed Toshy service"
+else
+	fail "toshy-kanata-device.service does not recover failed Toshy starts"
+fi
+
 if systemctl cat input-remapper.service >/dev/null 2>&1; then
 	if [[ ${DOTFILES_KEEP_INPUT_REMAPPER:-0} == 1 ]]; then
 		warn "input-remapper.service exists and keep flag is set; skipping conflict check"

ansible/files/scripts/host/keyboard/toshy-kanata-device.path

@@ -3,7 +3,7 @@ Description=Watch Kanata virtual keyboard for Toshy
 Documentation=https://github.com/RedBearAK/Toshy https://github.com/jtroo/kanata
 
 [Path]
-PathChanged=/run/kanata-main
+PathChanged=/run/kanata-main/main
 Unit=toshy-kanata-device.service
 
 [Install]

ansible/files/scripts/host/keyboard/toshy-kanata-device.service

@@ -4,4 +4,4 @@ Documentation=https://github.com/RedBearAK/Toshy https://github.com/jtroo/kanata
 
 [Service]
 Type=oneshot
-ExecStart=/bin/sh -c 'systemctl --user is-active --quiet toshy-config.service && systemctl --user restart toshy-config.service || true'
+ExecStart=/bin/sh -c 'systemctl --user reset-failed toshy-config.service || true; [ -e /run/kanata-main/main ] || exit 0; if systemctl --user is-active --quiet toshy-config.service || systemctl --user is-enabled --quiet toshy-config.service; then systemctl --user restart toshy-config.service; fi'

ansible/files/scripts/host/keyboard/toshy-merge.host.sh

@@ -20,6 +20,10 @@ if [[ ! -d $slice_dir ]]; then
 	printf "%s\n" "toshy-kanata-chain: Toshy slice directory was not found at $slice_dir" >&2
 	exit 1
 fi
+if [[ ! -f $dropin_source ]]; then
+	printf "%s\n" "toshy-kanata-chain: Toshy Kanata drop-in was not found at $dropin_source" >&2
+	exit 1
+fi
 if [[ ! -f $path_unit_source ]]; then
 	printf "%s\n" "toshy-kanata-chain: Toshy Kanata path unit was not found at $path_unit_source" >&2
 	exit 1
@@ -35,8 +39,10 @@ service_dropin_dir="${XDG_CONFIG_HOME:-$HOME/.config}/systemd/user/toshy-config.
 
 ensure_dirs "$config_dir" "$service_dir" "$service_dropin_dir"
 python3 "$slice_merger" "$config_path" "$slice_dir"
+python3 -m py_compile "$config_path"
 install_file_if_changed "$dropin_source" "$service_dropin_dir/10-dotfiles.conf"
 install_file_if_changed "$path_unit_source" "$service_dir/toshy-kanata-device.path"
 install_file_if_changed "$refresh_unit_source" "$service_dir/toshy-kanata-device.service"
 systemctl --user daemon-reload || true
 systemctl --user enable --now toshy-kanata-device.path || true
+systemctl --user start toshy-kanata-device.service || true

dotfiles/dot_config/kanata/kanata.kbd

@@ -1,6 +1,7 @@
 (defcfg
   process-unmapped-keys yes
   log-layer-changes yes
+  linux-output-device-name "dotfiles-kanata-main"
   linux-dev-names-include (
     "ITE Tech. Inc. ITE Device(8910) Keyboard"
     "LIFT Mouse"

packages/toshy/slices/kbtype_override.py

@@ -0,0 +1,5 @@
+keyboards_UserCustom_dct = {
+    "kanata": "Windows",
+    "kanata output": "Windows",
+    "dotfiles-kanata-main": "Windows",
+}