feat: Export to front-end all versions of an item, but only use the latest version in the front-end (#643)

Part of #504 .

---------

Co-authored-by: Matthieu Jouis <[email protected]>

Author: thomass-dev

skore-ui/src/models.ts

@@ -19,6 +19,6 @@ export type Layout = string[];
  * A project is a collection of items and views
  */
 export interface Project {
-  items: { [key: string]: ProjectItem };
+  items: { [key: string]: ProjectItem[] };
   views: { [key: string]: Layout };
 }

skore-ui/src/stores/project.ts

@@ -112,11 +112,20 @@ export const useProjectStore = defineStore("project", () => {
   /**
    * Set the current views and items
    * Autoselect the first view if no view is selected
+   *
+   * For now only the latest item is kept in memory.
+   *
    * @param r data received from the backend
    */
   async function setProject(r: Project) {
-    items.value = r.items;
+    const latestItemByKey: { [key: string]: ProjectItem } = {};
+    for (const [key, value] of Object.entries(r.items)) {
+      latestItemByKey[key] = value[value.length - 1];
+    }
+
+    items.value = latestItemByKey;
     views.value = r.views;
+
     const viewNames = Object.keys(views.value);
     if (currentView.value === null) {
       if (viewNames.length > 0) {

skore-ui/tests/stores/project.spec.ts

@@ -41,11 +41,11 @@ describe("Project store", () => {
     }
     const project = {
       items: {
-        a: makeFakeViewItem(),
-        "a/b": makeFakeViewItem(),
-        "a/b/d": makeFakeViewItem(),
-        "a/b/e": makeFakeViewItem(),
-        "a/b/f/g": makeFakeViewItem(),
+        a: [makeFakeViewItem()],
+        "a/b": [makeFakeViewItem()],
+        "a/b/d": [makeFakeViewItem()],
+        "a/b/e": [makeFakeViewItem()],
+        "a/b/f/g": [makeFakeViewItem()],
       },
       views: {},
     };

skore/src/skore/ui/project_routes.py

@@ -1,6 +1,7 @@
 """The definition of API routes to list project items and get them."""
 
 import base64
+from collections import defaultdict
 from dataclasses import dataclass
 from typing import Any
 
@@ -33,55 +34,52 @@ class SerializedItem:
 class SerializedProject:
     """Serialized project, to be sent to the skore-ui."""
 
-    items: dict[str, SerializedItem]
+    items: dict[str, list[SerializedItem]]
     views: dict[str, Layout]
 
 
 def __serialize_project(project: Project) -> SerializedProject:
-    views = {}
-    for key in project.list_view_keys():
-        views[key] = project.get_view(key).layout
+    items = defaultdict(list)
 
-    items = {}
     for key in project.list_item_keys():
-        item = project.get_item(key)
-
-        media_type = None
-        if isinstance(item, PrimitiveItem):
-            value = item.primitive
-            media_type = "text/markdown"
-        elif isinstance(item, NumpyArrayItem):
-            value = item.array_list
-            media_type = "text/markdown"
-        elif isinstance(item, PandasDataFrameItem):
-            value = item.dataframe.to_dict(orient="tight")
-            media_type = "application/vnd.dataframe+json"
-        elif isinstance(item, PandasSeriesItem):
-            value = item.series_list
-            media_type = "text/markdown"
-        elif isinstance(item, SklearnBaseEstimatorItem):
-            value = item.estimator_html_repr
-            media_type = "application/vnd.sklearn.estimator+html"
-        elif isinstance(item, MediaItem):
-            value = base64.b64encode(item.media_bytes).decode()
-            media_type = item.media_type
-        elif isinstance(item, CrossValidationItem):
-            # Convert plot to MediaItem
-            item = MediaItem.factory(item.plot)
-            value = base64.b64encode(item.media_bytes).decode()
-            media_type = item.media_type
-        else:
-            raise ValueError(f"Item {item} is not a known item type.")
-
-        items[key] = SerializedItem(
-            media_type=media_type,
-            value=value,
-            updated_at=item.updated_at,
-            created_at=item.created_at,
-        )
+        for item in project.get_item_versions(key):
+            if isinstance(item, PrimitiveItem):
+                value = item.primitive
+                media_type = "text/markdown"
+            elif isinstance(item, NumpyArrayItem):
+                value = item.array_list
+                media_type = "text/markdown"
+            elif isinstance(item, PandasDataFrameItem):
+                value = item.dataframe.to_dict(orient="tight")
+                media_type = "application/vnd.dataframe+json"
+            elif isinstance(item, PandasSeriesItem):
+                value = item.series_list
+                media_type = "text/markdown"
+            elif isinstance(item, SklearnBaseEstimatorItem):
+                value = item.estimator_html_repr
+                media_type = "application/vnd.sklearn.estimator+html"
+            elif isinstance(item, MediaItem):
+                value = base64.b64encode(item.media_bytes).decode()
+                media_type = item.media_type
+            elif isinstance(item, CrossValidationItem):
+                value = base64.b64encode(item.plot_bytes).decode()
+                media_type = "application/vnd.plotly.v1+json"
+            else:
+                raise ValueError(f"Item {item} is not a known item type.")
+
+            items[key].append(
+                SerializedItem(
+                    media_type=media_type,
+                    value=value,
+                    updated_at=item.updated_at,
+                    created_at=item.created_at,
+                )
+            )
+
+    views = {key: project.get_view(key).layout for key in project.list_view_keys()}
 
     return SerializedProject(
-        items=items,
+        items=dict(items),
         views=views,
     )
 

skore/tests/integration/ui/test_ui.py

@@ -26,20 +26,25 @@ def test_get_items(client, in_memory_project):
     assert response.status_code == 200
     assert response.json() == {"views": {}, "items": {}}
 
-    in_memory_project.put("test", "test")
-    item = in_memory_project.get_item("test")
+    in_memory_project.put("test", "version_1")
+    in_memory_project.put("test", "version_2")
+
+    items = in_memory_project.get_item_versions("test")
 
     response = client.get("/api/project/items")
     assert response.status_code == 200
     assert response.json() == {
         "views": {},
         "items": {
-            "test": {
-                "media_type": "text/markdown",
-                "value": "test",
-                "updated_at": item.updated_at,
-                "created_at": item.created_at,
-            }
+            "test": [
+                {
+                    "media_type": "text/markdown",
+                    "value": item.primitive,
+                    "created_at": item.created_at,
+                    "updated_at": item.updated_at,
+                }
+                for item in items
+            ],
         },
     }