anonymousland-synapse/tests/storage/test_monthly_active_users.py

358 lines
14 KiB
Python
Raw Normal View History

2018-08-03 08:49:53 -04:00
# -*- coding: utf-8 -*-
# Copyright 2018 New Vector
#
# 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.
from mock import Mock
from twisted.internet import defer
2018-07-31 11:36:24 -04:00
from synapse.api.constants import UserTypes
2019-01-28 10:43:32 -05:00
from tests import unittest
from tests.unittest import default_config, override_config
2018-07-31 11:36:24 -04:00
FORTY_DAYS = 40 * 24 * 60 * 60
2018-07-31 11:36:24 -04:00
def gen_3pids(count):
"""Generate `count` threepids as a list."""
return [
{"medium": "email", "address": "user%i@matrix.org" % i} for i in range(count)
]
2019-01-28 10:43:32 -05:00
class MonthlyActiveUsersTestCase(unittest.HomeserverTestCase):
def default_config(self):
config = default_config("test")
config.update({"limit_usage_by_mau": True, "max_mau_value": 50})
2018-09-03 12:21:48 -04:00
# apply any additional config which was specified via the override_config
# decorator.
if self._extra_config is not None:
config.update(self._extra_config)
return config
def prepare(self, reactor, clock, homeserver):
self.store = homeserver.get_datastore()
2018-09-03 12:21:48 -04:00
# Advance the clock a bit
reactor.advance(FORTY_DAYS)
2018-07-31 11:36:24 -04:00
@override_config({"max_mau_value": 3, "mau_limit_reserved_threepids": gen_3pids(3)})
def test_initialise_reserved_users(self):
threepids = self.hs.config.mau_limits_reserved_threepids
# register three users, of which two have reserved 3pids, and a third
# which is a support user.
user1 = "@user1:server"
user1_email = threepids[0]["address"]
user2 = "@user2:server"
user2_email = threepids[1]["address"]
user3 = "@user3:server"
self.store.register_user(user_id=user1)
self.store.register_user(user_id=user2)
self.store.register_user(user_id=user3, user_type=UserTypes.SUPPORT)
2018-09-03 12:21:48 -04:00
self.pump()
now = int(self.hs.get_clock().time_msec())
2018-09-03 12:21:48 -04:00
self.store.user_add_threepid(user1, "email", user1_email, now, now)
self.store.user_add_threepid(user2, "email", user2_email, now, now)
# XXX why are we doing this here? this function is only run at startup
# so it is odd to re-run it here.
self.store.db.runInteraction(
2018-10-24 12:18:08 -04:00
"initialise", self.store._initialise_reserved_users, threepids
)
2018-09-03 12:21:48 -04:00
self.pump()
# the number of users we expect will be counted against the mau limit
# -1 because user3 is a support user and does not count
user_num = len(threepids) - 1
# Check the number of active users. Ensure user3 (support user) is not counted
active_count = self.get_success(self.store.get_monthly_active_count())
self.assertEquals(active_count, user_num)
# Test each of the registered users is marked as active
2018-09-03 12:21:48 -04:00
timestamp = self.store.user_last_seen_monthly_active(user1)
self.assertTrue(self.get_success(timestamp))
timestamp = self.store.user_last_seen_monthly_active(user2)
self.assertTrue(self.get_success(timestamp))
# Test that users with reserved 3pids are not removed from the MAU table
# XXX some of this is redundant. poking things into the config shouldn't
# work, and in any case it's not obvious what we expect to happen when
# we advance the reactor.
self.hs.config.max_mau_value = 0
2018-09-03 12:21:48 -04:00
self.reactor.advance(FORTY_DAYS)
self.hs.config.max_mau_value = 5
2018-09-03 12:21:48 -04:00
self.store.reap_monthly_active_users()
self.pump()
2018-09-03 12:21:48 -04:00
active_count = self.store.get_monthly_active_count()
self.assertEquals(self.get_success(active_count), user_num)
# Add some more users and check they are counted as active
ru_count = 2
2018-09-03 12:21:48 -04:00
self.store.upsert_monthly_active_user("@ru1:server")
self.store.upsert_monthly_active_user("@ru2:server")
self.pump()
active_count = self.store.get_monthly_active_count()
self.assertEqual(self.get_success(active_count), user_num + ru_count)
# now run the reaper and check that the number of active users is reduced
# to max_mau_value
2018-09-03 12:21:48 -04:00
self.store.reap_monthly_active_users()
self.pump()
2018-09-03 12:21:48 -04:00
active_count = self.store.get_monthly_active_count()
self.assertEquals(self.get_success(active_count), 3)
2018-07-31 11:36:24 -04:00
def test_can_insert_and_count_mau(self):
2018-09-03 12:21:48 -04:00
count = self.store.get_monthly_active_count()
self.assertEqual(0, self.get_success(count))
2018-07-31 11:36:24 -04:00
2018-09-03 12:21:48 -04:00
self.store.upsert_monthly_active_user("@user:server")
self.pump()
2018-07-31 11:36:24 -04:00
2018-09-03 12:21:48 -04:00
count = self.store.get_monthly_active_count()
self.assertEqual(1, self.get_success(count))
2018-07-31 11:36:24 -04:00
2018-08-09 13:02:12 -04:00
def test_user_last_seen_monthly_active(self):
2018-07-31 11:36:24 -04:00
user_id1 = "@user1:server"
user_id2 = "@user2:server"
user_id3 = "@user3:server"
2018-08-09 13:02:12 -04:00
2018-09-03 12:21:48 -04:00
result = self.store.user_last_seen_monthly_active(user_id1)
self.assertFalse(self.get_success(result) == 0)
self.store.upsert_monthly_active_user(user_id1)
self.store.upsert_monthly_active_user(user_id2)
self.pump()
result = self.store.user_last_seen_monthly_active(user_id1)
self.assertGreater(self.get_success(result), 0)
result = self.store.user_last_seen_monthly_active(user_id3)
self.assertNotEqual(self.get_success(result), 0)
2018-08-03 08:49:53 -04:00
@override_config({"max_mau_value": 5})
2018-08-03 08:49:53 -04:00
def test_reap_monthly_active_users(self):
initial_users = 10
for i in range(initial_users):
2018-09-03 12:21:48 -04:00
self.store.upsert_monthly_active_user("@user%d:server" % i)
self.pump()
count = self.store.get_monthly_active_count()
self.assertTrue(self.get_success(count), initial_users)
self.store.reap_monthly_active_users()
self.pump()
count = self.store.get_monthly_active_count()
self.assertEquals(self.get_success(count), self.hs.config.max_mau_value)
2018-09-03 12:21:48 -04:00
self.reactor.advance(FORTY_DAYS)
self.store.reap_monthly_active_users()
self.pump()
count = self.store.get_monthly_active_count()
self.assertEquals(self.get_success(count), 0)
# Note that below says mau_limit (no s), this is the name of the config
# value, although it gets stored on the config object as mau_limits.
@override_config({"max_mau_value": 5, "mau_limit_reserved_threepids": gen_3pids(5)})
def test_reap_monthly_active_users_reserved_users(self):
""" Tests that reaping correctly handles reaping where reserved users are
present"""
threepids = self.hs.config.mau_limits_reserved_threepids
initial_users = len(threepids)
reserved_user_number = initial_users - 1
for i in range(initial_users):
user = "@user%d:server" % i
email = "user%d@matrix.org" % i
self.get_success(self.store.upsert_monthly_active_user(user))
# Need to ensure that the most recent entries in the
# monthly_active_users table are reserved
now = int(self.hs.get_clock().time_msec())
if i != 0:
self.get_success(
self.store.register_user(user_id=user, password_hash=None)
)
self.get_success(
self.store.user_add_threepid(user, "email", email, now, now)
)
self.store.db.runInteraction(
"initialise", self.store._initialise_reserved_users, threepids
)
count = self.store.get_monthly_active_count()
self.assertTrue(self.get_success(count), initial_users)
users = self.store.get_registered_reserved_users()
self.assertEquals(len(self.get_success(users)), reserved_user_number)
self.get_success(self.store.reap_monthly_active_users())
count = self.store.get_monthly_active_count()
self.assertEquals(self.get_success(count), self.hs.config.max_mau_value)
def test_populate_monthly_users_is_guest(self):
# Test that guest users are not added to mau list
user_id = "@user_id:host"
self.store.register_user(user_id=user_id, password_hash=None, make_guest=True)
self.store.upsert_monthly_active_user = Mock()
2018-09-06 12:22:53 -04:00
self.store.populate_monthly_active_users(user_id)
self.pump()
self.store.upsert_monthly_active_user.assert_not_called()
def test_populate_monthly_users_should_update(self):
self.store.upsert_monthly_active_user = Mock()
2019-05-10 01:12:11 -04:00
self.store.is_trial_user = Mock(return_value=defer.succeed(False))
self.store.user_last_seen_monthly_active = Mock(
return_value=defer.succeed(None)
)
2019-06-20 05:32:02 -04:00
self.store.populate_monthly_active_users("user_id")
self.pump()
self.store.upsert_monthly_active_user.assert_called_once()
def test_populate_monthly_users_should_not_update(self):
self.store.upsert_monthly_active_user = Mock()
2019-05-10 01:12:11 -04:00
self.store.is_trial_user = Mock(return_value=defer.succeed(False))
self.store.user_last_seen_monthly_active = Mock(
2019-05-10 01:12:11 -04:00
return_value=defer.succeed(self.hs.get_clock().time_msec())
)
2019-06-20 05:32:02 -04:00
self.store.populate_monthly_active_users("user_id")
self.pump()
self.store.upsert_monthly_active_user.assert_not_called()
2018-09-12 06:58:52 -04:00
def test_get_reserved_real_user_account(self):
# Test no reserved users, or reserved threepids
users = self.get_success(self.store.get_registered_reserved_users())
self.assertEquals(len(users), 0)
2018-09-12 06:58:52 -04:00
# Test reserved users but no registered users
2019-06-20 05:32:02 -04:00
user1 = "@user1:example.com"
user2 = "@user2:example.com"
2019-06-20 05:32:02 -04:00
user1_email = "user1@example.com"
user2_email = "user2@example.com"
2018-09-12 06:58:52 -04:00
threepids = [
2019-06-20 05:32:02 -04:00
{"medium": "email", "address": user1_email},
{"medium": "email", "address": user2_email},
2018-09-12 06:58:52 -04:00
]
self.hs.config.mau_limits_reserved_threepids = threepids
self.store.db.runInteraction(
2018-10-24 12:18:08 -04:00
"initialise", self.store._initialise_reserved_users, threepids
)
2018-09-12 06:58:52 -04:00
self.pump()
users = self.get_success(self.store.get_registered_reserved_users())
self.assertEquals(len(users), 0)
2018-09-12 06:58:52 -04:00
# Test reserved registed users
self.store.register_user(user_id=user1, password_hash=None)
self.store.register_user(user_id=user2, password_hash=None)
2018-09-12 06:58:52 -04:00
self.pump()
now = int(self.hs.get_clock().time_msec())
self.store.user_add_threepid(user1, "email", user1_email, now, now)
self.store.user_add_threepid(user2, "email", user2_email, now, now)
users = self.get_success(self.store.get_registered_reserved_users())
self.assertEquals(len(users), len(threepids))
def test_support_user_not_add_to_mau_limits(self):
support_user_id = "@support:test"
count = self.store.get_monthly_active_count()
self.pump()
self.assertEqual(self.get_success(count), 0)
self.store.register_user(
user_id=support_user_id, password_hash=None, user_type=UserTypes.SUPPORT
)
self.store.upsert_monthly_active_user(support_user_id)
count = self.store.get_monthly_active_count()
self.pump()
self.assertEqual(self.get_success(count), 0)
# Note that the max_mau_value setting should not matter.
@override_config(
{"limit_usage_by_mau": False, "mau_stats_only": True, "max_mau_value": 1}
)
def test_track_monthly_users_without_cap(self):
count = self.store.get_monthly_active_count()
self.assertEqual(0, self.get_success(count))
self.store.upsert_monthly_active_user("@user1:server")
self.store.upsert_monthly_active_user("@user2:server")
self.pump()
count = self.store.get_monthly_active_count()
self.assertEqual(2, self.get_success(count))
@override_config({"limit_usage_by_mau": False, "mau_stats_only": False})
def test_no_users_when_not_tracking(self):
self.store.upsert_monthly_active_user = Mock()
self.store.populate_monthly_active_users("@user:sever")
self.pump()
self.store.upsert_monthly_active_user.assert_not_called()
def test_get_monthly_active_count_by_service(self):
appservice1_user1 = "@appservice1_user1:example.com"
appservice1_user2 = "@appservice1_user2:example.com"
appservice2_user1 = "@appservice2_user1:example.com"
native_user1 = "@native_user1:example.com"
service1 = "service1"
service2 = "service2"
native = "native"
self.store.register_user(
user_id=appservice1_user1, password_hash=None, appservice_id=service1
)
self.store.register_user(
user_id=appservice1_user2, password_hash=None, appservice_id=service1
)
self.store.register_user(
user_id=appservice2_user1, password_hash=None, appservice_id=service2
)
self.store.register_user(user_id=native_user1, password_hash=None)
self.pump()
count = self.store.get_monthly_active_count_by_service()
self.assertEqual({}, self.get_success(count))
self.store.upsert_monthly_active_user(native_user1)
self.store.upsert_monthly_active_user(appservice1_user1)
self.store.upsert_monthly_active_user(appservice1_user2)
self.store.upsert_monthly_active_user(appservice2_user1)
self.pump()
count = self.store.get_monthly_active_count()
self.assertEqual(4, self.get_success(count))
count = self.store.get_monthly_active_count_by_service()
result = self.get_success(count)
self.assertEqual(2, result[service1])
self.assertEqual(1, result[service2])
self.assertEqual(1, result[native])