Merge pull request #459 from supertokens/feat/appinfo-refactor

feat!: appinfo refactor

Author: rishabhpoddar

.vscode/settings.json

@@ -6,5 +6,6 @@
     },
     "python.analysis.typeCheckingMode": "strict",
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
+    "python.testing.pytestEnabled": true,
+    "python.analysis.autoImportCompletions": true
 }

CHANGELOG.md

@@ -8,6 +8,49 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.18.0] - 2023-11-25
+
+### Added
+
+-   Adds support for configuring multiple frontend domains to be used with the same backend
+-   Added new `origin` property to `InputAppInfo`, this can be configured to allow you to conditionally return the value of the frontend domain. This property will replace `website_domain`
+-   `website_domain` inside `InputAppInfo` is now optional. Using `origin` recommended over using `website_domain`. Using `website_domain` will continue to work.
+
+### Breaking Change
+- The order or arguments in the `InputAppInfo` has changed. If NOT using keyword arguments for `app_info` in `supertokens.init`, then you will have to move `website_domain` like so:
+
+    Before:
+    ```python
+    init(
+        app_info=InputAppInfo(
+            "app_name",
+            "api_domain",
+            "website_domain",
+            None, # api_gateway_path
+            None, # api_base_path
+            None, # website_base_path
+        ),
+        # other configs..
+    )
+    ```
+
+    After:
+    ```python
+    init(
+        app_info=InputAppInfo(
+            "app_name",
+            "api_domain",
+            None, # api_gateway_path
+            None, # api_base_path
+            None, # website_base_path
+            "website_domain"
+        ),
+        # other configs..
+    )
+    ```
+
+- In the session recipe, if there is an `UNAUTHORISED` or `TOKEN_THEFT_DETECTED` error, the session tokens are cleared in the response regardless of if you have provided your own `error_handlers` in `session.init` 
+
 ## [0.17.0] - 2023-11-14
 - Fixes `create_reset_password_link` in the emailpassword recipe wherein we passed the `rid` instead of the token in the link
 

CONTRIBUTING.md

@@ -47,7 +47,7 @@ You will need to setup the [supertokens-core](https://github.com/supertokens/sup
 3. Open a new terminal and navigate to the `supertokens-python` respositry.
 4. Use `export SUPERTOKENS_PATH=path/to/supertokens-root` (**MANDATORY**)
 4. To run all tests, while ensuring the test environment is running on a different terminal, use `make test`.
-5. To run individual tests, use `pytest ./tests/path/to/test/file.py  -k test_function_name` OR use your IDE's in-built UI for running python tests. You may read [VSCode Python Testing](https://code.visualstudio.com/docs/python/testing) and [PyCharm Testing](https://www.jetbrains.com/help/pycharm/testing-your-first-python-application.html#debug-test) for more info.
+5. To run individual tests, use `INSTALL_DIR=../supertokens-root pytest ./tests/path/to/test/file.py::test_function_name` OR use your IDE's in-built UI for running python tests. You may read [VSCode Python Testing](https://code.visualstudio.com/docs/python/testing) and [PyCharm Testing](https://www.jetbrains.com/help/pycharm/testing-your-first-python-application.html#debug-test) for more info.
 
 ## Pull Request
 

examples/with-django/with-thirdpartyemailpassword/create_env.sh

@@ -70,7 +70,7 @@
 
 setup(
     name="supertokens_python",
-    version="0.17.0",
+    version="0.18.0",
     author="SuperTokens",
     license="Apache 2.0",
     author_email="[email protected]",

examples/with-fastapi/with-thirdpartyemailpassword/create_env.sh

@@ -14,7 +14,7 @@
 from __future__ import annotations
 
 SUPPORTED_CDI_VERSIONS = ["3.0"]
-VERSION = "0.17.0"
+VERSION = "0.18.0"
 TELEMETRY = "/telemetry"
 USER_COUNT = "/users/count"
 USER_DELETE = "/user/remove"

examples/with-flask/with-thirdpartyemailpassword/create_env.sh

@@ -49,14 +49,14 @@ async def __asyncMiddleware(request: HttpRequest):
                     request.supertokens, SessionContainer  # type: ignore
                 ):
                     manage_session_post_response(
-                        request.supertokens, result  # type: ignore
+                        request.supertokens, result, user_context  # type: ignore
                     )
                 if isinstance(result, DjangoResponse):
                     return result.response
             except SuperTokensError as e:
                 response = DjangoResponse(HttpResponse())
                 result = await st.handle_supertokens_error(
-                    DjangoRequest(request), e, response
+                    DjangoRequest(request), e, response, user_context
                 )
                 if isinstance(result, DjangoResponse):
                     return result.response
@@ -85,15 +85,15 @@ def __syncMiddleware(request: HttpRequest):
                 request.supertokens, SessionContainer  # type: ignore
             ):
                 manage_session_post_response(
-                    request.supertokens, result  # type: ignore
+                    request.supertokens, result, user_context  # type: ignore
                 )
             return result.response
 
         except SuperTokensError as e:
             response = DjangoResponse(HttpResponse())
             result: Union[DjangoResponse, None] = async_to_sync(
                 st.handle_supertokens_error
-            )(DjangoRequest(request), e, response)
+            )(DjangoRequest(request), e, response, user_context)
             if result is not None:
                 return result.response
         raise Exception("Should never come here")

setup.py

@@ -44,10 +44,11 @@ async def dispatch(self, request: Request, call_next: RequestResponseEndpoint):
             st = Supertokens.get_instance()
             from fastapi.responses import Response
 
+            custom_request = FastApiRequest(request)
+            response = FastApiResponse(Response())
+            user_context = default_user_context(custom_request)
+
             try:
-                custom_request = FastApiRequest(request)
-                response = FastApiResponse(Response())
-                user_context = default_user_context(custom_request)
                 result: Union[BaseResponse, None] = await st.middleware(
                     custom_request, response, user_context
                 )
@@ -58,13 +59,15 @@ async def dispatch(self, request: Request, call_next: RequestResponseEndpoint):
                 if hasattr(request.state, "supertokens") and isinstance(
                     request.state.supertokens, SessionContainer
                 ):
-                    manage_session_post_response(request.state.supertokens, result)
+                    manage_session_post_response(
+                        request.state.supertokens, result, user_context
+                    )
                 if isinstance(result, FastApiResponse):
                     return result.response
             except SuperTokensError as e:
                 response = FastApiResponse(Response())
                 result: Union[BaseResponse, None] = await st.handle_supertokens_error(
-                    FastApiRequest(request), e, response
+                    FastApiRequest(request), e, response, user_context
                 )
                 if isinstance(result, FastApiResponse):
                     return result.response