Initialize and update the ydoc path property

[brichet]

This PR fixes #341

NOTE:

In this implementation, the document is reloaded when the path change, as if the file content has changed.
Another approach could be to add a listener on the path only in the FileLoader, which only update the path property of the ydoc on change.

[github-actions]

👈 Launch a Binder on branch brichet/jupyter_collaboration/ydoc_file_path

[krassowski]

which only update the path property of the ydoc on change

I feel like that would be a better approach, as any reloading from disk is a risk of race condition in RTC context, right?

[davidbrochart]

Thanks @brichet.
I tried to rename an opened file out-of-band, and it seems to crash?

[brichet]

Thanks @brichet. I tried to rename an opened file out-of-band, and it seems to crash?

Yes, it doesn't fix the issue on renaming the file out-of-band. It works when renaming the file using jupyterlab.
The issue you mentioned is related to jupyter_server_fileid: jupyter-server/jupyter_server_fileid#80

[brichet]

which only update the path property of the ydoc on change

I feel like that would be a better approach, as any reloading from disk is a risk of race condition in RTC context, right?

Any opinion on how to do it ?

The 2 options I can see are:

• adding new methods, something like path_observer() and path_unobserver()
• adding an optional argument (Callable) to the current observe() method

[davidbrochart]

I think you can now remove the note in the top comment?

[davidbrochart]

Thanks @brichet.

[brichet]

Is it expected that the new test fails in the context of Test Minimal Versions and test Prerelease ?

[davidbrochart]

You should be able to reproduce with Test Minimal Versions's environment on you side?

[brichet]

You should be able to reproduce with Test Minimal Versions's environment on you side?

It works on my side with python 3.8

[davidbrochart]

I think it's not only Python, but all dependencies. You can probably use uv for installing minimal versions.

[brichet]

I think it's not only Python, but all dependencies. You can probably use uv for installing minimal versions.

Not sure about that, I checked the packages and they are similar to mine.
However, I wonder if there is not an issue with the collaboration python package versions:
Using cached jupyter_server_ydoc-1.0.0b1-py3-none-any.whl

It should be the jupyter_server_ydoc-1.0.0b3 if it was the current dev install, no ?

[krassowski]

Huh:

jupyter-collaboration/projects/jupyter-collaboration/pyproject.toml

Lines 32 to 35 in b8fafc0

	dependencies = [
	"jupyter-server-ydoc>=1.0.0b1",
	"jupyter-collaboration-ui>=1.0.0b1",
	"jupyter-docprovider>=1.0.0b1"

jupyter-collaboration/projects/jupyter-collaboration/pyproject.toml

Line 3 in b8fafc0

dependencies = ["jupyter_collaboration>=3.0.0b3", "jupyter_collaboration_ui>=1.0.0b3", "jupyter_docprovider>=1.0.0b3", "jupyter_server_ydoc>=1.0.0b3"]

I thought I fixed it with #335 but clearly it did not work as intended and instead of replacing the old ones just added a new line on top:

which means the last one gets used

[davidbrochart]

Maybe exclude scripts/bump_version.py for mypy in pyproject.toml?

[tool.mypy]
exclude=[
    "^binder/jupyter_config\\.py$",
    "^scripts/bump_version\\.py$",
    "/setup\\.py$",
]

[brichet]

Maybe exclude scripts/bump_version.py for mypy in pyproject.toml?

Thanks @davidbrochart.

Maybe we could exclude it, but do you know why it fails in this PR ? It seems to pass on recent ones...

[davidbrochart]

do you know why it fails in this PR ? It seems to pass on recent ones...

I don't know, I've seen that in other repos too.

[brichet]

And it seems there are some other issue after the release:
Using cached jupyter_collaboration_ui-1.0.0b3-py3-none-any.whl, it should be 1.0.0b6 I think.

I will first remove the test to be able to merge this one.

[davidbrochart]

It looks like check-links is still failing, but let's merge this one.

[brichet]

It looks like check-links is still failing, but let's merge this one.

Yes, it is not related