Track app_version and client_type in mapping_sessions table

mapswipe · Oct 22, 2024 · bc42684 · bc42684
1 parent 542f57a
commit bc42684
Show file tree

Hide file tree

Showing 10 changed files with 76 additions and 9 deletions.
diff --git a/django/apps/existing_database/migrations/0002_mappingsession_mappingsessionresult.py b/django/apps/existing_database/migrations/0002_mappingsession_mappingsessionresult.py
@@ -22,6 +22,8 @@ class Migration(migrations.Migration):
                 ("start_time", models.DateTimeField(blank=True, null=True)),
                 ("end_time", models.DateTimeField(blank=True, null=True)),
                 ("items_count", models.SmallIntegerField(default=0)),
+                ("app_version", models.CharField(max_length=999)),
+                ("client_type", models.CharField(max_length=999)),
             ],
             options={
                 "db_table": "mapping_sessions",

diff --git a/django/apps/existing_database/models.py b/django/apps/existing_database/models.py
@@ -233,6 +233,8 @@ class MappingSession(Model):
     start_time = models.DateTimeField(blank=True, null=True)
     end_time = models.DateTimeField(blank=True, null=True)
     items_count = models.SmallIntegerField(null=False, default=0)
+    app_version = models.CharField(max_length=999)
+    client_type = models.CharField(max_length=999)
 
     class Meta:
         managed = False

diff --git a/mapswipe_workers/mapswipe_workers/firebase_to_postgres/transfer_results.py b/mapswipe_workers/mapswipe_workers/firebase_to_postgres/transfer_results.py
@@ -264,6 +264,8 @@ def results_to_file(
             start_time = dateutil.parser.parse(result_data["startTime"])
             end_time = dateutil.parser.parse(result_data["endTime"])
             timestamp = end_time
+            app_version = result_data.get("appVersion", "")
+            client_type = result_data.get("clientType", "")
 
             if type(result_data["results"]) is dict:
                 for taskId, result in result_data["results"].items():
@@ -279,6 +281,8 @@ def results_to_file(
                             start_time,
                             end_time,
                             result,
+                            app_version,
+                            client_type,
                         ]
                     )
             elif type(result_data["results"]) is list:
@@ -303,6 +307,8 @@ def results_to_file(
                                 start_time,
                                 end_time,
                                 result,
+                                app_version,
+                                client_type,
                             ]
                         )
             else:
@@ -361,6 +367,8 @@ def save_results_to_postgres(
         "start_time",
         "end_time",
         "result",
+        "app_version",
+        "client_type",
     ]
     p_con.copy_from(results_file, result_temp_table, columns)
     results_file.close()
