Fix and test population of exhibit icon placeholder for GitHub (#34)

* Add a test case for the issue

* Expose homepage

* Fix the server-side placeholder icon being overwritten by empty values

jupyterlab_gallery/handlers.py

@@ -10,7 +10,7 @@
 # We do not want to expose `git_url` as it may contain PAT;
 # we want an allow-list over block-list to avoid exposing PAT in case
 # if the author of the config makes a typo like `giit` instead of `git`.
-EXPOSED_EXHIBIT_KEYS = ["repository", "title", "description", "icon"]
+EXPOSED_EXHIBIT_KEYS = ["homepage", "title", "description", "icon"]
 
 
 class BaseHandler(APIHandler):
@@ -53,8 +53,8 @@ def get(self):
     def _prepare_exhibit(self, exhibit, exhibit_id: int) -> dict:
         exposed_config = {k: v for k, v in exhibit.items() if k in EXPOSED_EXHIBIT_KEYS}
         return {
-            **self.gallery_manager.get_exhibit_data(exhibit),
             **exposed_config,
+            **self.gallery_manager.get_exhibit_data(exhibit),
             "id": exhibit_id,
         }
 

jupyterlab_gallery/tests/test_handlers.py

@@ -1,7 +1,11 @@
 import json
+from unittest import mock
+import pytest
 
 from jupyter_server.utils import url_path_join
 
+from jupyterlab_gallery.manager import GalleryManager
+
 
 async def test_exhibits(jp_fetch):
     response = await jp_fetch("jupyterlab-gallery", "exhibits")
@@ -10,6 +14,26 @@ async def test_exhibits(jp_fetch):
     assert isinstance(payload["exhibits"], list)
 
 
+@pytest.mark.parametrize("exhibit", [
+    {
+        "git": "https://github.com/nebari-dev/nebari.git",
+        "homepage": "https://github.com/nebari-dev/nebari"
+    },
+    {
+        "git": "https://github.com/nebari-dev/nebari.git",
+        "homepage": "https://github.com/nebari-dev/nebari",
+        "icon": None
+    }
+])
+async def test_exhibit_generate_github_icon(jp_serverapp, jp_fetch, exhibit):
+    with mock.patch.object(GalleryManager, 'exhibits', [exhibit]):
+        response = await jp_fetch("jupyterlab-gallery", "exhibits")
+    assert response.code == 200
+    payload = json.loads(response.body)
+    assert len(payload["exhibits"]) == 1
+    assert payload["exhibits"][0]["icon"] == 'https://opengraph.githubassets.com/1/nebari-dev/nebari'
+
+
 async def test_gallery(jp_fetch):
     response = await jp_fetch("jupyterlab-gallery", "gallery")
     assert response.code == 200