mirror of
https://mau.dev/maunium/synapse.git
synced 2024-08-23 18:56:10 +00:00
api into monthly_active_users table
This commit is contained in:
parent
82977477e3
commit
6ef983ce5c
@ -62,6 +62,7 @@ from synapse.rest.media.v0.content_repository import ContentRepoResource
|
|||||||
from synapse.server import HomeServer
|
from synapse.server import HomeServer
|
||||||
from synapse.storage import are_all_users_on_domain
|
from synapse.storage import are_all_users_on_domain
|
||||||
from synapse.storage.engines import IncorrectDatabaseSetup, create_engine
|
from synapse.storage.engines import IncorrectDatabaseSetup, create_engine
|
||||||
|
from synapse.storage.monthly_active_users import MonthlyActiveUsersStore
|
||||||
from synapse.storage.prepare_database import UpgradeDatabaseException, prepare_database
|
from synapse.storage.prepare_database import UpgradeDatabaseException, prepare_database
|
||||||
from synapse.util.caches import CACHE_SIZE_FACTOR
|
from synapse.util.caches import CACHE_SIZE_FACTOR
|
||||||
from synapse.util.httpresourcetree import create_resource_tree
|
from synapse.util.httpresourcetree import create_resource_tree
|
||||||
@ -511,6 +512,9 @@ def run(hs):
|
|||||||
# If you increase the loop period, the accuracy of user_daily_visits
|
# If you increase the loop period, the accuracy of user_daily_visits
|
||||||
# table will decrease
|
# table will decrease
|
||||||
clock.looping_call(generate_user_daily_visit_stats, 5 * 60 * 1000)
|
clock.looping_call(generate_user_daily_visit_stats, 5 * 60 * 1000)
|
||||||
|
clock.looping_call(
|
||||||
|
MonthlyActiveUsersStore(hs).reap_monthly_active_users, 1000 * 60 * 60
|
||||||
|
)
|
||||||
|
|
||||||
if hs.config.report_stats:
|
if hs.config.report_stats:
|
||||||
logger.info("Scheduling stats reporting for 3 hour intervals")
|
logger.info("Scheduling stats reporting for 3 hour intervals")
|
||||||
|
89
synapse/storage/monthly_active_users.py
Normal file
89
synapse/storage/monthly_active_users.py
Normal file
@ -0,0 +1,89 @@
|
|||||||
|
from twisted.internet import defer
|
||||||
|
|
||||||
|
from ._base import SQLBaseStore
|
||||||
|
|
||||||
|
|
||||||
|
class MonthlyActiveUsersStore(SQLBaseStore):
|
||||||
|
def __init__(self, hs):
|
||||||
|
super(MonthlyActiveUsersStore, self).__init__(None, hs)
|
||||||
|
self._clock = hs.get_clock()
|
||||||
|
|
||||||
|
def reap_monthly_active_users(self):
|
||||||
|
"""
|
||||||
|
Cleans out monthly active user table to ensure that no stale
|
||||||
|
entries exist.
|
||||||
|
Return:
|
||||||
|
defered, no return type
|
||||||
|
"""
|
||||||
|
def _reap_users(txn):
|
||||||
|
thirty_days_ago = (
|
||||||
|
int(self._clock.time_msec()) - (1000 * 60 * 60 * 24 * 30)
|
||||||
|
)
|
||||||
|
sql = "DELETE FROM monthly_active_users WHERE timestamp < ?"
|
||||||
|
txn.execute(sql, (thirty_days_ago,))
|
||||||
|
|
||||||
|
return self.runInteraction("reap_monthly_active_users", _reap_users)
|
||||||
|
|
||||||
|
def get_monthly_active_count(self):
|
||||||
|
"""
|
||||||
|
Generates current count of monthly active users.abs
|
||||||
|
return:
|
||||||
|
defered resolves to int
|
||||||
|
"""
|
||||||
|
def _count_users(txn):
|
||||||
|
sql = """
|
||||||
|
SELECT COALESCE(count(*), 0) FROM (
|
||||||
|
SELECT user_id FROM monthly_active_users
|
||||||
|
) u
|
||||||
|
"""
|
||||||
|
txn.execute(sql)
|
||||||
|
count, = txn.fetchone()
|
||||||
|
return count
|
||||||
|
return self.runInteraction("count_users", _count_users)
|
||||||
|
|
||||||
|
def upsert_monthly_active_user(self, user_id):
|
||||||
|
"""
|
||||||
|
Updates or inserts monthly active user member
|
||||||
|
Arguments:
|
||||||
|
user_id (str): user to add/update
|
||||||
|
"""
|
||||||
|
return self._simple_upsert(
|
||||||
|
desc="upsert_monthly_active_user",
|
||||||
|
table="monthly_active_users",
|
||||||
|
keyvalues={
|
||||||
|
"user_id": user_id,
|
||||||
|
},
|
||||||
|
values={
|
||||||
|
"timestamp": int(self._clock.time_msec()),
|
||||||
|
},
|
||||||
|
lock=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
def clean_out_monthly_active_users(self):
|
||||||
|
pass
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def is_user_monthly_active(self, user_id):
|
||||||
|
"""
|
||||||
|
Checks if a given user is part of the monthly active user group
|
||||||
|
Arguments:
|
||||||
|
user_id (str): user to add/update
|
||||||
|
Return:
|
||||||
|
bool : True if user part of group, False otherwise
|
||||||
|
"""
|
||||||
|
user_present = yield self._simple_select_onecol(
|
||||||
|
table="monthly_active_users",
|
||||||
|
keyvalues={
|
||||||
|
"user_id": user_id,
|
||||||
|
},
|
||||||
|
retcol="user_id",
|
||||||
|
desc="is_user_monthly_active",
|
||||||
|
)
|
||||||
|
# jeff = self.cursor_to_dict(res)
|
||||||
|
result = False
|
||||||
|
if user_present:
|
||||||
|
result = True
|
||||||
|
|
||||||
|
defer.returnValue(
|
||||||
|
result
|
||||||
|
)
|
@ -25,7 +25,7 @@ logger = logging.getLogger(__name__)
|
|||||||
|
|
||||||
# Remember to update this number every time a change is made to database
|
# Remember to update this number every time a change is made to database
|
||||||
# schema files, so the users will be informed on server restarts.
|
# schema files, so the users will be informed on server restarts.
|
||||||
SCHEMA_VERSION = 50
|
SCHEMA_VERSION = 51
|
||||||
|
|
||||||
dir_path = os.path.abspath(os.path.dirname(__file__))
|
dir_path = os.path.abspath(os.path.dirname(__file__))
|
||||||
|
|
||||||
|
@ -88,5 +88,5 @@ def run_upgrade(cur, database_engine, *args, **kwargs):
|
|||||||
"UPDATE sqlite_master SET sql=? WHERE tbl_name='events' AND type='table'",
|
"UPDATE sqlite_master SET sql=? WHERE tbl_name='events' AND type='table'",
|
||||||
(sql, ),
|
(sql, ),
|
||||||
)
|
)
|
||||||
cur.execute("PRAGMA schema_version=%i" % (oldver+1,))
|
cur.execute("PRAGMA schema_version=%i" % (oldver + 1,))
|
||||||
cur.execute("PRAGMA writable_schema=OFF")
|
cur.execute("PRAGMA writable_schema=OFF")
|
||||||
|
23
synapse/storage/schema/delta/51/monthly_active_users.sql
Normal file
23
synapse/storage/schema/delta/51/monthly_active_users.sql
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
/* 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
-- a table of users who have requested that their details be erased
|
||||||
|
CREATE TABLE monthly_active_users (
|
||||||
|
user_id TEXT NOT NULL,
|
||||||
|
timestamp BIGINT NOT NULL
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE UNIQUE INDEX monthly_active_users_users ON monthly_active_users(user_id);
|
||||||
|
CREATE INDEX monthly_active_users_time_stamp ON monthly_active_users(timestamp);
|
42
tests/storage/test_monthly_active_users.py
Normal file
42
tests/storage/test_monthly_active_users.py
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
from twisted.internet import defer
|
||||||
|
|
||||||
|
from synapse.storage.monthly_active_users import MonthlyActiveUsersStore
|
||||||
|
|
||||||
|
import tests.unittest
|
||||||
|
import tests.utils
|
||||||
|
from tests.utils import setup_test_homeserver
|
||||||
|
|
||||||
|
|
||||||
|
class MonthlyActiveUsersTestCase(tests.unittest.TestCase):
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
super(MonthlyActiveUsersTestCase, self).__init__(*args, **kwargs)
|
||||||
|
self.mau = None
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def setUp(self):
|
||||||
|
hs = yield setup_test_homeserver()
|
||||||
|
self.mau = MonthlyActiveUsersStore(hs)
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def test_can_insert_and_count_mau(self):
|
||||||
|
count = yield self.mau.get_monthly_active_count()
|
||||||
|
self.assertEqual(0, count)
|
||||||
|
|
||||||
|
yield self.mau.upsert_monthly_active_user("@user:server")
|
||||||
|
count = yield self.mau.get_monthly_active_count()
|
||||||
|
|
||||||
|
self.assertEqual(1, count)
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def test_is_user_monthly_active(self):
|
||||||
|
user_id1 = "@user1:server"
|
||||||
|
user_id2 = "@user2:server"
|
||||||
|
user_id3 = "@user3:server"
|
||||||
|
result = yield self.mau.is_user_monthly_active(user_id1)
|
||||||
|
self.assertFalse(result)
|
||||||
|
yield self.mau.upsert_monthly_active_user(user_id1)
|
||||||
|
yield self.mau.upsert_monthly_active_user(user_id2)
|
||||||
|
result = yield self.mau.is_user_monthly_active(user_id1)
|
||||||
|
self.assertTrue(result)
|
||||||
|
result = yield self.mau.is_user_monthly_active(user_id3)
|
||||||
|
self.assertFalse(result)
|
Loading…
Reference in New Issue
Block a user