Merge pull request #1200 from transformerlab/fix/plugins-empty-list

Stop plugin gallery errors in remote mode

Author: deep1401

README.md

@@ -258,6 +258,16 @@ Our Alembic setup lives under `api/alembic`. Use the API Conda/uv environment be
 
   To roll back the most recent migration while iterating, run `alembic downgrade -1`.
 
+### Running API Tests Locally
+
+To run API tests locally:
+
+```bash
+conda activate ~/.transformerlab/envs/transformerlab
+cd api
+pytest --cov=transformerlab --cov-branch --cov-report=xml -k 'not test_teams'
+```
+
 <!-- LICENSE -->
 
 ## License

api/test/api/test_plugins.py

@@ -14,6 +14,19 @@ def test_plugins_gallery(client):
         assert "name" in plugin or "description" in plugin
 
 
+def test_plugins_gallery_remote_mode(client, monkeypatch):
+    """Test that plugins/gallery returns empty list in remote mode (TFL_API_STORAGE_URI is set)"""
+    # Set TFL_API_STORAGE_URI to enable remote mode
+    monkeypatch.setenv("TFL_API_STORAGE_URI", "true")
+
+    # The endpoint reads env vars at request time, so monkeypatch should work
+    resp = client.get("/plugins/gallery")
+    assert resp.status_code == 200
+    data = resp.json()
+    assert isinstance(data, list)
+    assert data == []  # Should return empty list in remote mode
+
+
 def test_plugins_list(client):
     resp = client.get("/plugins/list")
     assert resp.status_code == 200
@@ -24,6 +37,19 @@ def test_plugins_list(client):
         assert "name" in plugin or "description" in plugin
 
 
+def test_plugins_list_remote_mode(client, monkeypatch):
+    """Test that plugins/list returns empty list in remote mode (TFL_API_STORAGE_URI is set)"""
+    # Set TFL_API_STORAGE_URI to enable remote mode
+    monkeypatch.setenv("TFL_API_STORAGE_URI", "true")
+
+    # The endpoint reads env vars at request time, so monkeypatch should work
+    resp = client.get("/plugins/list")
+    assert resp.status_code == 200
+    data = resp.json()
+    assert isinstance(data, list)
+    assert data == []  # Should return empty list in remote mode
+
+
 def test_plugins_install(client):
     resp = client.get("/plugins/gallery/fastchat_server/install")
     assert resp.status_code in (200, 404)

api/transformerlab/routers/plugins.py

@@ -24,6 +24,11 @@
 async def plugin_gallery():
     """Get list of plugins that we can access"""
 
+    # In remote mode (TFL_API_STORAGE_URI is set), plugins are not available
+    # Return empty list to match sidebar behavior where plugins menu is hidden
+    if os.getenv("TFL_API_STORAGE_URI"):
+        return []
+
     local_workspace_gallery_directory = dirs.PLUGIN_PRELOADED_GALLERY
     # today the remote gallery is a local file, we will move it remote later
     remote_gallery_file = os.path.join(dirs.TFL_SOURCE_CODE_DIR, "transformerlab/galleries/plugin-gallery.json")
@@ -429,6 +434,11 @@ async def run_installer_script(plugin_id: str):
 async def list_plugins() -> list[object]:
     """Get list of plugins that are currently installed"""
 
+    # In remote mode (TFL_API_STORAGE_URI is set), plugins are not available
+    # Return empty list to match sidebar behavior where plugins menu is hidden
+    if os.getenv("TFL_API_STORAGE_URI"):
+        return []
+
     from lab.dirs import get_plugin_dir
 
     local_workspace_gallery_directory = await get_plugin_dir()