Make defensive, expose common protected functions

Author: gotsysdba

src/client/content/config/tabs/databases.py

@@ -258,7 +258,7 @@ def display_databases() -> None:
     selected_database_alias = st.selectbox(
         "Current Database:",
         options=list(database_lookup.keys()),
-        index=list(database_lookup.keys()).index(state.client_settings["database"]["alias"]),
+        index=list(database_lookup.keys()).index(state.client_settings.get("database", {}).get("alias")),
         key="selected_database",
         on_change=st_common.update_client_settings("database"),
     )

src/client/content/config/tabs/settings.py

@@ -302,7 +302,7 @@ def spring_ai_obaas(src_dir, file_name, provider, ll_config, embed_config):
         sys_prompt=f"{sys_prompt}",
         ll_model=ll_config,
         vector_search=embed_config,
-        database_config=database_lookup[state.client_settings["database"]["alias"]],
+        database_config=database_lookup[state.client_settings.get("database", {}).get("alias")],
     )
 
     if file_name.endswith(".yaml"):
@@ -313,7 +313,7 @@ def spring_ai_obaas(src_dir, file_name, provider, ll_config, embed_config):
             sys_prompt=sys_prompt,
             ll_model=ll_config,
             vector_search=embed_config,
-            database_config=database_lookup[state.client_settings["database"]["alias"]],
+            database_config=database_lookup[state.client_settings.get("database", {}).get("alias")],
         )
 
         yaml_data = yaml.safe_load(formatted_content)

src/client/utils/st_common.py

@@ -117,7 +117,7 @@ def is_db_configured() -> bool:
         (
             config.get("connected")
             for config in state.database_configs
-            if config.get("name") == state.client_settings["database"]["alias"]
+            if config.get("name") == state.client_settings.get("database", {}).get("alias")
         ),
         False,
     )
@@ -274,7 +274,7 @@ def _update_set_tool():
         switch_prompt("sys", "Basic Example")
     else:
         # Client Settings
-        db_alias = state.client_settings["database"]["alias"]
+        db_alias = state.client_settings.get("database", {}).get("alias")
         oci_auth_profile = state.client_settings["oci"]["auth_profile"]
 
         # Lookups
@@ -346,7 +346,7 @@ def _disable_vector_search(reason):
 #####################################################
 def selectai_sidebar() -> None:
     """SelectAI Sidebar Settings, conditional if Database/SelectAI are configured"""
-    db_alias = state.client_settings["database"]["alias"]
+    db_alias = state.client_settings.get("database", {}).get("alias")
     database_lookup = state_configs_lookup("database_configs", "name")
     if state.client_settings["selectai"]["enabled"]:
         st.sidebar.subheader("SelectAI", divider="red")
@@ -418,22 +418,6 @@ def _render_vector_search_options(vector_search_type: str) -> None:
         )
 
 
-def _vs_reset() -> None:
-    """Reset Vector Store Selections"""
-    for key in state.client_settings["vector_search"]:
-        if key in (
-            "model",
-            "chunk_size",
-            "chunk_overlap",
-            "distance_metric",
-            "vector_store",
-            "alias",
-            "index_type",
-        ):
-            clear_state_key(f"selected_vector_search_{key}")
-            state.client_settings["vector_search"][key] = ""
-
-
 def _vs_gen_selectbox(label: str, options: list, key: str):
     """Handle selectbox with auto-setting for a single unique value"""
     valid_options = [option for option in options if option != ""]
@@ -461,7 +445,7 @@ def _vs_gen_selectbox(label: str, options: list, key: str):
     )
 
 
-def _update_filtered_df(vs_df: pd.DataFrame) -> pd.DataFrame:
+def update_filtered_vector_store(vs_df: pd.DataFrame) -> pd.DataFrame:
     """Dynamically update filtered_df based on selected filters"""
     embed_models_enabled = enabled_models_lookup("embed")
     filtered = vs_df.copy()
@@ -482,17 +466,36 @@ def _update_filtered_df(vs_df: pd.DataFrame) -> pd.DataFrame:
     return filtered
 
 
-def _render_vector_store_selection(vs_df: pd.DataFrame) -> None:
+def render_vector_store_selection(vs_df: pd.DataFrame) -> None:
     """Render vector store selection controls and handle state updates."""
