overleaf/services/web/frontend/js/features/ide-react/editor/open-documents.ts
Alf Eaton 731f071a4e Call detachDoc when cleaning up a doc (#16262)
GitOrigin-RevId: a7479e3685e552c2c3b73ed18a333d647f228c3e
2023-12-18 09:04:22 +00:00

98 lines
3 KiB
TypeScript

// Migrated from static methods of Document in Document.js
import { Document } from '@/features/ide-react/editor/document'
import { debugConsole } from '@/utils/debugging'
import { Socket } from '@/features/ide-react/connection/types/socket'
import { IdeEventEmitter } from '@/features/ide-react/create-ide-event-emitter'
import { EventLog } from '@/features/ide-react/editor/event-log'
import EditorWatchdogManager from '@/features/ide-react/connection/editor-watchdog-manager'
export class OpenDocuments {
private openDocs = new Map<string, Document>()
// eslint-disable-next-line no-useless-constructor
constructor(
private readonly socket: Socket,
private readonly globalEditorWatchdogManager: EditorWatchdogManager,
private readonly events: IdeEventEmitter,
private readonly eventLog: EventLog
) {}
getDocument(docId: string) {
// Try to clean up existing docs before reopening them. If the doc has no
// buffered ops then it will be deleted by _cleanup() and a new instance
// of the document created below. This prevents us trying to follow the
// joinDoc:existing code path on an existing doc that doesn't have any
// local changes and getting an error if its version is too old.
if (this.openDocs.has(docId)) {
debugConsole.log(
`[getDocument] Cleaning up existing document instance for ${docId}`
)
this.openDocs.get(docId)?.cleanUp()
}
if (!this.openDocs.has(docId)) {
debugConsole.log(
`[getDocument] Creating new document instance for ${docId}`
)
this.createDoc(docId)
} else {
debugConsole.log(
`[getDocument] Returning existing document instance for ${docId}`
)
}
return this.openDocs.get(docId)
}
private createDoc(docId: string) {
const doc = new Document(
docId,
this.socket,
this.globalEditorWatchdogManager,
this.events,
this.eventLog,
this.detachDoc.bind(this)
)
this.openDocs.set(docId, doc)
}
detachDoc(docId: string, doc: Document) {
if (this.openDocs.get(docId) === doc) {
debugConsole.log(
`[detach] Removing document with ID (${docId}) from openDocs`
)
this.openDocs.delete(docId)
} else {
// It's possible that this instance has error, and the doc has been reloaded.
// This creates a new instance in Document.openDoc with the same id. We shouldn't
// clear it because it's not this instance.
debugConsole.log(
`[_cleanUp] New instance of (${docId}) created. Not removing`
)
}
}
hasUnsavedChanges() {
for (const doc of this.openDocs.values()) {
if (doc.hasBufferedOps()) {
return true
}
}
return false
}
flushAll() {
for (const doc of this.openDocs.values()) {
doc.flush()
}
}
unsavedDocIds() {
const ids = []
for (const [docId, doc] of this.openDocs) {
if (!doc.pollSavedStatus()) {
ids.push(docId)
}
}
return ids
}
}