Commit Graph

4660 Commits

Author SHA1 Message Date
David Brochart
c99bb32e12 Backport PR #3494: Fix typo
Signed-off-by: Erik Sundell <erik.i.sundell@gmail.com>
2021-07-15 10:16:11 +02:00
Igor Beliakov
fee4ee23c0 Backport PR #3484: Bug: save_bearer_token (provider.py) passes a float value to the expires_at field (int)
**Environment**

* image: k8s-hub (`jupyterhub/k8s-hub:0.11.1`);
* `authenticator_class: dummy`;
* db: cocroachdb (`sqlalchemy-cocroachdb`).

**Description:**

`save_bearer_token` method (`provider.py`) passes a float value to the `expires_at` field (int).

A user can create a notebook, it gets successfully scheduled, and then, once the pod is up and ready, the user is unable to enter the notebook, because jupyterhub cannot save a token. In logs, we can see the following:

```
[I 2021-05-29 14:45:04.302 JupyterHub log:181] 302 GET /hub/api/oauth2/authorize?client_id=jupyterhub-user-user2&redirect_uri=%2Fuser%2Fuser2%2Foauth_callback&response_type=code&state=[secret] -> /user/user2/oauth_callback?code=[secret]&state=[secret] (user2 40.113.125.116) 73.98ms
[E 2021-05-29 14:45:04.424 JupyterHub web:1789] Uncaught exception POST /hub/api/oauth2/token (10.42.80.10)
    HTTPServerRequest(protocol='http', host='hub:8081', method='POST', uri='/hub/api/oauth2/token', version='HTTP/1.1', remote_ip='10.42.80.10')
    Traceback (most recent call last):
      File "/usr/local/lib/python3.8/dist-packages/tornado/web.py", line 1702, in _execute
        result = method(*self.path_args, **self.path_kwargs)
      File "/usr/local/lib/python3.8/dist-packages/jupyterhub/apihandlers/auth.py", line 324, in post
        headers, body, status = self.oauth_provider.create_token_response(
      File "/usr/local/lib/python3.8/dist-packages/oauthlib/oauth2/rfc6749/endpoints/base.py", line 116, in wrapper
        return f(endpoint, uri, *args, **kwargs)
      File "/usr/local/lib/python3.8/dist-packages/oauthlib/oauth2/rfc6749/endpoints/token.py", line 118, in create_token_response
        return grant_type_handler.create_token_response(
      File "/usr/local/lib/python3.8/dist-packages/oauthlib/oauth2/rfc6749/grant_types/authorization_code.py", line 313, in create_token_response
        self.request_validator.save_token(token, request)
      File "/usr/local/lib/python3.8/dist-packages/jupyterhub/oauth/provider.py", line 281, in save_token
        return self.save_bearer_token(token, request, *args, **kwargs)
      File "/usr/local/lib/python3.8/dist-packages/jupyterhub/oauth/provider.py", line 354, in save_bearer_token
        self.db.commit()
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/orm/session.py", line 1042, in commit
        self.transaction.commit()
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/orm/session.py", line 504, in commit
        self._prepare_impl()
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/orm/session.py", line 483, in _prepare_impl
        self.session.flush()
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/orm/session.py", line 2536, in flush
        self._flush(objects)
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/orm/session.py", line 2678, in _flush
        transaction.rollback(_capture_exception=True)
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/util/langhelpers.py", line 68, in __exit__
        compat.raise_(
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/util/compat.py", line 182, in raise_
        raise exception
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/orm/session.py", line 2638, in _flush
        flush_context.execute()
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/orm/unitofwork.py", line 422, in execute
        rec.execute(self)
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/orm/unitofwork.py", line 586, in execute
        persistence.save_obj(
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/orm/persistence.py", line 239, in save_obj
        _emit_insert_statements(
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/orm/persistence.py", line 1135, in _emit_insert_statements
        result = cached_connections[connection].execute(
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/engine/base.py", line 1011, in execute
        return meth(self, multiparams, params)
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/sql/elements.py", line 298, in _execute_on_connection
        return connection._execute_clauseelement(self, multiparams, params)
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/engine/base.py", line 1124, in _execute_clauseelement
        ret = self._execute_context(
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/engine/base.py", line 1316, in _execute_context
        self._handle_dbapi_exception(
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/engine/base.py", line 1510, in _handle_dbapi_exception
        util.raise_(
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/util/compat.py", line 182, in raise_
        raise exception
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/engine/base.py", line 1276, in _execute_context
        self.dialect.do_execute(
      File "/usr/local/lib/python3.8/dist-packages/sqlalchemy/engine/default.py", line 593, in do_execute
        cursor.execute(statement, parameters)
    sqlalchemy.exc.ProgrammingError: (psycopg2.errors.DatatypeMismatch) value type decimal doesn't match type int of column "expires_at"
    HINT:  you will need to rewrite or cast the expression

    [SQL: INSERT INTO oauth_access_tokens (client_id, grant_type, expires_at, refresh_token, refresh_expires_at, user_id, session_id, hashed, prefix, created, last_activity) VALUES (%(client_id)s, %(grant_type)s, %(expires_at)s, %(refresh_token)s, %(refresh_expires_at)s, %(user_id)s, %(session_id)s, %(hashed)s, %(prefix)s, %(created)s, %(last_activity)s) RETURNING oauth_access_tokens.id]
    [parameters: {'client_id': 'jupyterhub-user-user2', 'grant_type': 'authorization_code', 'expires_at': 1622303104.418992, 'refresh_token': 'FVJ8S4is0367LlEMnxIiEIoTOeoxhf', 'refresh_expires_at': None, 'user_id': 662636890939424770, 'session_id': '4e041a2bfcb34a34a00033a281bc1236', 'hashed': 'sha512:1:3b18deae37fbf50a:03df035736960af14e19196e1d13fd74f55c21f17405119f80e75817ff37c7567fab089a3d40b97a57f94b54065ee56f7260895352516b9facb989d656f05be8', 'prefix': 't11z', 'created': datetime.datetime(2021, 5, 29, 14, 45, 4, 421305), 'last_activity': None}]
    (Background on this error at: http://sqlalche.me/e/13/f405)

[W 2021-05-29 14:45:04.430 JupyterHub base:110] Rolling back session due to database error (psycopg2.errors.DatatypeMismatch) value type decimal doesn't match type int of column "expires_at"
    HINT:  you will need to rewrite or cast the expression

    [SQL: INSERT INTO oauth_access_tokens (client_id, grant_type, expires_at, refresh_token, refresh_expires_at, user_id, session_id, hashed, prefix, created, last_activity) VALUES (%(client_id)s, %(grant_type)s, %(expires_at)s, %(refresh_token)s, %(refresh_expires_at)s, %(user_id)s, %(session_id)s, %(hashed)s, %(prefix)s, %(created)s, %(last_activity)s) RETURNING oauth_access_tokens.id]
    [parameters: {'client_id': 'jupyterhub-user-user2', 'grant_type': 'authorization_code', 'expires_at': 1622303104.418992, 'refresh_token': 'FVJ8S4is0367LlEMnxIiEIoTOeoxhf', 'refresh_expires_at': None, 'user_id': 662636890939424770, 'session_id': '4e041a2bfcb34a34a00033a281bc1236', 'hashed': 'sha512:1:3b18deae37fbf50a:03df035736960af14e19196e1d13fd74f55c21f17405119f80e75817ff37c7567fab089a3d40b97a57f94b54065ee56f7260895352516b9facb989d656f05be8', 'prefix': 't11z', 'created': datetime.datetime(2021, 5, 29, 14, 45, 4, 421305), 'last_activity': None}]
    (Background on this error at: http://sqlalche.me/e/13/f405)
[E 2021-05-29 14:45:04.443 JupyterHub log:173] {
      "Host": "hub:8081",
      "User-Agent": "python-requests/2.25.1",
      "Accept-Encoding": "gzip, deflate",
      "Accept": "*/*",
      "Connection": "keep-alive",
      "Content-Type": "application/x-www-form-urlencoded",
      "Authorization": "token [secret]",
      "Content-Length": "190"
    }
[E 2021-05-29 14:45:04.444 JupyterHub log:181] 500 POST /hub/api/oauth2/token (user2 10.42.80.10) 63.28ms
```