-    filtered_df = _update_filtered_df(vs_df)
+    st.sidebar.subheader("Vector Store", divider="red")
+
+    def reset() -> None:
+        """Reset Vector Store Selections"""
+        for key in state.client_settings["vector_search"]:
+            if key in (
+                "model",
+                "chunk_size",
+                "chunk_overlap",
+                "distance_metric",
+                "vector_store",
+                "alias",
+                "index_type",
+            ):
+                clear_state_key(f"selected_vector_search_{key}")
+                state.client_settings["vector_search"][key] = ""
+
+    filtered_df = update_filtered_vector_store(vs_df)
 
     # Render selectbox with updated options
     alias = _vs_gen_selectbox("Select Alias:", filtered_df["alias"].unique().tolist(), "selected_vector_search_alias")
     embed_model = _vs_gen_selectbox(
         "Select Model:", filtered_df["model"].unique().tolist(), "selected_vector_search_model"
     )
     chunk_size = _vs_gen_selectbox(
-        "Select Chunk Size:", filtered_df["chunk_size"].unique().tolist(), "selected_vector_search_chunk_size"
+        "Select Chunk Size:",
+        filtered_df["chunk_size"].unique().tolist(),
+        "selected_vector_search_chunk_size",
     )
     chunk_overlap = _vs_gen_selectbox(
         "Select Chunk Overlap:",
@@ -505,7 +508,9 @@ def _render_vector_store_selection(vs_df: pd.DataFrame) -> None:
         "selected_vector_search_distance_metric",
     )
     index_type = _vs_gen_selectbox(
-        "Select Index Type:", filtered_df["index_type"].unique().tolist(), "selected_vector_search_index_type"
+        "Select Index Type:",
+        filtered_df["index_type"].unique().tolist(),
+        "selected_vector_search_index_type",
     )
 
     if all([alias, embed_model, chunk_size, chunk_overlap, distance_metric, index_type]):
@@ -518,11 +523,11 @@ def _render_vector_store_selection(vs_df: pd.DataFrame) -> None:
         state.client_settings["vector_search"]["distance_metric"] = distance_metric
         state.client_settings["vector_search"]["index_type"] = index_type
     else:
-        st.error("Please select Vector Store options or disable Vector Search to continue.", icon="❌")
+        st.info("Please select existing Vector Store options to continue.", icon="⬅️")
         state.enable_client = False
 
     # Reset button
-    st.sidebar.button("Reset", type="primary", on_click=_vs_reset)
+    st.sidebar.button("Reset", type="primary", on_click=reset)
 
 
 def vector_search_sidebar() -> None:
@@ -545,10 +550,9 @@ def vector_search_sidebar() -> None:
         _render_vector_search_options(vector_search_type)
 
         # Vector Store Section
-        st.sidebar.subheader("Vector Store", divider="red")
-        db_alias = state.client_settings["database"]["alias"]
+        db_alias = state.client_settings.get("database", {}).get("alias")
         database_lookup = state_configs_lookup("database_configs", "name")
-        vs_df = pd.DataFrame(database_lookup[db_alias].get("vector_stores"))
+        vs_df = pd.DataFrame(database_lookup.get(db_alias, {}).get("vector_stores", []))
 
         # Render vector store selection controls
-        _render_vector_store_selection(vs_df)
+        render_vector_store_selection(vs_df)

tests/client/content/tools/tabs/test_split_embed.py

