mirror of
https://github.com/tiennm99/DocsGPT.git
synced 2026-10-13 06:14:51 +00:00
refactor(settings): treat unset spellings of every optional string as None
Review follow-up. The per-group secret validators normalised a hand-picked list of API keys, which left other optional credentials and overrides (OPEN_ROUTER_API_KEY, S3 and Daytona keys, ELASTIC_PASSWORD, the OIDC trio, connector client ids, MICROSOFT_AUTHORITY, MCP_OAUTH_REDIRECT_URI) holding the literal "None" or "" a .env file spells "unset" with, so truthiness checks and fallbacks downstream saw a value. One rule on the group base replaces those lists: every Optional[str] field maps "", "None" and whitespace to None and strips real values. Plain str fields are left alone. The OIDC required-settings check therefore also rejects those spellings. EMBEDDINGS_POOLING is Literal["cls", "mean"] with case-insensitive parsing; its consumer silently ignored anything else. Bounds added where the consumer rejects or misbehaves on the value: SCHEDULE_RUN_OUTPUT_RETENTION_DAYS and MESSAGE_EVENTS_RETENTION_DAYS (the cleanup repositories raise on <= 0), EMBEDDINGS_DELEGATE_TIMEOUT, the remote-device idle/pairing/invocation TTLs and CELERY_VISIBILITY_TIMEOUT (> 0), REMOTE_DEVICE_CMD_QUEUE_TTL_SECONDS (> 605, the documented drain deadline), GRAPHRAG_MAX_CHUNKS_FOR_EXTRACTION (>= 0; negative would slice the pending list from the end). The generated reference now renders generic type arguments (dict[str, int] rather than dict).
This commit is contained in:
1 parent
f882ef49a7
commit
5578039c19
13 files changed
+113
-67
No files matched your search
@@ -9,16 +9,43 @@ domain's definitions live in their own module.
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import types
|
||||
import typing
|
||||
from typing import Any, Optional
|
||||
|
||||
from pydantic import model_validator
|
||||
from pydantic_settings import BaseSettings, SettingsConfigDict
|
||||
|
||||
|
||||
def _is_optional_str(annotation: Any) -> bool:
|
||||
if typing.get_origin(annotation) not in (typing.Union, types.UnionType):
|
||||
return False
|
||||
return set(typing.get_args(annotation)) == {str, type(None)}
|
||||
|
||||
|
||||
class SettingsGroup(BaseSettings):
|
||||
"""Base for one domain's settings; groups are composed into ``Settings``."""
|
||||
"""Base for one domain's settings; groups are composed into ``Settings``.
|
||||
|
||||
Every ``Optional[str]`` field treats the spellings an unset value has in a
|
||||
``.env`` file (``KEY=``, ``KEY=None``, whitespace) as ``None``, so a check
|
||||
like ``if settings.OIDC_ISSUER`` or a fallback like ``settings.X or default``
|
||||
sees "unset" rather than a truthy placeholder string. Real values are
|
||||
stripped. Fields typed ``str`` keep whatever they are given.
|
||||
"""
|
||||
|
||||
model_config = SettingsConfigDict(extra="ignore")
|
||||
|
||||
@model_validator(mode="before")
|
||||
@classmethod
|
||||
def _unset_optional_strings(cls, data: Any) -> Any:
|
||||
if not isinstance(data, dict):
|
||||
return data
|
||||
data = dict(data)
|
||||
for name, field in cls.model_fields.items():
|
||||
if name in data and _is_optional_str(field.annotation):
|
||||
data[name] = normalize_secret(data[name])
|
||||
return data
|
||||
|
||||
|
||||
def normalize_choice(value: Any) -> Any:
|
||||
"""Case-fold a closed-choice setting so ``PGVector`` and ``pgvector`` are the same choice."""
|
||||
|
||||
@@ -85,11 +85,6 @@ class AuthSettings(SettingsGroup):
|
||||
default=None, description="Bearer token for IdP SCIM clients (required when SCIM is enabled)."
|
||||
)
|
||||
|
||||
@field_validator("INTERNAL_KEY", mode="before")
|
||||
@classmethod
|
||||
def _normalize_auth_secrets(cls, v):
|
||||
return normalize_secret(v)
|
||||
|
||||
@field_validator("AUTH_TYPE", mode="before")
|
||||
@classmethod
|
||||
def _normalize_auth_type(cls, v):
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Optional
|
||||
from typing import Literal, Optional
|
||||
|
||||
from pydantic import Field, field_validator
|
||||
|
||||
from docsgpt.core.paths import home_dir
|
||||
from docsgpt.core.settings._shared import SettingsGroup, normalize_secret
|
||||
from docsgpt.core.settings._shared import SettingsGroup, normalize_choice
|
||||
|
||||
|
||||
class EmbeddingsSettings(SettingsGroup):
|
||||
@@ -56,7 +56,7 @@ class EmbeddingsSettings(SettingsGroup):
|
||||
"default is the temp dir."
|
||||
),
|
||||
)
|
||||
EMBEDDINGS_POOLING: Optional[str] = Field(
|
||||
EMBEDDINGS_POOLING: Optional[Literal["cls", "mean"]] = Field(
|
||||
default=None,
|
||||
description=(
|
||||
'Pooling strategy ("cls" or "mean"). Read from the model\'s own repository; set only for a '
|
||||
@@ -79,10 +79,10 @@ class EmbeddingsSettings(SettingsGroup):
|
||||
)
|
||||
EMBEDDINGS_QUEUE: str = Field(default="embeddings", description="Celery queue the embed task is routed to.")
|
||||
EMBEDDINGS_DELEGATE_TIMEOUT: int = Field(
|
||||
default=60, description="Seconds the API waits for the worker to return an embedding."
|
||||
default=60, gt=0, description="Seconds the API waits for the worker to return an embedding."
|
||||
)
|
||||
|
||||
@field_validator("EMBEDDINGS_KEY", mode="before")
|
||||
@field_validator("EMBEDDINGS_POOLING", mode="before")
|
||||
@classmethod
|
||||
def _normalize_embeddings_secrets(cls, v):
|
||||
return normalize_secret(v)
|
||||
def _normalize_pooling(cls, v):
|
||||
return normalize_choice(v)
|
||||
@@ -58,6 +58,7 @@ class EventsSettings(SettingsGroup):
|
||||
EVENTS_REPLAY_BUDGET_WINDOW_SECONDS: int = Field(default=60, description="Length of the replay budget window.")
|
||||
MESSAGE_EVENTS_RETENTION_DAYS: int = Field(
|
||||
default=14,
|
||||
gt=0,
|
||||
description=(
|
||||
"Retention for the message_events journal, enforced by the cleanup_message_events beat task. Replay "
|
||||
"only needs streams a client could still be tailing."
|
||||
@@ -66,14 +67,15 @@ class EventsSettings(SettingsGroup):
|
||||
|
||||
# Remote Device feature.
|
||||
REMOTE_DEVICE_SESSION_IDLE_SECONDS: int = Field(
|
||||
default=60, description="Seconds without a heartbeat before a remote-device session is considered idle."
|
||||
default=60, gt=0, description="Seconds without a heartbeat before a remote-device session is considered idle."
|
||||
)
|
||||
REMOTE_DEVICE_REQUIRE_SIGNATURE: bool = Field(
|
||||
default=False, description="Require signed commands from remote devices."
|
||||
)
|
||||
REMOTE_DEVICE_PAIRING_TTL_SECONDS: int = Field(default=600, description="Lifetime of a pairing code.")
|
||||
REMOTE_DEVICE_PAIRING_TTL_SECONDS: int = Field(default=600, gt=0, description="Lifetime of a pairing code.")
|
||||
REMOTE_DEVICE_CMD_QUEUE_TTL_SECONDS: int = Field(
|
||||
default=900,
|
||||
gt=605,
|
||||
description=(
|
||||
"Redis TTL of the per-device command queue, routing invocations cross-process so a scheduled run "
|
||||
"reaches the web-held device session. Must exceed the max drain deadline (605s) so a command for a "
|
||||
@@ -81,7 +83,7 @@ class EventsSettings(SettingsGroup):
|
||||
),
|
||||
)
|
||||
REMOTE_DEVICE_INVOCATION_TTL_SECONDS: int = Field(
|
||||
default=900, description="Redis TTL of a pending remote-device invocation."
|
||||
default=900, gt=0, description="Redis TTL of a pending remote-device invocation."
|
||||
)
|
||||
REMOTE_DEVICE_OUTPUT_STREAM_MAXLEN: int = Field(
|
||||
default=10_000, description="Cap on buffered output entries per remote-device invocation stream."
|
||||
|
||||
@@ -5,10 +5,10 @@ from __future__ import annotations
|
||||
import os
|
||||
from typing import Optional
|
||||
|
||||
from pydantic import Field, field_validator
|
||||
from pydantic import Field
|
||||
|
||||
from docsgpt.core.paths import home_dir
|
||||
from docsgpt.core.settings._shared import SettingsGroup, normalize_secret
|
||||
from docsgpt.core.settings._shared import SettingsGroup
|
||||
|
||||
|
||||
class LLMSettings(SettingsGroup):
|
||||
@@ -104,18 +104,3 @@ class LLMSettings(SettingsGroup):
|
||||
OPENAI_REASONING_SUMMARY: str = Field(
|
||||
default="auto", description="Reasoning summary mode requested from the Responses API."
|
||||
)
|
||||
|
||||
@field_validator(
|
||||
"API_KEY",
|
||||
"OPENAI_API_KEY",
|
||||
"ANTHROPIC_API_KEY",
|
||||
"GOOGLE_API_KEY",
|
||||
"GROQ_API_KEY",
|
||||
"HUGGINGFACE_API_KEY",
|
||||
"NOVITA_API_KEY",
|
||||
"FALLBACK_LLM_API_KEY",
|
||||
mode="before",
|
||||
)
|
||||
@classmethod
|
||||
def _normalize_llm_secrets(cls, v):
|
||||
return normalize_secret(v)
|
||||
@@ -62,7 +62,9 @@ def _type_name(annotation: Any) -> str:
|
||||
if origin is Literal:
|
||||
return " | ".join(json.dumps(v) for v in typing.get_args(annotation))
|
||||
if origin is not None:
|
||||
return getattr(origin, "__name__", str(origin))
|
||||
name = getattr(origin, "__name__", str(origin))
|
||||
args = typing.get_args(annotation)
|
||||
return f"{name}[{', '.join(_type_name(arg) for arg in args)}]" if args else name
|
||||
return getattr(annotation, "__name__", str(annotation))
|
||||
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ class RetrievalSettings(SettingsGroup):
|
||||
default=None, description="Model for ingest-time graph extraction; unset reuses LLM_PROVIDER/LLM_NAME."
|
||||
)
|
||||
GRAPHRAG_MAX_CHUNKS_FOR_EXTRACTION: int = Field(
|
||||
default=2000, description="Hard cap on chunks extracted per source (cost control)."
|
||||
default=2000, ge=0, description="Hard cap on chunks extracted per source (cost control); 0 extracts nothing."
|
||||
)
|
||||
|
||||
@field_validator("VECTOR_STORE", mode="before")
|
||||
|
||||
@@ -25,4 +25,4 @@ class SchedulerSettings(SettingsGroup):
|
||||
SCHEDULE_ONCE_MAX_HORIZON: int = Field(
|
||||
default=31_536_000, description="How far ahead a one-off run may be scheduled, in seconds (one year)."
|
||||
)
|
||||
SCHEDULE_RUN_OUTPUT_RETENTION_DAYS: int = Field(default=90, description="Days scheduled-run output is kept.")
|
||||
SCHEDULE_RUN_OUTPUT_RETENTION_DAYS: int = Field(default=90, gt=0, description="Days scheduled-run output is kept.")
|
||||
@@ -6,7 +6,7 @@ from typing import Literal, Optional
|
||||
|
||||
from pydantic import Field, field_validator
|
||||
|
||||
from docsgpt.core.settings._shared import SettingsGroup, normalize_choice, normalize_secret
|
||||
from docsgpt.core.settings._shared import SettingsGroup, normalize_choice
|
||||
|
||||
|
||||
class SpeechSettings(SettingsGroup):
|
||||
@@ -25,11 +25,6 @@ class SpeechSettings(SettingsGroup):
|
||||
STT_ENABLE_TIMESTAMPS: bool = Field(default=False, description="Return word/segment timestamps.")
|
||||
STT_ENABLE_DIARIZATION: bool = Field(default=False, description="Label speakers in the transcript.")
|
||||
|
||||
@field_validator("ELEVENLABS_API_KEY", mode="before")
|
||||
@classmethod
|
||||
def _normalize_speech_secrets(cls, v):
|
||||
return normalize_secret(v)
|
||||
|
||||
@field_validator("TTS_PROVIDER", "STT_PROVIDER", mode="before")
|
||||
@classmethod
|
||||
def _normalize_speech_providers(cls, v):
|
||||
|
||||
@@ -8,7 +8,7 @@ from pydantic import Field, field_validator
|
||||
|
||||
from docsgpt.core.db_uri import normalize_pgvector_connection_string
|
||||
from docsgpt.core.paths import home_dir
|
||||
from docsgpt.core.settings._shared import SettingsGroup, normalize_secret
|
||||
from docsgpt.core.settings._shared import SettingsGroup
|
||||
|
||||
|
||||
class VectorStoreSettings(SettingsGroup):
|
||||
@@ -82,8 +82,3 @@ class VectorStoreSettings(SettingsGroup):
|
||||
@classmethod
|
||||
def _normalize_pgvector_connection_string(cls, v):
|
||||
return normalize_pgvector_connection_string(v)
|
||||
|
||||
@field_validator("QDRANT_API_KEY", mode="before")
|
||||
@classmethod
|
||||
def _normalize_vectorstore_secrets(cls, v):
|
||||
return normalize_secret(v)
|
||||
@@ -17,6 +17,7 @@ class WorkerSettings(SettingsGroup):
|
||||
)
|
||||
CELERY_VISIBILITY_TIMEOUT: int = Field(
|
||||
default=3600,
|
||||
gt=0,
|
||||
description=(
|
||||
"Broker visibility timeout in seconds. Must exceed the longest legitimate task runtime but stay "
|
||||
"short enough that SIGKILLed tasks redeliver promptly."
|
||||
|
||||
Reference in new issue
Block a user