Everything went well, when I changed:
`expires_at=orm.OAuthAccessToken.now() + token['expires_in'],`
to:
`expires_at=int(orm.OAuthAccessToken.now() + token['expires_in']),`
That's what this PR is about.

As a sidenote, `black` formatter adjusted the `orm_client = orm.OAuthClient(identifier=client_id,)` line, but I guess it should be fine. Please, feel free to revert this change if needed.

(Upd): added the missing `int` conversion.

Signed-off-by: Erik Sundell <erik.i.sundell@gmail.com>
2021-07-15 10:16:08 +02:00
Min RK
2c8b29b6bb Merge pull request #3467 from minrk/1.4.x
Prepare for 1.4.1
1.4.1
2021-05-12 17:16:58 +02:00
Min RK
a53178a92b Backport PR #3462: prepare to rename default branch to main
- update references to default branch name in docs, workflows
- use HEAD in github urls, which always works regardless of default branch name
- fix petstore URLs since the old petstore links seem to have stopped working

to merge, in order:

- [x] approve this PR
- [x] rename the default branch to main in settings
- [x] merge this PR

Related tangent: I've been using [this git default-branch](https://github.com/minrk/git-stuff/blob/main/bin/git-default-branch) to help with my aliases and friends working with repos with different branch names.

Signed-off-by: Min RK <benjaminrk@gmail.com>
2021-05-12 15:51:06 +02:00
Min RK
e032cda638 release 1.4.1 2021-05-12 15:45:27 +02:00
Min RK
40820b3489 changelog for 1.4.1 2021-05-12 15:42:21 +02:00
Min RK
80f4454371 Backport PR #3457: ci: fix typo in environment variable
When i setup the release workflow i made a typo in an environment variable so signing into Docker Hub now fails.

