local-deep-research 0.4.1__tar.gz → 0.4.3__tar.gz

{local_deep_research-0.4.1 → local_deep_research-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: local-deep-research
-Version: 0.4.1
+Version: 0.4.3
 Summary: AI-powered research assistant with deep, iterative analysis using LLMs and web searches
 Author-Email: LearningCircuit <185559241+LearningCircuit@users.noreply.github.com>, HashedViking <6432677+HashedViking@users.noreply.github.com>
 License: MIT License

{local_deep_research-0.4.1 → local_deep_research-0.4.3}/pyproject.toml

@@ -65,7 +65,7 @@ dependencies = [
     "plotly>=6.0.1",
     "kaleido==0.1.0",
 ]
-version = "0.4.1"
+version = "0.4.3"
 
 [project.license]
 file = "LICENSE"

local_deep_research-0.4.3/src/local_deep_research/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.4.3"

{local_deep_research-0.4.1 → local_deep_research-0.4.3}/src/local_deep_research/config/llm_config.py

@@ -79,7 +79,7 @@ def get_llm(model_name=None, temperature=None, provider=None, openai_endpoint_ur
     if get_db_setting("llm.supports_max_tokens", True):
         # Use 80% of context window to leave room for prompts
         max_tokens = min(
-            get_db_setting("llm.max_tokens", 30000), int(context_window_size * 0.8)
+            int(get_db_setting("llm.max_tokens", 30000)), int(context_window_size * 0.8)
         )
         common_params["max_tokens"] = max_tokens
 

{local_deep_research-0.4.1 → local_deep_research-0.4.3}/src/local_deep_research/defaults/default_settings.json

@@ -342,7 +342,7 @@
         "options": null,
         "step": 0.05,
         "type": "LLM",
-        "ui_element": "slider",
+        "ui_element": "range",
         "value": 0.7,
         "visible": true
     },

{local_deep_research-0.4.1 → local_deep_research-0.4.3}/src/local_deep_research/web/services/settings_manager.py

@@ -1,10 +1,10 @@
 import importlib.resources as pkg_resources
 import json
 import os
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict, Optional, Type, Union
 
 from loguru import logger
-from sqlalchemy import func
+from sqlalchemy import func, or_
 from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy.orm import Session
 
@@ -45,6 +45,15 @@ class SettingsManager:
     Provides methods to get and set settings, with the ability to override settings in memory.
     """
 
+    _UI_ELEMENT_TO_SETTING_TYPE = {
+        "text": str,
+        "password": str,
+        "select": str,
+        "number": float,
+        "range": float,
+        "checkbox": bool,
+    }
+
     def __init__(self, db_session: Session):
         """
         Initialize the settings manager
@@ -59,6 +68,57 @@ class SettingsManager:
         default_settings = pkg_resources.read_text(defaults, "default_settings.json")
         self.default_settings = json.loads(default_settings)
 
+    def __get_typed_setting_value(
+        self, setting: Type[Setting], default: Any = None, check_env: bool = True
+    ) -> str | float | bool | None:
+        """
+        Extracts the value for a particular setting, ensuring that it has the
+        correct type.
+
+        Args:
+            setting: The setting to get the value for.
+            default: Default value to return if the value of the setting is
+                invalid.
+            check_env: If true, it will check the environment variable for
+                this setting before reading from the DB.
+
+        Returns:
+            The value of the setting.
+
+        """
+        setting_type = self._UI_ELEMENT_TO_SETTING_TYPE.get(setting.ui_element, None)
+        if setting_type is None:
+            logger.warning(
+                "Got unknown type {} for setting {}, returning default value.",
+                setting.ui_element,
+                setting.key,
+            )
+            return default
+
+        # Check environment variable first, then database.
+        if check_env:
+            env_value = check_env_setting(setting.key)
+            if env_value is not None:
+                try:
+                    return setting_type(env_value)
+                except ValueError:
+                    logger.warning(
+                        "Setting {} has invalid value {}. Falling back to DB.",
+                        setting.key,
+                        env_value,
+                    )
+
+        # If environment variable does not exist, read from the database.
+        try:
+            return setting_type(setting.value)
+        except ValueError:
+            logger.warning(
+                "Setting {} has invalid value {}. Returning default.",
+                setting.key,
+                setting.value,
+            )
+            return default
+
     def get_setting(self, key: str, default: Any = None, check_env: bool = True) -> Any:
         """
         Get a setting value
@@ -72,37 +132,29 @@ class SettingsManager:
         Returns:
             Setting value or default if not found
         """
-        if check_env:
-            env_value = check_env_setting(key)
-            if env_value is not None:
-                return env_value
-
         # If using database first approach and session available, check database
         if self.db_first and self.db_session:
             try:
                 settings = (
                     self.db_session.query(Setting)
                     # This will find exact matches and any subkeys.
-                    .filter(Setting.key.startswith(key)).all()
+                    .filter(
+                        or_(Setting.key == key, Setting.key.startswith(f"{key}."))
+                    ).all()
                 )
                 if len(settings) == 1:
                     # This is a bottom-level key.
-                    value = settings[0].value
-                    return value
+                    return self.__get_typed_setting_value(
+                        settings[0], default, check_env
+                    )
                 elif len(settings) > 1:
                     # This is a higher-level key.
                     settings_map = {}
                     for setting in settings:
                         output_key = setting.key.removeprefix(f"{key}.")
-                        value = setting.value
-
-                        if check_env:
-                            # Handle possible replacements from environment variables.
-                            env_value = check_env_setting(setting.key)
-                            if env_value is not None:
-                                value = env_value
-
-                        settings_map[output_key] = value
+                        settings_map[output_key] = self.__get_typed_setting_value(
+                            setting, default, check_env
+                        )
                     return settings_map
             except SQLAlchemyError as e:
                 logger.error(f"Error retrieving setting {key} from database: {e}")
@@ -149,6 +201,7 @@ class SettingsManager:
                         value=value,
                         type=setting_type,
                         name=key.split(".")[-1].replace("_", " ").title(),
+                        ui_element="text",
                         description=f"Setting for {key}",
                     )
                     self.db_session.add(new_setting)

