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

Extend userprofile endpoint with all data on the current user from Jupyter Server #510

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 27 additions & 8 deletions cylc/uiserver/handlers.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,11 @@
)

from cylc.uiserver.authorise import Authorization, AuthorizationMiddleware
from cylc.uiserver.resolvers import Resolvers
from cylc.uiserver.websockets import authenticated as websockets_authenticated
from cylc.uiserver.websockets.tornado import TornadoSubscriptionServer

if TYPE_CHECKING:
from cylc.uiserver.resolvers import Resolvers
from cylc.uiserver.websockets.tornado import TornadoSubscriptionServer
from graphql.execution import ExecutionResult


Expand Down Expand Up @@ -122,17 +123,34 @@ def _authorise(
return False


def get_username(handler: 'CylcAppHandler'):
def get_initials(username: str):
if ('.' in username):
first, last = username.split('.', maxsplit=1)
return f"{first[0]}{last[0]}".upper()
elif (username != ''):
return username[0].upper()
else:
return None


def get_user_info(handler: 'CylcAppHandler'):
"""Return the username for the authenticated user.

If the handler is token authenticated, then we return the username of the
account that this server instance is running under.
"""
if is_token_authenticated(handler):
# the bearer of the token has full privileges
return ME
return {'name': ME, 'initials': get_initials(ME), 'username': ME}
else:
return handler.current_user.username
initials = handler.current_user.initials or get_initials(
handler.current_user.username
)
return {
'name': handler.current_user.name,
'initials': initials,
'username': handler.current_user.username
}


class CylcAppHandler(JupyterHandler):
Expand Down Expand Up @@ -247,7 +265,8 @@ def set_default_headers(self) -> None:
# @authorised TODO: I can't think why we would want to authorise this
def get(self):
user_info = {
'name': get_username(self)
**self.current_user.__dict__,
**get_user_info(self)
}

# add an entry for the workflow owner
Expand Down Expand Up @@ -316,7 +335,7 @@ def context(self):
'graphql_params': self.graphql_params,
'request': self.request,
'resolvers': self.resolvers,
'current_user': get_username(self),
'current_user': get_user_info(self)['username'],
}

@web.authenticated # type: ignore[arg-type]
Expand Down Expand Up @@ -384,7 +403,7 @@ def context(self):
return {
'request': self.request,
'resolvers': self.resolvers,
'current_user': get_username(self),
'current_user': get_user_info(self)['username'],
'ops_queue': {},
'sub_statuses': self.sub_statuses
}