diff --git a/emission/analysis/result/user_stat.py b/emission/analysis/result/user_stat.py new file mode 100644 index 000000000..fa1d7ac95 --- /dev/null +++ b/emission/analysis/result/user_stat.py @@ -0,0 +1,91 @@ +# emission/analysis/result/user_stats.py + +import logging +import pymongo +import arrow +from typing import Optional, Dict, Any +import emission.storage.timeseries.abstract_timeseries as esta +import emission.core.wrapper.user as ecwu + +def get_last_call_timestamp(ts: esta.TimeSeries) -> Optional[int]: + """ + Retrieves the last API call timestamp. + + :param ts: The time series object. + :type ts: esta.TimeSeries + :return: The last call timestamp or None if not found. + :rtype: Optional[int] + """ + last_call_ts = ts.get_first_value_for_field( + key='stats/server_api_time', + field='data.ts', + sort_order=pymongo.DESCENDING + ) + logging.debug(f"Last call timestamp: {last_call_ts}") + return None if last_call_ts == -1 else last_call_ts + + +def update_user_profile(user_id: str, data: Dict[str, Any]) -> None: + """ + Updates the user profile with the provided data. + + :param user_id: The UUID of the user. + :type user_id: str + :param data: The data to update in the user profile. + :type data: Dict[str, Any] + :return: None + """ + user = ecwu.User.fromUUID(user_id) + user.update(data) + logging.debug(f"User profile updated with data: {data}") + logging.debug(f"New profile: {user.getProfile()}") + + +def get_and_store_user_stats(user_id: str, trip_key: str) -> None: + """ + Aggregates and stores user statistics into the user profile. + + :param user_id: The UUID of the user. + :type user_id: str + :param trip_key: The key representing the trip data in the time series. + :type trip_key: str + :return: None + """ + try: + logging.info(f"Starting get_and_store_user_stats for user_id: {user_id}, trip_key: {trip_key}") + + ts = esta.TimeSeries.get_time_series(user_id) + start_ts_result = ts.get_first_value_for_field(trip_key, "data.start_ts", pymongo.ASCENDING) + start_ts = None if start_ts_result == -1 else start_ts_result + + end_ts_result = ts.get_first_value_for_field(trip_key, "data.end_ts", pymongo.DESCENDING) + end_ts = None if end_ts_result == -1 else end_ts_result + + total_trips = ts.find_entries_count(key_list=["analysis/confirmed_trip"]) + labeled_trips = ts.find_entries_count( + key_list=["analysis/confirmed_trip"], + extra_query_list=[{'data.user_input': {'$ne': {}}}] + ) + + logging.info(f"Total trips: {total_trips}, Labeled trips: {labeled_trips}") + logging.info(f"user_id type: {type(user_id)}") + + last_call_ts = get_last_call_timestamp(ts) + logging.info(f"Last call timestamp: {last_call_ts}") + + update_data = { + "pipeline_range": { + "start_ts": start_ts, + "end_ts": end_ts + }, + "total_trips": total_trips, + "labeled_trips": labeled_trips, + "last_call_ts": last_call_ts + } + + update_user_profile(user_id, update_data) + + logging.debug("User profile updated successfully.") + + except Exception as e: + logging.error(f"Error in get_and_store_user_stats for user_id {user_id}: {e}") \ No newline at end of file diff --git a/emission/net/ext_service/transit_matching/match_stops.py b/emission/net/ext_service/transit_matching/match_stops.py index afa5d6abd..3e6deb1c3 100644 --- a/emission/net/ext_service/transit_matching/match_stops.py +++ b/emission/net/ext_service/transit_matching/match_stops.py @@ -15,12 +15,12 @@ url = "https://lz4.overpass-api.de/" try: - query_file = open('conf/net/ext_service/overpass_transit_stops_query_template') -except: + with open('conf/net/ext_service/overpass_transit_stops_query_template', 'r', encoding='UTF-8') as query_file: + query_string = "".join(query_file.readlines()) +except FileNotFoundError: print("transit stops query not configured, falling back to default") - query_file = open('conf/net/ext_service/overpass_transit_stops_query_template.sample') - -query_string = "".join(query_file.readlines()) + with open('conf/net/ext_service/overpass_transit_stops_query_template.sample', 'r', encoding='UTF-8') as query_file: + query_string = "".join(query_file.readlines()) RETRY = -1 diff --git a/emission/pipeline/intake_stage.py b/emission/pipeline/intake_stage.py index 424d85e32..791470264 100644 --- a/emission/pipeline/intake_stage.py +++ b/emission/pipeline/intake_stage.py @@ -13,6 +13,7 @@ from uuid import UUID import time import pymongo +from datetime import datetime import emission.core.get_database as edb import emission.core.timer as ect @@ -39,6 +40,7 @@ import emission.storage.decorations.stats_queries as esds import emission.core.wrapper.user as ecwu +import emission.analysis.result.user_stat as eaurs def run_intake_pipeline(process_number, uuid_list, skip_if_no_new_data=False): """ @@ -201,20 +203,8 @@ def run_intake_pipeline_for_user(uuid, skip_if_no_new_data): with ect.Timer() as gsr: logging.info("*" * 10 + "UUID %s: storing user stats " % uuid + "*" * 10) print(str(arrow.now()) + "*" * 10 + "UUID %s: storing user stats " % uuid + "*" * 10) - _get_and_store_range(uuid, "analysis/composite_trip") + eaurs.get_and_store_user_stats(uuid, "analysis/composite_trip") esds.store_pipeline_time(uuid, 'STORE_USER_STATS', - time.time(), gsr.elapsed) - -def _get_and_store_range(user_id, trip_key): - ts = esta.TimeSeries.get_time_series(user_id) - start_ts = ts.get_first_value_for_field(trip_key, "data.start_ts", pymongo.ASCENDING) - if start_ts == -1: - start_ts = None - end_ts = ts.get_first_value_for_field(trip_key, "data.end_ts", pymongo.DESCENDING) - if end_ts == -1: - end_ts = None - - user = ecwu.User(user_id) - user.update({"pipeline_range": {"start_ts": start_ts, "end_ts": end_ts}}) - logging.debug("After updating, new profiles is %s" % user.getProfile()) + time.time(), gsr.elapsed) + diff --git a/emission/tests/analysisTests/intakeTests/TestUserStat.py b/emission/tests/analysisTests/intakeTests/TestUserStat.py new file mode 100644 index 000000000..260342d86 --- /dev/null +++ b/emission/tests/analysisTests/intakeTests/TestUserStat.py @@ -0,0 +1,118 @@ +from __future__ import unicode_literals, print_function, division, absolute_import +import unittest +import uuid +import logging +import json +import os +import time +import pandas as pd + +from builtins import * +from future import standard_library +standard_library.install_aliases() + +# Standard imports +import emission.storage.json_wrappers as esj + +# Our imports +import emission.core.get_database as edb +import emission.storage.timeseries.timequery as estt +import emission.storage.timeseries.abstract_timeseries as esta +import emission.storage.decorations.analysis_timeseries_queries as esda +import emission.core.wrapper.user as ecwu +import emission.net.api.stats as enac + +# Test imports +import emission.tests.common as etc + + +class TestUserStats(unittest.TestCase): + def setUp(self): + """ + Set up the test environment by loading real example data for both Android and users. + """ + # Set up the real example data with entries + etc.setupRealExample(self, "emission/tests/data/real_examples/shankari_2015-aug-27") + + # Retrieve the user profile + profile = edb.get_profile_db().find_one({"user_id": self.testUUID}) + if profile is None: + # Initialize the profile if it does not exist + edb.get_profile_db().insert_one({"user_id": self.testUUID}) + + etc.runIntakePipeline(self.testUUID) + + logging.debug("UUID = %s" % (self.testUUID)) + + def tearDown(self): + """ + Clean up the test environment by removing analysis configuration and deleting test data from databases. + """ + + edb.get_timeseries_db().delete_many({"user_id": self.testUUID}) + edb.get_pipeline_state_db().delete_many({"user_id": self.testUUID}) + edb.get_analysis_timeseries_db().delete_many({"user_id": self.testUUID}) + edb.get_profile_db().delete_one({"user_id": self.testUUID}) + + def testGetAndStoreUserStats(self): + """ + Test get_and_store_user_stats for the user to ensure that user statistics + are correctly aggregated and stored in the user profile. + """ + + # Retrieve the updated user profile from the database + profile = edb.get_profile_db().find_one({"user_id": self.testUUID}) + + # Ensure that the profile exists + self.assertIsNotNone(profile, "User profile should exist after storing stats.") + + # Verify that the expected fields are present + self.assertIn("total_trips", profile, "User profile should contain 'total_trips'.") + self.assertIn("labeled_trips", profile, "User profile should contain 'labeled_trips'.") + self.assertIn("pipeline_range", profile, "User profile should contain 'pipeline_range'.") + self.assertIn("last_call_ts", profile, "User profile should contain 'last_call_ts'.") + + expected_total_trips = 8 + expected_labeled_trips = 0 + + self.assertEqual(profile["total_trips"], expected_total_trips, + f"Expected total_trips to be {expected_total_trips}, got {profile['total_trips']}") + self.assertEqual(profile["labeled_trips"], expected_labeled_trips, + f"Expected labeled_trips to be {expected_labeled_trips}, got {profile['labeled_trips']}") + + # Verify pipeline range + pipeline_range = profile.get("pipeline_range", {}) + self.assertIn("start_ts", pipeline_range, "Pipeline range should contain 'start_ts'.") + self.assertIn("end_ts", pipeline_range, "Pipeline range should contain 'end_ts'.") + + expected_start_ts = 1440688739.672 + expected_end_ts = 1440729142.709 + + self.assertEqual(pipeline_range["start_ts"], expected_start_ts, + f"Expected start_ts to be {expected_start_ts}, got {pipeline_range['start_ts']}") + self.assertEqual(pipeline_range["end_ts"], expected_end_ts, + f"Expected end_ts to be {expected_end_ts}, got {pipeline_range['end_ts']}") + + def testLastCall(self): + # Call the function with all required arguments + test_call_ts = time.time() + enac.store_server_api_time(self.testUUID, "test_call_ts", test_call_ts, 69420) + etc.runIntakePipeline(self.testUUID) + + # Retrieve the profile from the database + profile = edb.get_profile_db().find_one({"user_id": self.testUUID}) + + # Verify that last_call_ts is updated correctly + expected_last_call_ts = test_call_ts + actual_last_call_ts = profile.get("last_call_ts") + + self.assertEqual( + actual_last_call_ts, + expected_last_call_ts, + f"Expected last_call_ts to be {expected_last_call_ts}, got {actual_last_call_ts}" + ) + +if __name__ == '__main__': + # Configure logging for the test + etc.configLogging() + unittest.main() \ No newline at end of file diff --git a/emission/tests/common.py b/emission/tests/common.py index baae6053c..23bb9ec7f 100644 --- a/emission/tests/common.py +++ b/emission/tests/common.py @@ -193,6 +193,7 @@ def runIntakePipeline(uuid): import emission.analysis.userinput.expectations as eaue import emission.analysis.classification.inference.labels.pipeline as eacilp import emission.analysis.plotting.composite_trip_creation as eapcc + import emission.analysis.result.user_stat as eaurs eaum.match_incoming_user_inputs(uuid) eaicf.filter_accuracy(uuid) @@ -205,6 +206,8 @@ def runIntakePipeline(uuid): eaue.populate_expectations(uuid) eaum.create_confirmed_objects(uuid) eapcc.create_composite_objects(uuid) + eaurs.get_and_store_user_stats(uuid, "analysis/composite_trip") + def configLogging(): """