{local_deep_research-0.4.1 → local_deep_research-0.4.3}/src/local_deep_research/web_search_engines/engines/search_engine_searxng.py

@@ -98,7 +98,7 @@ class SearXNGSearchEngine(BaseSearchEngine):
         self.language = language
         try:
             self.safe_search = SafeSearchSetting[safe_search]
-        except ValueError:
+        except KeyError:
             logger.error(
                 "'{}' is not a valid safe search setting. Disabling safe search",
                 safe_search,

{local_deep_research-0.4.1 → local_deep_research-0.4.3}/src/local_deep_research/web_search_engines/search_engines_config.py

@@ -4,20 +4,12 @@ Loads search engine definitions from the user's configuration.
 """
 
 import json
-
-import logging
-from typing import Any, Dict, List
-
-from ..utilities.db_utils import get_db_setting
-from .default_search_engines import get_default_elasticsearch_config
-
-from functools import cache
 from typing import Any, Dict, List
 
 from loguru import logger
 
-
 from ..utilities.db_utils import get_db_setting
+from .default_search_engines import get_default_elasticsearch_config
 
 
 def _extract_per_engine_config(raw_config: Dict[str, Any]) -> Dict[str, Dict[str, Any]]:
@@ -69,7 +61,7 @@ def search_config() -> Dict[str, Any]:
     # Add alias for 'auto' if it exists
     if "auto" in search_engines and "meta" not in search_engines:
         search_engines["meta"] = search_engines["auto"]
-        
+
     # Add Elasticsearch search engine if not already present
     if "elasticsearch" not in search_engines:
         logger.info("Adding default Elasticsearch search engine configuration")
@@ -91,7 +83,7 @@ def search_config() -> Dict[str, Any]:
                 config["paths"] = json.loads(config["paths"])
             except json.decoder.JSONDecodeError:
                 logger.error(
-                    f"Invalid paths specified for local collection: "
+                    f"Path for local collection '{collection}' is not a valid JSON array: "
                     f"{config['paths']}"
                 )
                 config["paths"] = []

local_deep_research-0.4.3/tests/conftest.py

@@ -0,0 +1,119 @@
+from typing import Any
+
+import pytest
+from sqlalchemy import create_engine
+from sqlalchemy.exc import SQLAlchemyError
+from sqlalchemy.orm import sessionmaker
+
+import src.local_deep_research.utilities.db_utils as db_utils_module
+from src.local_deep_research.web.database.models import Base
+from src.local_deep_research.web.services.settings_manager import SettingsManager
+
+
+@pytest.fixture(scope="session", autouse=True)
+def setup_database_for_all_tests(
+    tmp_path_factory, session_mocker
+):  # Directly use the session_mocker provided by pytest-mock
+    """
+    Provides a database setup for a temporary SQLite file database for the entire test session.
+    It patches db_utils.get_db_session and db_utils.get_settings_manager to use this test DB.
+    """
+
+    # Call cache_clear on the functions from db_utils_module.
+    # This ensures any pre-existing cached instances are gone.
+    # We must ensure db_utils_module is imported before this point.
+    try:
+        if hasattr(db_utils_module.get_db_session, "cache_clear"):
+            db_utils_module.get_db_session.cache_clear()
+        if hasattr(db_utils_module.get_settings_manager, "cache_clear"):
+            db_utils_module.get_settings_manager.cache_clear()
+        if hasattr(db_utils_module.get_db_setting, "cache_clear"):
+            db_utils_module.get_db_setting.cache_clear()  # Clear get_db_setting's cache too
+
+    except Exception as e:
+        print(f"ERROR: Failed to clear db_utils caches aggressively: {e}")
+        # This shouldn't prevent test run, but indicates a problem with cache_clear
+
+    # Debug tmp_path_factory behavior
+    temp_dir = tmp_path_factory.mktemp("db_test_data")
+    db_file = temp_dir / "test_settings.db"
+    db_url = f"sqlite:///{db_file}"
+
+    engine = None
+    try:
+        engine = create_engine(db_url)
+    except Exception as e:
+        print(f"ERROR: Failed to create SQLAlchemy engine: {e}")
+        raise
+
+    try:
+        Base.metadata.create_all(engine)
+    except SQLAlchemyError as e:
+        print(f"ERROR: SQLAlchemyError during Base.metadata.create_all: {e}")
+        raise
+    except Exception as e:
+        print(f"ERROR: Unexpected error during Base.metadata.create_all: {e}")
+        raise
+
+    SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+    temp_session = SessionLocal()
+    temp_settings_manager = SettingsManager(db_session=temp_session)
+
+    try:
+        temp_settings_manager.load_from_defaults_file(commit=True)
+    except Exception as e:
+        print(f"ERROR: Failed to load default settings: {e}")
+        temp_session.rollback()  # Rollback if default loading fails
+        raise  # Re-raise to fail the test if default loading is critical
+    finally:
+        temp_session.close()  # Close the temporary session used for loading defaults
+
+    # Clear caches and patch
+    db_utils_module.get_db_session.cache_clear()
+    db_utils_module.get_settings_manager.cache_clear()
+
+    mock_get_db_session = session_mocker.patch(
+        "src.local_deep_research.utilities.db_utils.get_db_session"
+    )
+    mock_get_db_session.side_effect = SessionLocal
+
+    mock_get_settings_manager = session_mocker.patch(
+        "src.local_deep_research.utilities.db_utils.get_settings_manager"
+    )
+    mock_get_settings_manager.side_effect = lambda: SettingsManager(
+        db_session=mock_get_db_session()
+    )
+
+    yield SessionLocal  # Yield the SessionLocal class for individual tests to create sessions
+
+    if engine:
+        engine.dispose()  # Dispose the engine to close all connections
+    # tmp_path_factory handles deleting the temporary directory and its contents
+
+
+@pytest.fixture
+def mock_db_session(mocker):
+    return mocker.MagicMock()
+
+
+@pytest.fixture
+def mock_logger(mocker):
+    mocked_logger = mocker.patch(
+        "src.local_deep_research.web.services.settings_manager.logger"
+    )
+
+    def _print_to_console(message: str, *args: Any) -> None:
+        # Handle loguru formatting.
+        message = message.format(*args)
+        print(f"LOG: {message}")
+        return mocker.DEFAULT
+
+    # Pass through logged messages to the console.
+    mocked_logger.debug = mocker.MagicMock(side_effect=_print_to_console)
+    mocked_logger.info = mocker.MagicMock(side_effect=_print_to_console)
+    mocked_logger.warning = mocker.MagicMock(side_effect=_print_to_console)
+    mocked_logger.error = mocker.MagicMock(side_effect=_print_to_console)
+    mocked_logger.critical = mocker.MagicMock(side_effect=_print_to_console)
+    mocked_logger.exception = mocker.MagicMock(side_effect=_print_to_console)
+
+    return mocked_logger

local_deep_research-0.4.3/tests/test_settings_manager.py

@@ -0,0 +1,260 @@
+import os
+from typing import Any
+
+import pytest
+from sqlalchemy.exc import SQLAlchemyError
+
+from src.local_deep_research.web.services.settings_manager import (
+    Setting,
+    SettingsManager,
+    SettingType,
+    check_env_setting,
+)
+
+
+def test_check_env_setting_exists(monkeypatch):
+    monkeypatch.setenv("LDR_APP_VERSION", "1.0.0")
+    assert check_env_setting("app.version") == "1.0.0"
+
+
+def test_check_env_setting_not_exists():
+    # Ensure the environment variable is not set
+    if "LDR_APP_VERSION" in os.environ:
+        del os.environ["LDR_APP_VERSION"]
+    assert check_env_setting("app.version") is None
+
+
+@pytest.mark.parametrize(
+    "ui_element, setting_value, expected",
+    [
+        ("text", "hello", "hello"),
+        ("select", "option_a", "option_a"),
+        ("password", "secret", "secret"),
+        ("number", "3.14", 3.14),
+        ("range", "3.14", 3.14),
+        ("checkbox", "true", True),
+    ],
+)
+def test_get_setting_from_db(
+    mocker, ui_element: str, setting_value: str, expected: Any
+):
+    """
+    Tests that we can successfully read settings from the DB.
+
+    Args:
+        mocker: The fixture to use for mocking.
+        ui_element: The value of the `ui_element` parameter, which controls the return type.
+        setting_value: The value to use for the setting in the DB.
+        expected: The expected typed value of the setting.
+    """
+    # Arrange: Set up the mock database session and a sample setting
+    mock_db_session = mocker.MagicMock()
+    mock_setting = Setting(
+        key="test.setting", value=setting_value, ui_element=ui_element
+    )
+    mock_db_session.query.return_value.filter.return_value.all.return_value = [
+        mock_setting
+    ]
+
+    # Act: Call the get_setting method with the test key
+    settings_manager = SettingsManager(db_session=mock_db_session)
+    result = settings_manager.get_setting("test.setting")
+
+    # Assert: Verify that the result matches the expected value
+    assert result == expected, f"Expected {expected}, but got {result}"
+
+
+@pytest.mark.parametrize(
+    "ui_element, env_value, expected",
+    [
+        ("text", "hello", "hello"),
+        ("select", "option_a", "option_a"),
+        ("password", "secret", "secret"),
+        ("number", "3.14", 3.14),
+        ("range", "3.14", 3.14),
+        ("checkbox", "true", True),
+    ],
+)
+def test_get_setting_from_env(
+    mocker, monkeypatch, ui_element: str, env_value: str, expected: Any
+):
+    """
+    Tests that we can successfully override DB settings with environment
+    variables.
+
+    Args:
+        mocker: The fixture to use for mocking.
+        ui_element: The value of the `ui_element` parameter, which controls the return type.
+        env_value: The value to use for the setting in the environment variable.
+        expected: The expected typed value of the setting.
+    """
+    # Arrange: Set up the mock database session and ensure an environment variable is set
+    mock_db_session = mocker.MagicMock()
+    monkeypatch.setenv("LDR_TEST_SETTING", env_value)
+    # Ensure DB query returns an old version to verify environment variable is prioritized
+    mock_setting = Setting(key="test.setting", value="db_value", ui_element=ui_element)
+    mock_db_session.query.return_value.filter.return_value.all.return_value = [
+        mock_setting
+    ]
+
+    # Act: Call the get_setting method with the test key
+    settings_manager = SettingsManager(db_session=mock_db_session)
+    result = settings_manager.get_setting("test.setting")
+
+    # Assert: Verify that the result matches the expected value
+    assert result == expected, f"Expected {expected}, but got {result}"
+
+
+def test_get_setting_default(mocker):
+    mock_db_session = mocker.MagicMock()
+    # Ensure DB query returns nothing
+    mock_db_session.query.return_value.filter.return_value.all.return_value = []
+
+    settings_manager = SettingsManager(db_session=mock_db_session)
+    assert (
+        settings_manager.get_setting("non_existent_setting", default="default_value")
+        == "default_value"
+    )
+
+
+def test_get_setting_invalid_type(mocker):
+    """
+    Tests that when a setting's value cannot be converted to the type
+    specified by the `ui_element`, it will always return the default value.
+
+    Args:
+        mocker: The fixture to use for mocking.
+
+    """
+    # Arrange: Set up a mock DB session and setting with an invalid type
+    mock_db_session = mocker.MagicMock()
+    mock_setting = Setting(
+        key="test.invalid_type", value="not_a_number", ui_element="number"
+    )
+    mock_db_session.query.return_value.filter.return_value.all.return_value = [
+        mock_setting
+    ]
+
+    # Act: Call get_setting with a default value and an invalid type
+    settings_manager = SettingsManager(db_session=mock_db_session)
+    result = settings_manager.get_setting("test.invalid_type", default=10)
+
+    # Assert: Check that the default value is returned and not the invalid string
+    assert result == 10
+
+
+# The mocker fixture is automatically available
+def test_set_setting_update_existing(mocker):
+    mock_db_session = mocker.MagicMock()
+    mock_setting = Setting(key="app.version", value="1.0.0")
+    mock_db_session.query.return_value.filter.return_value.first.return_value = (
+        mock_setting
+    )
+    mocker.patch(
+        "src.local_deep_research.web.services.settings_manager.func.now"
+    )  # Patching the func.now call
+
+    settings_manager = SettingsManager(db_session=mock_db_session)
+    result = settings_manager.set_setting("app.version", "2.0.0")
+
+    assert result is True
+    assert mock_setting.value == "2.0.0"
+    mock_db_session.commit.assert_called_once()
+    mock_db_session.rollback.assert_not_called()
+
+
+def test_set_setting_create_new(mocker):
+    mock_db_session = mocker.MagicMock()
+    mock_db_session.query.return_value.filter.return_value.first.return_value = None
+    mocker.patch(
+        "src.local_deep_research.web.services.settings_manager.func.now"
+    )  # Patching the func.now call
+
+    settings_manager = SettingsManager(db_session=mock_db_session)
+    result = settings_manager.set_setting("new.setting", "new_value")
+
+    assert result is True
+    mock_db_session.add.assert_called_once()
+    new_setting = mock_db_session.add.call_args[0][0]
+    assert isinstance(new_setting, Setting)
+    assert new_setting.key == "new.setting"
+    assert new_setting.value == "new_value"
+    assert new_setting.type == SettingType.APP  # Assuming 'app' type for this key
+    mock_db_session.commit.assert_called_once()
+    mock_db_session.rollback.assert_not_called()
+
+
+def test_set_setting_db_error(mocker):
+    mock_db_session = mocker.MagicMock()
+    # Set the side_effect to an instance of SQLAlchemyError
+    mock_db_session.query.return_value.filter.return_value.first.side_effect = (
+        SQLAlchemyError("Simulated DB Error")
+    )
+
+    # Mock the logger to check if error is logged
+    mock_logger = mocker.patch(
+        "src.local_deep_research.web.services.settings_manager.logger"
+    )
+
+    settings_manager = SettingsManager(db_session=mock_db_session)
+    result = settings_manager.set_setting("app.version", "2.0.0")
+
+    # Assert that the method returned False
+    assert result is False
+
+    mock_db_session.rollback.assert_called_once()
+    mock_db_session.commit.assert_not_called()
+    mock_logger.error.assert_called_once()
+    # mock_logger.error.assert_called_once_with("Error setting value for app.version: Simulated DB Error")
+
+
+def test_get_setting_with_substring_keys(setup_database_for_all_tests):
+    """
+    Tests that we can get the correct value for a setting, even when its key
+    is a substring of the key for a different setting.
+
+    Args:
+        setup_database_for_all_tests: Fixture that sets up a real database
+            for testing. (This is necessary because the bug fix this is
+            testing depends on the actual behavior of the SQLAlchemy `filter()`
+            function.)
+
+    """
+    # Arrange.
+    session_local_class = setup_database_for_all_tests
+    session = session_local_class()
+
+    with session:
+        # Add two settings with overlapping keys but different full keys
+        setting1 = Setting(
+            key="test.hello",
+            value="world",
+            ui_element="text",
+            type="APP",
+            name="Test Setting 1",
+            visible=True,
+            editable=True,
+        )
+        setting2 = Setting(
+            key="test.hello_world",
+            value="universe",
+            ui_element="text",
+            type="APP",
+            name="Test Setting 2",
+            visible=True,
+            editable=True,
+        )
+        session.add(setting1)
+        session.add(setting2)
+        session.commit()
+
+        settings_manager = SettingsManager(db_session=session)
+
+        # Act and assert.
+        # Test getting the "test.hello" setting
+        result1 = settings_manager.get_setting("test.hello")
+        assert result1 == "world"
+
+        # Test getting the "test.hello_world" setting.
+        result2 = settings_manager.get_setting("test.hello_world")
+        assert result2 == "universe"

local_deep_research-0.4.1/src/local_deep_research/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.4.1"