Observed in https://github.com/jupyterhub/jupyterhub/pull/3456 issuecomment-832923798.

Signed-off-by: Min RK <benjaminrk@gmail.com>
2021-05-12 15:36:39 +02:00
Erik Sundell
4d0005b0b7 Backport PR #3454: define Spawner.delete_forever on base Spawner
...where I thought it already was! Instead of on the test class.

and fix the logic for when it is called a bit:

- call on *all* Spawners, not just the default
- call on named server deletion when remove=True

closes  3451, finishes  3337

Signed-off-by: Min RK <benjaminrk@gmail.com>
2021-05-12 15:36:36 +02:00
Erik Sundell
86761ff0d4 Backport PR #3456: avoid re-using asyncio.Locks across event loops
should never occur in real applications where only one loop is run, but may occur in tests if the Proxy object lives longer than the loop that is running when it's created (imported?).

I *suspect* this is the source of our intermittent test failures with:

> got Future <Future pending> attached to a different loop

But since they are intermittent, it's hard to be sure, even if this PR passes.

The issue: we were allocating an asyncio.Lock(), which in turn grabs a handle on the current event loop, at *method definition time* in the decorator, instead of *call time*.

The solution: allocate the method at call time *and* double-check to ensure we never use a lock across event loops by storing the locks per-loop.

This should change nothing for 'real' hub instances, where only one loop is ever running, only tests where we start and stop loops a bunch.

Signed-off-by: Min RK <benjaminrk@gmail.com>
2021-05-12 15:36:34 +02:00
Min RK
32a2a3031c Backport PR #3437: patch base handlers from both jupyter_server and notebook
and clarify warning when a base handler isn't patched that auth is still being applied

- reorganize patch steps into functions for easier re-use
- patch notebook and jupyter_server handlers if they are already imported
- run patch after initialize to ensure extensions have done their importing before we check what's present
- apply class-level patch even when instance-level patch is happening to avoid triggering patch on every request

This change isn't as big as it looks, because it's mostly moving some re-used code to a couple of functions.

closes https://github.com/jupyter-server/jupyter_server/issues/488

Signed-off-by: Min RK <benjaminrk@gmail.com>
2021-05-12 15:36:31 +02:00
Min RK
16352496da Backport PR #3452: Fix documentation
Signed-off-by: Min RK <benjaminrk@gmail.com>
2021-05-12 15:36:28 +02:00
Min RK
2259f57772 Backport PR #3436: ci: github workflow security, pin action to sha etc
Pin references to github actions we rely on in workflows with jobs that reference GitHub secrets that could get exposed.

Signed-off-by: Min RK <benjaminrk@gmail.com>
2021-05-12 15:36:26 +02:00
Min RK
574d343881 release 1.4.0 1.4.0 2021-04-19 13:41:28 +02:00
Yuvi Panda
c205385023 Merge pull request #3424 from minrk/changelog-1.4
more changelog for 1.4
2021-04-19 17:06:23 +05:30
Min RK
9e0ac1594c more changelog for 1.4 2021-04-19 13:13:29 +02:00
Min RK
2fd434f511 Merge pull request #3430 from yuvipanda/additional_routes
Support Proxy.extra_routes
2021-04-19 13:12:11 +02:00
YuviPanda
af39f39082 Mark extra proxy routes properly 2021-04-19 16:27:05 +05:30
YuviPanda
ab751bda5c Accomodate for host based routing 2021-04-19 16:26:09 +05:30
YuviPanda
f84078627f Add a little more documentation to extra_routes 2021-04-19 16:16:03 +05:30
YuviPanda
3ec3dc5195 Support Proxy.extra_routes
When the hub is running in API-only mode, it's
very useful to have the proxy know where to send
URLs that would normally be serviced by the hub.
For example, / might go to a service that renders
a home page, while `/user` might go to a service that
tells the user their server is dead.

