Files
Panama/tests/quickshell/settings-page-registry-contract.sh
T
Gabriel Brown 99433c0e8e Add a Storage page
Nothing showed what was using the drive, and removable media was handled
by a tray helper with no surface in Settings at all.

One scroll rather than tabs: space above, the device below. Every other
settings page is a scrolling card stack, and a tab would not be
deep-linkable from the launcher command or from search.

Three things the page has to get right, each now pinned by a contract,
because each is a way it could quietly lie. / and /home are one btrfs
filesystem sharing one pool of free space, and a page that copies df
shows double the free space that exists. zram is a block device and is
not storage; counting it as a drive overstates this machine by 8 GB.
Unmount and eject refuse anything not on a removable drive, because the
UI is what asks and a UI can be wrong.

The cheap read -- layout, usage, health -- runs when the page opens, at
around 90ms. Measuring what is filling the drive means walking every
file, so it happens on request and says so rather than showing an empty
list that reads as "nothing here".

Partitioning and formatting are deliberately absent. A settings pane is
the wrong place to put erasing a disk two clicks deep; the page opens
GNOME Disks for that.

Adding the page found a fourth hard-coded page list in ShellState. A
page missing from it does not error -- openSettings() falls back to
"home", so the launcher opens the wrong page and logs nothing. A
registry contract now holds the three lists together.

Claude-Session: https://claude.ai/code/session_01BRvzt4H8XXLPVH5MyYdk9L
2026-08-19 10:52:10 -04:00

61 lines
2.6 KiB
Bash
Executable File

#!/usr/bin/env bash
# A settings page is declared in three places that cannot see each other:
#
# SettingsSidebar.qml the list someone clicks
# SettingsShell.qml the switch that decides which component to build
# ShellState.qml the allow-list that IPC and the launcher go through
#
# Miss one and the failure is silent in the worst way. A page missing from the
# allow-list does not error -- openSettings() falls back to "home", so the
# launcher command opens Settings on the wrong page and logs nothing. That is
# exactly what happened when Storage was added.
#
# Static and read-only; it parses three files.
set -uo pipefail
repo_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
shell_dir="$repo_dir/config/dot/quickshell"
sidebar="$shell_dir/modules/settings/SettingsSidebar.qml"
shell_file="$shell_dir/modules/settings/SettingsShell.qml"
state="$shell_dir/services/ShellState.qml"
fail() {
printf 'settings page registry contract: %s\n' "$1" >&2
exit 1
}
for path in "$sidebar" "$shell_file" "$state"; do
[[ -r "$path" ]] || fail "missing $path"
done
listed="$(grep -oE '\{ page: "[a-z-]+"' "$sidebar" | sed 's/.*"\([a-z-]*\)"/\1/' | sort -u)"
routed="$(grep -oE 'case "[a-z-]+": return [a-zA-Z]+Page;' "$shell_file" \
| sed 's/case "\([a-z-]*\)".*/\1/' | sort -u)"
allowed="$(sed -n 's/.*const allowed = \[\(.*\)\];/\1/p' "$state" \
| tr ',' '\n' | tr -d ' "' | grep -v '^$' | sort -u)"
[[ -n "$listed" ]] || fail 'no pages found in the sidebar'
[[ -n "$routed" ]] || fail 'no pages found in the shell switch'
[[ -n "$allowed" ]] || fail 'no allow-list found in ShellState'
# "home" is the fallback: it is routed by `default:` rather than a case, so it
# is legitimately absent from the switch.
routed="$(printf '%s\nhome\n' "$routed" | sort -u)"
missing_route="$(comm -23 <(printf '%s\n' "$listed") <(printf '%s\n' "$routed") | tr '\n' ' ')"
[[ -z "${missing_route// }" ]] \
|| fail "these pages are in the sidebar but the shell has no case for them, so they render as Home: $missing_route"
missing_allow="$(comm -23 <(printf '%s\n' "$listed") <(printf '%s\n' "$allowed") | tr '\n' ' ')"
[[ -z "${missing_allow// }" ]] \
|| fail "these pages are in the sidebar but not in ShellState's allow-list, so opening them by IPC silently lands on Home: $missing_allow"
orphan_allow="$(comm -13 <(printf '%s\n' "$listed") <(printf '%s\n' "$allowed") | tr '\n' ' ')"
[[ -z "${orphan_allow// }" ]] \
|| fail "ShellState allows pages the sidebar does not have: $orphan_allow"
printf 'settings page registry contract: PASS (%d pages agree across three files)\n' \
"$(grep -c . <<<"$listed")"