@@ -420,9 +428,11 @@ def save_results_to_postgres(
                 nextval('mapping_sessions_mapping_session_id_seq'),
                 min(start_time),
                 max(end_time),
-                count(*)
+                count(*),
+                app_version,
+                client_type
             FROM {result_temp_table}
-            GROUP BY project_id, group_id, user_id
+            GROUP BY project_id, group_id, user_id, app_version, client_type
         ON CONFLICT (project_id,group_id,user_id)
         DO NOTHING;
         INSERT INTO {result_table}

diff --git a/mapswipe_workers/mapswipe_workers/generate_stats/project_stats.py b/mapswipe_workers/mapswipe_workers/generate_stats/project_stats.py
@@ -121,6 +121,8 @@ def get_results(
                 ms.start_time as timestamp,
                 ms.start_time,
                 ms.end_time,
+                ms.app_version,
+                ms.client_type,
                 {result_sql},
                 -- the username for users which login to MapSwipe with their
                 -- OSM account is not defined or ''.

diff --git a/mapswipe_workers/tests/integration/set_up.py b/mapswipe_workers/tests/integration/set_up.py
@@ -85,7 +85,15 @@ def create_test_project(
         set_postgres_test_data(project_type, "users", "user")
         set_firebase_test_data(project_type, "user_groups", "user_group", "")
         set_firebase_test_data(project_type, "results", fixture_name, project_id)
-        set_postgres_test_data(project_type, "mapping_sessions", fixture_name)
+        set_postgres_test_data(project_type, "mapping_sessions", fixture_name, columns=[
+            "project_id",
+            "group_id",
+            "user_id",
+            "mapping_session_id",
+            "start_time",
+            "end_time",
+            "items_count",
+        ])
         set_postgres_test_data(project_type, mapping_sessions_results, fixture_name)
         if create_user_group_session_data:
             set_postgres_test_data(

diff --git a/mapswipe_workers/tests/integration/set_up_db.sql b/mapswipe_workers/tests/integration/set_up_db.sql
@@ -91,7 +91,9 @@ CREATE TABLE IF NOT EXISTS results_temp (
     "timestamp" timestamp,
     start_time timestamp,
     end_time timestamp,
-    result int
+    result int,
+    app_version varchar,
+    client_type varchar
 );
 
 -- create table for results import through csv
@@ -103,7 +105,9 @@ CREATE TABLE IF NOT EXISTS results_geometry_temp (
     "timestamp" timestamp,
     start_time timestamp,
     end_time timestamp,
-    result varchar
+    result varchar,
+    app_version varchar,
+    client_type varchar
 );
 
 
@@ -175,6 +179,8 @@ CREATE TABLE IF NOT EXISTS mapping_sessions (
     start_time timestamp DEFAULT NULL,
     end_time timestamp DEFAULT NULL,
     items_count int2 not null,
+    app_version varchar,
+    client_type varchar,
     PRIMARY KEY (project_id, group_id, user_id),
     FOREIGN KEY (project_id, group_id)
     REFERENCES groups (project_id, group_id),

diff --git a/mapswipe_workers/tests/integration/test_get_results_real_project.py b/mapswipe_workers/tests/integration/test_get_results_real_project.py
@@ -29,7 +29,15 @@ def setUp(self):
             ),
             ("tasks", None),
             ("users", None),
-            ("mapping_sessions", None),
+            ("mapping_sessions", [
+                "project_id",
+                "group_id",
+                "user_id",
+                "mapping_session_id",
+                "start_time",
+                "end_time",
+                "items_count",
+            ]),
             ("mapping_sessions_results", None),
         ]:
             set_up.set_postgres_test_data(

diff --git a/mapswipe_workers/tests/integration/test_user_stats.py b/mapswipe_workers/tests/integration/test_user_stats.py
@@ -36,7 +36,15 @@ def setUp(self):
             ),
             ("tasks", None),
             ("users", None),
-            ("mapping_sessions", None),
+            ("mapping_sessions", [
+                "project_id",
+                "group_id",
+                "user_id",
+                "mapping_session_id",
+                "start_time",
+                "end_time",
+                "items_count",
+            ]),
             ("mapping_sessions_results", None),
         ]:
             set_up.set_postgres_test_data(

diff --git a/postgres/initdb.sql b/postgres/initdb.sql
@@ -91,7 +91,9 @@ CREATE TABLE IF NOT EXISTS results_temp (
     "timestamp" timestamp,
     start_time timestamp,
     end_time timestamp,
-    result int
+    result int,
+    app_version varchar,
+    client_type varchar
 );
 
 -- create table for results import through csv
@@ -103,7 +105,9 @@ CREATE TABLE IF NOT EXISTS results_geometry_temp (
     "timestamp" timestamp,
     start_time timestamp,
     end_time timestamp,
-    result varchar
+    result varchar,
+    app_version varchar,
+    client_type varchar
 );
 
 
@@ -175,6 +179,8 @@ CREATE TABLE IF NOT EXISTS mapping_sessions (
     start_time timestamp DEFAULT NULL,
     end_time timestamp DEFAULT NULL,
     items_count int2 not null,
+    app_version varchar,
+    client_type varchar,
     PRIMARY KEY (project_id, group_id, user_id),
     FOREIGN KEY (project_id, group_id)
     REFERENCES groups (project_id, group_id),

diff --git a/postgres/scripts/v2_to_v3/07_update_mapping_sessions_table.sql b/postgres/scripts/v2_to_v3/07_update_mapping_sessions_table.sql
@@ -0,0 +1,15 @@
+/*
+ * This script updates the `mapping_sessions` table by adding the following columns:
+ * - `app_version`: Stores the version of the client application.
+ * - `client_type`: Indicates the type of client (currently supporting 'web' and 'mobile').
+ * 
+ * Existing entries for `app_version` and `client_type` will be set to an empty string
+ * to indicate that they can correspond to either web or mobile, as web is already in use.
+ * 
+ * Related issue: https://github.com/mapswipe/mapswipe/issues/852#issuecomment-2400077760
+ */
+
+
+ALTER TABLE mapping_sessions
+    ADD COLUMN app_version varchar,
+    ADD COLUMN client_type varchar;