SettingADocumentTests.coffee 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. sinon = require "sinon"
  2. chai = require("chai")
  3. chai.should()
  4. expect = require("chai").expect
  5. Settings = require('settings-sharelatex')
  6. rclient_du = require("redis-sharelatex").createClient(Settings.redis.documentupdater)
  7. Keys = Settings.redis.documentupdater.key_schema
  8. MockTrackChangesApi = require "./helpers/MockTrackChangesApi"
  9. MockWebApi = require "./helpers/MockWebApi"
  10. DocUpdaterClient = require "./helpers/DocUpdaterClient"
  11. describe "Setting a document", ->
  12. before ->
  13. @lines = ["one", "two", "three"]
  14. @version = 42
  15. @update =
  16. doc: @doc_id
  17. op: [{
  18. i: "one and a half\n"
  19. p: 4
  20. }]
  21. v: @version
  22. @result = ["one", "one and a half", "two", "three"]
  23. @newLines = ["these", "are", "the", "new", "lines"]
  24. @source = "dropbox"
  25. @user_id = "user-id-123"
  26. sinon.spy MockTrackChangesApi, "flushDoc"
  27. sinon.spy MockWebApi, "setDocument"
  28. after ->
  29. MockWebApi.setDocument.restore()
  30. MockTrackChangesApi.flushDoc.restore()
  31. describe "when the updated doc exists in the doc updater", ->
  32. before (done) ->
  33. [@project_id, @doc_id] = [DocUpdaterClient.randomId(), DocUpdaterClient.randomId()]
  34. MockWebApi.insertDoc @project_id, @doc_id, lines: @lines, version: @version
  35. DocUpdaterClient.preloadDoc @project_id, @doc_id, (error) =>
  36. throw error if error?
  37. DocUpdaterClient.sendUpdate @project_id, @doc_id, @update, (error) =>
  38. throw error if error?
  39. setTimeout () =>
  40. DocUpdaterClient.setDocLines @project_id, @doc_id, @newLines, @source, @user_id, false, (error, res, body) =>
  41. @statusCode = res.statusCode
  42. done()
  43. , 200
  44. it "should return a 204 status code", ->
  45. @statusCode.should.equal 204
  46. it "should send the updated doc lines and version to the web api", ->
  47. MockWebApi.setDocument
  48. .calledWith(@project_id, @doc_id, @newLines)
  49. .should.equal true
  50. it "should update the lines in the doc updater", (done) ->
  51. DocUpdaterClient.getDoc @project_id, @doc_id, (error, res, doc) =>
  52. doc.lines.should.deep.equal @newLines
  53. done()
  54. it "should bump the version in the doc updater", (done) ->
  55. DocUpdaterClient.getDoc @project_id, @doc_id, (error, res, doc) =>
  56. doc.version.should.equal @version + 2
  57. done()
  58. it "should leave the document in redis", (done) ->
  59. rclient_du.get Keys.docLines({doc_id: @doc_id}), (error, lines) =>
  60. throw error if error?
  61. expect(JSON.parse(lines)).to.deep.equal @newLines
  62. done()
  63. describe "when the updated doc does not exist in the doc updater", ->
  64. before (done) ->
  65. [@project_id, @doc_id] = [DocUpdaterClient.randomId(), DocUpdaterClient.randomId()]
  66. MockWebApi.insertDoc @project_id, @doc_id, {lines: @lines, version: @version}
  67. DocUpdaterClient.setDocLines @project_id, @doc_id, @newLines, @source, @user_id, false, (error, res, body) =>
  68. @statusCode = res.statusCode
  69. setTimeout done, 200
  70. it "should return a 204 status code", ->
  71. @statusCode.should.equal 204
  72. it "should send the updated doc lines to the web api", ->
  73. MockWebApi.setDocument
  74. .calledWith(@project_id, @doc_id, @newLines)
  75. .should.equal true
  76. it "should flush track changes", ->
  77. MockTrackChangesApi.flushDoc.calledWith(@doc_id).should.equal true
  78. it "should remove the document from redis", (done) ->
  79. rclient_du.get Keys.docLines({doc_id: @doc_id}), (error, lines) =>
  80. throw error if error?
  81. expect(lines).to.not.exist
  82. done()
  83. describe "with track changes", ->
  84. before ->
  85. @lines = ["one", "one and a half", "two", "three"]
  86. @id_seed = "587357bd35e64f6157"
  87. @update =
  88. doc: @doc_id
  89. op: [{
  90. d: "one and a half\n"
  91. p: 4
  92. }]
  93. meta:
  94. tc: @id_seed
  95. user_id: @user_id
  96. v: @version
  97. describe "with the undo flag", ->
  98. before (done) ->
  99. [@project_id, @doc_id] = [DocUpdaterClient.randomId(), DocUpdaterClient.randomId()]
  100. MockWebApi.insertDoc @project_id, @doc_id, {lines: @lines, version: @version}
  101. DocUpdaterClient.preloadDoc @project_id, @doc_id, (error) =>
  102. throw error if error?
  103. DocUpdaterClient.sendUpdate @project_id, @doc_id, @update, (error) =>
  104. throw error if error?
  105. # Go back to old lines, with undo flag
  106. DocUpdaterClient.setDocLines @project_id, @doc_id, @lines, @source, @user_id, true, (error, res, body) =>
  107. @statusCode = res.statusCode
  108. setTimeout done, 200
  109. it "should undo the tracked changes", (done) ->
  110. DocUpdaterClient.getDoc @project_id, @doc_id, (error, res, data) =>
  111. throw error if error?
  112. ranges = data.ranges
  113. expect(ranges.changes).to.be.undefined
  114. done()
  115. describe "without the undo flag", ->
  116. before (done) ->
  117. [@project_id, @doc_id] = [DocUpdaterClient.randomId(), DocUpdaterClient.randomId()]
  118. MockWebApi.insertDoc @project_id, @doc_id, {lines: @lines, version: @version}
  119. DocUpdaterClient.preloadDoc @project_id, @doc_id, (error) =>
  120. throw error if error?
  121. DocUpdaterClient.sendUpdate @project_id, @doc_id, @update, (error) =>
  122. throw error if error?
  123. # Go back to old lines, without undo flag
  124. DocUpdaterClient.setDocLines @project_id, @doc_id, @lines, @source, @user_id, false, (error, res, body) =>
  125. @statusCode = res.statusCode
  126. setTimeout done, 200
  127. it "should not undo the tracked changes", (done) ->
  128. DocUpdaterClient.getDoc @project_id, @doc_id, (error, res, data) =>
  129. throw error if error?
  130. ranges = data.ranges
  131. expect(ranges.changes.length).to.equal 1
  132. done()