ProjectDetailsHandlerTests.coffee 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424
  1. should = require('chai').should()
  2. modulePath = "../../../../app/js/Features/Project/ProjectDetailsHandler"
  3. Errors = require "../../../../app/js/Features/Errors/Errors"
  4. SandboxedModule = require('sandboxed-module')
  5. sinon = require('sinon')
  6. assert = require("chai").assert
  7. expect = require("chai").expect
  8. require('chai').should()
  9. describe 'ProjectDetailsHandler', ->
  10. beforeEach ->
  11. @project_id = "321l3j1kjkjl"
  12. @user_id = "user-id-123"
  13. @project =
  14. name: "project"
  15. description: "this is a great project"
  16. something:"should not exist"
  17. compiler: "latexxxxxx"
  18. owner_ref: @user_id
  19. @user =
  20. features: "mock-features"
  21. @ProjectGetter =
  22. getProjectWithoutDocLines: sinon.stub().callsArgWith(1, null, @project)
  23. getProject: sinon.stub().callsArgWith(2, null, @project)
  24. @ProjectModel =
  25. update: sinon.stub()
  26. findOne: sinon.stub()
  27. @UserGetter =
  28. getUser: sinon.stub().callsArgWith(1, null, @user)
  29. @tpdsUpdateSender =
  30. moveEntity:sinon.stub().callsArgWith 1
  31. @ProjectEntityHandler =
  32. flushProjectToThirdPartyDataStore: sinon.stub().callsArg(1)
  33. @CollaboratorsHandler =
  34. removeUserFromProject: sinon.stub().callsArg(2)
  35. @handler = SandboxedModule.require modulePath, requires:
  36. "./ProjectGetter":@ProjectGetter
  37. '../../models/Project': Project:@ProjectModel
  38. "../User/UserGetter": @UserGetter
  39. '../ThirdPartyDataStore/TpdsUpdateSender':@tpdsUpdateSender
  40. "./ProjectEntityHandler": @ProjectEntityHandler
  41. "../Collaborators/CollaboratorsHandler": @CollaboratorsHandler
  42. 'logger-sharelatex':
  43. log:->
  44. err:->
  45. './ProjectTokenGenerator': @ProjectTokenGenerator = {}
  46. 'settings-sharelatex': @settings =
  47. defaultFeatures: 'default-features'
  48. describe "getDetails", ->
  49. it "should find the project and owner", (done)->
  50. @handler.getDetails @project_id, (err, details)=>
  51. details.name.should.equal @project.name
  52. details.description.should.equal @project.description
  53. details.compiler.should.equal @project.compiler
  54. details.features.should.equal @user.features
  55. assert.equal(details.something, undefined)
  56. done()
  57. it "should find overleaf metadata if it exists", (done)->
  58. @project.overleaf = { id: 'id' }
  59. @handler.getDetails @project_id, (err, details)=>
  60. details.overleaf.should.equal @project.overleaf
  61. assert.equal(details.something, undefined)
  62. done()
  63. it "should return an error for a non-existent project", (done)->
  64. @ProjectGetter.getProject.callsArg(2, null, null)
  65. err = new Errors.NotFoundError("project not found")
  66. @handler.getDetails "0123456789012345678901234", (error, details) =>
  67. err.should.eql error
  68. done()
  69. it 'should return the default features if no owner found', (done) ->
  70. @UserGetter.getUser.callsArgWith(1, null, null)
  71. @handler.getDetails @project_id, (err, details)=>
  72. details.features.should.equal @settings.defaultFeatures
  73. done()
  74. it "should return the error", (done)->
  75. error = "some error"
  76. @ProjectGetter.getProject.callsArgWith(2, error)
  77. @handler.getDetails @project_id, (err)=>
  78. err.should.equal error
  79. done()
  80. describe "transferOwnership", ->
  81. beforeEach ->
  82. @handler.generateUniqueName = sinon.stub().callsArgWith(2, null, 'teapot')
  83. @ProjectModel.update.callsArgWith(2)
  84. it "should return a not found error if the project can't be found", (done) ->
  85. @ProjectGetter.getProject.callsArgWith(2)
  86. @handler.transferOwnership 'abc', '123', (err) ->
  87. err.should.exist
  88. err.name.should.equal "NotFoundError"
  89. done()
  90. it "should return a not found error if the user can't be found", (done) ->
  91. @ProjectGetter.getProject.callsArgWith(2)
  92. @handler.transferOwnership 'abc', '123', (err) ->
  93. err.should.exist
  94. err.name.should.equal "NotFoundError"
  95. done()
  96. it "should return an error if user cannot be removed as collaborator ", (done) ->
  97. errorMessage = "user-cannot-be-removed"
  98. @CollaboratorsHandler.removeUserFromProject.callsArgWith(2, errorMessage)
  99. @handler.transferOwnership 'abc', '123', (err) ->
  100. err.should.exist
  101. err.should.equal errorMessage
  102. done()
  103. it "should transfer ownership of the project", (done) ->
  104. @handler.transferOwnership 'abc', '123', () =>
  105. sinon.assert.calledWith(@ProjectModel.update, {_id: 'abc'}, sinon.match({$set: {name: 'teapot'}}))
  106. done()
  107. it "should remove the user from the project's collaborators", (done) ->
  108. @handler.transferOwnership 'abc', '123', () =>
  109. sinon.assert.calledWith(@CollaboratorsHandler.removeUserFromProject, 'abc', '123')
  110. done()
  111. it "should flush the project to tpds", (done) ->
  112. @handler.transferOwnership 'abc', '123', () =>
  113. sinon.assert.calledWith(@ProjectEntityHandler.flushProjectToThirdPartyDataStore, 'abc')
  114. done()
  115. it "should generate a unique name for the project", (done) ->
  116. @handler.transferOwnership 'abc', '123', () =>
  117. sinon.assert.calledWith(@handler.generateUniqueName, '123', @project.name)
  118. done()
  119. it "should append the supplied suffix to the project name, if passed", (done) ->
  120. @handler.transferOwnership 'abc', '123', ' wombat', () =>
  121. sinon.assert.calledWith(@handler.generateUniqueName, '123', "#{@project.name} wombat")
  122. done()
  123. describe "getProjectDescription", ->
  124. it "should make a call to mongo just for the description", (done)->
  125. @ProjectGetter.getProject.callsArgWith(2)
  126. @handler.getProjectDescription @project_id, (err, description)=>
  127. @ProjectGetter.getProject
  128. .calledWith(@project_id, description: true)
  129. .should.equal true
  130. done()
  131. it "should return what the mongo call returns", (done)->
  132. err = "error"
  133. description = "cool project"
  134. @ProjectGetter.getProject.callsArgWith(2, err, {description:description})
  135. @handler.getProjectDescription @project_id, (returnedErr, returnedDescription)=>
  136. err.should.equal returnedErr
  137. description.should.equal returnedDescription
  138. done()
  139. describe "setProjectDescription", ->
  140. beforeEach ->
  141. @description = "updated teh description"
  142. it "should update the project detials", (done)->
  143. @ProjectModel.update.callsArgWith(2)
  144. @handler.setProjectDescription @project_id, @description, =>
  145. @ProjectModel.update.calledWith({_id:@project_id}, {description:@description}).should.equal true
  146. done()
  147. describe "renameProject", ->
  148. beforeEach ->
  149. @handler.validateProjectName = sinon.stub().yields()
  150. @ProjectModel.update.callsArgWith(2)
  151. @newName = "new name here"
  152. it "should update the project with the new name", (done)->
  153. newName = "new name here"
  154. @handler.renameProject @project_id, @newName, =>
  155. @ProjectModel.update.calledWith({_id: @project_id}, {name: @newName}).should.equal true
  156. done()
  157. it "should tell the tpdsUpdateSender", (done)->
  158. @handler.renameProject @project_id, @newName, =>
  159. @tpdsUpdateSender.moveEntity.calledWith({project_id:@project_id, project_name:@project.name, newProjectName:@newName}).should.equal true
  160. done()
  161. it "should not do anything with an invalid name", (done) ->
  162. @handler.validateProjectName = sinon.stub().yields(new Error("invalid name"))
  163. @handler.renameProject @project_id, @newName, =>
  164. @tpdsUpdateSender.moveEntity.called.should.equal false
  165. @ProjectModel.update.called.should.equal false
  166. done()
  167. describe "validateProjectName", ->
  168. it "should reject undefined names", (done) ->
  169. @handler.validateProjectName undefined, (error) ->
  170. expect(error).to.exist
  171. done()
  172. it "should reject empty names", (done) ->
  173. @handler.validateProjectName "", (error) ->
  174. expect(error).to.exist
  175. done()
  176. it "should reject names with /s", (done) ->
  177. @handler.validateProjectName "foo/bar", (error) ->
  178. expect(error).to.exist
  179. done()
  180. it "should reject names with \\s", (done) ->
  181. @handler.validateProjectName "foo\\bar", (error) ->
  182. expect(error).to.exist
  183. done()
  184. it "should reject long names", (done) ->
  185. @handler.validateProjectName new Array(1000).join("a"), (error) ->
  186. expect(error).to.exist
  187. done()
  188. it "should accept normal names", (done) ->
  189. @handler.validateProjectName "foobar", (error) ->
  190. expect(error).to.not.exist
  191. done()
  192. describe "ensureProjectNameIsUnique", ->
  193. beforeEach ->
  194. @result = {
  195. owned: [{_id: 1, name:"name"}, {_id: 2, name: "name1"}, {_id: 3, name: "name11"}, {_id: 100, name: "numeric"}]
  196. readAndWrite: [{_id: 4, name:"name2"}, {_id: 5, name:"name22"}]
  197. readOnly: [{_id:6, name:"name3"}, {_id:7, name: "name33"}]
  198. tokenReadAndWrite: [{_id:8, name:"name4"}, {_id:9, name:"name44"}]
  199. tokenReadOnly: [{_id:10, name:"name5"}, {_id:11, name:"name55"}, {_id:12, name:"x".repeat(15)}]
  200. }
  201. for i in [1..20].concat([30..40])
  202. @result.owned.push {_id: 100 + i, name: "numeric (#{i})"}
  203. @ProjectGetter.findAllUsersProjects = sinon.stub().callsArgWith(2, null, @result)
  204. it "should leave a unique name unchanged", (done) ->
  205. @handler.ensureProjectNameIsUnique @user_id, "unique-name", ["-test-suffix"], (error, name, changed) ->
  206. expect(name).to.equal "unique-name"
  207. expect(changed).to.equal false
  208. done()
  209. it "should append a suffix to an existing name", (done) ->
  210. @handler.ensureProjectNameIsUnique @user_id, "name1", ["-test-suffix"], (error, name, changed) ->
  211. expect(name).to.equal "name1-test-suffix"
  212. expect(changed).to.equal true
  213. done()
  214. it "should fallback to a second suffix when needed", (done) ->
  215. @handler.ensureProjectNameIsUnique @user_id, "name1", ["1", "-test-suffix"], (error, name, changed) ->
  216. expect(name).to.equal "name1-test-suffix"
  217. expect(changed).to.equal true
  218. done()
  219. it "should truncate the name when append a suffix if the result is too long", (done) ->
  220. @handler.MAX_PROJECT_NAME_LENGTH = 20
  221. @handler.ensureProjectNameIsUnique @user_id, "x".repeat(15), ["-test-suffix"], (error, name, changed) ->
  222. expect(name).to.equal "x".repeat(8) + "-test-suffix"
  223. expect(changed).to.equal true
  224. done()
  225. it "should use a numeric index if no suffix is supplied", (done) ->
  226. @handler.ensureProjectNameIsUnique @user_id, "name1", [], (error, name, changed) ->
  227. expect(name).to.equal "name1 (1)"
  228. expect(changed).to.equal true
  229. done()
  230. it "should use a numeric index if all suffixes are exhausted", (done) ->
  231. @handler.ensureProjectNameIsUnique @user_id, "name", ["1", "11"], (error, name, changed) ->
  232. expect(name).to.equal "name (1)"
  233. expect(changed).to.equal true
  234. done()
  235. it "should find the next lowest available numeric index for the base name", (done) ->
  236. @handler.ensureProjectNameIsUnique @user_id, "numeric", [], (error, name, changed) ->
  237. expect(name).to.equal "numeric (21)"
  238. expect(changed).to.equal true
  239. done()
  240. it "should find the next available numeric index when a numeric index is already present", (done) ->
  241. @handler.ensureProjectNameIsUnique @user_id, "numeric (5)", [], (error, name, changed) ->
  242. expect(name).to.equal "numeric (21)"
  243. expect(changed).to.equal true
  244. done()
  245. it "should not find a numeric index lower than the one already present", (done) ->
  246. @handler.ensureProjectNameIsUnique @user_id, "numeric (31)", [], (error, name, changed) ->
  247. expect(name).to.equal "numeric (41)"
  248. expect(changed).to.equal true
  249. done()
  250. describe "fixProjectName", ->
  251. it "should change empty names to Untitled", () ->
  252. expect(@handler.fixProjectName "").to.equal "Untitled"
  253. it "should replace / with -", () ->
  254. expect(@handler.fixProjectName "foo/bar").to.equal "foo-bar"
  255. it "should replace \\ with ''", () ->
  256. expect(@handler.fixProjectName "foo \\ bar").to.equal "foo bar"
  257. it "should truncate long names", () ->
  258. expect(@handler.fixProjectName new Array(1000).join("a")).to.equal "a".repeat(150)
  259. it "should accept normal names", () ->
  260. expect(@handler.fixProjectName "foobar").to.equal "foobar"
  261. describe "setPublicAccessLevel", ->
  262. beforeEach ->
  263. @ProjectModel.update.callsArgWith(2)
  264. @accessLevel = "readOnly"
  265. it "should update the project with the new level", (done)->
  266. @handler.setPublicAccessLevel @project_id, @accessLevel, =>
  267. @ProjectModel.update.calledWith({_id: @project_id}, {publicAccesLevel: @accessLevel}).should.equal true
  268. done()
  269. it 'should not produce an error', (done) ->
  270. @handler.setPublicAccessLevel @project_id, @accessLevel, (err) =>
  271. expect(err).to.not.exist
  272. done()
  273. describe 'when update produces an error', ->
  274. beforeEach ->
  275. @ProjectModel.update.callsArgWith(2, new Error('woops'))
  276. it 'should produce an error', (done) ->
  277. @handler.setPublicAccessLevel @project_id, @accessLevel, (err) =>
  278. expect(err).to.exist
  279. expect(err).to.be.instanceof Error
  280. done()
  281. describe "ensureTokensArePresent", ->
  282. beforeEach ->
  283. describe 'when the project has tokens', ->
  284. beforeEach ->
  285. @project =
  286. _id: @project_id
  287. tokens:
  288. readOnly: 'aaa'
  289. readAndWrite: '42bbb'
  290. readAndWritePrefix: '42'
  291. @ProjectGetter.getProject = sinon.stub()
  292. .callsArgWith(2, null, @project)
  293. @ProjectModel.update = sinon.stub()
  294. it 'should get the project', (done) ->
  295. @handler.ensureTokensArePresent @project_id, (err, tokens) =>
  296. expect(@ProjectGetter.getProject.callCount).to.equal 1
  297. expect(@ProjectGetter.getProject.calledWith(@project_id, {tokens: 1}))
  298. .to.equal true
  299. done()
  300. it 'should not update the project with new tokens', (done) ->
  301. @handler.ensureTokensArePresent @project_id, (err, tokens) =>
  302. expect(@ProjectModel.update.callCount).to.equal 0
  303. done()
  304. it 'should produce the tokens without error', (done) ->
  305. @handler.ensureTokensArePresent @project_id, (err, tokens) =>
  306. expect(err).to.not.exist
  307. expect(tokens).to.deep.equal @project.tokens
  308. done()
  309. describe 'when tokens are missing', ->
  310. beforeEach ->
  311. @project =
  312. _id: @project_id
  313. @ProjectGetter.getProject = sinon.stub()
  314. .callsArgWith(2, null, @project)
  315. @readOnlyToken = 'abc'
  316. @readAndWriteToken = '42def'
  317. @readAndWriteTokenPrefix = '42'
  318. @ProjectTokenGenerator.generateUniqueReadOnlyToken = sinon.stub().callsArgWith(0, null, @readOnlyToken)
  319. @ProjectTokenGenerator.readAndWriteToken = sinon.stub().returns({
  320. token: @readAndWriteToken
  321. numericPrefix: @readAndWriteTokenPrefix
  322. })
  323. @ProjectModel.update = sinon.stub()
  324. .callsArgWith(2, null)
  325. it 'should get the project', (done) ->
  326. @handler.ensureTokensArePresent @project_id, (err, tokens) =>
  327. expect(@ProjectGetter.getProject.callCount).to.equal 1
  328. expect(@ProjectGetter.getProject.calledWith(@project_id, {tokens: 1}))
  329. .to.equal true
  330. done()
  331. it 'should update the project with new tokens', (done) ->
  332. @handler.ensureTokensArePresent @project_id, (err, tokens) =>
  333. expect(@ProjectTokenGenerator.generateUniqueReadOnlyToken.callCount)
  334. .to.equal 1
  335. expect(@ProjectTokenGenerator.readAndWriteToken.callCount)
  336. .to.equal 1
  337. expect(@ProjectModel.update.callCount).to.equal 1
  338. expect(@ProjectModel.update.calledWith(
  339. {_id: @project_id},
  340. {
  341. $set: {
  342. tokens: {
  343. readOnly: @readOnlyToken,
  344. readAndWrite: @readAndWriteToken,
  345. readAndWritePrefix: @readAndWriteTokenPrefix
  346. }
  347. }
  348. }
  349. )).to.equal true
  350. done()
  351. it 'should produce the tokens without error', (done) ->
  352. @handler.ensureTokensArePresent @project_id, (err, tokens) =>
  353. expect(err).to.not.exist
  354. expect(tokens).to.deep.equal {
  355. readOnly: @readOnlyToken,
  356. readAndWrite: @readAndWriteToken,
  357. readAndWritePrefix: @readAndWriteTokenPrefix
  358. }
  359. done()