From b2e7b474ff1b051ef0a0b9b82fe39c6faad5c717 Mon Sep 17 00:00:00 2001
From: Christine Banek <cbanek@gmail.com>
Date: Mon, 26 Oct 2020 14:33:08 -0700
Subject: [PATCH 01/46] Allow options_from_form to be configurable

---
 jupyterhub/spawner.py | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/jupyterhub/spawner.py b/jupyterhub/spawner.py
index ad07fa44..6389c1d0 100644
--- a/jupyterhub/spawner.py
+++ b/jupyterhub/spawner.py
@@ -354,8 +354,9 @@ class Spawner(LoggingConfigurable):
 
         return options_form
 
-    def options_from_form(self, form_data):
-        """Interpret HTTP form data
+    options_from_form = Callable(
+        help="""
+        Interpret HTTP form data
 
         Form data will always arrive as a dict of lists of strings.
         Override this function to understand single-values, numbers, etc.
@@ -379,7 +380,14 @@ class Spawner(LoggingConfigurable):
             (with additional support for bytes in case of uploaded file data),
             and any non-bytes non-jsonable values will be replaced with None
             if the user_options are re-used.
-        """
+        """,
+    ).tag(config=True)
+
+    @default("options_from_form")
+    def _options_from_form(self):
+        return self._default_options_from_form
+
+    def _default_options_from_form(self, form_data):
         return form_data
 
     def options_from_query(self, query_data):

