OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.
Python
feat: add dedicated OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE flag for COS "share all" toggle (#2025) (#2092)
Edwin Jose5388298f62e5
diff --git a/frontend/app/api/queries/useGetSettingsQuery.ts b/frontend/app/api/queries/useGetSettingsQuery.tsindex 8ec5a2add..12c08a2bf 100644--- a/frontend/app/api/queries/useGetSettingsQuery.ts+++ b/frontend/app/api/queries/useGetSettingsQuery.ts@@ -79,6 +79,7 @@ export interface Settings {localhost_url?: string;ingest_via_chat?: boolean;show_provider_ingest_settings?: boolean;+ show_shared_upload_toggle?: boolean;segment_write_key?: string;environment?: string;langflow_port?: string | number | null;diff --git a/frontend/components/cloud-picker/ingest-settings.tsx b/frontend/components/cloud-picker/ingest-settings.tsxindex ceb007bbd..684dc84f5 100644--- a/frontend/components/cloud-picker/ingest-settings.tsx+++ b/frontend/components/cloud-picker/ingest-settings.tsx@@ -44,6 +44,13 @@ interface IngestSettingsProps {onSettingsChange?: (settings: IngestSettingsType) => void;/** When true, show the "Make documents available to all users" toggle. COS ingestion only. */showShared?: boolean;+ /**+ * When false, hide the embedding model, chunking, OCR, and picture description+ * controls, leaving only the shared toggle (if `showShared` is also true). Lets+ * deployments that disable per-upload ingest tuning (e.g. SaaS) still expose the+ * shared toggle on its own. Defaults to true.+ */+ showAdvancedSettings?: boolean;}export const IngestSettings = ({@@ -52,6 +59,7 @@ export const IngestSettings = ({settings,onSettingsChange,showShared = false,+ showAdvancedSettings = true,}: IngestSettingsProps) => {const { isAuthenticated, isNoAuthMode } = useAuth();@@ -158,118 +166,127 @@ export const IngestSettings = ({</CollapsibleTrigger><CollapsibleContent className="data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:slide-up-2 data-[state=open]:slide-down-2">- <div className="mt-6">- {/* Embedding model selection */}- <LabelWrapper- helperText="Model used for knowledge ingest and retrieval"- id="embedding-model-select"- label="Embedding model"- >- <Select- disabled={false}- value={selectEmbeddingValue}- onValueChange={(value) =>- handleSettingsChange({ embeddingModel: value })- }+ {showAdvancedSettings && (+ <div className="mt-6">+ {/* Embedding model selection */}+ <LabelWrapper+ helperText="Model used for knowledge ingest and retrieval"+ id="embedding-model-select"+ label="Embedding model">- <Tooltip>- <TooltipTrigger asChild>- <SelectTrigger id="embedding-model-select">- <SelectValue placeholder="Select an embedding model" />- </SelectTrigger>- </TooltipTrigger>- <TooltipContent>- Choose the embedding model for this upload- </TooltipContent>- </Tooltip>- <SelectContent>- <ModelSelectItems- models={embeddingSelectOptions}- fallbackModels={[]}- provider={currentProvider}+ <Select+ disabled={false}+ value={selectEmbeddingValue}+ onValueChange={(value) =>+ handleSettingsChange({ embeddingModel: value })+ }+ >+ <Tooltip>+ <TooltipTrigger asChild>+ <SelectTrigger id="embedding-model-select">+ <SelectValue placeholder="Select an embedding model" />+ </SelectTrigger>+ </TooltipTrigger>+ <TooltipContent>+ Choose the embedding model for this upload+ </TooltipContent>+ </Tooltip>+ <SelectContent>+ <ModelSelectItems+ models={embeddingSelectOptions}+ fallbackModels={[]}+ provider={currentProvider}+ />+ </SelectContent>+ </Select>+ </LabelWrapper>+ </div>+ )}+ {showAdvancedSettings && (+ <div className="mt-6">+ <div className="flex items-center gap-4 w-full mb-6">+ <div className="w-full">+ <NumberInput+ id="chunk-size"+ label="Chunk size"+ value={currentSettings.chunkSize}+ onChange={(value) =>+ handleSettingsChange({ chunkSize: value })+ }+ unit="characters"/>- </SelectContent>- </Select>- </LabelWrapper>- </div>- <div className="mt-6">- <div className="flex items-center gap-4 w-full mb-6">- <div className="w-full">- <NumberInput- id="chunk-size"- label="Chunk size"- value={currentSettings.chunkSize}- onChange={(value) => handleSettingsChange({ chunkSize: value })}- unit="characters"- />+ </div>+ <div className="w-full">+ <NumberInput+ id="chunk-overlap"+ label="Chunk overlap"+ value={currentSettings.chunkOverlap}+ onChange={(value) =>+ handleSettingsChange({ chunkOverlap: value })+ }+ unit="characters"+ />+ </div></div>- <div className="w-full">- <NumberInput- id="chunk-overlap"- label="Chunk overlap"- value={currentSettings.chunkOverlap}- onChange={(value) =>- handleSettingsChange({ chunkOverlap: value })++ {/* <div className="flex gap-2 items-center justify-between">+ <div>+ <div className="text-sm font-semibold pb-2">Table Structure</div>+ <div className="text-sm text-muted-foreground">+ Capture table structure during ingest.+ </div>+ </div>+ <Switch+ id="table-structure"+ checked={currentSettings.tableStructure}+ onCheckedChange={(checked) =>+ handleSettingsChange({ tableStructure: checked })}- unit="characters"/>- </div>- </div>+ </div> */}- {/* <div className="flex gap-2 items-center justify-between">- <div>- <div className="text-sm font-semibold pb-2">Table Structure</div>- <div className="text-sm text-muted-foreground">- Capture table structure during ingest.+ <div className="flex items-center justify-between border-b pb-3 mb-3">+ <div>+ <div className="text-sm font-semibold pb-2">OCR</div>+ <div className="text-sm text-muted-foreground">+ Extracts text from images/PDFs. Ingest is slower when enabled.+ </div></div>+ <Switch+ checked={currentSettings.ocr}+ onCheckedChange={(checked) =>+ handleSettingsChange({ ocr: checked })+ }+ /></div>- <Switch- id="table-structure"- checked={currentSettings.tableStructure}- onCheckedChange={(checked) =>- handleSettingsChange({ tableStructure: checked })- }- />- </div> */}- <div className="flex items-center justify-between border-b pb-3 mb-3">- <div>- <div className="text-sm font-semibold pb-2">OCR</div>- <div className="text-sm text-muted-foreground">- Extracts text from images/PDFs. Ingest is slower when enabled.- </div>- </div>- <Switch- checked={currentSettings.ocr}- onCheckedChange={(checked) =>- handleSettingsChange({ ocr: checked })+ <div+ className={+ showShared+ ? "flex items-center justify-between border-b pb-3 mb-3"+ : "flex items-center justify-between"}- />- </div>-- <div- className={- showShared- ? "flex items-center justify-between border-b pb-3 mb-3"- : "flex items-center justify-between"- }- >- <div>- <div className="text-sm pb-2 font-semibold">- Picture descriptions- </div>- <div className="text-sm text-muted-foreground">- Adds captions for images. Ingest is more expensive when enabled.+ >+ <div>+ <div className="text-sm pb-2 font-semibold">+ Picture descriptions+ </div>+ <div className="text-sm text-muted-foreground">+ Adds captions for images. Ingest is more expensive when+ enabled.+ </div></div>+ <Switch+ checked={currentSettings.pictureDescriptions}+ onCheckedChange={(checked) =>+ handleSettingsChange({ pictureDescriptions: checked })+ }+ /></div>- <Switch- checked={currentSettings.pictureDescriptions}- onCheckedChange={(checked) =>- handleSettingsChange({ pictureDescriptions: checked })- }- /></div>+ )}+ <div className={showAdvancedSettings ? "" : "mt-6"}>{showShared && (<div className="flex items-center justify-between"><div>diff --git a/frontend/components/connectors/shared-bucket-view.tsx b/frontend/components/connectors/shared-bucket-view.tsxindex fe690f405..d0b65997c 100644--- a/frontend/components/connectors/shared-bucket-view.tsx+++ b/frontend/components/connectors/shared-bucket-view.tsx@@ -55,6 +55,11 @@ export function SharedBucketView({});const showIngestSettings =apiSettings?.show_provider_ingest_settings ?? false;+ // The shared toggle can be exposed on its own (e.g. for SaaS deployments that+ // hide the general per-upload ingest tuning knobs) via a dedicated flag.+ const showSharedToggle =+ showShared &&+ (showIngestSettings || (apiSettings?.show_shared_upload_toggle ?? false));const [selectedBuckets, setSelectedBuckets] = useState<Set<string>>(new Set(),@@ -128,7 +133,9 @@ export function SharedBucketView({selected_files: [],bucket_filter: Array.from(selectedBuckets),settings: ingestSettings,- shared: showShared ? (ingestSettings.shared ?? false) : undefined,+ shared: showSharedToggle+ ? (ingestSettings.shared ?? false)+ : undefined,},},{@@ -299,13 +306,14 @@ export function SharedBucketView({</div>)}- {showIngestSettings && (+ {(showIngestSettings || showSharedToggle) && (<IngestSettingsisOpen={isSettingsOpen}onOpenChange={setIsSettingsOpen}settings={ingestSettings}onSettingsChange={setIngestSettings}- showShared={showShared}+ showShared={showSharedToggle}+ showAdvancedSettings={showIngestSettings}/>)}</div>diff --git a/src/api/settings/endpoints.py b/src/api/settings/endpoints.pyindex 4416be98f..096f49d97 100644--- a/src/api/settings/endpoints.py+++ b/src/api/settings/endpoints.py@@ -69,6 +69,7 @@ from config.settings import (LOCALHOST_URL,OPENRAG_INGEST_VIA_CHAT,OPENRAG_SHOW_PROVIDER_INGEST_SETTINGS,+ OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE,SEGMENT_WRITE_KEY,clients,config_manager,@@ -242,6 +243,7 @@ async def get_settings(ingestion_defaults=ingestion_defaults_obj,ingest_via_chat=OPENRAG_INGEST_VIA_CHAT,show_provider_ingest_settings=OPENRAG_SHOW_PROVIDER_INGEST_SETTINGS,+ show_shared_upload_toggle=OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE,segment_write_key=SEGMENT_WRITE_KEY or None,environment=ENVIRONMENT or None,langflow_port=str(LANGFLOW_PORT),diff --git a/src/api/settings/models.py b/src/api/settings/models.pyindex 2f2fad831..9a99ab9b3 100644--- a/src/api/settings/models.py+++ b/src/api/settings/models.py@@ -195,6 +195,7 @@ class SettingsResponse(BaseModel):ingestion_defaults: IngestionDefaultsConfig | None = Noneingest_via_chat: bool = Falseshow_provider_ingest_settings: bool = False+ show_shared_upload_toggle: bool = Falsesegment_write_key: str | None = Noneenvironment: str | None = Nonelangflow_port: str | None = Nonediff --git a/src/config/settings.py b/src/config/settings.pyindex 238153a25..871133720 100644--- a/src/config/settings.py+++ b/src/config/settings.py@@ -527,6 +527,14 @@ OPENRAG_SHOW_PROVIDER_INGEST_SETTINGS = os.getenv("OPENRAG_SHOW_PROVIDER_INGEST_SETTINGS", "false").lower() in ("true", "1", "yes")+# Show the "Make documents available to all users" (shared) toggle for COS bucket+# ingestion, independent of OPENRAG_SHOW_PROVIDER_INGEST_SETTINGS. Deployments that+# hide the general per-upload ingest tuning knobs (e.g. SaaS) can still opt back into+# just this toggle by setting this flag on its own.+OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE = os.getenv(+ "OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE", "false"+).lower() in ("true", "1", "yes")+# Ingest sample data configurationINGEST_SAMPLE_DATA = os.getenv("INGEST_SAMPLE_DATA", "true").lower() in ("true", "1", "yes")diff --git a/tests/unit/config/test_show_shared_upload_toggle.py b/tests/unit/config/test_show_shared_upload_toggle.pynew file mode 100644index 000000000..f667814aa--- /dev/null+++ b/tests/unit/config/test_show_shared_upload_toggle.py@@ -0,0 +1,72 @@+"""Regression tests for the OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE flag.++This flag lets deployments expose the COS "Make documents available to all+users" toggle independently of OPENRAG_SHOW_PROVIDER_INGEST_SETTINGS, which+gates the rest of the per-upload ingest tuning knobs (chunk size, OCR, etc.).+Make sure to update this test when the flag is removed.+"""++import os+import subprocess+import sys+from pathlib import Path++ROOT = Path(__file__).resolve().parent.parent.parent.parent+SRC = ROOT / "src"+++def _python_env(env: dict[str, str]) -> dict[str, str]:+ merged = os.environ.copy()+ merged.update(env)+ return merged+++def _read_flag(env: dict[str, str]) -> str:+ result = subprocess.run(+ [+ sys.executable,+ "-c",+ "from config import settings; print(settings.OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE)",+ ],+ capture_output=True,+ text=True,+ check=True,+ env=_python_env(env),+ cwd=str(ROOT),+ )+ return result.stdout.splitlines()[-1].strip()+++def test_defaults_false_when_unset():+ env = {"PYTHONPATH": str(SRC)}+ env.pop("OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE", None)+ assert _read_flag(env) == "False"+++def test_true_when_enabled():+ env = {"OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE": "true", "PYTHONPATH": str(SRC)}+ assert _read_flag(env) == "True"+++def test_independent_of_show_provider_ingest_settings():+ """The shared-only flag can be enabled while the general flag stays off."""+ env = {+ "OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE": "true",+ "OPENRAG_SHOW_PROVIDER_INGEST_SETTINGS": "false",+ "PYTHONPATH": str(SRC),+ }+ result = subprocess.run(+ [+ sys.executable,+ "-c",+ "from config import settings; "+ "print(settings.OPENRAG_SHOW_SHARED_UPLOAD_TOGGLE, "+ "settings.OPENRAG_SHOW_PROVIDER_INGEST_SETTINGS)",+ ],+ capture_output=True,+ text=True,+ check=True,+ env=_python_env(env),+ cwd=str(ROOT),+ )+ assert result.stdout.splitlines()[-1].strip() == "True False"