LibreChat/client/src/data-provider/connection.ts
Danny Avila b2f44fc90f
🧩 feat: Web Search Config Validations & Clipboard Citation Processing (#7530)
* 🔧 chore: Add missing optional `scraperTimeout` to webSearchSchema

* chore: Add missing optional `scraperTimeout` to web search authentication result

* chore: linting

* feat: Integrate attachment handling and citation processing in message components

- Added `useAttachments` hook to manage message attachments and search results.
- Updated `MessageParts`, `ContentParts`, and `ContentRender` components to utilize the new hook for improved attachment handling.
- Enhanced `useCopyToClipboard` to format citations correctly, including support for composite citations and deduplication.
- Introduced utility functions for citation processing and cleanup.
- Added tests for the new `useCopyToClipboard` functionality to ensure proper citation formatting and handling.

* feat: Add configuration for LibreChat Code Interpreter API and Web Search variables

* fix: Update searchResults type to use SearchResultData for better type safety

* feat: Add web search configuration validation and logging

- Introduced `checkWebSearchConfig` function to validate web search configuration values, ensuring they are environment variable references.
- Added logging for proper configuration and warnings for incorrect values.
- Created unit tests for `checkWebSearchConfig` to cover various scenarios, including valid and invalid configurations.

* docs: Update README to include Web Search feature details

- Added a section for the Web Search feature, highlighting its capabilities to search the internet and enhance AI context.
- Included links for further information on the Web Search functionality.

* ci: Add mock for checkWebSearchConfig in AppService tests

* chore: linting

* feat: Enhance Shared Messages with Web Search UI by adding searchResults prop to SearchContent and MinimalHoverButtons components

* chore: linting

* refactor: remove Meilisearch index sync from importConversations function

* feat: update safeSearch implementation to use SafeSearchTypes enum

* refactor: remove commented-out code in loadTools function

* fix: ensure responseMessageId handles latestMessage ID correctly

* feat: enhance Vite configuration for improved chunking and caching

- Added additional globIgnores for map files in Workbox configuration.
- Implemented high-impact chunking for various large libraries to optimize performance.
- Increased chunkSizeWarningLimit from 1200 to 1500 for better handling of larger chunks.

* refactor: move health check hook to Root, fix bad setState for Temporary state

- Enhanced the `useHealthCheck` hook to initiate health checks only when the user is authenticated.
- Added logic for managing health check intervals and handling window focus events.
- Introduced a new test suite for `useHealthCheck` to cover various scenarios including authentication state changes and error handling.
- Removed the health check invocation from `ChatRoute` and added it to `Root` for global health monitoring.

* fix: update font alias in Vite configuration for correct path resolution
2025-05-24 10:23:17 -04:00

101 lines
3.1 KiB
TypeScript

import { useCallback, useRef, useEffect } from 'react';
import { useQueryClient } from '@tanstack/react-query';
import { QueryKeys, Time, dataService } from 'librechat-data-provider';
import { logger } from '~/utils';
export const useHealthCheck = (isAuthenticated = false) => {
const queryClient = useQueryClient();
const isInitialized = useRef(false);
const intervalRef = useRef<NodeJS.Timeout | null>(null);
const focusHandlerRef = useRef<(() => Promise<void>) | null>(null);
useEffect(() => {
// Only start health check if authenticated
if (!isAuthenticated) {
return;
}
// Prevent multiple initializations
if (isInitialized.current) {
return;
}
isInitialized.current = true;
// Use a longer delay to ensure all rendering is complete
const initTimer = setTimeout(() => {
const performHealthCheck = async () => {
try {
await queryClient.fetchQuery([QueryKeys.health], () => dataService.healthCheck(), {
retry: false,
cacheTime: 0,
staleTime: 0,
});
} catch (error) {
console.error('Health check failed:', error);
}
};
// Initial check
performHealthCheck();
// Set up interval for recurring checks
intervalRef.current = setInterval(performHealthCheck, Time.TEN_MINUTES);
// Set up window focus handler
const handleWindowFocus = async () => {
const queryState = queryClient.getQueryState([QueryKeys.health]);
if (!queryState?.dataUpdatedAt) {
await performHealthCheck();
return;
}
const lastUpdated = new Date(queryState.dataUpdatedAt);
const tenMinutesAgo = new Date(Date.now() - Time.TEN_MINUTES);
logger.log(`Last health check: ${lastUpdated.toISOString()}`);
logger.log(`Ten minutes ago: ${tenMinutesAgo.toISOString()}`);
if (lastUpdated < tenMinutesAgo) {
await performHealthCheck();
}
};
// Store handler for cleanup
focusHandlerRef.current = handleWindowFocus;
window.addEventListener('focus', handleWindowFocus);
}, 500);
return () => {
clearTimeout(initTimer);
if (intervalRef.current) {
clearInterval(intervalRef.current);
intervalRef.current = null;
}
// Remove focus event listener if it was added
if (focusHandlerRef.current) {
window.removeEventListener('focus', focusHandlerRef.current);
focusHandlerRef.current = null;
}
};
}, [isAuthenticated, queryClient]);
};
export const useInteractionHealthCheck = () => {
const queryClient = useQueryClient();
const lastInteractionTimeRef = useRef(Date.now());
const checkHealthOnInteraction = useCallback(() => {
const currentTime = Date.now();
if (currentTime - lastInteractionTimeRef.current > Time.FIVE_MINUTES) {
logger.log(
'Checking health on interaction. Time elapsed:',
currentTime - lastInteractionTimeRef.current,
);
queryClient.invalidateQueries([QueryKeys.health]);
lastInteractionTimeRef.current = currentTime;
}
}, [queryClient]);
return checkHealthOnInteraction;
};