Merge pull request #2118 from overleaf/cmg-convert-array-archiving

New archiving endpoint to convert to array

GitOrigin-RevId: a6f5d3e2363afcbcd5719731261b85a0ae7a1e25

services/web/app/src/Features/Project/ProjectController.js

@@ -143,10 +143,40 @@ const ProjectController = {
         cb
       )
     } else {
-      ProjectDeleter.archiveProject(projectId, cb)
+      ProjectDeleter.legacyArchiveProject(projectId, cb)
     }
   },
 
+  archiveProject(req, res, next) {
+    const projectId = req.params.Project_id
+    logger.log({ projectId }, 'received request to archive project')
+
+    const user = AuthenticationController.getSessionUser(req)
+
+    ProjectDeleter.archiveProject(projectId, user._id, function(err) {
+      if (err != null) {
+        return next(err)
+      } else {
+        return res.sendStatus(200)
+      }
+    })
+  },
+
+  unarchiveProject(req, res, next) {
+    const projectId = req.params.Project_id
+    logger.log({ projectId }, 'received request to unarchive project')
+
+    const user = AuthenticationController.getSessionUser(req)
+
+    ProjectDeleter.unarchiveProject(projectId, user._id, function(err) {
+      if (err != null) {
+        return next(err)
+      } else {
+        return res.sendStatus(200)
+      }
+    })
+  },
+
   expireDeletedProjectsAfterDuration(req, res) {
     logger.log(
       'received request to look for old deleted projects and expire them'

services/web/app/src/Features/Project/ProjectDeleter.js

@@ -20,6 +20,7 @@ const logger = require('logger-sharelatex')
 const DocumentUpdaterHandler = require('../DocumentUpdater/DocumentUpdaterHandler')
 const TagsHandler = require('../Tags/TagsHandler')
 const async = require('async')
+const ProjectHelper = require('./ProjectHelper')
 const ProjectDetailsHandler = require('./ProjectDetailsHandler')
 const CollaboratorsHandler = require('../Collaborators/CollaboratorsHandler')
 const DocstoreManager = require('../Docstore/DocstoreManager')
@@ -122,7 +123,7 @@ const ProjectDeleter = {
     )
   },
 
-  archiveProject(project_id, callback) {
+  legacyArchiveProject(project_id, callback) {
     if (callback == null) {
       callback = function(error) {}
     }
@@ -158,6 +159,49 @@ const ProjectDeleter = {
 
 // Async methods
 
+async function archiveProject(project_id, userId) {
+  logger.log({ project_id }, 'archiving project from user request')
+
+  try {
+    let project = await Project.findOne({ _id: project_id }).exec()
+    if (!project) {
+      throw new Errors.NotFoundError('project not found')
+    }
+    const archived = ProjectHelper.calculateArchivedArray(
+      project,
+      userId,
+      'ARCHIVE'
+    )
+
+    await Project.update({ _id: project_id }, { $set: { archived: archived } })
+  } catch (err) {
+    logger.warn({ err }, 'problem archiving project')
+    throw err
+  }
+}
+
+async function unarchiveProject(project_id, userId) {
+  logger.log({ project_id }, 'unarchiving project from user request')
+
+  try {
+    let project = await Project.findOne({ _id: project_id }).exec()
+    if (!project) {
+      throw new Errors.NotFoundError('project not found')
+    }
+
+    const archived = ProjectHelper.calculateArchivedArray(
+      project,
+      userId,
+      'UNARCHIVE'
+    )
+
+    await Project.update({ _id: project_id }, { $set: { archived: archived } })
+  } catch (err) {
+    logger.warn({ err }, 'problem unarchiving project')
+    throw err
+  }
+}
+
 async function deleteProject(project_id, options = {}) {
   logger.log({ project_id }, 'deleting project')
 
@@ -304,6 +348,8 @@ async function expireDeletedProject(projectId) {
 // Exported class
 
 const promises = {
+  archiveProject: archiveProject,
+  unarchiveProject: unarchiveProject,
   deleteProject: deleteProject,
   undeleteProject: undeleteProject,
   expireDeletedProject: expireDeletedProject,
@@ -311,6 +357,8 @@ const promises = {
 }
 
 ProjectDeleter.promises = promises
+ProjectDeleter.archiveProject = callbackify(archiveProject)
+ProjectDeleter.unarchiveProject = callbackify(unarchiveProject)
 ProjectDeleter.deleteProject = callbackify(deleteProject)
 ProjectDeleter.undeleteProject = callbackify(undeleteProject)
 ProjectDeleter.expireDeletedProject = callbackify(expireDeletedProject)

services/web/app/src/Features/Project/ProjectHelper.js

@@ -18,6 +18,7 @@ const ENGINE_TO_COMPILER_MAP = {
   lualatex: 'lualatex'
 }
 const { ObjectId } = require('../../infrastructure/mongojs')
+const _ = require('lodash')
 const { promisify } = require('util')
 
 const ProjectHelper = {
@@ -52,6 +53,40 @@ const ProjectHelper = {
     )
   },
 
+  allCollaborators(project) {
+    return _.unionWith(
+      [project.owner_ref],
+      project.collaberator_refs,
+      project.readOnly_refs,
+      project.tokenAccessReadAndWrite_refs,
+      project.tokenAccessReadOnly_refs,
+      ProjectHelper._objectIdEquals
+    )
+  },
+
+  calculateArchivedArray(project, userId, action) {
+    let archived = project.archived
+    userId = ObjectId(userId)
+
+    if (archived === true) {
+      archived = ProjectHelper.allCollaborators(project)
+    } else if (!archived) {
+      archived = []
+    }
+
+    if (action === 'ARCHIVE') {
+      archived = _.unionWith(archived, [userId], ProjectHelper._objectIdEquals)
+    } else if (action === 'UNARCHIVE') {
+      archived = archived.filter(
+        id => !ProjectHelper._objectIdEquals(id, userId)
+      )
+    } else {
+      throw new Error('Unrecognised action')
+    }
+
+    return archived
+  },
+
   ensureNameIsUnique(nameList, name, suffixes, maxLength, callback) {
     // create a set of all project names
     if (suffixes == null) {
@@ -92,6 +127,11 @@ const ProjectHelper = {
     }
   },
 
+  _objectIdEquals(firstVal, secondVal) {
+    // For use as a comparator for unionWith
+    return firstVal.toString() === secondVal.toString()
+  },
+
   _addSuffixToProjectName(name, suffix, maxLength) {
     // append the suffix and truncate the project title if needed
     if (suffix == null) {

services/web/app/src/models/Project.js

@@ -61,7 +61,7 @@ const ProjectSchema = new Schema({
   spellCheckLanguage: { type: String, default: 'en' },
   deletedByExternalDataSource: { type: Boolean, default: false },
   description: { type: String, default: '' },
-  archived: Schema.Types.Mixed,
+  archived: { type: Schema.Types.Mixed },
   trashed: [{ type: ObjectId, ref: 'User' }],
   deletedDocs: [DeletedDocSchema],
   deletedFiles: [DeletedFileSchema],

services/web/app/src/router.js

@@ -449,12 +449,21 @@ function initialize(webRouter, privateApiRouter, publicApiRouter) {
     CompileController.wordCount
   )
 
+  webRouter.post(
+    '/Project/:Project_id/archive',
+    AuthorizationMiddleware.ensureUserCanReadProject,
+    ProjectController.archiveProject
+  )
+  webRouter.delete(
+    '/Project/:Project_id/archive',
+    AuthorizationMiddleware.ensureUserCanReadProject,
+    ProjectController.unarchiveProject
+  )
   webRouter.post(
     '/project/:project_id/trash',
     AuthorizationMiddleware.ensureUserCanReadProject,
     ProjectController.trashProject
   )
-
   webRouter.delete(
     '/project/:project_id/trash',
     AuthorizationMiddleware.ensureUserCanReadProject,
@@ -467,6 +476,7 @@ function initialize(webRouter, privateApiRouter, publicApiRouter) {
     AuthorizationMiddleware.ensureUserCanAdminProject,
     ProjectController.deleteProject
   )
+
   webRouter.post(
     '/Project/:Project_id/restore',
     AuthenticationController.requireLogin(),

services/web/test/unit/src/Project/ProjectControllerTests.js

@@ -38,7 +38,7 @@ describe('ProjectController', function() {
     }
     this.token = 'some-token'
     this.ProjectDeleter = {
-      archiveProject: sinon.stub().callsArg(1),
+      legacyArchiveProject: sinon.stub().callsArg(1),
       deleteProject: sinon.stub().callsArg(2),
       restoreProject: sinon.stub().callsArg(1),
       findArchivedProjects: sinon.stub()
@@ -284,7 +284,7 @@ describe('ProjectController', function() {
   describe('deleteProject', function() {
     it('should tell the project deleter to archive when forever=false', function(done) {
       this.res.sendStatus = code => {
-        this.ProjectDeleter.archiveProject
+        this.ProjectDeleter.legacyArchiveProject
           .calledWith(this.project_id)
           .should.equal(true)
         code.should.equal(200)

services/web/test/unit/src/Project/ProjectDeleterTests.js

@@ -18,10 +18,22 @@ describe('ProjectDeleter', function() {
       _id: this.project_id,
       lastUpdated: new Date(),
       rootFolder: [],
-      collaberator_refs: ['collab1', 'collab2'],
-      readOnly_refs: ['readOnly1', 'readOnly2'],
-      tokenAccessReadAndWrite_refs: ['tokenCollab1', 'tokenCollab2'],
-      tokenAccessReadOnly_refs: ['tokenReadOnly1', 'tokenReadOnly2'],
+      collaberator_refs: [
+        ObjectId('5b895d372f4189011c2f5afc'),
+        ObjectId('5b8d40073ead20011caca726')
+      ],
+      readOnly_refs: [
+        ObjectId('5b8d4602b2f786011c4fb244'),
+        ObjectId('5b8d4a57c1cd2b011c39161c')
+      ],
+      tokenAccessReadAndWrite_refs: [
+        ObjectId('5b8d5663a26df3035ea0d5a1'),
+        ObjectId('5b8e8676373c14011c2cad3c')
+      ],
+      tokenAccessReadOnly_refs: [
+        ObjectId('5b9b801b5dd22c011ba5d9b3'),
+        ObjectId('5bc5adae1cad8d011fd4060a')
+      ],
       owner_ref: ObjectId('588aaaaaaaaaaaaaaaaaaaaa'),
       tokens: {
         readOnly: 'wombat',
@@ -111,6 +123,10 @@ describe('ProjectDeleter', function() {
       }
     }
 
+    this.ProjectHelper = {
+      calculateArchivedArray: sinon.stub()
+    }
+
     this.db = {
       projects: {
         insert: sinon.stub().yields()
@@ -128,6 +144,7 @@ describe('ProjectDeleter', function() {
       requires: {
         '../Editor/EditorController': this.editorController,
         '../../models/Project': { Project: Project },
+        './ProjectHelper': this.ProjectHelper,
         '../../models/DeletedProject': { DeletedProject: DeletedProject },
         '../DocumentUpdater/DocumentUpdaterHandler': this
           .documentUpdaterHandler,
@@ -409,7 +426,7 @@ describe('ProjectDeleter', function() {
     })
   })
 
-  describe('archiveProject', function() {
+  describe('legacyArchiveProject', function() {
     beforeEach(function() {
       this.ProjectMock.expects('update')
         .withArgs(
@@ -424,13 +441,61 @@ describe('ProjectDeleter', function() {
     })
 
     it('should update the project', function(done) {
-      this.ProjectDeleter.archiveProject(this.project_id, () => {
+      this.ProjectDeleter.legacyArchiveProject(this.project_id, () => {
         this.ProjectMock.verify()
         done()
       })
     })
   })
 
+  describe('archiveProject', function() {
+    beforeEach(function() {
+      let archived = [ObjectId(this.user._id)]
+      this.ProjectHelper.calculateArchivedArray.returns(archived)
+
+      this.ProjectMock.expects('findOne')
+        .withArgs({ _id: this.project_id })
+        .chain('exec')
+        .resolves(this.project)
+
+      this.ProjectMock.expects('update')
+        .withArgs({ _id: this.project_id }, { $set: { archived: archived } })
+        .resolves()
+    })
+
+    it('should update the project', async function() {
+      await this.ProjectDeleter.promises.archiveProject(
+        this.project_id,
+        this.user._id
+      )
+      this.ProjectMock.verify()
+    })
+  })
+
+  describe('unarchiveProject', function() {
+    beforeEach(function() {
+      let archived = [ObjectId(this.user._id)]
+      this.ProjectHelper.calculateArchivedArray.returns(archived)
+
+      this.ProjectMock.expects('findOne')
+        .withArgs({ _id: this.project_id })
+        .chain('exec')
+        .resolves(this.project)
+
+      this.ProjectMock.expects('update')
+        .withArgs({ _id: this.project_id }, { $set: { archived: archived } })
+        .resolves()
+    })
+
+    it('should update the project', async function() {
+      await this.ProjectDeleter.promises.unarchiveProject(
+        this.project_id,
+        this.user._id
+      )
+      this.ProjectMock.verify()
+    })
+  })
+
   describe('restoreProject', function() {
     beforeEach(function() {
       this.ProjectMock.expects('update')

services/web/test/unit/src/Project/ProjectHelperTests.js

@@ -107,6 +107,130 @@ describe('ProjectHelper', function() {
     })
   })
 
+  describe('calculateArchivedArray', function() {
+    describe('project.archived being an array', function() {
+      it('returns an array adding the current user id when archiving', function() {
+        const project = { archived: [] }
+        const result = this.ProjectHelper.calculateArchivedArray(
+          project,
+          ObjectId('5c922599cdb09e014aa7d499'),
+          'ARCHIVE'
+        )
+        expect(result).to.deep.equal([ObjectId('5c922599cdb09e014aa7d499')])
+      })
+
+      it('returns an array without the current user id when unarchiving', function() {
+        const project = { archived: [ObjectId('5c922599cdb09e014aa7d499')] }
+        const result = this.ProjectHelper.calculateArchivedArray(
+          project,
+          ObjectId('5c922599cdb09e014aa7d499'),
+          'UNARCHIVE'
+        )
+        expect(result).to.deep.equal([])
+      })
+    })
+
+    describe('project.archived being a boolean and being true', function() {
+      it('returns an array of all associated user ids when archiving', function() {
+        const project = {
+          archived: true,
+          owner_ref: this.user._id,
+          collaberator_refs: [
+            ObjectId('4f2cfb341eb5855a5b000f8b'),
+            ObjectId('5c45f3bd425ead01488675aa')
+          ],
+          readOnly_refs: [ObjectId('5c92243fcdb09e014aa7d487')],
+          tokenAccessReadAndWrite_refs: [ObjectId('5c922599cdb09e014aa7d499')],
+          tokenAccessReadOnly_refs: []
+        }
+
+        const result = this.ProjectHelper.calculateArchivedArray(
+          project,
+          this.user._id,
+          'ARCHIVE'
+        )
+        expect(result).to.deep.equal([
+          this.user._id,
+          ObjectId('4f2cfb341eb5855a5b000f8b'),
+          ObjectId('5c45f3bd425ead01488675aa'),
+          ObjectId('5c92243fcdb09e014aa7d487'),
+          ObjectId('5c922599cdb09e014aa7d499')
+        ])
+      })
+
+      it('returns an array of all associated users without the current user id when unarchived', function() {
+        const project = {
+          archived: true,
+          owner_ref: this.user._id,
+          collaberator_refs: [
+            ObjectId('4f2cfb341eb5855a5b000f8b'),
+            ObjectId('5c45f3bd425ead01488675aa'),
+            ObjectId('5c922599cdb09e014aa7d499')
+          ],
+          readOnly_refs: [ObjectId('5c92243fcdb09e014aa7d487')],
+          tokenAccessReadAndWrite_refs: [ObjectId('5c922599cdb09e014aa7d499')],
+          tokenAccessReadOnly_refs: []
+        }
+
+        const result = this.ProjectHelper.calculateArchivedArray(
+          project,
+          this.user._id,
+          'UNARCHIVE'
+        )
+        expect(result).to.deep.equal([
+          ObjectId('4f2cfb341eb5855a5b000f8b'),
+          ObjectId('5c45f3bd425ead01488675aa'),
+          ObjectId('5c922599cdb09e014aa7d499'),
+          ObjectId('5c92243fcdb09e014aa7d487')
+        ])
+      })
+    })
+
+    describe('project.archived being a boolean and being false', function() {
+      it('returns an array adding the current user id when archiving', function() {
+        const project = { archived: false }
+        const result = this.ProjectHelper.calculateArchivedArray(
+          project,
+          ObjectId('5c922599cdb09e014aa7d499'),
+          'ARCHIVE'
+        )
+        expect(result).to.deep.equal([ObjectId('5c922599cdb09e014aa7d499')])
+      })
+
+      it('returns an empty array when unarchiving', function() {
+        const project = { archived: false }
+        const result = this.ProjectHelper.calculateArchivedArray(
+          project,
+          ObjectId('5c922599cdb09e014aa7d499'),
+          'UNARCHIVE'
+        )
+        expect(result).to.deep.equal([])
+      })
+    })
+
+    describe('project.archived not being set', function() {
+      it('returns an array adding the current user id when archiving', function() {
+        const project = { archived: undefined }
+        const result = this.ProjectHelper.calculateArchivedArray(
+          project,
+          ObjectId('5c922599cdb09e014aa7d499'),
+          'ARCHIVE'
+        )
+        expect(result).to.deep.equal([ObjectId('5c922599cdb09e014aa7d499')])
+      })
+
+      it('returns an empty array when unarchiving', function() {
+        const project = { archived: undefined }
+        const result = this.ProjectHelper.calculateArchivedArray(
+          project,
+          ObjectId('5c922599cdb09e014aa7d499'),
+          'UNARCHIVE'
+        )
+        expect(result).to.deep.equal([])
+      })
+    })
+  })
+
   describe('compilerFromV1Engine', function() {
     it('returns the correct engine for latex_dvipdf', function() {
       return expect(