Merge pull request #4476 from janhq/chore/refactor-remove-engine-atom

chore: refactor - clean out useEngines - mutate swr to update
This commit is contained in:
Louis 2025-01-17 13:06:36 +07:00 committed by GitHub
commit 56df7374f7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
18 changed files with 64 additions and 96 deletions

View File

@ -8,7 +8,7 @@
"inference_params": {
"max_tokens": 4096,
"temperature": 0.7,
"stream": false
"stream": true
},
"engine": "anthropic"
},
@ -21,7 +21,7 @@
"inference_params": {
"max_tokens": 8192,
"temperature": 0.7,
"stream": false
"stream": true
},
"engine": "anthropic"
},

View File

@ -1,19 +1,20 @@
import { Tooltip, Button, Badge } from '@janhq/joi'
import { useAtom, useAtomValue } from 'jotai'
import { useAtom } from 'jotai'
import { useActiveModel } from '@/hooks/useActiveModel'
import { useGetEngines } from '@/hooks/useEngineManagement'
import { toGibibytes } from '@/utils/converter'
import { isLocalEngine } from '@/utils/modelEngine'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import { serverEnabledAtom } from '@/helpers/atoms/LocalServer.atom'
const TableActiveModel = () => {
const { activeModel, stateModel, stopModel } = useActiveModel()
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const [serverEnabled, setServerEnabled] = useAtom(serverEnabledAtom)

View File

@ -31,6 +31,7 @@ import SetupRemoteModel from '@/containers/SetupRemoteModel'
import { useCreateNewThread } from '@/hooks/useCreateNewThread'
import useDownloadModel from '@/hooks/useDownloadModel'
import { modelDownloadStateAtom } from '@/hooks/useDownloadState'
import { useGetEngines } from '@/hooks/useEngineManagement'
import useRecommendedModel from '@/hooks/useRecommendedModel'
@ -42,7 +43,6 @@ import { manualRecommendationModel } from '@/utils/model'
import { getLogoEngine } from '@/utils/modelEngine'
import { activeAssistantAtom } from '@/helpers/atoms/Assistant.atom'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import {
configuredModelsAtom,
getDownloadingModelAtom,
@ -86,7 +86,7 @@ const ModelDropdown = ({
null
)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const downloadStates = useAtomValue(modelDownloadStateAtom)
const setThreadModelParams = useSetAtom(setThreadModelParamsAtom)

View File

@ -2,11 +2,18 @@
import { Fragment, useEffect } from 'react'
import { AppConfiguration, getUserHomePath } from '@janhq/core'
import {
AppConfiguration,
EngineEvent,
events,
getUserHomePath,
} from '@janhq/core'
import { useSetAtom } from 'jotai'
import { useDebouncedCallback } from 'use-debounce'
import useAssistants from '@/hooks/useAssistants'
import useEngines from '@/hooks/useEngines'
import { useGetEngines } from '@/hooks/useEngineManagement'
import useGetSystemResources from '@/hooks/useGetSystemResources'
import useModels from '@/hooks/useModels'
import useThreads from '@/hooks/useThreads'
@ -26,7 +33,7 @@ const DataLoader: React.FC = () => {
const setJanDefaultDataFolder = useSetAtom(defaultJanDataFolderAtom)
const setJanSettingScreen = useSetAtom(janSettingScreenAtom)
const { getData: loadModels } = useModels()
const { getData: loadEngines } = useEngines()
const { mutate } = useGetEngines()
useThreads()
useAssistants()
@ -35,9 +42,19 @@ const DataLoader: React.FC = () => {
useEffect(() => {
// Load data once
loadModels()
loadEngines()
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [])
const reloadData = useDebouncedCallback(() => {
mutate()
}, 300)
useEffect(() => {
events.on(EngineEvent.OnEngineUpdate, reloadData)
return () => {
// Remove listener on unmount
events.off(EngineEvent.OnEngineUpdate, reloadData)
}
}, [reloadData])
useEffect(() => {
window.core?.api

View File

@ -23,6 +23,8 @@ import { ulid } from 'ulidx'
import { activeModelAtom, stateModelAtom } from '@/hooks/useActiveModel'
import { useGetEngines } from '@/hooks/useEngineManagement'
import { isLocalEngine } from '@/utils/modelEngine'
import { extensionManager } from '@/extension'
@ -34,7 +36,6 @@ import {
deleteMessageAtom,
subscribedGeneratingMessageAtom,
} from '@/helpers/atoms/ChatMessage.atom'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import { downloadedModelsAtom } from '@/helpers/atoms/Model.atom'
import {
updateThreadWaitingForResponseAtom,
@ -75,7 +76,7 @@ export default function ModelHandler() {
const activeModelParams = useAtomValue(getActiveThreadModelParamsAtom)
const activeModelParamsRef = useRef(activeModelParams)
const setTokenSpeed = useSetAtom(tokenSpeedAtom)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
useEffect(() => {
activeThreadRef.current = activeThread

View File

@ -1,7 +0,0 @@
import { Engines } from '@janhq/core'
import { atom } from 'jotai'
/**
* Store all of the installed engines including local and remote engines
*/
export const installedEnginesAtom = atom<Engines>()

View File

@ -1,53 +0,0 @@
import { useCallback, useEffect } from 'react'
import {
ExtensionTypeEnum,
events,
EngineEvent,
EngineManagementExtension,
Engines,
} from '@janhq/core'
import { useSetAtom } from 'jotai'
import { useDebouncedCallback } from 'use-debounce'
import { extensionManager } from '@/extension'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
/**
* useModels hook - Handles the state of models
* It fetches the downloaded models, configured models and default model from Model Extension
* and updates the atoms accordingly.
*/
const useEngines = () => {
const setInstalledEngines = useSetAtom(installedEnginesAtom)
const getData = useCallback(() => {
getEngines().then(setInstalledEngines)
}, [setInstalledEngines])
const reloadData = useDebouncedCallback(() => getData(), 300)
const getEngines = async (): Promise<Engines> =>
extensionManager
.get<EngineManagementExtension>(ExtensionTypeEnum.Engine)
?.getEngines()
.catch(() => ({}) as Engines) ?? ({} as Engines)
useEffect(() => {
// Listen for engine updates
events.on(EngineEvent.OnEngineUpdate, reloadData)
return () => {
// Remove listener on unmount
events.off(EngineEvent.OnEngineUpdate, reloadData)
}
}, [reloadData])
return {
getData,
}
}
export default useEngines

View File

@ -6,8 +6,9 @@ import { atom, useAtomValue } from 'jotai'
import { activeModelAtom } from './useActiveModel'
import { useGetEngines } from './useEngineManagement'
import { activeAssistantAtom } from '@/helpers/atoms/Assistant.atom'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import { downloadedModelsAtom } from '@/helpers/atoms/Model.atom'
import { activeThreadAtom } from '@/helpers/atoms/Thread.atom'
@ -31,7 +32,7 @@ export default function useRecommendedModel() {
const activeThread = useAtomValue(activeThreadAtom)
const downloadedModels = useAtomValue(downloadedModelsAtom)
const activeAssistant = useAtomValue(activeAssistantAtom)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const getAndSortDownloadedModels = useCallback(async (): Promise<Model[]> => {
const models = downloadedModels.sort((a, b) =>

View File

@ -6,7 +6,8 @@ import { useAtomValue } from 'jotai'
import { isLocalEngine } from '@/utils/modelEngine'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import { useGetEngines } from './useEngineManagement'
import { downloadedModelsAtom } from '@/helpers/atoms/Model.atom'
import { threadsAtom } from '@/helpers/atoms/Thread.atom'
@ -14,7 +15,7 @@ export function useStarterScreen() {
const downloadedModels = useAtomValue(downloadedModelsAtom)
const threads = useAtomValue(threadsAtom)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const remoteEngines =
engines &&

View File

@ -4,9 +4,10 @@ import { Model } from '@janhq/core'
import { useAtomValue } from 'jotai'
import { useGetEngines } from '@/hooks/useEngineManagement'
import ModelItem from '@/screens/Hub/ModelList/ModelItem'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import { downloadedModelsAtom } from '@/helpers/atoms/Model.atom'
type Props = {
@ -15,7 +16,7 @@ type Props = {
const ModelList = ({ models }: Props) => {
const downloadedModels = useAtomValue(downloadedModelsAtom)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const sortedModels: Model[] = useMemo(() => {
const featuredModels: Model[] = []
const remoteModels: Model[] = []

View File

@ -4,16 +4,16 @@ import { InferenceEngine } from '@janhq/core'
import { ScrollArea } from '@janhq/joi'
import { useAtomValue } from 'jotai'
import { useGetEngines } from '@/hooks/useEngineManagement'
import { isLocalEngine } from '@/utils/modelEngine'
import LocalEngineItems from './LocalEngineItem'
import ModalAddRemoteEngine from './ModalAddRemoteEngine'
import RemoteEngineItems from './RemoteEngineItem'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
const Engines = () => {
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
return (
<ScrollArea className="h-full w-full">

View File

@ -14,11 +14,12 @@ import { twMerge } from 'tailwind-merge'
import { useActiveModel } from '@/hooks/useActiveModel'
import useDeleteModel from '@/hooks/useDeleteModel'
import { useGetEngines } from '@/hooks/useEngineManagement'
import { toGibibytes } from '@/utils/converter'
import { isLocalEngine } from '@/utils/modelEngine'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import { serverEnabledAtom } from '@/helpers/atoms/LocalServer.atom'
type Props = {
@ -32,7 +33,7 @@ const MyModelList = ({ model }: Props) => {
const { deleteModel } = useDeleteModel()
const [more, setMore] = useState(false)
const [serverEnabled, setServerEnabled] = useAtom(serverEnabledAtom)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const [menu, setMenu] = useState<HTMLDivElement | null>(null)
const [toggle, setToggle] = useState<HTMLDivElement | null>(null)

View File

@ -1,6 +1,8 @@
import { InferenceEngine } from '@janhq/core'
import { useAtomValue } from 'jotai'
import { useGetEngines } from '@/hooks/useEngineManagement'
import Advanced from '@/screens/Settings/Advanced'
import AppearanceOptions from '@/screens/Settings/Appearance'
import ExtensionCatalog from '@/screens/Settings/CoreExtensions'
@ -14,12 +16,11 @@ import Privacy from '@/screens/Settings/Privacy'
import { isLocalEngine } from '@/utils/modelEngine'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import { selectedSettingAtom } from '@/helpers/atoms/Setting.atom'
const SettingDetail = () => {
const selectedSetting = useAtomValue(selectedSettingAtom)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
switch (selectedSetting) {
case 'Engines':

View File

@ -6,12 +6,13 @@ import { useAtomValue } from 'jotai'
import LeftPanelContainer from '@/containers/LeftPanelContainer'
import { useGetEngines } from '@/hooks/useEngineManagement'
import { getTitleByEngine, isLocalEngine } from '@/utils/modelEngine'
import SettingItem from './SettingItem'
import { extensionManager } from '@/extension'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import {
showSettingActiveLocalEngineAtom,
@ -20,7 +21,7 @@ import {
import { janSettingScreenAtom } from '@/helpers/atoms/Setting.atom'
const SettingLeftPanel = () => {
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const settingScreens = useAtomValue(janSettingScreenAtom)
const showSettingActiveLocalEngine = useAtomValue(

View File

@ -7,16 +7,17 @@ import LogoMark from '@/containers/Brand/Logo/Mark'
import { MainViewState } from '@/constants/screens'
import { useGetEngines } from '@/hooks/useEngineManagement'
import { isLocalEngine } from '@/utils/modelEngine'
import { mainViewStateAtom } from '@/helpers/atoms/App.atom'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import { downloadedModelsAtom } from '@/helpers/atoms/Model.atom'
const EmptyThread = () => {
const downloadedModels = useAtomValue(downloadedModelsAtom)
const setMainViewState = useSetAtom(mainViewStateAtom)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const showOnboardingStep = useMemo(
() =>
!downloadedModels.some(

View File

@ -24,6 +24,8 @@ import useDownloadModel from '@/hooks/useDownloadModel'
import { modelDownloadStateAtom } from '@/hooks/useDownloadState'
import { useGetEngines } from '@/hooks/useEngineManagement'
import { formatDownloadPercentage, toGibibytes } from '@/utils/converter'
import { manualRecommendationModel } from '@/utils/model'
import {
@ -33,7 +35,6 @@ import {
} from '@/utils/modelEngine'
import { mainViewStateAtom } from '@/helpers/atoms/App.atom'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import {
configuredModelsAtom,
getDownloadingModelAtom,
@ -51,7 +52,7 @@ const OnDeviceStarterScreen = ({ isShowStarterScreen }: Props) => {
const { downloadModel } = useDownloadModel()
const downloadStates = useAtomValue(modelDownloadStateAtom)
const setSelectedSetting = useSetAtom(selectedSettingAtom)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const configuredModels = useAtomValue(configuredModelsAtom)
const setMainViewState = useSetAtom(mainViewStateAtom)

View File

@ -22,6 +22,7 @@ import { currentPromptAtom, fileUploadAtom } from '@/containers/Providers/Jotai'
import { useActiveModel } from '@/hooks/useActiveModel'
import { useGetEngines } from '@/hooks/useEngineManagement'
import useSendChatMessage from '@/hooks/useSendChatMessage'
import { uploader } from '@/utils/file'
@ -35,7 +36,6 @@ import RichTextEditor from './RichTextEditor'
import { showRightPanelAtom } from '@/helpers/atoms/App.atom'
import { experimentalFeatureEnabledAtom } from '@/helpers/atoms/AppConfig.atom'
import { activeAssistantAtom } from '@/helpers/atoms/Assistant.atom'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import { selectedModelAtom } from '@/helpers/atoms/Model.atom'
import { spellCheckAtom } from '@/helpers/atoms/Setting.atom'
import {
@ -64,7 +64,7 @@ const ChatInput = () => {
const textareaRef = useRef<HTMLTextAreaElement>(null)
const fileInputRef = useRef<HTMLInputElement>(null)
const imageInputRef = useRef<HTMLInputElement>(null)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const experimentalFeature = useAtomValue(experimentalFeatureEnabledAtom)
const isBlockingSend = useAtomValue(isBlockingSendAtom)
const activeAssistant = useAtomValue(activeAssistantAtom)

View File

@ -29,6 +29,7 @@ import RightPanelContainer from '@/containers/RightPanelContainer'
import { useActiveModel } from '@/hooks/useActiveModel'
import { useCreateNewThread } from '@/hooks/useCreateNewThread'
import { useGetEngines } from '@/hooks/useEngineManagement'
import useUpdateModelParameters from '@/hooks/useUpdateModelParameters'
import { getConfigurationsData } from '@/utils/componentSettings'
@ -39,7 +40,7 @@ import Tools from './Tools'
import { experimentalFeatureEnabledAtom } from '@/helpers/atoms/AppConfig.atom'
import { activeAssistantAtom } from '@/helpers/atoms/Assistant.atom'
import { installedEnginesAtom } from '@/helpers/atoms/Engines.atom'
import { selectedModelAtom } from '@/helpers/atoms/Model.atom'
import {
activeThreadAtom,
@ -61,7 +62,7 @@ const ThreadRightPanel = () => {
const [activeTabThreadRightPanel, setActiveTabThreadRightPanel] = useAtom(
activeTabThreadRightPanelAtom
)
const engines = useAtomValue(installedEnginesAtom)
const { engines } = useGetEngines()
const { updateThreadMetadata } = useCreateNewThread()
const experimentalFeature = useAtomValue(experimentalFeatureEnabledAtom)