editor-providers.tsx 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605
  1. // Disable prop type checks for test harnesses
  2. /* eslint-disable react/prop-types */
  3. import { merge } from 'lodash'
  4. import { SocketIOMock } from '@/ide/connection/SocketIoShim'
  5. import { IdeContext } from '@/shared/context/ide-context'
  6. import React, {
  7. useCallback,
  8. useEffect,
  9. useState,
  10. useMemo,
  11. type FC,
  12. type PropsWithChildren,
  13. } from 'react'
  14. import { IdeReactContext } from '@/features/ide-react/context/ide-react-context'
  15. import { IdeEventEmitter } from '@/features/ide-react/create-ide-event-emitter'
  16. import { ReactScopeValueStore } from '@/features/ide-react/scope-value-store/react-scope-value-store'
  17. import { ReactScopeEventEmitter } from '@/features/ide-react/scope-event-emitter/react-scope-event-emitter'
  18. import { ConnectionContext } from '@/features/ide-react/context/connection-context'
  19. import {
  20. EditorOpenDocContext,
  21. type EditorOpenDocContextState,
  22. } from '@/features/ide-react/context/editor-open-doc-context'
  23. import { ProjectContext } from '@/shared/context/project-context'
  24. import { ReactContextRoot } from '@/features/ide-react/context/react-context-root'
  25. import useEventListener from '@/shared/hooks/use-event-listener'
  26. import useDetachLayout from '@/shared/hooks/use-detach-layout'
  27. import useExposedState from '@/shared/hooks/use-exposed-state'
  28. import { ProjectSnapshot } from '@/infrastructure/project-snapshot'
  29. import {
  30. EditorPropertiesContext,
  31. EditorPropertiesContextValue,
  32. } from '@/features/ide-react/context/editor-properties-context'
  33. import {
  34. type IdeLayout,
  35. type IdeView,
  36. LayoutContext,
  37. type LayoutContextValue,
  38. } from '@/shared/context/layout-context'
  39. import type { Socket } from '@/features/ide-react/connection/types/socket'
  40. import type { PermissionsLevel } from '@/features/ide-react/types/permissions'
  41. import type { Folder } from '../../../types/folder'
  42. import type { SocketDebuggingInfo } from '@/features/ide-react/connection/types/connection-state'
  43. import type { DocumentContainer } from '@/features/ide-react/editor/document-container'
  44. import {
  45. ProjectMetadata,
  46. ProjectUpdate,
  47. } from '@/shared/context/types/project-metadata'
  48. import { UserId } from '../../../types/user'
  49. import { ProjectCompiler } from '../../../types/project-settings'
  50. import { ReferencesContext } from '@/features/ide-react/context/references-context'
  51. // these constants can be imported in tests instead of
  52. // using magic strings
  53. export const PROJECT_ID = 'project123'
  54. export const PROJECT_NAME = 'project-name'
  55. export const USER_ID = '123abd' as UserId
  56. export const USER_EMAIL = 'testuser@example.com'
  57. const defaultUserSettings = {
  58. pdfViewer: 'pdfjs',
  59. fontSize: 12,
  60. fontFamily: 'monaco',
  61. lineHeight: 'normal',
  62. editorTheme: 'textmate',
  63. overallTheme: '',
  64. mode: 'default',
  65. autoComplete: true,
  66. autoPairDelimiters: true,
  67. trackChanges: true,
  68. syntaxValidation: false,
  69. mathPreview: true,
  70. }
  71. export type EditorProvidersProps = {
  72. user?: { id: string; email: string }
  73. projectId?: string
  74. projectName?: string
  75. projectOwner?: ProjectMetadata['owner']
  76. rootDocId?: string
  77. imageName?: string
  78. compiler?: ProjectCompiler
  79. socket?: Socket
  80. isRestrictedTokenMember?: boolean
  81. scope?: Record<string, any>
  82. features?: Record<string, boolean>
  83. projectFeatures?: Record<string, boolean>
  84. permissionsLevel?: PermissionsLevel
  85. children?: React.ReactNode
  86. rootFolder?: Folder[]
  87. layoutContext?: Partial<LayoutContextValue>
  88. userSettings?: Record<string, any>
  89. providers?: Record<string, React.FC<React.PropsWithChildren<any>>>
  90. }
  91. export const projectDefaults: ProjectMetadata = {
  92. _id: PROJECT_ID,
  93. name: PROJECT_NAME,
  94. owner: {
  95. _id: '124abd' as UserId,
  96. email: 'owner@example.com',
  97. first_name: 'Test',
  98. last_name: 'Owner',
  99. privileges: 'owner',
  100. signUpDate: new Date('2025-07-07').toISOString(),
  101. },
  102. features: {
  103. referencesSearch: true,
  104. gitBridge: false,
  105. },
  106. rootDocId: '_root_doc_id',
  107. rootFolder: [
  108. {
  109. _id: 'root-folder-id',
  110. name: 'rootFolder',
  111. docs: [
  112. {
  113. _id: '_root_doc_id',
  114. name: 'main.tex',
  115. },
  116. ],
  117. folders: [],
  118. fileRefs: [],
  119. },
  120. ],
  121. imageName: 'texlive-full:2024.1',
  122. compiler: 'pdflatex' as ProjectCompiler,
  123. members: [],
  124. invites: [],
  125. trackChangesState: {} as Record<UserId | '__guests__', boolean>,
  126. spellCheckLanguage: 'en',
  127. }
  128. /**
  129. * @typedef {import('@/shared/context/layout-context').LayoutContextValue} LayoutContextValue
  130. * @type Partial<LayoutContextValue>
  131. */
  132. const layoutContextDefault = {
  133. view: 'editor',
  134. openFile: null,
  135. chatIsOpen: true, // false in the application, true in tests
  136. reviewPanelOpen: false,
  137. miniReviewPanelVisible: false,
  138. leftMenuShown: false,
  139. projectSearchIsOpen: false,
  140. pdfLayout: 'sideBySide',
  141. loadingStyleSheet: false,
  142. } satisfies Partial<LayoutContextValue>
  143. export function EditorProviders({
  144. user = { id: USER_ID, email: USER_EMAIL },
  145. projectId = projectDefaults._id,
  146. projectName = projectDefaults.name,
  147. projectOwner = projectDefaults.owner,
  148. rootDocId = projectDefaults.rootDocId,
  149. imageName = projectDefaults.imageName,
  150. compiler = projectDefaults.compiler,
  151. socket = new SocketIOMock() as any as Socket,
  152. isRestrictedTokenMember = false,
  153. scope: defaultScope = {},
  154. features = {
  155. referencesSearch: true,
  156. gitBridge: false,
  157. },
  158. projectFeatures = features,
  159. permissionsLevel = 'owner',
  160. children,
  161. rootFolder = projectDefaults.rootFolder,
  162. /** @type {Partial<LayoutContext>} */
  163. layoutContext = layoutContextDefault,
  164. userSettings = {},
  165. providers = {},
  166. }: EditorProvidersProps) {
  167. window.metaAttributesCache.set(
  168. 'ol-gitBridgePublicBaseUrl',
  169. 'https://git.overleaf.test'
  170. )
  171. window.metaAttributesCache.set(
  172. 'ol-isRestrictedTokenMember',
  173. isRestrictedTokenMember
  174. )
  175. window.metaAttributesCache.set(
  176. 'ol-userSettings',
  177. merge({}, defaultUserSettings, userSettings)
  178. )
  179. window.metaAttributesCache.set('ol-capabilities', [
  180. 'chat',
  181. 'dropbox',
  182. 'link-sharing',
  183. ])
  184. const scope = merge(
  185. {
  186. user,
  187. editor: {
  188. sharejs_doc: {
  189. doc_id: 'test-doc',
  190. getSnapshot: () => 'some doc content',
  191. hasBufferedOps: () => false,
  192. on: () => {},
  193. off: () => {},
  194. leaveAndCleanUpPromise: async () => {},
  195. } as any as DocumentContainer,
  196. openDocName: null,
  197. currentDocumentId: null,
  198. wantTrackChanges: false,
  199. },
  200. permissionsLevel,
  201. },
  202. defaultScope
  203. )
  204. const project = {
  205. _id: projectId,
  206. name: projectName,
  207. owner: projectOwner,
  208. features: projectFeatures,
  209. rootDocId,
  210. rootFolder,
  211. imageName,
  212. compiler,
  213. members: [],
  214. invites: [],
  215. trackChangesState: false,
  216. spellCheckLanguage: 'en',
  217. }
  218. // Add details for useUserContext
  219. window.metaAttributesCache.set('ol-user', { ...user, features })
  220. window.metaAttributesCache.set('ol-project_id', projectId)
  221. return (
  222. <ReactContextRoot
  223. providers={{
  224. ConnectionProvider: makeConnectionProvider(socket),
  225. IdeReactProvider: makeIdeReactProvider(scope, socket),
  226. EditorOpenDocProvider: makeEditorOpenDocProvider({
  227. currentDocumentId: scope.editor.currentDocumentId,
  228. openDocName: scope.editor.openDocName,
  229. currentDocument: scope.editor.sharejs_doc,
  230. }),
  231. EditorPropertiesProvider: makeEditorPropertiesProvider({
  232. wantTrackChanges: scope.editor.wantTrackChanges,
  233. }),
  234. LayoutProvider: makeLayoutProvider(layoutContext),
  235. ProjectProvider: makeProjectProvider(project),
  236. ReferencesProvider: makeReferencesProvider(),
  237. ...providers,
  238. }}
  239. >
  240. {children}
  241. </ReactContextRoot>
  242. )
  243. }
  244. const makeReferencesProvider = () => {
  245. const ReferencesProvider: FC<PropsWithChildren> = ({ children }) => {
  246. return (
  247. <ReferencesContext.Provider
  248. value={{
  249. referenceKeys: new Set(),
  250. indexAllReferences: () => Promise.resolve(),
  251. searchLocalReferences() {
  252. return Promise.resolve({
  253. hits: [],
  254. })
  255. },
  256. }}
  257. >
  258. {children}
  259. </ReferencesContext.Provider>
  260. )
  261. }
  262. return ReferencesProvider
  263. }
  264. const makeConnectionProvider = (socket: Socket) => {
  265. const ConnectionProvider: FC<PropsWithChildren> = ({ children }) => {
  266. const [value] = useState(() => ({
  267. socket,
  268. connectionState: {
  269. readyState: WebSocket.OPEN,
  270. forceDisconnected: false,
  271. inactiveDisconnect: false,
  272. reconnectAt: null,
  273. forcedDisconnectDelay: 0,
  274. lastConnectionAttempt: 0,
  275. error: '' as const,
  276. },
  277. isConnected: true,
  278. isStillReconnecting: false,
  279. secondsUntilReconnect: () => 0,
  280. tryReconnectNow: () => {},
  281. registerUserActivity: () => {},
  282. disconnect: () => {},
  283. closeConnection: () => {},
  284. getSocketDebuggingInfo: () => ({}) as SocketDebuggingInfo,
  285. }))
  286. return (
  287. <ConnectionContext.Provider value={value}>
  288. {children}
  289. </ConnectionContext.Provider>
  290. )
  291. }
  292. return ConnectionProvider
  293. }
  294. const makeIdeReactProvider = (
  295. scope: Record<string, unknown>,
  296. socket: Socket
  297. ) => {
  298. const IdeReactProvider: FC<PropsWithChildren> = ({ children }) => {
  299. const [startedFreeTrial, setStartedFreeTrial] = useState(false)
  300. const [ideReactContextValue] = useState(() => ({
  301. projectId: PROJECT_ID,
  302. eventEmitter: new IdeEventEmitter(),
  303. startedFreeTrial,
  304. setStartedFreeTrial,
  305. reportError: () => {},
  306. projectJoined: true,
  307. permissionsLevel: scope.permissionsLevel as PermissionsLevel,
  308. setPermissionsLevel: () => {},
  309. setOutOfSync: () => {},
  310. }))
  311. const [ideContextValue] = useState(() => {
  312. const scopeEventEmitter = new ReactScopeEventEmitter(
  313. new IdeEventEmitter()
  314. )
  315. const unstableStore = new ReactScopeValueStore()
  316. return {
  317. socket,
  318. scopeEventEmitter,
  319. unstableStore,
  320. }
  321. })
  322. useEffect(() => {
  323. window.overleaf = {
  324. ...window.overleaf,
  325. unstable: {
  326. ...window.overleaf?.unstable,
  327. store: ideContextValue.unstableStore,
  328. },
  329. }
  330. }, [ideContextValue.unstableStore])
  331. return (
  332. <IdeReactContext.Provider value={ideReactContextValue}>
  333. <IdeContext.Provider value={ideContextValue}>
  334. {children}
  335. </IdeContext.Provider>
  336. </IdeReactContext.Provider>
  337. )
  338. }
  339. return IdeReactProvider
  340. }
  341. export function makeEditorOpenDocProvider(
  342. initialValues: EditorOpenDocContextState
  343. ) {
  344. const {
  345. currentDocumentId: initialCurrentDocumentId,
  346. openDocName: initialOpenDocName,
  347. currentDocument: initialCurrentDocument,
  348. } = initialValues
  349. const EditorOpenDocProvider: FC<PropsWithChildren> = ({ children }) => {
  350. const [currentDocumentId, setCurrentDocumentId] = useExposedState(
  351. initialCurrentDocumentId,
  352. 'editor.open_doc_id'
  353. )
  354. const [openDocName, setOpenDocName] = useExposedState(
  355. initialOpenDocName,
  356. 'editor.open_doc_name'
  357. )
  358. const [currentDocument, setCurrentDocument] = useState(
  359. initialCurrentDocument
  360. )
  361. const value = {
  362. currentDocumentId,
  363. setCurrentDocumentId,
  364. openDocName,
  365. setOpenDocName,
  366. currentDocument,
  367. setCurrentDocument,
  368. }
  369. return (
  370. <EditorOpenDocContext.Provider value={value}>
  371. {children}
  372. </EditorOpenDocContext.Provider>
  373. )
  374. }
  375. return EditorOpenDocProvider
  376. }
  377. const makeLayoutProvider = (
  378. layoutContextOverrides?: Partial<LayoutContextValue>
  379. ) => {
  380. const layout = {
  381. ...layoutContextDefault,
  382. ...layoutContextOverrides,
  383. }
  384. const LayoutProvider: FC<PropsWithChildren> = ({ children }) => {
  385. const [view, setView] = useState<IdeView | null>(layout.view)
  386. const [openFile, setOpenFile] = useState(layout.openFile)
  387. const [chatIsOpen, setChatIsOpen] = useState(layout.chatIsOpen)
  388. const [reviewPanelOpen, setReviewPanelOpen] = useState(
  389. layout.reviewPanelOpen
  390. )
  391. const [miniReviewPanelVisible, setMiniReviewPanelVisible] = useState(
  392. layout.miniReviewPanelVisible
  393. )
  394. const [leftMenuShown, setLeftMenuShown] = useState(layout.leftMenuShown)
  395. const [projectSearchIsOpen, setProjectSearchIsOpen] = useState(
  396. layout.projectSearchIsOpen
  397. )
  398. const [pdfLayout, setPdfLayout] = useState(layout.pdfLayout)
  399. const [loadingStyleSheet, setLoadingStyleSheet] = useState(
  400. layout.loadingStyleSheet
  401. )
  402. useEventListener(
  403. 'ui.toggle-review-panel',
  404. useCallback(() => {
  405. setReviewPanelOpen(open => !open)
  406. }, [setReviewPanelOpen])
  407. )
  408. const changeLayout = useCallback(
  409. (newLayout: IdeLayout, newView: IdeView = 'editor') => {
  410. setPdfLayout(newLayout)
  411. setView(newLayout === 'sideBySide' ? 'editor' : newView)
  412. },
  413. [setPdfLayout, setView]
  414. )
  415. const restoreView = useCallback(() => {
  416. setView('editor')
  417. }, [])
  418. const {
  419. reattach,
  420. detach,
  421. isLinked: detachIsLinked,
  422. role: detachRole,
  423. } = useDetachLayout()
  424. const pdfPreviewOpen =
  425. pdfLayout === 'sideBySide' || view === 'pdf' || detachRole === 'detacher'
  426. const value = useMemo(
  427. () => ({
  428. reattach,
  429. detach,
  430. detachIsLinked,
  431. detachRole,
  432. changeLayout,
  433. chatIsOpen,
  434. leftMenuShown,
  435. openFile,
  436. pdfLayout,
  437. pdfPreviewOpen,
  438. projectSearchIsOpen,
  439. setProjectSearchIsOpen,
  440. reviewPanelOpen,
  441. miniReviewPanelVisible,
  442. loadingStyleSheet,
  443. setChatIsOpen,
  444. setLeftMenuShown,
  445. setOpenFile,
  446. setPdfLayout,
  447. setReviewPanelOpen,
  448. setMiniReviewPanelVisible,
  449. setLoadingStyleSheet,
  450. setView,
  451. view,
  452. restoreView,
  453. }),
  454. [
  455. reattach,
  456. detach,
  457. detachIsLinked,
  458. detachRole,
  459. changeLayout,
  460. chatIsOpen,
  461. leftMenuShown,
  462. openFile,
  463. pdfLayout,
  464. pdfPreviewOpen,
  465. projectSearchIsOpen,
  466. setProjectSearchIsOpen,
  467. reviewPanelOpen,
  468. miniReviewPanelVisible,
  469. loadingStyleSheet,
  470. setChatIsOpen,
  471. setLeftMenuShown,
  472. setOpenFile,
  473. setPdfLayout,
  474. setReviewPanelOpen,
  475. setMiniReviewPanelVisible,
  476. setLoadingStyleSheet,
  477. setView,
  478. view,
  479. restoreView,
  480. ]
  481. )
  482. return (
  483. <LayoutContext.Provider value={value}>{children}</LayoutContext.Provider>
  484. )
  485. }
  486. return LayoutProvider
  487. }
  488. export function makeEditorPropertiesProvider(
  489. initialValues: Partial<
  490. Pick<
  491. EditorPropertiesContextValue,
  492. 'showVisual' | 'showSymbolPalette' | 'wantTrackChanges'
  493. >
  494. >
  495. ) {
  496. const EditorPropertiesProvider: FC<PropsWithChildren> = ({ children }) => {
  497. const {
  498. showVisual: initialShowVisual,
  499. showSymbolPalette: initialShowSymbolPalette,
  500. wantTrackChanges: initialWantTrackChanges,
  501. } = initialValues
  502. const [showVisual, setShowVisual] = useState(initialShowVisual || false)
  503. const [showSymbolPalette, setShowSymbolPalette] = useState(
  504. initialShowSymbolPalette || false
  505. )
  506. function toggleSymbolPalette() {
  507. setShowSymbolPalette(show => !show)
  508. }
  509. const [opening, setOpening] = useState(true)
  510. const [trackChanges, setTrackChanges] = useState(false)
  511. const [wantTrackChanges, setWantTrackChanges] = useState(
  512. initialWantTrackChanges || false
  513. )
  514. const [errorState, setErrorState] = useState(false)
  515. const value = {
  516. showVisual,
  517. setShowVisual,
  518. showSymbolPalette,
  519. setShowSymbolPalette,
  520. toggleSymbolPalette,
  521. opening,
  522. setOpening,
  523. trackChanges,
  524. setTrackChanges,
  525. wantTrackChanges,
  526. setWantTrackChanges,
  527. errorState,
  528. setErrorState,
  529. }
  530. return (
  531. <EditorPropertiesContext.Provider value={value}>
  532. {children}
  533. </EditorPropertiesContext.Provider>
  534. )
  535. }
  536. return EditorPropertiesProvider
  537. }
  538. export function makeProjectProvider(initialProject: ProjectMetadata) {
  539. const ProjectProvider: FC<PropsWithChildren> = ({ children }) => {
  540. const [project, setProject] = useState(initialProject)
  541. const updateProject = useCallback((projectUpdateData: ProjectUpdate) => {
  542. setProject(projectData =>
  543. Object.assign({}, projectData, projectUpdateData)
  544. )
  545. }, [])
  546. const value = {
  547. projectId: project._id,
  548. project,
  549. joinProject: () => {},
  550. updateProject,
  551. joinedOnce: true,
  552. projectSnapshot: new ProjectSnapshot(project._id),
  553. tags: [],
  554. features: project.features,
  555. name: project.name,
  556. }
  557. return (
  558. <ProjectContext.Provider value={value}>
  559. {children}
  560. </ProjectContext.Provider>
  561. )
  562. }
  563. return ProjectProvider
  564. }