Add a user package to represent the current connected user #11443

hbcarlos · 2021-11-11T21:14:44Z

This PR was started in #11180, I decided to close the other one to separate every feature in a different PR.

This PR adds two new packages, "@jupyterlab/user", and "@jupyterlab/user-extension". These packages introduce two new plugins:

ICurrentUser:

Provides a representation of the connected user. The idea is that some extensions will require the ICurrentUser to read the information (docprovider to use this identity in RTC, or an extension to add comments in a notebook, etc.). At the moment, all the users are anonymous since we don't have any identity provider, but the idea is that other extensions can swap the default implementation of the current user to fetch the information from a third-party identity provider.
This interface includes the property role. For now, this property is useless since any other package supports RBAC to limit the actions that users can do. There is already an issue open to discuss what roles should we have.

IUserMenu:

Provides a new menu added to the JupyterLab toolbar with the current user's name and icon. The idea behind this widget is to provides a lumino menu where extensions can add different buttons to actions related to the user (Login/Logout buttons, settings, etc.).

References

solves #10965

Code changes

Adds two new package, "@jupyterlab/user", and "@jupyterlab/user-extension".

User-facing changes

Now users will see his name and icon at the right side of the toolbar.

Backwards-incompatible changes

jupyterlab-probot · 2021-11-11T21:14:46Z

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

jtpio · 2021-11-12T17:13:46Z

Thanks for starting this!

Adds two new package, "@jupyterlab/user", and "@jupyterlab/user-extension".

I think some CI checks are expected to fail because these packages are not published to npm yet.

hbcarlos · 2021-11-13T12:25:22Z

Thanks Jeremy!! I updated the images of the UI test to include the new menu.
Okay, I realized that I need to change the general UI test because every time is run, creates a new random username and color.

fcollonval

Thanks @hbcarlos

please find some suggestions for this PR.

galata/test/jupyterlab/general.test.ts

packages/metapackage/package.json

packages/user-extension/src/index.ts

packages/user/src/components.tsx

packages/user-extension/src/index.ts

packages/user/style/menu.css

packages/user/test/user.spec.ts

jtpio · 2021-11-22T09:24:22Z

Thanks @hbcarlos for the continued effort on this 👍

Now users will see his name and icon at the right side of the toolbar.

Posting here a summary of a discussion with Carlos on another channel.

At the moment the plugin adds the name and icon to the top area, even if the user does not plan to use any of the RTC features to collaborate with others. For example a single user only using JupyterLab to do some work locally.

