User service #12926

hbcarlos · 2022-08-09T15:57:47Z

This is ready for review. I'm keeping it as a draft because we need to update the jupyter-server dependency since this need server v2.

References

Fixes #11678

Code changes

Removes the ICurrentUser token and creates a new service manager to fetch the user's identity and permissions.

User-facing changes

N/A

Backwards-incompatible changes

N/A

jupyterlab-probot · 2022-08-09T15:58:50Z

Thanks for making a pull request to jupyterlab!
To try out this branch on binder, follow this link:

ellisonbg · 2022-08-17T23:04:50Z

Could we keep ICurrentUser and have the default implementation call the backend service. There may be situations (jupyter lite for example) where it makes more sense to customize this in the frontend.

fcollonval · 2022-08-18T09:51:59Z

Could we keep ICurrentUser and have the default implementation call the backend service. There may be situations (jupyter lite for example) where it makes more sense to customize this in the frontend.

Could you elaborate on the need @ellisonbg ? I fear that this will create inconsistency in remix because accessing ICurrentUser may then not match accessing the user information from the service manager. Moreover it will increase the security sensible API for attackers by replacing ICurrentUser to change their permissions.

Note: JupyterLite will deal with user authentication using its custom service manager for the user endpoint (similarly to other Jupyter server endpoints): https://github.com/jupyterlite/jupyterlite/blob/6b8458dcfe051a89df191bcfe6b5a09d16194b7c/packages/server/src/app.ts#L25

jtpio · 2022-10-26T16:13:39Z

There may be situations (jupyter lite for example) where it makes more sense to customize this in the frontend.

Most likely JupyterLite or other custom apps can handle that via their own ServiceManager.

hbcarlos · 2022-10-28T08:06:37Z

The workflow Test Minimum Versions fails because the install-minimums action from the maintainer tools package replaces >= with == to force installing the minimum version of the dependencies.

The problem is that jupyterlab depends in "importlib-metadata>=3.6;python_version<\"3.10\"" wich minium version is ==3.6 but jupyterlab-server depends in "importlib-metadata>=4.8.3;python_version<\"3.10\"" wich creates a conflict, see:
https://github.com/jupyterlab/jupyterlab/actions/runs/3340448609/jobs/5530556688

  The conflict is caused by:
      jupyterlab[test] 4.0.0a30 depends on importlib-metadata>=3.6; python_version < "3.10"
      importlib-resources 1.4.0 depends on importlib-metadata; python_version < "3.8"
      jupyterlab-server 2.16.0 depends on importlib-metadata>=4.8.3; python_version < "3.10"
      The user requested (constraint) importlib-metadata==3.6

I bumped importlib-metadata>=3.6 to importlib-metadata>=4.8.3 in e0de694.

hbcarlos · 2022-10-28T10:31:29Z

In jp-server v2, the terminal was moved to an extension. Some examples of standalone apps are configured to not load extensions. See:

jupyterlab/examples/app/main.py

Lines 11 to 13 in f1bc627

    
           # Turn off the Jupyter configuration system so configuration files on disk do 
        
           # not affect this app. This helps this app to truly be standalone. 
        
           os.environ["JUPYTER_NO_CONFIG"] = "1"

jupyterlab/examples/app/main.py

Line 28 in f1bc627

load_other_extensions = False

That makes the tests of the examples fail because the terminal doesn't work.
I changed the examples to load extensions in 2be6161.

fcollonval · 2022-10-28T12:57:09Z

In jp-server v2, the terminal was moved to an extension. Some examples of standalone apps are configured to not load extensions. See:

jupyterlab/examples/app/main.py

Lines 11 to 13 in f1bc627

# Turn off the Jupyter configuration system so configuration files on disk do

# not affect this app. This helps this app to truly be standalone.

os.environ["JUPYTER_NO_CONFIG"] = "1"

jupyterlab/examples/app/main.py

Line 28 in f1bc627

load_other_extensions = False

That makes the tests of the examples fail because the terminal doesn't work. I changed the examples to load extensions in 2be6161.

Would you mind opening an issue because we definitely need to do a follow up that support missing terminal feature in @jupyterlab/services?

fcollonval

Thanks @hbcarlos

fcollonval · 2022-10-28T13:36:51Z

@meeseeksdev please backport to 3.6.x

lumberbot-app · 2022-10-28T13:37:16Z

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

git checkout 3.6.x
git pull

Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 f9d01fc38b5d3ab7359a97fc59d8a13115fea541

You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #12926: User service'

Push to a named branch:

git push YOURFORK 3.6.x:auto-backport-of-pr-12926-on-3.6.x

Create a PR against branch 3.6.x, I would have named this PR:

"Backport PR #12926 on branch 3.6.x (User service)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

jtpio · 2022-10-28T13:50:24Z

examples/app/main.py

@@ -25,7 +27,8 @@ class ExampleApp(LabServerApp):
    extension_url = "/lab"
    default_url = "/lab"
    name = __name__
-    load_other_extensions = False
+    # In jupyter-server v2 terminals are an extension
+    load_other_extensions = True


It would be nice to keep that one to False as one of the main purposes of these examples is to show how to create standalone applications.

If that makes the tests fail maybe the test should be updated to not expect terminals anymore?

The tests check that JupyterLab starts without throwing an error in the dev console.
We could make the terminal service optional or catch the error and show a warning.

