github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2025-04-06 08:41:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #3477 from overleaf/jpa-harden-switching-docs

Browse source 
[frontend] harden the process of switching between docs

GitOrigin-RevId: f3540782f0c45671330ca7324d9d58d9c161bf84
This commit is contained in:
Brian Gough 2020-12-14 09:20:42 +00:00 • committed by Copybot
parent b7e4ece352
commit 2200221820
2 changed files with 50 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
services/web/frontend/js/ide/editor/Document.js
View file

@ -231,9 +231,10 @@ export default (Document = (function() {
)
}
leaveAndCleanUp() {
leaveAndCleanUp(cb) {
return this.leave(error => {
return this._cleanUp()
this._cleanUp()
if (cb) cb(error)
})
}

61
services/web/frontend/js/ide/editor/EditorManager.js
View file

@ -206,28 +206,61 @@ export default (EditorManager = (function() {
}
_openNewDocument(doc, callback) {
// Leave the current document
// - when we are opening a different new one, to avoid race conditions
// between leaving and joining the same document
// - when the current one has pending ops that need flushing, to avoid
// race conditions from cleanup
const current_sharejs_doc = this.$scope.editor.sharejs_doc
const currentDocId = current_sharejs_doc && current_sharejs_doc.doc_id
const hasBufferedOps =
current_sharejs_doc && current_sharejs_doc.hasBufferedOps()
const changingDoc = current_sharejs_doc && currentDocId !== doc.id
if (changingDoc || hasBufferedOps) {
sl_console.log('[_openNewDocument] Leaving existing open doc...')
// Do not trigger any UI changes from remote operations
this._unbindFromDocumentEvents(current_sharejs_doc)
// Teardown the Document -> ShareJsDoc -> sharejs doc
// By the time this completes, the Document instance is no longer
// registered in Document.openDocs and _doOpenNewDocument can start
// from scratch -- read: no corrupted internal state.
const editorOpenDocEpoch = ++this.editorOpenDocEpoch
current_sharejs_doc.leaveAndCleanUp(error => {
if (error) {
sl_console.log(
`[_openNewDocument] error leaving doc ${currentDocId}`,
error
)
return callback(error)
}
if (this.editorOpenDocEpoch !== editorOpenDocEpoch) {
sl_console.log(
`[openNewDocument] editorOpenDocEpoch mismatch ${
this.editorOpenDocEpoch
} vs ${editorOpenDocEpoch}`
)
return callback(new Error('another document was loaded'))
}
this._doOpenNewDocument(doc, callback)
})
} else {
this._doOpenNewDocument(doc, callback)
}
}
_doOpenNewDocument(doc, callback) {
if (callback == null) {
callback = function(error, sharejs_doc) {}
}
sl_console.log('[_openNewDocument] Opening...')
const current_sharejs_doc = this.$scope.editor.sharejs_doc
sl_console.log('[_doOpenNewDocument] Opening...')
const new_sharejs_doc = Document.getDocument(this.ide, doc.id)
// Leave the current document only when we are opening a different new
// one, to avoid race conditions between leaving and joining the same
// document.
if (
current_sharejs_doc != null &&
current_sharejs_doc !== new_sharejs_doc
) {
sl_console.log('[_openNewDocument] Leaving existing open doc...')
current_sharejs_doc.leaveAndCleanUp()
this._unbindFromDocumentEvents(current_sharejs_doc)
}
const editorOpenDocEpoch = ++this.editorOpenDocEpoch
return new_sharejs_doc.join(error => {
if (error != null) {
sl_console.log(
`[_openNewDocument] error joining doc ${doc.id}`,
`[_doOpenNewDocument] error joining doc ${doc.id}`,
error
)
return callback(error)