mirror of
https://github.com/overleaf/overleaf.git
synced 2024-12-14 23:40:54 -05:00
2d2746ef24
GitOrigin-RevId: 0b75635cb9141983827dfd0fa6a58b6182d47f22
228 lines
6.6 KiB
TypeScript
228 lines
6.6 KiB
TypeScript
import {
|
|
createContext,
|
|
useContext,
|
|
useEffect,
|
|
FC,
|
|
useCallback,
|
|
useMemo,
|
|
useState,
|
|
useRef,
|
|
} from 'react'
|
|
import { useIdeReactContext } from '@/features/ide-react/context/ide-react-context'
|
|
import { useConnectionContext } from '@/features/ide-react/context/connection-context'
|
|
import { useEditorManagerContext } from '@/features/ide-react/context/editor-manager-context'
|
|
import { getJSON, postJSON } from '@/infrastructure/fetch-json'
|
|
import { useOnlineUsersContext } from '@/features/ide-react/context/online-users-context'
|
|
import { useEditorContext } from '@/shared/context/editor-context'
|
|
import useSocketListener from '@/features/ide-react/hooks/use-socket-listener'
|
|
import useEventListener from '@/shared/hooks/use-event-listener'
|
|
import { useModalsContext } from '@/features/ide-react/context/modals-context'
|
|
import { usePermissionsContext } from '@/features/ide-react/context/permissions-context'
|
|
import { useTranslation } from 'react-i18next'
|
|
import { IdeEvents } from '@/features/ide-react/create-ide-event-emitter'
|
|
|
|
export type Command = {
|
|
caption: string
|
|
snippet: string
|
|
meta: string
|
|
score: number
|
|
}
|
|
|
|
export type DocumentMetadata = {
|
|
labels: string[]
|
|
packages: Record<string, Command[]>
|
|
packageNames: string[]
|
|
}
|
|
|
|
type DocumentsMetadata = Record<string, DocumentMetadata>
|
|
|
|
type DocMetadataResponse = { docId: string; meta: DocumentMetadata }
|
|
|
|
export const MetadataContext = createContext<
|
|
| {
|
|
commands: Command[]
|
|
labels: Set<string>
|
|
packageNames: Set<string>
|
|
}
|
|
| undefined
|
|
>(undefined)
|
|
|
|
export const MetadataProvider: FC = ({ children }) => {
|
|
const { t } = useTranslation()
|
|
const { eventEmitter, projectId } = useIdeReactContext()
|
|
const { socket } = useConnectionContext()
|
|
const { onlineUsersCount } = useOnlineUsersContext()
|
|
const { permissionsLevel } = useEditorContext()
|
|
const permissions = usePermissionsContext()
|
|
const { currentDocument } = useEditorManagerContext()
|
|
const { showGenericMessageModal } = useModalsContext()
|
|
|
|
const [documents, setDocuments] = useState<DocumentsMetadata>({})
|
|
|
|
const debouncerRef = useRef<Map<string, number>>(new Map()) // DocId => Timeout
|
|
|
|
useEffect(() => {
|
|
const handleEntityDeleted = ({
|
|
detail: [entity],
|
|
}: CustomEvent<IdeEvents['entity:deleted']>) => {
|
|
if (entity.type === 'doc') {
|
|
setDocuments(documents => {
|
|
delete documents[entity.entity._id]
|
|
return { ...documents }
|
|
})
|
|
}
|
|
}
|
|
|
|
eventEmitter.on('entity:deleted', handleEntityDeleted)
|
|
|
|
return () => {
|
|
eventEmitter.off('entity:deleted', handleEntityDeleted)
|
|
}
|
|
}, [eventEmitter])
|
|
|
|
useEffect(() => {
|
|
window.dispatchEvent(
|
|
new CustomEvent('project:metadata', { detail: documents })
|
|
)
|
|
}, [documents])
|
|
|
|
const onBroadcastDocMeta = useCallback((data: DocMetadataResponse) => {
|
|
const { docId, meta } = data
|
|
if (docId != null && meta != null) {
|
|
setDocuments(documents => ({ ...documents, [docId]: meta }))
|
|
}
|
|
}, [])
|
|
|
|
const loadProjectMetaFromServer = useCallback(() => {
|
|
getJSON(`/project/${projectId}/metadata`).then(
|
|
(response: { projectMeta: DocumentsMetadata }) => {
|
|
const { projectMeta } = response
|
|
if (projectMeta) {
|
|
setDocuments(projectMeta)
|
|
}
|
|
}
|
|
)
|
|
}, [projectId])
|
|
|
|
const loadDocMetaFromServer = useCallback(
|
|
(docId: string) => {
|
|
// Don't broadcast metadata when there are no other users in the
|
|
// project.
|
|
const broadcast = onlineUsersCount > 0
|
|
postJSON(`/project/${projectId}/doc/${docId}/metadata`, {
|
|
body: {
|
|
broadcast,
|
|
},
|
|
}).then((response: DocMetadataResponse) => {
|
|
if (!broadcast && response) {
|
|
// handle the POST response like a broadcast event when there are no
|
|
// other users in the project.
|
|
onBroadcastDocMeta(response)
|
|
}
|
|
})
|
|
},
|
|
[onBroadcastDocMeta, onlineUsersCount, projectId]
|
|
)
|
|
|
|
const scheduleLoadDocMetaFromServer = useCallback(
|
|
(docId: string) => {
|
|
if (permissionsLevel === 'readOnly') {
|
|
// The POST request is blocked for users without write permission.
|
|
// The user will not be able to consume the metadata for edits anyway.
|
|
return
|
|
}
|
|
// Debounce loading labels with a timeout
|
|
const existingTimeout = debouncerRef.current.get(docId)
|
|
|
|
if (existingTimeout != null) {
|
|
window.clearTimeout(existingTimeout)
|
|
debouncerRef.current.delete(docId)
|
|
}
|
|
|
|
debouncerRef.current.set(
|
|
docId,
|
|
window.setTimeout(() => {
|
|
// TODO: wait for the document to be saved?
|
|
loadDocMetaFromServer(docId)
|
|
debouncerRef.current.delete(docId)
|
|
}, 2000)
|
|
)
|
|
},
|
|
[loadDocMetaFromServer, permissionsLevel]
|
|
)
|
|
|
|
const handleBroadcastDocMeta = useCallback(
|
|
(data: DocMetadataResponse) => {
|
|
onBroadcastDocMeta(data)
|
|
},
|
|
[onBroadcastDocMeta]
|
|
)
|
|
|
|
useSocketListener(socket, 'broadcastDocMeta', handleBroadcastDocMeta)
|
|
|
|
const handleMetadataOutdated = useCallback(() => {
|
|
if (currentDocument) {
|
|
scheduleLoadDocMetaFromServer(currentDocument.doc_id)
|
|
}
|
|
}, [currentDocument, scheduleLoadDocMetaFromServer])
|
|
|
|
useEventListener('editor:metadata-outdated', handleMetadataOutdated)
|
|
|
|
const permissionsRef = useRef(permissions)
|
|
|
|
useEffect(() => {
|
|
permissionsRef.current = permissions
|
|
}, [permissions])
|
|
|
|
useEffect(() => {
|
|
const handleProjectJoined = ({
|
|
detail: [{ project }],
|
|
}: CustomEvent<IdeEvents['project:joined']>) => {
|
|
if (project.deletedByExternalDataSource) {
|
|
showGenericMessageModal(
|
|
t('project_renamed_or_deleted'),
|
|
t('project_renamed_or_deleted_detail')
|
|
)
|
|
}
|
|
window.setTimeout(() => {
|
|
if (permissionsRef.current.write) {
|
|
loadProjectMetaFromServer()
|
|
}
|
|
}, 200)
|
|
}
|
|
|
|
eventEmitter.once('project:joined', handleProjectJoined)
|
|
|
|
return () => {
|
|
eventEmitter.off('project:joined', handleProjectJoined)
|
|
}
|
|
}, [eventEmitter, loadProjectMetaFromServer, showGenericMessageModal, t])
|
|
|
|
const value = useMemo(() => {
|
|
const docs = Object.values(documents)
|
|
|
|
return {
|
|
commands: docs.flatMap(doc => Object.values(doc.packages).flat()),
|
|
labels: new Set(docs.flatMap(doc => doc.labels)),
|
|
packageNames: new Set(docs.flatMap(doc => doc.packageNames)),
|
|
}
|
|
}, [documents])
|
|
|
|
return (
|
|
<MetadataContext.Provider value={value}>
|
|
{children}
|
|
</MetadataContext.Provider>
|
|
)
|
|
}
|
|
|
|
export function useMetadataContext() {
|
|
const context = useContext(MetadataContext)
|
|
|
|
if (!context) {
|
|
throw new Error(
|
|
'useMetadataContext is only available inside MetadataProvider'
|
|
)
|
|
}
|
|
|
|
return context
|
|
}
|