Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Improve comments in StateGroupBackgroundUpdateStore. (#16383)
Browse files Browse the repository at this point in the history
  • Loading branch information
clokep authored Sep 25, 2023
1 parent 9fd18e9 commit 2763c49
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
1 change: 1 addition & 0 deletions changelog.d/16383.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve comments in `StateGroupBackgroundUpdateStore`.
18 changes: 16 additions & 2 deletions synapse/storage/databases/state/bg_updates.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,18 @@ def _get_state_groups_from_groups_txn(
groups: List[int],
state_filter: Optional[StateFilter] = None,
) -> Mapping[int, StateMap[str]]:
"""
Given a number of state groups, fetch the latest state for each group.
Args:
txn: The transaction object.
groups: The given state groups that you want to fetch the latest state for.
state_filter: The state filter to apply the state we fetch state from the database.
Returns:
Map from state_group to a StateMap at that point.
"""

state_filter = state_filter or StateFilter.all()

results: Dict[int, MutableStateMap[str]] = {group: {} for group in groups}
Expand Down Expand Up @@ -206,8 +218,10 @@ def _get_state_groups_from_groups_txn(
if where_clause:
where_clause = " AND (%s)" % (where_clause,)

# We don't use WITH RECURSIVE on sqlite3 as there are distributions
# that ship with an sqlite3 version that doesn't support it (e.g. wheezy)
# XXX: We could `WITH RECURSIVE` here since it's supported on SQLite 3.8.3
# or higher and our minimum supported version is greater than that.
#
# We just haven't put in the time to refactor this.
for group in groups:
next_group: Optional[int] = group

Expand Down

0 comments on commit 2763c49

Please sign in to comment.