UpdateTranslatorTests.js 31 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211
  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. blobHashes: { file: 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. blobHashes: { file: 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. blobHashes: { file: 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. blobHashes: { file: 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. blobHashes: { file: 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. blobHashes: { file: 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. blobHashes: { file: 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. blobHashes: { file: 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. blobHashes: { file: 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('should translate retains without tracking data', function () {
  528. const updates = [
  529. {
  530. update: {
  531. doc: this.doc_id,
  532. op: [
  533. {
  534. p: 3,
  535. r: 'lo',
  536. },
  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. [this.doc_id]: {
  565. pathname: 'main.tex',
  566. v: 0,
  567. },
  568. },
  569. },
  570. ])
  571. })
  572. it('can translate retains with tracking data', function () {
  573. const updates = [
  574. {
  575. update: {
  576. doc: this.doc_id,
  577. op: [
  578. {
  579. p: 3,
  580. r: 'lo',
  581. tracking: { type: 'none' },
  582. },
  583. ],
  584. v: this.version,
  585. meta: {
  586. user_id: this.user_id,
  587. ts: new Date(this.timestamp).getTime(),
  588. pathname: '/main.tex',
  589. doc_length: 20,
  590. },
  591. },
  592. },
  593. ]
  594. const changes = this.UpdateTranslator.convertToChanges(
  595. this.project_id,
  596. updates
  597. ).map(change => change.toRaw())
  598. expect(changes).to.deep.equal([
  599. {
  600. authors: [],
  601. operations: [
  602. {
  603. pathname: 'main.tex',
  604. textOperation: [
  605. 3,
  606. {
  607. r: 2,
  608. tracking: { type: 'none' },
  609. },
  610. 15,
  611. ],
  612. },
  613. ],
  614. v2Authors: [this.user_id],
  615. timestamp: this.timestamp,
  616. v2DocVersions: {
  617. '59bfd450e3028c4d40a1e9ab': {
  618. pathname: 'main.tex',
  619. v: 0,
  620. },
  621. },
  622. },
  623. ])
  624. })
  625. it('can translate insertions at the start and end (with zero retained)', function () {
  626. const updates = [
  627. {
  628. update: {
  629. doc: this.doc_id,
  630. op: [
  631. { p: 0, i: 'foo' },
  632. { p: 23, i: 'bar' },
  633. { p: 0, d: 'foo' },
  634. { p: 20, d: 'bar' },
  635. ],
  636. v: this.version,
  637. meta: {
  638. user_id: this.user_id,
  639. ts: new Date(this.timestamp).getTime(),
  640. pathname: '/main.tex',
  641. doc_length: 20,
  642. },
  643. },
  644. },
  645. ]
  646. const changes = this.UpdateTranslator.convertToChanges(
  647. this.project_id,
  648. updates
  649. ).map(change => change.toRaw())
  650. expect(changes).to.deep.equal([
  651. {
  652. authors: [],
  653. operations: [
  654. {
  655. pathname: 'main.tex',
  656. textOperation: [20],
  657. },
  658. ],
  659. v2Authors: [this.user_id],
  660. timestamp: this.timestamp,
  661. v2DocVersions: {
  662. '59bfd450e3028c4d40a1e9ab': {
  663. pathname: 'main.tex',
  664. v: 0,
  665. },
  666. },
  667. },
  668. ])
  669. })
  670. it('can handle operations in non-linear offset order', function () {
  671. const updates = [
  672. {
  673. update: {
  674. doc: this.doc_id,
  675. op: [
  676. { p: 15, i: 'foo' },
  677. { p: 3, i: 'bar' },
  678. ],
  679. v: this.version,
  680. meta: {
  681. user_id: this.user_id,
  682. ts: this.timestamp,
  683. pathname: '/main.tex',
  684. doc_length: 20,
  685. },
  686. },
  687. },
  688. ]
  689. const changes = this.UpdateTranslator.convertToChanges(
  690. this.project_id,
  691. updates
  692. ).map(change => change.toRaw())
  693. expect(changes).to.deep.equal([
  694. {
  695. authors: [],
  696. operations: [
  697. {
  698. pathname: 'main.tex',
  699. textOperation: [3, 'bar', 12, 'foo', 5],
  700. },
  701. ],
  702. v2Authors: [this.user_id],
  703. timestamp: this.timestamp,
  704. v2DocVersions: {
  705. '59bfd450e3028c4d40a1e9ab': {
  706. pathname: 'main.tex',
  707. v: 0,
  708. },
  709. },
  710. },
  711. ])
  712. })
  713. it('handles comment ops', function () {
  714. const updates = [
  715. {
  716. update: {
  717. doc: this.doc_id,
  718. op: [
  719. { p: 0, i: 'foo' },
  720. { p: 3, d: 'bar' },
  721. { p: 5, c: 'comment this', t: 'comment-id-1' },
  722. { p: 7, c: 'another comment', t: 'comment-id-2' },
  723. { p: 9, c: '', t: 'comment-id-3' },
  724. { p: 10, i: 'baz' },
  725. ],
  726. v: this.version,
  727. meta: {
  728. user_id: this.user_id,
  729. ts: new Date(this.timestamp).getTime(),
  730. pathname: '/main.tex',
  731. doc_length: 20,
  732. },
  733. },
  734. },
  735. ]
  736. const changes = this.UpdateTranslator.convertToChanges(
  737. this.project_id,
  738. updates
  739. ).map(change => change.toRaw())
  740. expect(changes).to.deep.equal([
  741. {
  742. authors: [],
  743. operations: [
  744. {
  745. pathname: 'main.tex',
  746. textOperation: ['foo', -3, 17],
  747. },
  748. {
  749. pathname: 'main.tex',
  750. commentId: 'comment-id-1',
  751. ranges: [{ pos: 5, length: 12 }],
  752. },
  753. {
  754. pathname: 'main.tex',
  755. commentId: 'comment-id-2',
  756. ranges: [{ pos: 7, length: 15 }],
  757. },
  758. {
  759. pathname: 'main.tex',
  760. commentId: 'comment-id-3',
  761. ranges: [],
  762. },
  763. {
  764. pathname: 'main.tex',
  765. textOperation: [10, 'baz', 10],
  766. },
  767. ],
  768. v2Authors: [this.user_id],
  769. timestamp: this.timestamp,
  770. v2DocVersions: {
  771. '59bfd450e3028c4d40a1e9ab': {
  772. pathname: 'main.tex',
  773. v: 0,
  774. },
  775. },
  776. },
  777. ])
  778. })
  779. it('handles insertions after the end of the document', function () {
  780. const updates = [
  781. {
  782. update: {
  783. doc: this.doc_id,
  784. op: [{ p: 3, i: '\\' }],
  785. v: this.version,
  786. meta: {
  787. user_id: this.user_id,
  788. ts: new Date(this.timestamp).getTime(),
  789. pathname: '/main.tex',
  790. doc_length: 2,
  791. },
  792. },
  793. },
  794. ]
  795. const changes = this.UpdateTranslator.convertToChanges(
  796. this.project_id,
  797. updates
  798. ).map(change => change.toRaw())
  799. expect(changes).to.deep.equal([
  800. {
  801. authors: [],
  802. operations: [
  803. {
  804. pathname: 'main.tex',
  805. textOperation: [2, '\\'],
  806. },
  807. ],
  808. v2Authors: [this.user_id],
  809. timestamp: this.timestamp,
  810. v2DocVersions: {
  811. '59bfd450e3028c4d40a1e9ab': {
  812. pathname: 'main.tex',
  813. v: 0,
  814. },
  815. },
  816. },
  817. ])
  818. })
  819. it('translates external source metadata into an origin', function () {
  820. const updates = [
  821. {
  822. update: {
  823. doc: this.doc_id,
  824. op: [{ p: 3, i: 'foo' }],
  825. v: this.version,
  826. meta: {
  827. user_id: this.user_id,
  828. ts: new Date(this.timestamp).getTime(),
  829. pathname: '/main.tex',
  830. doc_length: 20,
  831. type: 'external',
  832. source: 'dropbox',
  833. },
  834. },
  835. },
  836. ]
  837. const changes = this.UpdateTranslator.convertToChanges(
  838. this.project_id,
  839. updates
  840. ).map(change => change.toRaw())
  841. expect(changes).to.deep.equal([
  842. {
  843. authors: [],
  844. operations: [
  845. {
  846. pathname: 'main.tex',
  847. textOperation: [3, 'foo', 17],
  848. },
  849. ],
  850. v2Authors: [this.user_id],
  851. timestamp: this.timestamp,
  852. v2DocVersions: {
  853. '59bfd450e3028c4d40a1e9ab': {
  854. pathname: 'main.tex',
  855. v: 0,
  856. },
  857. },
  858. origin: { kind: 'dropbox' },
  859. },
  860. ])
  861. })
  862. it('errors on unexpected ops', function () {
  863. const updates = [
  864. {
  865. update: {
  866. doc: this.doc_id,
  867. op: [{ p: 5, z: 'bar' }],
  868. v: this.version,
  869. meta: {
  870. user_id: this.user_id,
  871. ts: new Date(this.timestamp).getTime(),
  872. pathname: '/main.tex',
  873. doc_length: 20,
  874. },
  875. },
  876. },
  877. ]
  878. expect(() => {
  879. this.UpdateTranslator.convertToChanges(this.project_id, updates)
  880. }).to.throw('unexpected op type')
  881. })
  882. })
  883. describe('text updates with history metadata', function () {
  884. it('handles deletes over tracked deletes', function () {
  885. const updates = [
  886. {
  887. update: {
  888. doc: this.doc_id,
  889. op: [
  890. { i: 'foo', p: 3, hpos: 5 },
  891. {
  892. d: 'quux',
  893. p: 10,
  894. hpos: 15,
  895. trackedChanges: [
  896. { type: 'delete', offset: 2, length: 3 },
  897. { type: 'delete', offset: 3, length: 1 },
  898. ],
  899. },
  900. { c: 'noteworthy', p: 8, t: 'comment-id', hpos: 11, hlen: 14 },
  901. ],
  902. v: this.version,
  903. meta: {
  904. user_id: this.user_id,
  905. ts: new Date(this.timestamp).getTime(),
  906. pathname: '/main.tex',
  907. doc_length: 20,
  908. history_doc_length: 30,
  909. source: 'some-editor-id',
  910. },
  911. },
  912. },
  913. ]
  914. const changes = this.UpdateTranslator.convertToChanges(
  915. this.project_id,
  916. updates
  917. ).map(change => change.toRaw())
  918. expect(changes).to.deep.equal([
  919. {
  920. authors: [],
  921. operations: [
  922. {
  923. pathname: 'main.tex',
  924. textOperation: [5, 'foo', 7, -2, 3, -1, 1, -1, 10],
  925. },
  926. {
  927. pathname: 'main.tex',
  928. commentId: 'comment-id',
  929. ranges: [{ pos: 11, length: 14 }],
  930. },
  931. ],
  932. v2Authors: [this.user_id],
  933. timestamp: this.timestamp,
  934. v2DocVersions: {
  935. '59bfd450e3028c4d40a1e9ab': {
  936. pathname: 'main.tex',
  937. v: 0,
  938. },
  939. },
  940. },
  941. ])
  942. })
  943. it('handles tracked delete rejections specially', function () {
  944. const updates = [
  945. {
  946. update: {
  947. doc: this.doc_id,
  948. op: [{ i: 'foo', p: 3, trackedDeleteRejection: true }],
  949. v: this.version,
  950. meta: {
  951. user_id: this.user_id,
  952. ts: new Date(this.timestamp).getTime(),
  953. pathname: '/main.tex',
  954. doc_length: 20,
  955. source: 'some-editor-id',
  956. },
  957. },
  958. },
  959. ]
  960. const changes = this.UpdateTranslator.convertToChanges(
  961. this.project_id,
  962. updates
  963. ).map(change => change.toRaw())
  964. expect(changes).to.deep.equal([
  965. {
  966. authors: [],
  967. operations: [
  968. {
  969. pathname: 'main.tex',
  970. textOperation: [
  971. 3,
  972. {
  973. r: 3,
  974. tracking: { type: 'none' },
  975. },
  976. 14,
  977. ],
  978. },
  979. ],
  980. v2Authors: [this.user_id],
  981. timestamp: this.timestamp,
  982. v2DocVersions: {
  983. '59bfd450e3028c4d40a1e9ab': {
  984. pathname: 'main.tex',
  985. v: 0,
  986. },
  987. },
  988. },
  989. ])
  990. })
  991. it('handles tracked changes', function () {
  992. const updates = [
  993. {
  994. update: {
  995. doc: this.doc_id,
  996. op: [
  997. { i: 'inserted', p: 5 },
  998. { d: 'deleted', p: 20 },
  999. { i: 'rejected deletion', p: 30, trackedDeleteRejection: true },
  1000. { d: 'rejected insertion', p: 50, u: true },
  1001. ],
  1002. v: this.version,
  1003. meta: {
  1004. tc: 'tracked-change-id',
  1005. user_id: this.user_id,
  1006. ts: new Date(this.timestamp).getTime(),
  1007. pathname: '/main.tex',
  1008. doc_length: 70,
  1009. source: 'some-editor-id',
  1010. },
  1011. },
  1012. },
  1013. ]
  1014. const changes = this.UpdateTranslator.convertToChanges(
  1015. this.project_id,
  1016. updates
  1017. ).map(change => change.toRaw())
  1018. expect(changes).to.deep.equal([
  1019. {
  1020. authors: [],
  1021. operations: [
  1022. {
  1023. pathname: 'main.tex',
  1024. textOperation: [
  1025. 5,
  1026. {
  1027. i: 'inserted',
  1028. tracking: {
  1029. type: 'insert',
  1030. userId: this.user_id,
  1031. ts: new Date(this.timestamp).toISOString(),
  1032. },
  1033. },
  1034. 7,
  1035. {
  1036. r: 7,
  1037. tracking: {
  1038. type: 'delete',
  1039. userId: this.user_id,
  1040. ts: new Date(this.timestamp).toISOString(),
  1041. },
  1042. },
  1043. 3,
  1044. {
  1045. r: 17,
  1046. tracking: { type: 'none' },
  1047. },
  1048. 3,
  1049. -18,
  1050. 10,
  1051. ],
  1052. },
  1053. ],
  1054. v2Authors: [this.user_id],
  1055. timestamp: this.timestamp,
  1056. v2DocVersions: {
  1057. '59bfd450e3028c4d40a1e9ab': {
  1058. pathname: 'main.tex',
  1059. v: 0,
  1060. },
  1061. },
  1062. },
  1063. ])
  1064. })
  1065. it('handles a delete over a mix of tracked inserts and tracked deletes', function () {
  1066. const updates = [
  1067. {
  1068. update: {
  1069. doc: this.doc_id,
  1070. op: [
  1071. {
  1072. d: 'abcdef',
  1073. p: 10,
  1074. trackedChanges: [
  1075. { type: 'insert', offset: 0, length: 3 },
  1076. { type: 'delete', offset: 2, length: 10 },
  1077. { type: 'insert', offset: 2, length: 2 },
  1078. ],
  1079. },
  1080. ],
  1081. v: this.version,
  1082. meta: {
  1083. tc: 'tracking-id',
  1084. user_id: this.user_id,
  1085. ts: new Date(this.timestamp).getTime(),
  1086. pathname: '/main.tex',
  1087. doc_length: 20,
  1088. history_doc_length: 30,
  1089. source: 'some-editor-id',
  1090. },
  1091. },
  1092. },
  1093. ]
  1094. const changes = this.UpdateTranslator.convertToChanges(
  1095. this.project_id,
  1096. updates
  1097. ).map(change => change.toRaw())
  1098. expect(changes).to.deep.equal([
  1099. {
  1100. authors: [],
  1101. operations: [
  1102. {
  1103. pathname: 'main.tex',
  1104. textOperation: [
  1105. 10,
  1106. -3,
  1107. 10,
  1108. -2,
  1109. {
  1110. r: 1,
  1111. tracking: {
  1112. type: 'delete',
  1113. userId: this.user_id,
  1114. ts: this.timestamp,
  1115. },
  1116. },
  1117. 4,
  1118. ],
  1119. },
  1120. ],
  1121. v2Authors: [this.user_id],
  1122. timestamp: this.timestamp,
  1123. v2DocVersions: {
  1124. '59bfd450e3028c4d40a1e9ab': {
  1125. pathname: 'main.tex',
  1126. v: 0,
  1127. },
  1128. },
  1129. },
  1130. ])
  1131. })
  1132. })
  1133. })
  1134. })