Where/how to set collaborative_document_save_delay

[ellisonbg]

Trying to figure out how to set the collaborative_document_save_delay property, but don't see how to do that. I would expect it to be a configurable trait, but haven't found that anywhere. Is there information about how to set this, or can you point to the relevant code that defines this trait?

[welcome]

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.

You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

[davidbrochart]

It has to be added somewhere here and there.
cc @hbcarlos who introduced this property.

[ellisonbg]

Not sure I follow. Is this not implemented currently? If not, what is the current behavior (often are documents written to disk?)

…

On Mon, Nov 7, 2022 at 1:16 PM David Brochart ***@***.***> wrote: It has to be added somewhere here <https://github.com/jupyterlab/jupyterlab/blob/288b7f79abb3eaca9b7db4d416a5fbdee7cf13cb/jupyterlab/labapp.py#L574> and there <https://github.com/jupyterlab/jupyterlab/blob/288b7f79abb3eaca9b7db4d416a5fbdee7cf13cb/jupyterlab/labapp.py#L818> . cc @hbcarlos <https://github.com/hbcarlos> who introduced this property. — Reply to this email directly, view it on GitHub <#47 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAGXUCO7RJTFPA3KHENTI3WHFWRNANCNFSM6AAAAAARZTLTRQ> . You are receiving this because you authored the thread.Message ID: ***@***.***>

-- Brian E. Granger Senior Principal Technologist, AWS AI/ML ***@***.***) On Leave - Professor of Physics and Data Science, Cal Poly @ellisonbg on GitHub

[ellisonbg]

If I understand this code here, it looks like the file will never be saved to disk? https://github.com/jupyter-server/jupyter_server_ydoc/blob/main/jupyter_server_ydoc/ydoc.py#L261

…

On Mon, Nov 7, 2022 at 4:23 PM Brian Granger ***@***.***> wrote: Not sure I follow. Is this not implemented currently? If not, what is the current behavior (often are documents written to disk?) On Mon, Nov 7, 2022 at 1:16 PM David Brochart ***@***.***> wrote: > It has to be added somewhere here > <https://github.com/jupyterlab/jupyterlab/blob/288b7f79abb3eaca9b7db4d416a5fbdee7cf13cb/jupyterlab/labapp.py#L574> > and there > <https://github.com/jupyterlab/jupyterlab/blob/288b7f79abb3eaca9b7db4d416a5fbdee7cf13cb/jupyterlab/labapp.py#L818> > . > cc @hbcarlos <https://github.com/hbcarlos> who introduced this property. > > — > Reply to this email directly, view it on GitHub > <#47 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AAAGXUCO7RJTFPA3KHENTI3WHFWRNANCNFSM6AAAAAARZTLTRQ> > . > You are receiving this because you authored the thread.Message ID: > ***@***.***> > -- Brian E. Granger Senior Principal Technologist, AWS AI/ML ***@***.***) On Leave - Professor of Physics and Data Science, Cal Poly @ellisonbg on GitHub

-- Brian E. Granger Senior Principal Technologist, AWS AI/ML ***@***.***) On Leave - Professor of Physics and Data Science, Cal Poly @ellisonbg on GitHub

[ellisonbg]

Context: we are trying to debug some performance issues with RTC and are trying to understand if it is related to saving to disk. To help debug that, we would like to change the saving frequency or turn it off.

[davidbrochart]

Not sure I follow. Is this not implemented currently? If not, what is the current behavior (often are documents written to disk?)

It was hard-coded to 1 second before this PR. The PR was released as 0.2.0, so that it doesn't affect JupyterLab's 3.6 or 4.

[hbcarlos]

Hi @ellisonbg. I added collaborative_document_save_delay to control the saving delay because it was necessary for the RTC UI tests (this PR: jupyterlab/jupyterlab#13240).

As @davidbrochart said, we released jupyter_server_ydoc v0.2.0 with this new configuration, and JupyterLab is still using v0.1, so it should not be a problem.

I'm adding this configuration as a trait in JupyterLab here jupyterlab/jupyterlab@560e304, but It is not merged yet.

[davidbrochart]

@hbcarlos can you point to the PR for this change?
I cannot find it and I wanted to comment on it.

[hbcarlos]

@davidbrochart is this one: jupyterlab/jupyterlab#13240

And the docstring of the trait is already fixed.

[davidbrochart]

Thanks, I just left minor comments.