refactor(toggl): use @cache to save user_info

instead of creating it immediately as the module loads

this helps in testing, allowing overriding of the TOGGL_USER_INFO
env var

Author: thekaveman

compiler_admin/services/toggl.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from functools import cache
 import io
 import os
 import sys
@@ -10,42 +11,47 @@
 from compiler_admin.services.google import user_info as google_user_info
 import compiler_admin.services.files as files
 
-# cache of previously seen user information, keyed on email
-USER_INFO = files.JsonFileCache("TOGGL_USER_INFO")
-
 # input columns needed for conversion
 TOGGL_COLUMNS = ["Email", "Project", "Client", "Start date", "Start time", "Duration", "Description"]
 
 # default output CSV columns for Harvest
 HARVEST_COLUMNS = ["Date", "Client", "Project", "Task", "Notes", "Hours", "First name", "Last name"]
 
 
+@cache
+def user_info():
+    """Cache of previously seen user information, keyed on email."""
+    return files.JsonFileCache("TOGGL_USER_INFO")
+
+
 def _get_first_name(email: str) -> str:
     """Get cached first name or derive from email."""
-    user = USER_INFO.get(email)
+    info = user_info()
+    user = info.get(email)
     first_name = user.get("First Name") if user else None
     if first_name is None:
         parts = email.split("@")
         first_name = parts[0].capitalize()
         data = {"First Name": first_name}
-        if email in USER_INFO:
-            USER_INFO[email].update(data)
+        if email in info:
+            info[email].update(data)
         else:
-            USER_INFO[email] = data
+            info[email] = data
     return first_name
 
 
 def _get_last_name(email: str):
     """Get cached last name or query from Google."""
-    user = USER_INFO.get(email)
+    info = user_info()
+    user = info.get(email)
     last_name = user.get("Last Name") if user else None
     if last_name is None:
         user = google_user_info(email)
         last_name = user.get("Last Name") if user else None
-        if email in USER_INFO:
-            USER_INFO[email].update(user)
+        if email in info:
+            info[email].update(user)
         else:
-            USER_INFO[email] = user
+            info[email] = user
     return last_name
 
 

tests/services/test_toggl.py

@@ -34,9 +34,9 @@ def spy_files(mocker):
     return mocker.patch.object(compiler_admin.services.toggl, "files", wraps=files)
 
 
-@pytest.fixture(autouse=True)
-def mock_USER_INFO(mocker):
-    return mocker.patch(f"{MODULE}.USER_INFO", new={})
+@pytest.fixture()
+def mock_user_info(mocker):
+    return mocker.patch(f"{MODULE}.user_info")
 
 
 @pytest.fixture
@@ -64,68 +64,68 @@ def mock_toggl_detailed_time_entries(mock_toggl_api, toggl_file):
     return mock_toggl_api
 
 
-def test_get_first_name_matching(mock_USER_INFO):
-    mock_USER_INFO["email"] = {"First Name": "User"}
+def test_get_first_name_matching(mock_user_info):
+    mock_user_info.return_value = {"email": {"First Name": "User"}}
 
     result = _get_first_name("email")
 
     assert result == "User"
 
 
-def test_get_first_name_calcuated_with_record(mock_USER_INFO):
+def test_get_first_name_calcuated_with_record(mock_user_info):
     email = "user@email.com"
-    mock_USER_INFO[email] = {"Data": 1234}
+    mock_user_info.return_value = {email: {"Data": 1234}}
 
     result = _get_first_name(email)
 
     assert result == "User"
-    assert mock_USER_INFO[email]["First Name"] == "User"
-    assert mock_USER_INFO[email]["Data"] == 1234
+    assert mock_user_info.return_value[email]["First Name"] == "User"
+    assert mock_user_info.return_value[email]["Data"] == 1234
 
 
-def test_get_first_name_calcuated_without_record(mock_USER_INFO):
+def test_get_first_name_calcuated_without_record(mock_user_info):
     email = "user@email.com"
-    mock_USER_INFO[email] = {}
+    mock_user_info.return_value = {email: {}}
 
     result = _get_first_name(email)
 
     assert result == "User"
-    assert mock_USER_INFO[email]["First Name"] == "User"
-    assert list(mock_USER_INFO[email].keys()) == ["First Name"]
+    assert mock_user_info.return_value[email]["First Name"] == "User"
+    assert list(mock_user_info.return_value[email].keys()) == ["First Name"]
 
 
-def test_get_last_name_matching(mock_USER_INFO, mock_google_user_info):
-    mock_USER_INFO["email"] = {"Last Name": "User"}
+def test_get_last_name_matching(mock_user_info, mock_google_user_info):
+    mock_user_info.return_value = {"email": {"Last Name": "User"}}
 
     result = _get_last_name("email")
 
     assert result == "User"
     mock_google_user_info.assert_not_called()
 
 
-def test_get_last_name_lookup_with_record(mock_USER_INFO, mock_google_user_info):
+def test_get_last_name_lookup_with_record(mock_user_info, mock_google_user_info):
     email = "user@email.com"
-    mock_USER_INFO[email] = {"Data": 1234}
+    mock_user_info.return_value = {email: {"Data": 1234}}
     mock_google_user_info.return_value = {"Last Name": "User"}
 
     result = _get_last_name(email)
 
     assert result == "User"
-    assert mock_USER_INFO[email]["Last Name"] == "User"
-    assert mock_USER_INFO[email]["Data"] == 1234
+    assert mock_user_info.return_value[email]["Last Name"] == "User"
+    assert mock_user_info.return_value[email]["Data"] == 1234
     mock_google_user_info.assert_called_once_with(email)
 
 
-def test_get_last_name_lookup_without_record(mock_USER_INFO, mock_google_user_info):
+def test_get_last_name_lookup_without_record(mock_user_info, mock_google_user_info):
     email = "user@email.com"
-    mock_USER_INFO[email] = {}
+    mock_user_info.return_value = {email: {}}
     mock_google_user_info.return_value = {"Last Name": "User"}
 
     result = _get_last_name(email)
 
     assert result == "User"
-    assert mock_USER_INFO[email]["Last Name"] == "User"
-    assert list(mock_USER_INFO[email].keys()) == ["Last Name"]
+    assert mock_user_info.return_value[email]["Last Name"] == "User"
+    assert list(mock_user_info.return_value[email].keys()) == ["Last Name"]
     mock_google_user_info.assert_called_once_with(email)