mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-04-03 06:17:21 +02:00
Some checks failed
Publish `librechat-data-provider` to NPM / build (push) Has been cancelled
Publish `@librechat/data-schemas` to NPM / build-and-publish (push) Has been cancelled
Docker Dev Images Build / build (Dockerfile, librechat-dev, node) (push) Has been cancelled
Docker Dev Images Build / build (Dockerfile.multi, librechat-dev-api, api-build) (push) Has been cancelled
Sync Locize Translations & Create Translation PR / Sync Translation Keys with Locize (push) Has been cancelled
Publish `librechat-data-provider` to NPM / publish-npm (push) Has been cancelled
Sync Locize Translations & Create Translation PR / Create Translation PR on Version Published (push) Has been cancelled
* refactor: add TMessageChatContext type for stable context passing Defines a type for a stable context object that wrapper components pass to memo'd message components, avoiding direct ChatContext subscriptions that bypass React.memo during streaming. * perf: remove ChatContext subscription from useMessageActions useMessageActions previously called useChatContext() inside memo'd components (MessageRender, ContentRender), bypassing React.memo when isSubmitting changed during streaming. Now accepts a stable chatContext param instead, using a ref for the isSubmitting guard in regenerateMessage. Also stabilizes handleScroll in useMessageProcess by using a ref for isSubmitting instead of including it in useCallback deps. * perf: pass stable chatContext to memo'd message components Wrapper components (Message, MessageContent) now create a stable chatContext object via useMemo with a getter-backed isSubmitting, and compute effectiveIsSubmitting (false for non-latest messages). This ensures MessageRender and ContentRender (both React.memo'd) only re-render for the latest message during streaming, preventing unnecessary re-renders of all prior messages and their SubRow, HoverButtons, and SiblingSwitch children. * perf: add custom memo comparators to prevent message reference re-renders buildTree creates new message objects on every streaming update for ALL messages, not just the changed one. This defeats React.memo's default shallow comparison since the message prop has a new reference even when the content hasn't changed. Custom areEqual comparators now compare message by key fields (messageId, text, error, depth, children length, etc.) instead of reference equality, preventing unnecessary re-renders of SubRow, Files, HoverButtons and other children for non-latest messages. * perf: memoize ChatForm children to prevent streaming re-renders - Wrap StopButton in React.memo - Wrap AudioRecorder in React.memo, use ref for isSubmitting in onTranscriptionComplete callback to stabilize it - Remove useChatContext() from FileFormChat (bypassed its memo during streaming), accept files/setFiles/setFilesLoading as props from ChatForm instead * perf: stabilize ChatForm child props to prevent cascading re-renders ChatForm re-renders frequently during streaming (ChatContext changes). This caused StopButton and AttachFileChat/AttachFileMenu to re-render despite being memo'd, because their props were new references each time. - Wrap handleStopGenerating in a ref-based stable callback so StopButton always receives the same function reference - Create stableConversation via useMemo keyed on rendering-relevant fields only (conversationId, endpoint, agent_id, etc.), so AttachFileChat and FileFormChat don't re-render from unrelated conversation metadata updates (e.g., title generation) * perf: remove ChatContext subscription from AttachFileMenu and FileFormChat Both components used useFileHandling() which internally calls useChatContext(), bypassing their React.memo wrappers and causing re-renders on every streaming chunk. Switch to useFileHandlingNoChatContext() which accepts file state as parameters. The state (files, setFiles, setFilesLoading, conversation) is passed down from ChatForm → AttachFileChat → AttachFileMenu as props, keeping the memo chain intact. * fix: update imports and test mocks for useFileHandlingNoChatContext - Re-export useFileHandlingNoChatContext from hooks barrel - Import from ~/hooks instead of direct path for test compatibility - Add useToastContext mock to @librechat/client in AttachFileMenu tests since useFileHandlingNoChatContext runs the core hook which needs it - Add useFileHandlingNoChatContext to ~/hooks test mock * perf: fix remaining ChatForm streaming re-renders - Switch AttachFileMenu from useSharePointFileHandling (subscribes to ChatContext) to useSharePointFileHandlingNoChatContext with explicit file state props - Memoize ChatForm textarea onFocus/onBlur handlers with useCallback to prevent TextareaAutosize re-renders (inline arrow functions and .bind() created new references on every ChatForm render) - Update AttachFileMenu test mocks for new hook variants * refactor: add displayName to ChatForm for React DevTools * perf: prevent ChatForm re-renders during streaming via wrapper pattern ChatForm was re-rendering on every streaming chunk because it subscribed to useChatContext() internally, and the ChatContext value changed frequently during streaming. Extract context subscription into a ChatFormWrapper that: - Subscribes to useChatContext() (re-renders on every chunk, cheap) - Stabilizes conversation via selective useMemo - Stabilizes handleStopGenerating via ref-based callback - Passes individual stable values as props to ChatForm ChatForm (memo'd) now receives context values as props instead of subscribing directly. Since individual values (files, setFiles, isSubmitting, etc.) are stable references during streaming, ChatForm's memo prevents re-renders entirely — it only re-renders when isSubmitting actually toggles (2x per stream: start/end). * perf: stabilize newConversation prop and memoize CollapseChat - Wrap newConversation in ref-based stable callback in ChatFormWrapper (was the remaining unstable prop causing ChatForm to re-render) - Wrap CollapseChat in React.memo to prevent re-renders from parent * perf: memoize useAddedResponse return value useAddedResponse returned a new object literal on every render, causing AddedChatContext.Provider to trigger re-renders of all consumers (including ChatForm) on every streaming chunk. Wrap in useMemo so the context value stays referentially stable. * perf: memoize TextareaHeader to prevent re-renders from ChatForm * perf: address review findings for streaming render optimization Finding 1: Switch AttachFile.tsx from useFileHandling to useFileHandlingNoChatContext, closing the optimization hole for standard (non-agent) chat endpoints. Finding 2: Replace content reference equality with length comparison in both memo comparators — safer against buildTree array reconstruction. Finding 3: Add conversation?.model to stableConversation deps in ChatFormWrapper so file uploads use the correct model after switches. Finding 4/14: Fix stableNewConversation to explicitly return the underlying call's result instead of discarding it via `as` cast. Finding 5/6: Extract useMemoizedChatContext hook shared by Message.tsx and MessageContent.tsx — eliminates ~70 lines of duplication and stabilizes chatContext.conversation via selective useMemo to prevent post-stream metadata updates from re-rendering all messages. Finding 8: Use TMessage type for regenerate param instead of Record<string, unknown>. Finding 9: Use FileSetter alias in FileFormChat instead of inline type. Finding 11: Fix pre-existing broken throttle in useMessageProcess — was creating a new throttle instance per call, providing zero deduplication. Now retains the instance via useMemo. Finding 12: Initialize isSubmittingRef with chatContext.isSubmitting instead of false for consistency. Finding 13: Add ChatFormWrapper displayName. * fix: revert content comparison to reference equality in memo comparators The length-based comparison (content?.length) missed updates within existing content parts during streaming — text chunks update a part's content without changing the array length, so the comparator returned true and skipped re-renders for the latest message. Reference equality (===) is correct here: buildTree preserves content array references for unchanged messages via shallow spread, while React Query gives the latest message a new reference when its content updates during streaming. * fix: cancel throttled handleScroll on unmount and remove unused import * fix: use chatContext getter directly in regenerateMessage callback The local isSubmittingRef was stale for non-latest messages (which don't re-render during streaming by design). chatContext.isSubmitting is a getter backed by the wrapper's ref, so reading it at call-time always returns the current value regardless of whether the component has re-rendered. * fix: remove unused useCallback import from useMemoizedChatContext * fix: pass global isSubmitting to HoverButtons for action gating HoverButtons uses isSubmitting via useGenerationsByLatest to disable regenerate and hide edit buttons during streaming. Passing the effective value (false for non-latest messages) re-enabled those actions mid-stream, risking overlapping edits/regenerations. Use chatContext.isSubmitting (getter, always returns current value) for HoverButtons while keeping the effective value for rendering-only UI (cursor, placeholder, streaming indicator). * fix: address second review — stale HoverButtons, messages dep, cleanup - Add isSubmitting to chatContext useMemo deps in useMemoizedChatContext so HoverButtons correctly updates when streaming starts/ends (2 extra re-renders per session, belt-and-suspenders for post-stream state) - Change conversation?.messages?.length dep to boolean in ChatFormWrapper stableConversation — only need 0↔1+ transition for landing page check, not exact count on every message addition - Add defensive comment at chatContext destructuring point in useMessageActions explaining why isSubmitting must not be destructured - Remove dead mockUseFileHandling.mockReturnValue from AttachFileMenu tests * chore: remove dead useFileHandling mock artifacts from AttachFileMenu tests * fix: resolve eslint warnings for useMemo dependencies - Extract complex expression (conversation?.messages?.length ?? 0) > 0 to hasMessages variable for static analysis in ChatFormWrapper - Add eslint-disable for intentional isSubmitting dep in useMemoizedChatContext (forces new chatContext reference on streaming start/end so HoverButtons re-renders)
321 lines
9.8 KiB
TypeScript
321 lines
9.8 KiB
TypeScript
import React, { useRef, useState, useMemo } from 'react';
|
|
import { useRecoilState } from 'recoil';
|
|
import * as Ariakit from '@ariakit/react';
|
|
import {
|
|
FileSearch,
|
|
ImageUpIcon,
|
|
FileType2Icon,
|
|
FileImageIcon,
|
|
TerminalSquareIcon,
|
|
} from 'lucide-react';
|
|
import {
|
|
FileUpload,
|
|
TooltipAnchor,
|
|
DropdownPopup,
|
|
AttachmentIcon,
|
|
SharePointIcon,
|
|
} from '@librechat/client';
|
|
import {
|
|
Providers,
|
|
EToolResources,
|
|
EModelEndpoint,
|
|
defaultAgentCapabilities,
|
|
bedrockDocumentExtensions,
|
|
isDocumentSupportedProvider,
|
|
} from 'librechat-data-provider';
|
|
import type { EndpointFileConfig, TConversation } from 'librechat-data-provider';
|
|
import type { ExtendedFile, FileSetter } from '~/common';
|
|
import {
|
|
useAgentToolPermissions,
|
|
useAgentCapabilities,
|
|
useGetAgentsConfig,
|
|
useFileHandlingNoChatContext,
|
|
useLocalize,
|
|
} from '~/hooks';
|
|
import { useSharePointFileHandlingNoChatContext } from '~/hooks/Files/useSharePointFileHandling';
|
|
import { SharePointPickerDialog } from '~/components/SharePoint';
|
|
import { useGetStartupConfig } from '~/data-provider';
|
|
import { ephemeralAgentByConvoId } from '~/store';
|
|
import { MenuItemProps } from '~/common';
|
|
import { cn } from '~/utils';
|
|
|
|
type FileUploadType =
|
|
| 'image'
|
|
| 'document'
|
|
| 'image_document'
|
|
| 'image_document_extended'
|
|
| 'image_document_video_audio';
|
|
|
|
interface AttachFileMenuProps {
|
|
agentId?: string | null;
|
|
endpoint?: string | null;
|
|
disabled?: boolean | null;
|
|
conversationId: string;
|
|
endpointType?: EModelEndpoint | string;
|
|
endpointFileConfig?: EndpointFileConfig;
|
|
useResponsesApi?: boolean;
|
|
files: Map<string, ExtendedFile>;
|
|
setFiles: FileSetter;
|
|
setFilesLoading: React.Dispatch<React.SetStateAction<boolean>>;
|
|
conversation: TConversation | null;
|
|
}
|
|
|
|
const AttachFileMenu = ({
|
|
agentId,
|
|
endpoint,
|
|
disabled,
|
|
endpointType,
|
|
conversationId,
|
|
endpointFileConfig,
|
|
useResponsesApi,
|
|
files,
|
|
setFiles,
|
|
setFilesLoading,
|
|
conversation,
|
|
}: AttachFileMenuProps) => {
|
|
const localize = useLocalize();
|
|
const isUploadDisabled = disabled ?? false;
|
|
const inputRef = useRef<HTMLInputElement>(null);
|
|
const [isPopoverActive, setIsPopoverActive] = useState(false);
|
|
const [ephemeralAgent, setEphemeralAgent] = useRecoilState(
|
|
ephemeralAgentByConvoId(conversationId),
|
|
);
|
|
const [toolResource, setToolResource] = useState<EToolResources | undefined>();
|
|
const { handleFileChange } = useFileHandlingNoChatContext(undefined, {
|
|
files,
|
|
setFiles,
|
|
setFilesLoading,
|
|
conversation,
|
|
});
|
|
const { handleSharePointFiles, isProcessing, downloadProgress } =
|
|
useSharePointFileHandlingNoChatContext(
|
|
{ toolResource },
|
|
{ files, setFiles, setFilesLoading, conversation },
|
|
);
|
|
|
|
const { agentsConfig } = useGetAgentsConfig();
|
|
const { data: startupConfig } = useGetStartupConfig();
|
|
const sharePointEnabled = startupConfig?.sharePointFilePickerEnabled;
|
|
|
|
const [isSharePointDialogOpen, setIsSharePointDialogOpen] = useState(false);
|
|
|
|
/** TODO: Ephemeral Agent Capabilities
|
|
* Allow defining agent capabilities on a per-endpoint basis
|
|
* Use definition for agents endpoint for ephemeral agents
|
|
* */
|
|
const capabilities = useAgentCapabilities(agentsConfig?.capabilities ?? defaultAgentCapabilities);
|
|
|
|
const { fileSearchAllowedByAgent, codeAllowedByAgent, provider } = useAgentToolPermissions(
|
|
agentId,
|
|
ephemeralAgent,
|
|
);
|
|
|
|
const handleUploadClick = (fileType?: FileUploadType) => {
|
|
if (!inputRef.current) {
|
|
return;
|
|
}
|
|
inputRef.current.value = '';
|
|
if (fileType === 'image') {
|
|
inputRef.current.accept = 'image/*,.heif,.heic';
|
|
} else if (fileType === 'document') {
|
|
inputRef.current.accept = '.pdf,application/pdf';
|
|
} else if (fileType === 'image_document') {
|
|
inputRef.current.accept = 'image/*,.heif,.heic,.pdf,application/pdf';
|
|
} else if (fileType === 'image_document_extended') {
|
|
inputRef.current.accept = `image/*,.heif,.heic,${bedrockDocumentExtensions}`;
|
|
} else if (fileType === 'image_document_video_audio') {
|
|
inputRef.current.accept = 'image/*,.heif,.heic,.pdf,application/pdf,video/*,audio/*';
|
|
} else {
|
|
inputRef.current.accept = '';
|
|
}
|
|
inputRef.current.click();
|
|
inputRef.current.accept = '';
|
|
};
|
|
|
|
const dropdownItems = useMemo(() => {
|
|
const createMenuItems = (onAction: (fileType?: FileUploadType) => void) => {
|
|
const items: MenuItemProps[] = [];
|
|
|
|
let currentProvider = provider || endpoint;
|
|
|
|
// This will be removed in a future PR to formally normalize Providers comparisons to be case insensitive
|
|
if (currentProvider?.toLowerCase() === Providers.OPENROUTER) {
|
|
currentProvider = Providers.OPENROUTER;
|
|
}
|
|
|
|
const isAzureWithResponsesApi =
|
|
currentProvider === EModelEndpoint.azureOpenAI && useResponsesApi;
|
|
|
|
if (
|
|
isDocumentSupportedProvider(endpointType) ||
|
|
isDocumentSupportedProvider(currentProvider) ||
|
|
isAzureWithResponsesApi
|
|
) {
|
|
items.push({
|
|
label: localize('com_ui_upload_provider'),
|
|
onClick: () => {
|
|
setToolResource(undefined);
|
|
let fileType: Exclude<FileUploadType, 'image' | 'document'> = 'image_document';
|
|
if (currentProvider === Providers.GOOGLE || currentProvider === Providers.OPENROUTER) {
|
|
fileType = 'image_document_video_audio';
|
|
} else if (
|
|
currentProvider === Providers.BEDROCK ||
|
|
endpointType === EModelEndpoint.bedrock
|
|
) {
|
|
fileType = 'image_document_extended';
|
|
}
|
|
onAction(fileType);
|
|
},
|
|
icon: <FileImageIcon className="icon-md" />,
|
|
});
|
|
} else {
|
|
items.push({
|
|
label: localize('com_ui_upload_image_input'),
|
|
onClick: () => {
|
|
setToolResource(undefined);
|
|
onAction('image');
|
|
},
|
|
icon: <ImageUpIcon className="icon-md" />,
|
|
});
|
|
}
|
|
|
|
if (capabilities.contextEnabled) {
|
|
items.push({
|
|
label: localize('com_ui_upload_ocr_text'),
|
|
onClick: () => {
|
|
setToolResource(EToolResources.context);
|
|
onAction();
|
|
},
|
|
icon: <FileType2Icon className="icon-md" />,
|
|
});
|
|
}
|
|
|
|
if (capabilities.fileSearchEnabled && fileSearchAllowedByAgent) {
|
|
items.push({
|
|
label: localize('com_ui_upload_file_search'),
|
|
onClick: () => {
|
|
setToolResource(EToolResources.file_search);
|
|
setEphemeralAgent((prev) => ({
|
|
...prev,
|
|
[EToolResources.file_search]: true,
|
|
}));
|
|
onAction();
|
|
},
|
|
icon: <FileSearch className="icon-md" />,
|
|
});
|
|
}
|
|
|
|
if (capabilities.codeEnabled && codeAllowedByAgent) {
|
|
items.push({
|
|
label: localize('com_ui_upload_code_files'),
|
|
onClick: () => {
|
|
setToolResource(EToolResources.execute_code);
|
|
setEphemeralAgent((prev) => ({
|
|
...prev,
|
|
[EToolResources.execute_code]: true,
|
|
}));
|
|
onAction();
|
|
},
|
|
icon: <TerminalSquareIcon className="icon-md" />,
|
|
});
|
|
}
|
|
|
|
return items;
|
|
};
|
|
|
|
const localItems = createMenuItems(handleUploadClick);
|
|
|
|
if (sharePointEnabled) {
|
|
const sharePointItems = createMenuItems(() => {
|
|
setIsSharePointDialogOpen(true);
|
|
// Note: toolResource will be set by the specific item clicked
|
|
});
|
|
localItems.push({
|
|
label: localize('com_files_upload_sharepoint'),
|
|
onClick: () => {},
|
|
icon: <SharePointIcon className="icon-md" />,
|
|
subItems: sharePointItems,
|
|
});
|
|
return localItems;
|
|
}
|
|
|
|
return localItems;
|
|
}, [
|
|
localize,
|
|
endpoint,
|
|
provider,
|
|
endpointType,
|
|
capabilities,
|
|
useResponsesApi,
|
|
setToolResource,
|
|
setEphemeralAgent,
|
|
sharePointEnabled,
|
|
codeAllowedByAgent,
|
|
fileSearchAllowedByAgent,
|
|
setIsSharePointDialogOpen,
|
|
]);
|
|
|
|
const menuTrigger = (
|
|
<TooltipAnchor
|
|
render={
|
|
<Ariakit.MenuButton
|
|
disabled={isUploadDisabled}
|
|
id="attach-file-menu-button"
|
|
aria-label="Attach File Options"
|
|
className={cn(
|
|
'flex size-9 items-center justify-center rounded-full p-1 hover:bg-surface-hover focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-primary focus-visible:ring-opacity-50',
|
|
isPopoverActive && 'bg-surface-hover',
|
|
)}
|
|
>
|
|
<div className="flex w-full items-center justify-center gap-2">
|
|
<AttachmentIcon />
|
|
</div>
|
|
</Ariakit.MenuButton>
|
|
}
|
|
id="attach-file-menu-button"
|
|
description={localize('com_sidepanel_attach_files')}
|
|
disabled={isUploadDisabled}
|
|
/>
|
|
);
|
|
const handleSharePointFilesSelected = async (sharePointFiles: any[]) => {
|
|
try {
|
|
await handleSharePointFiles(sharePointFiles);
|
|
setIsSharePointDialogOpen(false);
|
|
} catch (error) {
|
|
console.error('SharePoint file processing error:', error);
|
|
}
|
|
};
|
|
|
|
return (
|
|
<>
|
|
<FileUpload
|
|
ref={inputRef}
|
|
handleFileChange={(e) => {
|
|
handleFileChange(e, toolResource);
|
|
}}
|
|
>
|
|
<DropdownPopup
|
|
menuId="attach-file-menu"
|
|
className="overflow-visible"
|
|
isOpen={isPopoverActive}
|
|
setIsOpen={setIsPopoverActive}
|
|
modal={true}
|
|
unmountOnHide={true}
|
|
trigger={menuTrigger}
|
|
items={dropdownItems}
|
|
iconClassName="mr-0"
|
|
/>
|
|
</FileUpload>
|
|
<SharePointPickerDialog
|
|
isOpen={isSharePointDialogOpen}
|
|
onOpenChange={setIsSharePointDialogOpen}
|
|
onFilesSelected={handleSharePointFilesSelected}
|
|
isDownloading={isProcessing}
|
|
downloadProgress={downloadProgress}
|
|
maxSelectionCount={endpointFileConfig?.fileLimit}
|
|
/>
|
|
</>
|
|
);
|
|
};
|
|
|
|
export default React.memo(AttachFileMenu);
|