Since this was the subject of a discussion at the time when we added the Simple Interface toggle (see #9100, #9105 and #9296 for more context), I would like to raise a concern about having this name / icon indicator visible at all time in the top area.

This is also related to some user feedback (for example from jupyter/notebook#6210) about the JupyterLab UI having too many distractions, and a new visual indicator in the top area might add some more noise.

Possible alternatives we discussed could be to place to indicator in the bottom left corner (similar to VS Code):

Not sure the left area handler is currently able to pull items down. Otherwise it could also be a good opportunity to add that feature (in a separate PR).

hbcarlos · 2021-11-22T09:32:28Z

Thanks for commenting on the user menu @jtpio. I'll remove the widget and we can tackle that on another PR.

fcollonval · 2021-11-23T07:56:54Z

I fixed the integrity test; in fact in addition to the new user packages, the docprovider package style needed to be skipped because it has now style (due to its dependency on the new user package).

Regarding the very good point raised by @jtpio, my understanding from the JLab team meeting was that no UI elements should be displayed if JupyterLab was not executed with collaborative edition. This means that the collaboration state needs to be stored in the pageconfig object.

Note regarding retrolab: it does not have sidebars. So the current proposition à la Google doc sounds better for me.

hbcarlos · 2021-11-23T08:55:46Z

I fixed the integrity test; in fact in addition to the new user packages, the docprovider package style needed to be skipped because it has now style (due to its dependency on the new user package).

Thanks, @fcollonval! I did not realize about the docprovider.

This means that the collaboration state needs to be stored in the pageconfig object.

That's actually a good idea. I can remove the menu if the collaborative flag is false.

fcollonval · 2021-11-23T09:28:44Z

That's actually a good idea. I can remove the menu if the collaborative flag is false.

👍

jtpio · 2021-11-23T11:16:51Z

Note regarding retrolab: it does not have sidebars. So the current proposition à la Google doc sounds better for me.

Since the plugin adding the UI element to the top area is quite small, RetroLab could also define its own if needed.

But if we keep the current one behind the collaborative flag, then it should work automatically in RetroLab (might have to tweak the ranks there though)

trungleduc · 2021-11-24T10:36:02Z

👍 on the ideal of @jtpio, we can place the user widget to the bottom right corner and use it to indicate both the user information and the list of connected users.

hbcarlos · 2021-12-09T15:09:13Z

Follow-up PR would be fine.

Thanks, @krassowski!
I'm already working on it, I'll add on a follow-up PR as soon as it is done.

hbcarlos · 2021-12-09T15:10:54Z

I'm pushing one more commit to tag the ICurrentUser token and interface as experimental.
This will give us more flexibility for future changes.

jtpio · 2021-12-09T16:27:34Z

Thanks!

Let's merge and address the remaining items in follow-up issues and PRs.

jtpio · 2021-12-09T16:28:09Z

Making a new alpha release now.

martinRenou · 2022-10-13T15:00:07Z

@meeseeksdev please backport to 3.6.x

lumberbot-app · 2022-10-13T15:00:13Z

Awww, sorry martinRenou you do not seem to be allowed to do that, please ask a repository maintainer.

martinRenou · 2022-10-13T15:00:31Z

Oh come on, be nice Meeseeks

…b#11443) * Adds a new package for the user information * Read user info from IUser when opening a new document * Adds a user menu * Remove anonymous names from docprovider and runs integrity and eslint:typed * Small fix menu * Rename tokens ID to match the token name * Adds new tokens to the documentation * Review * Remove components * Adds tests * Create the user menu only if collaborative flag is true * Revert changes on UI tests * Adds tests to the user menu * Review * Integrity * Small issue * Store user in local storage, remove StateDB and run integrity * Remove 'id', 'name', and adds 'givenName', 'familyName', and 'initials' * Update packages as part of the rebase * Removes role, and solves an issue with names on the editor * Change tests user package * Makes colors private, removes public methods from IUserMenu * Package integrity updates * Tag ICurrentUser token and interface as experimental

fcollonval · 2022-10-13T16:34:37Z

@meeseeksdev please backport to 3.6.x

lumberbot-app · 2022-10-13T16:34:46Z

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 969fa5d674931a89322d60c7e8c5bf80752f6cdd

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

git commit -am 'Backport PR #11443: Add a user package to represent the current connected user'

Push to a named branch:

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

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

"Backport PR #11443 on branch 3.6.x (Add a user package to represent the current connected user)"

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.

martinRenou · 2022-10-14T07:22:07Z

Thanks for trying @fcollonval, but I also realized there would be conflicts. I made a big PR manually backporting all the IUser and collaboration PRs #13242 (still draft for now)

…b#11443) * Adds a new package for the user information * Read user info from IUser when opening a new document * Adds a user menu * Remove anonymous names from docprovider and runs integrity and eslint:typed * Small fix menu * Rename tokens ID to match the token name * Adds new tokens to the documentation * Review * Remove components * Adds tests * Create the user menu only if collaborative flag is true * Revert changes on UI tests * Adds tests to the user menu * Review * Integrity * Small issue * Store user in local storage, remove StateDB and run integrity * Remove 'id', 'name', and adds 'givenName', 'familyName', and 'initials' * Update packages as part of the rebase * Removes role, and solves an issue with names on the editor * Change tests user package * Makes colors private, removes public methods from IUserMenu * Package integrity updates * Tag ICurrentUser token and interface as experimental

github-actions bot assigned hbcarlos Nov 11, 2021

github-actions bot added Design System CSS documentation pkg:docmanager pkg:docprovider pkg:docregistry pkg:ui-components tag:CSS For general CSS related issues and pecadilloes labels Nov 11, 2021

hbcarlos mentioned this pull request Nov 11, 2021

Add new package "user" to represent a connected users #11180

Closed

hbcarlos marked this pull request as draft November 11, 2021 21:38

hbcarlos force-pushed the jp-user branch from ce8d8a5 to 3c96e2e Compare November 11, 2021 22:08

github-actions bot added the tag:Testing label Nov 13, 2021

hbcarlos force-pushed the jp-user branch from b808086 to eb677a3 Compare November 13, 2021 12:51

hbcarlos marked this pull request as ready for review November 13, 2021 15:14

fcollonval added the enhancement label Nov 15, 2021

fcollonval added this to the 4.0 milestone Nov 15, 2021

fcollonval requested changes Nov 15, 2021

View reviewed changes

This was referenced Nov 16, 2021

Don't update styles import for metapackage #11472

Closed

Weekly Team Meetings: Aug-Dec 2021 jupyterlab/frontends-team-compass#128

Closed

trungleduc mentioned this pull request Nov 23, 2021

Show the list of current connected users in RTC mode #11528

Closed

jtpio merged commit 969fa5d into jupyterlab:master Dec 9, 2021

hbcarlos deleted the jp-user branch December 9, 2021 22:07

hbcarlos mentioned this pull request Dec 9, 2021

Remove border from user menu when is empty #11650

Closed

minrk mentioned this pull request Dec 10, 2021

identity API jupyter-server/jupyter_server#638

Closed

This was referenced Dec 10, 2021

Move the top area spacer to a different plugin #11654

Merged

Drop familyName from the ICurrentUser interface? #11657

Closed

fcollonval mentioned this pull request Dec 13, 2021

Switching from user extension to user service #11678

Closed

This was referenced Dec 14, 2021

IUser to represent a connected users #10965

Closed

Add users colors to the theme #11703

Merged

SylvainCorlay mentioned this pull request Jan 26, 2022

Identity API at /api/me jupyter-server/jupyter_server#671

Merged

6 tasks

davidbrochart mentioned this pull request Feb 20, 2022

Save document from the backend using y-py #11599

Merged

jtpio mentioned this pull request Mar 14, 2022

RTC left panel #12095

Merged

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

martinRenou mentioned this pull request Oct 14, 2022

Backporting IUser/Collaboration PRs #13242

Merged

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

github-actions bot locked as resolved and limited conversation to collaborators Oct 29, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a user package to represent the current connected user #11443

Add a user package to represent the current connected user #11443

hbcarlos commented Nov 11, 2021

jupyterlab-probot bot commented Nov 11, 2021

jtpio commented Nov 12, 2021 •

edited

Loading

hbcarlos commented Nov 13, 2021 •

edited

Loading

fcollonval left a comment

jtpio commented Nov 22, 2021

hbcarlos commented Nov 22, 2021

fcollonval commented Nov 23, 2021 •

edited

Loading

hbcarlos commented Nov 23, 2021

fcollonval commented Nov 23, 2021

jtpio commented Nov 23, 2021

trungleduc commented Nov 24, 2021

hbcarlos commented Dec 9, 2021

hbcarlos commented Dec 9, 2021

jtpio commented Dec 9, 2021

jtpio commented Dec 9, 2021

martinRenou commented Oct 13, 2022

lumberbot-app bot commented Oct 13, 2022

martinRenou commented Oct 13, 2022

fcollonval commented Oct 13, 2022

lumberbot-app bot commented Oct 13, 2022

martinRenou commented Oct 14, 2022

Add a user package to represent the current connected user #11443

Add a user package to represent the current connected user #11443

Conversation

hbcarlos commented Nov 11, 2021

ICurrentUser:

IUserMenu:

References

Code changes

User-facing changes

Backwards-incompatible changes

jupyterlab-probot bot commented Nov 11, 2021

jtpio commented Nov 12, 2021 • edited Loading

hbcarlos commented Nov 13, 2021 • edited Loading

fcollonval left a comment

Choose a reason for hiding this comment

jtpio commented Nov 22, 2021

hbcarlos commented Nov 22, 2021

fcollonval commented Nov 23, 2021 • edited Loading

hbcarlos commented Nov 23, 2021

fcollonval commented Nov 23, 2021

jtpio commented Nov 23, 2021

trungleduc commented Nov 24, 2021

hbcarlos commented Dec 9, 2021

hbcarlos commented Dec 9, 2021

jtpio commented Dec 9, 2021

jtpio commented Dec 9, 2021

martinRenou commented Oct 13, 2022

lumberbot-app bot commented Oct 13, 2022

martinRenou commented Oct 13, 2022

fcollonval commented Oct 13, 2022

lumberbot-app bot commented Oct 13, 2022

martinRenou commented Oct 14, 2022

jtpio commented Nov 12, 2021 •

edited

Loading

hbcarlos commented Nov 13, 2021 •

edited

Loading

fcollonval commented Nov 23, 2021 •

edited

Loading