agama-project / agama / 28577280695

83%

Build Type

push

github

Committed by web-flow

Commit Message

refactor(web): make progress-tracking query waits explicit per page (#3674)

## Problem

The current progress tracking implementation has a design flaw where all
pages automatically wait for the "common proposal keys" (i.e.,
`proposal` and `extendedConfig`) to refetch, even when those keys are
not relevant to the operation being tracked.

This causes a bug with iSCSI discovery in which the progress backdrop
displays "Refreshing data..." indefinitely because:

1. The discovery operation completes and signals the `iscsi` scope.
2. The progress tracking automatically waits for `COMMON_PROPOSAL_KEYS`
to refetch.
3. But discovery doesn't trigger a proposal change, so those queries
never refetch.
4. The backdrop never dismisses, blocking user interaction.

See https://bugzilla.suse.com/show_bug.cgi?id=1269224.

As proposals come and go, the assumption that every operation affects
the proposal becomes increasingly incorrect. Moreover, the upcoming
architectural changes where some proposals might disappear make this
assumption even more problematic, see check
https://trello.com/c/jTgiokbJ.

## Solution

The solution is to make query-key subscriptions fully explicit, so each
page declares exactly the queries it depends on. In other words, remove
COMMON_PROPOSAL_KEYS and replace the `ensureRefetched` prop (which adds
to the default common keys) with an `awaitQueriesRefetch` prop (which
specifies all keys explicitly, with no defaults).

While the proposed change introduces additional verbosity by requiring
each consumer to explicitly specify the query keys it depends on, it
also makes those dependencies explicit, resulting in a more robust and
future-proof design.

Note: some flaws were detected in the progress tracking, but it is out
of the scope of this PR, see
https://trello.com/c/3WLwI010/2400-improve-progress-tracking.

---

Assisted by Claude Sonnet 4.5

Coverage Stats

4884 of 6797 branches covered (71.86%)

Branch coverage included in aggregate %.

68 of 69 new or added lines in 22 files covered. (98.55%)

51 existing lines in 14 files now uncovered.

25477 of 29690 relevant lines covered (85.81%)

123.88 hits per line