diff --git a/jupyterhub/apihandlers/users.py b/jupyterhub/apihandlers/users.py index 9fea47bd..0acf3b6d 100644 --- a/jupyterhub/apihandlers/users.py +++ b/jupyterhub/apihandlers/users.py @@ -14,12 +14,18 @@ from .base import APIHandler class BaseUserHandler(APIHandler): def user_model(self, user): - return { + model = { 'name': user.name, 'admin': user.admin, - 'server': user.server.base_url if user.server and not (user.spawn_pending or user.stop_pending) else None, + 'server': user.server.base_url if user.running else None, + 'pending': None, 'last_activity': user.last_activity.isoformat(), } + if user.spawn_pending: + model['pending'] = 'spawn' + elif user.stop_pending: + model['pending'] = 'stop' + return model _model_types = { 'name': str, @@ -150,7 +156,7 @@ class UserServerAPIHandler(BaseUserHandler): if user.stop_pending: self.set_status(202) return - if user.spawner is None: + if not user.running: raise web.HTTPError(400, "%s's server is not running" % name) status = yield user.spawner.poll() if status is not None: @@ -175,8 +181,8 @@ class UserAdminAccessAPIHandler(BaseUserHandler): user = self.find_user(name) if user is None: raise web.HTTPError(404) - if user.server is None: - raise web.HTTPError(400, "%s has no server running" % name) + if not user.running: + raise web.HTTPError(400, "%s's server is not running" % name) self.set_server_cookie(user) diff --git a/jupyterhub/orm.py b/jupyterhub/orm.py index d1cefdeb..a43f38c1 100644 --- a/jupyterhub/orm.py +++ b/jupyterhub/orm.py @@ -267,6 +267,15 @@ class User(Base): name=self.name, ) + @property + def running(self): + """property for whether a user has a running server""" + if self.spawner is None: + return False + if self.server is None: + return False + return True + def new_api_token(self): """Create a new API token""" assert self.id is not None @@ -285,7 +294,7 @@ class User(Base): Returns None if not found. """ return db.query(cls).filter(cls.name==name).first() - + @gen.coroutine def spawn(self, spawner_class, base_url='/', hub=None, config=None): """Start the user's spawner""" @@ -298,11 +307,10 @@ class User(Base): ) db.add(self.server) db.commit() - + api_token = self.new_api_token() db.commit() - spawner = self.spawner = spawner_class( config=config, user=self, @@ -314,21 +322,26 @@ class User(Base): spawner.api_token = api_token self.spawn_pending = True - f = spawner.start() # wait for spawner.start to return try: + f = spawner.start() yield gen.with_timeout(timedelta(seconds=spawner.start_timeout), f) - except gen.TimeoutError as e: - self.log.warn("{user}'s server failed to start in {s} seconds, giving up".format( - user=self.name, s=spawner.start_timeout, - )) + except Exception as e: + if isinstance(e, gen.TimeoutError): + self.log.warn("{user}'s server failed to start in {s} seconds, giving up".format( + user=self.name, s=spawner.start_timeout, + )) + else: + self.log.error("Unhandled error starting {user}'s server: {error}".format( + user=self.name, error=e, + )) try: yield self.stop() except Exception: self.log.error("Failed to cleanup {user}'s server that failed to start".format( user=self.name, ), exc_info=True) - # raise original TimeoutError + # raise original exception raise e spawner.start_polling() @@ -338,10 +351,15 @@ class User(Base): db.commit() try: yield self.server.wait_up(http=True) - except TimeoutError as e: - self.log.warn("{user}'s server never showed up at {url}, giving up".format( - user=self.name, url=self.server.url, - )) + except Exception as e: + if isinstance(e, TimeoutError): + self.log.warn("{user}'s server never showed up at {url}, giving up".format( + user=self.name, url=self.server.url, + )) + else: + self.log.error("Unhandled error waiting for {user}'s server to show up at {url}: {error}".format( + user=self.name, url=self.server.url, error=e, + )) try: yield self.stop() except Exception: diff --git a/jupyterhub/tests/test_api.py b/jupyterhub/tests/test_api.py index 7cde62c1..c852b4d8 100644 --- a/jupyterhub/tests/test_api.py +++ b/jupyterhub/tests/test_api.py @@ -104,11 +104,13 @@ def test_get_users(app): 'name': 'admin', 'admin': True, 'server': None, + 'pending': None, }, { 'name': 'user', 'admin': False, 'server': None, + 'pending': None, } ] diff --git a/jupyterhub/tests/test_orm.py b/jupyterhub/tests/test_orm.py index bb789baa..544a9cf8 100644 --- a/jupyterhub/tests/test_orm.py +++ b/jupyterhub/tests/test_orm.py @@ -3,7 +3,11 @@ # Copyright (c) Jupyter Development Team. # Distributed under the terms of the Modified BSD License. +import pytest +from tornado import gen + from .. import orm +from .mocking import MockSpawner def test_server(db): @@ -82,3 +86,20 @@ def test_tokens(db): assert found.match(token) found = orm.APIToken.find(db, 'something else') assert found is None + + +def test_spawn_fails(db, io_loop): + user = orm.User(name='aeofel') + db.add(user) + db.commit() + + class BadSpawner(MockSpawner): + @gen.coroutine + def start(self): + raise RuntimeError("Split the party") + + with pytest.raises(Exception) as exc: + io_loop.run_sync(lambda : user.spawn(BadSpawner)) + assert user.server is None + assert not user.running + diff --git a/share/jupyter/hub/templates/admin.html b/share/jupyter/hub/templates/admin.html index 7e072f01..99725deb 100644 --- a/share/jupyter/hub/templates/admin.html +++ b/share/jupyter/hub/templates/admin.html @@ -42,11 +42,11 @@ {% if u.admin %}admin{% endif %} {{u.last_activity.isoformat() + 'Z'}} - stop server + stop server {% if admin_access %} - access server + access server {% endif %} - start server + start server edit diff --git a/share/jupyter/hub/templates/home.html b/share/jupyter/hub/templates/home.html index 66a09629..62ac135a 100644 --- a/share/jupyter/hub/templates/home.html +++ b/share/jupyter/hub/templates/home.html @@ -5,7 +5,7 @@
- {% if user.server %} + {% if user.running %} Stop My Server {% endif %}