Add test for document dirty attribute

[davidbrochart]

No description provided.

[github-actions]

👈 Launch a Binder on branch davidbrochart/jupyter_collaboration/test-dirty

[Zsailer]

Does this sleep interval work only because the file_poll_interval trait is set to 1 by default?

If so, we might want to define a constant in this repo that is used in the trait's default_value argument and here in the test. That way, if we ever change the default in the future, we don't have to update it in multiple places.

[davidbrochart]

Agreed, I just didn't find how to do that, even with jp_configurable_serverapp. Do you have an idea?

[Zsailer]

I was just thinking we'd define a constants.py module with e.g.

# constants.py
FILE_POLL_INTERVAL = 1

and use this constant as the default value of the YDocExtension.file_poll_interval, like

# app.py
from .contants import FILE_POLL_INTERVAL

...

file_poll_interval = Float(default_value=FILE_POLL_INTERVAL
...

Then, in this unit test, do something like:

from jupyter_collaboration.constants import FILE_POLL_INTERVAL

...
await sleep(FILE_POLL_INTERVAL + 0.5)
...

[Zsailer]

I guess this isn't great either, since if we changed FILE_POLL_INTERVAL to a larger value some point in the future, it would make this test very slow.

[Zsailer]

Can you pass the configuration through the jp_server_config pytest fixture?

FILE_POLL_INTERVAL = 2

@pytest.fixture
def jp_server_config():
    return {
        "YDocExtension": {"file_poll_interval": FILE_POLL_INTERVAL}
    }

I can't remember if this config makes it to the extension or not...

[davidbrochart]

Thanks, this works and I added an rtc_document_save_delay fixture in b92aefd so that we can parameterize it.

[Zsailer]

This looks good @davidbrochart.

I added some comments, but they shouldn't block from merging.