ProjectStructureTests.js 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383
  1. const { expect } = require('chai')
  2. const mkdirp = require('mkdirp')
  3. const { ObjectId } = require('mongojs')
  4. const Path = require('path')
  5. const fs = require('fs')
  6. const Settings = require('settings-sharelatex')
  7. const _ = require('underscore')
  8. const ProjectGetter = require('../../../app/src/Features/Project/ProjectGetter.js')
  9. const MockDocUpdaterApi = require('./helpers/MockDocUpdaterApi')
  10. require('./helpers/MockFileStoreApi')
  11. require('./helpers/MockProjectHistoryApi')
  12. const User = require('./helpers/User')
  13. describe('ProjectStructureChanges', function() {
  14. let owner
  15. beforeEach(function(done) {
  16. owner = new User()
  17. owner.login(done)
  18. })
  19. function createExampleProject(owner, callback) {
  20. owner.createProject(
  21. 'example-project',
  22. { template: 'example' },
  23. (error, projectId) => {
  24. if (error) {
  25. return callback(error)
  26. }
  27. ProjectGetter.getProject(projectId, (error, project) => {
  28. if (error) {
  29. return callback(error)
  30. }
  31. const rootFolderId = project.rootFolder[0]._id.toString()
  32. callback(null, projectId, rootFolderId)
  33. })
  34. }
  35. )
  36. }
  37. function createExampleDoc(owner, projectId, callback) {
  38. ProjectGetter.getProject(projectId, (error, project) => {
  39. if (error) {
  40. return callback(error)
  41. }
  42. owner.request.post(
  43. {
  44. uri: `project/${projectId}/doc`,
  45. json: {
  46. name: 'new.tex',
  47. parent_folder_id: project.rootFolder[0]._id
  48. }
  49. },
  50. (error, res, body) => {
  51. if (error) {
  52. return callback(error)
  53. }
  54. if (res.statusCode < 200 || res.statusCode >= 300) {
  55. return callback(new Error(`failed to add doc ${res.statusCode}`))
  56. }
  57. callback(null, body._id)
  58. }
  59. )
  60. })
  61. }
  62. function createExampleFolder(owner, projectId, callback) {
  63. owner.request.post(
  64. {
  65. uri: `project/${projectId}/folder`,
  66. json: {
  67. name: 'foo'
  68. }
  69. },
  70. (error, res, body) => {
  71. if (error) {
  72. return callback(error)
  73. }
  74. if (res.statusCode < 200 || res.statusCode >= 300) {
  75. return callback(new Error(`failed to add doc ${res.statusCode}`))
  76. }
  77. callback(null, body._id)
  78. }
  79. )
  80. }
  81. function uploadFile(
  82. owner,
  83. projectId,
  84. folderId,
  85. file,
  86. name,
  87. contentType,
  88. callback
  89. ) {
  90. const imageFile = fs.createReadStream(
  91. Path.resolve(Path.join(__dirname, '..', 'files', file))
  92. )
  93. owner.request.post(
  94. {
  95. uri: `project/${projectId}/upload`,
  96. qs: {
  97. folder_id: folderId
  98. },
  99. formData: {
  100. qqfile: {
  101. value: imageFile,
  102. options: {
  103. filename: name,
  104. contentType: contentType
  105. }
  106. }
  107. }
  108. },
  109. (error, res, body) => {
  110. if (error) {
  111. return callback(error)
  112. }
  113. if (res.statusCode < 200 || res.statusCode >= 300) {
  114. return callback(new Error(`failed to upload file ${res.statusCode}`))
  115. }
  116. callback(null, JSON.parse(body).entity_id)
  117. }
  118. )
  119. }
  120. function uploadExampleFile(owner, projectId, folderId, callback) {
  121. uploadFile(
  122. owner,
  123. projectId,
  124. folderId,
  125. '1pixel.png',
  126. '1pixel.png',
  127. 'image/png',
  128. callback
  129. )
  130. }
  131. function uploadExampleProject(owner, zipFilename, options, callback) {
  132. if (typeof options === 'function') {
  133. callback = options
  134. options = {}
  135. }
  136. const zipFile = fs.createReadStream(
  137. Path.resolve(Path.join(__dirname, '..', 'files', zipFilename))
  138. )
  139. owner.request.post(
  140. {
  141. uri: 'project/new/upload',
  142. formData: {
  143. qqfile: zipFile
  144. }
  145. },
  146. (error, res, body) => {
  147. if (error) {
  148. return callback(error)
  149. }
  150. if (
  151. !options.allowBadStatus &&
  152. (res.statusCode < 200 || res.statusCode >= 300)
  153. ) {
  154. return new Error(`failed to upload project ${res.statusCode}`)
  155. }
  156. callback(null, JSON.parse(body).project_id, res)
  157. }
  158. )
  159. }
  160. function moveItem(owner, projectId, type, itemId, folderId, callback) {
  161. owner.request.post(
  162. {
  163. uri: `project/${projectId}/${type}/${itemId}/move`,
  164. json: {
  165. folder_id: folderId
  166. }
  167. },
  168. (error, res) => {
  169. if (error) {
  170. return callback(error)
  171. }
  172. if (res.statusCode < 200 || res.statusCode >= 300) {
  173. return callback(new Error(`failed to move ${type} ${res.statusCode}`))
  174. }
  175. callback()
  176. }
  177. )
  178. }
  179. function renameItem(owner, projectId, type, itemId, name, callback) {
  180. owner.request.post(
  181. {
  182. uri: `project/${projectId}/${type}/${itemId}/rename`,
  183. json: {
  184. name: name
  185. }
  186. },
  187. (error, res) => {
  188. if (error) {
  189. return callback(error)
  190. }
  191. if (res.statusCode < 200 || res.statusCode >= 300) {
  192. return callback(
  193. new Error(`failed to rename ${type} ${res.statusCode}`)
  194. )
  195. }
  196. callback()
  197. }
  198. )
  199. }
  200. function deleteItem(owner, projectId, type, itemId, callback) {
  201. owner.request.delete(
  202. {
  203. uri: `project/${projectId}/${type}/${itemId}`
  204. },
  205. (error, res) => {
  206. if (error) {
  207. return callback(error)
  208. }
  209. if (res.statusCode < 200 || res.statusCode >= 300) {
  210. return callback(
  211. new Error(`failed to delete folder ${res.statusCode}`)
  212. )
  213. }
  214. callback()
  215. }
  216. )
  217. }
  218. function verifyVersionIncremented(
  219. projectId,
  220. oldVersion,
  221. updateVersion,
  222. increment,
  223. callback
  224. ) {
  225. expect(updateVersion).to.equal(oldVersion + increment)
  226. ProjectGetter.getProject(projectId, (error, newProject) => {
  227. if (error) {
  228. return callback(error)
  229. }
  230. expect(newProject.version).to.equal(updateVersion)
  231. callback()
  232. })
  233. }
  234. describe('creating a project from the example template', function() {
  235. let exampleProjectId
  236. beforeEach(function(done) {
  237. MockDocUpdaterApi.clearProjectStructureUpdates()
  238. createExampleProject(owner, (err, projectId) => {
  239. exampleProjectId = projectId
  240. done(err)
  241. })
  242. })
  243. it('should version creating a doc', function() {
  244. const {
  245. docUpdates: updates,
  246. version
  247. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  248. expect(updates.length).to.equal(2)
  249. _.each(updates, update => {
  250. expect(update.userId).to.equal(owner._id)
  251. expect(update.docLines).to.be.a('string')
  252. })
  253. expect(_.where(updates, { pathname: '/main.tex' }).length).to.equal(1)
  254. expect(_.where(updates, { pathname: '/references.bib' }).length).to.equal(
  255. 1
  256. )
  257. expect(version).to.equal(3)
  258. })
  259. it('should version creating a file', function() {
  260. const {
  261. fileUpdates: updates,
  262. version
  263. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  264. expect(updates.length).to.equal(1)
  265. const update = updates[0]
  266. expect(update.userId).to.equal(owner._id)
  267. expect(update.pathname).to.equal('/universe.jpg')
  268. expect(update.url).to.be.a('string')
  269. expect(version).to.equal(3)
  270. })
  271. })
  272. describe('duplicating a project', function() {
  273. let dupProjectId
  274. beforeEach(function(done) {
  275. MockDocUpdaterApi.clearProjectStructureUpdates()
  276. createExampleProject(owner, (err, projectId) => {
  277. if (err) {
  278. return done(err)
  279. }
  280. owner.request.post(
  281. {
  282. uri: `/Project/${projectId}/clone`,
  283. json: {
  284. projectName: 'new.tex'
  285. }
  286. },
  287. (error, res, body) => {
  288. if (error) {
  289. throw error
  290. }
  291. if (res.statusCode < 200 || res.statusCode >= 300) {
  292. throw new Error(`failed to clone project ${res.statusCode}`)
  293. }
  294. dupProjectId = body.project_id
  295. done()
  296. }
  297. )
  298. })
  299. })
  300. it('should version the docs created', function() {
  301. const {
  302. docUpdates: updates,
  303. version
  304. } = MockDocUpdaterApi.getProjectStructureUpdates(dupProjectId)
  305. expect(updates.length).to.equal(2)
  306. _.each(updates, update => {
  307. expect(update.userId).to.equal(owner._id)
  308. expect(update.docLines).to.be.a('string')
  309. })
  310. expect(_.where(updates, { pathname: '/main.tex' }).length).to.equal(1)
  311. expect(_.where(updates, { pathname: '/references.bib' }).length).to.equal(
  312. 1
  313. )
  314. expect(version).to.equal(3)
  315. })
  316. it('should version the files created', function() {
  317. const {
  318. fileUpdates: updates,
  319. version
  320. } = MockDocUpdaterApi.getProjectStructureUpdates(dupProjectId)
  321. expect(updates.length).to.equal(1)
  322. const update = updates[0]
  323. expect(update.userId).to.equal(owner._id)
  324. expect(update.pathname).to.equal('/universe.jpg')
  325. expect(update.url).to.be.a('string')
  326. expect(version).to.equal(3)
  327. })
  328. })
  329. describe('adding a doc', function() {
  330. let exampleProjectId, oldVersion
  331. beforeEach(function(done) {
  332. createExampleProject(owner, (err, projectId) => {
  333. if (err) {
  334. return done(err)
  335. }
  336. exampleProjectId = projectId
  337. MockDocUpdaterApi.clearProjectStructureUpdates()
  338. ProjectGetter.getProject(projectId, (error, project) => {
  339. if (error) {
  340. return done(error)
  341. }
  342. oldVersion = project.version
  343. createExampleDoc(owner, projectId, done)
  344. })
  345. })
  346. })
  347. it('should version the doc added', function(done) {
  348. const {
  349. docUpdates: updates,
  350. version: newVersion
  351. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  352. expect(updates.length).to.equal(1)
  353. const update = updates[0]
  354. expect(update.userId).to.equal(owner._id)
  355. expect(update.pathname).to.equal('/new.tex')
  356. expect(update.docLines).to.be.a('string')
  357. verifyVersionIncremented(
  358. exampleProjectId,
  359. oldVersion,
  360. newVersion,
  361. 1,
  362. done
  363. )
  364. })
  365. })
  366. describe('uploading a project', function() {
  367. let exampleProjectId
  368. beforeEach(function(done) {
  369. uploadExampleProject(owner, 'test_project.zip', (err, projectId) => {
  370. if (err) {
  371. return done(err)
  372. }
  373. exampleProjectId = projectId
  374. done()
  375. })
  376. })
  377. it('should version the docs created', function() {
  378. const {
  379. docUpdates: updates,
  380. version
  381. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  382. expect(updates.length).to.equal(1)
  383. const update = updates[0]
  384. expect(update.userId).to.equal(owner._id)
  385. expect(update.pathname).to.equal('/main.tex')
  386. expect(update.docLines).to.equal('Test')
  387. expect(version).to.equal(2)
  388. })
  389. it('should version the files created', function() {
  390. const {
  391. fileUpdates: updates,
  392. version
  393. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  394. expect(updates.length).to.equal(1)
  395. const update = updates[0]
  396. expect(update.userId).to.equal(owner._id)
  397. expect(update.pathname).to.equal('/1pixel.png')
  398. expect(update.url).to.be.a('string')
  399. expect(version).to.equal(2)
  400. })
  401. })
  402. describe('uploading a project with a name', function() {
  403. let exampleProjectId
  404. const testProjectName = 'wombat'
  405. beforeEach(function(done) {
  406. uploadExampleProject(
  407. owner,
  408. 'test_project_with_name.zip',
  409. (err, projectId) => {
  410. if (err) {
  411. return done(err)
  412. }
  413. exampleProjectId = projectId
  414. done()
  415. }
  416. )
  417. })
  418. it('should set the project name from the zip contents', function(done) {
  419. ProjectGetter.getProject(exampleProjectId, (error, project) => {
  420. expect(error).not.to.exist
  421. expect(project.name).to.equal(testProjectName)
  422. done()
  423. })
  424. })
  425. })
  426. describe('uploading a project with an invalid name', function() {
  427. let exampleProjectId
  428. const testProjectMatch = /^bad[^\\]+name$/
  429. beforeEach(function(done) {
  430. uploadExampleProject(
  431. owner,
  432. 'test_project_with_invalid_name.zip',
  433. (error, projectId) => {
  434. if (error) {
  435. return done(error)
  436. }
  437. exampleProjectId = projectId
  438. done()
  439. }
  440. )
  441. })
  442. it('should set the project name from the zip contents', function(done) {
  443. ProjectGetter.getProject(exampleProjectId, (error, project) => {
  444. expect(error).not.to.exist
  445. expect(project.name).to.match(testProjectMatch)
  446. done()
  447. })
  448. })
  449. })
  450. describe('uploading an empty zipfile', function() {
  451. let res
  452. beforeEach(function(done) {
  453. uploadExampleProject(
  454. owner,
  455. 'test_project_empty.zip',
  456. { allowBadStatus: true },
  457. (err, projectId, response) => {
  458. if (err) {
  459. return done(err)
  460. }
  461. res = response
  462. done()
  463. }
  464. )
  465. })
  466. it('should fail with 422 error', function() {
  467. expect(res.statusCode).to.equal(422)
  468. })
  469. })
  470. describe('uploading a zipfile containing only empty directories', function() {
  471. let res
  472. beforeEach(function(done) {
  473. uploadExampleProject(
  474. owner,
  475. 'test_project_with_empty_folder.zip',
  476. { allowBadStatus: true },
  477. (err, projectId, response) => {
  478. if (err) {
  479. return done(err)
  480. }
  481. res = response
  482. done()
  483. }
  484. )
  485. })
  486. it('should fail with 422 error', function() {
  487. expect(res.statusCode).to.equal(422)
  488. })
  489. })
  490. describe('uploading a project with a shared top-level folder', function() {
  491. let exampleProjectId
  492. beforeEach(function(done) {
  493. uploadExampleProject(
  494. owner,
  495. 'test_project_with_shared_top_level_folder.zip',
  496. (err, projectId) => {
  497. if (err) {
  498. return done(err)
  499. }
  500. exampleProjectId = projectId
  501. done()
  502. }
  503. )
  504. })
  505. it('should not create the top-level folder', function(done) {
  506. ProjectGetter.getProject(exampleProjectId, (error, project) => {
  507. expect(error).not.to.exist
  508. expect(project.rootFolder[0].folders.length).to.equal(0)
  509. expect(project.rootFolder[0].docs.length).to.equal(2)
  510. done()
  511. })
  512. })
  513. })
  514. describe('uploading a project with backslashes in the path names', function() {
  515. let exampleProjectId
  516. beforeEach(function(done) {
  517. uploadExampleProject(
  518. owner,
  519. 'test_project_with_backslash_in_filename.zip',
  520. (err, projectId) => {
  521. if (err) {
  522. return done(err)
  523. }
  524. exampleProjectId = projectId
  525. done()
  526. }
  527. )
  528. })
  529. it('should treat the backslash as a directory separator', function(done) {
  530. ProjectGetter.getProject(exampleProjectId, (error, project) => {
  531. expect(error).not.to.exist
  532. expect(project.rootFolder[0].folders[0].name).to.equal('styles')
  533. expect(project.rootFolder[0].folders[0].docs[0].name).to.equal('ao.sty')
  534. done()
  535. })
  536. })
  537. })
  538. describe('uploading a project with files in different encodings', function() {
  539. let docUpdates
  540. beforeEach(function(done) {
  541. uploadExampleProject(owner, 'charsets/charsets.zip', (err, projectId) => {
  542. if (err) {
  543. return done(err)
  544. }
  545. docUpdates = MockDocUpdaterApi.getProjectStructureUpdates(projectId)
  546. .docUpdates
  547. done()
  548. })
  549. })
  550. it('should correctly parse windows-1252', function() {
  551. const update = _.find(
  552. docUpdates,
  553. update => update.pathname === '/test-german-windows-1252.tex'
  554. )
  555. expect(update.docLines).to.contain(
  556. 'Der schnelle braune Fuchs sprang träge über den Hund.'
  557. )
  558. })
  559. it('should correctly parse German utf8', function() {
  560. const update = _.find(
  561. docUpdates,
  562. update => update.pathname === '/test-german-utf8x.tex'
  563. )
  564. expect(update.docLines).to.contain(
  565. 'Der schnelle braune Fuchs sprang träge über den Hund.'
  566. )
  567. })
  568. it('should correctly parse little-endian utf16', function() {
  569. const update = _.find(
  570. docUpdates,
  571. update => update.pathname === '/test-greek-utf16-le-bom.tex'
  572. )
  573. expect(update.docLines).to.contain(
  574. 'Η γρήγορη καστανή αλεπού πήδηξε χαλαρά πάνω από το σκυλί.'
  575. )
  576. })
  577. it('should correctly parse Greek utf8', function() {
  578. const update = _.find(
  579. docUpdates,
  580. update => update.pathname === '/test-greek-utf8x.tex'
  581. )
  582. expect(update.docLines).to.contain(
  583. 'Η γρήγορη καστανή αλεπού πήδηξε χαλαρά πάνω από το σκυλί.'
  584. )
  585. })
  586. })
  587. describe('uploading a file', function() {
  588. let exampleProjectId, oldVersion, rootFolderId
  589. beforeEach(function(done) {
  590. createExampleProject(owner, (err, projectId, folderId) => {
  591. if (err) {
  592. return done(err)
  593. }
  594. exampleProjectId = projectId
  595. rootFolderId = folderId
  596. MockDocUpdaterApi.clearProjectStructureUpdates()
  597. ProjectGetter.getProject(projectId, (error, project) => {
  598. if (error) {
  599. throw error
  600. }
  601. oldVersion = project.version
  602. uploadExampleFile(owner, projectId, rootFolderId, done)
  603. })
  604. })
  605. })
  606. it('should version a newly uploaded file', function(done) {
  607. const {
  608. fileUpdates: updates,
  609. version
  610. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  611. expect(updates.length).to.equal(1)
  612. const update = updates[0]
  613. expect(update.userId).to.equal(owner._id)
  614. expect(update.pathname).to.equal('/1pixel.png')
  615. expect(update.url).to.be.a('string')
  616. // one file upload
  617. verifyVersionIncremented(exampleProjectId, oldVersion, version, 1, done)
  618. })
  619. it('should version a replacement file', function(done) {
  620. MockDocUpdaterApi.clearProjectStructureUpdates()
  621. uploadFile(
  622. owner,
  623. exampleProjectId,
  624. rootFolderId,
  625. '2pixel.png',
  626. '1pixel.png',
  627. 'image/png',
  628. () => {
  629. const {
  630. fileUpdates: updates,
  631. version
  632. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  633. expect(updates.length).to.equal(2)
  634. let update = updates[0]
  635. expect(update.userId).to.equal(owner._id)
  636. expect(update.pathname).to.equal('/1pixel.png')
  637. update = updates[1]
  638. expect(update.userId).to.equal(owner._id)
  639. expect(update.pathname).to.equal('/1pixel.png')
  640. expect(update.url).to.be.a('string')
  641. // two file uploads
  642. verifyVersionIncremented(
  643. exampleProjectId,
  644. oldVersion,
  645. version,
  646. 2,
  647. done
  648. )
  649. }
  650. )
  651. })
  652. })
  653. describe('moving entities', function() {
  654. let exampleProjectId,
  655. oldVersion,
  656. exampleDocId,
  657. exampleFileId,
  658. exampleFolderId
  659. beforeEach(function(done) {
  660. createExampleProject(owner, (err, projectId, rootFolderId) => {
  661. if (err) {
  662. return done(err)
  663. }
  664. exampleProjectId = projectId
  665. createExampleDoc(owner, projectId, (err, docId) => {
  666. if (err) {
  667. return done(err)
  668. }
  669. exampleDocId = docId
  670. uploadExampleFile(owner, projectId, rootFolderId, (err, fileId) => {
  671. if (err) {
  672. return done(err)
  673. }
  674. exampleFileId = fileId
  675. createExampleFolder(owner, projectId, (err, folderId) => {
  676. if (err) {
  677. return done(err)
  678. }
  679. exampleFolderId = folderId
  680. ProjectGetter.getProject(projectId, (error, project) => {
  681. if (error) {
  682. throw error
  683. }
  684. oldVersion = project.version
  685. MockDocUpdaterApi.clearProjectStructureUpdates()
  686. done()
  687. })
  688. })
  689. })
  690. })
  691. })
  692. })
  693. it('should version moving a doc', function(done) {
  694. moveItem(
  695. owner,
  696. exampleProjectId,
  697. 'doc',
  698. exampleDocId,
  699. exampleFolderId,
  700. () => {
  701. const {
  702. docUpdates: updates,
  703. version
  704. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  705. expect(updates.length).to.equal(1)
  706. const update = updates[0]
  707. expect(update.userId).to.equal(owner._id)
  708. expect(update.pathname).to.equal('/new.tex')
  709. expect(update.newPathname).to.equal('/foo/new.tex')
  710. // 2, because it's a delete and then add
  711. verifyVersionIncremented(
  712. exampleProjectId,
  713. oldVersion,
  714. version,
  715. 2,
  716. done
  717. )
  718. }
  719. )
  720. })
  721. it('should version moving a file', function(done) {
  722. moveItem(
  723. owner,
  724. exampleProjectId,
  725. 'file',
  726. exampleFileId,
  727. exampleFolderId,
  728. () => {
  729. const {
  730. fileUpdates: updates,
  731. version
  732. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  733. expect(updates.length).to.equal(1)
  734. const update = updates[0]
  735. expect(update.userId).to.equal(owner._id)
  736. expect(update.pathname).to.equal('/1pixel.png')
  737. expect(update.newPathname).to.equal('/foo/1pixel.png')
  738. // 2, because it's a delete and then add
  739. verifyVersionIncremented(
  740. exampleProjectId,
  741. oldVersion,
  742. version,
  743. 2,
  744. done
  745. )
  746. }
  747. )
  748. })
  749. it('should version moving a folder', function(done) {
  750. moveItem(
  751. owner,
  752. exampleProjectId,
  753. 'doc',
  754. exampleDocId,
  755. exampleFolderId,
  756. () => {
  757. MockDocUpdaterApi.clearProjectStructureUpdates()
  758. owner.request.post(
  759. {
  760. uri: `project/${exampleProjectId}/folder`,
  761. json: {
  762. name: 'bar'
  763. }
  764. },
  765. (error, res, body) => {
  766. if (error) {
  767. throw error
  768. }
  769. const newFolderId = body._id
  770. moveItem(
  771. owner,
  772. exampleProjectId,
  773. 'folder',
  774. exampleFolderId,
  775. newFolderId,
  776. () => {
  777. const {
  778. docUpdates: updates,
  779. version
  780. } = MockDocUpdaterApi.getProjectStructureUpdates(
  781. exampleProjectId
  782. )
  783. expect(updates.length).to.equal(1)
  784. let update = updates[0]
  785. expect(update.userId).to.equal(owner._id)
  786. expect(update.pathname).to.equal('/foo/new.tex')
  787. expect(update.newPathname).to.equal('/bar/foo/new.tex')
  788. // 5, because it's two file moves plus a folder
  789. verifyVersionIncremented(
  790. exampleProjectId,
  791. oldVersion,
  792. version,
  793. 5,
  794. done
  795. )
  796. }
  797. )
  798. }
  799. )
  800. }
  801. )
  802. })
  803. })
  804. describe('renaming entities', function() {
  805. let exampleProjectId,
  806. exampleDocId,
  807. exampleFileId,
  808. exampleFolderId,
  809. oldVersion
  810. beforeEach(function(done) {
  811. createExampleProject(owner, (err, projectId, rootFolderId) => {
  812. if (err) {
  813. return done(err)
  814. }
  815. exampleProjectId = projectId
  816. createExampleDoc(owner, projectId, (err, docId) => {
  817. if (err) {
  818. return done(err)
  819. }
  820. exampleDocId = docId
  821. uploadExampleFile(owner, projectId, rootFolderId, (err, fileId) => {
  822. if (err) {
  823. return done(err)
  824. }
  825. exampleFileId = fileId
  826. createExampleFolder(owner, projectId, (err, folderId) => {
  827. if (err) {
  828. return done(err)
  829. }
  830. exampleFolderId = folderId
  831. moveItem(owner, projectId, 'doc', docId, folderId, () => {
  832. moveItem(owner, projectId, 'file', fileId, folderId, () => {
  833. MockDocUpdaterApi.clearProjectStructureUpdates()
  834. ProjectGetter.getProject(
  835. exampleProjectId,
  836. (error, project) => {
  837. if (error) {
  838. throw error
  839. }
  840. oldVersion = project.version
  841. done()
  842. }
  843. )
  844. })
  845. })
  846. })
  847. })
  848. })
  849. })
  850. })
  851. it('should version renaming a doc', function(done) {
  852. renameItem(
  853. owner,
  854. exampleProjectId,
  855. 'Doc',
  856. exampleDocId,
  857. 'wombat.tex',
  858. () => {
  859. const {
  860. docUpdates: updates,
  861. version
  862. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  863. expect(updates.length).to.equal(1)
  864. const update = updates[0]
  865. expect(update.userId).to.equal(owner._id)
  866. expect(update.pathname).to.equal('/foo/new.tex')
  867. expect(update.newPathname).to.equal('/foo/wombat.tex')
  868. verifyVersionIncremented(
  869. exampleProjectId,
  870. oldVersion,
  871. version,
  872. 1,
  873. done
  874. )
  875. }
  876. )
  877. })
  878. it('should version renaming a file', function(done) {
  879. renameItem(
  880. owner,
  881. exampleProjectId,
  882. 'file',
  883. exampleFileId,
  884. 'potato.png',
  885. () => {
  886. const {
  887. fileUpdates: updates,
  888. version
  889. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  890. expect(updates.length).to.equal(1)
  891. const update = updates[0]
  892. expect(update.userId).to.equal(owner._id)
  893. expect(update.pathname).to.equal('/foo/1pixel.png')
  894. expect(update.newPathname).to.equal('/foo/potato.png')
  895. verifyVersionIncremented(
  896. exampleProjectId,
  897. oldVersion,
  898. version,
  899. 1,
  900. done
  901. )
  902. }
  903. )
  904. })
  905. it('should version renaming a folder', function(done) {
  906. renameItem(
  907. owner,
  908. exampleProjectId,
  909. 'folder',
  910. exampleFolderId,
  911. 'giraffe',
  912. () => {
  913. const {
  914. docUpdates,
  915. fileUpdates,
  916. version
  917. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  918. expect(docUpdates.length).to.equal(1)
  919. const docUpdate = docUpdates[0]
  920. expect(docUpdate.userId).to.equal(owner._id)
  921. expect(docUpdate.pathname).to.equal('/foo/new.tex')
  922. expect(docUpdate.newPathname).to.equal('/giraffe/new.tex')
  923. expect(fileUpdates.length).to.equal(1)
  924. const fileUpdate = fileUpdates[0]
  925. expect(fileUpdate.userId).to.equal(owner._id)
  926. expect(fileUpdate.pathname).to.equal('/foo/1pixel.png')
  927. expect(fileUpdate.newPathname).to.equal('/giraffe/1pixel.png')
  928. verifyVersionIncremented(
  929. exampleProjectId,
  930. oldVersion,
  931. version,
  932. 1,
  933. done
  934. )
  935. }
  936. )
  937. })
  938. })
  939. describe('deleting entities', function() {
  940. let exampleProjectId, oldVersion, exampleFolderId
  941. beforeEach(function(done) {
  942. createExampleProject(owner, (err, projectId) => {
  943. if (err) {
  944. return done(err)
  945. }
  946. exampleProjectId = projectId
  947. createExampleFolder(owner, exampleProjectId, (err, folderId) => {
  948. if (err) {
  949. return done(err)
  950. }
  951. exampleFolderId = folderId
  952. createExampleDoc(owner, projectId, (err, docId) => {
  953. if (err) {
  954. return done(err)
  955. }
  956. uploadExampleFile(owner, projectId, folderId, (err, fileId) => {
  957. if (err) {
  958. return done(err)
  959. }
  960. moveItem(owner, projectId, 'doc', docId, folderId, () => {
  961. moveItem(owner, projectId, 'file', fileId, folderId, () => {
  962. MockDocUpdaterApi.clearProjectStructureUpdates()
  963. ProjectGetter.getProject(
  964. exampleProjectId,
  965. (error, project) => {
  966. if (error) {
  967. throw error
  968. }
  969. oldVersion = project.version
  970. done()
  971. }
  972. )
  973. })
  974. })
  975. })
  976. })
  977. })
  978. })
  979. })
  980. it('should version deleting a folder', function(done) {
  981. deleteItem(owner, exampleProjectId, 'folder', exampleFolderId, () => {
  982. const {
  983. docUpdates,
  984. fileUpdates,
  985. version
  986. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  987. expect(docUpdates.length).to.equal(1)
  988. const docUpdate = docUpdates[0]
  989. expect(docUpdate.userId).to.equal(owner._id)
  990. expect(docUpdate.pathname).to.equal('/foo/new.tex')
  991. expect(docUpdate.newPathname).to.equal('')
  992. expect(fileUpdates.length).to.equal(1)
  993. const fileUpdate = fileUpdates[0]
  994. expect(fileUpdate.userId).to.equal(owner._id)
  995. expect(fileUpdate.pathname).to.equal('/foo/1pixel.png')
  996. expect(fileUpdate.newPathname).to.equal('')
  997. verifyVersionIncremented(exampleProjectId, oldVersion, version, 1, done)
  998. })
  999. })
  1000. })
  1001. describe('tpds', function() {
  1002. let projectName, exampleProjectId, oldVersion, rootFolderId
  1003. beforeEach(function(done) {
  1004. projectName = `tpds-project-${new ObjectId().toString()}`
  1005. owner.createProject(projectName, (error, projectId) => {
  1006. if (error) {
  1007. throw error
  1008. }
  1009. exampleProjectId = projectId
  1010. mkdirp(Settings.path.dumpFolder, () => {
  1011. ProjectGetter.getProject(exampleProjectId, (error, project) => {
  1012. if (error) {
  1013. throw error
  1014. }
  1015. MockDocUpdaterApi.clearProjectStructureUpdates()
  1016. rootFolderId = project.rootFolder[0]._id.toString()
  1017. oldVersion = project.version
  1018. done()
  1019. })
  1020. })
  1021. })
  1022. })
  1023. it('should version adding a doc', function(done) {
  1024. const texFile = fs.createReadStream(
  1025. Path.resolve(Path.join(__dirname, '..', 'files', 'test.tex'))
  1026. )
  1027. const req = owner.request.post({
  1028. uri: `/user/${owner._id}/update/${projectName}/test.tex`,
  1029. auth: {
  1030. user: _.keys(Settings.httpAuthUsers)[0],
  1031. pass: _.values(Settings.httpAuthUsers)[0],
  1032. sendImmediately: true
  1033. }
  1034. })
  1035. texFile.on('error', err => {
  1036. throw err
  1037. })
  1038. req.on('error', err => {
  1039. throw err
  1040. })
  1041. req.on('response', res => {
  1042. if (res.statusCode < 200 || res.statusCode >= 300) {
  1043. throw new Error(`failed to upload file ${res.statusCode}`)
  1044. }
  1045. const {
  1046. docUpdates: updates,
  1047. version
  1048. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  1049. expect(updates.length).to.equal(1)
  1050. const update = updates[0]
  1051. expect(update.userId).to.equal(owner._id)
  1052. expect(update.pathname).to.equal('/test.tex')
  1053. expect(update.docLines).to.equal('Test')
  1054. verifyVersionIncremented(exampleProjectId, oldVersion, version, 1, done)
  1055. })
  1056. texFile.pipe(req)
  1057. })
  1058. it('should version adding a new file', function(done) {
  1059. const imageFile = fs.createReadStream(
  1060. Path.resolve(Path.join(__dirname, '..', 'files', '1pixel.png'))
  1061. )
  1062. const req = owner.request.post({
  1063. uri: `/user/${owner._id}/update/${projectName}/1pixel.png`,
  1064. auth: {
  1065. user: _.keys(Settings.httpAuthUsers)[0],
  1066. pass: _.values(Settings.httpAuthUsers)[0],
  1067. sendImmediately: true
  1068. }
  1069. })
  1070. imageFile.on('error', err => {
  1071. throw err
  1072. })
  1073. req.on('error', err => {
  1074. throw err
  1075. })
  1076. req.on('response', res => {
  1077. if (res.statusCode < 200 || res.statusCode >= 300) {
  1078. throw new Error(`failed to upload file ${res.statusCode}`)
  1079. }
  1080. const {
  1081. fileUpdates: updates,
  1082. version
  1083. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  1084. expect(updates.length).to.equal(1)
  1085. const update = updates[0]
  1086. expect(update.userId).to.equal(owner._id)
  1087. expect(update.pathname).to.equal('/1pixel.png')
  1088. expect(update.url).to.be.a('string')
  1089. verifyVersionIncremented(exampleProjectId, oldVersion, version, 1, done)
  1090. })
  1091. imageFile.pipe(req)
  1092. })
  1093. describe('when there are files in the project', function() {
  1094. beforeEach(function(done) {
  1095. uploadExampleFile(owner, exampleProjectId, rootFolderId, () => {
  1096. createExampleDoc(owner, exampleProjectId, () => {
  1097. ProjectGetter.getProject(exampleProjectId, (error, project) => {
  1098. if (error) {
  1099. throw error
  1100. }
  1101. MockDocUpdaterApi.clearProjectStructureUpdates()
  1102. oldVersion = project.version
  1103. done()
  1104. })
  1105. })
  1106. })
  1107. })
  1108. it('should version replacing a file', function(done) {
  1109. const imageFile = fs.createReadStream(
  1110. Path.resolve(Path.join(__dirname, '..', 'files', '2pixel.png'))
  1111. )
  1112. const req = owner.request.post({
  1113. uri: `/user/${owner._id}/update/${projectName}/1pixel.png`,
  1114. auth: {
  1115. user: _.keys(Settings.httpAuthUsers)[0],
  1116. pass: _.values(Settings.httpAuthUsers)[0],
  1117. sendImmediately: true
  1118. }
  1119. })
  1120. imageFile.on('error', err => {
  1121. throw err
  1122. })
  1123. req.on('error', err => {
  1124. throw err
  1125. })
  1126. req.on('response', res => {
  1127. if (res.statusCode < 200 || res.statusCode >= 300) {
  1128. throw new Error(`failed to upload file ${res.statusCode}`)
  1129. }
  1130. const {
  1131. fileUpdates: updates,
  1132. version
  1133. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  1134. expect(updates.length).to.equal(2)
  1135. let update = updates[0]
  1136. expect(update.userId).to.equal(owner._id)
  1137. expect(update.pathname).to.equal('/1pixel.png')
  1138. // expect(update.url).to.be.a('string');
  1139. update = updates[1]
  1140. expect(update.userId).to.equal(owner._id)
  1141. expect(update.pathname).to.equal('/1pixel.png')
  1142. expect(update.url).to.be.a('string')
  1143. verifyVersionIncremented(
  1144. exampleProjectId,
  1145. oldVersion,
  1146. version,
  1147. 1,
  1148. done
  1149. )
  1150. })
  1151. imageFile.pipe(req)
  1152. })
  1153. it('should version deleting a doc', function(done) {
  1154. owner.request.delete(
  1155. {
  1156. uri: `/user/${owner._id}/update/${projectName}/new.tex`,
  1157. auth: {
  1158. user: _.keys(Settings.httpAuthUsers)[0],
  1159. pass: _.values(Settings.httpAuthUsers)[0],
  1160. sendImmediately: true
  1161. }
  1162. },
  1163. (error, res) => {
  1164. if (error) {
  1165. throw error
  1166. }
  1167. if (res.statusCode < 200 || res.statusCode >= 300) {
  1168. throw new Error(`failed to delete doc ${res.statusCode}`)
  1169. }
  1170. const {
  1171. docUpdates: updates,
  1172. version
  1173. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  1174. expect(updates.length).to.equal(1)
  1175. const update = updates[0]
  1176. expect(update.userId).to.equal(owner._id)
  1177. expect(update.pathname).to.equal('/new.tex')
  1178. expect(update.newPathname).to.equal('')
  1179. verifyVersionIncremented(
  1180. exampleProjectId,
  1181. oldVersion,
  1182. version,
  1183. 1,
  1184. done
  1185. )
  1186. }
  1187. )
  1188. })
  1189. })
  1190. })
  1191. describe('uploading a document', function() {
  1192. let exampleProjectId, rootFolderId
  1193. beforeEach(function(done) {
  1194. createExampleProject(owner, (err, projectId, folderId) => {
  1195. if (err) {
  1196. return done(err)
  1197. }
  1198. exampleProjectId = projectId
  1199. rootFolderId = folderId
  1200. MockDocUpdaterApi.clearProjectStructureUpdates()
  1201. done()
  1202. })
  1203. })
  1204. describe('with an unusual character set', function() {
  1205. it('should correctly handle utf16-le data', function(done) {
  1206. uploadFile(
  1207. owner,
  1208. exampleProjectId,
  1209. rootFolderId,
  1210. 'charsets/test-greek-utf16-le-bom.tex',
  1211. 'test-greek-utf16-le-bom.tex',
  1212. 'text/x-tex',
  1213. () => {
  1214. const {
  1215. docUpdates: updates
  1216. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  1217. expect(updates.length).to.equal(1)
  1218. const update = updates[0]
  1219. expect(update.pathname).to.equal('/test-greek-utf16-le-bom.tex')
  1220. expect(update.docLines).to.contain(
  1221. 'Η γρήγορη καστανή αλεπού πήδηξε χαλαρά πάνω από το σκυλί.'
  1222. )
  1223. done()
  1224. }
  1225. )
  1226. })
  1227. it('should correctly handle windows1252/iso-8859-1/latin1 data', function(done) {
  1228. uploadFile(
  1229. owner,
  1230. exampleProjectId,
  1231. rootFolderId,
  1232. 'charsets/test-german-windows-1252.tex',
  1233. 'test-german-windows-1252.tex',
  1234. 'text/x-tex',
  1235. () => {
  1236. const {
  1237. docUpdates: updates
  1238. } = MockDocUpdaterApi.getProjectStructureUpdates(exampleProjectId)
  1239. expect(updates.length).to.equal(1)
  1240. const update = updates[0]
  1241. expect(update.pathname).to.equal('/test-german-windows-1252.tex')
  1242. expect(update.docLines).to.contain(
  1243. 'Der schnelle braune Fuchs sprang träge über den Hund.'
  1244. )
  1245. done()
  1246. }
  1247. )
  1248. })
  1249. })
  1250. })
  1251. })