But I'm not sure what is the best solution.

I'm looking into it.

packages/docprovider-extension/src/index.ts

* Backport PR #12926: User service * Fix integrity * Handle missing user service * Fix tests * Integrity fix Co-authored-by: Carlos Herrero <contact@carloshb.com>

* Creates a new service to fetch the identity of the user * Change ICurrentUser to a service * Pin jp-server v2 * Explicit test dependencies * Fixes user tests * Bumps importlib-metadata and fixes lint * Bumps notebook_shim * Fixes the examples * Fixes the examples Co-authored-by: Frédéric Collonval <fcollonval@gmail.com>

hbcarlos self-assigned this Aug 9, 2022

hbcarlos added the tag:Real Time Collaboration label Aug 9, 2022

github-actions bot added pkg:collaboration pkg:docprovider pkg:services labels Aug 9, 2022

hbcarlos marked this pull request as draft August 9, 2022 16:01

github-actions bot added Design System CSS tag:CSS For general CSS related issues and pecadilloes labels Aug 9, 2022

hbcarlos force-pushed the user_service branch from 822f4f2 to 28a3104 Compare August 11, 2022 23:20

hbcarlos force-pushed the user_service branch from 28a3104 to 15f2039 Compare September 12, 2022 13:56

fcollonval added this to the 3.6.0 milestone Oct 26, 2022

hbcarlos added 2 commits October 26, 2022 14:50

Creates a new service to fetch the identity of the user

2143a69

Change ICurrentUser to a service

3546586

hbcarlos force-pushed the user_service branch from 15f2039 to 193d3a0 Compare October 26, 2022 14:41

Pin jp-server v2

b1cad5c

hbcarlos force-pushed the user_service branch from 193d3a0 to b1cad5c Compare October 27, 2022 08:39

fcollonval added the enhancement label Oct 27, 2022

fcollonval and others added 3 commits October 27, 2022 10:56

Explicit test dependencies

9d6f93a

Fixes user tests

bd97e96

Bumps importlib-metadata and fixes lint

e0de694

hbcarlos added 2 commits October 28, 2022 11:19

Bumps notebook_shim

a96bf67

Fixes the examples

2be6161

github-actions bot added the tag:Examples label Oct 28, 2022

Fixes the examples

97972c1

hbcarlos marked this pull request as ready for review October 28, 2022 12:14

fcollonval approved these changes Oct 28, 2022

View reviewed changes

fcollonval merged commit f9d01fc into jupyterlab:master Oct 28, 2022

fcollonval mentioned this pull request Oct 28, 2022

Support missing terminals feature #13330

Closed

lumberbot-app bot added the Still Needs Manual Backport label Oct 28, 2022

hbcarlos deleted the user_service branch October 28, 2022 13:37

jtpio reviewed Oct 28, 2022

View reviewed changes

packages/docprovider-extension/src/index.ts Show resolved Hide resolved

This was referenced Oct 28, 2022

In JP-Server v2 the terminal is not in core anymore. #13331

Closed

Removes empty requires list #13334

Merged

fcollonval mentioned this pull request Oct 28, 2022

JupyterLab 3.6.0 Release #13221

Closed

23 tasks

fcollonval pushed a commit to fcollonval/jupyterlab that referenced this pull request Oct 28, 2022

Backport PR jupyterlab#12926: User service

2dab222

This was referenced Oct 28, 2022

Backport PR #12926 on branch 3.6.x (User service) #13337

Merged

Fix Binder for jupyter-server v2 #13344

Merged

fcollonval removed the Still Needs Manual Backport label Oct 31, 2022

This was referenced Nov 16, 2022

Update to JupyterLab 4.0.0a31 jupyter/notebook#6577

Closed

Update to JupyterLab 4.0.0a31 jupyter/notebook#6627

Merged

github-actions bot locked as resolved and limited conversation to collaborators Nov 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User service #12926

User service #12926

hbcarlos commented Aug 9, 2022

jupyterlab-probot bot commented Aug 9, 2022

ellisonbg commented Aug 17, 2022

fcollonval commented Aug 18, 2022

jtpio commented Oct 26, 2022

hbcarlos commented Oct 28, 2022

hbcarlos commented Oct 28, 2022

fcollonval commented Oct 28, 2022

fcollonval left a comment

fcollonval commented Oct 28, 2022

lumberbot-app bot commented Oct 28, 2022

jtpio Oct 28, 2022

hbcarlos Oct 28, 2022

fcollonval Oct 28, 2022

User service #12926

User service #12926

Conversation

hbcarlos commented Aug 9, 2022

References

Code changes

User-facing changes

Backwards-incompatible changes

jupyterlab-probot bot commented Aug 9, 2022

ellisonbg commented Aug 17, 2022

fcollonval commented Aug 18, 2022

jtpio commented Oct 26, 2022

hbcarlos commented Oct 28, 2022

hbcarlos commented Oct 28, 2022

fcollonval commented Oct 28, 2022

fcollonval left a comment

Choose a reason for hiding this comment

fcollonval commented Oct 28, 2022

lumberbot-app bot commented Oct 28, 2022

jtpio Oct 28, 2022

Choose a reason for hiding this comment

hbcarlos Oct 28, 2022

Choose a reason for hiding this comment

fcollonval Oct 28, 2022

Choose a reason for hiding this comment