overleaf/services/web/test/frontend/helpers/editor-providers.jsx
Jakob Ackermann 9c5eb9630b Merge pull request #18222 from overleaf/jpa-socket-io-mock
[web] replace socket.io-mock with simple EventEmitter based interface

GitOrigin-RevId: 012e4263367a83e16efea3947f310a2de9a65279
2024-05-09 08:05:14 +00:00

183 lines
5.6 KiB
JavaScript

// Disable prop type checks for test harnesses
/* eslint-disable react/prop-types */
import sinon from 'sinon'
import { get, merge } from 'lodash'
import { SplitTestProvider } from '@/shared/context/split-test-context'
import { IdeAngularProvider } from '@/shared/context/ide-angular-provider'
import { UserProvider } from '@/shared/context/user-context'
import { ProjectProvider } from '@/shared/context/project-context'
import { FileTreeDataProvider } from '@/shared/context/file-tree-data-context'
import { EditorProvider } from '@/shared/context/editor-context'
import { DetachProvider } from '@/shared/context/detach-context'
import { LayoutProvider } from '@/shared/context/layout-context'
import { LocalCompileProvider } from '@/shared/context/local-compile-context'
import { DetachCompileProvider } from '@/shared/context/detach-compile-context'
import { ProjectSettingsProvider } from '@/features/editor-left-menu/context/project-settings-context'
import { FileTreePathProvider } from '@/features/file-tree/contexts/file-tree-path'
import { UserSettingsProvider } from '@/shared/context/user-settings-context'
import { OutlineProvider } from '@/features/ide-react/context/outline-context'
import { SocketIOMock } from '@/ide/connection/SocketIoShim'
// these constants can be imported in tests instead of
// using magic strings
export const PROJECT_ID = 'project123'
export const PROJECT_NAME = 'project-name'
export const USER_ID = '123abd'
export const USER_EMAIL = 'testuser@example.com'
const defaultUserSettings = {
pdfViewer: 'pdfjs',
fontSize: 12,
fontFamily: 'monaco',
lineHeight: 'normal',
editorTheme: 'textmate',
overallTheme: '',
mode: 'default',
autoComplete: true,
autoPairDelimiters: true,
trackChanges: true,
syntaxValidation: false,
}
export function EditorProviders({
user = { id: USER_ID, email: USER_EMAIL },
projectId = PROJECT_ID,
projectOwner = {
_id: '124abd',
email: 'owner@example.com',
},
rootDocId = '_root_doc_id',
socket = new SocketIOMock(),
isRestrictedTokenMember = false,
clsiServerId = '1234',
scope = {},
features = {
referencesSearch: true,
},
permissionsLevel = 'owner',
children,
rootFolder = [
{
_id: 'root-folder-id',
name: 'rootFolder',
docs: [],
folders: [],
fileRefs: [],
},
],
ui = { view: 'editor', pdfLayout: 'sideBySide', chatOpen: true },
fileTreeManager = {
findEntityById: () => null,
findEntityByPath: () => null,
getEntityPath: () => '',
getRootDocDirname: () => '',
getPreviewByPath: path => ({ url: path, extension: 'png' }),
},
editorManager = {
getCurrentDocId: () => 'foo',
getCurrentDocValue: () => {},
openDoc: sinon.stub(),
},
metadataManager = {
metadata: {
state: {
documents: {},
},
},
},
userSettings = {},
providers = {},
}) {
window.user = user || window.user
window.gitBridgePublicBaseUrl = 'https://git.overleaf.test'
window.project_id = projectId != null ? projectId : window.project_id
window.isRestrictedTokenMember = isRestrictedTokenMember
window.metaAttributesCache.set(
'ol-userSettings',
merge({}, defaultUserSettings, userSettings)
)
const $scope = merge(
{
user: window.user,
project: {
_id: window.project_id,
name: PROJECT_NAME,
owner: projectOwner,
features,
rootDoc_id: rootDocId,
rootFolder,
},
ui,
$watch: (path, callback) => {
callback(get($scope, path))
return () => null
},
$on: sinon.stub(),
$applyAsync: sinon.stub(),
permissionsLevel,
},
scope
)
window._ide = {
$scope,
socket,
clsiServerId,
editorManager,
fileTreeManager,
metadataManager,
}
// Add details for useUserContext
window.metaAttributesCache.set('ol-user', { ...user, features })
const Providers = {
DetachCompileProvider,
DetachProvider,
EditorProvider,
FileTreeDataProvider,
FileTreePathProvider,
IdeAngularProvider,
LayoutProvider,
LocalCompileProvider,
OutlineProvider,
ProjectProvider,
ProjectSettingsProvider,
SplitTestProvider,
UserProvider,
UserSettingsProvider,
...providers,
}
return (
<Providers.SplitTestProvider>
<Providers.IdeAngularProvider ide={window._ide}>
<Providers.UserProvider>
<Providers.UserSettingsProvider>
<Providers.ProjectProvider>
<Providers.FileTreeDataProvider>
<Providers.FileTreePathProvider>
<Providers.DetachProvider>
<Providers.EditorProvider>
<Providers.ProjectSettingsProvider>
<Providers.LayoutProvider>
<Providers.LocalCompileProvider>
<Providers.DetachCompileProvider>
<Providers.OutlineProvider>
{children}
</Providers.OutlineProvider>
</Providers.DetachCompileProvider>
</Providers.LocalCompileProvider>
</Providers.LayoutProvider>
</Providers.ProjectSettingsProvider>
</Providers.EditorProvider>
</Providers.DetachProvider>
</Providers.FileTreePathProvider>
</Providers.FileTreeDataProvider>
</Providers.ProjectProvider>
</Providers.UserSettingsProvider>
</Providers.UserProvider>
</Providers.IdeAngularProvider>
</Providers.SplitTestProvider>
)
}