Skip to content

OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.

Python

fix: Enhance EnvManager to preserve unmanaged .env variables during save

Rico Furtado07d48308f192
diff --git a/src/tui/managers/env_manager.py b/src/tui/managers/env_manager.py
index b940f2a0e..3d707103e 100644
--- a/src/tui/managers/env_manager.py
+++ b/src/tui/managers/env_manager.py
@@ -1,6 +1,7 @@
"""Environment configuration manager for OpenRAG TUI."""
import os
+import re
import secrets
import string
from dataclasses import dataclass, field
@@ -155,19 +156,9 @@ class EnvManager:
escaped_value = value.replace("'", "'\\''")
return f"'{escaped_value}'"
- def load_existing_env(self) -> bool:
- """Load existing .env file if it exists, or fall back to environment variables.
-
- Uses python-dotenv's load_dotenv() for standard .env file parsing, which handles:
- - Quoted values (single and double quotes)
- - Variable expansion (${VAR})
- - Multiline values
- - Escaped characters
- - Comments
- """
- # Map env vars to config attributes
- # These are environment variable names, not actual secrets
- attr_map = { # pragma: allowlist secret
+ def _env_attr_map(self) -> Dict[str, str]:
+ """Map env vars to EnvConfig attribute names."""
+ return { # pragma: allowlist secret
"OPENAI_API_KEY": "openai_api_key", # pragma: allowlist secret
"ANTHROPIC_API_KEY": "anthropic_api_key", # pragma: allowlist secret
"OLLAMA_ENDPOINT": "ollama_endpoint",
@@ -212,6 +203,48 @@ class EnvManager:
"LANGFUSE_HOST": "langfuse_host",
}
+ def _collect_preserved_env_lines(self) -> list[str]:
+ """Collect existing .env assignments not managed by this TUI."""
+ if not self.env_file.exists():
+ return []
+
+ managed_vars = set(self._env_attr_map().keys())
+ assignment_pattern = re.compile(r"^\s*(?:export\s+)?([A-Za-z_][A-Za-z0-9_]*)\s*=")
+ preserved_lines: list[str] = []
+
+ try:
+ for raw_line in self.env_file.read_text().splitlines():
+ stripped = raw_line.strip()
+ if not stripped or stripped.startswith("#"):
+ continue
+
+ match = assignment_pattern.match(raw_line)
+ if not match:
+ continue
+
+ env_var = match.group(1)
+ if env_var in managed_vars:
+ continue
+ preserved_lines.append(raw_line)
+ except Exception:
+ logger.warning(f"Failed to preserve custom .env lines from {self.env_file}")
+
+ return preserved_lines
+
+ def load_existing_env(self) -> bool:
+ """Load existing .env file if it exists, or fall back to environment variables.
+
+ Uses python-dotenv's load_dotenv() for standard .env file parsing, which handles:
+ - Quoted values (single and double quotes)
+ - Variable expansion (${VAR})
+ - Multiline values
+ - Escaped characters
+ - Comments
+ """
+ # Map env vars to config attributes
+ # These are environment variable names, not actual secrets
+ attr_map = self._env_attr_map()
+
loaded_from_file = False
# Load .env file using python-dotenv for standard parsing
@@ -371,6 +404,7 @@ class EnvManager:
try:
# Ensure secure defaults (including Langflow secret key) are set before saving
self.setup_secure_defaults()
+ preserved_custom_lines = self._collect_preserved_env_lines()
# Create timestamped backup if file exists
if self.env_file.exists():
timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
@@ -552,6 +586,12 @@ class EnvManager:
if langfuse_written:
f.write("\n")
+ if preserved_custom_lines:
+ f.write("# Preserved custom settings\n")
+ for line in preserved_custom_lines:
+ f.write(f"{line}\n")
+ f.write("\n")
+
f.flush()
os.fsync(f.fileno())
diff --git a/tests/unit/test_env_manager.py b/tests/unit/test_env_manager.py
index 8cc605781..267fb3e93 100644
--- a/tests/unit/test_env_manager.py
+++ b/tests/unit/test_env_manager.py
@@ -87,6 +87,25 @@ class TestSaveEnvFilePermissions:
f"expected 0o600, got {oct(_perms(backups[0]))}"
)
+ def test_preserves_unmanaged_env_variables(self, env_manager, tmp_path):
+ """Saving config must keep existing .env keys that TUI does not manage."""
+ env_file = tmp_path / ".env"
+ env_file.write_text(
+ "OPENRAG_BACKEND_HOST='my-host'\n"
+ "OPENSEARCH_PASSWORD='old-password'\n"
+ )
+
+ env_manager.config.opensearch_password = "NewSecurePass!123"
+
+ with patch("tui.utils.version_check.get_current_version", return_value="1.0.0"):
+ result = env_manager.save_env_file()
+
+ assert result is True
+ content = env_file.read_text()
+ assert "OPENRAG_BACKEND_HOST='my-host'" in content
+ assert content.count("OPENRAG_BACKEND_HOST=") == 1
+ assert "OPENSEARCH_PASSWORD='NewSecurePass!123'" in content
+
# ---------------------------------------------------------------------------
# ensure_openrag_version