Switched from _request_ctx_stack.top to flask.g

Author: jrast

flask_jwt_extended/utils.py

@@ -3,7 +3,7 @@
 from typing import Optional
 
 import jwt
-from flask import _request_ctx_stack
+from flask import g
 from flask import Response
 from werkzeug.local import LocalProxy
 
@@ -23,7 +23,7 @@ def get_jwt() -> dict:
     :return:
         The payload (claims) of the JWT in the current request
     """
-    decoded_jwt = getattr(_request_ctx_stack.top, "jwt", None)
+    decoded_jwt = getattr(g, "_jwt_extended_jwt", None)
     if decoded_jwt is None:
         raise RuntimeError(
             "You must call `@jwt_required()` or `verify_jwt_in_request()` "
@@ -41,7 +41,7 @@ def get_jwt_header() -> dict:
     :return:
         The headers of the JWT in the current request
     """
-    decoded_header = getattr(_request_ctx_stack.top, "jwt_header", None)
+    decoded_header = getattr(g, "_jwt_extended_jwt_header", None)
     if decoded_header is None:
         raise RuntimeError(
             "You must call `@jwt_required()` or `verify_jwt_in_request()` "
@@ -73,7 +73,7 @@ def get_jwt_request_location() -> Optional[str]:
         The location of the JWT in the current request; e.g., "cookies",
         "query-string", "headers", or "json"
     """
-    return getattr(_request_ctx_stack.top, "jwt_location", None)
+    return getattr(g, "_jwt_extended_jwt_location", None)
 
 
 def get_current_user() -> Any:
@@ -91,7 +91,7 @@ def get_current_user() -> Any:
         The current user object for the JWT in the current request
     """
     get_jwt()  # Raise an error if not in a decorated context
-    jwt_user_dict = getattr(_request_ctx_stack.top, "jwt_user", None)
+    jwt_user_dict = getattr(g, "_jwt_extended_jwt_user", None)
     if jwt_user_dict is None:
         raise RuntimeError(
             "You must provide a `@jwt.user_lookup_loader` callback to use "

flask_jwt_extended/view_decorators.py

@@ -8,8 +8,8 @@
 from typing import Tuple
 from typing import Union
 
-from flask import _request_ctx_stack
 from flask import current_app
+from flask import g
 from flask import request
 from werkzeug.exceptions import BadRequest
 
@@ -86,8 +86,9 @@ def verify_jwt_in_request(
         return None
 
     # Should be impossible to hit, this makes mypy checks happy
-    if not _request_ctx_stack.top:  # pragma: no cover
-        raise RuntimeError("No _request_ctx_stack.top present, aborting")
+    # TODO: Convert this check to the new `flask.g` object
+    # if not _request_ctx_stack.top:  # pragma: no cover
+    #     raise RuntimeError("No _request_ctx_stack.top present, aborting")
 
     try:
         jwt_data, jwt_header, jwt_location = _decode_jwt_from_request(
@@ -97,18 +98,18 @@ def verify_jwt_in_request(
     except NoAuthorizationError:
         if not optional:
             raise
-        _request_ctx_stack.top.jwt = {}
-        _request_ctx_stack.top.jwt_header = {}
-        _request_ctx_stack.top.jwt_user = {"loaded_user": None}
-        _request_ctx_stack.top.jwt_location = None
+        g._jwt_extended_jwt = {}
+        g._jwt_extended_jwt_header = {}
+        g._jwt_extended_jwt_user = {"loaded_user": None}
+        g._jwt_extended_jwt_location = None
         return None
 
     # Save these at the very end so that they are only saved in the requet
     # context if the token is valid and all callbacks succeed
-    _request_ctx_stack.top.jwt_user = _load_user(jwt_header, jwt_data)
-    _request_ctx_stack.top.jwt_header = jwt_header
-    _request_ctx_stack.top.jwt = jwt_data
-    _request_ctx_stack.top.jwt_location = jwt_location
+    g._jwt_extended_jwt_user = _load_user(jwt_header, jwt_data)
+    g._jwt_extended_jwt_header = jwt_header
+    g._jwt_extended_jwt = jwt_data
+    g._jwt_extended_jwt_location = jwt_location
 
     return jwt_header, jwt_data