Right now, this happens 'out of band', with a process
that has to talk to the proxy directly. This is a
bit messy - the routes need to be re-added when the
proxy restarts, the hub might try to remove them, etc.
By adding support for this in the hub itself, all
this complexity is now removed and the hub continues
to own all the routes in the proxy
2021-04-19 16:14:28 +05:30
Simon Li
73102e7aeb Merge pull request #3429 from minrk/push-auth
typos in onbuild, demo images for push
2021-04-19 09:19:57 +01:00
Min RK
b039e2985b typos in onbuild, demo images for push
it's jupyterhub/jupyterhub-onbuild not jupyterthub-onbuild/jupyterhub
2021-04-19 09:09:49 +02:00
Min RK
6d7863d56a Merge pull request #3428 from Carreau/doc-1
DOC: Conform to numpydoc.
2021-04-19 08:56:42 +02:00
Min RK
aba32e7200 Merge pull request #3425 from manics/docker-arm64
Disable docker jupyterhub-demo arm64 build
2021-04-19 08:33:45 +02:00
Matthias Bussonnier
a71823c5ab DOC: Conform to numpydoc.
Minor syntax update
2021-04-18 21:23:03 -07:00
Simon Li
fcf9122519 jupyterhub/action-major-minor-tag-calculator@v1
Co-authored-by: Erik Sundell <erik.i.sundell@gmail.com>
2021-04-15 20:35:21 +01:00
Simon Li
6c3fc41176 jupyterhub/action-major-minor-tag-calculator@main 2021-04-15 16:14:51 +01:00
Simon Li
0bdb1bac4d GHW docker: use default tag for PRs
This allows testing with a localhost:5000 registry
2021-04-15 11:11:12 +01:00
Simon Li
35c76221fe Disable linux/arm64 jupyterhub-demo build
Installing notebook requires additional compilation dependencies
2021-04-15 10:21:32 +01:00
Simon Li
ffb092721c GHW docker: push to localhost if not releasing 2021-04-15 10:19:06 +01:00
Min RK
8758b3af27 Merge pull request #3422 from olifre/login-page-customization
login-template: Add a "login_container" block inside the div-container.
2021-04-15 09:31:23 +02:00
Min RK
5202cdff8c Merge pull request #3421 from manics/docker-arm64
Docker arm64 builds
2021-04-15 09:31:04 +02:00
Simon Li
ce0cb95282 docker release: fix build-arg BASE_IMAGE tag 2021-04-14 23:17:16 +01:00
Simon Li
ee421f6427 GHW: Remove unnecessary echo, add docker test timeout 2021-04-14 22:47:17 +01:00
Simon Li
268da21bbf GH workflow docker: 'input device is not a TTY' 2021-04-14 22:44:34 +01:00
Simon Li
4ad5f61bc7 Bump onbuild/README.md example version 2021-04-14 22:28:27 +01:00
Simon Li
3df3850b3a Remove Docker hub automated build hooks 2021-04-14 22:28:07 +01:00
Simon Li
50733efa1b Move circleci docker test to gh workflow 2021-04-14 22:27:28 +01:00
Simon Li
98230ee770 docker release: jupyterhub-onbuild jupyterhub-demo 2021-04-14 22:26:25 +01:00
Simon Li
37f250b4d7 Push some branches, use variable to determine whether to push 2021-04-14 22:26:21 +01:00
Oliver Freyermuth
869661bf25 login-template: Add a "login_container" block inside the div-container.
This allows for more flexible customization of the login page,
since it allows to re-use the login form in an extending template
by reusing the new block.

This was not cleanly possible before since the main container
was part of the very same block as the form code.

fixes #3414
2021-04-14 20:11:04 +02:00
Simon Li
009fa955ed Add Docker multi-arch publish 2021-04-13 15:35:03 +01:00
Simon Li
7c8f7e9fcb Don't pin Dockerfile parent hash 2021-04-13 15:34:14 +01:00
Yuvi Panda
14539c4e0f Merge pull request #3373 from minrk/only-hub-route
allow the hub to not be the default route
2021-04-13 17:12:21 +05:30
Min RK
a11a292cd9 test custom hub routespecs 2021-04-13 13:16:59 +02:00
Min RK
5890064191 duplicate metrics, health handlers on /api/
these should probably have been on `/api/` all along,
but must be on /api/ for api-only hub routing
2021-04-13 13:16:59 +02:00
Min RK
1f30e693ad allow overriding JupyterHub.hub_routespec
Rare, but can make sense for api-only deployments

allows easier override of the default route,
e.g. for mybinder.org custom error pages
2021-04-13 13:16:59 +02:00
Min RK
32976f3d42 Merge pull request #3403 from kafonek/fastapi-example
Fastapi example
2021-04-13 12:58:43 +02:00
Min RK
30bc23f102 Merge pull request #3418 from jiajunjie/log-exception
Log the exception raised in Spawner.post_stop_hook instead of raising it
2021-04-13 12:56:38 +02:00
Jia Junjie
786c7039d6 Log the exception raised in Spawner.post_stop_hook instead of raising it 2021-04-13 08:01:59 +00:00