Add update cell content method to rtu client (#150)

* Add update cell content method to rtu client

* add replace cell content method

* fix syntax

* fix changelog

* tests

Author: Matt Kafonek

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 For pre-1.0 releases, see [0.0.35 Changelog](https://github.com/noteable-io/origami/blob/0.0.35/CHANGELOG.md)
 
 ## [Unreleased]
+### Added
+- `rtu_client.update_cell_content` that takes cell id and a diff-match-patch patch str
 
 ### Changed
 - Temporary guard against invalid `rtu_client_type` names when initiating `APIClient`

origami/clients/rtu.py

@@ -17,6 +17,7 @@
 from sending.backends.websocket import WebsocketManager
 from websockets.client import WebSocketClientProtocol
 
+from origami.models.deltas.delta_types.cell_contents import CellContentsReplace, CellContentsUpdate
 from origami.models.deltas.delta_types.cell_execute import (
     CellExecute,
     CellExecuteAfter,
@@ -822,6 +823,30 @@ async def change_cell_type(
         _, cell = self.builder.get_cell(cell_id)
         return cell
 
+    async def update_cell_content(self, cell_id: str, patch: str) -> NotebookCell:
+        """
+        Update cell content with a diff-match-patch patch string
+        """
+        delta = CellContentsUpdate(
+            file_id=self.file_id, resource_id=cell_id, properties={'patch': patch}
+        )
+        await self.new_delta_request(delta)
+        # Grab updated cell post-squashing
+        _, cell = self.builder.get_cell(cell_id)
+        return cell
+
+    async def replace_cell_content(self, cell_id: str, source: str) -> NotebookCell:
+        """
+        Replace cell content with a string
+        """
+        delta = CellContentsReplace(
+            file_id=self.file_id, resource_id=cell_id, properties={'source': source}
+        )
+        await self.new_delta_request(delta)
+        # Grab updated cell post-squashing
+        _, cell = self.builder.get_cell(cell_id)
+        return cell
+
     async def queue_execution(
         self,
         cell_id: Optional[str] = None,

tests/e2e/rtu/test_notebook.py

@@ -13,37 +13,73 @@ async def test_add_and_remove_cell(api_client: APIClient, notebook_maker):
     # TODO: remove sleep when Gate stops permission denied on newly created files (db time-travel)
     await asyncio.sleep(2)
     rtu_client: RTUClient = await api_client.connect_realtime(file)
-    assert rtu_client.builder.nb.cells == []
+    try:
+        assert rtu_client.builder.nb.cells == []
 
-    cell = await rtu_client.add_cell(source='print("hello world")')
-    assert cell.cell_type == 'code'
-    assert cell.id in rtu_client.cell_ids
+        cell = await rtu_client.add_cell(source='print("hello world")')
+        assert cell.cell_type == 'code'
+        assert cell.id in rtu_client.cell_ids
 
-    await rtu_client.delete_cell(cell.id)
-    with pytest.raises(CellNotFound):
-        rtu_client.builder.get_cell(cell.id)
-
-    await rtu_client.shutdown()
+        await rtu_client.delete_cell(cell.id)
+        with pytest.raises(CellNotFound):
+            rtu_client.builder.get_cell(cell.id)
+    finally:
+        await rtu_client.shutdown()
 
 
 async def test_change_cell_type(api_client: APIClient, notebook_maker):
     file: File = await notebook_maker()
     # TODO: remove sleep when Gate stops permission denied on newly created files (db time-travel)
     await asyncio.sleep(2)
     rtu_client: RTUClient = await api_client.connect_realtime(file)
-    assert rtu_client.builder.nb.cells == []
+    try:
+        assert rtu_client.builder.nb.cells == []
+
+        source_cell = await rtu_client.add_cell(source='1 + 1')
+        _, cell = rtu_client.builder.get_cell(source_cell.id)
+        assert cell.cell_type == 'code'
+
+        await rtu_client.change_cell_type(cell.id, 'markdown')
+        _, cell = rtu_client.builder.get_cell(source_cell.id)
+        assert cell.cell_type == 'markdown'
+
+        await rtu_client.change_cell_type(cell.id, 'sql')
+        _, cell = rtu_client.builder.get_cell(source_cell.id)
+        assert cell.cell_type == 'code'
+        assert cell.is_sql_cell
+    finally:
+        await rtu_client.shutdown()
+
+
+async def test_update_cell_content(api_client: APIClient, notebook_maker):
+    file: File = await notebook_maker()
+    # TODO: remove sleep when Gate stops permission denied on newly created files (db time-travel)
+    await asyncio.sleep(2)
+    rtu_client: RTUClient = await api_client.connect_realtime(file)
+    try:
+        assert rtu_client.builder.nb.cells == []
+
+        source_cell = await rtu_client.add_cell(source='1 + 1')
+        _, cell = rtu_client.builder.get_cell(source_cell.id)
+
+        cell = await rtu_client.update_cell_content(cell.id, '@@ -1,5 +1,5 @@\n-1 + 1\n+2 + 2\n')
+        assert cell.source == '2 + 2'
+    finally:
+        await rtu_client.shutdown()
 
-    source_cell = await rtu_client.add_cell(source='1 + 1')
-    _, cell = rtu_client.builder.get_cell(source_cell.id)
-    assert cell.cell_type == 'code'
 
-    await rtu_client.change_cell_type(cell.id, 'markdown')
-    _, cell = rtu_client.builder.get_cell(source_cell.id)
-    assert cell.cell_type == 'markdown'
+async def test_replace_cell_content(api_client: APIClient, notebook_maker):
+    file: File = await notebook_maker()
+    # TODO: remove sleep when Gate stops permission denied on newly created files (db time-travel)
+    await asyncio.sleep(2)
+    rtu_client: RTUClient = await api_client.connect_realtime(file)
+    try:
+        assert rtu_client.builder.nb.cells == []
 
-    await rtu_client.change_cell_type(cell.id, 'sql')
-    _, cell = rtu_client.builder.get_cell(source_cell.id)
-    assert cell.cell_type == 'code'
-    assert cell.is_sql_cell
+        source_cell = await rtu_client.add_cell(source='1 + 1')
+        _, cell = rtu_client.builder.get_cell(source_cell.id)
 
-    await rtu_client.shutdown()
+        cell = await rtu_client.replace_cell_content(cell.id, '2 + 2')
+        assert cell.source == '2 + 2'
+    finally:
+        await rtu_client.shutdown()