DeletionTests.mjs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587
  1. import User from './helpers/User.mjs'
  2. import Subscription from './helpers/Subscription.mjs'
  3. import request from './helpers/request.js'
  4. import async from 'async'
  5. import { expect } from 'chai'
  6. import settings from '@overleaf/settings'
  7. import { db, ObjectId } from '../../../app/src/infrastructure/mongodb.js'
  8. import Features from '../../../app/src/infrastructure/Features.js'
  9. import MockDocstoreApiClass from './mocks/MockDocstoreApi.mjs'
  10. import MockFilestoreApiClass from './mocks/MockFilestoreApi.mjs'
  11. import MockChatApiClass from './mocks/MockChatApi.mjs'
  12. import MockGitBridgeApiClass from './mocks/MockGitBridgeApi.mjs'
  13. import MockHistoryBackupDeletionApiClass from './mocks/MockHistoryBackupDeletionApi.mjs'
  14. let MockDocstoreApi,
  15. MockFilestoreApi,
  16. MockChatApi,
  17. MockGitBridgeApi,
  18. MockHistoryBackupDeletionApi
  19. before(function () {
  20. MockDocstoreApi = MockDocstoreApiClass.instance()
  21. MockFilestoreApi = MockFilestoreApiClass.instance()
  22. MockChatApi = MockChatApiClass.instance()
  23. MockGitBridgeApi = MockGitBridgeApiClass.instance()
  24. MockHistoryBackupDeletionApi = MockHistoryBackupDeletionApiClass.instance()
  25. })
  26. describe('Deleting a user', function () {
  27. beforeEach(function (done) {
  28. async.auto(
  29. {
  30. user: cb => {
  31. const user = new User()
  32. user.ensureUserExists(() => {
  33. cb(null, user)
  34. })
  35. },
  36. login: [
  37. 'user',
  38. (results, cb) => {
  39. results.user.login(cb)
  40. },
  41. ],
  42. subscription: [
  43. 'user',
  44. 'login',
  45. (results, cb) => {
  46. const subscription = new Subscription({
  47. admin_id: results.user._id,
  48. })
  49. subscription.ensureExists(err => {
  50. cb(err, subscription)
  51. })
  52. },
  53. ],
  54. },
  55. (err, results) => {
  56. expect(err).not.to.exist
  57. this.user = results.user
  58. this.subscription = results.subscription
  59. done()
  60. }
  61. )
  62. })
  63. it('Should remove the user from active users', function (done) {
  64. this.user.get((error, user) => {
  65. expect(error).not.to.exist
  66. expect(user).to.exist
  67. this.user.deleteUser(error => {
  68. expect(error).not.to.exist
  69. this.user.get((error, user) => {
  70. expect(error).not.to.exist
  71. expect(user).not.to.exist
  72. done()
  73. })
  74. })
  75. })
  76. })
  77. it('Should create a soft-deleted user', function (done) {
  78. this.user.get((error, user) => {
  79. expect(error).not.to.exist
  80. this.user.deleteUser(error => {
  81. expect(error).not.to.exist
  82. db.deletedUsers.findOne(
  83. { 'user._id': user._id },
  84. (error, deletedUser) => {
  85. expect(error).not.to.exist
  86. expect(deletedUser).to.exist
  87. // it should set the 'deleterData' correctly
  88. expect(deletedUser.deleterData.deleterId.toString()).to.equal(
  89. user._id.toString()
  90. )
  91. expect(deletedUser.deleterData.deletedUserId.toString()).to.equal(
  92. user._id.toString()
  93. )
  94. expect(deletedUser.deleterData.deletedUserReferralId).to.equal(
  95. user.referal_id
  96. )
  97. // it should set the 'user' correctly
  98. expect(deletedUser.user._id.toString()).to.equal(
  99. user._id.toString()
  100. )
  101. expect(deletedUser.user.email).to.equal(user.email)
  102. done()
  103. }
  104. )
  105. })
  106. })
  107. })
  108. it("Should delete the user's projects", function (done) {
  109. this.user.createProject('wombat', (error, projectId) => {
  110. expect(error).not.to.exist
  111. this.user.getProject(projectId, (error, project) => {
  112. expect(error).not.to.exist
  113. expect(project).to.exist
  114. this.user.deleteUser(error => {
  115. expect(error).not.to.exist
  116. this.user.getProject(projectId, (error, project) => {
  117. expect(error).not.to.exist
  118. expect(project).not.to.exist
  119. done()
  120. })
  121. })
  122. })
  123. })
  124. })
  125. describe('when scrubbing the user', function () {
  126. beforeEach(function (done) {
  127. this.user.get((error, user) => {
  128. if (error) {
  129. throw error
  130. }
  131. this.userId = user._id
  132. this.user.deleteUser(done)
  133. })
  134. })
  135. it('Should remove the user data from mongo', function (done) {
  136. db.deletedUsers.findOne(
  137. { 'deleterData.deletedUserId': this.userId },
  138. (error, deletedUser) => {
  139. expect(error).not.to.exist
  140. expect(deletedUser).to.exist
  141. expect(deletedUser.deleterData.deleterIpAddress).to.exist
  142. expect(deletedUser.user).to.exist
  143. request.post(
  144. `/internal/users/${this.userId}/expire`,
  145. {
  146. auth: {
  147. user: settings.apis.web.user,
  148. pass: settings.apis.web.pass,
  149. sendImmediately: true,
  150. },
  151. },
  152. (error, res) => {
  153. expect(error).not.to.exist
  154. expect(res.statusCode).to.equal(204)
  155. db.deletedUsers.findOne(
  156. { 'deleterData.deletedUserId': this.userId },
  157. (error, deletedUser) => {
  158. expect(error).not.to.exist
  159. expect(deletedUser).to.exist
  160. expect(deletedUser.deleterData.deleterIpAddress).not.to.exist
  161. expect(deletedUser.user).not.to.exist
  162. done()
  163. }
  164. )
  165. }
  166. )
  167. }
  168. )
  169. })
  170. })
  171. })
  172. describe('Deleting a project', function () {
  173. beforeEach(function (done) {
  174. this.user = new User()
  175. this.projectName = 'wombat'
  176. this.user.ensureUserExists(() => {
  177. this.user.login(() => {
  178. this.user.createProject(this.projectName, (_e, projectId) => {
  179. this.projectId = projectId
  180. done()
  181. })
  182. })
  183. })
  184. })
  185. it('Should remove the project from active projects', function (done) {
  186. this.user.getProject(this.projectId, (error, project) => {
  187. expect(error).not.to.exist
  188. expect(project).to.exist
  189. this.user.deleteProject(this.projectId, error => {
  190. expect(error).not.to.exist
  191. this.user.getProject(this.projectId, (error, project) => {
  192. expect(error).not.to.exist
  193. expect(project).not.to.exist
  194. done()
  195. })
  196. })
  197. })
  198. })
  199. it('Should create a soft-deleted project', function (done) {
  200. this.user.getProject(this.projectId, (error, project) => {
  201. expect(error).not.to.exist
  202. this.user.get((error, user) => {
  203. expect(error).not.to.exist
  204. this.user.deleteProject(this.projectId, error => {
  205. expect(error).not.to.exist
  206. db.deletedProjects.findOne(
  207. { 'deleterData.deletedProjectId': project._id },
  208. (error, deletedProject) => {
  209. expect(error).not.to.exist
  210. expect(deletedProject).to.exist
  211. // it should set the 'deleterData' correctly
  212. expect(deletedProject.deleterData.deleterId.toString()).to.equal(
  213. user._id.toString()
  214. )
  215. expect(
  216. deletedProject.deleterData.deletedProjectId.toString()
  217. ).to.equal(project._id.toString())
  218. expect(
  219. deletedProject.deleterData.deletedProjectOwnerId.toString()
  220. ).to.equal(user._id.toString())
  221. // it should set the 'user' correctly
  222. expect(deletedProject.project._id.toString()).to.equal(
  223. project._id.toString()
  224. )
  225. expect(deletedProject.project.name).to.equal(this.projectName)
  226. done()
  227. }
  228. )
  229. })
  230. })
  231. })
  232. })
  233. describe('when the project has deleted files', function () {
  234. beforeEach('get rootFolder id', function (done) {
  235. this.user.getProject(this.projectId, (error, project) => {
  236. if (error) return done(error)
  237. this.rootFolder = project.rootFolder[0]._id
  238. done()
  239. })
  240. })
  241. let allFileIds
  242. beforeEach('reset allFileIds', function () {
  243. allFileIds = []
  244. })
  245. function createAndDeleteFile(name) {
  246. let fileId
  247. beforeEach(`create file ${name}`, function (done) {
  248. this.user.uploadExampleFileInProject(
  249. this.projectId,
  250. this.rootFolder,
  251. name,
  252. (error, theFileId) => {
  253. fileId = theFileId
  254. allFileIds.push(theFileId)
  255. done(error)
  256. }
  257. )
  258. })
  259. beforeEach(`delete file ${name}`, function (done) {
  260. this.user.deleteItemInProject(this.projectId, 'file', fileId, done)
  261. })
  262. }
  263. for (const name of ['a.png', 'another.png']) {
  264. createAndDeleteFile(name)
  265. }
  266. it('should have two deleteFiles entries', async function () {
  267. const files = await db.deletedFiles
  268. .find({}, { sort: { _id: 1 } })
  269. .toArray()
  270. expect(files).to.have.length(2)
  271. expect(files.map(file => file._id.toString())).to.deep.equal(allFileIds)
  272. })
  273. describe('When the deleted project is expired', function () {
  274. beforeEach('soft delete the project', function (done) {
  275. this.user.deleteProject(this.projectId, done)
  276. })
  277. beforeEach('hard delete the project', function (done) {
  278. request.post(
  279. `/internal/project/${this.projectId}/expire-deleted-project`,
  280. {
  281. auth: {
  282. user: settings.apis.web.user,
  283. pass: settings.apis.web.pass,
  284. sendImmediately: true,
  285. },
  286. },
  287. (error, res) => {
  288. expect(error).not.to.exist
  289. expect(res.statusCode).to.equal(200)
  290. done()
  291. }
  292. )
  293. })
  294. it('should cleanup the deleteFiles', async function () {
  295. const files = await db.deletedFiles
  296. .find({}, { sort: { _id: 1 } })
  297. .toArray()
  298. expect(files).to.deep.equal([])
  299. })
  300. })
  301. })
  302. describe('When the project has docs', function () {
  303. beforeEach(function (done) {
  304. this.user.getProject(this.projectId, (error, project) => {
  305. if (error) {
  306. throw error
  307. }
  308. this.user.createDocInProject(
  309. this.projectId,
  310. project.rootFolder[0]._id,
  311. 'potato',
  312. (error, docId) => {
  313. if (error) {
  314. throw error
  315. }
  316. this.docId = docId
  317. done()
  318. }
  319. )
  320. MockFilestoreApi.files[this.projectId.toString()] = {
  321. dummyFile: 'wombat',
  322. }
  323. MockChatApi.projects[this.projectId.toString()] = ['message']
  324. if (Features.hasFeature('git-bridge')) {
  325. MockGitBridgeApi.projects[this.projectId.toString()] = {
  326. data: 'some-data',
  327. }
  328. }
  329. })
  330. })
  331. describe('When the deleted project is expired', function () {
  332. beforeEach(function (done) {
  333. this.user.deleteProject(this.projectId, error => {
  334. if (error) {
  335. throw error
  336. }
  337. done()
  338. })
  339. })
  340. it('Should destroy the docs', function (done) {
  341. expect(
  342. MockDocstoreApi.docs[this.projectId.toString()][this.docId.toString()]
  343. ).to.exist
  344. request.post(
  345. `/internal/project/${this.projectId}/expire-deleted-project`,
  346. {
  347. auth: {
  348. user: settings.apis.web.user,
  349. pass: settings.apis.web.pass,
  350. sendImmediately: true,
  351. },
  352. },
  353. (error, res) => {
  354. expect(error).not.to.exist
  355. expect(res.statusCode).to.equal(200)
  356. expect(MockDocstoreApi.docs[this.projectId.toString()]).not.to.exist
  357. done()
  358. }
  359. )
  360. })
  361. it('Should destroy the files', function (done) {
  362. expect(MockFilestoreApi.files[this.projectId.toString()]).to.exist
  363. request.post(
  364. `/internal/project/${this.projectId}/expire-deleted-project`,
  365. {
  366. auth: {
  367. user: settings.apis.web.user,
  368. pass: settings.apis.web.pass,
  369. sendImmediately: true,
  370. },
  371. },
  372. (error, res) => {
  373. expect(error).not.to.exist
  374. expect(res.statusCode).to.equal(200)
  375. expect(MockFilestoreApi.files[this.projectId.toString()]).not.to
  376. .exist
  377. done()
  378. }
  379. )
  380. })
  381. it('Should destroy the chat', function (done) {
  382. expect(MockChatApi.projects[this.projectId.toString()]).to.exist
  383. request.post(
  384. `/internal/project/${this.projectId}/expire-deleted-project`,
  385. {
  386. auth: {
  387. user: settings.apis.web.user,
  388. pass: settings.apis.web.pass,
  389. sendImmediately: true,
  390. },
  391. },
  392. (error, res) => {
  393. expect(error).not.to.exist
  394. expect(res.statusCode).to.equal(200)
  395. expect(MockChatApi.projects[this.projectId.toString()]).not.to.exist
  396. done()
  397. }
  398. )
  399. })
  400. it('Should remove the project data from mongo', function (done) {
  401. db.deletedProjects.findOne(
  402. { 'deleterData.deletedProjectId': new ObjectId(this.projectId) },
  403. (error, deletedProject) => {
  404. expect(error).not.to.exist
  405. expect(deletedProject).to.exist
  406. expect(deletedProject.project).to.exist
  407. expect(deletedProject.deleterData.deleterIpAddress).to.exist
  408. expect(deletedProject.deleterData.deletedAt).to.exist
  409. request.post(
  410. `/internal/project/${this.projectId}/expire-deleted-project`,
  411. {
  412. auth: {
  413. user: settings.apis.web.user,
  414. pass: settings.apis.web.pass,
  415. sendImmediately: true,
  416. },
  417. },
  418. (error, res) => {
  419. expect(error).not.to.exist
  420. expect(res.statusCode).to.equal(200)
  421. db.deletedProjects.findOne(
  422. {
  423. 'deleterData.deletedProjectId': new ObjectId(
  424. this.projectId
  425. ),
  426. },
  427. (error, deletedProject) => {
  428. expect(error).not.to.exist
  429. expect(deletedProject).to.exist
  430. expect(deletedProject.project).not.to.exist
  431. expect(deletedProject.deleterData.deleterIpAddress).not.to
  432. .exist
  433. expect(deletedProject.deleterData.deletedAt).to.exist
  434. done()
  435. }
  436. )
  437. }
  438. )
  439. }
  440. )
  441. })
  442. if (Features.hasFeature('saas')) {
  443. it('Should destroy the history backup', function (done) {
  444. MockHistoryBackupDeletionApi.prepareProject(this.projectId, 204)
  445. request.post(
  446. `/internal/project/${this.projectId}/expire-deleted-project`,
  447. {
  448. auth: {
  449. user: settings.apis.web.user,
  450. pass: settings.apis.web.pass,
  451. sendImmediately: true,
  452. },
  453. },
  454. (error, res) => {
  455. expect(error).not.to.exist
  456. expect(res.statusCode).to.equal(200)
  457. expect(
  458. MockHistoryBackupDeletionApi.projects[this.projectId.toString()]
  459. ).not.to.exist
  460. done()
  461. }
  462. )
  463. })
  464. it('Should abort when the history backup cannot be deleted', function (done) {
  465. MockHistoryBackupDeletionApi.prepareProject(this.projectId, 422)
  466. request.post(
  467. `/internal/project/${this.projectId}/expire-deleted-project`,
  468. {
  469. auth: {
  470. user: settings.apis.web.user,
  471. pass: settings.apis.web.pass,
  472. sendImmediately: true,
  473. },
  474. },
  475. (error, res) => {
  476. expect(error).not.to.exist
  477. expect(res.statusCode).to.equal(500)
  478. expect(
  479. MockHistoryBackupDeletionApi.projects[this.projectId.toString()]
  480. ).to.exist
  481. db.deletedProjects.findOne(
  482. {
  483. 'deleterData.deletedProjectId': new ObjectId(this.projectId),
  484. },
  485. (error, deletedProject) => {
  486. expect(error).not.to.exist
  487. expect(deletedProject).to.exist
  488. expect(deletedProject.project).to.exist
  489. done()
  490. }
  491. )
  492. }
  493. )
  494. })
  495. }
  496. })
  497. })
  498. if (Features.hasFeature('git-bridge')) {
  499. describe('When the project has git-bridge data', function () {
  500. beforeEach(function () {
  501. MockGitBridgeApi.projects[this.projectId.toString()] = {
  502. data: 'some-data',
  503. }
  504. })
  505. describe('When the deleted project is expired', function () {
  506. beforeEach(function (done) {
  507. this.user.deleteProject(this.projectId, error => {
  508. if (error) {
  509. return done(error)
  510. }
  511. request.post(
  512. `/internal/project/${this.projectId}/expire-deleted-project`,
  513. {
  514. auth: {
  515. user: settings.apis.web.user,
  516. pass: settings.apis.web.pass,
  517. sendImmediately: true,
  518. },
  519. },
  520. (error, res) => {
  521. if (error) {
  522. return done(error)
  523. }
  524. expect(res.statusCode).to.equal(200)
  525. done()
  526. }
  527. )
  528. })
  529. })
  530. it('should delete the git-bridge data', function () {
  531. expect(MockGitBridgeApi.projects[this.projectId.toString()]).not.to
  532. .exist
  533. })
  534. })
  535. })
  536. }
  537. })