From 126a7ee6dc8cf7daa2ab48feef4b10a14a59053b Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Fri, 9 Aug 2024 12:32:50 -0400 Subject: [PATCH 1/9] refactor: scrollToEnd --- client/src/utils/messages.ts | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/client/src/utils/messages.ts b/client/src/utils/messages.ts index bb16cd6bbbc..411065752f4 100644 --- a/client/src/utils/messages.ts +++ b/client/src/utils/messages.ts @@ -45,10 +45,8 @@ export const getTextKey = (message?: TMessage | null, convoId?: string | null) = }; export const scrollToEnd = () => { - setTimeout(() => { - const messagesEndElement = document.getElementById('messages-end'); - if (messagesEndElement) { - messagesEndElement.scrollIntoView({ behavior: 'instant' }); - } - }, 750); + const messagesEndElement = document.getElementById('messages-end'); + if (messagesEndElement) { + messagesEndElement.scrollIntoView({ behavior: 'instant' }); + } }; From 5702ed2306f8b633ab5a9ec985498b13cfa63c55 Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Fri, 9 Aug 2024 12:35:11 -0400 Subject: [PATCH 2/9] fix(validateConvoAccess): search conversation by ID for proper validation --- api/models/Conversation.js | 15 +++++++++++++++ api/server/middleware/validate/convoAccess.js | 4 ++-- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/api/models/Conversation.js b/api/models/Conversation.js index 93ceac9b77c..19622ba7962 100644 --- a/api/models/Conversation.js +++ b/api/models/Conversation.js @@ -2,6 +2,20 @@ const Conversation = require('./schema/convoSchema'); const { getMessages, deleteMessages } = require('./Message'); const logger = require('~/config/winston'); +/** + * Searches for a conversation by conversationId and returns a lean document with only conversationId and user. + * @param {string} conversationId - The conversation's ID. + * @returns {Promise<{conversationId: string, user: string} | null>} The conversation object with selected fields or null if not found. + */ +const searchConversation = async (conversationId) => { + try { + return await Conversation.findOne({ conversationId }, 'conversationId user').lean(); + } catch (error) { + logger.error('[searchConversation] Error searching conversation', error); + throw new Error('Error searching conversation'); + } +}; + /** * Retrieves a single conversation for a given user and conversation ID. * @param {string} user - The user's ID. @@ -19,6 +33,7 @@ const getConvo = async (user, conversationId) => { module.exports = { Conversation, + searchConversation, /** * Saves a conversation to the database. * @param {Object} req - The request object. diff --git a/api/server/middleware/validate/convoAccess.js b/api/server/middleware/validate/convoAccess.js index fb48d4475c8..43cca0097d3 100644 --- a/api/server/middleware/validate/convoAccess.js +++ b/api/server/middleware/validate/convoAccess.js @@ -1,8 +1,8 @@ const { Constants, ViolationTypes, Time } = require('librechat-data-provider'); +const { searchConversation } = require('~/models/Conversation'); const denyRequest = require('~/server/middleware/denyRequest'); const { logViolation, getLogStores } = require('~/cache'); const { isEnabled } = require('~/server/utils'); -const { getConvo } = require('~/models'); const { USE_REDIS, CONVO_ACCESS_VIOLATION_SCORE: score = 0 } = process.env ?? {}; @@ -42,7 +42,7 @@ const validateConvoAccess = async (req, res, next) => { } } - const conversation = await getConvo(userId, conversationId); + const conversation = await searchConversation(conversationId); if (!conversation) { return next(); From 8d7533668e86aef6a688b385bdbf485030d90192 Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Fri, 9 Aug 2024 12:35:30 -0400 Subject: [PATCH 3/9] feat: Add unique index for conversationId and user in convoSchema --- api/models/schema/convoSchema.js | 1 + 1 file changed, 1 insertion(+) diff --git a/api/models/schema/convoSchema.js b/api/models/schema/convoSchema.js index 92f5589b13e..7b020e33097 100644 --- a/api/models/schema/convoSchema.js +++ b/api/models/schema/convoSchema.js @@ -61,6 +61,7 @@ if (process.env.MEILI_HOST && process.env.MEILI_MASTER_KEY) { } convoSchema.index({ createdAt: 1, updatedAt: 1 }); +convoSchema.index({ conversationId: 1, user: 1 }, { unique: true }); const Conversation = mongoose.models.Conversation || mongoose.model('Conversation', convoSchema); From b3aaf1b9556da5f340dac1e9caeaf6f5984e4c1b Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Fri, 9 Aug 2024 12:45:06 -0400 Subject: [PATCH 4/9] refactor: Update font sizes 1 rem -> font-size-base in style.css --- client/src/style.css | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/client/src/style.css b/client/src/style.css index a2b6afdac2f..30c87361cdd 100644 --- a/client/src/style.css +++ b/client/src/style.css @@ -2217,31 +2217,31 @@ ol ol):not(:where([class~=not-prose] *)) { } .message-content { - font-size: var(--markdown-font-size, 1rem); + font-size: var(--markdown-font-size, var(--font-size-base)); line-height: 1.75; } .message-content pre code { - font-size: calc(0.85 * var(--markdown-font-size, 1rem)); + font-size: calc(0.85 * var(--markdown-font-size, var(--font-size-base))); } .message-content pre { - font-size: var(--markdown-font-size, 1rem); + font-size: var(--markdown-font-size, var(--font-size-base)); } .code-analyze-block pre code, .code-analyze-block .overflow-y-auto code { - font-size: calc(0.85 * var(--markdown-font-size, 1rem)); + font-size: calc(0.85 * var(--markdown-font-size, var(--font-size-base))); } .code-analyze-block pre, .code-analyze-block .overflow-y-auto { - font-size: var(--markdown-font-size, 1rem); + font-size: var(--markdown-font-size, var(--font-size-base)); } .progress-text-wrapper { - font-size: var(--markdown-font-size, 1rem); - line-height: calc(1.25 * var(--markdown-font-size, 1rem)); + font-size: var(--markdown-font-size, var(--font-size-base)); + line-height: calc(1.25 * var(--markdown-font-size, var(--font-size-base))); } .progress-text-content { From a6feb779e5ba49ed5c7be0afdf83e6c2b71d7867 Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Fri, 9 Aug 2024 14:14:10 -0400 Subject: [PATCH 5/9] fix: Assistants map type issues --- client/src/components/Chat/Landing.tsx | 8 +-- .../components/Chat/Messages/MessageParts.tsx | 13 ++--- client/src/components/Endpoints/ConvoIcon.tsx | 19 +++++-- .../SidePanel/Builder/ActionsInput.tsx | 50 ++++++++++--------- .../SidePanel/Builder/AssistantAvatar.tsx | 12 ++--- .../SidePanel/Builder/AssistantPanel.tsx | 26 ++++++---- .../SidePanel/Builder/ContextButton.tsx | 10 ++-- .../src/hooks/Assistants/useAssistantsMap.ts | 2 +- .../src/hooks/Messages/useMessageActions.tsx | 28 ++++++----- .../src/hooks/Messages/useMessageHelpers.tsx | 23 ++++++--- 10 files changed, 111 insertions(+), 80 deletions(-) diff --git a/client/src/components/Chat/Landing.tsx b/client/src/components/Chat/Landing.tsx index 3e3a648b163..0faa6d88dd0 100644 --- a/client/src/components/Chat/Landing.tsx +++ b/client/src/components/Chat/Landing.tsx @@ -31,10 +31,10 @@ export default function Landing({ Header }: { Header?: ReactNode }) { endpoint = getIconEndpoint({ endpointsConfig, iconURL, endpoint }); const isAssistant = isAssistantsEndpoint(endpoint); - const assistant = isAssistant && assistantMap[endpoint][assistant_id ?? '']; - const assistantName = (assistant && assistant.name) || ''; - const assistantDesc = (assistant && assistant.description) || ''; - const avatar = (assistant && (assistant.metadata?.avatar as string)) || ''; + const assistant = isAssistant ? assistantMap?.[endpoint][assistant_id ?? ''] : undefined; + const assistantName = assistant && assistant.name; + const assistantDesc = assistant && assistant.description; + const avatar = assistant && (assistant.metadata?.avatar as string); const containerClassName = 'shadow-stroke relative flex h-full items-center justify-center rounded-full bg-white text-black'; diff --git a/client/src/components/Chat/Messages/MessageParts.tsx b/client/src/components/Chat/Messages/MessageParts.tsx index 01206ce5fc2..af97f9512c8 100644 --- a/client/src/components/Chat/Messages/MessageParts.tsx +++ b/client/src/components/Chat/Messages/MessageParts.tsx @@ -1,9 +1,9 @@ import { useRecoilValue } from 'recoil'; import type { TMessageProps } from '~/common'; import Icon from '~/components/Chat/Messages/MessageIcon'; +import { useMessageHelpers, useLocalize } from '~/hooks'; import ContentParts from './Content/ContentParts'; import SiblingSwitch from './SiblingSwitch'; -import { useMessageHelpers } from '~/hooks'; // eslint-disable-next-line import/no-cycle import MultiMessage from './MultiMessage'; import HoverButtons from './HoverButtons'; @@ -12,6 +12,7 @@ import { cn } from '~/utils'; import store from '~/store'; export default function Message(props: TMessageProps) { + const localize = useLocalize(); const { message, siblingIdx, siblingCount, setSiblingIdx, currentEditId, setCurrentEditId } = props; @@ -31,7 +32,6 @@ export default function Message(props: TMessageProps) { regenerateMessage, } = useMessageHelpers(props); const fontSize = useRecoilValue(store.fontSize); - const { content, children, messageId = null, isCreatedByUser, error, unfinished } = message ?? {}; if (!message) { @@ -59,12 +59,13 @@ export default function Message(props: TMessageProps) {
- {/* TODO: LOCALIZE */} - {isCreatedByUser != null ? 'You' : (assistant && assistant.name) ?? 'Assistant'} + {isCreatedByUser === true + ? localize('com_user_message') + : (assistant && assistant.name) ?? localize('com_ui_assistant')}
@@ -76,7 +77,7 @@ export default function Message(props: TMessageProps) { message={message} messageId={messageId} enterEdit={enterEdit} - error={!!error} + error={!!(error ?? false)} isSubmitting={isSubmitting} unfinished={unfinished ?? false} isCreatedByUser={isCreatedByUser ?? true} diff --git a/client/src/components/Endpoints/ConvoIcon.tsx b/client/src/components/Endpoints/ConvoIcon.tsx index a3e3ac6835a..4a42e4173a9 100644 --- a/client/src/components/Endpoints/ConvoIcon.tsx +++ b/client/src/components/Endpoints/ConvoIcon.tsx @@ -1,3 +1,4 @@ +import React, { useMemo } from 'react'; import { isAssistantsEndpoint } from 'librechat-data-provider'; import type { TAssistantsMap, @@ -20,7 +21,7 @@ export default function ConvoIcon({ }: { conversation: TConversation | TPreset | null; endpointsConfig: TEndpointsConfig; - assistantMap: TAssistantsMap; + assistantMap: TAssistantsMap | undefined; containerClassName?: string; context?: 'message' | 'nav' | 'landing' | 'menu-item'; className?: string; @@ -29,11 +30,19 @@ export default function ConvoIcon({ const iconURL = conversation?.iconURL; let endpoint = conversation?.endpoint; endpoint = getIconEndpoint({ endpointsConfig, iconURL, endpoint }); - const assistant = - isAssistantsEndpoint(endpoint) && assistantMap?.[endpoint]?.[conversation?.assistant_id ?? '']; - const assistantName = (assistant && assistant?.name) || ''; + const assistant = useMemo(() => { + if (!isAssistantsEndpoint(conversation?.endpoint)) { + return undefined; + } - const avatar = (assistant && (assistant?.metadata?.avatar as string)) || ''; + const endpointKey = conversation?.endpoint ?? ''; + const assistantId = conversation?.assistant_id ?? ''; + + return assistantMap?.[endpointKey] ? assistantMap[endpointKey][assistantId] : undefined; + }, [conversation?.endpoint, conversation?.assistant_id, assistantMap]); + const assistantName = assistant && (assistant.name ?? ''); + + const avatar = (assistant && (assistant.metadata?.avatar as string)) || ''; const endpointIconURL = getEndpointField(endpointsConfig, endpoint, 'iconURL'); const iconKey = getIconKey({ endpoint, endpointsConfig, endpointIconURL }); const Icon = icons[iconKey]; diff --git a/client/src/components/SidePanel/Builder/ActionsInput.tsx b/client/src/components/SidePanel/Builder/ActionsInput.tsx index c64fdfe4189..741fa68de5b 100644 --- a/client/src/components/SidePanel/Builder/ActionsInput.tsx +++ b/client/src/components/SidePanel/Builder/ActionsInput.tsx @@ -62,12 +62,12 @@ export default function ActionsInput({ const [functions, setFunctions] = useState(null); useEffect(() => { - if (!action?.metadata?.raw_spec) { + if (!action?.metadata.raw_spec) { return; } setInputValue(action.metadata.raw_spec); debouncedValidation(action.metadata.raw_spec, handleResult); - }, [action?.metadata?.raw_spec]); + }, [action?.metadata.raw_spec]); useEffect(() => { if (!validationResult || !validationResult.status || !validationResult.spec) { @@ -100,7 +100,7 @@ export default function ActionsInput({ }, onError(error) { showToast({ - message: (error as Error)?.message ?? localize('com_assistants_update_actions_error'), + message: (error as Error).message ?? localize('com_assistants_update_actions_error'), status: 'error', }); }, @@ -180,7 +180,7 @@ export default function ActionsInput({ assistant_id, endpoint, version, - model: assistantMap[endpoint][assistant_id].model, + model: assistantMap?.[endpoint][assistant_id].model ?? '', }); }); @@ -195,16 +195,32 @@ export default function ActionsInput({ debouncedValidation(newValue, handleResult); }; + const submitContext = () => { + if (updateAction.isLoading) { + return ; + } else if (action?.action_id.length ?? 0) { + return localize('com_ui_update'); + } else { + return localize('com_ui_create'); + } + }; + return ( <>
- +
{/* */} @@ -280,13 +288,7 @@ export default function ActionsInput({ className="focus:shadow-outline mt-1 flex min-w-[100px] items-center justify-center rounded bg-green-500 px-4 py-2 font-semibold text-white hover:bg-green-400 focus:border-green-500 focus:outline-none focus:ring-0 disabled:bg-green-400" type="button" > - {updateAction.isLoading ? ( - - ) : action?.action_id ? ( - localize('com_ui_update') - ) : ( - localize('com_ui_create') - )} + {submitContext()}
diff --git a/client/src/components/SidePanel/Builder/AssistantAvatar.tsx b/client/src/components/SidePanel/Builder/AssistantAvatar.tsx index 2cfe9bfd62f..c94c1c956b2 100644 --- a/client/src/components/SidePanel/Builder/AssistantAvatar.tsx +++ b/client/src/components/SidePanel/Builder/AssistantAvatar.tsx @@ -51,7 +51,7 @@ function Avatar({ const { showToast } = useToastContext(); const activeModel = useMemo(() => { - return assistantsMap[endpoint][assistant_id ?? '']?.model ?? ''; + return assistantsMap?.[endpoint][assistant_id ?? '']?.model ?? ''; }, [assistantsMap, endpoint, assistant_id]); const { mutate: uploadAvatar } = useUploadAssistantAvatarMutation({ @@ -59,7 +59,7 @@ function Avatar({ setProgress(0.4); }, onSuccess: (data, vars) => { - if (!vars.postCreation) { + if (vars.postCreation !== true) { showToast({ message: localize('com_ui_upload_success') }); } else if (lastSeenCreatedId.current !== createMutation.data?.id) { lastSeenCreatedId.current = createMutation.data?.id ?? ''; @@ -136,9 +136,9 @@ function Avatar({ createMutation.isSuccess && input && previewUrl && - previewUrl?.includes('base64') + previewUrl.includes('base64') ); - if (sharedUploadCondition && lastSeenCreatedId.current === createMutation.data?.id) { + if (sharedUploadCondition && lastSeenCreatedId.current === createMutation.data.id) { return; } @@ -149,8 +149,8 @@ function Avatar({ formData.append('file', input, input.name); formData.append('assistant_id', createMutation.data.id); - if (typeof createMutation.data?.metadata === 'object') { - formData.append('metadata', JSON.stringify(createMutation.data?.metadata)); + if (typeof createMutation.data.metadata === 'object') { + formData.append('metadata', JSON.stringify(createMutation.data.metadata)); } uploadAvatar({ diff --git a/client/src/components/SidePanel/Builder/AssistantPanel.tsx b/client/src/components/SidePanel/Builder/AssistantPanel.tsx index d0dfa04e30f..621156d9a08 100644 --- a/client/src/components/SidePanel/Builder/AssistantPanel.tsx +++ b/client/src/components/SidePanel/Builder/AssistantPanel.tsx @@ -100,7 +100,7 @@ export default function AssistantPanel({ const error = err as Error; showToast({ message: `${localize('com_assistants_update_error')}${ - error?.message ? ` ${localize('com_ui_error')}: ${error?.message}` : '' + error.message ? ` ${localize('com_ui_error')}: ${error.message}` : '' }`, status: 'error', }); @@ -119,7 +119,7 @@ export default function AssistantPanel({ const error = err as Error; showToast({ message: `${localize('com_assistants_create_error')}${ - error?.message ? ` ${localize('com_ui_error')}: ${error?.message}` : '' + error.message ? ` ${localize('com_ui_error')}: ${error.message}` : '' }`, status: 'error', }); @@ -139,7 +139,7 @@ export default function AssistantPanel({ return functionName; } else { const assistant = assistantMap?.[endpoint]?.[assistant_id]; - const tool = assistant?.tools?.find((tool) => tool.function?.name === functionName); + const tool = assistant?.tools.find((tool) => tool.function?.name === functionName); if (assistant && tool) { return tool; } @@ -193,6 +193,16 @@ export default function AssistantPanel({ }); }; + let submitContext: string | JSX.Element; + + if (create.isLoading || update.isLoading) { + submitContext = ; + } else if (assistant_id) { + submitContext = localize('com_ui_save'); + } else { + submitContext = localize('com_ui_create'); + } + return (
@@ -425,13 +435,7 @@ export default function AssistantPanel({ className="btn btn-primary focus:shadow-outline flex w-full items-center justify-center px-4 py-2 font-semibold text-white hover:bg-green-600 focus:border-green-500" type="submit" > - {create.isLoading || update.isLoading ? ( - - ) : assistant_id ? ( - localize('com_ui_save') - ) : ( - localize('com_ui_create') - )} + {submitContext}
diff --git a/client/src/components/SidePanel/Builder/ContextButton.tsx b/client/src/components/SidePanel/Builder/ContextButton.tsx index 308c0cc0e97..6bd0e7245cc 100644 --- a/client/src/components/SidePanel/Builder/ContextButton.tsx +++ b/client/src/components/SidePanel/Builder/ContextButton.tsx @@ -15,7 +15,7 @@ export default function ContextButton({ createMutation, endpoint, }: { - activeModel: string; + activeModel?: string; assistant_id: string; setCurrentAssistantId: React.Dispatch>; createMutation: UseMutationResult; @@ -38,7 +38,7 @@ export default function ContextButton({ status: 'success', }); - if (createMutation.data?.id) { + if (createMutation.data?.id !== undefined) { console.log('[deleteAssistant] resetting createMutation'); createMutation.reset(); } @@ -52,7 +52,7 @@ export default function ContextButton({ return setOption('assistant_id')(firstAssistant.id); } - const currentAssistant = updatedList?.find( + const currentAssistant = updatedList.find( (assistant) => assistant.id === conversation?.assistant_id, ); @@ -75,6 +75,10 @@ export default function ContextButton({ return null; } + if (activeModel?.length === 0 || activeModel === undefined) { + return null; + } + return ( diff --git a/client/src/hooks/Assistants/useAssistantsMap.ts b/client/src/hooks/Assistants/useAssistantsMap.ts index 46ddd6cc33c..eb44bef8d0c 100644 --- a/client/src/hooks/Assistants/useAssistantsMap.ts +++ b/client/src/hooks/Assistants/useAssistantsMap.ts @@ -7,7 +7,7 @@ export default function useAssistantsMap({ isAuthenticated, }: { isAuthenticated: boolean; -}): TAssistantsMap { +}): TAssistantsMap | undefined { const { data: assistants = {} } = useListAssistantsQuery(EModelEndpoint.assistants, undefined, { select: (res) => mapAssistants(res.data), enabled: isAuthenticated, diff --git a/client/src/hooks/Messages/useMessageActions.tsx b/client/src/hooks/Messages/useMessageActions.tsx index 051454c7209..5607cbab30a 100644 --- a/client/src/hooks/Messages/useMessageActions.tsx +++ b/client/src/hooks/Messages/useMessageActions.tsx @@ -32,7 +32,7 @@ export default function useMessageActions(props: TMessageActions) { } = useChatContext(); const { conversation: addedConvo, isSubmitting: isSubmittingAdditional } = useAddedChatContext(); const conversation = useMemo( - () => (isMultiMessage ? addedConvo : rootConvo), + () => (isMultiMessage === true ? addedConvo : rootConvo), [isMultiMessage, addedConvo, rootConvo], ); const assistantMap = useAssistantsMapContext(); @@ -41,24 +41,28 @@ export default function useMessageActions(props: TMessageActions) { const edit = useMemo(() => messageId === currentEditId, [messageId, currentEditId]); const enterEdit = useCallback( - (cancel?: boolean) => setCurrentEditId && setCurrentEditId(cancel ? -1 : messageId), + (cancel?: boolean) => setCurrentEditId && setCurrentEditId(cancel === true ? -1 : messageId), [messageId, setCurrentEditId], ); - const assistant = useMemo( - () => - isAssistantsEndpoint(conversation?.endpoint) && - assistantMap?.[conversation?.endpoint ?? '']?.[message?.model ?? ''], - [assistantMap, conversation?.endpoint, message?.model], - ); + const assistant = useMemo(() => { + if (!isAssistantsEndpoint(conversation?.endpoint)) { + return undefined; + } + + const endpointKey = conversation?.endpoint ?? ''; + const modelKey = message?.model ?? ''; + + return assistantMap?.[endpointKey] ? assistantMap[endpointKey][modelKey] : undefined; + }, [conversation?.endpoint, message?.model, assistantMap]); const isSubmitting = useMemo( - () => (isMultiMessage ? isSubmittingAdditional : isSubmittingRoot), + () => (isMultiMessage === true ? isSubmittingAdditional : isSubmittingRoot), [isMultiMessage, isSubmittingAdditional, isSubmittingRoot], ); const regenerateMessage = useCallback(() => { - if ((isSubmitting && isCreatedByUser) || !message) { + if ((isSubmitting && isCreatedByUser === true) || !message) { return; } @@ -68,8 +72,8 @@ export default function useMessageActions(props: TMessageActions) { const copyToClipboard = useCopyToClipboard({ text, content }); const messageLabel = useMemo(() => { - if (message?.isCreatedByUser) { - return UsernameDisplay ? user?.name || user?.username : localize('com_user_message'); + if (message?.isCreatedByUser === true) { + return UsernameDisplay ? user?.name != null || user?.username : localize('com_user_message'); } else if (assistant) { return assistant.name ?? 'Assistant'; } else { diff --git a/client/src/hooks/Messages/useMessageHelpers.tsx b/client/src/hooks/Messages/useMessageHelpers.tsx index b5ad809ac57..ea68f70d536 100644 --- a/client/src/hooks/Messages/useMessageHelpers.tsx +++ b/client/src/hooks/Messages/useMessageHelpers.tsx @@ -1,4 +1,4 @@ -import { useEffect, useRef, useCallback } from 'react'; +import { useEffect, useRef, useCallback, useMemo } from 'react'; import { Constants, isAssistantsEndpoint } from 'librechat-data-provider'; import type { TMessageProps } from '~/common'; import { useChatContext, useAssistantsMapContext } from '~/Providers'; @@ -24,7 +24,7 @@ export default function useMessageHelpers(props: TMessageProps) { const { text, content, children, messageId = null, isCreatedByUser } = message ?? {}; const edit = messageId === currentEditId; - const isLast = !children?.length; + const isLast = children?.length === 0 || children?.length === undefined; useEffect(() => { const convoId = conversation?.conversationId; @@ -44,7 +44,7 @@ export default function useMessageHelpers(props: TMessageProps) { const logInfo = { textKey, 'latestText.current': latestText.current, - messageId: message?.messageId, + messageId: message.messageId, convoId, }; if ( @@ -60,7 +60,7 @@ export default function useMessageHelpers(props: TMessageProps) { }, [isLast, message, setLatestMessage, conversation?.conversationId]); const enterEdit = useCallback( - (cancel?: boolean) => setCurrentEditId && setCurrentEditId(cancel ? -1 : messageId), + (cancel?: boolean) => setCurrentEditId && setCurrentEditId(cancel === true ? -1 : messageId), [messageId, setCurrentEditId], ); @@ -72,12 +72,19 @@ export default function useMessageHelpers(props: TMessageProps) { } }, [isSubmitting, setAbortScroll]); - const assistant = - isAssistantsEndpoint(conversation?.endpoint) && - assistantMap?.[conversation?.endpoint ?? '']?.[message?.model ?? '']; + const assistant = useMemo(() => { + if (!isAssistantsEndpoint(conversation?.endpoint)) { + return undefined; + } + + const endpointKey = conversation?.endpoint ?? ''; + const modelKey = message?.model ?? ''; + + return assistantMap?.[endpointKey] ? assistantMap[endpointKey][modelKey] : undefined; + }, [conversation?.endpoint, message?.model, assistantMap]); const regenerateMessage = () => { - if ((isSubmitting && isCreatedByUser) || !message) { + if ((isSubmitting && isCreatedByUser === true) || !message) { return; } From 64a3ed957ff70644ea84c1c00124a6ed9cbe3455 Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Fri, 9 Aug 2024 14:25:21 -0400 Subject: [PATCH 6/9] refactor: Remove obsolete scripts --- config/install.js | 104 ----------------------------- config/upgrade.js | 163 ---------------------------------------------- 2 files changed, 267 deletions(-) delete mode 100644 config/install.js delete mode 100644 config/upgrade.js diff --git a/config/install.js b/config/install.js deleted file mode 100644 index bc8e0d0a67a..00000000000 --- a/config/install.js +++ /dev/null @@ -1,104 +0,0 @@ -/** - * Install script: WIP - */ -const fs = require('fs'); -const { exit } = require('process'); -const { askQuestion } = require('./helpers'); - -// If we are not in a TTY, lets exit -if (!process.stdin.isTTY) { - console.log('Note: we are not in a TTY, skipping install script.'); - exit(0); -} - -// If we are in CI env, lets exit -if (process.env.NODE_ENV === 'CI') { - console.log('Note: we are in a CI environment, skipping install script.'); - exit(0); -} - -// Save the original console.log function -const originalConsoleWarn = console.warn; -console.warn = () => {}; -const loader = require('./loader'); -console.warn = originalConsoleWarn; - -const rootEnvPath = loader.resolve('.env'); - -// Skip if the env file exists -if (fs.existsSync(rootEnvPath)) { - exit(0); -} - -// Run the upgrade script if the legacy api/env file exists -// Todo: remove this in a future version -if (fs.existsSync(loader.resolve('api/.env'))) { - console.warn('Upgrade script has yet to run, lets do that!'); - require('./upgrade'); - exit(0); -} - -// Check the example file exists -if (!fs.existsSync(rootEnvPath + '.example')) { - console.red('It looks like the example env file is missing, please complete setup manually.'); - exit(0); -} - -// Copy the example file -fs.copyFileSync(rootEnvPath + '.example', rootEnvPath); - -// Update the secure keys! -loader.addSecureEnvVar(rootEnvPath, 'CREDS_KEY', 32); -loader.addSecureEnvVar(rootEnvPath, 'CREDS_IV', 16); -loader.addSecureEnvVar(rootEnvPath, 'JWT_SECRET', 32); -loader.addSecureEnvVar(rootEnvPath, 'MEILI_MASTER_KEY', 32); - -// Init env -let env = {}; - -(async () => { - // Lets colour the console - console.purple('=== LibreChat First Install ==='); - console.blue('Note: Leave blank to use the default value.'); - console.log(''); // New line - - // Ask for the app title - const title = await askQuestion('Enter the app title (default: "LibreChat"): '); - env['APP_TITLE'] = title || 'LibreChat'; - - // Ask for OPENAI_API_KEY - const key = await askQuestion('Enter your OPENAI_API_KEY (default: "user_provided"): '); - env['OPENAI_API_KEY'] = key || 'user_provided'; - - // Ask about mongodb - const mongodb = await askQuestion( - 'What is your mongodb url? (default: mongodb://127.0.0.1:27018/LibreChat)', - ); - env['MONGO_URI'] = mongodb || 'mongodb://127.0.0.1:27018/LibreChat'; - // Very basic check to make sure they entered a url - if (!env['MONGO_URI'].includes('://')) { - console.orange( - 'Warning: Your mongodb url looks incorrect, please double check it in the `.env` file.', - ); - } - - // Lets ask about open registration - const openReg = await askQuestion('Do you want to allow user registration (y/n)? Default: y'); - if (openReg === 'n' || openReg === 'no') { - env['ALLOW_REGISTRATION'] = 'false'; - // Lets tell them about how to create an account: - console.red( - 'Note: You can create an account by running: `npm run create-user `', - ); - // sleep for 1 second so they can read this - await new Promise((resolve) => setTimeout(resolve, 1000)); - } - - // Update the env file - loader.writeEnvFile(rootEnvPath, env); - - // We can ask for more here if we want - console.log(''); // New line - console.green('Success! Please read our docs if you need help setting up the rest of the app.'); - console.log(''); // New line -})(); diff --git a/config/upgrade.js b/config/upgrade.js deleted file mode 100644 index c954cf0452a..00000000000 --- a/config/upgrade.js +++ /dev/null @@ -1,163 +0,0 @@ -/** - * Upgrade script - */ -const fs = require('fs'); -const dotenv = require('dotenv'); -const { exit } = require('process'); - -// Suppress default warnings -const originalConsoleWarn = console.warn; -console.warn = () => {}; -const loader = require('./loader'); -console.warn = originalConsoleWarn; - -// Old Paths -const apiEnvPath = loader.resolve('api/.env'); -const clientEnvPath = loader.resolve('client/.env'); - -// Load into env -dotenv.config({ - path: loader.resolve(apiEnvPath), -}); -dotenv.config({ - path: loader.resolve(clientEnvPath), -}); -// JS was doing spooky actions at a distance, lets prevent that -const initEnv = JSON.parse(JSON.stringify(process.env)); - -// New Paths -const rootEnvPath = loader.resolve('.env'); -const devEnvPath = loader.resolve('.env.development'); -const prodEnvPath = loader.resolve('.env.production'); - -if (fs.existsSync(rootEnvPath)) { - console.error('Root env file already exists! Aborting'); - exit(1); -} - -// Validate old configs -if (!fs.existsSync(apiEnvPath)) { - console.error('Api env doesn\'t exit! Did you mean to run install?'); - exit(1); -} -if (!fs.existsSync(clientEnvPath)) { - console.error('Client env doesn\'t exit! But api/.env does. Manual upgrade required'); - exit(1); -} - -/** - * Refactor the ENV if it has a prod_/dev_ version - * - * @param {*} varDev - * @param {*} varProd - * @param {*} varName - */ -function refactorPairedEnvVar(varDev, varProd, varName) { - // Lets validate if either of these are undefined, if so lets use the non-undefined one - if (initEnv[varDev] === undefined && initEnv[varProd] === undefined) { - console.error(`Both ${varDev} and ${varProd} are undefined! Manual intervention required!`); - } else if (initEnv[varDev] === undefined) { - fs.appendFileSync(rootEnvPath, `\n${varName}=${initEnv[varProd]}`); - } else if (initEnv[varProd] === undefined) { - fs.appendFileSync(rootEnvPath, `\n${varName}=${initEnv[varDev]}`); - } else if (initEnv[varDev] === initEnv[varProd]) { - fs.appendFileSync(rootEnvPath, `\n${varName}=${initEnv[varDev]}`); - } else { - fs.appendFileSync(rootEnvPath, `${varName}=${initEnv[varProd]}\n`); - fs.appendFileSync(devEnvPath, `${varName}=${initEnv[varDev]}\n`); - } -} - -/** - * Upgrade the env files! - * 1. /api/.env will merge into /.env - * 2. /client/.env will merge into /.env - * 3. Any prod_/dev_ keys will be split up into .env.development / .env.production files (if they are different) - */ -if (fs.existsSync(apiEnvPath)) { - fs.copyFileSync(apiEnvPath, rootEnvPath); - fs.copyFileSync(apiEnvPath, rootEnvPath + '.api.bak'); - fs.unlinkSync(apiEnvPath); -} - -// Clean up Domain variables -fs.appendFileSync( - rootEnvPath, - '\n\n##########################\n# Domain Variables:\n# Note: DOMAIN_ vars are passed to vite\n##########################\n', -); -refactorPairedEnvVar('CLIENT_URL_DEV', 'CLIENT_URL_PROD', 'DOMAIN_CLIENT'); -refactorPairedEnvVar('SERVER_URL_DEV', 'SERVER_URL_PROD', 'DOMAIN_SERVER'); - -// Remove the old vars -const removeEnvs = { - NODE_ENV: 'remove', - OPENAI_KEY: 'remove', - CLIENT_URL_DEV: 'remove', - CLIENT_URL_PROD: 'remove', - SERVER_URL_DEV: 'remove', - SERVER_URL_PROD: 'remove', - JWT_SECRET_DEV: 'remove', // Lets regen - JWT_SECRET_PROD: 'remove', // Lets regen - VITE_APP_TITLE: 'remove', - // Comments to remove: - '#JWT:': 'remove', - '# Add a secure secret for production if deploying to live domain.': 'remove', - '# Site URLs:': 'remove', - '# Don\'t forget to set Node env to development in the Server configuration section above': - 'remove', - '# if you want to run in dev mode': 'remove', - '# Change these values to domain if deploying:': 'remove', - '# Set Node env to development if running in dev mode.': 'remove', -}; -loader.writeEnvFile(rootEnvPath, removeEnvs); - -/** - * Lets make things more secure! - * 1. Add CREDS_KEY - * 2. Add CREDS_IV - * 3. Add JWT_SECRET - */ -fs.appendFileSync( - rootEnvPath, - '\n\n##########################\n# Secure Keys:\n##########################\n', -); -loader.addSecureEnvVar(rootEnvPath, 'CREDS_KEY', 32); -loader.addSecureEnvVar(rootEnvPath, 'CREDS_IV', 16); -loader.addSecureEnvVar(rootEnvPath, 'JWT_SECRET', 32); - -// Lets update the openai key name, not the best spot in the env file but who cares ¯\_(ツ)_/¯ -loader.writeEnvFile(rootEnvPath, { OPENAI_API_KEY: initEnv['OPENAI_KEY'] }); - -// TODO: we need to copy over the value of: APP_TITLE -fs.appendFileSync( - rootEnvPath, - '\n\n##########################\n# Frontend Vite Variables:\n##########################\n', -); -const frontend = { - APP_TITLE: initEnv['VITE_APP_TITLE'] || '"LibreChat"', - ALLOW_REGISTRATION: 'true', -}; -loader.writeEnvFile(rootEnvPath, frontend); - -// Ensure .env.development and .env.production files end with a newline -if (fs.existsSync(devEnvPath)) { - fs.appendFileSync(devEnvPath, '\n'); -} -if (fs.existsSync(prodEnvPath)) { - fs.appendFileSync(prodEnvPath, '\n'); -} -// Remove client file -fs.copyFileSync(clientEnvPath, rootEnvPath + '.client.bak'); -fs.unlinkSync(clientEnvPath); - -console.log('###############################################'); -console.log('Upgrade completed! Please review the new .env file and make any changes as needed.'); -console.log('###############################################'); - -// if the .env.development file exists, lets tell the user -if (fs.existsSync(devEnvPath)) { - console.log( - 'NOTE: A .env.development file was created. This will take precedence over the .env file when running in dev mode.', - ); - console.log('###############################################'); -} From 7929f2c036ff13ef05b7880ad0ca9412158f7c7a Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Fri, 9 Aug 2024 14:58:37 -0400 Subject: [PATCH 7/9] fix: Update DropdownNoState component to handle both string and OptionType values --- client/src/components/ui/DropdownNoState.tsx | 35 ++++++++++---------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/client/src/components/ui/DropdownNoState.tsx b/client/src/components/ui/DropdownNoState.tsx index 2f32436dbc7..67cb826425b 100644 --- a/client/src/components/ui/DropdownNoState.tsx +++ b/client/src/components/ui/DropdownNoState.tsx @@ -15,9 +15,9 @@ type OptionType = { }; interface DropdownProps { - value: string; + value: string | OptionType; label?: string; - onChange: (value: string) => void; + onChange: (value: string) => void | ((value: OptionType) => void); options: (string | OptionType)[]; className?: string; anchor?: AnchorPropsWithSelection; @@ -35,14 +35,19 @@ const Dropdown: FC = ({ sizeClasses, testId = 'dropdown-menu', }) => { + const getValue = (option: string | OptionType): string => + typeof option === 'string' ? option : option.value; + + const getDisplay = (option: string | OptionType): string => + typeof option === 'string' ? option : (option.display ?? '') || option.value; + + const selectedOption = options.find((option) => getValue(option) === getValue(value)); + + const displayValue = selectedOption != null ? getDisplay(selectedOption) : getDisplay(value); + return (
- { - onChange(newValue); - }} - > +
= ({ > {label} - {options - .map((o) => (typeof o === 'string' ? { value: o, display: o } : o)) - .find((o) => o.value === value)?.display || value} + {displayValue} = ({ > = ({ {options.map((item, index) => (
- - {typeof item === 'string' ? item : (item as OptionType).display} - + {getDisplay(item)}
))} From f9ca57b9aa3c9988438e79340f8f4e40c86ea111 Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Fri, 9 Aug 2024 14:58:56 -0400 Subject: [PATCH 8/9] refactor: Remove config/loader.js file --- config/loader.js | 252 ----------------------------------------------- 1 file changed, 252 deletions(-) delete mode 100644 config/loader.js diff --git a/config/loader.js b/config/loader.js deleted file mode 100644 index a29ca19a0a4..00000000000 --- a/config/loader.js +++ /dev/null @@ -1,252 +0,0 @@ -const fs = require('fs'); -const path = require('path'); -const crypto = require('crypto'); -const dotenv = require('dotenv'); - -/** - * This class is responsible for loading the environment variables - * - * Inspired by: https://thekenyandev.com/blog/environment-variables-strategy-for-node/ - */ -class Env { - constructor() { - this.envMap = { - default: '.env', - development: '.env.development', - test: '.env.test', - production: '.env.production', - }; - - this.init(); - - this.isProduction = process.env.NODE_ENV === 'production'; - this.domains = { - client: process.env.DOMAIN_CLIENT, - server: process.env.DOMAIN_SERVER, - }; - } - - /** - * Initialize the environment variables - */ - init() { - let hasDefault = false; - // Load the default env file if it exists - if (fs.existsSync(this.envMap.default)) { - hasDefault = true; - dotenv.config({ - // path: this.resolve(this.envMap.default), - path: path.resolve(__dirname, '..', this.envMap.default), - }); - } else { - console.warn('The default .env file was not found'); - } - - const environment = this.currentEnvironment(); - - // Load the environment specific env file - const envFile = this.envMap[environment]; - - // check if the file exists - if (fs.existsSync(envFile)) { - dotenv.config({ - // path: this.resolve(envFile), - path: path.resolve(__dirname, '..', envFile), - }); - } else if (!hasDefault) { - console.warn('No env files found, have you completed the install process?'); - } - } - - /** - * Validate Config - */ - validate() { - const requiredKeys = [ - 'NODE_ENV', - 'JWT_SECRET', - 'DOMAIN_CLIENT', - 'DOMAIN_SERVER', - 'CREDS_KEY', - 'CREDS_IV', - ]; - - const missingKeys = requiredKeys - .map((key) => { - const variable = process.env[key]; - if (variable === undefined || variable === null) { - return key; - } - }) - .filter((value) => value !== undefined); - - // Throw an error if any required keys are missing - if (missingKeys.length) { - const message = ` - The following required env variables are missing: - ${missingKeys.toString()}. - Please add them to your env file or run 'npm run install' - `; - throw new Error(message); - } - - // Check JWT secret for default - if (process.env.JWT_SECRET === 'secret') { - console.warn('Warning: JWT_SECRET is set to default value'); - } - } - - /** - * Resolve the location of the env file - * - * @param {String} envFile - * @returns - */ - resolve(envFile) { - return path.resolve(process.cwd(), envFile); - } - - /** - * Add secure keys to the env - * - * @param {String} filePath The path of the .env you are updating - * @param {String} key The env you are adding - * @param {Number} length The length of the secure key - */ - addSecureEnvVar(filePath, key, length) { - const env = {}; - env[key] = this.generateSecureRandomString(length); - this.writeEnvFile(filePath, env); - } - - /** - * Write the change to the env file - */ - writeEnvFile(filePath, env) { - const content = fs.readFileSync(filePath, 'utf-8'); - const lines = content.split('\n'); - const updatedLines = lines - .map((line) => { - if (line.trim().startsWith('#')) { - // Allow comment removal - if (env[line] === 'remove') { - return null; // Mark the line for removal - } - // Preserve comments - return line; - } - - const [key, value] = line.split('='); - if (key && value && Object.prototype.hasOwnProperty.call(env, key.trim())) { - if (env[key.trim()] === 'remove') { - return null; // Mark the line for removal - } - return `${key.trim()}=${env[key.trim()]}`; - } - return line; - }) - .filter((line) => line !== null); // Remove lines marked for removal - - // Add any new environment variables that are not in the file yet - Object.entries(env).forEach(([key, value]) => { - if (value !== 'remove' && !updatedLines.some((line) => line.startsWith(`${key}=`))) { - updatedLines.push(`${key}=${value}`); - } - }); - - // Loop through updatedLines and wrap values with spaces in double quotes - const fixedLines = updatedLines.map((line) => { - // lets only split the first = sign - const [key, value] = line.split(/=(.+)/); - if (typeof value === 'undefined' || line.trim().startsWith('#')) { - return line; - } - // Skip lines with quotes and numbers already - // Todo: this could be one regex - const wrappedValue = - value.includes(' ') && !value.includes('"') && !value.includes('\'') && !/\d/.test(value) - ? `"${value}"` - : value; - return `${key}=${wrappedValue}`; - }); - - const updatedContent = fixedLines.join('\n'); - fs.writeFileSync(filePath, updatedContent); - } - - /** - * Generate Secure Random Strings - * - * @param {Number} length The length of the random string - * @returns - */ - generateSecureRandomString(length = 32) { - return crypto.randomBytes(length).toString('hex'); - } - - /** - * Get all the environment variables - */ - all() { - return process.env; - } - - /** - * Get an environment variable - * - * @param {String} variable - * @returns - */ - get(variable) { - return process.env[variable]; - } - - /** - * Get the current environment name - * - * @returns {String} - */ - currentEnvironment() { - return this.get('NODE_ENV'); - } - - /** - * Are we running in development? - * - * @returns {Boolean} - */ - isDevelopment() { - return this.currentEnvironment() === 'development'; - } - - /** - * Are we running tests? - * - * @returns {Boolean} - */ - isTest() { - return this.currentEnvironment() === 'test'; - } - - /** - * Are we running in production? - * - * @returns {Boolean} - */ - isProduction() { - return this.currentEnvironment() === 'production'; - } - - /** - * Are we running in CI? - * - * @returns {Boolean} - */ - isCI() { - return this.currentEnvironment() === 'CI'; - } -} - -const env = new Env(); - -module.exports = env; From 2463efe256c6677492ecbd6df6e7e3476db42f82 Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Fri, 9 Aug 2024 15:09:25 -0400 Subject: [PATCH 9/9] fix: remove crypto.randomBytes(); refactor: Create reusable function for generating token and hash --- api/server/services/AuthService.js | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/api/server/services/AuthService.js b/api/server/services/AuthService.js index 9664a7e67c9..eb2dd63e6be 100644 --- a/api/server/services/AuthService.js +++ b/api/server/services/AuthService.js @@ -1,4 +1,5 @@ const bcrypt = require('bcryptjs'); +const { webcrypto } = require('node:crypto'); const { SystemRoles, errorsToString } = require('librechat-data-provider'); const { findUser, @@ -53,14 +54,23 @@ const logoutUser = async (userId, refreshToken) => { } }; +/** + * Creates Token and corresponding Hash for verification + * @returns {[string, string]} + */ +const createTokenHash = () => { + const token = Buffer.from(webcrypto.getRandomValues(new Uint8Array(32))).toString('hex'); + const hash = bcrypt.hashSync(token, 10); + return [token, hash]; +}; + /** * Send Verification Email * @param {Partial & { _id: ObjectId, email: string, name: string}} user * @returns {Promise} */ const sendVerificationEmail = async (user) => { - let verifyToken = crypto.randomBytes(32).toString('hex'); - const hash = bcrypt.hashSync(verifyToken, 10); + const [verifyToken, hash] = createTokenHash(); const verificationLink = `${ domains.client @@ -226,8 +236,7 @@ const requestPasswordReset = async (req) => { await token.deleteOne(); } - let resetToken = crypto.randomBytes(32).toString('hex'); - const hash = bcrypt.hashSync(resetToken, 10); + const [resetToken, hash] = createTokenHash(); await new Token({ userId: user._id, @@ -365,8 +374,7 @@ const resendVerificationEmail = async (req) => { return { status: 200, message: genericVerificationMessage }; } - let verifyToken = crypto.randomBytes(32).toString('hex'); - const hash = bcrypt.hashSync(verifyToken, 10); + const [verifyToken, hash] = createTokenHash(); const verificationLink = `${ domains.client