OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.
Python
fix: validate chunk settings before individual-file ingest (#2433)
Nathan Bakare4c1624f476b0
diff --git a/frontend/components/cloud-picker/types.test.ts b/frontend/components/cloud-picker/types.test.tsindex 8bc049d07..9ad53ea7c 100644--- a/frontend/components/cloud-picker/types.test.ts+++ b/frontend/components/cloud-picker/types.test.ts@@ -1,6 +1,13 @@import assert from "node:assert/strict";-import { describe, expect, it } from "vitest";-import { getChunkSettingsError, getIngestChunkSettingsError } from "./types";+import { toast } from "sonner";+import { beforeEach, describe, expect, it, vi } from "vitest";+import {+ getChunkSettingsError,+ getIngestChunkSettingsError,+ validateIngestSettingsOrToast,+} from "./types";++vi.mock("sonner", () => ({ toast: { error: vi.fn() } }));const validSettings = {embeddingModel: "prod-embed",@@ -86,3 +93,42 @@ describe("getChunkSettingsError", () => {expect(getChunkSettingsError({ chunkSize: 1, chunkOverlap: 0 })).toBeNull();});});++describe("validateIngestSettingsOrToast", () => {+ beforeEach(() => {+ vi.mocked(toast.error).mockClear();+ });++ it("passes when no settings were provided", () => {+ expect(validateIngestSettingsOrToast(undefined)).toBe(true);+ expect(toast.error).not.toHaveBeenCalled();+ });++ it("passes valid settings without a toast", () => {+ expect(validateIngestSettingsOrToast(validSettings)).toBe(true);+ expect(toast.error).not.toHaveBeenCalled();+ });++ it("blocks invalid settings and explains why in a toast", () => {+ expect(+ validateIngestSettingsOrToast({+ ...validSettings,+ chunkSize: 100,+ chunkOverlap: 100,+ }),+ ).toBe(false);+ expect(toast.error).toHaveBeenCalledWith("Could not start ingest", {+ description: "Chunk overlap must be less than chunk size",+ });+ });++ it("blocks a missing embedding model", () => {+ expect(+ validateIngestSettingsOrToast({ ...validSettings, embeddingModel: "" }),+ ).toBe(false);+ expect(toast.error).toHaveBeenCalledWith("Could not start ingest", {+ description:+ "Select an embedding model in Settings before ingesting files",+ });+ });+});diff --git a/frontend/components/cloud-picker/types.ts b/frontend/components/cloud-picker/types.tsindex 1ff837083..69117146c 100644--- a/frontend/components/cloud-picker/types.ts+++ b/frontend/components/cloud-picker/types.ts@@ -1,3 +1,5 @@+import { toast } from "sonner";+export interface CloudFile {id: string;name: string;@@ -142,3 +144,17 @@ export function getChunkSettingsError(}return null;}++export function validateIngestSettingsOrToast(+ settings:+ | Pick<IngestSettings, "embeddingModel" | "chunkSize" | "chunkOverlap">+ | undefined,+): boolean {+ if (!settings) return true;+ const chunkErr = getIngestChunkSettingsError(settings);+ if (chunkErr) {+ toast.error("Could not start ingest", { description: chunkErr });+ return false;+ }+ return true;+}diff --git a/frontend/components/connectors/shared-bucket-view.tsx b/frontend/components/connectors/shared-bucket-view.tsxindex 9f554ffe7..45caf19f0 100644--- a/frontend/components/connectors/shared-bucket-view.tsx+++ b/frontend/components/connectors/shared-bucket-view.tsx@@ -7,7 +7,7 @@ import { toast } from "sonner";import type { useSyncConnector } from "@/app/api/mutations/useSyncConnector";import { useGetSettingsQuery } from "@/app/api/queries/useGetSettingsQuery";import { IngestSettings } from "@/components/cloud-picker/ingest-settings";-import { getIngestChunkSettingsError } from "@/components/cloud-picker/types";+import { validateIngestSettingsOrToast } from "@/components/cloud-picker/types";import { DuplicateHandlingDialog } from "@/components/duplicate-handling-dialog";import { FileBrowserDialog } from "@/components/file-browser-dialog";import { Button } from "@/components/ui/button";@@ -223,11 +223,7 @@ export function SharedBucketView({};const ingestSelected = async () => {- const chunkErr = getIngestChunkSettingsError(ingestSettings);- if (chunkErr) {- toast.error("Could not start ingest", { description: chunkErr });- return;- }+ if (!validateIngestSettingsOrToast(ingestSettings)) return;trackStartProcess({processType: "Ingestion",process: "Document Upload",diff --git a/frontend/components/file-browser-dialog.test.tsx b/frontend/components/file-browser-dialog.test.tsxnew file mode 100644index 000000000..5fb9b9310--- /dev/null+++ b/frontend/components/file-browser-dialog.test.tsx@@ -0,0 +1,70 @@+import { toast } from "sonner";+import { beforeEach, describe, expect, it, vi } from "vitest";+import type { IngestSettings } from "@/components/cloud-picker/types";+import { fireEvent, renderWithProviders, screen } from "@/test-utils/render";+import { FileBrowserDialog } from "./file-browser-dialog";++/**+ * "Browse Files" ingest must honor the same chunk-settings validation as the+ * whole-bucket ingest button (#2070). Both read the shared ingest settings, so+ * without this gate invalid values set on the parent screen reached the backend.+ */++const mutateAsync = vi.fn();++vi.mock("sonner", () => ({+ toast: { success: vi.fn(), error: vi.fn(), info: vi.fn() },+}));++vi.mock("@/app/api/mutations/useSyncConnector", () => ({+ useSyncConnector: () => ({ mutateAsync, isPending: false }),+}));++vi.mock("@/app/api/queries/useBrowseConnectionFiles", () => ({+ useBrowseConnectionFiles: () => ({+ data: { files: [{ id: "f1", name: "report.pdf", size: 1024 }] },+ isLoading: false,+ error: null,+ }),+}));++const baseSettings: IngestSettings = {+ chunkSize: 1000,+ chunkOverlap: 200,+ ocr: false,+ pictureDescriptions: false,+ embeddingModel: "prod-embed",+};++function renderDialog(ingestSettings: IngestSettings) {+ return renderWithProviders(+ <FileBrowserDialog+ open+ onOpenChange={vi.fn()}+ connectorType="ibm_cos"+ connectionId="conn-1"+ ingestSettings={ingestSettings}+ />,+ );+}++describe("FileBrowserDialog ingest validation", () => {+ beforeEach(() => {+ mutateAsync.mockReset();+ vi.mocked(toast.error).mockClear();+ global.fetch = vi.fn();+ });++ it("blocks ingest with a toast when chunk overlap is not below chunk size", () => {+ renderDialog({ ...baseSettings, chunkSize: 100, chunkOverlap: 100 });++ fireEvent.click(screen.getByText("report.pdf"));+ fireEvent.click(screen.getByRole("button", { name: /Ingest 1 file/ }));++ expect(toast.error).toHaveBeenCalledWith("Could not start ingest", {+ description: "Chunk overlap must be less than chunk size",+ });+ expect(global.fetch).not.toHaveBeenCalled();+ expect(mutateAsync).not.toHaveBeenCalled();+ });+});diff --git a/frontend/components/file-browser-dialog.tsx b/frontend/components/file-browser-dialog.tsxindex 84149eed9..f7a1c3a3e 100644--- a/frontend/components/file-browser-dialog.tsx+++ b/frontend/components/file-browser-dialog.tsx@@ -8,7 +8,10 @@ import {type RemoteFile,useBrowseConnectionFiles,} from "@/app/api/queries/useBrowseConnectionFiles";-import type { IngestSettings } from "@/components/cloud-picker/types";+import {+ type IngestSettings,+ validateIngestSettingsOrToast,+} from "@/components/cloud-picker/types";import { formatFileSize } from "@/lib/file-format";import { DuplicateHandlingDialog } from "./duplicate-handling-dialog";import { Badge } from "./ui/badge";@@ -187,6 +190,7 @@ export function FileBrowserDialog({const handleIngest = useCallback(async () => {if (selectedFiles.length === 0) return;+ if (!validateIngestSettingsOrToast(ingestSettings)) return;const filesPayload: SyncFilePayload[] = selectedFiles.map((f) => ({id: f.id,@@ -248,7 +252,7 @@ export function FileBrowserDialog({} finally {setIsCheckingDuplicates(false);}- }, [selectedFiles, connectorType, connectionId, submitSync]);+ }, [selectedFiles, connectorType, connectionId, submitSync, ingestSettings]);const handleOverwriteDuplicates = () => {if (!pendingSync) return;