github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-14 20:40:17 -05:00
Code Issues Projects Releases Packages Wiki Activity

Initialise full project history for old projects when project opened (#4687)

Browse source 
* Initialise full project history for old projects when project opened

This begins a second attempt at initialising the full project history in
the background for projects without a full project history id.

The original web-internal#4345 was reverted in web-internal#4353. This
commit reverts the revert, and adds an additional flush of the project
before initialising full project history.

GitOrigin-RevId: ac263dca8cf0d80186fee916a76e5572ec5649d4
This commit is contained in:
Thomas 2021-08-12 15:07:34 +01:00 committed by Copybot
parent 3ace29999b
commit 7517a818b2
6 changed files with 104 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
services/web/app/src/Features/History/HistoryManager.js
View file

@ -8,12 +8,14 @@ module.exports = {
initializeProject: callbackify(initializeProject),
flushProject: callbackify(flushProject),
resyncProject: callbackify(resyncProject),
forceResyncProject: callbackify(forceResyncProject),
deleteProject: callbackify(deleteProject),
injectUserDetails: callbackify(injectUserDetails),
promises: {
initializeProject,
flushProject,
resyncProject,
forceResyncProject,
deleteProject,
injectUserDetails,
},
@ -65,6 +67,18 @@ async function resyncProject(projectId) {
}
}
async function forceResyncProject(projectId) {
try {
await request.post({
url: `${settings.apis.project_history.url}/project/${projectId}/resync?force=true`,
})
} catch (err) {
throw OError.tag(err, 'failed to force resync project history', {
projectId,
})
}
}
async function deleteProject(projectId, historyId) {
try {
const tasks = [

19
services/web/app/src/Features/Project/ProjectController.js
View file

@ -9,6 +9,7 @@ const { ObjectId } = require('mongodb')
const ProjectDeleter = require('./ProjectDeleter')
const ProjectDuplicator = require('./ProjectDuplicator')
const ProjectCreationHandler = require('./ProjectCreationHandler')
const ProjectHistoryHandler = require('./ProjectHistoryHandler')
const EditorController = require('../Editor/EditorController')
const ProjectHelper = require('./ProjectHelper')
const metrics = require('@overleaf/metrics')
@ -680,6 +681,24 @@ const ProjectController = {
activate(cb) {
InactiveProjectManager.reactivateProjectIfRequired(projectId, cb)
},
ensureHistoryExists(cb) {
// enable full project history in background for older projects
if (!Settings.apis.project_history || !Features.hasFeature('saas')) {
return cb()
}
ProjectHistoryHandler.ensureHistoryExistsForProject(
projectId,
err => {
if (err) {
logger.error(
{ err, projectId },
'error ensuring history exists for project'
)
}
cb()
}
)
},
markAsOpened(cb) {
// don't need to wait for this to complete
ProjectUpdateHandler.markAsOpened(projectId, () => {})

18
services/web/app/src/Features/Project/ProjectHistoryHandler.js
View file

@ -19,6 +19,7 @@ const logger = require('logger-sharelatex')
const settings = require('@overleaf/settings')
const HistoryManager = require('../History/HistoryManager')
const ProjectEntityUpdateHandler = require('./ProjectEntityUpdateHandler')
const DocumentUpdaterHandler = require('../DocumentUpdater/DocumentUpdaterHandler')
const { promisifyAll } = require('../../util/promises')
const ProjectHistoryHandler = {
@ -134,11 +135,15 @@ const ProjectHistoryHandler = {
if (history_id != null) {
return callback()
} // history already exists, success
return HistoryManager.flushProject(project_id, function (err) {
if (err != null) {
return callback(err)
}
return HistoryManager.initializeProject(function (err, history) {
if (err != null) {
return callback(err)
}
if (!(history != null ? history.overleaf_id : undefined)) {
if (!history || !history.overleaf_id) {
return callback(new Error('failed to initialize history id'))
}
return ProjectHistoryHandler.setHistoryId(
@ -148,7 +153,13 @@ const ProjectHistoryHandler = {
if (err != null) {
return callback(err)
}
return ProjectEntityUpdateHandler.resyncProjectHistory(
return DocumentUpdaterHandler.flushProjectToMongoAndDelete(
project_id,
function (err) {
if (err != null) {
return callback(err)
}
return HistoryManager.forceResyncProject(
project_id,
function (err) {
if (err != null) {
@ -159,6 +170,9 @@ const ProjectHistoryHandler = {
)
}
)
}
)
})
})
}
)

4
services/web/test/acceptance/src/mocks/MockProjectHistoryApi.js
View file

@ -128,6 +128,10 @@ class MockProjectHistoryApi extends AbstractMockApi {
this.app.post('/project/:projectId/flush', (req, res) => {
res.sendStatus(200)
})
this.app.post('/project/:projectId/resync', (req, res) => {
res.sendStatus(204)
})
}
}

16
services/web/test/unit/src/Project/ProjectControllerTests.js
View file

@ -54,6 +54,9 @@ describe('ProjectController', function () {
.stub()
.callsArgWith(2, null, { _id: this.project_id }),
}
this.ProjectHistoryHandler = {
ensureHistoryExistsForProject: sinon.stub().callsArg(1),
}
this.SubscriptionLocator = { getUsersSubscription: sinon.stub() }
this.LimitationsManager = { hasPaidSubscription: sinon.stub() }
this.TagsHandler = { getAllTags: sinon.stub() }
@ -140,6 +143,7 @@ describe('ProjectController', function () {
'./ProjectDeleter': this.ProjectDeleter,
'./ProjectDuplicator': this.ProjectDuplicator,
'./ProjectCreationHandler': this.ProjectCreationHandler,
'./ProjectHistoryHandler': this.ProjectHistoryHandler,
'../Editor/EditorController': this.EditorController,
'../User/UserController': this.UserController,
'./ProjectHelper': this.ProjectHelper,
@ -1024,6 +1028,18 @@ describe('ProjectController', function () {
this.ProjectController.loadEditor(this.req, this.res)
})
it('should ensureHistoryExistsForProject if saas and project_history enabled', function (done) {
this.Features.hasFeature.withArgs('saas').returns(true)
this.settings.apis.project_history = 'enabled'
this.res.render = (pageName, opts) => {
this.ProjectHistoryHandler.ensureHistoryExistsForProject
.calledWith(this.project_id)
.should.equal(true)
done()
}
this.ProjectController.loadEditor(this.req, this.res)
})
it('should mark project as opened', function (done) {
this.res.render = (pageName, opts) => {
this.ProjectUpdateHandler.markAsOpened

25
services/web/test/unit/src/Project/ProjectHistoryHandlerTests.js
View file

@ -51,6 +51,7 @@ describe('ProjectHistoryHandler', function () {
'./ProjectDetailsHandler': (this.ProjectDetailsHandler = {}),
'../History/HistoryManager': (this.HistoryManager = {}),
'./ProjectEntityUpdateHandler': (this.ProjectEntityUpdateHandler = {}),
'../DocumentUpdater/DocumentUpdaterHandler': (this.DocumentUpdaterHandler = {}),
},
}))
})
@ -62,9 +63,10 @@ describe('ProjectHistoryHandler', function () {
.stub()
.callsArgWith(0, null, { overleaf_id: this.newHistoryId })
this.HistoryManager.flushProject = sinon.stub().callsArg(1)
return (this.ProjectEntityUpdateHandler.resyncProjectHistory = sinon
this.HistoryManager.forceResyncProject = sinon.stub().callsArg(1)
this.DocumentUpdaterHandler.flushProjectToMongoAndDelete = sinon
.stub()
.callsArg(1))
.callsArg(1)
})
describe('when the history does not already exist', function () {
@ -101,14 +103,21 @@ describe('ProjectHistoryHandler', function () {
.should.equal(true)
})
it('should resync the project history', function () {
return this.ProjectEntityUpdateHandler.resyncProjectHistory
it('should trigger a hard resync of the project history', function () {
return this.HistoryManager.forceResyncProject
.calledWith(project_id)
.should.equal(true)
})
it('should flush the project history', function () {
it('should flush the project history (twice)', function () {
this.HistoryManager.flushProject.calledTwice.should.equal(true)
return this.HistoryManager.flushProject
.alwaysCalledWith(project_id)
.should.equal(true)
})
it('should tell docupdater to flush and delete', function () {
return this.DocumentUpdaterHandler.flushProjectToMongoAndDelete
.calledWith(project_id)
.should.equal(true)
})
@ -146,10 +155,8 @@ describe('ProjectHistoryHandler', function () {
return this.ProjectModel.updateOne.called.should.equal(false)
})
it('should not resync the project history', function () {
return this.ProjectEntityUpdateHandler.resyncProjectHistory.called.should.equal(
false
)
it('should not trigger a hard resync of the project history', function () {
return this.HistoryManager.forceResyncProject.called.should.equal(false)
})
it('should not flush the project history', function () {