Add more tests

Author: davidbrochart

.github/workflows/test.yml

@@ -35,6 +35,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14' ]
     defaults:
       run:
         shell: bash -l {0}
@@ -48,7 +49,7 @@ jobs:
       - name: Install dependencies
         run: |
           micromamba install pip nodejs=18
-          pip install ".[test]"
+          pip install . --group test
       - name: Build JavaScript assets
         working-directory: javascript
         run: |
@@ -76,5 +77,11 @@ jobs:
           yarn build:test
           yarn test:cov
       - name: Run Python tests
+        if: ${{ !((matrix.python-version == '3.14') && (matrix.os == 'ubuntu-latest')) }}
         run: |
           python -m pytest -v
+      - name: Run Python code coverage
+        if: ${{ (matrix.python-version == '3.14') && (matrix.os == 'ubuntu-latest') }}
+        run: |
+          coverage run -m pytest -v
+          coverage report --show-missing

README.md

@@ -30,8 +30,6 @@ Which is just a shortcut to:
 
 ```py
 from importlib.metadata import entry_points
-# for Python < 3.10, install importlib_metadata and do:
-# from importlib_metadata import entry_points
 
 ydocs = {ep.name: ep.load() for ep in entry_points(group="jupyter_ydoc")}
 ```

jupyter_ydoc/__init__.py

@@ -1,19 +1,12 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-import sys
-
 from ._version import __version__ as __version__
 from .yblob import YBlob as YBlob
 from .yfile import YFile as YFile
 from .ynotebook import YNotebook as YNotebook
 from .yunicode import YUnicode as YUnicode
 
-# See compatibility note on `group` keyword in
-# https://docs.python.org/3/library/importlib.metadata.html#entry-points
-if sys.version_info < (3, 10):
-    from importlib_metadata import entry_points
-else:
-    from importlib.metadata import entry_points
+from importlib.metadata import entry_points
 
 ydocs = {ep.name: ep.load() for ep in entry_points(group="jupyter_ydoc")}

jupyter_ydoc/yblob.py

@@ -64,6 +64,9 @@ def set(self, value: bytes) -> None:
         :param value: The content of the document.
         :type value: bytes
         """
+        if self.get() == value:
+            return
+
         self._ysource["bytes"] = value
 
     def observe(self, callback: Callable[[str, Any], None]) -> None:

jupyter_ydoc/yunicode.py

@@ -67,6 +67,7 @@ def set(self, value: str) -> None:
             # no-op if the values are already the same,
             # to avoid side-effects such as cursor jumping to the top
             return
+
         with self._ydoc.transaction():
             # clear document
             self._ysource.clear()

pyproject.toml

@@ -9,18 +9,17 @@ build-backend = "hatchling.build"
 name = "jupyter-ydoc"
 dynamic = ["version"]
 description = "Document structures for collaborative editing using Ypy"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 keywords = ["jupyter", "pycrdt", "yjs"]
 dependencies = [
-    "importlib_metadata >=3.6; python_version<'3.10'",
     "pycrdt >=0.10.1,<0.13.0",
 ]
 
 [[project.authors]]
 name = "Jupyter Development Team"
 email = "[email protected]"
 
-[project.optional-dependencies]
+[dependency-groups]
 dev = [
     "click",
     "jupyter_releaser",
@@ -33,6 +32,7 @@ test = [
     "httpx-ws >=0.5.2",
     "hypercorn >=0.16.0",
     "pycrdt-websocket >=0.16.0,<0.17.0",
+    "coverage >=7.12.0,<8",
 ]
 docs = [
     "sphinx",

tests/conftest.py

@@ -63,5 +63,5 @@ def yjs_client(request):
     p.terminate()
     try:
         p.wait(timeout=10)
-    except Exception:
+    except Exception:  # pragma: nocover
         p.kill()

tests/test_pycrdt_yjs.py

@@ -5,7 +5,7 @@
 from pathlib import Path
 
 import pytest
-from anyio import Event, create_task_group, move_on_after
+from anyio import Event, create_task_group, fail_after, move_on_after, sleep
 from httpx_ws import aconnect_ws
 from pycrdt import Doc, Map, Provider
 from utils import Websocket
@@ -90,17 +90,12 @@ async def test_ypy_yjs_1(yws_server, yjs_client):
     ):
         output_text = ynotebook.ycells[0]["outputs"][0]["text"]
         assert output_text.to_py() == "Hello,"
-        event = Event()
 
-        def callback(_event):
-            event.set()
-
-        output_text.observe(callback)
-
-        with move_on_after(10):
-            await event.wait()
-
-        assert output_text.to_py() == "Hello,", " World!"
+        with fail_after(10):
+            while True:
+                await sleep(0.1)
+                if output_text.to_py() == "Hello, World!":
+                    break
 
 
 def test_plotly_renderer():

tests/test_yblob.py

@@ -0,0 +1,29 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+from jupyter_ydoc import YBlob
+
+
+def test_set_no_op_if_unchanged():
+    blob = YBlob()
+
+    assert blob.version == "2.0.0"
+
+    content0 = b"012"
+    blob.set(content0)
+
+    changes = []
+
+    def record_changes(topic, event):
+        changes.append((topic, event))  # pragma: nocover
+
+    blob.observe(record_changes)
+
+    content1 = blob.get()
+    assert content0 == content1
+
+    # Call set with identical content
+    blob.set(content0)
+
+    # No changes should be observed at all
+    assert changes == []

tests/test_ynotebook.py

@@ -26,12 +26,15 @@ def __eq__(self, other):
 
 def test_set_preserves_cells_when_unchanged():
     nb = YNotebook()
+
+    assert nb.version == "2.0.0"
+
     nb.set({"cells": [make_code_cell("print('a')\n"), make_code_cell("print('b')\n")]})
 
     changes = []
 
     def record_changes(topic, event):
-        changes.append((topic, event))
+        changes.append((topic, event))  # pragma: nocover
 
     nb.observe(record_changes)