@@ -692,3 +692,130 @@ def test_embedding_server_not_accessible(self, app_server, app_test, monkeypatch
         # Should show warning about server accessibility
         warnings = at.get("warning")
         assert len(warnings) > 0
+
+    def test_create_new_vs_toggle_not_shown_when_no_vector_stores(self, app_server, app_test, monkeypatch):
+        """Test that 'Create New Vector Store' toggle is NOT shown when no vector stores exist"""
+        assert app_server is not None
+        self._setup_common_mocks(monkeypatch)
+
+        # Mock database_configs with no vector stores
+        def mock_get_no_vs(endpoint=None, **kwargs):
+            if endpoint == "v1/models":
+                return [
+                    {
+                        "id": "test-model",
+                        "type": "embed",
+                        "enabled": True,
+                        "api_base": "http://test.url",
+                        "max_chunk_size": 1000,
+                    }
+                ]
+            elif endpoint == "v1/databases":
+                return [
+                    {
+                        "name": "DEFAULT",
+                        "vector_stores": [],  # No vector stores
+                    }
+                ]
+            elif endpoint == "v1/oci":
+                return [
+                    {
+                        "auth_profile": "DEFAULT",
+                        "namespace": "test-namespace",
+                        "tenancy": "test-tenancy",
+                        "region": "us-ashburn-1",
+                        "authentication": "api_key",
+                    }
+                ]
+            return {}
+
+        monkeypatch.setattr("client.utils.api_call.get", mock_get_no_vs)
+        monkeypatch.setattr("common.functions.is_url_accessible", lambda api_base: (True, ""))
+        monkeypatch.setattr("client.utils.st_common.is_db_configured", lambda: True)
+
+        at = self._run_app_and_verify_no_errors(app_test)
+
+        # Toggle should NOT be present when no vector stores exist
+        toggles = at.get("toggle")
+        create_new_toggle = next(
+            (t for t in toggles if hasattr(t, "label") and "Create New Vector Store" in str(t.label)), None
+        )
+        assert create_new_toggle is None, "Toggle should not be shown when no vector stores exist"
+
+    def test_create_new_vs_toggle_shown_when_vector_stores_exist(self, app_server, app_test, monkeypatch):
+        """Test that 'Create New Vector Store' toggle IS shown when vector stores exist"""
+        assert app_server is not None
+        self._setup_common_mocks(monkeypatch)
+
+        # Mock database_configs with existing vector stores
+        def mock_get_with_vs(endpoint=None, **kwargs):
+            if endpoint == "v1/models":
+                return [
+                    {
+                        "id": "test-model",
+                        "type": "embed",
+                        "enabled": True,
+                        "api_base": "http://test.url",
+                        "max_chunk_size": 1000,
+                    }
+                ]
+            elif endpoint == "v1/databases":
+                return [
+                    {
+                        "name": "DEFAULT",
+                        "vector_stores": [
+                            {
+                                "alias": "existing_vs",
+                                "model": "test-model",
+                                "vector_store": "VECTOR_STORE_TABLE",
+                                "chunk_size": 500,
+                                "chunk_overlap": 50,
+                                "distance_metric": "COSINE",
+                                "index_type": "IVF",
+                            }
+                        ],
+                    }
+                ]
+            elif endpoint == "v1/oci":
+                return [
+                    {
+                        "auth_profile": "DEFAULT",
+                        "namespace": "test-namespace",
+                        "tenancy": "test-tenancy",
+                        "region": "us-ashburn-1",
+                        "authentication": "api_key",
+                    }
+                ]
+            return {}
+
+        monkeypatch.setattr("client.utils.api_call.get", mock_get_with_vs)
+        monkeypatch.setattr("common.functions.is_url_accessible", lambda api_base: (True, ""))
+        monkeypatch.setattr("client.utils.st_common.is_db_configured", lambda: True)
+
+        at = self._run_app_and_verify_no_errors(app_test)
+
+        # Toggle SHOULD be present when vector stores exist
+        toggles = at.get("toggle")
+        create_new_toggle = next(
+            (t for t in toggles if hasattr(t, "label") and "Create New Vector Store" in str(t.label)), None
+        )
+        assert create_new_toggle is not None, "Toggle should be shown when vector stores exist"
+        assert create_new_toggle.value is True, "Toggle should default to True (create new mode)"
+
+    def test_populate_button_shown_in_create_new_mode(self, app_server, app_test, monkeypatch):
+        """Test that 'Populate Vector Store' button is shown when in create new mode"""
+        assert app_server is not None
+        self._setup_common_mocks(monkeypatch)
+
+        at = self._run_app_and_verify_no_errors(app_test)
+
+        # Should have Populate button
+        buttons = at.get("button")
+        populate_button = next(
+            (b for b in buttons if hasattr(b, "label") and "Populate Vector Store" in str(b.label)), None
+        )
+        assert populate_button is not None, "Populate button should be present in create new mode"
+
+        # Should NOT have Refresh button when in create new mode
+        refresh_button = next((b for b in buttons if hasattr(b, "label") and "Refresh from OCI" in str(b.label)), None)
+        assert refresh_button is None, "Refresh button should not be present in create new mode"