Skip to content

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

Python

refactor: no derived state (#1886)

Mike Fortman426042fc31c5
diff --git a/frontend/app/chat/_components/function-calls/container.tsx b/frontend/app/chat/_components/function-calls/container.tsx
index 43a623609..edd7b96e3 100644
--- a/frontend/app/chat/_components/function-calls/container.tsx
+++ b/frontend/app/chat/_components/function-calls/container.tsx
@@ -1,4 +1,4 @@
-import { useState } from "react";
+import { useEffect, useState } from "react";
import type { FunctionCall as FunctionCallType } from "../../_types/types";
import { FunctionCall } from "./call";
import { FunctionCallsHeader } from "./header";
@@ -19,6 +19,9 @@ export function FunctionCallsContainer({
isStreaming = false,
}: FunctionCallsContainerProps) {
const [isGroupExpanded, setIsGroupExpanded] = useState(isStreaming);
+ useEffect(() => {
+ if (isStreaming) setIsGroupExpanded(true);
+ }, [isStreaming]);
if (!functionCalls || functionCalls.length === 0) return null;
diff --git a/frontend/app/onboarding/_components/anthropic-onboarding.tsx b/frontend/app/onboarding/_components/anthropic-onboarding.tsx
index 30af56752..2deaae475 100644
--- a/frontend/app/onboarding/_components/anthropic-onboarding.tsx
+++ b/frontend/app/onboarding/_components/anthropic-onboarding.tsx
@@ -29,6 +29,15 @@ export function AnthropicOnboarding({
}) {
const [apiKey, setApiKey] = useState("");
const [getFromEnv, setGetFromEnv] = useState(hasEnvApiKey);
+ const [prevHasEnvApiKey, setPrevHasEnvApiKey] = useState(hasEnvApiKey);
+ const envKeyChanged = hasEnvApiKey !== prevHasEnvApiKey;
+ if (envKeyChanged) {
+ setPrevHasEnvApiKey(hasEnvApiKey);
+ setGetFromEnv(hasEnvApiKey);
+ if (hasEnvApiKey) {
+ setApiKey("");
+ }
+ }
const debouncedApiKey = useDebouncedValue(apiKey, 500);
// Fetch models from API when API key is provided
@@ -53,6 +62,10 @@ export function AnthropicOnboarding({
languageModels,
embeddingModels,
} = useModelSelection(modelsData, isEmbedding);
+ if (envKeyChanged) {
+ setLanguageModel?.("");
+ setEmbeddingModel?.("");
+ }
const handleGetFromEnvChange = (fromEnv: boolean) => {
setGetFromEnv(fromEnv);
diff --git a/frontend/app/onboarding/_components/model-selector.tsx b/frontend/app/onboarding/_components/model-selector.tsx
index 65937f811..ecb43d5d1 100644
--- a/frontend/app/onboarding/_components/model-selector.tsx
+++ b/frontend/app/onboarding/_components/model-selector.tsx
@@ -64,6 +64,14 @@ export function ModelSelector({
...props
}: ModelSelectorProps) {
const [open, setOpen] = useState(defaultOpen);
+ const [prevDefaultOpen, setPrevDefaultOpen] = useState(defaultOpen);
+ if (defaultOpen !== prevDefaultOpen) {
+ setPrevDefaultOpen(defaultOpen);
+ if (defaultOpen) {
+ setOpen(true);
+ }
+ }
+
const [searchValue, setSearchValue] = useState("");
const listboxId = useId();
@@ -89,13 +97,6 @@ export function ModelSelector({
}
}, [allOptions, value, custom, onValueChange]);
- // Update open state when defaultOpen changes
- useEffect(() => {
- if (defaultOpen) {
- setOpen(true);
- }
- }, [defaultOpen]);
-
return (
<Popover open={open} onOpenChange={setOpen} modal={false}>
<PopoverTrigger asChild>
diff --git a/frontend/app/onboarding/_components/onboarding-card.tsx b/frontend/app/onboarding/_components/onboarding-card.tsx
index 0c97148e8..0229ece0d 100644
--- a/frontend/app/onboarding/_components/onboarding-card.tsx
+++ b/frontend/app/onboarding/_components/onboarding-card.tsx
@@ -10,7 +10,10 @@ import {
useOnboardingMutation,
} from "@/app/api/mutations/useOnboardingMutation";
import { useOnboardingRollbackMutation } from "@/app/api/mutations/useOnboardingRollbackMutation";
-import { useGetSettingsQuery } from "@/app/api/queries/useGetSettingsQuery";
+import {
+ type ProviderSettings,
+ useGetSettingsQuery,
+} from "@/app/api/queries/useGetSettingsQuery";
import { useGetTasksQuery } from "@/app/api/queries/useGetTasksQuery";
import type { ProviderHealthResponse } from "@/app/api/queries/useProviderHealthQuery";
import {
@@ -85,46 +88,48 @@ const OnboardingCard = ({
const { data: currentSettings } = useGetSettingsQuery();
// Auto-select the first provider that has an API key set in env vars
- useEffect(() => {
- if (!currentSettings?.providers) return;
-
- // Define provider order based on whether it's embedding or not
- const fullOrder = isEmbedding
- ? EMBEDDING_PROVIDER_ORDER
- : LLM_PROVIDER_ORDER;
- const providerOrder = isCloudBrand
- ? fullOrder.filter((p) => !CLOUD_EXCLUDED_PROVIDERS.includes(p))
- : fullOrder;
-
- // Find the first provider with an API key
- for (const provider of providerOrder) {
- if (
- provider === "anthropic" &&
- currentSettings.providers.anthropic?.has_api_key
- ) {
- setModelProvider("anthropic");
- return;
- } else if (
- provider === "openai" &&
- currentSettings.providers.openai?.has_api_key
- ) {
- setModelProvider("openai");
- return;
- } else if (
- provider === "watsonx" &&
- currentSettings.providers.watsonx?.has_api_key
- ) {
- setModelProvider("watsonx");
- return;
- } else if (
- provider === "ollama" &&
- currentSettings.providers.ollama?.endpoint
- ) {
- setModelProvider("ollama");
- return;
+ const [prevProviders, setPrevProviders] = useState<
+ ProviderSettings | undefined | null
+ >(null);
+ if (currentSettings?.providers !== prevProviders) {
+ setPrevProviders(currentSettings?.providers);
+ if (currentSettings?.providers) {
+ const fullOrder = isEmbedding
+ ? EMBEDDING_PROVIDER_ORDER
+ : LLM_PROVIDER_ORDER;
+ const providerOrder = isCloudBrand
+ ? fullOrder.filter((p) => !CLOUD_EXCLUDED_PROVIDERS.includes(p))
+ : fullOrder;
+
+ for (const provider of providerOrder) {
+ if (
+ provider === "anthropic" &&
+ currentSettings.providers.anthropic?.has_api_key
+ ) {
+ setModelProvider("anthropic");
+ break;
+ } else if (
+ provider === "openai" &&
+ currentSettings.providers.openai?.has_api_key
+ ) {
+ setModelProvider("openai");
+ break;
+ } else if (
+ provider === "watsonx" &&
+ currentSettings.providers.watsonx?.has_api_key
+ ) {
+ setModelProvider("watsonx");
+ break;
+ } else if (
+ provider === "ollama" &&
+ currentSettings.providers.ollama?.endpoint
+ ) {
+ setModelProvider("ollama");
+ break;
+ }
}
}
- }, [currentSettings, isEmbedding, isCloudBrand]);
+ }
const handleSetModelProvider = (provider: string) => {
setIsLoadingModels(false);
diff --git a/frontend/app/onboarding/_hooks/useModelSelection.ts b/frontend/app/onboarding/_hooks/useModelSelection.ts
index a5952f66e..d6cf4b19d 100644
--- a/frontend/app/onboarding/_hooks/useModelSelection.ts
+++ b/frontend/app/onboarding/_hooks/useModelSelection.ts
@@ -1,4 +1,4 @@
-import { useEffect, useState } from "react";
+import { useState } from "react";
import type { ModelsResponse } from "../../api/queries/useGetModelsQuery";
export function useModelSelection(
@@ -8,18 +8,17 @@ export function useModelSelection(
const [languageModel, setLanguageModel] = useState("");
const [embeddingModel, setEmbeddingModel] = useState("");
- // Update default selections when models are loaded
- useEffect(() => {
+ // Set default selections when models first load (render-time adjustment)
+ const [prevModelsData, setPrevModelsData] = useState<
+ ModelsResponse | undefined
+ >();
+ if (modelsData !== prevModelsData) {
+ setPrevModelsData(modelsData);
if (modelsData) {
- const defaultLangModel = isEmbedding
- ? undefined
- : modelsData.language_models.find((m) => m.default);
- const defaultEmbedModel = isEmbedding
- ? modelsData.embedding_models.find((m) => m.default)
- : undefined;
-
- // Set language model: prefer default, fallback to first available
if (!languageModel && !isEmbedding) {
+ const defaultLangModel = modelsData.language_models.find(
+ (m) => m.default,
+ );
if (defaultLangModel) {
setLanguageModel(defaultLangModel.value);
} else if (modelsData.language_models.length > 0) {
@@ -27,8 +26,10 @@ export function useModelSelection(
}
}
- // Set embedding model: prefer default, fallback to first available
if (!embeddingModel && isEmbedding) {
+ const defaultEmbedModel = modelsData.embedding_models.find(
+ (m) => m.default,
+ );
if (defaultEmbedModel) {
setEmbeddingModel(defaultEmbedModel.value);
} else if (modelsData.embedding_models.length > 0) {
@@ -36,7 +37,7 @@ export function useModelSelection(
}
}
}
- }, [modelsData, languageModel, embeddingModel, isEmbedding]);
+ }
return {
languageModel,
diff --git a/frontend/app/settings/_components/s3-settings-dialog.tsx b/frontend/app/settings/_components/s3-settings-dialog.tsx
index 942dcbdd0..3c6a45c91 100644
--- a/frontend/app/settings/_components/s3-settings-dialog.tsx
+++ b/frontend/app/settings/_components/s3-settings-dialog.tsx
@@ -1,7 +1,7 @@
"use client";
import { useQueryClient } from "@tanstack/react-query";
-import { useEffect, useState } from "react";
+import { useState } from "react";
import { FormProvider, useForm } from "react-hook-form";
import { toast } from "sonner";
import { useS3ConfigureMutation } from "@/app/api/mutations/useS3ConfigureMutation";
@@ -49,15 +49,19 @@ export default function S3SettingsDialog({
defaults?.bucket_names ?? [],
);
- // Sync bucket state when defaults load asynchronously after dialog mount
- useEffect(() => {
+ const [prevBucketNames, setPrevBucketNames] = useState(
+ defaults?.bucket_names?.join(","),
+ );
+ const currentBucketNames = defaults?.bucket_names?.join(",");
+ if (currentBucketNames !== prevBucketNames) {
+ setPrevBucketNames(currentBucketNames);
if (defaults?.bucket_names?.length) {
setBuckets(defaults.bucket_names);
setSelectedBuckets((prev) =>
prev.length ? prev : defaults.bucket_names,
);
}
- }, [defaults?.bucket_names?.join(",")]);
+ }
const [isFetchingBuckets, setIsFetchingBuckets] = useState(false);
const [bucketsError, setBucketsError] = useState<string | null>(null);
diff --git a/frontend/components/chat-renderer.tsx b/frontend/components/chat-renderer.tsx
index 43d3b4af3..4b196b3dc 100644
--- a/frontend/components/chat-renderer.tsx
+++ b/frontend/components/chat-renderer.tsx
@@ -54,25 +54,24 @@ export function ChatRenderer({
} = useChat();
// Initialize onboarding state from backend settings
- const [currentStep, setCurrentStep] = useState<number>(() => {
- return settings?.onboarding?.current_step ?? 0;
- });
-
- const [showLayout, setShowLayout] = useState<boolean>(() => {
- // Show layout only if onboarding is complete (current_step >= TOTAL_ONBOARDING_STEPS)
- // This means onboarding will show even if edited=true, as long as it's not complete
- const onboardingStep = settings?.onboarding?.current_step ?? 0;
- return onboardingStep >= TOTAL_ONBOARDING_STEPS;
- });
-
- // Update currentStep and showLayout when settings change
- useEffect(() => {
+ const [currentStep, setCurrentStep] = useState<number>(
+ settings?.onboarding?.current_step ?? 0,
+ );
+ const [showLayout, setShowLayout] = useState<boolean>(
+ (settings?.onboarding?.current_step ?? 0) >= TOTAL_ONBOARDING_STEPS,
+ );
+
+ // Sync from settings without an extra render cycle
+ const [prevSettingsStep, setPrevSettingsStep] = useState(
+ settings?.onboarding?.current_step,
+ );
+ if (settings?.onboarding?.current_step !== prevSettingsStep) {
+ setPrevSettingsStep(settings?.onboarding?.current_step);
if (settings?.onboarding?.current_step !== undefined) {
setCurrentStep(settings.onboarding.current_step);
- // Update showLayout based on whether onboarding is complete
setShowLayout(settings.onboarding.current_step >= TOTAL_ONBOARDING_STEPS);
}
- }, [settings?.onboarding?.current_step]);
+ }
useEffect(() => {
if (!showLayout) {
diff --git a/frontend/components/knowledge-search-bar.tsx b/frontend/components/knowledge-search-bar.tsx
index d7f7b3959..484682403 100644
--- a/frontend/components/knowledge-search-bar.tsx
+++ b/frontend/components/knowledge-search-bar.tsx
@@ -1,11 +1,5 @@
import { ArrowRight, RefreshCw, Search, X } from "lucide-react";
-import {
- type ChangeEvent,
- type FormEvent,
- useCallback,
- useEffect,
- useState,
-} from "react";
+import { type ChangeEvent, type FormEvent, useCallback, useState } from "react";
import { toast } from "sonner";
import { useRefreshOpenragDocs } from "@/app/api/mutations/useRefreshOpenragDocs";
import {
@@ -30,6 +24,11 @@ export const KnowledgeSearchBar = () => {
} = useKnowledgeFilter();
const [searchQueryInput, setSearchQueryInput] = useState(queryOverride || "");
+ const [prevQueryOverride, setPrevQueryOverride] = useState(queryOverride);
+ if (queryOverride !== prevQueryOverride) {
+ setPrevQueryOverride(queryOverride);
+ setSearchQueryInput(queryOverride);
+ }
const handleSearch = useCallback(
(e?: FormEvent<HTMLFormElement>) => {
@@ -44,10 +43,6 @@ export const KnowledgeSearchBar = () => {
setQueryOverride("");
}, [setQueryOverride]);
- useEffect(() => {
- setSearchQueryInput(queryOverride);
- }, [queryOverride]);
-
const syncAllConnectorsMutation = useSyncAllConnectors();
const syncAllPreviewMutation = useSyncAllConnectorsPreview();
const refreshOpenragDocsMutation = useRefreshOpenragDocs();
diff --git a/frontend/components/knowledge-search-input.tsx b/frontend/components/knowledge-search-input.tsx
index a42986166..dbb03d1f3 100644
--- a/frontend/components/knowledge-search-input.tsx
+++ b/frontend/components/knowledge-search-input.tsx
@@ -1,11 +1,5 @@
import { ArrowRight, Search, X } from "lucide-react";
-import {
- type ChangeEvent,
- type FormEvent,
- useCallback,
- useEffect,
- useState,
-} from "react";
+import { type ChangeEvent, type FormEvent, useCallback, useState } from "react";
import { Button } from "@/components/ui/button";
import { useKnowledgeFilter } from "@/contexts/knowledge-filter-context";
import { cn } from "@/lib/utils";
@@ -21,6 +15,11 @@ export const KnowledgeSearchInput = () => {
} = useKnowledgeFilter();
const [searchQueryInput, setSearchQueryInput] = useState(queryOverride || "");
+ const [prevQueryOverride, setPrevQueryOverride] = useState(queryOverride);
+ if (queryOverride !== prevQueryOverride) {
+ setPrevQueryOverride(queryOverride);
+ setSearchQueryInput(queryOverride);
+ }
const handleSearch = useCallback(
(e?: FormEvent<HTMLFormElement>) => {
@@ -30,11 +29,6 @@ export const KnowledgeSearchInput = () => {
[searchQueryInput, setQueryOverride],
);
- // Reset the query text when the selected filter changes
- useEffect(() => {
- setSearchQueryInput(queryOverride);
- }, [queryOverride]);
-
return (
<form
className="flex flex-1 max-w-[min(640px,100%)] min-w-[100px]"
diff --git a/frontend/components/navigation.tsx b/frontend/components/navigation.tsx
index f10687b80..fc2a50a51 100644
--- a/frontend/components/navigation.tsx
+++ b/frontend/components/navigation.tsx
@@ -92,7 +92,7 @@ export function Navigation({
loading,
} = useChat();
- const [previousConversationCount, setPreviousConversationCount] = useState(0);
+ const previousConversationCountRef = useRef(0);
const [deleteModalOpen, setDeleteModalOpen] = useState(false);
const [conversationToDelete, setConversationToDelete] =
useState<ChatConversation | null>(null);
@@ -232,8 +232,7 @@ export function Navigation({
useEffect(() => {
if (!isConversationsLoading && !hasCompletedInitialLoad.current) {
hasCompletedInitialLoad.current = true;
- // Set initial count after first load completes
- setPreviousConversationCount(conversations.length);
+ previousConversationCountRef.current = conversations.length;
}
}, [isConversationsLoading, conversations.length]);
@@ -245,37 +244,28 @@ export function Navigation({
: Infinity;
const MIN_TIME_AFTER_MOUNT = 2000; // 2 seconds - prevents selection right after onboarding
- // Only select if:
- // 1. We have a placeholder (new conversation was created)
- // 2. Initial load has completed (prevents selection on browser refresh)
- // 3. Count increased (new conversation appeared)
- // 4. Not currently loading
- // 5. Enough time has passed since mount (prevents selection after onboarding completes)
if (
placeholderConversation &&
hasCompletedInitialLoad.current &&
- currentCount > previousConversationCount &&
+ currentCount > previousConversationCountRef.current &&
conversations.length > 0 &&
!isConversationsLoading &&
timeSinceMount >= MIN_TIME_AFTER_MOUNT
) {
setPlaceholderConversation(null);
- // Highlight the most recent conversation (first in sorted array) without loading its messages
const newestConversation = conversations[0];
if (newestConversation) {
setCurrentConversationId(newestConversation.response_id);
}
}
- // Update the previous count only after initial load
if (hasCompletedInitialLoad.current) {
- setPreviousConversationCount(currentCount);
+ previousConversationCountRef.current = currentCount;
}
}, [
conversations.length,
placeholderConversation,
setPlaceholderConversation,
- previousConversationCount,
conversations,
setCurrentConversationId,
isConversationsLoading,
diff --git a/frontend/contexts/knowledge-filter-context.tsx b/frontend/contexts/knowledge-filter-context.tsx
index 7141ea2df..636ea5d3e 100644
--- a/frontend/contexts/knowledge-filter-context.tsx
+++ b/frontend/contexts/knowledge-filter-context.tsx
@@ -5,7 +5,6 @@ import React, {
type ReactNode,
useCallback,
useContext,
- useEffect,
useState,
} from "react";
import { FilterColor, IconKey } from "@/components/filter-icon-popover";
@@ -171,9 +170,11 @@ export function KnowledgeFilterProvider({
};
// Clear the search override when we change filters
- useEffect(() => {
+ const [prevSelectedFilter, setPrevSelectedFilter] = useState(selectedFilter);
+ if (selectedFilter !== prevSelectedFilter) {
+ setPrevSelectedFilter(selectedFilter);
setQueryOverride("");
- }, [selectedFilter]);
+ }
const value: KnowledgeFilterContextType = {
selectedFilter,