Create basic comm API shim for jupyter-js-services #264

jdfreder · 2015-12-08T21:28:36Z

Here's a simple shim that allows use of jupyter-js-services via the old comm API.

shim
test it / create an example

parente · 2015-12-08T21:36:43Z

Sweet. Thanks for jumping on this. Definitely looks like what I was envisioning.

So on our end we'd have to instantiate and pass the shim to the WidgetManager, plus alias the services/kernels/comm module import here (https://github.com/ipython/ipywidgets/blob/master/ipywidgets/static/widgets/js/manager.js#L8) so that the shim gets imported. I think.

/cc @lbustelo, @dalogsdon @jhpedemonte who are all closer to widgets / dahsboards JS than I have been

jdfreder · 2015-12-08T21:50:53Z

So on our end we'd have to instantiate and pass the shim to the WidgetManager, plus alias the services/kernels/comm module import here (https://github.com/ipython/ipywidgets/blob/master/ipywidgets/static/widgets/js/manager.js#L8) so that the shim gets imported. I think.

/cc @lbustelo, @dalogsdon @jhpedemonte who are all closer to widgets / dahsboards JS than I have bee

Actually, that's not what I was intending. The WidgetManager you reference is intended for notebook use only, it'd surely break outside of the notebook. Instead my suggestion is took take something like examples/development/web2 as a starting point, and use jupyter-js-services to add backend support. Right now that example only has widgets without live comms.

I'll add another example to this PR clarifying what I mean and demonstrating jupyter-js-services powered widgets outside of the notebook.

this is required to make the relative paths work correctly.

jdfreder · 2015-12-09T00:59:10Z

This is ready to go now! See ipywidgets/examples/development/web3

cc @SylvainCorlay

rgbkrk · 2015-12-09T01:04:30Z

yeah this is awesome

blink1073 · 2015-12-09T01:07:49Z

Looks like you had to poke into the private API, feel free to push back on what the API needs to look like.

lbustelo · 2015-12-09T01:35:20Z

Pretty awesome indeed.

Gino B.

On Dec 8, 2015, at 7:04 PM, Kyle Kelley [email protected] wrote:

yeah this is awesome

—
Reply to this email directly or view it on GitHub.

parente · 2015-12-09T02:03:12Z

@lbustelo and I poked around earlier while you were working up the new demo. Totally get it now. Implement a subclass of the base widget manager. Instantiate the shim. Override the necessary methods. Away you go. Looks great.

jdfreder · 2015-12-09T03:42:49Z

Looks like you had to poke into the private API, feel free to push back on what the API needs to look like.

Thanks, I know that ipywidgets actually uses some of the private methods of the old API too. The private methods used in the shim may not be essential. I'll have to dig deeper into the code to remember what the reasoning was for creating comms that are unregistered and unknown to the manager (the kernel, in jupyter-js-services's case). It may be that no changes are needed to the new API when I drop the old comm API completely.

jdfreder · 2015-12-09T03:44:12Z

@SylvainCorlay this PR also fixes some hiccups introduced in the examples by #261

SylvainCorlay · 2015-12-09T03:45:29Z

@jdfreder thank you for fixing the example after #261.

If we use private APIs, this may be an indication that to expose more things in the API!

jdfreder · 2015-12-09T03:48:58Z

Actually, I just looked, we aren't using any private APIs in master right now, so we must have fixed that at some point.

SylvainCorlay · 2015-12-09T03:51:29Z

Why moving the examples directory?

jdfreder · 2015-12-09T03:54:53Z

@blink1073 the only lines that are causing me to use private APIs ATM are these: https://github.com/ipython/ipywidgets/blob/master/ipywidgets/static/widgets/js/manager.js#L260-L262 They create a comm and don't send a comm open message. Looks like the new API supports this, as connectToComm, right?

jdfreder · 2015-12-09T03:58:34Z

Why moving the examples directory?

I had trouble with it complaining about missing dev-dependencies of ipywidgets otherwise. Basically, in order for the funky relative dependency that we have to work, the sub projects have to be inside the parent project's directory.