From 2bef5ba9814d4bc1bb44cd9d661702161d7cebb8 Mon Sep 17 00:00:00 2001
From: agp8x <git@agp8x.org>
Date: Wed, 4 Nov 2020 13:54:31 +0100
Subject: [PATCH 02/46] Add prefix to prometheus metrics to group all jupyter
 metrics (see #1585)

---
 jupyterhub/metrics.py | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/jupyterhub/metrics.py b/jupyterhub/metrics.py
index 2bb9013b..a164ec50 100644
--- a/jupyterhub/metrics.py
+++ b/jupyterhub/metrics.py
@@ -3,9 +3,9 @@ Prometheus metrics exported by JupyterHub
 
 Read https://prometheus.io/docs/practices/naming/ for naming
 conventions for metrics & labels. We generally prefer naming them
-`<noun>_<verb>_<type_suffix>`. So a histogram that's tracking
+`jupyter_<noun>_<verb>_<type_suffix>`. So a histogram that's tracking
 the duration (in seconds) of servers spawning would be called
-SERVER_SPAWN_DURATION_SECONDS.
+JUPYTER_SERVER_SPAWN_DURATION_SECONDS.
 
 We also create an Enum for each 'status' type label in every metric
 we collect. This is to make sure that the metrics exist regardless
@@ -21,13 +21,13 @@ from prometheus_client import Gauge
 from prometheus_client import Histogram
 
 REQUEST_DURATION_SECONDS = Histogram(
-    'request_duration_seconds',
+    'jupyter_request_duration_seconds',
     'request duration for all HTTP requests',
     ['method', 'handler', 'code'],
 )
 
 SERVER_SPAWN_DURATION_SECONDS = Histogram(
-    'server_spawn_duration_seconds',
+    'jupyter_server_spawn_duration_seconds',
     'time taken for server spawning operation',
     ['status'],
     # Use custom bucket sizes, since the default bucket ranges
@@ -36,25 +36,25 @@ SERVER_SPAWN_DURATION_SECONDS = Histogram(
 )
 
 RUNNING_SERVERS = Gauge(
-    'running_servers', 'the number of user servers currently running'
+    'jupyter_running_servers', 'the number of user servers currently running'
 )
 
-TOTAL_USERS = Gauge('total_users', 'total number of users')
+TOTAL_USERS = Gauge('jupyter_total_users', 'total number of users')
 
 CHECK_ROUTES_DURATION_SECONDS = Histogram(
-    'check_routes_duration_seconds', 'Time taken to validate all routes in proxy'
+    'jupyter_check_routes_duration_seconds', 'Time taken to validate all routes in proxy'
 )
 
 HUB_STARTUP_DURATION_SECONDS = Histogram(
-    'hub_startup_duration_seconds', 'Time taken for Hub to start'
+    'jupyter_hub_startup_duration_seconds', 'Time taken for Hub to start'
 )
 
 INIT_SPAWNERS_DURATION_SECONDS = Histogram(
-    'init_spawners_duration_seconds', 'Time taken for spawners to initialize'
+    'jupyter_init_spawners_duration_seconds', 'Time taken for spawners to initialize'
 )
 
 PROXY_POLL_DURATION_SECONDS = Histogram(
-    'proxy_poll_duration_seconds', 'duration for polling all routes from proxy'
+    'jupyter_proxy_poll_duration_seconds', 'duration for polling all routes from proxy'
 )
 
 
@@ -79,7 +79,7 @@ for s in ServerSpawnStatus:
 
 
 PROXY_ADD_DURATION_SECONDS = Histogram(
-    'proxy_add_duration_seconds', 'duration for adding user routes to proxy', ['status']
+    'jupyter_proxy_add_duration_seconds', 'duration for adding user routes to proxy', ['status']
 )
 
 
@@ -100,7 +100,7 @@ for s in ProxyAddStatus:
 
 
 SERVER_POLL_DURATION_SECONDS = Histogram(
-    'server_poll_duration_seconds',
+    'jupyter_server_poll_duration_seconds',
     'time taken to poll if server is running',
     ['status'],
 )
@@ -127,7 +127,7 @@ for s in ServerPollStatus:
 
 
 SERVER_STOP_DURATION_SECONDS = Histogram(
-    'server_stop_seconds', 'time taken for server stopping operation', ['status']
+    'jupyter_server_stop_seconds', 'time taken for server stopping operation', ['status']
 )
 
 
@@ -148,7 +148,7 @@ for s in ServerStopStatus:
 
 
 PROXY_DELETE_DURATION_SECONDS = Histogram(
-    'proxy_delete_duration_seconds',
+    'jupyter_proxy_delete_duration_seconds',
     'duration for deleting user routes from proxy',
     ['status'],
 )

From 9657430cacab210bdc69ea3aa5eec8185302a3a3 Mon Sep 17 00:00:00 2001
From: Mohammad Wasil <mwasil@outlook.co.id>
Date: Wed, 4 Nov 2020 17:59:28 +0100
Subject: [PATCH 03/46] Fix reverse proxy redirect from https

---
 docs/source/reference/config-proxy.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/source/reference/config-proxy.md b/docs/source/reference/config-proxy.md
index cd56025c..181ebf41 100644
--- a/docs/source/reference/config-proxy.md
+++ b/docs/source/reference/config-proxy.md
@@ -86,6 +86,7 @@ server {
         proxy_http_version 1.1;
         proxy_set_header Upgrade $http_upgrade;
         proxy_set_header Connection $connection_upgrade;
+        proxy_set_header X-Scheme $scheme;
 
         proxy_buffering off;
     }

From af09bc547af8161d287df520bb3a3df00d39aa26 Mon Sep 17 00:00:00 2001
From: agp8x <git@agp8x.org>
Date: Tue, 17 Nov 2020 15:29:37 +0100
Subject: [PATCH 04/46] change metric prefix to jupyterhub

---
 jupyterhub/metrics.py | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/jupyterhub/metrics.py b/jupyterhub/metrics.py
index a164ec50..68aeb884 100644
--- a/jupyterhub/metrics.py
+++ b/jupyterhub/metrics.py
@@ -3,9 +3,9 @@ Prometheus metrics exported by JupyterHub
 
 Read https://prometheus.io/docs/practices/naming/ for naming
 conventions for metrics & labels. We generally prefer naming them
-`jupyter_<noun>_<verb>_<type_suffix>`. So a histogram that's tracking
+`jupyterhub_<noun>_<verb>_<type_suffix>`. So a histogram that's tracking
 the duration (in seconds) of servers spawning would be called
-JUPYTER_SERVER_SPAWN_DURATION_SECONDS.
+jupyterhub_SERVER_SPAWN_DURATION_SECONDS.
 
 We also create an Enum for each 'status' type label in every metric
 we collect. This is to make sure that the metrics exist regardless
@@ -21,13 +21,13 @@ from prometheus_client import Gauge
 from prometheus_client import Histogram
 
 REQUEST_DURATION_SECONDS = Histogram(
-    'jupyter_request_duration_seconds',
+    'jupyterhub_request_duration_seconds',
     'request duration for all HTTP requests',
     ['method', 'handler', 'code'],
 )
 
 SERVER_SPAWN_DURATION_SECONDS = Histogram(
-    'jupyter_server_spawn_duration_seconds',
+    'jupyterhub_server_spawn_duration_seconds',
     'time taken for server spawning operation',
     ['status'],
     # Use custom bucket sizes, since the default bucket ranges
@@ -36,25 +36,25 @@ SERVER_SPAWN_DURATION_SECONDS = Histogram(
 )
 
 RUNNING_SERVERS = Gauge(
-    'jupyter_running_servers', 'the number of user servers currently running'
+    'jupyterhub_running_servers', 'the number of user servers currently running'
 )
 
-TOTAL_USERS = Gauge('jupyter_total_users', 'total number of users')
+TOTAL_USERS = Gauge('jupyterhub_total_users', 'total number of users')
 
 CHECK_ROUTES_DURATION_SECONDS = Histogram(
-    'jupyter_check_routes_duration_seconds', 'Time taken to validate all routes in proxy'
+    'jupyterhub_check_routes_duration_seconds', 'Time taken to validate all routes in proxy'
 )
 
 HUB_STARTUP_DURATION_SECONDS = Histogram(
-    'jupyter_hub_startup_duration_seconds', 'Time taken for Hub to start'
+    'jupyterhub_hub_startup_duration_seconds', 'Time taken for Hub to start'
 )
 
 INIT_SPAWNERS_DURATION_SECONDS = Histogram(
-    'jupyter_init_spawners_duration_seconds', 'Time taken for spawners to initialize'
+    'jupyterhub_init_spawners_duration_seconds', 'Time taken for spawners to initialize'
 )
 
 PROXY_POLL_DURATION_SECONDS = Histogram(
-    'jupyter_proxy_poll_duration_seconds', 'duration for polling all routes from proxy'
+    'jupyterhub_proxy_poll_duration_seconds', 'duration for polling all routes from proxy'
 )
 
 
@@ -79,7 +79,7 @@ for s in ServerSpawnStatus:
 
 
 PROXY_ADD_DURATION_SECONDS = Histogram(
-    'jupyter_proxy_add_duration_seconds', 'duration for adding user routes to proxy', ['status']
+    'jupyterhub_proxy_add_duration_seconds', 'duration for adding user routes to proxy', ['status']
 )
 
 
@@ -100,7 +100,7 @@ for s in ProxyAddStatus:
 
 
 SERVER_POLL_DURATION_SECONDS = Histogram(
-    'jupyter_server_poll_duration_seconds',
+    'jupyterhub_server_poll_duration_seconds',
     'time taken to poll if server is running',
     ['status'],
 )
@@ -127,7 +127,7 @@ for s in ServerPollStatus:
 
 
 SERVER_STOP_DURATION_SECONDS = Histogram(
-    'jupyter_server_stop_seconds', 'time taken for server stopping operation', ['status']
+    'jupyterhub_server_stop_seconds', 'time taken for server stopping operation', ['status']
 )
 
 
@@ -148,7 +148,7 @@ for s in ServerStopStatus:
 
 
 PROXY_DELETE_DURATION_SECONDS = Histogram(
-    'jupyter_proxy_delete_duration_seconds',
+    'jupyterhub_proxy_delete_duration_seconds',
     'duration for deleting user routes from proxy',
     ['status'],
 )

From 73cdd687e9e2a435e544a956dd14ea7158367d31 Mon Sep 17 00:00:00 2001
From: agp8x <git@agp8x.org>
Date: Tue, 17 Nov 2020 15:36:30 +0100
Subject: [PATCH 05/46] fix formatting

---
 jupyterhub/metrics.py | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/jupyterhub/metrics.py b/jupyterhub/metrics.py
index 68aeb884..08037aef 100644
--- a/jupyterhub/metrics.py
+++ b/jupyterhub/metrics.py
@@ -42,7 +42,8 @@ RUNNING_SERVERS = Gauge(
 TOTAL_USERS = Gauge('jupyterhub_total_users', 'total number of users')
 
 CHECK_ROUTES_DURATION_SECONDS = Histogram(
-    'jupyterhub_check_routes_duration_seconds', 'Time taken to validate all routes in proxy'
+    'jupyterhub_check_routes_duration_seconds',
+    'Time taken to validate all routes in proxy',
 )
 
 HUB_STARTUP_DURATION_SECONDS = Histogram(
@@ -54,7 +55,8 @@ INIT_SPAWNERS_DURATION_SECONDS = Histogram(
 )
 
 PROXY_POLL_DURATION_SECONDS = Histogram(
-    'jupyterhub_proxy_poll_duration_seconds', 'duration for polling all routes from proxy'
+    'jupyterhub_proxy_poll_duration_seconds',
+    'duration for polling all routes from proxy',
 )
 
 
@@ -79,7 +81,9 @@ for s in ServerSpawnStatus:
 
 
 PROXY_ADD_DURATION_SECONDS = Histogram(
-    'jupyterhub_proxy_add_duration_seconds', 'duration for adding user routes to proxy', ['status']
+    'jupyterhub_proxy_add_duration_seconds',
+    'duration for adding user routes to proxy',
+    ['status'],
 )
 
 
@@ -127,7 +131,9 @@ for s in ServerPollStatus:
 
 
 SERVER_STOP_DURATION_SECONDS = Histogram(
-    'jupyterhub_server_stop_seconds', 'time taken for server stopping operation', ['status']
+    'jupyterhub_server_stop_seconds',
+    'time taken for server stopping operation',
+    ['status'],
 )
 
 

From fb5f98f2fa4566f1aa32534c9960ff9073e064eb Mon Sep 17 00:00:00 2001
From: Long Vu <vu.long@ouranos.ca>
Date: Tue, 17 Nov 2020 17:24:38 -0500
Subject: [PATCH 06/46] login page: add optional feature to accept terms and
 conditions in order to login

The feature is disabled by default.

If enabled (by setting `login_term_url`), user will have to check the
checkbox to accept the terms and conditions in order to login.
---
 share/jupyterhub/templates/login.html | 29 +++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/share/jupyterhub/templates/login.html b/share/jupyterhub/templates/login.html
index 130339c9..4aad65f5 100644
--- a/share/jupyterhub/templates/login.html
+++ b/share/jupyterhub/templates/login.html
@@ -63,6 +63,18 @@
       value='Sign In'
       tabindex="3"
     />
+
+    {% block login_terms %}
+    {% if login_term_url %}
+    <div id="login_terms" class="login_terms">
+    <input type="checkbox" id="login_terms_checkbox" name="login_terms_checkbox"/>
+    {% block login_terms_text %} {# allow overriding the text #}
+    By logging into the platform you accept the <a href="{{ login_term_url }}">terms and conditions</a>.
+    </div>
+    {% endblock login_terms_text %}
+    {% endif %}
+    {% endblock login_terms %}
+
   </div>
 </form>
 {% endif %}
@@ -81,4 +93,21 @@ if (window.location.protocol === "http:") {
 }
 </script>
 
+{% if login_term_url %}
+<script>
+// By default disable the login submit button, unless user check the terms and
+// conditions checkbox.
+var loginBtn = document.getElementById('login_submit');
+loginBtn.disabled = "disabled";
+
+document.getElementById('login_terms_checkbox').onclick = function() {
+    if ( this.checked ) {
+        loginBtn.disabled = "";
+    } else {
+        loginBtn.disabled = "disabled";
+    }
+};
+</script>
+{% endif %}
+
 {% endblock %}

From 11a85d1dc545a5e6295a607d5d09c4b026b3c3a9 Mon Sep 17 00:00:00 2001
From: Long Vu <vu.long@ouranos.ca>
Date: Wed, 18 Nov 2020 14:25:49 -0500
Subject: [PATCH 07/46] login page: allow full override of the optional accept
 terms and conditions feature

The text was already overridable but the endblock was at the wrong
location.

Now the javascript can also be overridden.
---
 share/jupyterhub/templates/login.html | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/share/jupyterhub/templates/login.html b/share/jupyterhub/templates/login.html
index 6df3c535..6a946d66 100644
--- a/share/jupyterhub/templates/login.html
+++ b/share/jupyterhub/templates/login.html
@@ -75,8 +75,8 @@
     <input type="checkbox" id="login_terms_checkbox" name="login_terms_checkbox"/>
     {% block login_terms_text %} {# allow overriding the text #}
     By logging into the platform you accept the <a href="{{ login_term_url }}">terms and conditions</a>.
-    </div>
     {% endblock login_terms_text %}
+    </div>
     {% endif %}
     {% endblock login_terms %}
 
@@ -105,6 +105,7 @@ $('form').submit((e) => {
 });
 </script>
 
+{% block login_terms_script %} {# allow overriding the javascript #}
 {% if login_term_url %}
 <script>
 // By default disable the login submit button, unless user check the terms and
@@ -121,5 +122,6 @@ document.getElementById('login_terms_checkbox').onclick = function() {
 };
 </script>
 {% endif %}
+{% endblock login_terms_script %}
 
 {% endblock %}

From b66d204d69ac12f423c2a7abfabaaf13acd52b6f Mon Sep 17 00:00:00 2001
From: Long Vu <vu.long@ouranos.ca>
Date: Wed, 25 Nov 2020 10:30:22 -0500
Subject: [PATCH 08/46] login page: no javascript needed for the optional
 accept terms and conditions feature

Bonus user gets a pop-up notification to check the checkbox.

Tested on Mozilla Firefox
(https://user-images.githubusercontent.com/11966697/100246404-18115e00-2f07-11eb-9061-d35434ace3aa.gif)
and Google Chrome.

Feedback from @minrk.
---
 share/jupyterhub/templates/login.html | 22 +---------------------
 1 file changed, 1 insertion(+), 21 deletions(-)

diff --git a/share/jupyterhub/templates/login.html b/share/jupyterhub/templates/login.html
index 6a946d66..98d43dc8 100644
--- a/share/jupyterhub/templates/login.html
+++ b/share/jupyterhub/templates/login.html
@@ -72,7 +72,7 @@
     {% block login_terms %}
     {% if login_term_url %}
     <div id="login_terms" class="login_terms">
-    <input type="checkbox" id="login_terms_checkbox" name="login_terms_checkbox"/>
+    <input type="checkbox" id="login_terms_checkbox" name="login_terms_checkbox" required />
     {% block login_terms_text %} {# allow overriding the text #}
     By logging into the platform you accept the <a href="{{ login_term_url }}">terms and conditions</a>.
     {% endblock login_terms_text %}
@@ -104,24 +104,4 @@ $('form').submit((e) => {
   form.find('.feedback-widget>*').toggleClass('fa-pulse');
 });
 </script>
-
-{% block login_terms_script %} {# allow overriding the javascript #}
-{% if login_term_url %}
-<script>
-// By default disable the login submit button, unless user check the terms and
-// conditions checkbox.
-var loginBtn = document.getElementById('login_submit');
-loginBtn.disabled = "disabled";
-
-document.getElementById('login_terms_checkbox').onclick = function() {
-    if ( this.checked ) {
-        loginBtn.disabled = "";
-    } else {
-        loginBtn.disabled = "disabled";
-    }
-};
-</script>
-{% endif %}
-{% endblock login_terms_script %}
-
 {% endblock %}

From e59ee33a6e823dbe89215f282b41ac763f9475b3 Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Wed, 2 Dec 2020 11:36:13 +0100
Subject: [PATCH 09/46] note versionchanged in metrics module docstring

---
 jupyterhub/metrics.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/jupyterhub/metrics.py b/jupyterhub/metrics.py
index 08037aef..2f50dfc2 100644
--- a/jupyterhub/metrics.py
+++ b/jupyterhub/metrics.py
@@ -5,7 +5,7 @@ Read https://prometheus.io/docs/practices/naming/ for naming
 conventions for metrics & labels. We generally prefer naming them
 `jupyterhub_<noun>_<verb>_<type_suffix>`. So a histogram that's tracking
 the duration (in seconds) of servers spawning would be called
-jupyterhub_SERVER_SPAWN_DURATION_SECONDS.
+jupyterhub_server_spawn_duration_seconds.
 
 We also create an Enum for each 'status' type label in every metric
 we collect. This is to make sure that the metrics exist regardless
@@ -14,6 +14,10 @@ create them, the metric spawn_duration_seconds{status="failure"}
 will not actually exist until the first failure. This makes dashboarding
 and alerting difficult, so we explicitly list statuses and create
 them manually here.
+
+.. versionchanged:: 1.3
+
+    added ``jupyterhub_`` prefix to metric names.
 """
 from enum import Enum
 

From f8040209b00c291e608edf1afa95370d910f44ac Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Wed, 2 Dec 2020 12:21:25 +0100
Subject: [PATCH 10/46] allow services to call /api/user to identify themselves

---
 jupyterhub/apihandlers/users.py |  6 +++++-
 jupyterhub/tests/test_api.py    | 11 +++++++++++
 2 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/jupyterhub/apihandlers/users.py b/jupyterhub/apihandlers/users.py
index 02975371..f427455d 100644
--- a/jupyterhub/apihandlers/users.py
+++ b/jupyterhub/apihandlers/users.py
@@ -36,7 +36,11 @@ class SelfAPIHandler(APIHandler):
             user = self.get_current_user_oauth_token()
         if user is None:
             raise web.HTTPError(403)
-        self.write(json.dumps(self.user_model(user)))
+        if isinstance(user, orm.Service):
+            model = self.service_model(user)
+        else:
+            model = self.user_model(user)
+        self.write(json.dumps(model))
 
 
 class UserListAPIHandler(APIHandler):
diff --git a/jupyterhub/tests/test_api.py b/jupyterhub/tests/test_api.py
index f6821f22..25b03566 100644
--- a/jupyterhub/tests/test_api.py
+++ b/jupyterhub/tests/test_api.py
@@ -277,6 +277,17 @@ async def test_get_self(app):
     assert r.status_code == 403
 
 
+async def test_get_self_service(app, mockservice):
+    r = await api_request(
+        app, "user", headers={"Authorization": f"token {mockservice.api_token}"}
+    )
+    r.raise_for_status()
+    service_info = r.json()
+
+    assert service_info['kind'] == 'service'
+    assert service_info['name'] == mockservice.name
+
+
 @mark.user
 async def test_add_user(app):
     db = app.db

From 9d38259ad7a87e3b1fbd66582a73f732276d1857 Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Wed, 2 Dec 2020 12:51:05 +0100
Subject: [PATCH 11/46] fix increasing pagination limits

setting per_page in constructor resolves before max_per_page limit is updated from config,
preventing max_per_page from being increased beyond the default limit

we already loaded these values anyway in the first instance,
so remove the redundant Pagination object
---
 jupyterhub/handlers/pages.py        | 12 +++---------
 jupyterhub/pagination.py            |  5 ++---
 jupyterhub/tests/test_pagination.py | 19 +++++++++++++------
 3 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/jupyterhub/handlers/pages.py b/jupyterhub/handlers/pages.py
index 98ebddec..0acbc0d5 100644
--- a/jupyterhub/handlers/pages.py
+++ b/jupyterhub/handlers/pages.py
@@ -457,7 +457,8 @@ class AdminHandler(BaseHandler):
     @web.authenticated
     @admin_only
     async def get(self):
-        page, per_page, offset = Pagination(config=self.config).get_page_args(self)
+        pagination = Pagination(url=self.request.uri, config=self.config)
+        page, per_page, offset = pagination.get_page_args(self)
 
         available = {'name', 'admin', 'running', 'last_activity'}
         default_sort = ['admin', 'name']
@@ -513,14 +514,7 @@ class AdminHandler(BaseHandler):
         for u in users:
             running.extend(s for s in u.spawners.values() if s.active)
 
-        total = self.db.query(orm.User.id).count()
-        pagination = Pagination(
-            url=self.request.uri,
-            total=total,
-            page=page,
-            per_page=per_page,
-            config=self.config,
-        )
+        pagination.total = self.db.query(orm.User.id).count()
 
         auth_state = await self.current_user.get_auth_state()
         html = await self.render_template(
diff --git a/jupyterhub/pagination.py b/jupyterhub/pagination.py
index dc315e7e..e7672caa 100644
--- a/jupyterhub/pagination.py
+++ b/jupyterhub/pagination.py
@@ -1,7 +1,6 @@
 """Basic class to manage pagination utils."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
-from traitlets import Bool
 from traitlets import default
 from traitlets import Integer
 from traitlets import observe
@@ -81,13 +80,13 @@ class Pagination(Configurable):
         try:
             self.per_page = int(per_page)
         except Exception:
-            self.per_page = self._default_per_page
+            self.per_page = self.default_per_page
 
         try:
             self.page = int(page)
             if self.page < 1:
                 self.page = 1
-        except:
+        except Exception:
             self.page = 1
 
         return self.page, self.per_page, self.per_page * (self.page - 1)
diff --git a/jupyterhub/tests/test_pagination.py b/jupyterhub/tests/test_pagination.py
index b9833eae..890c0854 100644
--- a/jupyterhub/tests/test_pagination.py
+++ b/jupyterhub/tests/test_pagination.py
@@ -6,11 +6,20 @@ from traitlets.config import Config
 from jupyterhub.pagination import Pagination
 
 
-def test_per_page_bounds():
+@mark.parametrize(
+    "per_page, max_per_page, expected",
+    [
+        (20, 10, 10),
+        (1000, 1000, 1000),
+    ],
+)
+def test_per_page_bounds(per_page, max_per_page, expected):
     cfg = Config()
-    cfg.Pagination.max_per_page = 10
-    p = Pagination(config=cfg, per_page=20, total=100)
-    assert p.per_page == 10
+    cfg.Pagination.max_per_page = max_per_page
+    p = Pagination(config=cfg)
+    p.per_page = per_page
+    p.total = 99999
+    assert p.per_page == expected
     with raises(Exception):
         p.per_page = 0
 
@@ -39,7 +48,5 @@ def test_per_page_bounds():
     ],
 )
 def test_window(page, per_page, total, expected):
-    cfg = Config()
-    cfg.Pagination
     pagination = Pagination(page=page, per_page=per_page, total=total)
     assert pagination.calculate_pages_window() == expected

From ed6231d3aa71f86ed059c285460bd051825af4b0 Mon Sep 17 00:00:00 2001
From: coffeebenzene <ericteo_no1@hotmail.com>
Date: Wed, 2 Dec 2020 17:57:28 +0000
Subject: [PATCH 12/46] Fix asyncio deprecation asyncio.Task.all_tasks

---
 jupyterhub/app.py   | 13 +++++++++----
 jupyterhub/utils.py | 10 +++++++++-
 2 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/jupyterhub/app.py b/jupyterhub/app.py
index b6d8571a..6cf4b093 100644
--- a/jupyterhub/app.py
+++ b/jupyterhub/app.py
@@ -29,6 +29,13 @@ from urllib.parse import urlunparse
 if sys.version_info[:2] < (3, 3):
     raise ValueError("Python < 3.3 not supported: %s" % sys.version)
 
+# For compatibility with python versions 3.6 or earlier.
+# asyncio.Task.all_tasks() is fully moved to asyncio.all_tasks() starting with 3.9. Also applies to current_task.
+try:
+    asyncio.all_tasks
+except AttributeError as e:
+    asyncio.all_tasks = asyncio.Task.all_tasks
+    asyncio.current_task = asyncio.Task.current_task
 
 from dateutil.parser import parse as parse_date
 from jinja2 import Environment, FileSystemLoader, PrefixLoader, ChoiceLoader
@@ -2817,9 +2824,7 @@ class JupyterHub(Application):
     async def shutdown_cancel_tasks(self, sig):
         """Cancel all other tasks of the event loop and initiate cleanup"""
         self.log.critical("Received signal %s, initiating shutdown...", sig.name)
-        tasks = [
-            t for t in asyncio.Task.all_tasks() if t is not asyncio.Task.current_task()
-        ]
+        tasks = [t for t in asyncio.all_tasks() if t is not asyncio.current_task()]
 
         if tasks:
             self.log.debug("Cancelling pending tasks")
@@ -2832,7 +2837,7 @@ class JupyterHub(Application):
             except StopAsyncIteration as e:
                 self.log.error("Caught StopAsyncIteration Exception", exc_info=True)
 
-            tasks = [t for t in asyncio.Task.all_tasks()]
+            tasks = [t for t in asyncio.all_tasks()]
             for t in tasks:
                 self.log.debug("Task status: %s", t)
         await self.cleanup()
diff --git a/jupyterhub/utils.py b/jupyterhub/utils.py
index 8fcf7bc6..a5b221e8 100644
--- a/jupyterhub/utils.py
+++ b/jupyterhub/utils.py
@@ -28,6 +28,14 @@ from tornado.httpclient import HTTPError
 from tornado.log import app_log
 from tornado.platform.asyncio import to_asyncio_future
 
+# For compatibility with python versions 3.6 or earlier.
+# asyncio.Task.all_tasks() is fully moved to asyncio.all_tasks() starting with 3.9. Also applies to current_task.
+try:
+    asyncio.all_tasks
+except AttributeError as e:
+    asyncio.all_tasks = asyncio.Task.all_tasks
+    asyncio.current_task = asyncio.Task.current_task
+
 
 def random_port():
     """Get a single random port."""
@@ -474,7 +482,7 @@ def print_stacks(file=sys.stderr):
     # also show asyncio tasks, if any
     # this will increase over time as we transition from tornado
     # coroutines to native `async def`
-    tasks = asyncio.Task.all_tasks()
+    tasks = asyncio.all_tasks()
     if tasks:
         print("AsyncIO tasks: %i" % len(tasks))
         for task in tasks:

From f866bbcf454fc521bf26515c4b8e8a3afb28a366 Mon Sep 17 00:00:00 2001
From: coffeebenzene <ericteo_no1@hotmail.com>
Date: Wed, 2 Dec 2020 19:50:49 +0000
Subject: [PATCH 13/46] Use variable instead of monkey patching asyncio

---
 jupyterhub/app.py   | 11 ++++++-----
 jupyterhub/utils.py |  9 +++++----
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/jupyterhub/app.py b/jupyterhub/app.py
index 6cf4b093..a3bc17e0 100644
--- a/jupyterhub/app.py
+++ b/jupyterhub/app.py
@@ -32,10 +32,11 @@ if sys.version_info[:2] < (3, 3):
 # For compatibility with python versions 3.6 or earlier.
 # asyncio.Task.all_tasks() is fully moved to asyncio.all_tasks() starting with 3.9. Also applies to current_task.
 try:
-    asyncio.all_tasks
+    asyncio_all_tasks = asyncio.all_tasks
+    asyncio_current_task = asyncio.current_task
 except AttributeError as e:
-    asyncio.all_tasks = asyncio.Task.all_tasks
-    asyncio.current_task = asyncio.Task.current_task
+    asyncio_all_tasks = asyncio.Task.all_tasks
+    asyncio_current_task = asyncio.Task.current_task
 
 from dateutil.parser import parse as parse_date
 from jinja2 import Environment, FileSystemLoader, PrefixLoader, ChoiceLoader
@@ -2824,7 +2825,7 @@ class JupyterHub(Application):
     async def shutdown_cancel_tasks(self, sig):
         """Cancel all other tasks of the event loop and initiate cleanup"""
         self.log.critical("Received signal %s, initiating shutdown...", sig.name)
-        tasks = [t for t in asyncio.all_tasks() if t is not asyncio.current_task()]
+        tasks = [t for t in asyncio_all_tasks() if t is not asyncio_current_task()]
 
         if tasks:
             self.log.debug("Cancelling pending tasks")
@@ -2837,7 +2838,7 @@ class JupyterHub(Application):
             except StopAsyncIteration as e:
                 self.log.error("Caught StopAsyncIteration Exception", exc_info=True)
 
-            tasks = [t for t in asyncio.all_tasks()]
+            tasks = [t for t in asyncio_all_tasks()]
             for t in tasks:
                 self.log.debug("Task status: %s", t)
         await self.cleanup()
diff --git a/jupyterhub/utils.py b/jupyterhub/utils.py
index a5b221e8..e8c86bd0 100644
--- a/jupyterhub/utils.py
+++ b/jupyterhub/utils.py
@@ -31,10 +31,11 @@ from tornado.platform.asyncio import to_asyncio_future
 # For compatibility with python versions 3.6 or earlier.
 # asyncio.Task.all_tasks() is fully moved to asyncio.all_tasks() starting with 3.9. Also applies to current_task.
 try:
-    asyncio.all_tasks
+    asyncio_all_tasks = asyncio.all_tasks
+    asyncio_current_task = asyncio.current_task
 except AttributeError as e:
-    asyncio.all_tasks = asyncio.Task.all_tasks
-    asyncio.current_task = asyncio.Task.current_task
+    asyncio_all_tasks = asyncio.Task.all_tasks
+    asyncio_current_task = asyncio.Task.current_task
 
 
 def random_port():
@@ -482,7 +483,7 @@ def print_stacks(file=sys.stderr):
     # also show asyncio tasks, if any
     # this will increase over time as we transition from tornado
     # coroutines to native `async def`
-    tasks = asyncio.all_tasks()
+    tasks = asyncio_all_tasks()
     if tasks:
         print("AsyncIO tasks: %i" % len(tasks))
         for task in tasks:

From 6e161d01401ca2b8cfe2a9e35944a8b739758b94 Mon Sep 17 00:00:00 2001
From: Geoffroy Youri Berret <kaliko@azylum.org>
Date: Fri, 4 Dec 2020 09:19:37 +0100
Subject: [PATCH 14/46] Fixed idle-culler references.

Merge request #3257 fixed #3256 only on getting-started/services-basics.md
There is still a reference to jupyterhub example cull-idle in reference/services.md
---
 docs/source/reference/services.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/source/reference/services.md b/docs/source/reference/services.md
index d477163b..fef2a964 100644
--- a/docs/source/reference/services.md
+++ b/docs/source/reference/services.md
@@ -91,9 +91,9 @@ This example would be configured as follows in `jupyterhub_config.py`:
 ```python
 c.JupyterHub.services = [
     {
-        'name': 'cull-idle',
+        'name': 'idle-culler',
         'admin': True,
-        'command': [sys.executable, '/path/to/cull-idle.py', '--timeout']
+        'command': [sys.executable, '-m', 'jupyterhub_idle_culler', '--timeout=3600']
     }
 ]
 ```
@@ -123,15 +123,14 @@ For the previous 'cull idle' Service example, these environment variables
 would be passed to the Service when the Hub starts the 'cull idle' Service:
 
 ```bash
-JUPYTERHUB_SERVICE_NAME: 'cull-idle'
+JUPYTERHUB_SERVICE_NAME: 'idle-culler'
 JUPYTERHUB_API_TOKEN: API token assigned to the service
 JUPYTERHUB_API_URL: http://127.0.0.1:8080/hub/api
 JUPYTERHUB_BASE_URL: https://mydomain[:port]
-JUPYTERHUB_SERVICE_PREFIX: /services/cull-idle/
+JUPYTERHUB_SERVICE_PREFIX: /services/idle-culler/
 ```
 
-See the JupyterHub GitHub repo for additional information about the
-[`cull-idle` example](https://github.com/jupyterhub/jupyterhub/tree/master/examples/cull-idle).
+See the GitHub repo for additional information about the [jupyterhub_idle_culler][].
 
 ## Externally-Managed Services
 
@@ -376,3 +375,4 @@ section on securing the notebook viewer.
 [HubAuth.user_for_token]: ../api/services.auth.html#jupyterhub.services.auth.HubAuth.user_for_token
 [HubAuthenticated]: ../api/services.auth.html#jupyterhub.services.auth.HubAuthenticated
 [nbviewer example]: https://github.com/jupyter/nbviewer#securing-the-notebook-viewer
+[jupyterhub_idle_culler]: https://github.com/jupyterhub/jupyterhub-idle-culler

From 2cf8e48fb59abb6ce76d1b7b17d953dbf0c7000a Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Wed, 2 Dec 2020 15:25:43 +0100
Subject: [PATCH 15/46] start changelog for 1.3

I noticed that our jinja async feature is new in 2.9, and matured in 2.11, so explicitly require that
---
 docs/source/changelog.md | 55 ++++++++++++++++++++++++++++++++++++++++
 requirements.txt         |  2 +-
 2 files changed, 56 insertions(+), 1 deletion(-)

diff --git a/docs/source/changelog.md b/docs/source/changelog.md
index 6a032337..dce07ea4 100644
--- a/docs/source/changelog.md
+++ b/docs/source/changelog.md
@@ -7,6 +7,61 @@ command line for details.
 
 ## [Unreleased]
 
+### 1.3
+
+JupyterHub 1.3 is a small feature release. Highlights include:
+
+- Require Python >=3.6 (jupyterhub 1.2 is the last release to support 3.5)
+- Add a `?state=` filter for getting user list, allowing much quicker responses
+  when retrieving a small fraction of users.
+  `state` can be `active`, `inactive`, or `ready`.
+- prometheus metrics now include a `jupyterhub_` prefix,
+  so deployments may need to update their grafana charts to match.
+- page templates can now be [async](https://jinja.palletsprojects.com/en/2.11.x/api/#async-support)!
+
+
+#### 1.3.0 1.2.1...master@{2020-12-09}
+
+([full changelog](https://github.com/jupyterhub/jupyterhub/compare/1.2.1...ae77038a6469a976a352bb0b6c24243bab94b773))
+
+#### Enhancements made
+
+* allow services to call /api/user to identify themselves [#3293](https://github.com/jupyterhub/jupyterhub/pull/3293) ([@minrk](https://github.com/minrk))
+* Add optional user agreement to login screen [#3264](https://github.com/jupyterhub/jupyterhub/pull/3264) ([@tlvu](https://github.com/tlvu))
+* [Metrics] Add prefix to prometheus metrics to group all jupyterhub metrics  [#3243](https://github.com/jupyterhub/jupyterhub/pull/3243) ([@agp8x](https://github.com/agp8x))
+* Allow options_from_form to be configurable [#3225](https://github.com/jupyterhub/jupyterhub/pull/3225) ([@cbanek](https://github.com/cbanek))
+* add ?state= filter for GET /users [#3177](https://github.com/jupyterhub/jupyterhub/pull/3177) ([@minrk](https://github.com/minrk))
+* Enable async support in jinja2 templates [#3176](https://github.com/jupyterhub/jupyterhub/pull/3176) ([@yuvipanda](https://github.com/yuvipanda))
+
+#### Bugs fixed
+
+* fix increasing pagination limits [#3294](https://github.com/jupyterhub/jupyterhub/pull/3294) ([@minrk](https://github.com/minrk))
+* fix and test TOTAL_USERS count [#3289](https://github.com/jupyterhub/jupyterhub/pull/3289) ([@minrk](https://github.com/minrk))
+* Fix asyncio deprecation asyncio.Task.all_tasks [#3298](https://github.com/jupyterhub/jupyterhub/pull/3298) ([@coffeebenzene](https://github.com/coffeebenzene))
+
+#### Maintenance and upkeep improvements
+
+* bump oldest-required prometheus-client [#3292](https://github.com/jupyterhub/jupyterhub/pull/3292) ([@minrk](https://github.com/minrk))
+* bump black pre-commit hook to 20.8 [#3287](https://github.com/jupyterhub/jupyterhub/pull/3287) ([@minrk](https://github.com/minrk))
+* Test internal_ssl separately [#3266](https://github.com/jupyterhub/jupyterhub/pull/3266) ([@0mar](https://github.com/0mar))
+* wait for pending spawns in spawn_form_admin_access [#3253](https://github.com/jupyterhub/jupyterhub/pull/3253) ([@minrk](https://github.com/minrk))
+* Assume py36 and remove @gen.coroutine etc. [#3242](https://github.com/jupyterhub/jupyterhub/pull/3242) ([@consideRatio](https://github.com/consideRatio))
+
+#### Documentation improvements
+
+* Fix curl in jupyter announcements [#3286](https://github.com/jupyterhub/jupyterhub/pull/3286) ([@Sangarshanan](https://github.com/Sangarshanan))
+* CONTRIBUTING: Fix contributor guide URL [#3281](https://github.com/jupyterhub/jupyterhub/pull/3281) ([@olifre](https://github.com/olifre))
+* Update services.md [#3267](https://github.com/jupyterhub/jupyterhub/pull/3267) ([@slemonide](https://github.com/slemonide))
+* [Docs] Fix https reverse proxy redirect issues [#3244](https://github.com/jupyterhub/jupyterhub/pull/3244) ([@mhwasil](https://github.com/mhwasil))
+* Fixed idle-culler references. [#3300](https://github.com/jupyterhub/jupyterhub/pull/3300) ([@mxjeff](https://github.com/mxjeff))
+
+#### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyterhub/jupyterhub/graphs/contributors?from=2020-10-30&to=2020-12-09&type=c))
+
+[@0mar](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3A0mar+updated%3A2020-10-30..2020-12-09&type=Issues) | [@agp8x](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aagp8x+updated%3A2020-10-30..2020-12-09&type=Issues) | [@alexweav](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aalexweav+updated%3A2020-10-30..2020-12-09&type=Issues) | [@belfhi](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Abelfhi+updated%3A2020-10-30..2020-12-09&type=Issues) | [@betatim](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Abetatim+updated%3A2020-10-30..2020-12-09&type=Issues) | [@cbanek](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Acbanek+updated%3A2020-10-30..2020-12-09&type=Issues) | [@cmd-ntrf](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Acmd-ntrf+updated%3A2020-10-30..2020-12-09&type=Issues) | [@coffeebenzene](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Acoffeebenzene+updated%3A2020-10-30..2020-12-09&type=Issues) | [@consideRatio](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3AconsideRatio+updated%3A2020-10-30..2020-12-09&type=Issues) | [@danlester](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Adanlester+updated%3A2020-10-30..2020-12-09&type=Issues) | [@fcollonval](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Afcollonval+updated%3A2020-10-30..2020-12-09&type=Issues) | [@GeorgianaElena](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3AGeorgianaElena+updated%3A2020-10-30..2020-12-09&type=Issues) | [@ianabc](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aianabc+updated%3A2020-10-30..2020-12-09&type=Issues) | [@IvanaH8](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3AIvanaH8+updated%3A2020-10-30..2020-12-09&type=Issues) | [@manics](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amanics+updated%3A2020-10-30..2020-12-09&type=Issues) | [@meeseeksmachine](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Ameeseeksmachine+updated%3A2020-10-30..2020-12-09&type=Issues) | [@mhwasil](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amhwasil+updated%3A2020-10-30..2020-12-09&type=Issues) | [@minrk](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aminrk+updated%3A2020-10-30..2020-12-09&type=Issues) | [@mriedem](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amriedem+updated%3A2020-10-30..2020-12-09&type=Issues) | [@mxjeff](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amxjeff+updated%3A2020-10-30..2020-12-09&type=Issues) | [@olifre](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aolifre+updated%3A2020-10-30..2020-12-09&type=Issues) | [@rcthomas](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Arcthomas+updated%3A2020-10-30..2020-12-09&type=Issues) | [@rgbkrk](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Argbkrk+updated%3A2020-10-30..2020-12-09&type=Issues) | [@rkdarst](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Arkdarst+updated%3A2020-10-30..2020-12-09&type=Issues) | [@Sangarshanan](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3ASangarshanan+updated%3A2020-10-30..2020-12-09&type=Issues) | [@slemonide](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aslemonide+updated%3A2020-10-30..2020-12-09&type=Issues) | [@support](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Asupport+updated%3A2020-10-30..2020-12-09&type=Issues) | [@tlvu](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Atlvu+updated%3A2020-10-30..2020-12-09&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Awelcome+updated%3A2020-10-30..2020-12-09&type=Issues) | [@yuvipanda](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Ayuvipanda+updated%3A2020-10-30..2020-12-09&type=Issues)
+
+
 ## 1.2
 
 ### [1.2.2] 2020-11-27
diff --git a/requirements.txt b/requirements.txt
index e54e8f11..3c4481be 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,7 +2,7 @@ alembic
 async_generator>=1.9
 certipy>=0.1.2
 entrypoints
-jinja2
+jinja2>=2.11.0
 jupyter_telemetry>=0.1.0
 oauthlib>=3.0
 pamela; sys_platform != 'win32'

From 55c2d3648ed8823a45520f5a214f5d2721661d00 Mon Sep 17 00:00:00 2001
From: sangarshanan <sangarshanan1998@gmail.com>
Date: Fri, 11 Dec 2020 01:53:35 +0530
Subject: [PATCH 16/46] Add the missing parenthesis in service.md

---
 docs/source/reference/services.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/source/reference/services.md b/docs/source/reference/services.md
index fef2a964..cebe1d1b 100644
--- a/docs/source/reference/services.md
+++ b/docs/source/reference/services.md
@@ -346,7 +346,7 @@ and taking note of the following process:
         headers = {
             'Authorization' : 'token %s' % api_token,
         },
-    )
+    ))
     r.raise_for_status()
     user = r.json()
     ```

From 8ede92495650233358361ca929db1ab9497ab048 Mon Sep 17 00:00:00 2001
From: sangarshanan <sangarshanan1998@gmail.com>
Date: Fri, 11 Dec 2020 13:15:13 +0530
Subject: [PATCH 17/46] Remove extra paranthesis

---
 docs/source/reference/services.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/source/reference/services.md b/docs/source/reference/services.md
index cebe1d1b..603234b0 100644
--- a/docs/source/reference/services.md
+++ b/docs/source/reference/services.md
@@ -339,14 +339,14 @@ and taking note of the following process:
 
     ```python
     r = requests.get(
-        '/'.join((["http://127.0.0.1:8081/hub/api",
+        '/'.join(["http://127.0.0.1:8081/hub/api",
                    "authorizations/cookie/jupyterhub-services",
                    quote(encrypted_cookie, safe=''),
         ]),
         headers = {
             'Authorization' : 'token %s' % api_token,
         },
-    ))
+    )
     r.raise_for_status()
     user = r.json()
     ```

From 88706d4c27728a3d2c05c33e8118368f6505e1b2 Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Fri, 11 Dec 2020 12:07:06 +0100
Subject: [PATCH 18/46] final changelog edits for 1.3.0

---
 docs/source/changelog.md | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/docs/source/changelog.md b/docs/source/changelog.md
index dce07ea4..ffa2c029 100644
--- a/docs/source/changelog.md
+++ b/docs/source/changelog.md
@@ -19,10 +19,9 @@ JupyterHub 1.3 is a small feature release. Highlights include:
   so deployments may need to update their grafana charts to match.
 - page templates can now be [async](https://jinja.palletsprojects.com/en/2.11.x/api/#async-support)!
 
+### [1.3.0]
 
-#### 1.3.0 1.2.1...master@{2020-12-09}
-
-([full changelog](https://github.com/jupyterhub/jupyterhub/compare/1.2.1...ae77038a6469a976a352bb0b6c24243bab94b773))
+([full changelog](https://github.com/jupyterhub/jupyterhub/compare/1.2.1...1.3.0))
 
 #### Enhancements made
 
@@ -54,12 +53,14 @@ JupyterHub 1.3 is a small feature release. Highlights include:
 * Update services.md [#3267](https://github.com/jupyterhub/jupyterhub/pull/3267) ([@slemonide](https://github.com/slemonide))
 * [Docs] Fix https reverse proxy redirect issues [#3244](https://github.com/jupyterhub/jupyterhub/pull/3244) ([@mhwasil](https://github.com/mhwasil))
 * Fixed idle-culler references. [#3300](https://github.com/jupyterhub/jupyterhub/pull/3300) ([@mxjeff](https://github.com/mxjeff))
+* Remove the extra parenthesis in service.md [#3303](https://github.com/jupyterhub/jupyterhub/pull/3303) ([@Sangarshanan](https://github.com/Sangarshanan))
+
 
 #### Contributors to this release
 
-([GitHub contributors page for this release](https://github.com/jupyterhub/jupyterhub/graphs/contributors?from=2020-10-30&to=2020-12-09&type=c))
+([GitHub contributors page for this release](https://github.com/jupyterhub/jupyterhub/graphs/contributors?from=2020-10-30&to=2020-12-11&type=c))
 
-[@0mar](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3A0mar+updated%3A2020-10-30..2020-12-09&type=Issues) | [@agp8x](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aagp8x+updated%3A2020-10-30..2020-12-09&type=Issues) | [@alexweav](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aalexweav+updated%3A2020-10-30..2020-12-09&type=Issues) | [@belfhi](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Abelfhi+updated%3A2020-10-30..2020-12-09&type=Issues) | [@betatim](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Abetatim+updated%3A2020-10-30..2020-12-09&type=Issues) | [@cbanek](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Acbanek+updated%3A2020-10-30..2020-12-09&type=Issues) | [@cmd-ntrf](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Acmd-ntrf+updated%3A2020-10-30..2020-12-09&type=Issues) | [@coffeebenzene](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Acoffeebenzene+updated%3A2020-10-30..2020-12-09&type=Issues) | [@consideRatio](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3AconsideRatio+updated%3A2020-10-30..2020-12-09&type=Issues) | [@danlester](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Adanlester+updated%3A2020-10-30..2020-12-09&type=Issues) | [@fcollonval](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Afcollonval+updated%3A2020-10-30..2020-12-09&type=Issues) | [@GeorgianaElena](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3AGeorgianaElena+updated%3A2020-10-30..2020-12-09&type=Issues) | [@ianabc](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aianabc+updated%3A2020-10-30..2020-12-09&type=Issues) | [@IvanaH8](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3AIvanaH8+updated%3A2020-10-30..2020-12-09&type=Issues) | [@manics](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amanics+updated%3A2020-10-30..2020-12-09&type=Issues) | [@meeseeksmachine](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Ameeseeksmachine+updated%3A2020-10-30..2020-12-09&type=Issues) | [@mhwasil](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amhwasil+updated%3A2020-10-30..2020-12-09&type=Issues) | [@minrk](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aminrk+updated%3A2020-10-30..2020-12-09&type=Issues) | [@mriedem](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amriedem+updated%3A2020-10-30..2020-12-09&type=Issues) | [@mxjeff](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amxjeff+updated%3A2020-10-30..2020-12-09&type=Issues) | [@olifre](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aolifre+updated%3A2020-10-30..2020-12-09&type=Issues) | [@rcthomas](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Arcthomas+updated%3A2020-10-30..2020-12-09&type=Issues) | [@rgbkrk](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Argbkrk+updated%3A2020-10-30..2020-12-09&type=Issues) | [@rkdarst](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Arkdarst+updated%3A2020-10-30..2020-12-09&type=Issues) | [@Sangarshanan](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3ASangarshanan+updated%3A2020-10-30..2020-12-09&type=Issues) | [@slemonide](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aslemonide+updated%3A2020-10-30..2020-12-09&type=Issues) | [@support](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Asupport+updated%3A2020-10-30..2020-12-09&type=Issues) | [@tlvu](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Atlvu+updated%3A2020-10-30..2020-12-09&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Awelcome+updated%3A2020-10-30..2020-12-09&type=Issues) | [@yuvipanda](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Ayuvipanda+updated%3A2020-10-30..2020-12-09&type=Issues)
+[@0mar](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3A0mar+updated%3A2020-10-30..2020-12-11&type=Issues) | [@agp8x](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aagp8x+updated%3A2020-10-30..2020-12-11&type=Issues) | [@alexweav](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aalexweav+updated%3A2020-10-30..2020-12-11&type=Issues) | [@belfhi](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Abelfhi+updated%3A2020-10-30..2020-12-11&type=Issues) | [@betatim](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Abetatim+updated%3A2020-10-30..2020-12-11&type=Issues) | [@cbanek](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Acbanek+updated%3A2020-10-30..2020-12-11&type=Issues) | [@cmd-ntrf](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Acmd-ntrf+updated%3A2020-10-30..2020-12-11&type=Issues) | [@coffeebenzene](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Acoffeebenzene+updated%3A2020-10-30..2020-12-11&type=Issues) | [@consideRatio](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3AconsideRatio+updated%3A2020-10-30..2020-12-11&type=Issues) | [@danlester](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Adanlester+updated%3A2020-10-30..2020-12-11&type=Issues) | [@fcollonval](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Afcollonval+updated%3A2020-10-30..2020-12-11&type=Issues) | [@GeorgianaElena](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3AGeorgianaElena+updated%3A2020-10-30..2020-12-11&type=Issues) | [@ianabc](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aianabc+updated%3A2020-10-30..2020-12-11&type=Issues) | [@IvanaH8](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3AIvanaH8+updated%3A2020-10-30..2020-12-11&type=Issues) | [@manics](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amanics+updated%3A2020-10-30..2020-12-11&type=Issues) | [@meeseeksmachine](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Ameeseeksmachine+updated%3A2020-10-30..2020-12-11&type=Issues) | [@mhwasil](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amhwasil+updated%3A2020-10-30..2020-12-11&type=Issues) | [@minrk](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aminrk+updated%3A2020-10-30..2020-12-11&type=Issues) | [@mriedem](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amriedem+updated%3A2020-10-30..2020-12-11&type=Issues) | [@mxjeff](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Amxjeff+updated%3A2020-10-30..2020-12-11&type=Issues) | [@olifre](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aolifre+updated%3A2020-10-30..2020-12-11&type=Issues) | [@rcthomas](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Arcthomas+updated%3A2020-10-30..2020-12-11&type=Issues) | [@rgbkrk](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Argbkrk+updated%3A2020-10-30..2020-12-11&type=Issues) | [@rkdarst](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Arkdarst+updated%3A2020-10-30..2020-12-11&type=Issues) | [@Sangarshanan](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3ASangarshanan+updated%3A2020-10-30..2020-12-11&type=Issues) | [@slemonide](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Aslemonide+updated%3A2020-10-30..2020-12-11&type=Issues) | [@support](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Asupport+updated%3A2020-10-30..2020-12-11&type=Issues) | [@tlvu](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Atlvu+updated%3A2020-10-30..2020-12-11&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Awelcome+updated%3A2020-10-30..2020-12-11&type=Issues) | [@yuvipanda](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyterhub+involves%3Ayuvipanda+updated%3A2020-10-30..2020-12-11&type=Issues)
 
 
 ## 1.2
@@ -966,7 +967,9 @@ Fix removal of `/login` page in 0.4.0, breaking some OAuth providers.
 First preview release
 
 
-[Unreleased]: https://github.com/jupyterhub/jupyterhub/compare/1.2.1...HEAD
+[Unreleased]: https://github.com/jupyterhub/jupyterhub/compare/1.3.0...HEAD
+[1.3.0]: https://github.com/jupyterhub/jupyterhub/compare/1.2.1...1.3.0
+[1.2.2]: https://github.com/jupyterhub/jupyterhub/compare/1.2.1...1.2.2
 [1.2.1]: https://github.com/jupyterhub/jupyterhub/compare/1.2.0...1.2.1
 [1.2.0]: https://github.com/jupyterhub/jupyterhub/compare/1.1.0...1.2.0
 [1.1.0]: https://github.com/jupyterhub/jupyterhub/compare/1.0.0...1.1.0

From a91197635ab1a9d8c9b3d2e83b4f213d0d535d8d Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Fri, 11 Dec 2020 12:07:55 +0100
Subject: [PATCH 19/46] release 1.3.0

---
 jupyterhub/_version.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/jupyterhub/_version.py b/jupyterhub/_version.py
index 58b0bff5..3e6427cd 100644
--- a/jupyterhub/_version.py
+++ b/jupyterhub/_version.py
@@ -7,7 +7,7 @@ version_info = (
     3,
     0,
     "",  # release (b1, rc1, or "" for final or dev)
-    "dev",  # dev or nothing for beta/rc/stable releases
+    # "dev",  # dev or nothing for beta/rc/stable releases
 )
 
 # pep 440 version: no dot before beta/rc, but before .dev

From f6f6b3afa3df6a31c17fc10c652b9f415b2bc62b Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Fri, 11 Dec 2020 12:08:22 +0100
Subject: [PATCH 20/46] back to dev

---
 jupyterhub/_version.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/jupyterhub/_version.py b/jupyterhub/_version.py
index 3e6427cd..591bafc5 100644
--- a/jupyterhub/_version.py
+++ b/jupyterhub/_version.py
@@ -4,10 +4,10 @@
 
 version_info = (
     1,
-    3,
+    4,
     0,
     "",  # release (b1, rc1, or "" for final or dev)
-    # "dev",  # dev or nothing for beta/rc/stable releases
+    "dev",  # dev or nothing for beta/rc/stable releases
 )
 
 # pep 440 version: no dot before beta/rc, but before .dev

From 7c474396f138aa05791af2be5163265b48cb3b5c Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Fri, 11 Dec 2020 12:27:34 +0100
Subject: [PATCH 21/46] publish releases from github actions

---
 .github/workflows/release.yml | 61 +++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 .github/workflows/release.yml

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 00000000..8b54bfd4
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,61 @@
+# Build releases and (on tags) publish to PyPI
+name: Release
+
+# always build releases (to make sure wheel-building works)
+# but only publish to PyPI on tags
+on:
+  push:
+  pull_request:
+
+jobs:
+  build-release:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "14"
+
+      - name: install build package
+        run: |
+          pip install --upgrade pip
+          pip install build
+          pip freeze
+
+      - name: build release
+        run: |
+          python -m build --sdist --wheel .
+          ls -l dist
+
+      - name: verify wheel
+        run: |
+          cd dist
+          pip install ./*.whl
+          # verify data-files are installed where they are found
+          cat <<EOF | python
+          import os
+          from jupyterhub._data import DATA_FILES_PATH
+          print(f"DATA_FILES_PATH={DATA_FILES_PATH}")
+          assert os.path.exists(DATA_FILES_PATH), DATA_FILES_PATH
+          for subpath in (
+              "templates/page.html",
+              "static/css/style.min.css",
+              "static/components/jquery/dist/jquery.js",
+          ):
+              path = os.path.join(DATA_FILES_PATH, subpath)
+              assert os.path.exists(path), path
+          print("OK")
+          EOF
+
+      - name: Publish to PyPI
+        if: startsWith(github.ref, 'refs/tags/')
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          pip install twine
+          twine upload --skip-existing dist/*

From 1e53fd1f8cf2ba6c3761c10318c5f754050d5fba Mon Sep 17 00:00:00 2001
From: Tim Gates <tim.gates@iress.com>
Date: Wed, 23 Dec 2020 11:54:51 +1100
Subject: [PATCH 22/46] docs: fix simple typo, funciton -> function

There is a small typo in jupyterhub/orm.py.

Should read `function` rather than `funciton`.
---
 jupyterhub/orm.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/jupyterhub/orm.py b/jupyterhub/orm.py
index cc96ca88..dca18f04 100644
--- a/jupyterhub/orm.py
+++ b/jupyterhub/orm.py
@@ -318,7 +318,7 @@ class Expiring:
     which should be unix timestamp or datetime object
     """
 
-    now = utcnow  # funciton, must return float timestamp or datetime
+    now = utcnow  # function, must return float timestamp or datetime
     expires_at = None  # must be defined
 
     @property

From 147167e58998ff2e722dad6679775a375abf8606 Mon Sep 17 00:00:00 2001
From: Erik Sundell <erik.i.sundell@gmail.com>
Date: Fri, 8 Jan 2021 01:16:06 +0100
Subject: [PATCH 23/46] ci: allow tests to be run manually through github UI

---
 .github/workflows/test.yml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index b7785e68..250f616b 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -1,7 +1,7 @@
 # This is a GitHub workflow defining a set of jobs with a set of steps.
 # ref: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions
 #
-name: Run tests
+name: Test
 
 # Trigger the workflow's on all PRs but only on pushed tags or commits to
 # main/master branch to avoid PRs developed in a GitHub fork's dedicated branch
@@ -9,6 +9,7 @@ name: Run tests
 on:
   pull_request:
   push:
+  workflow_dispatch:
 
 defaults:
   run:

From 8e603e5212dabf5ae146ff0ac5d48c845bfa1564 Mon Sep 17 00:00:00 2001
From: Erik Sundell <erik.i.sundell@gmail.com>
Date: Fri, 8 Jan 2021 01:16:29 +0100
Subject: [PATCH 24/46] docs: update README.md badge for github actions

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 28afd74e..f335f2e5 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@
 [![Latest PyPI version](https://img.shields.io/pypi/v/jupyterhub?logo=pypi)](https://pypi.python.org/pypi/jupyterhub)
 [![Latest conda-forge version](https://img.shields.io/conda/vn/conda-forge/jupyterhub?logo=conda-forge)](https://www.npmjs.com/package/jupyterhub)
 [![Documentation build status](https://img.shields.io/readthedocs/jupyterhub?logo=read-the-docs)](https://jupyterhub.readthedocs.org/en/latest/)
-[![TravisCI build status](https://img.shields.io/travis/com/jupyterhub/jupyterhub?logo=travis)](https://travis-ci.com/jupyterhub/jupyterhub)
+[![GitHub Workflow Status - Test](https://img.shields.io/github/workflow/status/jupyterhub/jupyterhub/Test?logo=github&label=tests)](https://github.com/jupyterhub/jupyterhub/actions)
 [![DockerHub build status](https://img.shields.io/docker/build/jupyterhub/jupyterhub?logo=docker&label=build)](https://hub.docker.com/r/jupyterhub/jupyterhub/tags)
 [![CircleCI build status](https://img.shields.io/circleci/build/github/jupyterhub/jupyterhub?logo=circleci)](https://circleci.com/gh/jupyterhub/jupyterhub)<!-- CircleCI Token: b5b65862eb2617b9a8d39e79340b0a6b816da8cc -->
 [![Test coverage of code](https://codecov.io/gh/jupyterhub/jupyterhub/branch/master/graph/badge.svg)](https://codecov.io/gh/jupyterhub/jupyterhub)

From 4dbe5490f8c1f122b146228c9a28d93418669f70 Mon Sep 17 00:00:00 2001
From: Andre Wisplinghoff <andre.wisplinghoff@gmail.com>
Date: Fri, 8 Jan 2021 11:39:09 +0100
Subject: [PATCH 25/46] Fix mixup in comment regarding the sync parameter

---
 jupyterhub/handlers/base.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/jupyterhub/handlers/base.py b/jupyterhub/handlers/base.py
index 0db1660c..e08e083e 100644
--- a/jupyterhub/handlers/base.py
+++ b/jupyterhub/handlers/base.py
@@ -1186,8 +1186,8 @@ class BaseHandler(RequestHandler):
         """
         Render jinja2 template
 
-        If sync is set to True, we return an awaitable
-        If sync is set to False, we render the template & return a string
+        If sync is set to True, we render the template & return a string
+        If sync is set to False, we return an awaitable
         """
         template_ns = {}
         template_ns.update(self.template_namespace)

From f69ef9f846b2b65d708d43101b51f4340e8b0b0b Mon Sep 17 00:00:00 2001
From: Zsailer <zsailer@apple.com>
Date: Mon, 11 Jan 2021 16:48:52 -0800
Subject: [PATCH 26/46] add docs describing jupyter_server

---
 docs/source/reference/config-user-env.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/source/reference/config-user-env.md b/docs/source/reference/config-user-env.md
index c085b106..4a378831 100644
--- a/docs/source/reference/config-user-env.md
+++ b/docs/source/reference/config-user-env.md
@@ -179,3 +179,13 @@ The number of named servers per user can be limited by setting
 ```python
 c.JupyterHub.named_server_limit_per_user = 5
 ```
+
+## Switching to Jupyter Server
+
+[Jupyter Server](https://jupyter-server.readthedocs.io/en/latest/) is a new Tornado Server backend for Jupyter web applications (e.g. JupyterLab 3.0 uses this package as its default backend).
+
+By default, the single-user notebook server uses the (old) `NotebookApp` from the [notebook](https://github.com/jupyter/notebook) package. You can switch to using Jupyter Server's `ServerApp` backend (this will likely become the default in future releases) by setting the `JUPYTERHUB_SINGLEUSER_APP` environment variable to:
+
+```bash
+export JUPYTERHUB_SINGLEUSER_APP='jupyter_server.serverapp.ServerApp'
+```

From 8ab25e7c3d4db9f3f757f7437d3d7a8091f9ca6e Mon Sep 17 00:00:00 2001
From: Tania Allard <taniar.allard@gmail.com>
Date: Wed, 13 Jan 2021 11:43:05 +0000
Subject: [PATCH 27/46] :memo: Fix telemetry section

---
 docs/source/events/index.rst | 12 ++++--------
 1 file changed, 4 insertions(+), 8 deletions(-)

diff --git a/docs/source/events/index.rst b/docs/source/events/index.rst
index 90e30acb..bc086ba1 100644
--- a/docs/source/events/index.rst
+++ b/docs/source/events/index.rst
@@ -1,10 +1,7 @@
 Eventlogging and Telemetry
 ==========================
 
-JupyterHub can be configured to record structured events from a running server using Jupyter's `Telemetry System`_. The types of events that JupyterHub emits are defined by `JSON schemas`_ listed below_
-
- emitted as JSON data, defined and validated by the JSON schemas listed below.
-
+JupyterHub can be configured to record structured events from a running server using Jupyter's `Telemetry System`_. The types of events that JupyterHub emits are defined by `JSON schemas`_ listed at the bottom of this page_.
 
 .. _logging: https://docs.python.org/3/library/logging.html
 .. _`Telemetry System`: https://github.com/jupyter/telemetry
@@ -38,13 +35,12 @@ Here's a basic example:
 The output is a file, ``"event.log"``, with events recorded as JSON data.
 
 
-
-.. _below:
+.. _page:
 
 Event schemas
 -------------
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2
 
-   server-actions.rst
+    server-actions.rst

From ca4fb3187fd2b019e570241513eff8926ef27808 Mon Sep 17 00:00:00 2001
From: Jia Junjie <62194633+jiajunjie@users.noreply.github.com>
Date: Wed, 13 Jan 2021 21:59:38 +0800
Subject: [PATCH 28/46] Fix the help related to the proxy check

---
 jupyterhub/app.py   | 3 ++-
 jupyterhub/proxy.py | 6 +++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/jupyterhub/app.py b/jupyterhub/app.py
index a3bc17e0..3e4a5816 100644
--- a/jupyterhub/app.py
+++ b/jupyterhub/app.py
@@ -374,7 +374,7 @@ class JupyterHub(Application):
         300, help="Interval (in seconds) at which to update last-activity timestamps."
     ).tag(config=True)
     proxy_check_interval = Integer(
-        30, help="Interval (in seconds) at which to check if the proxy is running."
+        5, help="DEPRECATED since version 0.8: Use ConfigurableHTTPProxy.check_running_interval"
     ).tag(config=True)
     service_check_interval = Integer(
         60,
@@ -688,6 +688,7 @@ class JupyterHub(Application):
     ).tag(config=True)
 
     _proxy_config_map = {
+        'proxy_check_interval': 'check_running_interval',
         'proxy_cmd': 'command',
         'debug_proxy': 'debug',
         'proxy_auth_token': 'auth_token',
diff --git a/jupyterhub/proxy.py b/jupyterhub/proxy.py
index 077ed820..7a9f3f8f 100644
--- a/jupyterhub/proxy.py
+++ b/jupyterhub/proxy.py
@@ -450,7 +450,11 @@ class ConfigurableHTTPProxy(Proxy):
         Loaded from the CONFIGPROXY_AUTH_TOKEN env variable by default.
         """
     ).tag(config=True)
-    check_running_interval = Integer(5, config=True)
+    check_running_interval = Integer(
+        5,
+        help="Interval (in seconds) at which to check if the proxy is running.",
+        config=True
+    )
 
     @default('auth_token')
     def _auth_token_default(self):

From 3db5eae9a98d81ab9ea78cd5281c70c08d4bf6c3 Mon Sep 17 00:00:00 2001
From: Jia Junjie <62194633+jiajunjie@users.noreply.github.com>
Date: Thu, 14 Jan 2021 20:52:59 +0800
Subject: [PATCH 29/46] Run pre-commit

---
 jupyterhub/app.py   | 3 ++-
 jupyterhub/proxy.py | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/jupyterhub/app.py b/jupyterhub/app.py
index 3e4a5816..ed4f068d 100644
--- a/jupyterhub/app.py
+++ b/jupyterhub/app.py
@@ -374,7 +374,8 @@ class JupyterHub(Application):
         300, help="Interval (in seconds) at which to update last-activity timestamps."
     ).tag(config=True)
     proxy_check_interval = Integer(
-        5, help="DEPRECATED since version 0.8: Use ConfigurableHTTPProxy.check_running_interval"
+        5,
+        help="DEPRECATED since version 0.8: Use ConfigurableHTTPProxy.check_running_interval",
     ).tag(config=True)
     service_check_interval = Integer(
         60,
diff --git a/jupyterhub/proxy.py b/jupyterhub/proxy.py
index 7a9f3f8f..cf707d6f 100644
--- a/jupyterhub/proxy.py
+++ b/jupyterhub/proxy.py
@@ -453,7 +453,7 @@ class ConfigurableHTTPProxy(Proxy):
     check_running_interval = Integer(
         5,
         help="Interval (in seconds) at which to check if the proxy is running.",
-        config=True
+        config=True,
     )
 
     @default('auth_token')

From b73eca91caba183ba4f6375b16d1003bdc685f8c Mon Sep 17 00:00:00 2001
From: Rollin Thomas <rcthomas@lbl.gov>
Date: Fri, 15 Jan 2021 11:19:57 -0800
Subject: [PATCH 30/46] Fix pagination with named servers

---
 jupyterhub/handlers/pages.py | 12 ++++--------
 1 file changed, 4 insertions(+), 8 deletions(-)

diff --git a/jupyterhub/handlers/pages.py b/jupyterhub/handlers/pages.py
index 0acbc0d5..368cc7d2 100644
--- a/jupyterhub/handlers/pages.py
+++ b/jupyterhub/handlers/pages.py
@@ -501,20 +501,16 @@ class AdminHandler(BaseHandler):
         # get User.col.desc() order objects
         ordered = [getattr(c, o)() for c, o in zip(cols, orders)]
 
-        users = (
-            self.db.query(orm.User)
-            .outerjoin(orm.Spawner)
-            .order_by(*ordered)
-            .limit(per_page)
-            .offset(offset)
-        )
+        query = self.db.query(orm.User).outerjoin(orm.Spawner).distinct(orm.User.id)
+
+        users = query.order_by(*ordered).limit(per_page).offset(offset)
         users = [self._user_from_orm(u) for u in users]
 
         running = []
         for u in users:
             running.extend(s for s in u.spawners.values() if s.active)
 
-        pagination.total = self.db.query(orm.User.id).count()
+        pagination.total = query.count()
 
         auth_state = await self.current_user.get_auth_state()
         html = await self.render_template(

From b0bf3489085ffc5e56ff942d44c4b00c7a084aca Mon Sep 17 00:00:00 2001
From: Rollin Thomas <rcthomas@lbl.gov>
Date: Fri, 15 Jan 2021 22:53:12 -0800
Subject: [PATCH 31/46] Need to format as subquery

---
 jupyterhub/handlers/pages.py | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/jupyterhub/handlers/pages.py b/jupyterhub/handlers/pages.py
index 368cc7d2..36e8cb86 100644
--- a/jupyterhub/handlers/pages.py
+++ b/jupyterhub/handlers/pages.py
@@ -502,8 +502,15 @@ class AdminHandler(BaseHandler):
         ordered = [getattr(c, o)() for c, o in zip(cols, orders)]
 
         query = self.db.query(orm.User).outerjoin(orm.Spawner).distinct(orm.User.id)
+        subquery = query.subquery("users")
+        users = (
+            self.db.query(orm.User)
+            .select_entity_from(subquery)
+            .order_by(*ordered)
+            .limit(per_page)
+            .offset(offset)
+        )
 
-        users = query.order_by(*ordered).limit(per_page).offset(offset)
         users = [self._user_from_orm(u) for u in users]
 
         running = []

From dcff08ae13bfa520bf1d8b2995a4ced8378523aa Mon Sep 17 00:00:00 2001
From: Rollin Thomas <rcthomas@lbl.gov>
Date: Sat, 16 Jan 2021 09:15:34 -0800
Subject: [PATCH 32/46] Add back outerjoin that made spawner sorts work

---
 jupyterhub/handlers/pages.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/jupyterhub/handlers/pages.py b/jupyterhub/handlers/pages.py
index 36e8cb86..eae9b63f 100644
--- a/jupyterhub/handlers/pages.py
+++ b/jupyterhub/handlers/pages.py
@@ -506,6 +506,7 @@ class AdminHandler(BaseHandler):
         users = (
             self.db.query(orm.User)
             .select_entity_from(subquery)
+            .outerjoin(orm.Spawner)
             .order_by(*ordered)
             .limit(per_page)
             .offset(offset)

From c7f1b89f6c529cf013597f70dfa529cba148b3a8 Mon Sep 17 00:00:00 2001
From: SHAHN3 <SHAHN3@legal.regn.net>
Date: Tue, 19 Jan 2021 16:08:33 -0500
Subject: [PATCH 33/46] delete user's PVC when delete user is called

---
 jupyterhub/apihandlers/users.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/jupyterhub/apihandlers/users.py b/jupyterhub/apihandlers/users.py
index f427455d..e5b109dd 100644
--- a/jupyterhub/apihandlers/users.py
+++ b/jupyterhub/apihandlers/users.py
@@ -237,6 +237,10 @@ class UserAPIHandler(APIHandler):
                 )
 
         await maybe_future(self.authenticator.delete_user(user))
+
+        # delete the user's PVC
+        await user.spawner.delete_namespaced_persistent_volume_claim(user.spawner.pvc_name, user.spawner.namespace)
+
         # remove from registry
         self.users.delete(user)
 

From c40b3a4ad64a8b96c7460f43e57013064a7a2728 Mon Sep 17 00:00:00 2001
From: SHAHN3 <SHAHN3@legal.regn.net>
Date: Tue, 19 Jan 2021 16:32:59 -0500
Subject: [PATCH 34/46] reformatted code

---
 jupyterhub/apihandlers/users.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/jupyterhub/apihandlers/users.py b/jupyterhub/apihandlers/users.py
index e5b109dd..02935dda 100644
--- a/jupyterhub/apihandlers/users.py
+++ b/jupyterhub/apihandlers/users.py
@@ -239,7 +239,9 @@ class UserAPIHandler(APIHandler):
         await maybe_future(self.authenticator.delete_user(user))
 
         # delete the user's PVC
-        await user.spawner.delete_namespaced_persistent_volume_claim(user.spawner.pvc_name, user.spawner.namespace)
+        await user.spawner.delete_namespaced_persistent_volume_claim(
+            user.spawner.pvc_name, user.spawner.namespace
+        )
 
         # remove from registry
         self.users.delete(user)

From 8b9b69ce22602b6e231177cf3151e9dc4f5409e8 Mon Sep 17 00:00:00 2001
From: SHAHN3 <SHAHN3@legal.regn.net>
Date: Tue, 19 Jan 2021 17:40:59 -0500
Subject: [PATCH 35/46] trying to mock

---
 jupyterhub/tests/mocking.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/jupyterhub/tests/mocking.py b/jupyterhub/tests/mocking.py
index 5ae6ec8c..308c842d 100644
--- a/jupyterhub/tests/mocking.py
+++ b/jupyterhub/tests/mocking.py
@@ -274,6 +274,10 @@ class MockHub(JupyterHub):
                 return port
         return random_port()
 
+    @default('delete_namespaced_persistent_volume_claim')
+    def _pvc_default(self):
+        return 'fakePVC'
+
     @default('authenticator_class')
     def _authenticator_class_default(self):
         return MockPAMAuthenticator

From 202d6f93d46772e0176bd7cb7ea327a2074aa93f Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Wed, 20 Jan 2021 09:23:26 +0100
Subject: [PATCH 36/46] always log slow requests at least at info-level

if health or static responses are taking longer than 1s, it's useful to know
---
 jupyterhub/log.py | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/jupyterhub/log.py b/jupyterhub/log.py
index f9fbffe8..43a38d36 100644
--- a/jupyterhub/log.py
+++ b/jupyterhub/log.py
@@ -2,7 +2,9 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import json
+import logging
 import traceback
+from functools import partial
 from http.cookies import SimpleCookie
 from urllib.parse import urlparse
 from urllib.parse import urlunparse
@@ -132,19 +134,25 @@ def log_request(handler):
         status < 300 and isinstance(handler, (StaticFileHandler, HealthCheckHandler))
     ):
         # static-file success and 304 Found are debug-level
-        log_method = access_log.debug
+        log_level = logging.DEBUG
     elif status < 400:
-        log_method = access_log.info
+        log_level = logging.INFO
     elif status < 500:
-        log_method = access_log.warning
+        log_level = logging.WARNING
     else:
-        log_method = access_log.error
+        log_level = logging.ERROR
 
     uri = _scrub_uri(request.uri)
     headers = _scrub_headers(request.headers)
 
     request_time = 1000.0 * handler.request.request_time()
 
+    # always log slow responses (longer than 1s) at least info-level
+    if request_time >= 1000 and log_level < logging.INFO:
+        log_level = logging.INFO
+
+    log_method = partial(access_log.log, log_level)
+
     try:
         user = handler.current_user
     except (HTTPError, RuntimeError):

From cd06f3fb12677acbdb2656bc2f5bfa70ec58092a Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Wed, 20 Jan 2021 09:34:42 +0100
Subject: [PATCH 37/46] specify minimum alembic

this gets us *older* alembic in the old-dependencies test

since alembic 1.5 doesn't support sqlalchemy 1.1
---
 requirements.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/requirements.txt b/requirements.txt
index 3c4481be..0338b1c0 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,4 +1,4 @@
-alembic
+alembic>=1.4
 async_generator>=1.9
 certipy>=0.1.2
 entrypoints

From 289dee5996fce392ef6f483d4c2a58d2e1f5bd42 Mon Sep 17 00:00:00 2001
From: SHAHN3 <SHAHN3@legal.regn.net>
Date: Wed, 20 Jan 2021 14:34:32 -0500
Subject: [PATCH 38/46] new method delete_forever

---
 jupyterhub/apihandlers/users.py | 8 ++++----
 jupyterhub/tests/mocking.py     | 7 +++----
 2 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/jupyterhub/apihandlers/users.py b/jupyterhub/apihandlers/users.py
index 02935dda..a35e1637 100644
--- a/jupyterhub/apihandlers/users.py
+++ b/jupyterhub/apihandlers/users.py
@@ -238,10 +238,10 @@ class UserAPIHandler(APIHandler):
 
         await maybe_future(self.authenticator.delete_user(user))
 
-        # delete the user's PVC
-        await user.spawner.delete_namespaced_persistent_volume_claim(
-            user.spawner.pvc_name, user.spawner.namespace
-        )
+        # Delete the user's storage, if it exists.
+        # In kubespawner spawner.py, we have delete_forever
+        # method to delete the user's PVC.
+        await user.spawner.delete_forever()
 
         # remove from registry
         self.users.delete(user)
diff --git a/jupyterhub/tests/mocking.py b/jupyterhub/tests/mocking.py
index 308c842d..e096b9bc 100644
--- a/jupyterhub/tests/mocking.py
+++ b/jupyterhub/tests/mocking.py
@@ -93,6 +93,9 @@ class MockSpawner(SimpleLocalProcessSpawner):
     def _cmd_default(self):
         return [sys.executable, '-m', 'jupyterhub.tests.mocksu']
 
+    def delete_forever(self):
+        return "mocking_this_method"
+
     use_this_api_token = None
 
     def start(self):
@@ -274,10 +277,6 @@ class MockHub(JupyterHub):
                 return port
         return random_port()
 
-    @default('delete_namespaced_persistent_volume_claim')
-    def _pvc_default(self):
-        return 'fakePVC'
-
     @default('authenticator_class')
     def _authenticator_class_default(self):
         return MockPAMAuthenticator

From 8fcc4b48a5d7ed00d1e4eeb530747f344b2dd5f4 Mon Sep 17 00:00:00 2001
From: SHAHN3 <SHAHN3@legal.regn.net>
Date: Wed, 20 Jan 2021 14:44:03 -0500
Subject: [PATCH 39/46] removed await

---
 jupyterhub/apihandlers/users.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/jupyterhub/apihandlers/users.py b/jupyterhub/apihandlers/users.py
index a35e1637..c8d6bb7a 100644
--- a/jupyterhub/apihandlers/users.py
+++ b/jupyterhub/apihandlers/users.py
@@ -241,7 +241,7 @@ class UserAPIHandler(APIHandler):
         # Delete the user's storage, if it exists.
         # In kubespawner spawner.py, we have delete_forever
         # method to delete the user's PVC.
-        await user.spawner.delete_forever()
+        user.spawner.delete_forever()
 
         # remove from registry
         self.users.delete(user)

From 9bd97db90b796633c7207f73f4e8d194fc8ccca1 Mon Sep 17 00:00:00 2001
From: SHAHN3 <SHAHN3@legal.regn.net>
Date: Thu, 21 Jan 2021 16:21:18 -0500
Subject: [PATCH 40/46] added try except, also changed to await and async

---
 jupyterhub/apihandlers/users.py | 9 +++++----
 jupyterhub/tests/mocking.py     | 4 ++--
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/jupyterhub/apihandlers/users.py b/jupyterhub/apihandlers/users.py
index c8d6bb7a..27e9bf0f 100644
--- a/jupyterhub/apihandlers/users.py
+++ b/jupyterhub/apihandlers/users.py
@@ -238,10 +238,11 @@ class UserAPIHandler(APIHandler):
 
         await maybe_future(self.authenticator.delete_user(user))
 
-        # Delete the user's storage, if it exists.
-        # In kubespawner spawner.py, we have delete_forever
-        # method to delete the user's PVC.
-        user.spawner.delete_forever()
+        # allow the spawner to cleanup any persistent resources associated with the user
+        try:
+            await user.spawner.delete_forever()
+        except Exception as e:
+            self.log.error("Error cleaning up persistent resources: %s" % e)
 
         # remove from registry
         self.users.delete(user)
diff --git a/jupyterhub/tests/mocking.py b/jupyterhub/tests/mocking.py
index e096b9bc..4342e8d7 100644
--- a/jupyterhub/tests/mocking.py
+++ b/jupyterhub/tests/mocking.py
@@ -93,8 +93,8 @@ class MockSpawner(SimpleLocalProcessSpawner):
     def _cmd_default(self):
         return [sys.executable, '-m', 'jupyterhub.tests.mocksu']
 
-    def delete_forever(self):
-        return "mocking_this_method"
+    async def delete_forever(self):
+        pass
 
     use_this_api_token = None
 

From 162076c5dd8907b7e65b11461fa4ea8530b6a054 Mon Sep 17 00:00:00 2001
From: SHAHN3 <SHAHN3@legal.regn.net>
Date: Sat, 23 Jan 2021 15:58:32 -0500
Subject: [PATCH 41/46] added docstring

---
 jupyterhub/tests/mocking.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/jupyterhub/tests/mocking.py b/jupyterhub/tests/mocking.py
index 4342e8d7..e0f97cac 100644
--- a/jupyterhub/tests/mocking.py
+++ b/jupyterhub/tests/mocking.py
@@ -94,6 +94,13 @@ class MockSpawner(SimpleLocalProcessSpawner):
         return [sys.executable, '-m', 'jupyterhub.tests.mocksu']
 
     async def delete_forever(self):
+        """Called when a user is deleted.
+
+        This can do things like request removal of resources such as persistent storage.
+        Only called on stopped spawners, and is likely the last action ever taken for the user.
+
+        Will only be called once on the user's default Spawner.
+        """
         pass
 
     use_this_api_token = None

From 2f304bffcc653c8b8616749a4df4dfcb6fb8f514 Mon Sep 17 00:00:00 2001
From: Daisuke Taniwaki <daisuketaniwaki@gmail.com>
Date: Sun, 24 Jan 2021 20:21:17 +0900
Subject: [PATCH 42/46] Clear tornado cookie on logout

---
 jupyterhub/handlers/base.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/jupyterhub/handlers/base.py b/jupyterhub/handlers/base.py
index e08e083e..6818ace0 100644
--- a/jupyterhub/handlers/base.py
+++ b/jupyterhub/handlers/base.py
@@ -493,6 +493,11 @@ class BaseHandler(RequestHandler):
             path=url_path_join(self.base_url, 'services'),
             **kwargs,
         )
+        # clear tornado cookie
+        self.clear_cookie(
+            '_xsrf',
+            **self.settings.get('xsrf_cookie_kwargs', {}),
+        )
         # Reset _jupyterhub_user
         self._jupyterhub_user = None
 

From c5d026598447d525746d5cdda9c616dca76c6054 Mon Sep 17 00:00:00 2001
From: Erik Sundell <erik.i.sundell@gmail.com>
Date: Mon, 25 Jan 2021 22:28:50 +0100
Subject: [PATCH 43/46] Allow cookie_secret to be a hexadecimal string

With this, we coerce hexadecimal strings into Bytes. This can be helpful
as YAML/JSON cannot represent raw bytes.
---
 jupyterhub/app.py | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/jupyterhub/app.py b/jupyterhub/app.py
index ed4f068d..028929ca 100644
--- a/jupyterhub/app.py
+++ b/jupyterhub/app.py
@@ -848,15 +848,30 @@ class JupyterHub(Application):
         to reduce the cost of checking authentication tokens.
         """,
     ).tag(config=True)
-    cookie_secret = Bytes(
+    cookie_secret = Union(
+        [Bytes(), Unicode()],
         help="""The cookie secret to use to encrypt cookies.
 
         Loaded from the JPY_COOKIE_SECRET env variable by default.
 
         Should be exactly 256 bits (32 bytes).
-        """
+        """,
     ).tag(config=True, env='JPY_COOKIE_SECRET')
 
+    @validate('cookie_secret')
+    def _validate_secret_key(self, proposal):
+        """Coerces strings with even number of hexadecimal characters to bytes."""
+        r = proposal['value']
+        if type(r) == str:
+            try:
+                return bytes.fromhex(r)
+            except ValueError:
+                raise ValueError(
+                    "cookie_secret set as a string must contain an even amount of hexadecimal characters."
+                )
+        else:
+            return r
+
     @observe('cookie_secret')
     def _cookie_secret_check(self, change):
         secret = change.new

From cba22751b4e334877d0a930b0c1764f3d86f6ab1 Mon Sep 17 00:00:00 2001
From: Erik Sundell <erik.i.sundell@gmail.com>
Date: Mon, 25 Jan 2021 22:29:48 +0100
Subject: [PATCH 44/46] Test setting cookie_secret to a hexadecimal string

---
 jupyterhub/tests/test_app.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/jupyterhub/tests/test_app.py b/jupyterhub/tests/test_app.py
index accdd430..a918e9b7 100644
--- a/jupyterhub/tests/test_app.py
+++ b/jupyterhub/tests/test_app.py
@@ -199,6 +199,18 @@ def test_cookie_secret_env(tmpdir, request):
     assert not os.path.exists(hub.cookie_secret_file)
 
 
+def test_cookie_secret_string_():
+    cfg = Config()
+
+    cfg.JupyterHub.cookie_secret = "not hex"
+    with pytest.raises(ValueError):
+        JupyterHub(config=cfg)
+
+    cfg.JupyterHub.cookie_secret = "abc123"
+    app = JupyterHub(config=cfg)
+    assert app.cookie_secret == binascii.a2b_hex('abc123')
+
+
 async def test_load_groups(tmpdir, request):
     to_load = {
         'blue': ['cyclops', 'rogue', 'wolverine'],

From 6c65624942fa2e746ff11ec7cd48832c6fee12db Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Tue, 26 Jan 2021 11:53:39 +0100
Subject: [PATCH 45/46] [TST] Do not implicitly create users in auth_header

implicit user creation results in surprising behavior when the user shouldn't exist
---
 jupyterhub/tests/utils.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/jupyterhub/tests/utils.py b/jupyterhub/tests/utils.py
index b99ba4ea..e48d30b5 100644
--- a/jupyterhub/tests/utils.py
+++ b/jupyterhub/tests/utils.py
@@ -121,7 +121,7 @@ def auth_header(db, name):
     """Return header with user's API authorization token."""
     user = find_user(db, name)
     if user is None:
-        user = add_user(db, name=name)
+        raise KeyError(f"No such user: {name}")
     token = user.new_api_token()
     return {'Authorization': 'token %s' % token}
 

From 4c3a32b51f56101a1ed788746aeb06b9a75fe7a3 Mon Sep 17 00:00:00 2001
From: Erik Sundell <erik@sundellopensource.se>
Date: Tue, 26 Jan 2021 12:44:17 +0100
Subject: [PATCH 46/46] Apply suggestions from code review

Co-authored-by: Min RK <benjaminrk@gmail.com>
---
 jupyterhub/app.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/jupyterhub/app.py b/jupyterhub/app.py
index 028929ca..d5d35d5a 100644
--- a/jupyterhub/app.py
+++ b/jupyterhub/app.py
@@ -862,7 +862,7 @@ class JupyterHub(Application):
     def _validate_secret_key(self, proposal):
         """Coerces strings with even number of hexadecimal characters to bytes."""
         r = proposal['value']
-        if type(r) == str:
+        if isinstance(r, str):
             try:
                 return bytes.fromhex(r)
             except ValueError: