Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document protocol version 3.0.0 #3343

Merged

Conversation

maartenbreddels
Copy link
Member

Closes #3330

@github-actions
Copy link

Binder 👈 Launch a binder notebook on branch maartenbreddels/ipywidgets/messaging_protocol_2.1

@SylvainCorlay
Copy link
Member

We discussed this PR in the Jupyter widgets call and we think that the new protocol version number should be 3.0.

Indeed, if the backend implements this new protocol, and an old client connects to it, it will interpret echo messages as regular updates and behave accordingly, leading to wrong behavior.

@maartenbreddels
Copy link
Member Author

it's not wrong behaviour I think, it will not break (except the jitter is annoying).
Actually, a kernel implementation knows about the version number of the protocol the front end uses, so if the front end creates a COM with protocol version <2.1 we can choose not to send the echo messages, making it fully backward compatible.

@vidartf
Copy link
Member

vidartf commented Jan 17, 2022

it's not wrong behaviour I think, it will not break (except the jitter is annoying). Actually, a kernel implementation knows about the version number of the protocol the front end uses, so if the front end creates a COM with protocol version <2.1 we can choose not to send the echo messages, making it fully backward compatible.

And what do you propose we do in the case where the kernel is the one that opens the COM (which is that majority of cases)? In this case we will not know what protocol version the client has (unless I'm remembering the code wrong), so it cannot know to not send echos.

@martinRenou martinRenou changed the title Document protocol version 2.1.0 Document protocol version 3.0.0 Jan 18, 2022
@SylvainCorlay
Copy link
Member

Merging as discussed in the team call.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the widget protocol changes for echoing comm sync messages
3 participants