My theory is that npm walks outwards for node_modules folders looking for binary dependencies. I found this out because I don't have tsc installed globally on my machine, and yet it's a local installed dependency of ipywidgets. If the examples were outside of the parent folder, I'd get tsc not found errors.

SylvainCorlay · 2015-12-09T14:16:10Z

Why moving the examples directory?
I had trouble with it complaining about missing dev-dependencies of ipywidgets otherwise. Basically, in order for the funky relative dependency that we have to work, the sub projects have to be inside the parent project's directory.

My theory is that npm walks outwards for node_modules folders looking for binary dependencies. I found this out because I don't have tsc installed globally on my machine, and yet it's a local installed dependency of ipywidgets. If the examples were outside of the parent folder, I'd get tsc not found errors.

It is weird because I did not have such issues with bqplot while requiring ipywidgets which was not in a parent project directory.

blink1073 · 2015-12-09T14:48:46Z

@jdfreder, connectToComm gives you a comm object, it is up to you whether to call open on it or not.

jdfreder · 2015-12-09T16:45:20Z

It is weird because I did not have such issues with bqplot while requiring ipywidgets which was not in a parent project directory.

I just double checked and it looks like I can move them back. Now I think what I was seeing earlier was caused by a separate problem, which was that I hadn't ran npm install in the widgets directory yet.

jdfreder · 2015-12-09T17:13:28Z

@jdfreder, connectToComm gives you a comm object, it is up to you whether to call open on it or not.

Awesome, I shouldn't need any private members when I make the full transition to jupyter-js-services. Also, I just checked, and the old API methods I'm emulating, that do need private members of jupyter-js-services, aren't even being used by the example, so I went ahead and removed them. There shouldn't be any more private member usage now.

blink1073 · 2015-12-09T17:45:05Z

Great, glad to hear it.

blink1073 · 2015-12-09T18:33:38Z

ipywidgets/static/widgets/js/services-shim.js

