Add optional monorepo information into schema and post_live_metrics

Author: mattseddon

src/dvc_studio_client/post_live_metrics.py

@@ -123,6 +123,8 @@ def post_live_metrics(  # noqa: C901,PLR0912,PLR0913
     studio_token: Optional[str] = None,
     studio_repo_url: Optional[str] = None,
     studio_url: Optional[str] = None,
+    dvc_experiment_parent_data: Optional[Dict[str, Any]] = None,
+    subdir: Optional[str] = None,
 ) -> Optional[bool]:
     """Post `event_type` to Studio's `api/live`.
 
@@ -239,6 +241,10 @@ def post_live_metrics(  # noqa: C901,PLR0912,PLR0913
         if message:
             # Cutting the message to match the commit title length limit.
             body["message"] = message[:72]
+        if subdir:
+            body["subdir"] = subdir
+        if dvc_experiment_parent_data:
+            body["dvc_experiment_parent_data"] = dvc_experiment_parent_data
     elif event_type == "data":
         if step is None:
             logger.warning("Missing `step` in `data` event.")

src/dvc_studio_client/schema.py

@@ -1,4 +1,4 @@
-from voluptuous import All, Any, Exclusive, Lower, Match, Required, Schema
+from voluptuous import All, Any, Exclusive, Lower, Match, Optional, Required, Schema
 
 
 def choices(*choices):
@@ -32,6 +32,8 @@ def choices(*choices):
     "start": BASE_SCHEMA.extend(
         {
             "message": str,
+            Optional("dvc_experiment_parent_data"): dict,
+            Optional("subdir"): str,
         },
     ),
     "data": BASE_SCHEMA.extend(

tests/test_post_live_metrics.py

@@ -38,59 +38,97 @@ def test_post_live_metrics_skip_on_schema_error(caplog, monkeypatch):
 
 
 def test_post_live_metrics_start_event(mocker, monkeypatch):
-    monkeypatch.setenv(DVC_STUDIO_URL, "https://0.0.0.0")
-    monkeypatch.setenv(DVC_STUDIO_TOKEN, "FOO_TOKEN")
-    monkeypatch.setenv(STUDIO_REPO_URL, "FOO_REPO_URL")
+    repo_url = "FOO_REPO_URL"
+    studio_url = "https://0.0.0.0"
+    studio_token = "FOO_TOKEN"
+    baseline_sha = "f" * 40
+    event_type = "start"
+    name = "fooname"
+    client = "fooclient"
+
+    post_url = f"{studio_url}/api/live"
+    headers = {
+        "Authorization": f"token {studio_token}",
+        "Content-type": "application/json",
+    }
+    base_event = {
+        "type": "start",
+        "repo_url": "FOO_REPO_URL",
+        "baseline_sha": baseline_sha,
+        "name": name,
+        "client": client,
+    }
+
+    monkeypatch.setenv(DVC_STUDIO_URL, studio_url)
+    monkeypatch.setenv(DVC_STUDIO_TOKEN, studio_token)
+    monkeypatch.setenv(STUDIO_REPO_URL, repo_url)
 
     mocked_response = mocker.MagicMock()
     mocked_response.status_code = 200
     mocked_post = mocker.patch("requests.post", return_value=mocked_response)
 
     assert post_live_metrics(
-        "start",
-        "f" * 40,
-        "fooname",
-        "fooclient",
+        event_type,
+        baseline_sha,
+        name,
+        client,
     )
 
     mocked_post.assert_called_with(
-        "https://0.0.0.0/api/live",
-        json={
-            "type": "start",
-            "repo_url": "FOO_REPO_URL",
-            "baseline_sha": "f" * 40,
-            "name": "fooname",
-            "client": "fooclient",
-        },
-        headers={
-            "Authorization": "token FOO_TOKEN",
-            "Content-type": "application/json",
-        },
+        post_url,
+        json=base_event,
+        headers=headers,
         timeout=(30, 5),
     )
 
     post_live_metrics(
-        "start",
-        "f" * 40,
-        "fooname",
-        "fooclient",
+        event_type,
+        baseline_sha,
+        name,
+        client,
         params={"params.yaml": {"foo": "bar"}},
     )
 
     mocked_post.assert_called_with(
-        "https://0.0.0.0/api/live",
+        post_url,
         json={
-            "type": "start",
-            "repo_url": "FOO_REPO_URL",
-            "baseline_sha": "f" * 40,
-            "name": "fooname",
-            "client": "fooclient",
+            **base_event,
             "params": {"params.yaml": {"foo": "bar"}},
         },
-        headers={
-            "Authorization": "token FOO_TOKEN",
-            "Content-type": "application/json",
+        headers=headers,
+        timeout=(30, 5),
+    )
+
+    dvc_experiment_parent_data = {
+        "sha": baseline_sha,
+        "message": "test message",
+        "title": "test message",
+        "author": {
+            "name": "Monrepo user",
+            "email": "overcomplicated@iLoveMonorepos.com",
+        },
+        "date": "2021-09-01T12:00:00+00:00",
+        "branch": "main",
+    }
+    subdir = "subdir"
+
+    assert post_live_metrics(
+        "start",
+        baseline_sha,
+        name,
+        client,
+        dvc_experiment_parent_data=dvc_experiment_parent_data,
+        subdir=subdir,
+    )
+
+    mocked_post.assert_called_with(
+        post_url,
+        json={
+            **base_event,
+            "dvc_experiment_parent_data": dvc_experiment_parent_data,
+            "subdir": subdir,
         },
+        headers=headers,
         timeout=(30, 5),
     )