refactor(metrics): rename get_distinct_id method to get_or_create_distinct_id for clarity

Author: dimanu-py

instant_python/metrics/infra/post_hog_metrics_reporter.py

@@ -19,7 +19,7 @@ def __init__(self, config: PostHogConfig, user_identity_manager: UserIdentityMan
     def send(self, metrics: UsageMetricsData) -> None:
         try:
             self._client.capture(
-                distinct_id=self._user_identity_manager.get_distinct_id(),
+                distinct_id=self._user_identity_manager.get_or_create_distinct_id(),
                 event="ipy_usage",
                 properties=metrics.to_primitives(),
             )

instant_python/metrics/infra/user_identity_manager.py

@@ -17,7 +17,7 @@ def __init__(self, config_dir: Path | None = None) -> None:
         ) if not config_dir else config_dir
         self._metrics_file = self._config_dir / self._METRICS_FILE_NAME
 
-    def get_distinct_id(self) -> str:
+    def get_or_create_distinct_id(self) -> str:
         existing_id = self._load_existing_distinct_id()
         return existing_id if existing_id else self._create_and_store_new_distinct_id()
 

test/metrics/infra/test_user_identity_manager.py

@@ -15,7 +15,7 @@ def test_should_create_metrics_file_and_store_distinct_id_for_new_user(self) ->
             metrics_file = config_dir / "metrics.json"
             user_identity_manager = UserIdentityManager(config_dir=config_dir)
 
-            distinct_id = user_identity_manager.get_distinct_id()
+            distinct_id = user_identity_manager.get_or_create_distinct_id()
 
             expect(metrics_file.exists()).to(be_true)
             stored_distinct_id = json.loads(metrics_file.read_text())
@@ -27,8 +27,8 @@ def test_should_return_same_id_on_consecutive_calls(self) -> None:
             config_dir = Path(temp_dir)
             user_identity_manager = UserIdentityManager(config_dir=config_dir)
 
-            first_id = user_identity_manager.get_distinct_id()
-            second_id = user_identity_manager.get_distinct_id()
+            first_id = user_identity_manager.get_or_create_distinct_id()
+            second_id = user_identity_manager.get_or_create_distinct_id()
 
             expect(first_id).to(equal(second_id))
 
@@ -39,7 +39,7 @@ def test_should_regenerate_id_when_metrics_file_is_invalid(self) -> None:
             metrics_file.write_text("invalid json content")
 
             user_identity_manager = UserIdentityManager(config_dir=config_dir)
-            distinct_id = user_identity_manager.get_distinct_id()
+            distinct_id = user_identity_manager.get_or_create_distinct_id()
 
             stored_data = json.loads(metrics_file.read_text())
             expect(stored_data["distinct_id"]).to(equal(distinct_id))
@@ -52,7 +52,7 @@ def test_should_load_and_validate_existing_uuid_from_metrics_file(self) -> None:
             metrics_file.write_text(json.dumps({"distinct_id": existing_uuid}))
 
             user_identity_manager = UserIdentityManager(config_dir=config_dir)
-            distinct_id = user_identity_manager.get_distinct_id()
+            distinct_id = user_identity_manager.get_or_create_distinct_id()
 
             expect(distinct_id).to(equal(existing_uuid))
             expect(uuid.UUID(distinct_id)).to(be_a(uuid.UUID))
@@ -64,7 +64,7 @@ def test_should_regenerate_id_when_stored_value_is_not_a_valid_uuid(self) -> Non
             metrics_file.write_text(json.dumps({"distinct_id": "not-a-valid-uuid"}))
 
             user_identity_manager = UserIdentityManager(config_dir=config_dir)
-            distinct_id = user_identity_manager.get_distinct_id()
+            distinct_id = user_identity_manager.get_or_create_distinct_id()
 
             expect(distinct_id).not_to(equal("not-a-valid-uuid"))
             stored_data = json.loads(metrics_file.read_text())