watcha-synapse/synapse/storage/roommember.py

# -*- coding: utf-8 -*-
# Copyright 2014-2016 OpenMarket Ltd
# Copyright 2018 New Vector Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import logging
from collections import namedtuple

logger = logging.getLogger(__name__)


RoomsForUser = namedtuple(
    "RoomsForUser", ("room_id", "sender", "membership", "event_id", "stream_ordering")
)

GetRoomsForUserWithStreamOrdering = namedtuple(
    "_GetRoomsForUserWithStreamOrdering", ("room_id", "event_pos")
)


# We store this using a namedtuple so that we save about 3x space over using a
# dict.
ProfileInfo = namedtuple("ProfileInfo", ("avatar_url", "display_name"))

# "members" points to a truncated list of (user_id, event_id) tuples for users of
# a given membership type, suitable for use in calculating heroes for a room.
# "count" points to the total numberr of users of a given membership type.
MemberSummary = namedtuple("MemberSummary", ("members", "count"))
Reference Matrix Home Server 10 years ago			`# -- coding: utf-8 --`
copyrights 9 years ago			`# Copyright 2014-2016 OpenMarket Ltd`
Update copyright 7 years ago			`# Copyright 2018 New Vector Ltd`
Reference Matrix Home Server 10 years ago			`#`
			`# Licensed under the Apache License, Version 2.0 (the "License");`
			`# you may not use this file except in compliance with the License.`
			`# You may obtain a copy of the License at`
			`#`
			`# http://www.apache.org/licenses/LICENSE-2.0`
			`#`
			`# Unless required by applicable law or agreed to in writing, software`
			`# distributed under the License is distributed on an "AS IS" BASIS,`
			`# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.`
			`# See the License for the specific language governing permissions and`
			`# limitations under the License.`
add in whitespace after copyright statements to improve legibility 10 years ago
run isort 6 years ago			`import logging`
We don't need the full events for get_rooms_for_user_where_membership_is 10 years ago			`from collections import namedtuple`

Reference Matrix Home Server 10 years ago			`logger = logging.getLogger(__name__)`


We don't need the full events for get_rooms_for_user_where_membership_is 10 years ago			`RoomsForUser = namedtuple(`
Run `black` on some storage modules that the stats branch touches (#4959) 6 years ago			`"RoomsForUser", ("room_id", "sender", "membership", "event_id", "stream_ordering")`
We don't need the full events for get_rooms_for_user_where_membership_is 10 years ago			`)`

Fix race in sync when joining room The race happens when the user joins a room at the same time as doing a sync. We fetch the current token and then get the rooms the user is in. If the join happens after the current token, but before we get the rooms we end up sending down a partial room entry in the sync. This is fixed by looking at the stream ordering of the membership returned by get_rooms_for_user, and handling the case when that stream ordering is after the current token. 7 years ago			`GetRoomsForUserWithStreamOrdering = namedtuple(`
Add EventStreamPosition type (#8388) The idea is to remove some of the places we pass around `int`, where it can represent one of two things: 1. the position of an event in the stream; or 2. a token that partitions the stream, used as part of the stream tokens. The valid operations are then: 1. did a position happen before or after a token; 2. get all events that happened before or after a token; and 3. get all events between two tokens. (Note that we don't want to allow other operations as we want to change the tokens to be vector clocks rather than simple ints) 4 years ago			`"_GetRoomsForUserWithStreamOrdering", ("room_id", "event_pos")`
Fix race in sync when joining room The race happens when the user joins a room at the same time as doing a sync. We fetch the current token and then get the rooms the user is in. If the join happens after the current token, but before we get the rooms we end up sending down a partial room entry in the sync. This is fixed by looking at the stream ordering of the membership returned by get_rooms_for_user, and handling the case when that stream ordering is after the current token. 7 years ago			`)`

We don't need the full events for get_rooms_for_user_where_membership_is 10 years ago
Comment 8 years ago			`# We store this using a namedtuple so that we save about 3x space over using a`
			`# dict.`
Run `black` on some storage modules that the stats branch touches (#4959) 6 years ago			`ProfileInfo = namedtuple("ProfileInfo", ("avatar_url", "display_name"))`
Reduce size of joined_user cache The _get_joined_users_from_context cache stores a mapping from user_id to avatar_url and display_name. Instead of storing those in a dict, store them in a namedtuple as that uses much less memory. We also try converting the string to ascii to further reduce the size. 8 years ago
Speed up lazy loading (#3827) * speed up room summaries by pulling their data from room_memberships rather than room state * disable LL for incr syncs, and log incr sync stats (#3840) 6 years ago			`# "members" points to a truncated list of (user_id, event_id) tuples for users of`
			`# a given membership type, suitable for use in calculating heroes for a room.`
			`# "count" points to the total numberr of users of a given membership type.`
Run `black` on some storage modules that the stats branch touches (#4959) 6 years ago			`MemberSummary = namedtuple("MemberSummary", ("members", "count"))`