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

Merge pull request #10739 from overleaf/em-history-mongo-backend

Browse source 
Send a history id from web when creating a project

GitOrigin-RevId: dd1417ae734c76990931885df1864a81a9439da0
This commit is contained in:
Eric Mc Sween 2022-12-06 07:57:39 -05:00 committed by Copybot
parent 2675cab92e
commit 38df974ce1
8 changed files with 65 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -4,7 +4,7 @@ const settings = require('@overleaf/settings')
const OError = require('@overleaf/o-error')
const UserGetter = require('../User/UserGetter')
async function initializeProject() {
async function initializeProject(projectId) {
if (
!(
settings.apis.project_history &&
@ -16,8 +16,10 @@ async function initializeProject() {
const response = await fetch(`${settings.apis.project_history.url}/project`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Accept: 'application/json',
},
body: JSON.stringify({ historyId: projectId.toString() }),
})
if (!response.ok) {
throw new OError('failed to initialize project history', {

23
services/web/app/src/Features/Project/ProjectCreationHandler.js
View file

@ -152,33 +152,32 @@ async function _createBlankProject(
const timer = new metrics.Timer('project-creation')
await ProjectDetailsHandler.promises.validateProjectName(projectName)
if (!attributes.overleaf) {
const historyId = await HistoryManager.promises.initializeProject()
if (historyId != null) {
attributes.overleaf = {
history: { id: historyId },
}
}
}
const rootFolder = new Folder({ name: 'rootFolder' })
attributes.lastUpdatedBy = attributes.owner_ref = new ObjectId(ownerId)
attributes.name = projectName
const project = new Project(attributes)
Object.assign(project, attributes)
if (project.overleaf.history.id == null) {
const historyId = await HistoryManager.promises.initializeProject(
project._id
)
if (historyId != null) {
project.overleaf.history.id = historyId
}
}
// only display full project history when the project has the overleaf history id attribute
// (to allow scripted creation of projects without full project history)
const historyId = _.get(attributes, ['overleaf', 'history', 'id'])
const historyId = project.overleaf.history.id
if (
Features.hasFeature('history-v1') &&
Settings.apis.project_history.displayHistoryForNewProjects &&
historyId
historyId != null
) {
project.overleaf.history.display = true
}
if (Settings.currentImageName) {
// avoid clobbering any imageName already set in attributes (e.g. importedImageName)
if (!project.imageName) {

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

@ -26,8 +26,8 @@ const ProjectHistoryHandler = {
if (callback == null) {
callback = function () {}
}
if (!history_id || typeof history_id !== 'number') {
return callback(new Error('invalid history id'))
if (history_id == null) {
return callback(new Error('missing history id'))
}
// use $exists:false to prevent overwriting any existing history id, atomically
return Project.updateOne(
@ -154,7 +154,9 @@ const ProjectHistoryHandler = {
if (history_id != null) {
return callback()
} // history already exists, success
return HistoryManager.initializeProject(function (err, historyId) {
return HistoryManager.initializeProject(
project_id,
function (err, historyId) {
if (err != null) {
return callback(err)
}
@ -179,7 +181,8 @@ const ProjectHistoryHandler = {
)
}
)
})
}
)
}
)
},

2
services/web/app/src/models/Project.js
View file

@ -88,7 +88,7 @@ const ProjectSchema = new Schema({
token: { type: String },
read_token: { type: String },
history: {
id: { type: Number },
id: { type: Schema.Types.Mixed },
display: { type: Boolean },
upgradedAt: { type: Date },
allowDowngrade: { type: Boolean },

2
services/web/scripts/history/HistoryUpgradeHelper.js
View file

@ -176,7 +176,7 @@ async function doUpgradeForNoneWithoutConversion(project) {
// of a resync request to doc-updater
let historyId = await ProjectHistoryHandler.promises.getHistoryId(projectId)
if (historyId == null) {
historyId = await HistoryManager.promises.initializeProject()
historyId = await HistoryManager.promises.initializeProject(projectId)
if (historyId != null) {
await ProjectHistoryHandler.promises.setHistoryId(projectId, historyId)
}

2
services/web/scripts/history/upgrade_none_without_conversion_if_no_sl_history.js
View file

@ -121,7 +121,7 @@ async function doUpgradeForNoneWithoutConversion(project) {
projectId
)
if (historyId == null) {
historyId = await HistoryManager.promises.initializeProject()
historyId = await HistoryManager.promises.initializeProject(projectId)
if (historyId != null) {
await ProjectHistoryHandler.promises.setHistoryId(
projectId,

25
services/web/test/unit/src/History/HistoryManagerTests.js
View file

@ -8,6 +8,7 @@ const MODULE_PATH = '../../../../app/src/Features/History/HistoryManager'
describe('HistoryManager', function () {
beforeEach(function () {
this.user_id = 'user-id-123'
this.historyId = ObjectId().toString()
this.AuthenticationController = {
getLoggedInUserId: sinon.stub().returns(this.user_id),
}
@ -61,9 +62,10 @@ describe('HistoryManager', function () {
describe('project history returns a successful response', function () {
beforeEach(async function () {
this.overleaf_id = 1234
this.response.json.resolves({ project: { id: this.overleaf_id } })
this.result = await this.HistoryManager.promises.initializeProject()
this.response.json.resolves({ project: { id: this.historyId } })
this.result = await this.HistoryManager.promises.initializeProject(
this.historyId
)
})
it('should call the project history api', function () {
@ -74,23 +76,25 @@ describe('HistoryManager', function () {
})
it('should return the overleaf id', function () {
expect(this.result).to.deep.equal(this.overleaf_id)
expect(this.result).to.equal(this.historyId)
})
})
describe('project history returns a response without the project id', function () {
it('should throw an error', async function () {
this.response.json.resolves({ project: {} })
await expect(this.HistoryManager.promises.initializeProject()).to.be
.rejected
await expect(
this.HistoryManager.promises.initializeProject(this.historyId)
).to.be.rejected
})
})
describe('project history errors', function () {
it('should propagate the error', async function () {
this.fetch.rejects(new Error('problem connecting'))
await expect(this.HistoryManager.promises.initializeProject()).to.be
.rejected
await expect(
this.HistoryManager.promises.initializeProject(this.historyId)
).to.be.rejected
})
})
})
@ -98,8 +102,9 @@ describe('HistoryManager', function () {
describe('with project history disabled', function () {
it('should return without errors', async function () {
this.settings.apis.project_history.initializeHistoryForNewProjects = false
await expect(this.HistoryManager.promises.initializeProject()).to.be
.fulfilled
await expect(
this.HistoryManager.promises.initializeProject(this.historyId)
).to.be.fulfilled
})
})
})

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

@ -39,6 +39,7 @@ describe('ProjectHistoryHandler', function () {
return Project
})()
this.project = new this.ProjectModel()
this.historyId = this.project._id.toString()
this.callback = sinon.stub()
@ -57,10 +58,9 @@ describe('ProjectHistoryHandler', function () {
describe('starting history for an existing project', function () {
beforeEach(function () {
this.newHistoryId = 123456789
this.HistoryManager.initializeProject = sinon
.stub()
.callsArgWith(0, null, this.newHistoryId)
.yields(null, this.historyId)
this.HistoryManager.flushProject = sinon.stub().callsArg(1)
return (this.ProjectEntityUpdateHandler.resyncProjectHistory = sinon
.stub()
@ -96,7 +96,7 @@ describe('ProjectHistoryHandler', function () {
return this.ProjectModel.updateOne
.calledWith(
{ _id: project_id, 'overleaf.history.id': { $exists: false } },
{ 'overleaf.history.id': this.newHistoryId }
{ 'overleaf.history.id': this.historyId }
)
.should.equal(true)
})