+        if (callbacks) {
+            future.onReply = function(msg) {
+                if (callbacks.shell && callbacks.shell.reply) callbacks.shell.reply(msg);
+                // TODO: Handle payloads.  See https://github.com/jupyter/notebook/blob/master/notebook/static/services/kernels/kernel.js#L923-L947


Do you think we should update KernelFuture to handle this?

Honestly, I don't think so. As you know, the channels are shell, iopub, and stdin. The payload handler acts on shell messages. In the spirit of minimal message processing at the kernel level and the 'hand the full message to the handler and allow it to decide what to do with it' thinking, it makes sense to not handle this in the kernel.

Great, that was my reasoning as well.

SylvainCorlay · 2015-12-09T20:45:01Z

Thanks for moving examples back. I have build scripts that fetch this directory and I wanted to be sure it is not moving.

Adding font-awesome's css and top-level requirement for npm

SylvainCorlay · 2015-12-09T22:13:00Z

LGTM.

…renaming

Jupyter js widgets + web example requires node-lessify

Create basic comm API shim for jupyter-js-services

jdfreder · 2015-12-09T23:32:57Z

🎉

blink1073 · 2015-12-10T00:39:20Z

Nicely done!

parente · 2015-12-10T01:58:17Z

💥 yay!

Create basic comm API shim for jupyter-js-services

250bbbc

jdfreder added the feature request label Dec 8, 2015

jdfreder added this to the 5.0 milestone Dec 8, 2015

Export

b6dad9e

jdfreder added 2 commits December 8, 2015 14:04

Move examples into ipywidgets dir,

6198c79

this is required to make the relative paths work correctly.

Upload demo of comm shim with jupyter-js-services

ec53b7a

jdfreder changed the title ~~WIP: Create basic comm API shim for jupyter-js-services~~ Create basic comm API shim for jupyter-js-services Dec 9, 2015

jdfreder added 2 commits December 9, 2015 08:47

Move tests back

4427d87

Don't use any private members of jupyter-js-services

cfbeb1b

blink1073 reviewed Dec 9, 2015
View reviewed changes

SylvainCorlay and others added 2 commits December 9, 2015 16:55

Adding font-awesome's css and top-level requirement for npm

1f884a5

Merge pull request #5 from SylvainCorlay/fontawesome

c2b8646

Adding font-awesome's css and top-level requirement for npm

SylvainCorlay and others added 2 commits December 9, 2015 17:48

Web example requires node-lessify $ ipywidgets to jupyter-js-widgets …

5f81d64

…renaming

Merge pull request #6 from SylvainCorlay/jupyter-js-widgets

d3bf9f1

Jupyter js widgets + web example requires node-lessify

SylvainCorlay added a commit that referenced this pull request Dec 9, 2015

Merge pull request #264 from jdfreder/shim-services

fc6844f

Create basic comm API shim for jupyter-js-services

SylvainCorlay merged commit fc6844f into jupyter-widgets:master Dec 9, 2015

parente mentioned this pull request Jan 4, 2016

Support ipywidget based interactive elements jupyter/dashboards_server#2

Closed

github-actions bot added the resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Feb 27, 2021

github-actions bot locked as resolved and limited conversation to collaborators Feb 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create basic comm API shim for jupyter-js-services #264

Create basic comm API shim for jupyter-js-services #264

jdfreder commented Dec 8, 2015

parente commented Dec 8, 2015

jdfreder commented Dec 8, 2015

jdfreder commented Dec 9, 2015

rgbkrk commented Dec 9, 2015

blink1073 commented Dec 9, 2015

lbustelo commented Dec 9, 2015

parente commented Dec 9, 2015

jdfreder commented Dec 9, 2015

jdfreder commented Dec 9, 2015

SylvainCorlay commented Dec 9, 2015

jdfreder commented Dec 9, 2015

SylvainCorlay commented Dec 9, 2015

jdfreder commented Dec 9, 2015

jdfreder commented Dec 9, 2015

SylvainCorlay commented Dec 9, 2015

blink1073 commented Dec 9, 2015

jdfreder commented Dec 9, 2015

jdfreder commented Dec 9, 2015

blink1073 commented Dec 9, 2015

blink1073 Dec 9, 2015

jdfreder Dec 10, 2015

blink1073 Dec 10, 2015

SylvainCorlay commented Dec 9, 2015

SylvainCorlay commented Dec 9, 2015

jdfreder commented Dec 9, 2015

blink1073 commented Dec 10, 2015

parente commented Dec 10, 2015

Create basic comm API shim for jupyter-js-services #264

Create basic comm API shim for jupyter-js-services #264

Conversation

jdfreder commented Dec 8, 2015

parente commented Dec 8, 2015

jdfreder commented Dec 8, 2015

jdfreder commented Dec 9, 2015

rgbkrk commented Dec 9, 2015

blink1073 commented Dec 9, 2015

lbustelo commented Dec 9, 2015

parente commented Dec 9, 2015

jdfreder commented Dec 9, 2015

jdfreder commented Dec 9, 2015

SylvainCorlay commented Dec 9, 2015

jdfreder commented Dec 9, 2015

SylvainCorlay commented Dec 9, 2015

jdfreder commented Dec 9, 2015

jdfreder commented Dec 9, 2015

SylvainCorlay commented Dec 9, 2015

blink1073 commented Dec 9, 2015

jdfreder commented Dec 9, 2015

jdfreder commented Dec 9, 2015

blink1073 commented Dec 9, 2015

blink1073 Dec 9, 2015

Choose a reason for hiding this comment

jdfreder Dec 10, 2015

Choose a reason for hiding this comment

blink1073 Dec 10, 2015

Choose a reason for hiding this comment

SylvainCorlay commented Dec 9, 2015

SylvainCorlay commented Dec 9, 2015

jdfreder commented Dec 9, 2015

blink1073 commented Dec 10, 2015

parente commented Dec 10, 2015