UpdateTranslatorTests.js 29 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112
  1. import sinon from 'sinon'
  2. import { expect } from 'chai'
  3. import { strict as esmock } from 'esmock'
  4. import Core from 'overleaf-editor-core'
  5. const MODULE_PATH = '../../../../app/js/UpdateTranslator.js'
  6. describe('UpdateTranslator', function () {
  7. beforeEach(async function () {
  8. this.UpdateTranslator = await esmock(MODULE_PATH, {
  9. 'overleaf-editor-core': Core,
  10. })
  11. this.callback = sinon.stub()
  12. this.project_id = '59bfd450e3028c4d40a1e9aa'
  13. this.doc_id = '59bfd450e3028c4d40a1e9ab'
  14. this.file_id = '59bfd450e3028c4d40a1easd'
  15. this.user_id = '59bb9051abf6e8682a269b64'
  16. this.version = 0
  17. this.timestamp = new Date().toJSON()
  18. this.mockBlobHash = '12345abc12345abc12345abc12345abc12345abc'
  19. })
  20. describe('convertToChanges', function () {
  21. it('can translate doc additions', function () {
  22. const updates = [
  23. {
  24. update: {
  25. doc: this.doc_id,
  26. pathname: '/main.tex',
  27. docLines: 'a\nb',
  28. meta: {
  29. user_id: this.user_id,
  30. ts: this.timestamp,
  31. },
  32. },
  33. blobHash: this.mockBlobHash,
  34. },
  35. ]
  36. const changes = this.UpdateTranslator.convertToChanges(
  37. this.project_id,
  38. updates
  39. ).map(change => change.toRaw())
  40. expect(changes).to.deep.equal([
  41. {
  42. authors: [],
  43. operations: [
  44. {
  45. pathname: 'main.tex',
  46. file: {
  47. hash: this.mockBlobHash,
  48. },
  49. },
  50. ],
  51. v2Authors: [this.user_id],
  52. timestamp: this.timestamp,
  53. },
  54. ])
  55. })
  56. it('can translate file additions', function () {
  57. const updates = [
  58. {
  59. update: {
  60. file: this.file_id,
  61. pathname: '/test.png',
  62. url: 'filestore.example.com/test.png',
  63. meta: {
  64. user_id: this.user_id,
  65. ts: this.timestamp,
  66. },
  67. },
  68. blobHash: this.mockBlobHash,
  69. },
  70. ]
  71. const changes = this.UpdateTranslator.convertToChanges(
  72. this.project_id,
  73. updates
  74. ).map(change => change.toRaw())
  75. expect(changes).to.deep.equal([
  76. {
  77. authors: [],
  78. operations: [
  79. {
  80. pathname: 'test.png',
  81. file: {
  82. hash: this.mockBlobHash,
  83. },
  84. },
  85. ],
  86. v2Authors: [this.user_id],
  87. timestamp: this.timestamp,
  88. },
  89. ])
  90. })
  91. it('can translate doc renames', function () {
  92. const updates = [
  93. {
  94. update: {
  95. doc: this.doc_id,
  96. pathname: '/main.tex',
  97. new_pathname: '/new_main.tex',
  98. meta: {
  99. user_id: this.user_id,
  100. ts: this.timestamp,
  101. },
  102. },
  103. },
  104. ]
  105. const changes = this.UpdateTranslator.convertToChanges(
  106. this.project_id,
  107. updates
  108. ).map(change => change.toRaw())
  109. expect(changes).to.deep.equal([
  110. {
  111. authors: [],
  112. operations: [
  113. {
  114. pathname: 'main.tex',
  115. newPathname: 'new_main.tex',
  116. },
  117. ],
  118. v2Authors: [this.user_id],
  119. timestamp: this.timestamp,
  120. },
  121. ])
  122. })
  123. it('can translate file renames', function () {
  124. const updates = [
  125. {
  126. update: {
  127. file: this.file_id,
  128. pathname: '/test.png',
  129. new_pathname: '/new_test.png',
  130. meta: {
  131. user_id: this.user_id,
  132. ts: this.timestamp,
  133. },
  134. },
  135. },
  136. ]
  137. const changes = this.UpdateTranslator.convertToChanges(
  138. this.project_id,
  139. updates
  140. ).map(change => change.toRaw())
  141. expect(changes).to.deep.equal([
  142. {
  143. authors: [],
  144. operations: [
  145. {
  146. pathname: 'test.png',
  147. newPathname: 'new_test.png',
  148. },
  149. ],
  150. v2Authors: [this.user_id],
  151. timestamp: this.timestamp,
  152. },
  153. ])
  154. })
  155. it('can translate multiple updates with the correct versions', function () {
  156. const updates = [
  157. {
  158. update: {
  159. doc: this.doc_id,
  160. pathname: '/main.tex',
  161. docLines: 'a\nb',
  162. meta: {
  163. user_id: this.user_id,
  164. ts: this.timestamp,
  165. },
  166. },
  167. blobHash: this.mockBlobHash,
  168. },
  169. {
  170. update: {
  171. file: this.file_id,
  172. pathname: '/test.png',
  173. url: 'filestore.example.com/test.png',
  174. meta: {
  175. user_id: this.user_id,
  176. ts: this.timestamp,
  177. },
  178. },
  179. blobHash: this.mockBlobHash,
  180. },
  181. ]
  182. const changes = this.UpdateTranslator.convertToChanges(
  183. this.project_id,
  184. updates
  185. ).map(change => change.toRaw())
  186. expect(changes).to.deep.equal([
  187. {
  188. authors: [],
  189. operations: [
  190. {
  191. pathname: 'main.tex',
  192. file: {
  193. hash: this.mockBlobHash,
  194. },
  195. },
  196. ],
  197. v2Authors: [this.user_id],
  198. timestamp: this.timestamp,
  199. },
  200. {
  201. authors: [],
  202. operations: [
  203. {
  204. pathname: 'test.png',
  205. file: {
  206. hash: this.mockBlobHash,
  207. },
  208. },
  209. ],
  210. v2Authors: [this.user_id],
  211. timestamp: this.timestamp,
  212. },
  213. ])
  214. })
  215. it('returns an error if the update has an unknown format', function () {
  216. const updates = [
  217. {
  218. update: {
  219. foo: 'bar',
  220. },
  221. },
  222. ]
  223. expect(() =>
  224. this.UpdateTranslator.convertToChanges(this.project_id, updates)
  225. ).to.throw('update with unknown format')
  226. })
  227. it('replaces backslashes with underscores in pathnames', function () {
  228. const updates = [
  229. {
  230. update: {
  231. doc: this.doc_id,
  232. pathname: '/\\main\\foo.tex',
  233. new_pathname: '/\\new_main\\foo\\bar.tex',
  234. meta: {
  235. user_id: this.user_id,
  236. ts: this.timestamp,
  237. },
  238. },
  239. },
  240. ]
  241. const changes = this.UpdateTranslator.convertToChanges(
  242. this.project_id,
  243. updates
  244. ).map(change => change.toRaw())
  245. expect(changes).to.deep.equal([
  246. {
  247. authors: [],
  248. operations: [
  249. {
  250. pathname: '_main_foo.tex',
  251. newPathname: '_new_main_foo_bar.tex',
  252. },
  253. ],
  254. v2Authors: [this.user_id],
  255. timestamp: this.timestamp,
  256. },
  257. ])
  258. })
  259. it('replaces leading asterisks with __ASTERISK__ in pathnames', function () {
  260. const updates = [
  261. {
  262. update: {
  263. file: this.file_id,
  264. pathname: '/test*test.png',
  265. meta: {
  266. user_id: this.user_id,
  267. ts: this.timestamp,
  268. },
  269. url: 'filestore.example.com/test*test.png',
  270. },
  271. blobHash: this.mockBlobHash,
  272. },
  273. ]
  274. const changes = this.UpdateTranslator.convertToChanges(
  275. this.project_id,
  276. updates
  277. ).map(change => change.toRaw())
  278. expect(changes).to.deep.equal([
  279. {
  280. authors: [],
  281. operations: [
  282. {
  283. pathname: 'test__ASTERISK__test.png',
  284. file: {
  285. hash: this.mockBlobHash,
  286. },
  287. },
  288. ],
  289. v2Authors: [this.user_id],
  290. timestamp: this.timestamp,
  291. },
  292. ])
  293. })
  294. it('replaces a leading space for top-level files with __SPACE__', function () {
  295. const updates = [
  296. {
  297. update: {
  298. file: this.file_id,
  299. pathname: '/ test.png',
  300. meta: {
  301. user_id: this.user_id,
  302. ts: this.timestamp,
  303. },
  304. url: 'filestore.example.com/test.png',
  305. },
  306. blobHash: this.mockBlobHash,
  307. },
  308. ]
  309. const changes = this.UpdateTranslator.convertToChanges(
  310. this.project_id,
  311. updates
  312. ).map(change => change.toRaw())
  313. expect(changes).to.deep.equal([
  314. {
  315. authors: [],
  316. operations: [
  317. {
  318. pathname: '__SPACE__test.png',
  319. file: {
  320. hash: this.mockBlobHash,
  321. },
  322. },
  323. ],
  324. v2Authors: [this.user_id],
  325. timestamp: this.timestamp,
  326. },
  327. ])
  328. })
  329. it('replaces leading spaces of files in subfolders with __SPACE__', function () {
  330. const updates = [
  331. {
  332. update: {
  333. file: this.file_id,
  334. pathname: '/folder/ test.png',
  335. meta: {
  336. user_id: this.user_id,
  337. ts: this.timestamp,
  338. },
  339. url: 'filestore.example.com/folder/test.png',
  340. },
  341. blobHash: this.mockBlobHash,
  342. },
  343. ]
  344. const changes = this.UpdateTranslator.convertToChanges(
  345. this.project_id,
  346. updates
  347. ).map(change => change.toRaw())
  348. expect(changes).to.deep.equal([
  349. {
  350. authors: [],
  351. operations: [
  352. {
  353. pathname: 'folder/__SPACE__test.png',
  354. file: {
  355. hash: this.mockBlobHash,
  356. },
  357. },
  358. ],
  359. v2Authors: [this.user_id],
  360. timestamp: this.timestamp,
  361. },
  362. ])
  363. })
  364. it('sets a null author when user_id is "anonymous-user"', function () {
  365. const updates = [
  366. {
  367. update: {
  368. doc: this.doc_id,
  369. pathname: '/main.tex',
  370. docLines: 'a\nb',
  371. meta: {
  372. user_id: 'anonymous-user',
  373. ts: this.timestamp,
  374. },
  375. },
  376. blobHash: this.mockBlobHash,
  377. },
  378. ]
  379. const changes = this.UpdateTranslator.convertToChanges(
  380. this.project_id,
  381. updates
  382. ).map(change => change.toRaw())
  383. expect(changes).to.deep.equal([
  384. {
  385. authors: [],
  386. operations: [
  387. {
  388. pathname: 'main.tex',
  389. file: {
  390. hash: this.mockBlobHash,
  391. },
  392. },
  393. ],
  394. v2Authors: [null],
  395. timestamp: this.timestamp,
  396. },
  397. ])
  398. })
  399. it('sets an empty array as author when there is no meta.user_id', function () {
  400. const updates = [
  401. {
  402. update: {
  403. doc: this.doc_id,
  404. pathname: '/main.tex',
  405. docLines: 'a\nb',
  406. meta: {
  407. ts: this.timestamp,
  408. },
  409. },
  410. blobHash: this.mockBlobHash,
  411. },
  412. ]
  413. const changes = this.UpdateTranslator.convertToChanges(
  414. this.project_id,
  415. updates
  416. ).map(change => change.toRaw())
  417. expect(changes).to.deep.equal([
  418. {
  419. authors: [],
  420. operations: [
  421. {
  422. pathname: 'main.tex',
  423. file: {
  424. hash: this.mockBlobHash,
  425. },
  426. },
  427. ],
  428. v2Authors: [],
  429. timestamp: this.timestamp,
  430. },
  431. ])
  432. })
  433. describe('text updates', function () {
  434. it('can translate insertions', function () {
  435. const updates = [
  436. {
  437. update: {
  438. doc: this.doc_id,
  439. op: [
  440. { p: 3, i: 'foo' },
  441. { p: 15, i: 'bar', commentIds: ['comment1'] },
  442. ],
  443. v: this.version,
  444. meta: {
  445. user_id: this.user_id,
  446. ts: new Date(this.timestamp).getTime(),
  447. pathname: '/main.tex',
  448. doc_length: 20,
  449. source: 'some-editor-id',
  450. },
  451. },
  452. },
  453. ]
  454. const changes = this.UpdateTranslator.convertToChanges(
  455. this.project_id,
  456. updates
  457. ).map(change => change.toRaw())
  458. expect(changes).to.deep.equal([
  459. {
  460. authors: [],
  461. operations: [
  462. {
  463. pathname: 'main.tex',
  464. textOperation: [
  465. 3,
  466. 'foo',
  467. 9,
  468. { i: 'bar', commentIds: ['comment1'] },
  469. 8,
  470. ],
  471. },
  472. ],
  473. v2Authors: [this.user_id],
  474. timestamp: this.timestamp,
  475. v2DocVersions: {
  476. '59bfd450e3028c4d40a1e9ab': {
  477. pathname: 'main.tex',
  478. v: 0,
  479. },
  480. },
  481. },
  482. ])
  483. })
  484. it('can translate deletions', function () {
  485. const updates = [
  486. {
  487. update: {
  488. doc: this.doc_id,
  489. op: [
  490. { p: 3, d: 'lo' },
  491. { p: 10, d: 'bar' },
  492. ],
  493. v: this.version,
  494. meta: {
  495. user_id: this.user_id,
  496. ts: new Date(this.timestamp).getTime(),
  497. pathname: '/main.tex',
  498. doc_length: 20,
  499. },
  500. },
  501. },
  502. ]
  503. const changes = this.UpdateTranslator.convertToChanges(
  504. this.project_id,
  505. updates
  506. ).map(change => change.toRaw())
  507. expect(changes).to.deep.equal([
  508. {
  509. authors: [],
  510. operations: [
  511. {
  512. pathname: 'main.tex',
  513. textOperation: [3, -2, 7, -3, 5],
  514. },
  515. ],
  516. v2Authors: [this.user_id],
  517. timestamp: this.timestamp,
  518. v2DocVersions: {
  519. '59bfd450e3028c4d40a1e9ab': {
  520. pathname: 'main.tex',
  521. v: 0,
  522. },
  523. },
  524. },
  525. ])
  526. })
  527. it('can translate insertions at the start and end (with zero retained)', function () {
  528. const updates = [
  529. {
  530. update: {
  531. doc: this.doc_id,
  532. op: [
  533. { p: 0, i: 'foo' },
  534. { p: 23, i: 'bar' },
  535. { p: 0, d: 'foo' },
  536. { p: 20, d: 'bar' },
  537. ],
  538. v: this.version,
  539. meta: {
  540. user_id: this.user_id,
  541. ts: new Date(this.timestamp).getTime(),
  542. pathname: '/main.tex',
  543. doc_length: 20,
  544. },
  545. },
  546. },
  547. ]
  548. const changes = this.UpdateTranslator.convertToChanges(
  549. this.project_id,
  550. updates
  551. ).map(change => change.toRaw())
  552. expect(changes).to.deep.equal([
  553. {
  554. authors: [],
  555. operations: [
  556. {
  557. pathname: 'main.tex',
  558. textOperation: [20],
  559. },
  560. ],
  561. v2Authors: [this.user_id],
  562. timestamp: this.timestamp,
  563. v2DocVersions: {
  564. '59bfd450e3028c4d40a1e9ab': {
  565. pathname: 'main.tex',
  566. v: 0,
  567. },
  568. },
  569. },
  570. ])
  571. })
  572. it('can handle operations in non-linear offset order', function () {
  573. const updates = [
  574. {
  575. update: {
  576. doc: this.doc_id,
  577. op: [
  578. { p: 15, i: 'foo' },
  579. { p: 3, i: 'bar' },
  580. ],
  581. v: this.version,
  582. meta: {
  583. user_id: this.user_id,
  584. ts: this.timestamp,
  585. pathname: '/main.tex',
  586. doc_length: 20,
  587. },
  588. },
  589. },
  590. ]
  591. const changes = this.UpdateTranslator.convertToChanges(
  592. this.project_id,
  593. updates
  594. ).map(change => change.toRaw())
  595. expect(changes).to.deep.equal([
  596. {
  597. authors: [],
  598. operations: [
  599. {
  600. pathname: 'main.tex',
  601. textOperation: [3, 'bar', 12, 'foo', 5],
  602. },
  603. ],
  604. v2Authors: [this.user_id],
  605. timestamp: this.timestamp,
  606. v2DocVersions: {
  607. '59bfd450e3028c4d40a1e9ab': {
  608. pathname: 'main.tex',
  609. v: 0,
  610. },
  611. },
  612. },
  613. ])
  614. })
  615. it('handles comment ops', function () {
  616. const updates = [
  617. {
  618. update: {
  619. doc: this.doc_id,
  620. op: [
  621. { p: 0, i: 'foo' },
  622. { p: 3, d: 'bar' },
  623. { p: 5, c: 'comment this', t: 'comment-id-1' },
  624. { p: 7, c: 'another comment', t: 'comment-id-2' },
  625. { p: 10, i: 'baz' },
  626. ],
  627. v: this.version,
  628. meta: {
  629. user_id: this.user_id,
  630. ts: new Date(this.timestamp).getTime(),
  631. pathname: '/main.tex',
  632. doc_length: 20,
  633. },
  634. },
  635. },
  636. ]
  637. const changes = this.UpdateTranslator.convertToChanges(
  638. this.project_id,
  639. updates
  640. ).map(change => change.toRaw())
  641. expect(changes).to.deep.equal([
  642. {
  643. authors: [],
  644. operations: [
  645. {
  646. pathname: 'main.tex',
  647. textOperation: ['foo', -3, 17],
  648. },
  649. {
  650. pathname: 'main.tex',
  651. commentId: 'comment-id-1',
  652. ranges: [{ pos: 5, length: 12 }],
  653. resolved: false,
  654. },
  655. {
  656. pathname: 'main.tex',
  657. commentId: 'comment-id-2',
  658. ranges: [{ pos: 7, length: 15 }],
  659. resolved: false,
  660. },
  661. {
  662. pathname: 'main.tex',
  663. textOperation: [10, 'baz', 10],
  664. },
  665. ],
  666. v2Authors: [this.user_id],
  667. timestamp: this.timestamp,
  668. v2DocVersions: {
  669. '59bfd450e3028c4d40a1e9ab': {
  670. pathname: 'main.tex',
  671. v: 0,
  672. },
  673. },
  674. },
  675. ])
  676. })
  677. it('handles insertions after the end of the document', function () {
  678. const updates = [
  679. {
  680. update: {
  681. doc: this.doc_id,
  682. op: [{ p: 3, i: '\\' }],
  683. v: this.version,
  684. meta: {
  685. user_id: this.user_id,
  686. ts: new Date(this.timestamp).getTime(),
  687. pathname: '/main.tex',
  688. doc_length: 2,
  689. },
  690. },
  691. },
  692. ]
  693. const changes = this.UpdateTranslator.convertToChanges(
  694. this.project_id,
  695. updates
  696. ).map(change => change.toRaw())
  697. expect(changes).to.deep.equal([
  698. {
  699. authors: [],
  700. operations: [
  701. {
  702. pathname: 'main.tex',
  703. textOperation: [2, '\\'],
  704. },
  705. ],
  706. v2Authors: [this.user_id],
  707. timestamp: this.timestamp,
  708. v2DocVersions: {
  709. '59bfd450e3028c4d40a1e9ab': {
  710. pathname: 'main.tex',
  711. v: 0,
  712. },
  713. },
  714. },
  715. ])
  716. })
  717. it('translates external source metadata into an origin', function () {
  718. const updates = [
  719. {
  720. update: {
  721. doc: this.doc_id,
  722. op: [{ p: 3, i: 'foo' }],
  723. v: this.version,
  724. meta: {
  725. user_id: this.user_id,
  726. ts: new Date(this.timestamp).getTime(),
  727. pathname: '/main.tex',
  728. doc_length: 20,
  729. type: 'external',
  730. source: 'dropbox',
  731. },
  732. },
  733. },
  734. ]
  735. const changes = this.UpdateTranslator.convertToChanges(
  736. this.project_id,
  737. updates
  738. ).map(change => change.toRaw())
  739. expect(changes).to.deep.equal([
  740. {
  741. authors: [],
  742. operations: [
  743. {
  744. pathname: 'main.tex',
  745. textOperation: [3, 'foo', 17],
  746. },
  747. ],
  748. v2Authors: [this.user_id],
  749. timestamp: this.timestamp,
  750. v2DocVersions: {
  751. '59bfd450e3028c4d40a1e9ab': {
  752. pathname: 'main.tex',
  753. v: 0,
  754. },
  755. },
  756. origin: { kind: 'dropbox' },
  757. },
  758. ])
  759. })
  760. it('errors on unexpected ops', function () {
  761. const updates = [
  762. {
  763. update: {
  764. doc: this.doc_id,
  765. op: [{ p: 5, z: 'bar' }],
  766. v: this.version,
  767. meta: {
  768. user_id: this.user_id,
  769. ts: new Date(this.timestamp).getTime(),
  770. pathname: '/main.tex',
  771. doc_length: 20,
  772. },
  773. },
  774. },
  775. ]
  776. expect(() => {
  777. this.UpdateTranslator.convertToChanges(this.project_id, updates)
  778. }).to.throw('unexpected op type')
  779. })
  780. })
  781. describe('text updates with history metadata', function () {
  782. it('handles deletes over tracked deletes', function () {
  783. const updates = [
  784. {
  785. update: {
  786. doc: this.doc_id,
  787. op: [
  788. { i: 'foo', p: 3, hpos: 5 },
  789. {
  790. d: 'quux',
  791. p: 10,
  792. hpos: 15,
  793. trackedChanges: [
  794. { type: 'delete', offset: 2, length: 3 },
  795. { type: 'delete', offset: 3, length: 1 },
  796. ],
  797. },
  798. { c: 'noteworthy', p: 8, t: 'comment-id', hpos: 11, hlen: 14 },
  799. ],
  800. v: this.version,
  801. meta: {
  802. user_id: this.user_id,
  803. ts: new Date(this.timestamp).getTime(),
  804. pathname: '/main.tex',
  805. doc_length: 20,
  806. history_doc_length: 30,
  807. source: 'some-editor-id',
  808. },
  809. },
  810. },
  811. ]
  812. const changes = this.UpdateTranslator.convertToChanges(
  813. this.project_id,
  814. updates
  815. ).map(change => change.toRaw())
  816. expect(changes).to.deep.equal([
  817. {
  818. authors: [],
  819. operations: [
  820. {
  821. pathname: 'main.tex',
  822. textOperation: [5, 'foo', 7, -2, 3, -1, 1, -1, 10],
  823. },
  824. {
  825. pathname: 'main.tex',
  826. commentId: 'comment-id',
  827. ranges: [{ pos: 11, length: 14 }],
  828. resolved: false,
  829. },
  830. ],
  831. v2Authors: [this.user_id],
  832. timestamp: this.timestamp,
  833. v2DocVersions: {
  834. '59bfd450e3028c4d40a1e9ab': {
  835. pathname: 'main.tex',
  836. v: 0,
  837. },
  838. },
  839. },
  840. ])
  841. })
  842. it('handles tracked delete rejections specially', function () {
  843. const updates = [
  844. {
  845. update: {
  846. doc: this.doc_id,
  847. op: [{ i: 'foo', p: 3, trackedDeleteRejection: true }],
  848. v: this.version,
  849. meta: {
  850. user_id: this.user_id,
  851. ts: new Date(this.timestamp).getTime(),
  852. pathname: '/main.tex',
  853. doc_length: 20,
  854. source: 'some-editor-id',
  855. },
  856. },
  857. },
  858. ]
  859. const changes = this.UpdateTranslator.convertToChanges(
  860. this.project_id,
  861. updates
  862. ).map(change => change.toRaw())
  863. expect(changes).to.deep.equal([
  864. {
  865. authors: [],
  866. operations: [
  867. {
  868. pathname: 'main.tex',
  869. textOperation: [
  870. 3,
  871. {
  872. r: 3,
  873. tracking: {
  874. type: 'none',
  875. userId: this.user_id,
  876. ts: new Date(this.timestamp).toISOString(),
  877. },
  878. },
  879. 14,
  880. ],
  881. },
  882. ],
  883. v2Authors: [this.user_id],
  884. timestamp: this.timestamp,
  885. v2DocVersions: {
  886. '59bfd450e3028c4d40a1e9ab': {
  887. pathname: 'main.tex',
  888. v: 0,
  889. },
  890. },
  891. },
  892. ])
  893. })
  894. it('handles tracked changes', function () {
  895. const updates = [
  896. {
  897. update: {
  898. doc: this.doc_id,
  899. op: [
  900. { i: 'inserted', p: 5 },
  901. { d: 'deleted', p: 20 },
  902. { i: 'rejected deletion', p: 30, trackedDeleteRejection: true },
  903. { d: 'rejected insertion', p: 50, u: true },
  904. ],
  905. v: this.version,
  906. meta: {
  907. tc: 'tracked-change-id',
  908. user_id: this.user_id,
  909. ts: new Date(this.timestamp).getTime(),
  910. pathname: '/main.tex',
  911. doc_length: 70,
  912. source: 'some-editor-id',
  913. },
  914. },
  915. },
  916. ]
  917. const changes = this.UpdateTranslator.convertToChanges(
  918. this.project_id,
  919. updates
  920. ).map(change => change.toRaw())
  921. expect(changes).to.deep.equal([
  922. {
  923. authors: [],
  924. operations: [
  925. {
  926. pathname: 'main.tex',
  927. textOperation: [
  928. 5,
  929. {
  930. i: 'inserted',
  931. tracking: {
  932. type: 'insert',
  933. userId: this.user_id,
  934. ts: new Date(this.timestamp).toISOString(),
  935. },
  936. },
  937. 7,
  938. {
  939. r: 7,
  940. tracking: {
  941. type: 'delete',
  942. userId: this.user_id,
  943. ts: new Date(this.timestamp).toISOString(),
  944. },
  945. },
  946. 3,
  947. {
  948. r: 17,
  949. tracking: {
  950. type: 'none',
  951. userId: this.user_id,
  952. ts: new Date(this.timestamp).toISOString(),
  953. },
  954. },
  955. 3,
  956. -18,
  957. 10,
  958. ],
  959. },
  960. ],
  961. v2Authors: [this.user_id],
  962. timestamp: this.timestamp,
  963. v2DocVersions: {
  964. '59bfd450e3028c4d40a1e9ab': {
  965. pathname: 'main.tex',
  966. v: 0,
  967. },
  968. },
  969. },
  970. ])
  971. })
  972. it('handles a delete over a mix of tracked inserts and tracked deletes', function () {
  973. const updates = [
  974. {
  975. update: {
  976. doc: this.doc_id,
  977. op: [
  978. {
  979. d: 'abcdef',
  980. p: 10,
  981. trackedChanges: [
  982. { type: 'insert', offset: 0, length: 3 },
  983. { type: 'delete', offset: 2, length: 10 },
  984. { type: 'insert', offset: 2, length: 2 },
  985. ],
  986. },
  987. ],
  988. v: this.version,
  989. meta: {
  990. tc: 'tracking-id',
  991. user_id: this.user_id,
  992. ts: new Date(this.timestamp).getTime(),
  993. pathname: '/main.tex',
  994. doc_length: 20,
  995. history_doc_length: 30,
  996. source: 'some-editor-id',
  997. },
  998. },
  999. },
  1000. ]
  1001. const changes = this.UpdateTranslator.convertToChanges(
  1002. this.project_id,
  1003. updates
  1004. ).map(change => change.toRaw())
  1005. expect(changes).to.deep.equal([
  1006. {
  1007. authors: [],
  1008. operations: [
  1009. {
  1010. pathname: 'main.tex',
  1011. textOperation: [
  1012. 10,
  1013. -3,
  1014. 10,
  1015. -2,
  1016. {
  1017. r: 1,
  1018. tracking: {
  1019. type: 'delete',
  1020. userId: this.user_id,
  1021. ts: this.timestamp,
  1022. },
  1023. },
  1024. 4,
  1025. ],
  1026. },
  1027. ],
  1028. v2Authors: [this.user_id],
  1029. timestamp: this.timestamp,
  1030. v2DocVersions: {
  1031. '59bfd450e3028c4d40a1e9ab': {
  1032. pathname: 'main.tex',
  1033. v: 0,
  1034. },
  1035. },
  1036. },
  1037. ])
  1038. })
  1039. })
  1040. })
  1041. })